Files
gregWiki/docs/intro.md
Marvin b37a0d9078 w
2026-04-10 01:39:48 +02:00

2.8 KiB

id, title, slug, description
id title slug description
intro gregFramework documentation /docs Entry point for the split-repo workspace — core, mods, extensions, and this wiki.

This documentation describes the current split layout: a local gregFramework/ workspace with separate repositories for core, mods, extensions, and wiki. It is written for players, mod developers, contributors, and sponsors.

Who is this for?

Audience Start here
Players — install, play, troubleshoot End users (hub) · End user wiki (import)
Mod developers — build mods, hooks, debugging Mod developers (hub) · ModDevs wiki (import) · Framework
Contributors — PRs, docs, plugins, CI Contributors (workflow) · Contributors wiki (import)
Sponsors — support & transparency Sponsors (hub) · Sponsors (EN) · Sponsoren (DE)

Experience tracks (newbies → pros): By audienceNewbies, Intermediates, Professionals.

Repository hub

  • Workspace map — how folders map to repos
  • Framework core: gregCore/ (translations, hooks, runtime, templates, bridges)
  • Mods: gregMod.<Name>/ (directly under gregFramework/)
  • Extensions: gregExt.<Name>/ (directly under gregFramework/)
  • Wiki: gregWiki/ (this site)

Hooks and releases

Layout (contributors)

  • Repo inventory — project and repository overview
  • Split naming: gregMod.<Name>, gregExt.<Name>, gregSta.<Name>

Source model

  • Authoring: Markdown/MDX lives in the gregWiki repository.
  • Technical source of truth: the framework core is gregCore — translations, hooks, and runtime/bridge implementation live there.
  • Rust bridge: integrated in the core tree under gregCore/bridges/gregSta.RustBridge/.