Skip to content

Commit 3412cc9

Browse files
committed
Fix #7, Implement #8, add more specifications and properties to the game schema
1 parent e64e6e1 commit 3412cc9

File tree

1 file changed

+13
-9
lines changed

1 file changed

+13
-9
lines changed

CONTRIBUTING.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Start by forking this repository and cloning your fork locally.
66

77
Decide a "slug" for the game you are adding: it's like an username: short, no spaces, special characters or punctuation.
88

9-
> If the game is called "Super Roto Land : Tales from the Dumper", a good slug would be `super-roto-land-1`.
9+
> If the game is called "Super Roto Land I: Tales from the Dumper", a good slug would be `super-roto-land-1`.
1010
1111
### 2. Create the game folder and add the related files
1212

@@ -52,7 +52,7 @@ Fill in every property. You can take a look at existing games to make sure every
5252
| platform | Target console | String: `GB` or `GBC` |
5353
| typetag | The type of the software | String: `game`, `homebrew` or `demo` |
5454
| screenshots | A list of the filenames of the screenshots in the folder | Array of String of the screnshots file names (no path) |
55-
| rom | The name of the ROM in the folder | String |
55+
| rom | The name of the ROM in the folder | String (no path) |
5656

5757

5858
#### Optional Fields
@@ -61,13 +61,17 @@ The following fields are appreciated, but not strictly required:
6161

6262
| Property | Description | Possible values |
6363
|---------------|----------------------------------------------------------------------|---------------------------------------------------------|
64-
| license* | Identifier of the license under whose terms the software is released | [Identifier](https://spdx.org/licenses/) of the license |
65-
| description* | A description of the entry | String |
66-
| date* | The date the entry was *first* released | String, formatted as MM/DD/YYYY e.g. `"12/01/2006"` |
67-
| tags* | A list of the categories representing the entry | Array of String of existing categories |
68-
| alias* | A list of other names with which the entry can be referred to | Array of String |
69-
| repository* | Repository or URL where the source can be found | String |
70-
| onlineplay* | Allow or not the game to be played directly on the website | Boolean (`true` or `false`) |
64+
| license | Identifier of the license under whose terms the software is released | [Identifier](https://spdx.org/licenses/) of the license |
65+
| assetLicense | Identifier of the license under whose terms the assets are released | [Identifier](https://spdx.org/licenses/) of the license |
66+
| description | A description of the entry | String |
67+
| gameplayVideo | YouTube URL of a gameplay or trailer video | String, YouTube URL |
68+
| date | The date the entry was *first* released | String, formatted as `YYYY-MM-DD` (ISO 8601) |
69+
| tags | A list of the categories representing the entry | Array of String of existing categories |
70+
| alias | A list of other names with which the entry can be referred to | Array of String |
71+
| repository | Repository or URL where the source can be found | String |
72+
| gameWebsite | Game website/page | String |
73+
| devWebsite | Developer personal website/page | String |
74+
| onlineplay | Allow or not the game to be played directly on the website | Boolean (`true` or `false`) |
7175

7276

7377
The possible categories are: `RPG`, `Open Source`, `Adventure`, `Action`, `Puzzle`, `Platform`.

0 commit comments

Comments
 (0)