Textplay has been rigorously tested against fountain documents, but it is not perfect, if you encounter a problem please open a github issue.
- Clone this repo somewhere convenient,
cdinto that directory,
This will place a symbolic link to textplay in
This symbolic link can be removed with
Textplay was built using Mac OS 10.10 and Ruby 2.0. I have only tested it in this environment, if you want to run Textplay in another environment (such as Windows) you may have to modify the code.
textplay [options] -h, --help Display the help text -s, --snippet Do not include document headers/footers -f, --fdx Convert to Final Draft .fdx -x, --xml Output as the internal raw XML -d, --diff Assume input is a diff, generate revision marks -w, --wrap Wrap action and dialogue paragraphs
Texplay is designed to be a Unix tool, thus it always reads from STDIN and writes to STDOUT. To make a file use standard Unix redirection. For example:
textplay < screenplay.fountain > screenplay.html
As another example, textplay has been tested extensively with PrinceXML. To make a PDF from a fountain document, use this:
textplay < screenplay.fountain | prince - -o screenplay.pdf
Want to customize how textplay interprets your screenplay? Want to change the layout of your screenplay?
key:value title-page syntax,
you can control how textplay interprets your screenplay.
--help for info.
|slugline_spacing (number of 12pt lines)||1|
|header||(empty by default)|
|footer||(empty by default)|
It is possible to create a screenplay with revision marks via Textplay.
You'll have to know how to use
diff and pass the output to Textplay.
--help for instructions.
Support for the Fountain Format
- How does Textplay interpret text differently from the Fountain spec?
- An action line that contains no lower-case letters is converted to a slugline, a "Goldman Slugline". This can be switched off.
- Textplay is smart about what constitutes a transition. Usually, there's no need to escape transitions, but you can.
- In some cases Textplay does not assume that every whitespace character you type (newlines, spaces, and tabs) is intentional. For example, if you type one space on the line immediately below an all-caps line, Fountain assumes you'd like a Character saying “ ”. Textplay assumes you accidentally typed a space.
- Textplay collapses multiple blank lines between elements to a single blank line.
- What parts of the Fountain spec are not supported?
- Title Pages.
- Scene Numbers.
- Empty lines in dialogue-blocks.