GithubHelp home page GithubHelp logo

skribo's Introduction

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)

skribo's People

Contributors

ondra6ak avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.