mirror of
https://github.com/mleem97/gregWiki.git
synced 2026-04-11 03:29:19 +02:00
7f8070fe2a
- Revised import paths in the FFI and hooks, game folder layout, and roadmap documentation to reflect the transition to the legacy directory structure. - This change ensures that all links point to the correct legacy resources, improving accessibility and accuracy of the documentation.
2.6 KiB
2.6 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 audience → Newbies, Intermediates, Professionals.
Repository hub
- Workspace map — how folders map to repos
- Core:
gregCore/FrikaMF-StandaloneRepo/ - Mods:
gregMods/(reposgregMod.<Name>) - Extensions:
gregExtensions/(reposgregExt.<Name>) - Wiki:
gregWiki/(this site)
Hooks and releases
- FMF hook naming —
FMF.<Domain>.…and legacyFFM.* - FMF hooks catalog — generated from core
HookNames.cs - Release channels — Steam Workshop vs GitHub (beta)
- MCP server — optional LLM/IDE tooling over docs +
fmf_hooks.json
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: runtime and bridge details come from gregCore.
- Rust bridge: integrated in the core tree under
FrikaMF-StandaloneRepo/bridges/gregSta.RustBridge/.