storydata.tw

located: src/twee/meta/storydata.tw

:: StoryData [illumeIgnore]
{
	"ifid": "",
	"format": "SugarCube",
	"format-version": "2.36.1",
	"start": "Start"
}

:: StoryTitle [illumeIgnore]
ChoiceScript-like SugarCube Template

:: StoryDisplayTitle [illumeIgnore]
ChoiceScript-like SugarCube Template

:: StoryAuthor [illumeIgnore]
brushmen

Passage “StoryData” is required. The tag “illumeIgnore” is optional, but if you are planning to use illume proofing format to estimate words in the main story, you can start tagging passages that you don’t want illume to count the words from (such as meta or mainly code passages).

“ifid” value should be different for each project (not absolutely guaranteed to be unique since it does not check against other existing projects at the time of ifid-generation). If you want to generate a new one and not sure how, make this field an empty string, like how it looks now, then after you try to compile the code, the compiler will complain and offer you a value which you can then copy-paste into this part.

“format-version” must match what storyformat file you have, in this case you should have 2.36.1 version of sugarcube 2.

“start” value can be any named passage, so you can make it be

"start" : "Prelude",

if you want, just make sure there is a passage named Prelude.

“tag-colors” is an optional element. If you don’t care about what the squares would look like if the project is imported into the Twine editor, you don’t need tag-colors. If you want to add it, put a comma (“,”) after the previous section, like this:

    "start": "Start",
    "tag-colors": {
	  "c1": "red",
	  "c2": "green",
          "c3": "blue"
    }

Passage “StoryTitle” is required. It only accepts plain text without extra coding. This usually affects the save file. If you want to change the story title without breaking save files, use StoryDisplayTitle passage to “overwrite” the story title. (There is a way to not be affected by this restriction, but too much info for an initial tutorial)

Passage “StoryAuthor” is actually optional because we can rebuild the user interface (StoryInterface passage) to not rely on it. But I like the simplicity of this method.