Skip to main content

MnesOS is fully Agentic RPG Game Engine.

Project description

MnesOS

MnesOS is an agentic RPG engine that separates deterministic game mechanics from LLM-driven narration.

PyPI version Documentation

What It Does

MnesOS combines four concerns into a single turn pipeline:

  • VectorLoreStore retrieves relevant lore from bot_lore.md
  • the Director LLM maps player intent to YARE events
  • YAREInterpreter applies deterministic state changes
  • the Director can query NPC intents via the query_npc_intent tool
  • the Narrator LLM reacts to the resolved turn The engine state is explicit. The caller passes a GameState into app.invoke(...) and receives the updated state back.

Turn Model

The graph itself is stateless between invocations. The client is responsible for persisting and re-supplying the returned game state for the next turn.

  • client_messages: persistent story history owned by the caller
  • agent message lists: per-node, per-turn working prompts rebuilt on each invocation
  • bot_memory: persistent deterministic world state

Cartridge Layout

Each cartridge lives under cartridges/<name>/ and contains:

  • yare.yaml: procedural rules and state schema
  • bot_lore.md: markdown lore used for retrieval
  • prompt_directives.yaml: optional LLM directives for director, npc, and narrator

prompt_directives must not be embedded in yare.yaml; the loader rejects that configuration.

Installation

pip install MnesOS

Development

python -m venv venv
source venv/bin/activate
pip install -e ".[dev,docs]"

Run Tests

python -m pytest

Build Docs

mkdocs build

Further Reading

  • docs/architecture.md: current graph architecture and turn flow
  • docs/cartridge-guide.md: cartridge authoring guidance
  • docs/yare-specification.md: supported YARE syntax and execution rules

License

MIT.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mnesos-0.6.0.tar.gz (644.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mnesos-0.6.0-py3-none-any.whl (72.9 kB view details)

Uploaded Python 3

File details

Details for the file mnesos-0.6.0.tar.gz.

File metadata

  • Download URL: mnesos-0.6.0.tar.gz
  • Upload date:
  • Size: 644.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for mnesos-0.6.0.tar.gz
Algorithm Hash digest
SHA256 237a190636d43edd2b210e12fbdfa1205ddb7f8d1962628ca2c9c4b47cda4d42
MD5 bcae85d67da6ae046b038d4f70111116
BLAKE2b-256 f4f3d3e8ebd5b8c11e369e239c96b4e0af92892cc5fd1dd172cb0f0fea6f8ab0

See more details on using hashes here.

Provenance

The following attestation bundles were made for mnesos-0.6.0.tar.gz:

Publisher: release.yml on neolaw84/MnesOS

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file mnesos-0.6.0-py3-none-any.whl.

File metadata

  • Download URL: mnesos-0.6.0-py3-none-any.whl
  • Upload date:
  • Size: 72.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for mnesos-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 23bc0ea8664fcc82f5dc2657855cd73d0cff31fa0e1acc67e05158a9209c87bf
MD5 0ec12a7d58e868c8aa1c78668dbc4819
BLAKE2b-256 1abc3e18d03ed96fd00ecbe0d9157ae805808ed43dac404d24a6d4b8c5ab5fa5

See more details on using hashes here.

Provenance

The following attestation bundles were made for mnesos-0.6.0-py3-none-any.whl:

Publisher: release.yml on neolaw84/MnesOS

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page