User Tools

Site Tools


story_format

About Tags ——— Special Passages

Story Formats

When you publish your story to an HTML file, you can choose between story formats. These story formats control both the basic appearance and behavior of your story, though you can customize both of these via individual changes you make to your story.

There are two main story formats to choose from:

Sugarcane

This displays your story with white text on a black background. Players can only see one passage at a time, though they can, if you permit, use their browsers' back buttons to return to a previous passage.

The HTML structure of Sugarcane is examinable here.

Sugarcane has a sidebar menu that may contain these entries:

  • Bookmark: This serves as a link directly to the current passage, and is automatically updated throughout the game. Players can save their game by copying the URL from this link. (If your StorySettings disallows the ability to undo, then this is unavailable to players, as bookmarking can obviously be used to undo moves.
  • Rewind: If a Sugarcane passage has the tag “bookmark”, then each visit to this passage will create an entry in the Rewind menu as a 'checkpoint'. By using that menu, they can rewind the game to that particular state. For obvious reasons, this isn't particularly useful if your StorySettings allows the Bookmark menu to also be present.

Responsive

This is simply a variant of Sugarcane with a different design that is more readable on mobile web browsers, especially phones. It is heavily based on the Initializr template.

Jonah

This displays your story with black text on a chrome background, and as a player clicks links in your story, the text expands. A player can review earlier passages of your story by scrolling upwards. This approach is called stretchtext. They can rewind to past passages to try different choices by simply clicking the links in those passages (but you can optionally disable this in StorySettings).

The StoryMenu in Jonah is simply the box in the upper-right corner.

Adding Formats

People have shared several story formats to date, the most famous being SugarCube. These can easily be added to become accessible from inside Twine.

On Windows

  1. Locate the “targets” folder in Twine's installation folder.
  2. Inside “targets”, create a folder with a header.html file here.
  3. For example, Program Files(x86)/Twine/targets/sugarcube/header.html

After making any changes inside the “targets” folder, Twine will need to be restarted to update the Story Format menu. Once you restart, from the menu choose Story and then Story Format and select the folder name you created (i.e. sugarcube)

On OS X

  1. Locate Twine.app where you installed it, most likely the Applications folder.
  2. Create a folder called “targets” in the same folder.
  3. Inside “targets”, create a folder with a header.html file here.

After making any changes inside the “targets” folder, Twine will need to be restarted to update the Story Format menu.

About Tags ——— Special Passages

story_format.txt · Last modified: 2017/10/10 00:39 (external edit)