Skip to content

jerseycheese/BootHillGM

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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

BootHill Folder

Core Systems Folder

Development Workflows

Technical Folder

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published