Text-Based Adventure Game Creator Documentation
The game creation tool is designed to be somewhat user-friendly, but not to protect the user from themselves in
every possible scenario.
Mainly, there are the following things you need to look out for or the game player may throw an error:
- Unless the "Option goes to other screen" or "Is end screen" option is checked, you must
have an option in the options list.
- The "purpose" and "text" attributes should be set in each option.
- Do not have more than one option with the same name, as it will just be processed as the last value that was
unique.
This will make much more sense soon.
How to Use The Tool
First, open the text-based adventure game creation tool.
Set the name of your game in the top-left corner. You can edit values in all the text boxes.
Create a new option by pressing the "+" button. The game file follows a nested structure of options.
When you are done, you can save your game with the "Save" and load it in either the game player or the game creator tool.
What the Options Do
- Purpose: Required; What the user types in to make that choice.
- Header: Optional; What text is shown in the header at the top of th screen.
- Text: Required; What text is shown to the user.
- Disable undoing previous choice: Not recommended, but will disable the user's ability to type "go back" to undo the last choice on that screen.
- Option goes to other screen: If the choice jumps to a screen not directly descended from the previous
screen.
- Is end screen: Will keep any options from being shown to the user. Use for any screen that is an ending.
- Go to: Required if "Option goes to other screen" is checked; References a place on the tree to jump to. For example, the path for the screen for door 1 in the
default game file would be
"screens.options.door 1".
Notes On Unintended Behaviors of The Tool
- When you toggle a checkbox or add/remove an option, the open/closed state of the dropdowns will reset.
- When you change the name of an option, it will be listed last in the game file and in game in the screen it
is in. This can be remedied by renaming and naming back all other options in the screen.
- When you press space when renaming an option, the open/closed state of the dropdown will be toggled.