Emacs major mode for screenwriting in Fountain plaintext markup
Latest commit 55e8b6a Sep 11, 2018
Permalink
Failed to load latest commit information.
screenshots Screenshot (feat. The Abductors) Dec 14, 2017
LICENSE.txt Add LICENSE.txt, remove badge Apr 17, 2018
README.md Updated Bitcoin Cash address May 21, 2018
fountain-mode.el Fixes #97 Sep 11, 2018

README.md

Fountain Mode

MELPA Stable MELPA

Fountain Mode is a complete screenwriting environment for GNU Emacs using the Fountain markup format. For more information on the Fountain markup format, visit http://fountain.io.

screenshot

Pictured: The Abductors by Paul W. Rankin in Fountain Mode (using imenu-list and Olivetti minor modes)

Features

  • Support for Fountain 1.1 specification
  • WYSIWYG auto-align elements (display only, does not modify file contents) specific to script format, e.g. screenplay, stageplay or user-defined format
  • Traditional TAB writing style for auto-upcasing character names (see Do What I Mean)
  • Export to plain text, HTML, LaTeX, Final Draft (FDX), or Fountain
  • Export to standalone document or snippet
  • Optionally show approximate page count (current page of total pages) in mode-line
  • Include external files with {{ include: FILENAME }}
  • Integration with outline to fold/cycle visibility of sections and scenes (see Outlining)
  • Integration with imenu (sections, scene headings, notes)
  • Intergration with auto-insert for title page metadata
  • Add/remove automatic continuation string to successively speaking characters
  • Navigation by section, scene, character name, or page
  • Optionally display scene numbers in the right margin
  • Intelligent insertion of a page breaks
  • 3 levels of element syntax highlighting
  • Automatic loading for *.fountain files
  • Include or omit a title page
  • Emphasis (bold, italic, underlined text)
  • Toggle visibility of emphasis delimiters and syntax characters
  • Everything is customizable

Check out the Nicholl Fellowship sample script exported from Fountain Mode to:

Most common features are accessible from the menu. For a full list of functions and key-bindings, type C-h m.

For more, see the Wiki.

Requirements

  • Emacs 24.5
  • LaTeX packages for PDF export: geometry fontspec titling fancyhdr marginnote ulem xstring oberdiek

Installation

For users on OS X with no experience with Emacs, see the Absolute Beginner's Guide (macOS).

The latest stable release of Fountain Mode is available via MELPA-stable.

Alternately, download the latest release, move the files into your load-path and add the following line to your .emacs or init.el file:

(require 'fountain-mode)

If you prefer the latest but perhaps unstable version, install via MELPA, or clone the repository into your load-path and require as above:

git clone https://github.com/rnkn/fountain-mode.git

Users of Debian ≥10 or Ubuntu ≥18.04 can install Fountain Mode with the following command:

sudo apt install elpa-fountain-mode

Bugs and Feature Requests

Please raise an issue on Issues.

  • Emacs versions prior to 26 have a bug with visual-line-mode that produces erratic navigation behavior when displaying very long lines. More information here: https://debbugs.gnu.org/23879

Roadmap

See Roadmap.

History

See Releases.

Tips

Ethereum address 0x209C60afd8aF6c61ac4Dbe340d81D4f789DF64D3
Bitcoin Cash address qp0n3z88mmq06xv9mvkwuur9289qhnyg2gl45tlhxf