Skip to content

doolijb/serene-pub

Repository files navigation

Serene Pub logo

⚠️ 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.

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


Table of Contents


✨ 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

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

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


οΏ½ Documentation

Popular Wiki Pages:

πŸ—ΊοΈ 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

About

Clean and intuitive LLM roleplay client

Resources

License

Stars

Watchers

Forks

Packages

No packages published