User Tools

Site Tools


twine1:special_passages

About Story Formats ——— Choosing Between Twine and Twee

Special Passages

There are certain passage names that have special meaning, and let you make your stories look more polished. The most important is Start. It is the first passage displayed when your story is first loaded by a reader.

StoryTitle, StorySubtitle, StoryAuthor

StoryTitle is where you set your story's title. StorySubtitle lets you enter a brief subheading under the story, and StoryAuthor lets you credit yourself. Note that if you insert macro tags in these passages, they will be re-run every time the player changes passages.

StoryMenu

The StoryMenu passage lets you add items to the the menu that hovers in the upper-right corner of the page in the Jonah story format, or on the left side of the page in the Sugarcane story format. You can link directly to passages in your story from this menu. You might, for instance, put an “About the author” link in the menu that links to a passage containing a personal blurb.

Take care with the length of your menu items. A link will be displayed on a single line, even if it means that it will overlap your story's text.

Again, if you put macro tags in this passages, it will be re-run every time the player changes passages. This lets you make a “dynamic menu” that alters itself depending on the player's progress in the story.

StorySettings

The StorySettings passage enables a number of special story options to be set.

  • Undo: enables the player to “undo moves”. In Sugarcane, this means being able to use the Back button in the browser. In Jonah, this means being able to use the “Rewind to here” link, and being able to click links in previous passages.
  • Bookmark: enables the player to use the “Bookmark” link in Sugarcane and Jonah. On by default.
  • Hash updates: this causes the current passage's bookmark URL to be automatically placed in the player's browser address bar whenever they change passages. This is off by default because the URLs can become very long and ugly quickly - but if you opt against including the sidebar's “Bookmark” link, this may provide a useful alternative.
  • Prompt before closing: If the player tries to reload or close the page, the browser will prompt for confirmation. This is useful for long games - it would be unfortunate if the player lost a lot of progress due to an idle key-press.
  • Don't use default CSS: This removes most of the CSS used by the story format, allowing CSS programmers to write their own stylesheet redesigns more easily. Off by default - but including the text “blank stylesheet” in a stylesheet will set it on automatically.
  • ROT13: obfuscates the story's HTML source to dissuade people from spoiling themselves by reading it. Off by default.
  • jQuery: set this on if you are using custom scripts that rely on the jQuery library. Otherwise, leave off. Note: Twine 1.4 does not use the “$” variable, so jQuery can use it without $.noConflict().
  • Modernizr: set this on if you are using custom scripts or stylesheets that rely on the Modernizr library. Otherwise, leave off.

StoryIncludes

This passage is inspired by the “import” feature of various programming languages. It allows you to merge the passages from other .tws or .twee files into your story's HTML file at build time. This lets you work on a Twine project split into multiple files, each being edited independently of the other, but which are built into a single story. It also lets you import a Twine file from a web URL without having to personally download it.

List the file paths and URLs that you want to include, line by line, in the StoryIncludes passage.

If an included file contains a passage with the same name as another included file's passage, an error will be raised when you build.

About Story Formats ——— Choosing Between Twine and Twee

twine1/special_passages.txt · Last modified: 2016/05/09 16:31 (external edit)