River Writer

Product Introduction

1. Definition: River Writer is a free, open-source (MIT licensed) desktop application for macOS, specifically designed as a technical writing environment for authors of screenplays, stage plays, and novels. It is built using the Tauri framework, combining a Rust backend for core logic with a web-based frontend for the user interface.
2. Core Value Proposition: River Writer exists to provide a distraction-free, privacy-focused, and file-format-agnostic writing tool that integrates professional formatting and built-in version control. Its core value is enabling writers to work in plain text (.fountain or .md) while seeing a live, print-ready preview, all within a local-first, offline-capable application that respects user data and workflow ownership.

Main Features

1. Plain-Text-First Workflow with Live Preview: Writers compose in the Fountain markup language for scripts or Markdown for novels. The application's rendering engine parses this plain text in real-time and displays a formatted, paginated preview (Screenplay, Multi-cam, Stage Play, or Manuscript) side-by-side with the editor. This eliminates the need for manual formatting or a separate compilation step, merging the simplicity of a text editor with the output of dedicated typesetting software.
2. Integrated Git Version Control: River Writer embeds a full Git client within the application interface. Users can commit drafts, browse file history, view diffs, restore previous versions, and create branches (e.g., for alternate story endings) without using the command line or external tools. This feature provides professional-grade versioning and non-linear storytelling capabilities directly within the writing environment.
3. Project-Centric Organization with Sidebar Extras: A project in River Writer is a standard folder on the filesystem. The application enhances this with a sidebar containing integrated tools: an Outline (a navigable tree of scenes/sections), a Scratchpad for notes, and a Todos list. Critically, these are stored as plain text files (e.g., _river/outline.md) within the project folder, ensuring they are portable, editable elsewhere, and included in version control.
4. Native macOS Integration & Offline-Only Design: Built as a native macOS app (requiring macOS 13+), it adheres to platform conventions. The application is explicitly architected to make no network connections. It contains no telemetry, cloud sync, accounts, or AI features, ensuring complete data privacy and uninterrupted offline work. Autosave and crash recovery are handled locally.

Problems Solved

1. Pain Point: The disconnect between the creative writing process (often best done in simple, fast text editors) and the complex formatting requirements of professional scripts and manuscripts. Traditional solutions force a choice between a WYSIWYG word processor (which can be slow and opaque) or a separate compilation step from plain text to PDF.
2. Target Audience: Screenwriters and Playwrights who value the Fountain standard but want a dedicated, preview-enabled environment; Novelists seeking a clean, focused Markdown editor with manuscript formatting; Technically-inclined Writers who prefer plain text, use version control, and want to own their file ecosystem; Privacy-Conscious Creators who reject software with mandatory cloud services, subscriptions, or data collection.
3. Use Cases: Drafting and revising a feature-length screenplay with real-time page count; Writing a novel with chapter-by-chapter organization in the sidebar; Experimenting with major plot changes using Git branches without losing the original draft; Collaborating on a script via a shared Git remote (e.g., GitHub), using River Writer for local commits and merges; Writing in environments without reliable internet access.

Unique Advantages

1. Strengths & Limitations (Pros & Cons):

   • Pros: Unparalleled data ownership and privacy (no network calls); Seamless integration of professional formatting with plain-text source files; Powerful, built-in Git versioning lowers the barrier to professional workflow; Project files are 100% portable and future-proof; Completely free and open-source under the MIT license; Lightweight and fast due to Rust/Tauri architecture.
   • Cons: MacOS exclusive, with no support for Windows or Linux; Requires a self-build from source for installation, which demands technical comfort with command-line tools (Xcode CLT, Rust, Node.js); Lacks cloud-based collaboration features found in commercial tools; As a newer project, it may have a smaller community and less third-party integration compared to established alternatives.

2. Key Alternatives & Differentiation:

   • Final Draft / Celtx: Industry-standard commercial WYSIWYG screenwriting software. Differentiation: River Writer is free, uses open plain-text formats (vs. proprietary binary files), and includes integrated Git. It focuses on the writing/versioning process rather than production management features.
   • Highland / Slugline: Dedicated Fountain-based screenwriting apps. Differentiation: River Writer adds built-in Git, a project sidebar with outline/notes, and support for multiple document types (plays, novels) within a single app. Its development model (source-only) is also distinct from commercial sales.
   • Obsidian / VS Code with Plugins: General-purpose markdown editors that can be extended. Differentiation: River Writer is a purpose-built, opinionated environment with live, industry-standard page previews and deep Git integration out-of-the-box. It offers a cohesive, writer-specific experience without configuration.

Frequently Asked Questions (FAQ)

1. Is River Writer really free and private? Yes. River Writer is completely free, open-source (MIT license), and explicitly designed with a zero-network policy. It contains no telemetry, analytics, accounts, or cloud sync features, ensuring all your writing data remains exclusively on your local machine.
2. Can I open my River Writer projects in other software? Absolutely. Since projects are standard folders and documents are plain .fountain or .md files, you can open and edit them with any text editor (like VS Code, Obsidian, or even TextEdit). The _river subfolder contains supplementary files in plain text as well.
3. How does the built-in Git version control work? River Writer includes a full Git client in its interface. You can commit changes, view history, see diffs between versions, and create branches directly within the app. Your project folder is a standard Git repository, so you can also use command-line Git or push to remote repositories like GitHub.
4. What are the system requirements for River Writer? You need a Mac running macOS 13 (Ventura) or later. To build the application from source, you need Xcode Command Line Tools, Rust, Node.js, and pnpm. Once built, the application runs independently.
5. Can I use River Writer for collaborative writing? While the app itself is local and offline, collaboration is possible through its Git integration. Writers can work on the same Git repository, using branches and merges to synchronize changes. This is a more technical workflow compared to the real-time collaboration in cloud-based tools but offers greater control and history.