m. c. de marco: To invent new life and new civilizations...

DotScap

DotScap is a proofing format that lays out a Twine story as a Scapple mind map. For other styles of story graphs, see DotGraph and/or A History of Choice Mapping.

small-graph

DotScap works with Twine 1, Twine 2, Twee, Twee2, and TweeGo. It can omit node names, skip special and/or specially tagged passages, and skip display links. It also shows you some basic story statistics.

To go the other way (from Scapple into Twine), try scap2tw.

Versions

The current version of DotScap is 1.0.1. It adds some coloring and node marking a la DotGraph.

Previous Versions

Installation

Twine 2

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

Twine 1

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

Use

As a story format, DotScap outputs an HTML file that contains the DotScap controls and should automatically download the Scapple file for your story. If you change the settings (for omissions, display links, etc.), you can click the Regenerate File button to download the revised Scapple file.

Twine 2

After installation, you may want to click the star or radio button next to DotScap in the Proofing Formats list (also under Formats) to make it your default proofing format.

Next, import your story (if it isn’t already in Twine 2), click on it to open it, and click View Proofing Copy in the popup menu in the lower left hand corner of the UI.

Twine 1

In Twine 1, open or create a story (under the File menu). Then, in the Story menu under Story Formats, select DotScap as the story format. Choose Test Play or Build Story from the Build menu to see your story. (You may need to restart Twine 1 if you installed DotScap while it was running.)

Twees

You can also use DotScap with an external Twine renderer like Twee, Twee2, or TweeGo; just download the appropriate file (format.js or header.html, depending on the associated Twine version) to your filesystem and follow your renderer’s instructions for installing and using a new story format.

Settings

You can adjust the settings in the UI, or you can pass in your desired settings (including some settings not available in the UI) using the StorySettings special passage. They should be in the following (JSON) format:

dotgraph:{"color":"length","scale":true,"ends":true,"trace":"Mars"}  

(That’s not a typo; DotScap uses DotGraph’s settings.) You only need pass in your desired changes; see the DotGraph documentation for the full list of settings.

You should put the configuration on one line in your StorySettings file.

Examples

Here’s a Scapple file generated from the Scree example story. (You may need to right-click the link to download it successfully. If your browser appends a .xml to the file name, you may need to remove it before opening the file in Scapple.)

Sausage

The source code is available at BitBucket.

DotScap was inspired by a discussion on the Twine discord server.

DotScap is in no way associated with Literature and Latte, the makers of Scapple.