Skip to content

mehdiskouri/world_forge

Repository files navigation

Forge

Agent-native worldbuilding format and toolchain delivered as an MCP server. Pure-deterministic Python core, Blender 5.0 realizer, multi-layer hypergraph as project memory. See AGENT/PRD.md for the v1 thesis and AGENT/ARCHITECTURE.md for the system design.

Status: Phase 0 — repo bootstrap. No application code yet.

CI License: Apache 2.0 Python 3.13


Quickstart (development)

Forge targets Python 3.13 and uses uv for environment + dependency management.

git clone https://github.com/mehdi/world_forge.git
cd world_forge

uv sync                       # create .venv, install dev deps
uv run pre-commit install     # wire up git hooks
uv run pytest                 # smoke tests pass
uv run ruff check .           # lint
uv run ruff format --check .  # formatting
uv run mypy                   # strict type-check

A fresh clone followed by uv sync && uv run pytest should be green on the first try. If it isn't, that's a bug — open an issue.

Repository layout

world_forge/
├── .github/
│   ├── instructions.md       # mandatory rules for AI agents + humans
│   └── workflows/ci.yml
├── AGENT/                    # PRD, Architecture, Roadmap, phase plans
├── forge_mcp/                # the package (placeholder in Phase 0)
├── tests/
├── pyproject.toml
└── ...

For AI coding agents

Read .github/instructions.md before making any changes. It defines the non-negotiable rules around phase discipline, lint/type-check strictness, test coverage, docstrings, and schema maintenance.

Companion documents:

Project format

A Forge project is an on-disk folder of human-readable JSON, designed to be git-friendly and inspectable without booting Blender. The layout, file shapes, and invariants are documented in AGENT/ARCHITECTURE.md §3 and walked through end-to-end in docs/project_format.md. Pydantic-published JSON Schemas for every model live under schemas/ and are regenerated via:

uv run forge-schema-export --check   # CI gate
uv run forge-schema-export --write   # regenerate

Contributing

  • Work on feature branches; open PRs against main.
  • CI must be green; pre-commit must be installed locally.
  • Lint + type-check strictness will not be loosened (see instructions §2).
  • Test coverage target is 90–95% once real code lands (Phase 2+).

License

Apache License 2.0 © 2026 Mehdi.

About

Agent-native worldbuilding MCP server (Forge v1)

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors