Skip to content
Support for fountain screenplay markup in visual studio code
TypeScript HTML JavaScript
Branch: master
Clone or download
piersdeseilligny Merge pull request #49 from wunderhund/wunderhund/support-unicode-apo…
…strophe

Add regex support for unicode apostrophe
Latest commit 15ef717 Jan 3, 2020
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.vscode
src Add regex support for unicode apostrophe Jan 3, 2020
syntaxes Add support for dash in tmlanguage format Jan 3, 2020
.gitattributes Initial commit Sep 29, 2018
.gitignore revert to pre-1.4.1 Jul 31, 2019
.vscodeignore revert to pre-1.4.1 Jul 31, 2019
CHANGELOG.md Add option to disable noise texture in preview Aug 27, 2019
FAQ.md Add note on how to reach JSON settings Sep 7, 2019
LICENSE.md
README.md 1.4.0 Release Jul 27, 2019
flaticon.svg
icon.png Updated icon Sep 30, 2018
jest.config.js Statistics Sep 5, 2019
language-configuration.json Version 1.0.1 Sep 29, 2018
package-lock.json Update https-proxy-agent to 2.2.4 Jan 3, 2020
package.json Adjust for windows machins (CRLF carriage returns) Sep 8, 2019
tsconfig.json Statistics Sep 5, 2019

README.md

Screenshot of BetterFountain in dark mode Screenshot of BetterFountain in light mode

Better fountain

This is an extension for Visual Studio Code, written in a few hours, which allows you to write screenplays using the fountain syntax quickly and efficiently. (If you're already confused click here)

Install it here

Support via PayPal

Features

  • Full syntax highlighting (even for stuff like lyrics!)
  • Smart autocomplete for recurring characters and scenes, as well as title page keys.
  • Full screenplay outline, broken down by sections and scenes
  • "Folding" scenes
  • Live preview of the formatted screenplay
  • Exporting the screenplay to a PDF File
  • Custom font support (Add "Font:" at the top of your .fountain screenplay, with the other title page keys, followed by the name of a font installed on your system)
  • Approximation of a screenplay's duration (in the status bar)
  • Other cool stuff
    • Go straight to writing dialog after a parenthetical by pressing enter, while the cursor is still inside it
    • Jump to scenes/sections in the .fountain and live preview when clicking on the outline

Why?

Writing with fountain lets you focus on the essential. With the addition of autocomplete and syntax highlighting, you have the ultimate clutter-free ultra-fast solution for writing screenplays. And because it's an extension for vscode, it's free and cross-platform, and you get lots of other cool features like integrated source control.

Usage

Just open a .fountain file in Visual Studio Code, and everything should work as expected. You can open the live preview and export to PDF by opening the command palette (Ctrl+Shift+P or F1) and searching for "Fountain".

You can modify various options related to PDF Export in the settings, under "Fountain PDF Export".

And to get an approximate duration of your screenplay, just look at your status bar, in the bottom right corner.

TODO

Here are some features I would like to add, but don't really have time to right now, in an approximate order of difficulty/priority:

  • Built-in screenplay templates (such as Blake Snyder's beat sheet)

  • Folding for sections

  • Even smarter auto-complete

  • Some sort of system that would allow the storage of character information alongside the script

  • Synchronized scrolling of the live preview with the markup.

I will probably add these features when I have time, but if you're up for the challenge I'm more than happy to accept your pull requests.

Thanks / Third-party licenses

  • Syntax highlighting works thanks to a modified version of the .tmlanguage file by Jonathan Poritsky for fountain-sublime-text

  • The live preview uses elements from the Fountain.js library by Matt Daly, covered by the MIT License

  • The fountain parsing and PDF generation feature is based on Piotr Jamróz's Afterwriting, also covered by the MIT License

  • The project was built using Microsoft's language server example extension as a boilerplate.

  • The default font used in the preview and in the exported PDF is "Courier Prime", more specifically a version which adds support for Azerbaijani, Belorussian, Kazakh, Russian, and Ukrainian

Why visual studio code? I thought this was about screenwriting?

Screenwriting is just about writing text, and Visual Studio Code is a great text editor. You don't need to know anything about programming to use it. Here's what you need to do to get started using BetterFountain:

You can’t perform that action at this time.