⚠️ Serene Pub is in alpha! Expect bugs and rapid changes. This project is under heavy development.

📚 Documentation • ⬇️ Downloads • 🐛 Issues • 💬 Discord • ☕ Buy Me a Coffee

---

🦊 Serene Pub

Modern, Open Source AI Roleplay Chat

Serene Pub is a brand new, open source chat application for immersive AI roleplay and creative conversations. Designed for simplicity, speed, and beautiful usability, Serene Pub brings your characters and worlds to life—on your terms, with your data, and your favorite AI models.

📚 Full Documentation & Setup Guide

For detailed installation instructions, configuration guides, and tutorials, visit our Wiki.

---

Table of Contents

• Why Serene Pub?
• Screenshots
• Features
• Quick Start
• Documentation
• Contributing
• License

---

✨ Why Serene Pub?

• Zero Clutter, Maximum Fun: Clean, intuitive UI with minimal menus and instant access to everything you need.
• Real-Time Sync: All chats, settings, and characters update live across devices via WebSockets.
• Portable & Private: Runs locally, no accounts, no cloud lock-in. Your data stays with you.
• AI Freedom: Connect to OpenAI, Ollama, LM Studio, Llama.cpp, and more. Mix and match models, run local or cloud.
• Low fuss local AI: Use Ollama manager to search, download and activate models all within the comfort of Serene Pub.
• Roleplay-First: Built for character-driven, story-rich experiences. Import Silly Tavern cards, manage personas, and more.
• Coherence: Some user's report characters adhere better to their profiles than other apps.
• Group Chats: Chat with as many characters at once as you wish.
• Mobile Ready: Responsive design for desktop and mobile. Pick up your story anywhere.
• Open Source: AGPL-3.0. Hack it, extend it, make it yours!

---

🖼️ Screenshots

Desktop Experience

Chat & Editing	Connections & Characters	Contexts & Lorebooks

Prompt Details	Prompts & Chats	Sampling & Personas

Theme Example 1	Theme Example 2	Theme Example 3

Theme Example 4	Theme Example 5

Lorebooks+ & Worldbuilding

Character Bindings	Character Lore	Lorebook History	World Lore

Ollama Manager

Available Models	Downloads	Installed Models	Settings

Mobile Experience

Chat	Connections	Edit Character

Home	Navigation

---

🚀 Features

• AI Model Agnostic: Connect to OpenAI, Ollama, Llama.cpp, and more
• Ollama Manager: Built-in UI to easily manage, download, and activate Ollama models
• Character & Persona Management: Import, create, and edit with rich metadata and avatars
• Lorebooks+: Organize world lore, character lore, and history for deep roleplay
• Group Chats: Multi-character chats for immersive group roleplay and dynamic storylines
• Tags: Easily organize and filter chats, characters, personas, and lorebooks with customizable tags
• Chat & Context Tools:
  • Auto character response
  • Edit/delete messages
  • Streaming & regenerate
  • Manual & hidden responses
  • Swipe left/right on messages
  • Live token and history stats
• Prompt Statistics: View compiled prompts before sending
• Context Templates: Handlebar-based, customizable prompt formats
• Mobile-First Design: Fully responsive, works great on phones and tablets
• Themes & Dark Mode: 20+ themes, instant switching, and accessibility options
• Accessibility & Screen Reader Support: Experimental support for screen readers and assistive technologies (in progress)
• Portable & Secure: Embedded database, no cloud required, runs anywhere
• Silly Tavern Compatibility: Import/export character cards and avatars
• Open Source & Extensible: AGPL-3.0, modular adapters, easy to hack

---

🛠️ Quick Start

Download & Run (No Install Required)

Linux, MacOS and Windows are supported!

1. Download the latest release for your OS
2. Extract the archive anywhere
3. Read the included INSTRUCTIONS.txt for your platform
4. Run the launcher script (run.sh/run.cmd)
5. Open http://localhost:3000 in your browser
6. Add your first AI connection and start chatting!

From Source

Requirements

• Node.js
• (Optional) Ollama for local models

Steps

1. Clone this repo
2. npm i to install dependencies
3. npm run dev to start the dev server, or npm run dev:host
4. Visit http://localhost:5173

🐳 Docker

Pre-built images are published to the GitHub Container Registry on every release:

ghcr.io/doolijb/serene-pub:latest   ← always the latest stable release
ghcr.io/doolijb/serene-pub:1.2.3    ← exact version pin

Quickstart — download docker-compose.dist.yml from the release assets, then:

docker compose -f docker-compose.dist.yml up -d

The web UI will be at http://localhost:3000.

Data directory — all persistent data (database, model cache, uploads) is stored under a single directory controlled by the SERENE_PUB_DATA_DIR environment variable. The default inside the container is /data, which is mounted as a named Docker volume. To use a host path instead:

docker run -p 3000:3000 -p 3001:3001 \
  -e SERENE_PUB_DATA_DIR=/data \
  -v "$(pwd)/serene-pub-data":/data \
  ghcr.io/doolijb/serene-pub:latest

See DOCKER.md for full documentation — ports, volumes, reverse proxy setup, Ollama/KoboldCPP integration, and more.

Need help? Check out our Setup Guide in the wiki.

---

<EFBFBD> Documentation

Complete Documentation Available in our Wiki

Popular Wiki Pages:

• Installation & Setup - Detailed setup instructions for all platforms
• Connections - How to connect to AI models (OpenAI, Ollama, LM Studio, etc.)
• Characters & Personas - Creating and managing your roleplay characters
• Lorebooks - Advanced world-building and context management
• Context Templates - Customizing AI prompts with Handlebars
• Troubleshooting - Common issues and solutions

🗺️ Planned Features

• 🧠 Vectorization / embeddings
• 🤖 Assistant Chat: Ask AI questions about Serene Pub and get suggestions to improve your characters, personas, and lore
• 🤖 Assistant Chat: In-chat OOC discussions
• 🖼️ Image generation
• 📝 Chat summarizing
• 👥 Multi-user logins & multi-user group chats
• 👥 Admin user account management

💡 Considered Features

• 🖼️ User/chat backgrounds
• 📖 Story narration/system instructions
• 📅 Lorebooks+ features: custom calendars, "eras" historical categories, and more
• 🕹️ Text adventure & narrator modes

---

❤️ Contributing

Serene Pub is community-driven! Bug fixes, features, and feedback are welcome. Please open an issue or start a discussion before submitting large changes.

For development setup and contribution guidelines, see our Contributing Guide.

---

🛡️ License

AGPL-3.0. See LICENSE and NOTICE.md for details.

---

🙏 Special Thanks

Special thanks to crazyaphro and Nivelle for Q/A, M3d4r for editing the Wiki, and .

---

Serene Pub — Play more, tweak less. 100% open source.
📚 Read the full documentation