SammyAI

SammyAI is a creative writing assistant that helps writers brainstorm, draft, and refine stories of all genres and types.

Official Website

---

About   |   User Guide   |   Stories   |   Best Practices

---

🔑 Key Features

• Multi-model Chat: Seamlessly switch between different AI models during a single session to tailor assistance to your specific needs.
• Context Injection (CIN): Directly inject specific reference files into the current AI conversation for informed brainstorming.
• Retrieval-Augmented Generation (RAG): Index your project files to provide the AI with a deep "memory" of your world and characters.
• Diff-Based Editing (DBE): Review AI suggestions via visual diffs and surgically apply changes to your drafts.

🚀 Getting Started

Prerequisites

• Python 3.10+
• Ollama (for local model support)

Quick Install

1. Clone the repository:

   git clone https://github.com/sasadjukic/sammyai.git
   cd sammyai

2. Install dependencies:

   pip install -r requirements.txt

3. Run SammyAI:

   python text_editor.py

For detailed installation options including Docker support, see the Installation Guide.

📖 Stories

SammyAI is a valuable collaborative partner for:

• Essays & Short Stories: From flash fiction to complex narratives.
• Novels & Epics: Build rich fictional worlds of all genres.
• Screenplays & TV Pilots: Tailored for movies and TV/streaming series.
• Game Development: Fast-track your world-building and dialogue creation.

Check out our Story Archive to see examples of what SammyAI can help you create.

🔒 Privacy & Copyrights

• 100% Free: Leverage local models and free cloud tiers.
• Privacy First: SammyAI does not collect or store your data. Everything runs locally on your PC.
• Your Rights: You retain full ownership and copyright of everything you create.

Read more in our Cost, Privacy and Copyrights document.

🗺️ Roadmap

Planned updates include:

• Long-Form Stress Testing: Ensuring stability for full-length novels.
• Custom LLM Integration: Bringing your own models into the workflow.
• Improved Dialogue System: Dialogue that tailors to your character traits and speech patterns.
• UI Improvements: Improving UI and UX.

See Planned Updates for more details.

⚖️ License

This project is licensed under the MIT License.