Yggdrasil World Engine

Documentation

Documentation

Getting started with the Yggdrasil World Engine

Getting Started

  1. Clone the repository from GitHub.
  2. Review the master specification: docs/master_specification/YWE_MASTER_SPECIFICATION.md
  3. Review the repository bootstrap baseline: YWE_REPOSITORY_BOOTSTRAP_PROMPT.md
  4. Review the architecture documentation: docs/architecture/
  5. Load data schemas and canonical rule artifacts into your host engine.
  6. Implement core engines following interface definitions in core/*/engine_interface.json.
  7. Extend with expansion modules following modules/*/.

Key Documents

Master Specification

The foundational engine-first design baseline.

Architecture Layers

Layer hierarchy, dependency rules, and structural contracts.

ASH Compliance

Compliance rules and checklist for ASH pattern adherence.

Developer Guide

Extended implementation guide for engine developers.

Wiki Reference

Comprehensive reference playbook for the entire system.

Design Glossary

Complete terminology reference for YWE concepts.

Data Schemas

The data/ directory contains all canonical schemas, registries, and rule artifacts.

  • realm_registry/ — Nine canonical realm definitions
  • realm/ — Realm mechanics, transitions, boundary profiles
  • pattern_archetypes/ — ASH pattern node schemas and generation rules
  • quest_archetypes/ — Quest seed schemas
  • myth_archetypes/ — Myth record schemas
  • bloodline_registry/ — Bloodline system schemas
  • perception/ — Perception overlay canonical rules
  • schemas/ — Player state, prophecy, perception persistence
Browse Schemas on GitHub

Validation & CI

The repository includes validation scripts and CI workflows to enforce architectural compliance.

  • validate_architecture.py — Structural compliance checker
  • validate_ash_compliance.py — ASH model compliance validator
  • validate_schemas.py — JSON schema integrity validator
  • run_checks.sh / run_checks.ps1 — Full validation suite

GitHub Actions workflows run validation automatically on every pull request.