aodhan/storyteller
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Reorganize and consolidate documentation

Browse Source 
Documentation Structure:
- Created docs/features/ for all feature documentation
- Moved CONTEXTUAL_RESPONSE_FEATURE.md, DEMO_SESSION.md, FIXES_SUMMARY.md, PROMPT_IMPROVEMENTS.md to docs/features/
- Moved TESTING_GUIDE.md and TEST_RESULTS.md to docs/development/
- Created comprehensive docs/features/README.md with feature catalog

Cleanup:
- Removed outdated CURRENT_STATUS.md and SESSION_SUMMARY.md
- Removed duplicate files in docs/development/
- Consolidated scattered documentation

Main README Updates:
- Reorganized key features into categories (Core, AI, Technical)
- Added Demo Session section with quick-access info
- Updated Quick Start section with bash start.sh instructions
- Added direct links to feature documentation

Documentation Hub Updates:
- Updated docs/README.md with new structure
- Added features section at top
- Added current status (v0.2.0)
- Added documentation map visualization
- Better quick links for different user types

New Files:
- CHANGELOG.md - Version history following Keep a Changelog format
- docs/features/README.md - Complete feature catalog and index

Result: Clean, organized documentation structure with clear navigation
This commit is contained in:
Aodhan Collins
2025-10-12 00:32:48 +01:00
parent d5e4795fc4
commit da30107f5b
14 changed files with 528 additions and 1430 deletions
Download Patch File Download Diff File Expand all files Collapse all files

71
README.md
View File

@@ -4,13 +4,23 @@ A storyteller-centric roleplaying application where characters communicate **pri
## ✨ Key Features
### Core Features
- **🔒 Private Character-Storyteller Communication**: Each character has a completely isolated conversation with the storyteller - no character can see what others are saying or receiving
- **📢 Flexible Messaging System**: Private, public, or mixed messages for different roleplay scenarios
- **🎲 Storyteller-Centric Workflow**: The storyteller sees all character messages and responds to each individually
- **🤖 Multiple LLM Support**: Each character can use a different AI model (GPT-4, Claude, Llama, Gemini, Mistral, etc.) via OpenRouter or OpenAI
- **📜 Scene Narration**: Storyteller can broadcast scene descriptions visible to all characters
- **🧠 Isolated Memory Sessions**: Each character maintains their own separate conversation history with the storyteller
- **🧠 Context-Aware AI**: Generate responses considering multiple characters' actions simultaneously
- **🎮 Demo Session**: Pre-loaded "Cursed Tavern" adventure with two characters for instant testing
### AI & LLM Support
- **🤖 Multiple LLM Support**: GPT-4o, GPT-4, GPT-3.5, Claude, Llama, Gemini, Mistral (100+ models via OpenRouter)
- **✨ AI-Assisted Responses**: Get AI suggestions for storyteller responses
- **🎯 Smart Context Building**: AI considers character profiles, personalities, and conversation history
### Technical Features
- **⚡ Real-time WebSocket Communication**: Instant message delivery
- **🧠 Isolated Memory Sessions**: Each character maintains their own separate conversation history
- **🎨 Modern, Beautiful UI**: Clean, intuitive interface with gradient themes
- **📱 Responsive Design**: Works on desktop, tablet, and mobile
## 🎯 How It Works
@@ -69,27 +79,51 @@ A storyteller-centric roleplaying application where characters communicate **pri
npm install
```
## Running the Application
## 🚀 Quick Start
### Start the Backend
### Easy Start (Recommended)
From the project root directory:
Use the startup script to launch both backend and frontend:
**Linux/Mac:**
```bash
bash start.sh
```
**Windows:**
```bash
start.bat
```
This will:
1. Start the FastAPI backend on `http://localhost:8000`
2. Start the React frontend on `http://localhost:3000`
3. Create a demo session automatically
4. Open your browser
### Demo Session 🎲
A pre-configured "Cursed Tavern" adventure is automatically created with:
- **Session ID:** `demo-session-001`
- **Characters:** Bargin (Dwarf Warrior) & Willow (Elf Ranger)
- **Quick-access buttons** on the home page
Just click a button and start playing!
### Manual Start
If you prefer to run services separately:
**Backend:**
```bash
uvicorn main:app --reload
```
The backend will be available at `http://localhost:8000`
### Start the Frontend
In a new terminal, navigate to the frontend directory and run:
**Frontend:**
```bash
cd frontend
npm start
cd frontend && npm start
```
The frontend will open in your default browser at `http://localhost:3000`
## 🎮 How to Use
### As the Storyteller
@@ -184,10 +218,15 @@ Each character has a **completely isolated** conversation with the storyteller:
All project documentation is organized in the [`docs/`](./docs/) folder:
### Quick Links
- **[Features Guide](./docs/features/)** - All features with examples and guides
- [Demo Session](./docs/features/DEMO_SESSION.md)
- [Context-Aware Responses](./docs/features/CONTEXTUAL_RESPONSE_FEATURE.md)
- [Bug Fixes Summary](./docs/features/FIXES_SUMMARY.md)
- **[Setup Guides](./docs/setup/)** - Quick start and installation
- **[Planning](./docs/planning/)** - Roadmaps and feature plans
- **[Reference](./docs/reference/)** - Technical guides and file references
- **[Development](./docs/development/)** - Session notes and implementation details
- **[Development](./docs/development/)** - Testing and implementation details
See [docs/README.md](./docs/README.md) for the complete documentation index.