gregWiki/docs/framework/architecture.md at af20f959656e13d52dc2242e44ba3b13e279d7cc

mirror of https://github.com/mleem97/gregWiki.git synced 2026-04-11 03:29:19 +02:00

Files

Marvin 331847013d docs: update docusaurus configuration and documentation structure

- Revised the tagline in `docusaurus.config.js` for improved clarity on the documentation's focus.
- Removed German localization support from the configuration to streamline the user experience.
- Updated navigation items in the sidebar to better reflect the current structure, emphasizing player and developer resources.
- Enhanced the README and various documentation files to clarify the repository layout and improve accessibility for users.
- Adjusted links and descriptions throughout the documentation to ensure consistency and accuracy.

This commit aims to enhance the overall clarity and usability of the documentation.

2026-04-10 02:26:32 +02:00

2.1 KiB

Raw Blame History

title, sidebar_label, description

title	sidebar_label	description
Repository architecture	Repository architecture	Current multi-repo layout with `gregFramework` as a local wrapper and clear repository boundaries.

Modding language

Mods, MelonLoader plugins, and extensions ship their logic in C# only (MelonLoader / .NET). Scope vs framework core (e.g. Rust bridge): Modding language (C# only).

Target runtime layers

Above the raw repositories, the logical model is ModManager → Framework → Plugins → Mods (see System architecture & documentation principles):

Layer	Role	Repo / folder
ModManager	MAUI front-end: manage mods/plugins, surface game status; talks to the framework through defined interfaces.	`gregModmanager/`
Framework (SDK)	Hooks, events, versioning, logging; bridge to IL2CPP / MelonLoader.	`gregCore/`
Plugins	Framework extensions (`FFM.Plugin.*`).	`gregExt.<Name>/`
Mods	User mods (`FMF.*`).	`gregMod.<Name>/`

On-disk repositories

Layer	Role
Wrapper	`gregFramework/` holds local checkouts of individual repositories.
Core	`gregCore/` — framework core: translation, hooks, Harmony/event runtime, MCP, templates, and related core features.
Rust bridge	Integrated in core under `gregCore/bridges/gregSta.RustBridge/`.
Mods	`gregMod.<Name>/` — one repo each, directly under `gregFramework/`.
Extensions	`gregExt.<Name>/` — one repo each, directly under `gregFramework/`.
Docs	`gregWiki/` — documentation site repository.

Hook registry

Hook naming and the registry are owned by core; when repos split, core remains the source of truth.

Tools

Core tools: gregCore/tools/
MCP runtime: gregCore/mcp-server/
Hook / mapping utilities: also under core tools, versioned with the core repo.

Steam & Workshop

Workshop templates and deployment scripts live in the core repo under gregCore/Templates/ and gregCore/scripts/.

2.1 KiB Raw Blame History