📄 START_HERE.md (THIS IS YOUR ENTRY POINT!)
- Complete overview of the system
- What I built for you
- How to use it
- Next steps
📄 QUICKSTART.md
- Get running in 5 minutes
- Essential commands
- Troubleshooting
- Common use cases
🔧 setup.sh
- Automated setup script
- Checks dependencies
- Starts Docker services
- Usage:
bash setup.sh
📄 .env.example
- Environment configuration template
- Copy to
.envand add your API keys - Required: OpenAI API key
📄 README.md
- Complete documentation (500+ lines)
- Full API reference
- Architecture diagrams
- Development guide
- Examples and tutorials
📄 PROJECT_SUMMARY.md
- Detailed breakdown of what I built
- Component descriptions
- Design decisions
- Technical details
- Future roadmap
🐍 demo.py
- Complete working demo (400+ lines)
- Shows full gameplay session
- Creates campaign & characters
- Runs combat encounter
- Demonstrates memory system
- Usage:
python demo.py
📄 docker-compose.yml
- Docker configuration
- Defines services:
- Qdrant (vector database)
- Backend API server
- Usage:
docker-compose up -d
📄 .gitignore
- Files to ignore in git
- Protects secrets and data
🐍 api_server.py (565 lines)
- FastAPI REST API server
- All HTTP endpoints
- WebSocket support
- Main entry point for API access
🐍 enhanced_character.py (570 lines)
- Complete character system
- D&D stats and mechanics
- Character "laptops" (notebooks)
- Memory-driven decisions
- Vector DB integration
🐍 game_mechanics.py (445 lines)
- D&D 5e combat system
- Skill checks
- Dice rolling
- Spell casting (framework)
- Environmental interactions
🐍 game_room.py (550 lines)
- Game session management
- DM system with master vector DB
- Session transcripts
- Turn-based gameplay
- Campaign management
🐍 memory_system.py (791 lines)
- Temporal consciousness engine
- Memory consolidation (episodic → semantic)
- Temporal landmarks
- Autobiographical narratives
- Identity persistence
🐍 vector_memory.py (472 lines)
- Qdrant vector database integration
- Semantic memory retrieval
- Weighted scoring system
- In-memory fallback
🐍 cultural_transmission.py (532 lines)
- Skill teaching & learning
- Cultural evolution
- Imitation learning
- Transmission fidelity tracking
📄 requirements.txt
- Python dependencies
- LangChain, FastAPI, Qdrant, etc.
- Install:
pip install -r requirements.txt
📄 Dockerfile
- Container definition for backend
- Python 3.11 slim base
- Installs dependencies
- Runs API server
Code:
- 7 Python modules
- 3,200+ lines of production code
- 1 FastAPI server (565 lines)
- 1 Demo script (400 lines)
Documentation:
- 5 markdown files
- 2,000+ lines of documentation
- Complete API reference
- Quick start guides
Infrastructure:
- Docker Compose setup
- Dockerfile
- Environment configuration
If you want to understand the system:
- START_HERE.md - Big picture overview
- QUICKSTART.md - How to run it
- demo.py - See it working
- README.md - Deep dive
- PROJECT_SUMMARY.md - Technical details
If you want to use the system:
- QUICKSTART.md - Commands to run
- setup.sh - Automated setup
- README.md - API reference
If you want to extend the system:
- PROJECT_SUMMARY.md - Architecture
- backend/api_server.py - API structure
- backend/enhanced_character.py - Character system
- backend/memory_system.py - Memory mechanics
Looking for...
- How to start? → QUICKSTART.md
- What this is? → START_HERE.md
- API endpoints? → README.md (API Reference section)
- Code examples? → demo.py
- Character creation? → enhanced_character.py
- Combat system? → game_mechanics.py
- Memory system? → memory_system.py
- DM features? → game_room.py
- Dependencies? → requirements.txt
- Docker setup? → docker-compose.yml
ai_society_dnd/
├── START_HERE.md ← Read this first!
├── QUICKSTART.md ← Get running fast
├── README.md ← Full documentation
├── PROJECT_SUMMARY.md ← Technical details
├── FILE_INDEX.md ← This file
├── setup.sh ← Automated setup
├── demo.py ← Working example
├── docker-compose.yml ← Infrastructure
├── .env.example ← Config template
├── .gitignore ← Git exclusions
└── backend/ ← All Python code
├── api_server.py ← REST API
├── enhanced_character.py ← Characters
├── game_mechanics.py ← D&D rules
├── game_room.py ← Sessions & DM
├── memory_system.py ← Consciousness
├── vector_memory.py ← Vector DB
├── cultural_transmission.py ← Learning
├── requirements.txt ← Dependencies
└── Dockerfile ← Container
Minimum to run:
- Docker & Docker Compose
- .env file with OpenAI API key
- Run:
docker-compose up -d
To understand:
- Read START_HERE.md
- Run demo.py
- Try API commands from QUICKSTART.md
To extend:
- Read PROJECT_SUMMARY.md
- Study the backend/ code
- Check README.md for API structure
Ready? Start with START_HERE.md then run bash setup.sh! 🚀