Local-first AI writing assistant with story structure + chatbot + image prompt support.

• You are the author in the driver seat: your story is your story, and the AI is a creative partner (from brainstorm buddy to ghostwriter-style assistant) that supports your voice and choices.
• Join the community: r/AugmentedQuill

The fastest way to get started is to download a ready-to-run build from the Releases page, choosing the option that suits you:

The full Installation Guide walks through every method in detail.

Tip: For the simplest setup, use the published releases. Building from source is intended for development and contribution.

• Ensure your OpenAI-compatible API provider endpoint is running and reachable (local llama.cpp/Ollama endpoint or cloud OpenAI-compatible endpoint), and enter the key/URL in Settings before creating your first project.
• Talk to Writing Partner (AI chat)
• Create a project - or let the Writing Partner do it for you
• Add sourcebook entries - or let the Writing Partner do it for you
• Add chapters / short story content - or let the Writing Partner do it for you
• (Optional) Open Images panel and use prompt generator to create images in external tools

The complete user guide is in docs/user_manual/:

• Getting started
• Projects and settings
• The writing interface
• Chapters and books
• The Sourcebook
• Tutorial: writing your first story
• The AI chat assistant
• Search and replace
• Project images
• Appearance and display
• Writing your story: a practical roadmap
• Scenes, annotations, and structural improvements
• Troubleshooting & FAQ

Tip: Start with 01_getting_started.md, then 03_writing_interface.md.

• Project-based story authoring (short story, novel, series)
• Multi-chapter and multi-book structure
• Live AI writing assistant and chat (local API key / OpenAI-compatible endpoints)
• Custom prompt pipelines (editor, writer, chat voices)
• Sourcebook (characters, scenes, lore, items, etc.)
• Image metadata + optimized image prompt generation
• Config-driven with JSON templates and env overrides
• Auto-captured project artifacts in data/projects

• Local-first app. No built-in auth. Do not expose to public internet without reverse proxy + access control.
• Security model: single-user local use.
• Browser-based LLM calls may require CORS-friendly endpoints or use internal proxy route /api/v1/openai/models.
• AugmentedQuill does not include an LLM server; you must point it at an OpenAI-compatible API endpoint (self-hosted or cloud). For local use, set up a compatible host such as llama.cpp endpoints, Ollama, or another OpenAI API compliant server.
• For easier setup and releases, try the official Electron or Docker builds provided with each release instead of building from source.

Want to modify the code, contribute a feature, or run a local instance from source? See the Developer Guide for:

• Repository layout
• Development setup and commands (backend + frontend)
• The optional dev container
• Configuration paths and model endpoint variables
• QA requirements and branching conventions

Contributors should also read CONTRIBUTING.md. Technical deep dives live in docs/ARCHITECTURE.md and docs/ORGANIZATION.md.

• No multi-user access controls.
• No real-time external editor sync.

AugmentedQuill natively supports multiple languages for both the application interface (GUI) and your story formatting. Use Settings > General > GUI Language to configure the application locale, and the language will automatically be respected.