https://github.com/ondra6ak/skribo
Dead simple screenplay format
https://github.com/ondra6ak/skribo
pandoc plaintext screenplay writing
Last synced: 8 months ago
JSON representation
Dead simple screenplay format
- Host: GitHub
- URL: https://github.com/ondra6ak/skribo
- Owner: ondra6ak
- License: bsd-2-clause
- Created: 2017-10-27T11:01:23.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2017-11-16T01:40:17.000Z (almost 8 years ago)
- Last Synced: 2025-01-11T00:22:31.389Z (9 months ago)
- Topics: pandoc, plaintext, screenplay, writing
- Language: Python
- Size: 1.49 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Skribo
======
Dead simple screenplay format.
Installation
------------
Install `python3` and `pip`, `pandoc`, `texlive-luatex` (recomended) and `texlive-latex-extra` via your package manager. And then use these commands to complete the installation:
# pip3 install unicode-slugify
# mkdir -p /usr/lib/python3/dist-packages/skribo
# cp skribo.py /usr/lib/python3/dist-packages/skribo/__init__.py
# chmod +x skribo-*
# cp skrib-* /usr/bin/
# cp -r roboto /usr/share/fonts/truetype/roboto
Usage (WIP)
-----------
skribo-reader -i examples/monty_python.skrb | pandoc -f json --normalize --latex-engine lualatex --template skribo.latex -o examples/monty_python.pdf
Syntax
------
Every screenplay must begin with header like the one bellow and blank line after
TITLE
Subtitle
Alice Doe; Bob Doe
Each scene begins with the scene name in allcaps and blank line
SCENE EXAMPLE
Replica begins with the character name and a colon following by the actual text and a blank line
Alice: Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
Notes can appear anywhere in the text
Alice: Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. (exits)
(The room darkens)