Skip to content

nordevelopment/OpenRoleplayChat

Repository files navigation

Open Roleplay Chat (ORC) 🤖🎭

The easiest way to chat, roleplay, and build AI agents on your own server. Clean, fast, and simple.

ORC is a lightweight, beautiful web application for personal roleplaying and chatting with AI. You can create custom characters, give them unique personalities, and even let them write files or generate images for you.

For developers and advanced users, check the technical guide: Technical Documentation & Settings (DOCS.md).


✨ Features (Explained Simply)

  • 🧠 Long-Term Memory: Characters actually remember facts about you and the story. No more "forgetting" what you discussed 10 messages ago!
  • 💬 Real-Time Chat: Messages stream in word-by-word, just like talking to a real person.
  • 🎭 Visual Character Catalog: Easily add, edit, or delete characters directly from your browser. Upload custom avatars, write scenarios, and customize behavior without editing code.
  • 🎨 AI Image Generator: Ask the AI to paint a picture, or generate images manually with direct aspect ratio controls.
  • 🛠️ AI Tools (Agents): Give characters the ability to create text files or paint pictures in a safe sandbox folder.
  • 📱 Telegram Bot Support: Talk to Natalia or your custom assistants right inside Telegram (optional setup).

🚀 Quick Start (For Everyone)

Setting up Open Roleplay Chat takes less than 5 minutes. Just follow these steps:

1. Download and Install

  1. Download this project folder to your computer.
  2. Open your terminal/command prompt in the project folder and run:
    npm install

2. Launch the App

Start the local server by running:

npm run dev

3. Setup in Your Browser

  1. Open your browser and go to: http://localhost:3000
  2. Step 1 (Settings): Enter your OpenRouter API key (you can get one at openrouter.ai).
  3. Step 2 (Database Initialization): Click the "INITIALIZE DATABASE" button. This will automatically structure the application and create your characters.
  4. Log In: Click "GO TO LOGIN" and log in using the default credentials:
    • Email: admin@example.com
    • Password: 12345678

Note: You can easily change this email and password in your Profile Settings once you log in!


📸 Screenshots

Chat Interface Characters Management Image Generation Panel

🛠️ Advanced Settings & Development

Need to set up the Telegram webhook, edit environment variables, check the SQLite database schema, or contribute to code?

👉 Refer to DOCS.md for complete technical details.


⭐ Support & Licensing

  • Open Roleplay Chat is licensed under the permissive MIT License.
  • If you run into issues, please report them on GitHub Issues.
  • If you enjoy using ORC, please give this repository a star! ⭐

About

A lightweight, self-hosted AI characters chatbots app based on NodeJs and SQLite. Supports SSE streaming and automated history summarization, image genereation

Topics

Resources

License

Stars

1 star

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors