Skip to main content

Create and display Story structure.

Project description

Plotlines

Plotlines is a tool to help create online choice-based narratives.

Authors create a basic story structure in Inkscape. Plotlines will read the SVG file and generate templates for HTML5 output.

Works-in-progress can be saved in human-readable TOML files. This format is better suited to collaborative editing.

Workflow

Inkscape's Connectors tool makes it easy to design a branching narrative structure.

Story board

You can capture ideas in the title and description fields of both nodes and edges using the Object Properties editor.

When that phase is complete, you use Plotlines to save the structure as a .toml file where the serious process of writing and editing begins.

Finally, you can export to a template tree ready for Spiki to generate the HTML suitable for a static web site on the Internet.

Features

Plotlines can import SVG from either of these editors:

Mode of use CLI options Progress Status
Auto-generation of plot structures Omit -i option Ongoing :x:
Convert Dunnart files to TOML format -i <file>.svg -o .toml Complete :ok:
Convert Inkscape files to TOML format -i <file>.svg -o .toml Complete :ok:
Load and plot a file in TOML format -i <file>.toml Complete :ok:
Load file and generate a Spiki template tree -i <file>.toml -o <dir> Complete :ok:

Usage

python3 -m plotlines.main --help
usage: python -m plotlines.main [-h] [--debug] [-i INPUT] [-o OUTPUT] [--ending ENDING] [--limit LIMIT] [--exits EXITS]

options:
  -h, --help            show this help message and exit
  --debug               Display debug information
  -i, --input INPUT     Specify an input file
  -o, --output OUTPUT   Specify an output file or directory
  --ending ENDING       Set the number of endings [4].
  --limit LIMIT         Limit the number of Nodes and Edges in the graph [100]
  --exits EXITS         Fix the number of exiting Edges from each Node [4]

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

plotlines-0.5.0.tar.gz (72.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

plotlines-0.5.0-py3-none-any.whl (85.9 kB view details)

Uploaded Python 3

File details

Details for the file plotlines-0.5.0.tar.gz.

File metadata

  • Download URL: plotlines-0.5.0.tar.gz
  • Upload date:
  • Size: 72.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.0

File hashes

Hashes for plotlines-0.5.0.tar.gz
Algorithm Hash digest
SHA256 731f3c83a74ca1059d9f3735f553af95bb1302dd5a91d3abc868562be7007211
MD5 1dfda48a8d8eea33cd95dd1d3a111a69
BLAKE2b-256 eef92635e728e27ec63f56dfa4b056acc8d1a6b182949a01f518945b3615d73b

See more details on using hashes here.

File details

Details for the file plotlines-0.5.0-py3-none-any.whl.

File metadata

  • Download URL: plotlines-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 85.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.0

File hashes

Hashes for plotlines-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c0e46369391c0b136d41cd63b1c87071284be6bbd7b81887cf052c83b7349a50
MD5 6031a73d09c2ded5d6072288f18cd9d0
BLAKE2b-256 65be205f35f6207ef08aa2f6c15175d772c9ea2f9d53708a944ffa357ba93504

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page