Skip to main content

MnesOS is fully Agentic RPG Game Engine.

Project description

MnesOS

MnesOS is a stateless, event-sourced agentic RPG engine that operates on a Bring-Your-Own-Key (BYOK) model. It is designed to solve the unreliability of traditional "LLM-only" RPGs by explicitly separating deterministic logic from high-fidelity narrative orchestration.

🌟 Key Features & Architecture

  • Deterministic Rules (YARE): All state mutation, math operations, and RNG are handled by the non-Turing complete YARE Agentic Rules Engine rather than the LLM.
  • Air-Gapped Narration: MnesOS utilizes a two-node LangGraph structure (Director and Narrator), isolating system mechanics and numbers from the narrative output.
  • Stateless & Branchable: The backend retains no operational memory across network turns, employing a tree-based event source model that natively supports branching timelines.
  • Secure Identity: Uses a zero-knowledge, side-by-side authentication approach where API keys are passed in-flight via PKCE and never stored on the server.

For comprehensive details on the engine's mechanics and design constraints, read the Architecture Design and Core Philosophy documents.

🚀 Getting Started

For Players

MnesOS can be installed as a pre-compiled Python package, bundling the backend and frontend into a single instance:

pip install MnesOS[api]
uvicorn MnesOS.api.app:app --host 127.0.0.1 --port 8000

Refer to the Player Guide for full instructions on setting up your environment, navigating the UI, and connecting your local OpenRouter credentials.

For Cartridge Developers

MnesOS games are distributed as "Cartridges". A cartridge typically contains:

  • yare.yaml: Defines the deterministic state schema and logic. Read the YARE Specification for syntax rules and capabilities.
  • bot_lore.md: Markdown-formatted world facts, item definitions, and NPC details used for context retrieval.
  • prompt_directives.yaml: Per-role steering instructions for the Director, Narrator, and NPC roles.

Check the Cartridge Developer Guide to learn about best practices, including semantic grounding and phase-based combat intention.

For Engine Contributors

MnesOS requires Python 3.12+ and Node.js (v20+ LTS) for full-stack, split-terminal development.

  • Setup & Testing: Learn about Makefile commands, continuous integration gating rules, and test runners in the CI/CD & Build Instructions.
  • Codebase Structure: Familiarize yourself with the Python/React layers and directory locations in the Directory Map.
  • Interfaces: Review the generated API Reference for backend endpoint details.

📚 Full Documentation Map

Our detailed documentation is organized tightly by domain:

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.7.0.tar.gz (1.7 MB view details)

Uploaded Source

Built Distribution

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

mnesos-0.7.0-py3-none-any.whl (163.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for mnesos-0.7.0.tar.gz
Algorithm Hash digest
SHA256 450b7d5d4e97be12a4abde656e072ab568e8f77ee9642f98c824ecb15488d0ef
MD5 22c4033c38f3f95ea78437ad5a1c55d6
BLAKE2b-256 a95e9f9ffb12c7ff911b69b4342c9bc6563a949696a4256119f25968842b9d21

See more details on using hashes here.

Provenance

The following attestation bundles were made for mnesos-0.7.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.7.0-py3-none-any.whl.

File metadata

  • Download URL: mnesos-0.7.0-py3-none-any.whl
  • Upload date:
  • Size: 163.2 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.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ac07b74554b4f332127208d089c56a1c91afc2ce638dd62c9df6a06c55736c50
MD5 cc393c09a9a0e7b92ef2c3abd799e75a
BLAKE2b-256 b723a36a2df2d28ae7029c5f1dd5b2f2847e8e0dea1f83292f441ce3024a8a6a

See more details on using hashes here.

Provenance

The following attestation bundles were made for mnesos-0.7.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