Barebones RPG Framework Documentation¶

A flexible, code-first Python framework for building turn-based RPG games with support for procedural generation and AI-driven content.

Overview¶

Barebones RPG is a Python framework designed to be a foundation for creating RPG games. It provides all the essential systems needed for an RPG, but with no content - making it a perfect starting point for your own games and stories.

Key Features¶

Code-First Design: Primary interface is Python classes and functions for programmatic game creation
Fully Extensible: Hooks, events, and overridable behavior throughout
Flexible Architecture: Supports both hand-crafted and procedurally generated content
Turn-Based Combat: Built-in combat system with extensible action framework
Rich Systems: Entities, items, inventory, quests, dialog trees, world/map management
Data Loading: Optional JSON/YAML support for data-driven content
Rendering Abstraction: Pygame-based UI with clean separation from game logic
AI-Ready: Designed to easily integrate with LLMs for dynamic content generation

Quick Start¶

Installation¶

# Clone the repository
git clone https://github.com/PierceGov/barebones_rpg.git
cd barebones_rpg

# Install with uv (recommended)
uv sync --dev

# Or with pip
pip install -e ".[dev]"

Basic Example¶

from barebones_rpg import Game, GameConfig, Character, Enemy, Stats, Combat

# Create game
game = Game(GameConfig(title="My RPG"))

# Create characters
hero = Character(
    name="Hero",
    stats=Stats(strength=15, constitution=12, dexterity=10,
                intelligence=8, charisma=10, base_max_hp=50, hp=100)
)
goblin = Enemy(
    name="Goblin",
    stats=Stats(strength=8, constitution=6, dexterity=12,
                intelligence=5, charisma=5, base_max_hp=20, hp=30)
)

# Create combat
combat = Combat(
    player_group=[hero],
    enemy_group=[goblin],
    events=game.events
)
combat.start()

Documentation Sections¶

Examples

Development