|  

---

Fountext Screenwriting Editor for Linux

A blazing fast, professional screenwriting environment built with Python, PyQt6, and a custom C++ layout engine.

---

About Fountext

Fountext is a modern, lightweight, and powerful screenwriting editor that fully embraces the Fountain syntax. Forget about formatting struggles; just write. Fountext's custom-built C++ rendering engine handles all the professional formatting for you automatically.

Key Features

Fountain Format Support - Full support for the .fountain screenwriting format
Real-time Rendering - Custom C++ layout engine provides millimeter-perfect positioning
Auto-Formatting - Automatically formats scene headings, character names, and dialogue
Scene Navigation - Floating panel for quick scene/location navigation
PDF Export - Export to industry-standard, text-selectable vector PDFs
Smooth Scrolling - Navigate seamlessly between scenes
Page Statistics - Real-time page count and character count tracking
Bilingual Support - Full support for English and Turkish

---

Quick Start

Option 1: Download Pre-built Binaries (Recommended for Most Users)

1. Go to the Releases Page

2. Download the Latest Version

   • Click on the latest release (currently v1.2)
   • Download the Fountext-v1.2-Linux.tar.gz file

3. Extract the Archive

   # Extract the archive
   tar -xzf Fountext-v1.2-Linux.tar.gz
   
   # Navigate to the directory
   cd Fountext

4. Choose How to Run:

   • A. Portable Mode (Run Directly) You can run Fountext immediately without installing anything. Just double-click the Fountext executable file in the folder, or run it via terminal:

     ./Fountext

     (Note: In portable mode, your desktop environment might not display the application logo on the taskbar depending on your OS/Wayland settings).

   • B. System Integration Mode (Recommended for KDE/Wayland) If you want the Fountext logo to appear correctly on your taskbar and want to find Fountext in your system's Application/Office Menu, run the installation script:

     ./install.sh

     This will safely integrate Fountext into your system. It will also create a handy Fountext.desktop shortcut right inside the folder for easy access!

Option 2: Build from Source

Prerequisites

• Python 3.8+
• PyQt6
• CMake 3.15+
• C++ compiler (GCC 7+ or Clang)
• pybind11

Installation Steps

1. Clone the Repository

   git clone https://github.com/SametCirik/Fountext-Screenwriting-Editor.git
   cd Fountext-Screenwriting-Editor

2. Install Python Dependencies

   pip install -r requirements.txt

3. Build the C++ Layout Engine

   mkdir build
   cd build
   cmake ..
   make
   cd ..

4. Run the Application

   python src/main.py

---

Contributing & Forking

We welcome contributions! Here's how to get started:

Fork the Repository

1. Click the "Fork" button at the top right of the main repository page

   • This creates a copy of the repository under your GitHub account

2. Clone Your Fork

   git clone https://github.com/YOUR_USERNAME/Fountext-Screenwriting-Editor.git
   cd Fountext-Screenwriting-Editor

3. Create a Branch for Your Changes

   git checkout -b feature/your-feature-name
   # or
   git checkout -b fix/your-bug-fix

4. Make Your Changes and Commit

   git add .
   git commit -m "Clear description of your changes"

5. Push to Your Fork

   git push origin feature/your-feature-name

6. Create a Pull Request

   • Go to the main repository
   • Click "Pull Requests" → "New Pull Request"
   • Select your fork and branch
   • Describe your changes and submit!

Areas for Contribution

• Bug Fixes - Found an issue? Help us fix it!
• Features - Have an idea? Implement it!
• Documentation - Help improve guides and documentation
• Translations - Add support for new languages
• Testing - Report issues and test new features

---

Usage Guide

Basic Writing

1. Start Writing - Open the application and begin typing in Fountain format
2. Automatic Formatting - Scene headings, character names, and dialogue are formatted automatically
3. Navigate Scenes - Click the "SCENES" menu to jump between locations

Exporting

• PDF Export - File → Export as PDF or press Ctrl + E
• Professional industry-standard formatting
• Text-selectable content
• Vector-based rendering

Project Structure

Fountext-Screenwriting-Editor/
├── src/                    # Python source code
├── src_cpp/                # C++ layout engine source
├── requirements.txt        # Python dependencies
├── CMakeLists.txt         # C++ build configuration
├── guide_EN.pdf           # User guide (English)
├── guide_TR.pdf           # User guide (Turkish)
└── README.md              # This file

---

System Requirements

• OS: Linux (Ubuntu 20.04+, Fedora 33+, Debian 11+, or similar)
• Python: 3.8 or higher
• RAM: 512 MB minimum, 2 GB recommended
• Disk Space: ~200 MB for installation

---

Documentation

• User Guide (English) - Complete user guide in Fountain format
• User Guide (Turkish) - Türkçe kullanıcı rehberi

---

License

This project is licensed under the GNU General Public License v3.0 - see the LICENSE file for details.

---

Support & Community

• Issues - Found a bug? Report it here
• Discussions - Have questions? Start a discussion
• Contact - Reach out on GitHub

---

Roadmap

• Cross-platform support (Windows, macOS)
• Additional export formats (FDXM, AV Pro)
• Collaboration features
• Theme customization
• Plugin system

---

Acknowledgments

Built with:

• Python - Core application logic
• PyQt6 - User interface
• C++17 - High-performance layout engine
• pybind11 - Python/C++ bindings
• Fountain Format - Industry-standard screenplay syntax

---

Questions?

Feel free to open an issue or discussion for any questions or feedback!

Happy writing!