Skip to content

davemh/highland-fountain-syringe

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Highland Fountain Syringe

A tool for extracting Fountain screenplay text and from Highland (.highland) project files, then reinjecting edits.

Pairs well with Better Fountain (.fountain support for VSCode).


Features

  • Extract Mode: Extracts the screenplay text (.md) from inside the .textbundle in a Highland Pro (.highland) project file and saves it as a .fountain file.

  • Inject Mode: Injects the contents of a .fountain screenplay file into the .md inside an existing .highland project, preserving the internal structure and updating metadata (specifically, the contents of revisions/current.json) so the ensure the resulting file will open correctly in Highland Pro.


Installation

  1. Clone this repository:

    git clone https://github.com/davemh/highland-fountain-syringe.git cd highland-fountain-syringe

  2. Install Python 3.10+ (if not already installed).


Usage

Browse to the repo on your local machine and launch the GUI via command-line:

python highland-fountain-syringe_[version].py

GUI

Extract Mode GUI

  • Extract Mode:
    • Browse to select a .highland file.
    • Click Extract Fountain to create a .fountain file in the same folder.

Inject Mode GUI

  • Inject Mode:
    • Browse to select a source .fountain file containing a screenplay to inject.
    • Browse to select the .highland project to inject into.
    • Click Inject Fountain to create a new .highland file with _/injected appended to the filename.

Notes

  • The .highland project spec has changed over time! The initial release of this tool may not work with versions of Highland older than Highland Pro.
  • This is a crossplatform tool -- it shoudl work on macOS, Windows, and Linux (given that Python 3.10+ is installed).

Roadmap

  • Add support for .highland files created by Highland 2.
  • Add support for .highland files created by Highland (original release).
  • Add automatic detection of Highland version based on .highland file structure.
  • Create and add binaries, so command line isn't needed to launch GUI.

Contributing

Contributions are welcome! Particularly if you want to help add backward compatibility with .highland files created by Highland and Highland 2.

  • Fork the repo.
  • Place any changes in a new branch called feature/feature-name.
  • Submit a pull request.

Please include a clear explanation of changes (and screenshots if your change affects the GUI).


License

Gnu GPL 3.0

About

Extract .fountain screenplays from Highland Pro .highland project files. Reinject edits. An essential helper tool for screenwriters moving Highland screenplays between MacOS and Windows.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages