Skip to content

luifa7/realm-codex-starter

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

REALM REALM — Codex Starter

The Operating Framework for Human-Agent Companies

This repository contains the starter Codex for the REALM Framework — a ready-to-use folder structure, all five Class Sheets, and templates for every file you need to build and run a Realm.

Fork it, clone it, and start building your world.


What is REALM?

REALM is an operating framework for companies where humans and AI agents work together as a single crew. It defines who does what, how knowledge flows, and where the human stays in control.

The metaphor is a game world — Characters with defined abilities, a Codex that holds all knowledge, Quests that drive work forward, and a Player who makes the decisions that matter.

Read the full frameworkDownload the PDFSee it in practice


What's in this repo?

This is the Codex — the knowledge base structure that every Character reads from and writes to.

REALM-Codex/
├── WORLD/
│   ├── OATH.md                    ← Why your company exists
│   ├── DESTINY.md                 ← Where your company is going
│   └── Your-Zone-1/              ← One folder per business domain
│       ├── Zone-Overview.md
│       ├── Knowledge/
│       ├── Outputs/
│       └── Intelligence/
│
├── PLAYERS/
│   └── Player-Card-Template.md    ← One file per human Player
│
├── CHARACTERS/
│   ├── Class-Sheets/              ← The 5 Class definitions (included)
│   │   ├── Warrior.md
│   │   ├── Mage.md
│   │   ├── Hunter.md
│   │   ├── Cleric.md
│   │   └── Bard.md
│   ├── Cards/                     ← One Character Card per agent
│   │   └── Character-Card-Template.md
│   ├── SOUL-Files/                ← One SOUL file per agent (system prompt)
│   │   └── SOUL-File-Template.md
│   └── Portraits/                 ← Optional character images
│
├── SAGAS/
│   ├── Active/
│   │   └── Your-First-Saga/
│   │       ├── Saga-Overview.md
│   │       └── Quest-Template.md
│   └── Completed/
│
├── SESSIONS/
│   ├── Season-Reviews/
│   ├── Raids/
│   └── Patches/
│
├── INTELLIGENCE/
│   ├── Competitors/
│   ├── Market-Trends/
│   └── Opportunities/
│
├── GUILDS/                        ← External partner relationships
│
├── QUESTS/                        ← Standalone Quest records
│
└── QUEST-BOARD.md                 ← Source of truth for all Task states

What's included and ready to use

File What it is
5 Class Sheets Complete definitions for Warrior, Mage, Hunter, Cleric, and Bard — abilities, limitations, how they think, how to work with them
Quest Board The four-state task system with reconciliation rules
Process Classification How REALM maps to management, core, and support processes

What's a template for you to fill in

Template What you write
OATH.md Why your company exists (1-2 paragraphs)
DESTINY.md Where your company is going (1-3 paragraphs)
Player Card Who you are, your energy patterns, communication style
Character Card One per agent — name, class, zone, abilities, autonomy
SOUL File One per agent — the system prompt they read at startup
Zone Overview One per business domain — current state, metrics, open questions
Saga Overview One per quarter/season — goal, quests, context
Quest One per specific goal — tasks, owners, decisions, outcome

Prerequisites

This repo gives you the REALM layer — the structure, identity, and workflow for your agents. It does not replace the infrastructure needed to run agents. Before using this, you need:

  • An agent platform configured and running (OpenClaw, AutoGPT, custom setups, or any platform that can host and trigger AI agents)
  • A knowledge base tool where this Codex lives (Obsidian, Notion, Google Drive, or similar — REALM is tool-agnostic)
  • A project board for your visual Quest Board (Trello, Linear, Notion, or similar)
  • A communication channel where you interact with agents (Slack, Discord, or similar)

REALM works on top of whatever infrastructure you have. The infrastructure has to exist first.

A note on safety: REALM defines Autonomy Tiers to control what agents can do alone. But the framework is only as safe as your implementation. Before giving any agent access to external systems — payment platforms, email, publishing tools, APIs that spend money or send messages — make sure Tier 3 boundaries are enforced at the platform level, not just written in the SOUL file. An agent that should ask permission but can act without it is a misconfiguration, not a framework failure. Start with tight boundaries and loosen them as trust is earned.


How to start

  1. Fork or clone this repo into your knowledge base tool
  2. Read the REALM Framework PDF — understand the principles, classes, and goal hierarchy before building
  3. Write your Oath (WORLD/OATH.md) — why does your company exist?
  4. Write your Destiny (WORLD/DESTINY.md) — where is it going?
  5. Create your Player Card (PLAYERS/) — who are you, how do you work?
  6. Rename the Zone folders to match your business domains (Commerce, Marketing, Finance, etc.)
  7. Create your first Character — pick the Class that fits, fill in the Card and SOUL file, deploy to your agent platform
  8. Define your first Saga and Quest — one meaningful goal, broken into SMART Tasks
  9. Start your first Session — read The Scroll, set Energy, play

The five Character Classes

Class Symbol Role Core Question
Warrior Executes defined tasks with precision "What exactly do I need to do?"
Mage Analyzes data and surfaces insights "What does this mean?"
Hunter Finds new information and opportunities "What don't we know yet?"
Cleric Coordinates, protects, keeps things running "Is everything running?"
Bard Creates content and connects with people "How do I make someone care?"

Full Class Sheets with abilities, limitations, and working guidelines are in CHARACTERS/Class-Sheets/.


License

REALM Framework v1.0 · Created by Luis Alfredo Godoy Alvarez

Licensed under CC BY-SA 4.0 — free to use, share, and adapt for any purpose, including commercially, as long as you give appropriate credit and distribute adaptations under the same license.


⚔ Build your world. Play for real.

About

The starter Codex for the REALM Framework — folder structure, Class Sheets, and templates to build and run a human-agent company. Fork it and start playing.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors