Skip to content

Commit

Permalink
feat: link to game version schema
Browse files Browse the repository at this point in the history
  • Loading branch information
qixils committed Nov 3, 2023
1 parent 4bbaaf2 commit b9887a2
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ To add to the repository, you must create a pull request which modifies [data.js

## Asset Schema

The following properties are available for all assets.

| Property | Description | Required? |
|--------------------|-------------------------------------------------------------------------------------------------|:---------:|
| `type` | The type of the asset. Must be `mappack`, `tileset`, `music`, `sound`, `character`, or `enemy`. ||
Expand All @@ -31,9 +33,9 @@ To add to the repository, you must create a pull request which modifies [data.js
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. ||
| Property | Description | Required? |
|----------------|-------------------------------------------------------------------------------------------------|:---------:|
| `game_version` | The version of the game this asset is tied to. See [Game Version Schema](#game-version-schema). ||

#### Game Version Schema

Expand Down

0 comments on commit b9887a2

Please sign in to comment.