Starward Rogue:XML - Tutorial Definitions

Each .xml file in the Configuration/Tutorials/ directory is parsed, and each child of the root node is read as a separate tutorial.

Each of those nodes will have 1 or more "phase" nodes, and each phase corresponds to a single room that is run in a way very similar to a test chamber

main nodes

• name
  • the internal name the game will remember this tutorial by; if someone beats the tutorial and this name is later changed, the game will think it's a new (unbeaten) tutorial
• display_name
  • the name that will be shown on the tutorial list to the player
• end_message
  • the message shown to the player when this entire tutorial is successfully completed

tutorial sub-node type: phase

the contents of this node (between the > and the <, so not including the attributes and the tag itself) will be parsed as a test chamber script when the phase is started

since the parsing doesn't happen until later, those contents will not be error-checked during the loading of the game

• starting_message
  • the message shown to the player when this phase is started
  • this also shows on the escape menu's bottom-right info block during this phase

Starward Rogue XML Documentation Main