README.md

BootHillGM Project

BootHillGM is a web application providing an AI-driven Game Master for the Boot Hill tabletop RPG, offering an engaging, user-friendly experience for solo players in the Western genre. Built with Next.js, it's designed to run in modern web browsers.

Key Features (MVP)

• Boot Hill Character Creation with AI-driven generation
• AI-powered Game Mastering for Western settings using Gemini 1.5 Pro
• AI-powered NPCs with persistent memory
• Game Session and State Management with automatic saving and restoration
• Boot Hill's percentile dice system for chance-based outcomes
• Character Sheet View with stat and status displays
• Inventory Management with item usage and tracking
• Turn-based combat system with Boot Hill mechanics, including weapon and brawling combat
• Strength system implementation with derived stats and modifiers
• Automatic journal entry system with search and filtering

Technical Stack

• Platform: Web application using Next.js 14.x with App Router
• AI Model: Gemini 1.5 Pro API (Google Generative AI)
• Development Environment: Visual Studio Code, Git for version control
• User Interface: React with Tailwind CSS for wireframe styling
• State Management: React Context with useReducer for global state management
• Data Persistence: localStorage for simple data storage

Getting Started

1. Clone the repository
2. Install Node.js and npm if not already installed
3. Navigate to the BootHillGMApp directory and run: npm install
4. Set up your Gemini API key:
   • Create a .env file in the BootHillGMApp directory
   • Add your API key to this file: GEMINI_API_KEY=your_api_key_here
   • Ensure this file is added to .gitignore to keep your API key secure
5. To run the app:
   • npm run dev

Project Documentation

Docs Folder Structure

• AIGameMasterLogic.md: Details on the AI Game Master's logic and decision-making processes.
• ArchitectureDecisionRecord.md: Record of key architectural decisions made for the project.
• ComponentBreakdown.md: Breakdown of the main components of the BootHillGM project.
• DevelopmentRoadmap.md: Roadmap outlining the development phases and milestones.
• GameDesignDocument.md: Comprehensive game design document.
• ProjectOverview.md: High-level overview of the BootHillGM project.
• RiskAssessment.md: Assessment of potential risks and mitigation strategies.
• TechnicalSpecification.md: Detailed technical specifications for the project.
• UIWireframes.md: User interface wireframes for the app.

BootHill Folder

• Boot Hill v2 Basic Rules.txt: Basic rules for Boot Hill version 2.

Core Systems Folder

• AI Integration: Details on AI system integration
• Character Generation: Character creation process and rules
• Combat System: Combat mechanics and rules
• Journal System: Journal system functionality and design
• State Management: State management approach and implementation
• Strength System: Strength system mechanics and calculations
• Combat Modifiers: Combat modifiers and their effects

Development Workflows

• Claude Workflow: Guidelines for using Claude in development
• Project Analysis Prompt Example: Example prompt for project analysis

Technical Folder

• Gemini-API-Integration-Guide.md: Guide for integrating the Gemini API.
• Setup Guide: Instructions for setting up the development environment
• Dependencies: Overview of project dependencies
• Environment Configuration: Guide to configuring environment variables
• Testing Guide: Information on testing procedures and tools
• Development Workflow: Best practices for development workflow