Overview

HTTPS SSH

Paloma

Paloma is a Jonah-style story format for Twine 1 and 2 based on Snowman by Chris Klimas.

Paloma uses Markdown rather than TiddlyWiki-style text formatting, and Javascript rather than Twine 1.x-style macros for scripting, so it is not a drop-in replacement for Jonah. It is a drop-in replacement for Snowman, except that Paloma will ignore any checkpoints in your story.

The Paloma page is here.

View a demo story here.

To add Paloma to Twine 2, use this URL (under Formats > Add a New Format): https://mcdemarco.net/tools/scree/paloma/format.js.

To add Paloma to Twine 1, create a new folder called paloma inside your targets folder, then download this file: https://mcdemarco.net/tools/scree/paloma/header.html and place it inside the paloma folder. (See the Twine wiki for more information about installing and using story formats in Twine 1.)

Changes From Snowman

Paloma displays a running log of all passages, like Jonah. All story links from previous passages are disabled, and the previously selected link is highlighted.

By default, clicking a passage link adds an entry to the reader's browser history. The reader can back up through this history, but cannot go forward again (except by clicking story links again). Paloma does not have Snowman's checkpoint functionality; history is node-by-node only.

There is an inline title at the beginning of the story, as well as an optional subtitle and byline below the title. To add a subtitle, use the special passage StorySubtitle. To add an author, use StoryAuthor. (The title is handled as usual for your version of Twine.)

To restyle or remove the title, use the selector #ptitle. To restyle or remove the subtitle, use the selectors #psub (for both), #psubtitle (for the subtitle), and #pauthor (for the byline). See my website for styling examples.

Non-changes from Snowman

Paloma uses Marked for Markdown formatting and jQuery and Underscore for scripting and templating.

As in Snowman, state is rewound on navigating back.

Some basic Snowman scripting:

  • Set a state variable gender: <% s.gender = "male" %>.
  • Show the variable's value: <%= s.gender %>.
  • Show some text based on a variable's value: <% if (s.gender == "male") { %>You are male.<% } %>.
  • Show alternate texts based on a variable's value: <% if (s.gender == "male") { %>You are male.<% } else { %>You are female.<% } %>.
  • Add a comment: /* My ToDo list for this node: spellcheck! */

See the Snowman docs for more details.

Versions

1.1.1

Fixed iPhone CSS issue.

1.1.0

Added support for Twine 1, and the StoryAuthor and StorySubtitle special passages.

1.0.1

Added the title inline in the story.

1.0.0

Initial version.

Building From Source

Run npm install to install dependencies. Run grunt package to create a release version for Twine under dist/. Run grunt --help to list other grunt targets.