feat: readme, minLength

README.md

@@ -0,0 +1,51 @@
+# Mari0pository
+
+The Mari0pository is a repository of community-made content for the game [Mari0](https://github.com/Stabyourself/mari0)
+and its derivatives like [Alesan's Entities](https://github.com/alesan99/mari0_ae).
+
+## Contributing
+
+To add to the repository, you must create a pull request which modifies [data.json](data.json) to describe your content.
+
+## Asset Schema
+
+| Property | Description | Required? |
+|--------------------|-------------------------------------------------------------------------------------------------|:---------:|
+| `type` | The type of the asset. Must be `mappack`, `tileset`, `music`, `sound`, `character`, or `enemy`. | ✅ |
+| `name` | The short name of the asset. Must be \[1,17] characters long. | ✅ |
+| `long_name` | The long name of the asset. | ❌ |
+| `description` | A short description of the asset. Must be at most three lines with 17 characters per line. | ❌ |
+| `long_description` | A long description of the asset. | ❌ |
+| `version` | The version of the asset in semantic versioning format. | ✅ |
+| `author` | The author of the asset. Must be \[1,14] characters long. | ✅ |
+| `license` | The license of the asset. Should be an [SPDX identifier](https://spdx.org/licenses/). | ❌ |
+| `download` | The direct download link of the asset. | ✅ |
+| `released` | The date the asset was released. YYYY-MM-DD format. | ✅ |
+| `updated` | The date the asset was last updated. YYYY-MM-DD format. Defaults to the release date. | ✅ |
+| `icon` | The direct download link to the asset's icon. | ❌ |
+| `filename` | The filename of the asset. | ✅ |
+| `homepage` | The link to the homepage of the asset. | ❌ |
+
+### Game-Specific Asset Schema
+
+The following additional properties are available for assets that are created for a specific version of the game.
+This currently includes mappacks, tilesets, characters, and enemies.
+
+| Property | Description | Required? |
+|----------------|------------------------------------------------|:---------:|
+| `game_version` | The version of the game this asset is tied to. | ✅ |
+
+#### Game Version Schema
+
+| Property | Description | Required? |
+|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:---------:|
+| `derivative` | A list of which derivative(s) of the game this asset was created for. Items must be `1.6`, `SE`, `AE`, or `CE`. | ✅ |
+| `ranges` | A list of version ranges this asset is compatible with. The components of a version range separated by a space are AND'd, while the components separated into different items in the array are OR'd. | ❌ |
+
+### Mappack-Specific Asset Schema
+
+The following additional properties are available for mappacks.
+
+| Property | Description | Required? |
+|--------------|----------------------------------------------------------|:---------:|
+| `background` | The level to show in the background of the title screen. | ❌ |

data.schema.json

@@ -33,38 +33,46 @@
  "name": {
  "description": "The short name of the asset.",
  "type": "string",
+ "minLength": 1,
  "maxLength": 17
  },
  "long_name": {
  "description": "The long name of the asset.",
- "type": "string"
+ "type": "string",
+ "minLength": 1
  },
  "description": {
  "description": "A short description of the asset.",
  "type": "string",
  "pattern": "^([^\n]{1,17}\n?){1,3}$",
+ "minLength": 1,
  "maxLength": 53
  },
  "long_description": {
  "description": "A long description of the asset.",
- "type": "string"
+ "type": "string",
+ "minLength": 1
  },
  "version": {
  "description": "The version of the asset.",
- "type": "string"
+ "type": "string",
+ "minLength": 1
  },
  "author": {
  "description": "The author of the asset.",
  "type": "string",
- "maxLength": 17
+ "minLength": 1,
+ "maxLength": 14
  },
  "license": {
- "description": "The license of the asset.",
- "type": "string"
+ "description": "The license of the asset. Should be an SPDX identifier.",
+ "type": "string",
+ "minLength": 1
  },
  "download": {
  "description": "The download link of the asset.",
- "type": "string"
+ "type": "string",
+ "minLength": 1
  },
  "released": {
  "description": "The date the asset was released.",
@@ -78,15 +86,18 @@
  },
  "icon": {
  "description": "The link to the icon of the asset.",
- "type": "string"
+ "type": "string",
+ "minLength": 1
  },
  "filename": {
  "description": "The filename of the asset.",
- "type": "string"
+ "type": "string",
+ "minLength": 1
  },
  "homepage": {
  "description": "The link to the homepage of the asset.",
- "type": "string"
+ "type": "string",
+ "minLength": 1
  }
  },
  "required": [
@@ -134,7 +145,8 @@
  "type": "array",
  "items": {
  "description": "A version range. The components separated by a space are AND'd.",
- "type": "string"
+ "type": "string",
+ "minLength": 1
  }
  }
  },