mirror of
https://github.com/mleem97/gregWiki.git
synced 2026-04-11 03:29:19 +02:00
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.
This commit is contained in:
Marvin
@@ -4,15 +4,16 @@ sidebar_label: Erste Schritte
|
||||
description: "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.:
|
||||
Die Struktur ist **Multi-Repo** mit `gregFramework/` als lokalem Wrapper-Ordner. Darin liegen die eigenständigen Repositories, z. B.:
|
||||
|
||||
- `gregCore/` — **Framework-Kern**: Übersetzung, Hooks, Harmony-/Event-Laufzeit, Templates, Bridges und übrige Kernfunktionen
|
||||
- `gregMod.<Name>/` (einzelne Mod-Repos, direkt unter `gregFramework/`)
|
||||
- `gregExt.<Name>/` (einzelne Extension-Repos, direkt unter `gregFramework/`)
|
||||
- `gregWiki/` (Dokumentation)
|
||||
- `gregStore/` (**Gregweb**, privates Repository — Modstore Web + Infra; Next.js unter `web/`)
|
||||
- `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
|
||||
|
||||
Das Upstream-Projekt **DataCenter-RustBridge** wird in den Core integriert und liegt unter:
|
||||
Die **Rust**-Bridge liegt unter:
|
||||
|
||||
- `gregCore/bridges/gregSta.RustBridge/`
|
||||
|
||||
@@ -24,20 +25,16 @@ dotnet build gregCore/FrikaMF.sln -c Release
|
||||
|
||||
Alternativ in der IDE: `gregCore/FrikaMF.sln` öffnen.
|
||||
|
||||
## Sprache (Mods / Plugins / Extensions)
|
||||
|
||||
**Pflicht:** Gameplay- und Integrationslogik für Mods, MelonLoader-Plugins und Extensions ausschließlich in **C#**. Siehe [Modding-Sprache (nur C#)](/wiki/reference/modding-language-requirement).
|
||||
|
||||
## Hook-Naming
|
||||
|
||||
- **Zielkonvention:** `FMF.<DOMAIN>.<Event>` (siehe [`CONTRIBUTING.md`](https://github.com/mleem97/gregFramework/blob/master/CONTRIBUTING.md)).
|
||||
- **Registry:** [`FrikaModFramework/fmf_hooks.json`](https://github.com/mleem97/gregFramework/blob/master/FrikaModFramework/fmf_hooks.json).
|
||||
- **Legacy-Runtime-Strings** können noch `FFM.*` in [`HookNames`](https://github.com/mleem97/gregFramework/blob/master/framework/FrikaMF/HookNames.cs) nutzen, bis migriert.
|
||||
- **Zielkonvention:** `FMF.<DOMAIN>.<Event>` (siehe [`CONTRIBUTING.md`](https://github.com/mleem97/gregFramework/blob/main/CONTRIBUTING.md)).
|
||||
- **Registry (Beispielpfad):** [`gregDataCenterExporter/FrikaModFramework/fmf_hooks.json`](https://github.com/mleem97/gregFramework/blob/main/gregDataCenterExporter/FrikaModFramework/fmf_hooks.json).
|
||||
- **Legacy-Runtime-Strings** können noch `FFM.*` in [`HookNames.cs`](https://github.com/mleem97/gregFramework/blob/main/gregCore/framework/FrikaMF/HookNames.cs) nutzen, bis migriert.
|
||||
|
||||
## Mod starten
|
||||
|
||||
1. Neues Mod-Repo als Ordner `gregMod.<Name>/` unter `gregFramework/` anlegen.
|
||||
2. Templates aus `gregCore/Templates/` nutzen.
|
||||
1. Neues Mod-Repo als `gregMod.<Name>/` unter `gregFramework/` anlegen (neben `gregCore/` klonen oder anlegen).
|
||||
2. Templates aus `gregCore/Templates/` nutzen (Spiegel unter `gregDataCenterExporter/Templates/` wo vorhanden).
|
||||
3. Hook-Metadaten pflegen und Mod im eigenen Repo versionieren.
|
||||
|
||||
## Dokumentations-Site
|
||||
@@ -51,4 +48,4 @@ Im `gregWiki`-Root: `docker build -t gregwiki-docs .` und `docker run --rm -p 30
|
||||
|
||||
### MCP
|
||||
|
||||
Siehe [`reference/mcp-server`](/wiki/reference/mcp-server) im Core (`gregCore/mcp-server/`).
|
||||
Siehe [`reference/mcp-server`](/wiki/reference/mcp-server) — Implementierung unter **`gregCore/mcp-server/`** (Installation und `--data-root` laut `README.md` dort).
|
||||
|
||||
@@ -21,9 +21,11 @@ Diese Dokumentation beschreibt den **aktuellen Split-Stand**: `gregFramework/` a
|
||||
## Repository-Hub
|
||||
|
||||
- [Workspace-Karte](/wiki/workspace/) — Ordner → Repos
|
||||
- Core: `gregCore/FrikaMF-StandaloneRepo/`
|
||||
- Core: `gregCore/` (`framework/FrikaMF`, `mcp-server/`, `bridges/gregSta.RustBridge/`)
|
||||
- Mods: `gregMod.<Name>/` (Split-Repos, direkt unter `gregFramework/`)
|
||||
- Extensions (FFM-Plugins): `gregExt.<Name>/` (Split-Repos, direkt unter `gregFramework/`)
|
||||
- Workshop-App: `gregModmanager/` (Gregtools Modmanager — `WorkshopUploader.exe`)
|
||||
- Exporter/Templates: `gregDataCenterExporter/`
|
||||
- Wiki: `gregWiki/`
|
||||
|
||||
## Hooks und Releases
|
||||
@@ -36,10 +38,10 @@ Diese Dokumentation beschreibt den **aktuellen Split-Stand**: `gregFramework/` a
|
||||
## Layout (Contributors)
|
||||
|
||||
- [Repo-Inventar](/wiki/contributors/repo-inventory) — Projekt- und Repo-Übersicht
|
||||
- Split-Konvention: `gregMod.<Name>`, `gregExt.<Name>`, `gregSta.<Name>`
|
||||
- Split-Konvention: `gregMod.<Name>`, `gregExt.<Name>`, `gregSta.<Name>` (Rust-Bridge-Repo), plus Apps wie `gregModmanager/`, `gregDataCenterExporter/`, `gregIPAM/`, `gregStore/`
|
||||
|
||||
## Quellenmodell
|
||||
|
||||
- **Authoring:** Inhalte liegen im **gregWiki**-Repo.
|
||||
- **Technische Wahrheit:** Runtime/Bridge-Details kommen aus **gregCore**.
|
||||
- **RustBridge:** im Core unter `FrikaMF-StandaloneRepo/bridges/gregSta.RustBridge/`.
|
||||
- **RustBridge:** `gregCore/bridges/gregSta.RustBridge/`.
|
||||
|
||||
@@ -20,7 +20,7 @@ Das gilt für alles, was als **`gregMod.*`**, **`gregExt.*`** oder **`FFM.Plugin
|
||||
|
||||
## Was hiervon *nicht* betroffen ist
|
||||
|
||||
- Der **Framework-Kern** (`gregCore`) kann weiterhin **Nicht-C#**-Bestandteile enthalten (z. B. **Rust**-FFI unter `bridges/gregSta.RustBridge/`, Build-Skripte, Tools). Das ersetzt **nicht** Mod-/Plugin-/Extension-Logik außerhalb von C#.
|
||||
- Der **Framework-Kern** (`gregCore`) kann weiterhin **Nicht-C#**-Bestandteile enthalten (z. B. **Rust**-FFI unter `gregCore/bridges/gregSta.RustBridge/`, Build-Skripte, Tools). Das ersetzt **nicht** Mod-/Plugin-/Extension-Logik außerhalb von C#.
|
||||
- **Dokumentation**, **Konfiguration** (JSON/YAML) und **Assets** zählen hier nicht als „Logik“.
|
||||
- **gregStore**, **gregWiki** und andere Nicht-In-Game-Stacks dürfen andere Sprachen nutzen.
|
||||
|
||||
|
||||
@@ -100,10 +100,10 @@ WorkshopUploader.exe --mode publish --path <project-folder>
|
||||
Die App wird als **eigenständige** Windows-Executable veröffentlicht — auf dem Zielrechner ist keine Installation von .NET-Runtime oder Windows App SDK erforderlich.
|
||||
|
||||
```bash
|
||||
dotnet publish WorkshopUploader/WorkshopUploader.csproj -c Release -p:SelfContained=true -p:RuntimeIdentifier=win10-x64
|
||||
dotnet publish gregModmanager/WorkshopUploader.csproj -c Release -p:SelfContained=true -p:RuntimeIdentifier=win10-x64
|
||||
```
|
||||
|
||||
Ausgabe: `WorkshopUploader/bin/Release/net9.0-windows10.0.19041.0/win10-x64/publish/`
|
||||
Ausgabe: `gregModmanager/bin/Release/net9.0-windows10.0.19041.0/win10-x64/publish/`
|
||||
|
||||
### Alle Mods + Gregtools Modmanager in Workshop-Ordner bereitstellen
|
||||
|
||||
@@ -121,7 +121,7 @@ pwsh -File scripts/Deploy-Release-ToDataCenter.ps1 -IncludeWorkshopUploader
|
||||
|
||||
## See also
|
||||
|
||||
- Repository README: [`WorkshopUploader/README.md`](https://github.com/mleem97/gregFramework/blob/master/WorkshopUploader/README.md)
|
||||
- Repository-README: [`gregModmanager/README.md`](https://github.com/mleem97/gregFramework/blob/main/gregModmanager/README.md) (Produkt **Gregtools Modmanager**; `WorkshopUploader.csproj`)
|
||||
- [End-User Guide](/wiki/guides/players/enduser-workshop)
|
||||
- [Contributor Guide](/wiki/guides/contributors/contributor-workshop)
|
||||
- [Release](/wiki/guides/contributors/release)
|
||||
|
||||
Reference in New Issue
Block a user