ch0ccyra1n/oni-engine
1
0
Fork 0
Code Issues 4 Pull requests Projects Releases 2 Packages Wiki Activity Actions

Add Game Data

ch0ccyra1n 2024-09-11 19:12:25 +00:00
parent cc64a1a43d
commit 756475f086
1 changed files with 14 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
Game-Data.md Normal file

@ -0,0 +1,14 @@
**Game data** is stored on a [YAML](https://yaml.org/) file that follows a particular format specific to this engine. This page describes how a developer should lay out a file.
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", " SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in [[RFC2119](https://datatracker.ietf.org/doc/html/rfc2119)].
For an example of what this looks like, check [sample.yaml](https://forge.planetexpress.me/ch0ccyra1n/fedijam-engine/src/branch/main/sample.yaml)
When creating a game data YAML file, you MUST include an `entrypoint` encounter. This is where the engine will look for the start of your game.
The following table lists all possible attributes you MAY apply to any encounter:
| Attribute | Data Type | Function | Notes |
| ------------- | ------------- |---| ---|
| `scenario` | string | Describes the encounter that the player is located |
| `choices` | array of strings | List of all possible choices the player can make during an encounter. | Every choice in `choices` except for `"Exit game"` MUST be the key of a valid encounter |
| `goto` | string | Tells the engine to read out the scenario (if it exists) | MUST be the key of a valid encounter |