Skip to content

QUICKSTART.md

Latest commit

 

History

History
154 lines (104 loc) · 3.77 KB

QUICKSTART.md

File metadata and controls

154 lines (104 loc) · 3.77 KB

MOOLLM Quickstart

Get playing in 2 minutes ⏱️

👀 Browse First

Explore on GitHub — no install needed:

Start Here What You'll Find
🔥 examples/adventure-4/ The richest microworld — pub, NPCs, Palm the monkey
🧠 skills/ ~80 skills — all the building blocks
📜 designs/eval/EVAL-INCARNATE-FRAMEWORK.md The deep dive

Every directory has a README. Every YAML is literate and commented.

🚀 Install & Run

git clone git@github.com:SimHacker/moollm.git
cd moollm
cursor .

Or ask Cursor: "Clone https://github.com/SimHacker/moollm.git and open it"

⏳ Wait for Indexing

After opening moollm in Cursor for the first time, give it time to index the repo.

  1. Go to Cursor → Settings → Cursor Settings
  2. Navigate to Indexing and Docs → Codebase Indexing
  3. Wait until it shows 100% indexed

The semantic search and context assembly work much better once indexing is complete.

Then you're ready. Open a chat. The repo IS the game.

🎮 Play

> LOOK
> GO WEST
> READ NOTE
> GET LAMP

The LLM is your Dungeon Master. Directories are rooms. Files are objects.

🏗️ Build

Tell Cursor what you want:

"Clone adventure-4 to my-adventure-1, start me in the pub."

"Add a garden west of the kitchen with a talking flower."

Or copy manually and edit the YAML directly.

📚 Learn from Sessions

Session Highlights
marathon-session.md Palm's incarnation, 33-turn Fluxx
k-line-connections.md K-line safari with conceptual pioneers

These are collaborative literature — see mechanics in action.

🗂️ What's In adventure-4?

examples/adventure-4/
├── characters/         # Players, NPCs, animals
├── sessions/           # Play logs (shareable literature)
├── start/              # Beginning room with lamp
├── kitchen/            # Mother's note → your goals!
├── pub/                # Social hub — games, NPCs, stage
├── maze/               # 10 dark rooms, grues
└── end/                # Treasury — the goal!

📚 Full structure: examples/adventure-4/README.md

🧠 Core Concepts

Concept Meaning
FILES-AS-STATE No hidden memory — everything in files
YAML-JAZZ Comments carry semantic meaning
ROOMS Directories are places
K-LINES Names that activate conceptual clusters
SPEED-OF-LIGHT Many agents in one LLM call
POSTEL Interpret charitably, never crash

📚 Full protocol list: PROTOCOLS.yml

🔧 Quick Recipes

Add a Room

# examples/adventure-4/garden/ROOM.yml
room:
  name: The Hidden Garden
  exits:
    south:
      destination: ../kitchen/

Add an Object

# examples/adventure-4/garden/flower.yml
object:
  name: Mysterious Flower
  portable: true
  actions:
    SMELL: "You remember something you forgot..."

📚 Full guide: skills/room/

📚 Next Steps

Goal Read This
Understand the vision README.md
Deep architecture dive EVAL-INCARNATE-FRAMEWORK.md
All skills skills/
All protocols PROTOCOLS.yml

The LLM is the Coherence Engine. The filesystem is the world. The chat is the adventure.

Now go GET LAMP! 🪔