1
Game Data
ch0ccyra1n edited this page 2024-09-11 19:12:25 +00:00
Game data is stored on a YAML 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].
For an example of what this looks like, check 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 |