gregWiki/i18n/de/docusaurus-plugin-content-docs/current/getting-started.md at 8d8fda49c414a24739af69139ec285d5f489c347

mirror of https://github.com/mleem97/gregWiki.git synced 2026-04-10 19:19:18 +02:00

Files

Marvin cfaa5550d4 docs: enhance documentation structure and clarify repository layout

- Updated the README and various documentation files to reflect the new flat layout of the `gregFramework`, emphasizing the direct placement of repositories like `gregMod.<Name>/` and `gregExt.<Name>/` under `gregFramework/`.
- Added details about the `gregModmanager/` and `gregDataCenterExporter/` directories, clarifying their roles and contents.
- Improved descriptions and links throughout the documentation to ensure consistency and accuracy, enhancing user navigation and understanding of the project structure.
- Adjusted language in several sections to better communicate the purpose and organization of the repositories.

This commit improves the overall clarity and usability of the documentation.

2026-04-10 02:03:00 +02:00

2.2 KiB

Raw Blame History

title, sidebar_label, description

title	sidebar_label	description
Erste Schritte	Erste Schritte	Split-Repo-Workspace: gregFramework-Layout, Core bauen und wo die Doku liegt.

Die Struktur ist Multi-Repo mit gregFramework/ als lokalem Wrapper-Ordner. Darin liegen die eigenständigen Repositories, z. B.:

gregCore/ — Core-SDK (gregCore/framework/FrikaMF.csproj), MCP unter gregCore/mcp-server/
gregMod.<Name>/ — Gameplay-Mods (FMF.*), flach neben gregCore/ (älteres gregMods/ ist obsolet)
gregExt.<Name>/ — Framework-Plugins (FFM.Plugin.*), ebenfalls flach (älteres gregExtensions/ obsolet)
gregModmanager/ — Gregtools Modmanager (WorkshopManager; WorkshopUploader.csproj)
gregDataCenterExporter/ — Exporter, Templates, Hook-JSON-Spiegel
gregWiki/ — diese Dokumentation

Die Rust-Bridge liegt unter:

gregCore/bridges/gregSta.RustBridge/

Core bauen

dotnet build gregCore/FrikaMF.sln -c Release

Alternativ in der IDE: gregCore/FrikaMF.sln öffnen.

Hook-Naming

Zielkonvention: FMF.<DOMAIN>.<Event> (siehe CONTRIBUTING.md).
Registry (Beispielpfad): gregDataCenterExporter/FrikaModFramework/fmf_hooks.json.
Legacy-Runtime-Strings können noch FFM.* in HookNames.cs nutzen, bis migriert.

Mod starten

Neues Mod-Repo als gregMod.<Name>/ unter gregFramework/ anlegen (neben gregCore/ klonen oder anlegen).
Templates aus gregCore/Templates/ nutzen (Spiegel unter gregDataCenterExporter/Templates/ wo vorhanden).
Hook-Metadaten pflegen und Mod im eigenen Repo versionieren.

Dokumentations-Site

Repo: gregWiki/
Inhalt: Markdown/MDX in diesem Repo, angepasst an den Split-Stand.

Docker

Im gregWiki-Root: docker build -t gregwiki-docs . und docker run --rm -p 3000:3000 gregwiki-docs.

MCP

Siehe reference/mcp-server — Implementierung unter gregCore/mcp-server/ (Installation und --data-root laut README.md dort).

2.2 KiB Raw Blame History Unescape Escape