scripttool

A tool for working with screenplay file formats (e.g. fdx, fountain, osf, FadeIn).

Converting to fountain format

Convert from screenplay.fdx to screenplay.fountain

    scripttool fdx2fountain screenplay.fdx screenplay.fountain

Convert from screenplay.fadein to screenplay.fountain

    scripttool fadein2fountain screenplay.fadein screenplay.fountain

Convert from screenplay.osf to screenplay.fountain

    scripttool osf2fountain screenplay.osf screenplay.fountain

Working with fountain files

Pretty print fountain files

    scripttool fountainfmt screenplay.fountain

Render a fountain file as JSON

    scripttool fountain2json screenplay.fountain

Convert from fountain format

Convert from screenplay.fountain to screenplay.fdx

    scripttool fountain2fdx screenplay.fountain screenplay.fdx

Convert from screenplay.fountain to screenplay.fadein

    scripttool fountain2fadein screenplay.fountain screenplay.fadein

Convert from screenplay.fountain to screenplay.osf

    scripttool fountain2osf screenplay.fountain screenplay.osf

Script Reports

NOTE: Currently only fountain documents are supported for reporting. Currently the character list report is implemented as a proof of concept.

List the characters in screenplay.fountain

    scripttool characters screenplay.fountain

Help

scripttool help prints the manual. scripttool help index lists the help topics and scripttool help TOPIC prints one, for example scripttool help fdx. Each topic also has a man page, scripttool-TOPIC.7.md.

Install

Get a release from GitHub, or see INSTALL.md, which also covers installing from source.

Build and test

You need Go 1.27.3 or later. Pandoc and GNU Make are only needed for the man page and the website, and cmt (CMTools) only to regenerate version.go, about.md and CITATION.cff from codemeta.json.

make          # build scripttool into bin/ and the man page into man/
make test     # go test ./...
make check    # gofmt -l and go vet; rewrites nothing