campaign-rpg-engine 1.0.1

CampAIgn — map-based LLM RPG simulation engine (Session API, multi-area worlds, compound turns)

CampAIgn RPG Engine

Grid-based LLM agent simulation engine: multi-area worlds, compound turns (move → look → speak → interact/emote), pluggable memory modules, and a stable campaign_rpg_engine library API. Build your own UI and scenarios on the engine; use CampAIgn-RPG-Studio as a full GM reference app.

License: MIT — open source.

Current version: 1.0.0 — library-first package (campaign_rpg_engine only; no CLI). See Migration from 0.7 and the changelog index.

Quick start

cd path\to\CampAIgn-RPG-Engine
uv sync
uv run pytest

from campaign_rpg_engine import Session, load_profile, AgentCompoundTurn

session = Session.from_profile(load_profile("default_compound"))
session.create_agent(name="Scout", position=(0, 0), personality="Curious.")
session.create_object(name="Chest", position=(2, 1), passive_description="An old chest.")
prompt = session.build_prompt()
result = session.run_compound_turn(
    AgentCompoundTurn(reasoning="look around", action="none"),
)

GM web UI: clone CampAIgn-RPG-Studio (separate GitHub repo):

cd path\to\CampAIgn-RPG-Studio
uv sync
copy .env.example .env   # optional; or use Settings gear in the UI
uv run campaign-rpg-studio

On Windows, if Smart App Control blocks uv run campaign-rpg-studio, use uv run python -m backend.main. Open http://127.0.0.1:8765.

Environment

Copy .env.example to .env and set OPENROUTER_API_KEY for LLM turns. Optional OPENROUTER_MODEL (default deepseek/deepseek-v4-flash). Engine tests mock the LLM — no key required for uv run pytest.

CampAIgn-RPG-Studio Settings (gear icon) can set API key and model in memory for the current server process only — nothing is written to disk.

Custom memory modules

Register .py modules at process startup before creating agents or loading saves:

from campaign_rpg_engine import register_memory_module_from_path

register_memory_module_from_path("path/to/my_module.py")
session.create_agent(..., memory_module="my_module_id")

Saves store module_id + state only (no bundled source). Import fails if a save references a module that is not loaded. Sample module and upload UI: CampAIgn-RPG-Studio fixtures/custom_memory/.

Lorebooks

Load SillyTavern-style .json lorebooks via session.load_lorebook_from_path(...) or CampAIgn-RPG-Studio Lorebooks tab. Add a lorebook prompt block in Prompt layout to inject matched world info. Not included in the default prompt layout.

Tests

uv run pytest

CampAIgn-RPG-Studio API tests live in the CampAIgn-RPG-Studio repo.

Documentation

Start at docs/README.md — guides, API overview, and changelog index.

Doc	Topic
Building on CampAIgn-RPG-Engine	App integration (typed API, hosting)
API reference	campaign_rpg_engine exports and Session methods
Migration realm-fabric → campaign-rpg-engine	Rename from Realm-Fabric / realm_fabric
CampAIgn-RPG-Studio	Full GM reference UI (GitHub)
Roadmap	Version plans
Long-term goals	Aspirational features

Older version notes: changelog index.