Skip to content

ruwanego/fountain-java

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 

Repository files navigation

Fountain for Java

A Java parser for fountain based off (plagiarizing perhaps?) of nyousefi/Fountain.

Fountain

Fountain is a simple plain text formatting syntax for screenplays. The syntax is simple and human readable. If you want to write in Notepad or SublimeText you can! Whatever floats your boat.

The syntax is very similar to markdown. Fountain removes a lot of the complexity of markdown, and keeps things simple. If you ever tried writing a screenplay using plaintext before, more than likely a large majority of it winds up being valid fountain syntax.

Fountain for Java

Fountain for java is a port of the Objective-C implementation to Java. Why Java? Well... we'll have to answer that later...

Components

FNTypes

An enum that contains valid types based off of the syntax of Fountain. Used by FNElement to identify the type of element.

FNElement

The data model for storing script elements.

FNParser

A line-by-line parser for Fountain strings and files. Stores the script in a List of FNElements and the title page as a Map.

To Do

  • FNScriptToHTML - Will convert a Fountain string or file to an HTML file.
  • FNWriter - Will output a List of FNElements and a Map representing the Title Page to a valid Fountain file.
  • FNScript - Object that holds the script content. Makes it easy to read and write fountain files (instead of having to interact with everything).

Installation and Usage

Download our jar or source (someday...) and add it to your Java project path. Import com.thp.fountain.*; Be happy.

Credits

Links

Want to discuss and contribute to the syntax of fountain? Join the Glassboard.

Other useful tools for fountain? Check out the apps.

Need to convert from Fountain to Final Draft? Checkout screenplain.

About

A Java parser for fountain.io/syntax

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published