mirror of
https://github.com/mleem97/gregWiki.git
synced 2026-04-11 03:29:19 +02:00
refactor: update project branding and structure for gregFramework
- Changed project title and tagline in docusaurus.config.js to reflect the new branding. - Updated package.json and package-lock.json to rename the project to gregwiki-docs-site. - Adjusted sidebar and documentation files to align with the new project structure and naming conventions. - Enhanced documentation content for clarity and consistency across various sections. - Added Prettier as a development dependency for code formatting. This commit aligns the project with the new branding and improves overall documentation structure.
This commit is contained in:
Marvin
@@ -44,3 +44,9 @@ Details: [`topics/wiki-import/overview.md`](./topics/wiki-import/overview.md).
|
||||
| Sync `../.wiki` → `docs/wiki-import/` | `scripts/sync-wiki-to-docs.mjs` | Copies `*.md` from the sibling `.wiki/` clone under `gregFramework/`. |
|
||||
| Split DE/EN pairs | `scripts/normalize-wiki-import-i18n.mjs` | EN default locale, DE under `i18n/de/...`. |
|
||||
| Sidebar category keys | `scripts/write-wiki-import-category-keys.mjs` | Regenerates `_category_.json` keys under Guides/Reference/Troubleshooting (if present). |
|
||||
|
||||
## Locales (EN / DE / others)
|
||||
|
||||
- **Default locale:** `en` — curated pages live under `docs/` (e.g. `intro.md`, `getting-started.md`).
|
||||
- **German:** override files under `i18n/de/docusaurus-plugin-content-docs/current/` with the **same path** as in `docs/` (same doc `id` / filename). Example: `intro.md` and `getting-started.md` are fully maintained in DE.
|
||||
- **fr, es, ru, ja:** enabled in `docusaurus.config.js`; where no translated file exists, Docusaurus **falls back** to the English `docs/` markdown. Add more translated files under `i18n/<locale>/docusaurus-plugin-content-docs/current/` as needed.
|
||||
|
||||
@@ -1,50 +1,49 @@
|
||||
---
|
||||
title: Getting started
|
||||
sidebar_label: Getting started
|
||||
description: "Aktueller Stand nach Repo-Split: Wrapper-Struktur, Core-Build und Mod-/Extension-Repos."
|
||||
description: "Split-repo workspace: gregFramework layout, building the core, and where docs live."
|
||||
---
|
||||
|
||||
Die Struktur ist jetzt **Multi-Repo** mit `gregFramework/` als lokalem Wrapper-Ordner. Darin liegen die eigenständigen Repositories, z. B.:
|
||||
The workspace is **multi-repo** with a local `gregFramework/` folder containing standalone repositories, for example:
|
||||
|
||||
- `gregCore/` (Core SDK, inkl. `FrikaMF-StandaloneRepo/`)
|
||||
- `gregMods/` (einzelne Mod-Repos)
|
||||
- `gregExtensions/` (einzelne Extension-Repos)
|
||||
- `gregWiki/` (Dokumentation)
|
||||
- `gregCore/` (core SDK, including `FrikaMF-StandaloneRepo/`)
|
||||
- `gregMods/` (per-mod repositories)
|
||||
- `gregExtensions/` (per-extension repositories)
|
||||
- `gregWiki/` (this documentation site)
|
||||
|
||||
`DataCenter-RustBridge` wird in den Core integriert und liegt im Core-Baum unter:
|
||||
`DataCenter-RustBridge` is integrated into the core tree at:
|
||||
|
||||
- `gregCore/FrikaMF-StandaloneRepo/bridges/gregSta.RustBridge/`
|
||||
|
||||
## Core bauen
|
||||
## Build the core
|
||||
|
||||
```text
|
||||
dotnet build gregCore/FrikaMF-StandaloneRepo/FrikaMF.sln -c Release
|
||||
```
|
||||
|
||||
Alternativ in IDE: `gregCore/FrikaMF-StandaloneRepo/FrikaMF.sln` öffnen.
|
||||
Or open `gregCore/FrikaMF-StandaloneRepo/FrikaMF.sln` in your IDE.
|
||||
|
||||
## Hook naming
|
||||
|
||||
- **Target convention:** `FMF.<DOMAIN>.<Event>` (see [`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).
|
||||
- **Registry:** [`FrikaModFramework/fmf_hooks.json`](https://github.com/mleem97/gregFramework/blob/master/FrikaModFramework/fmf_hooks.json) (path may vary by branch).
|
||||
- **Legacy runtime strings** may still use `FFM.*` in [`HookNames`](https://github.com/mleem97/gregFramework/blob/master/framework/FrikaMF/HookNames.cs) until migrated.
|
||||
|
||||
## Mod starten
|
||||
## Start a mod
|
||||
|
||||
1. Neues Mod-Repo unter `gregMods/` nach Schema `gregMod.<Name>` anlegen.
|
||||
2. Templates aus `gregCore/FrikaMF-StandaloneRepo/Templates/` nutzen.
|
||||
3. Hook-Metadaten pflegen und Mod im eigenen Repo versionieren.
|
||||
1. Create a new mod repo under `gregMods/` using the `gregMod.<Name>` pattern.
|
||||
2. Use templates from `gregCore/FrikaMF-StandaloneRepo/Templates/`.
|
||||
3. Maintain hook metadata and version the mod in its own repository.
|
||||
|
||||
## Documentation site
|
||||
|
||||
- **Repo:** `gregWiki/`
|
||||
- **Inhalt:** Markdown/MDX in diesem Repo, angepasst an den Split-Stand.
|
||||
- **Repository:** `gregWiki/`
|
||||
- **Content:** Markdown/MDX in this repo, aligned with the split layout.
|
||||
|
||||
### Docker
|
||||
|
||||
- **Dev server with hot reload:** from the `gregWiki` repo root, `docker build -t gregwiki-docs .` then `docker run --rm -p 3000:3000 gregwiki-docs` (or use your host compose file if you mount this repo).
|
||||
- **MCP:** see [`reference/mcp-server`](./reference/mcp-server.md) in the core repository (`gregCore/FrikaMF-StandaloneRepo/mcp-server/`).
|
||||
From the `gregWiki` root: `docker build -t gregwiki-docs .` then `docker run --rm -p 3000:3000 gregwiki-docs`.
|
||||
|
||||
## Assistants / MCP
|
||||
### MCP
|
||||
|
||||
Der MCP-Server für Framework-Scan/Tooling liegt im Core-Umfeld (`gregCore/FrikaMF-StandaloneRepo/mcp-server/`).
|
||||
See [`reference/mcp-server`](./reference/mcp-server.md) — the server lives next to the core sources (`gregCore/FrikaMF-StandaloneRepo/mcp-server/`).
|
||||
|
||||
@@ -1,43 +1,44 @@
|
||||
---
|
||||
id: intro
|
||||
title: FrikaMF Docs Start
|
||||
title: gregFramework documentation
|
||||
slug: /docs
|
||||
description: Entry point for the split-repo workspace — core, mods, extensions, and this wiki.
|
||||
---
|
||||
|
||||
Diese Dokumentation beschreibt den **aktuellen Split-Stand**: `gregFramework/` als Wrapper mit Einzel-Repositories für Core, Mods, Extensions und Wiki. Sie richtet sich an **Spieler**, **Mod-Developer**, **Contributors** und **Sponsoren**.
|
||||
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**.
|
||||
|
||||
## Für wen? — Who is this for?
|
||||
## Who is this for?
|
||||
|
||||
| Audience | Start here |
|
||||
|----------|------------|
|
||||
| **Spieler** — install, play, troubleshoot | [End users (hub)](./topics/end-user/overview.md) · [End user wiki (import)](./wiki-import/EndUser/) |
|
||||
| **Moddevs** — build mods, hooks, debugging | [Mod developers (hub)](./topics/mod-developers/overview.md) · [ModDevs wiki (import)](./wiki-import/ModDevs/) · [Framework](./mods/framework.md) |
|
||||
| **Contributor** — PRs, docs, plugins, CI | [Contributors (workflow)](./topics/contributors/overview.md) · [Contributors wiki (import)](./wiki-import/Contributors/) |
|
||||
| **Sponsorinnen & Sponsoren** — support & transparency | [Sponsors (hub)](./topics/sponsors/overview.md) · [Sponsors (EN)](./wiki-import/Sponsors) · [Sponsoren (DE)](./wiki-import/Sponsoren) |
|
||||
| **Players** — install, play, troubleshoot | [End users (hub)](./topics/end-user/overview.md) · [End user wiki (import)](./wiki-import/EndUser/) |
|
||||
| **Mod developers** — build mods, hooks, debugging | [Mod developers (hub)](./topics/mod-developers/overview.md) · [ModDevs wiki (import)](./wiki-import/ModDevs/) · [Framework](./mods/framework.md) |
|
||||
| **Contributors** — PRs, docs, plugins, CI | [Contributors (workflow)](./topics/contributors/overview.md) · [Contributors wiki (import)](./wiki-import/Contributors/) |
|
||||
| **Sponsors** — support & transparency | [Sponsors (hub)](./topics/sponsors/overview.md) · [Sponsors (EN)](./wiki-import/Sponsors) · [Sponsoren (DE)](./wiki-import/Sponsoren) |
|
||||
|
||||
**Experience tracks** (newbies → pros): [By audience](./topics/audiences/overview.md) → [Newbies](./audiences/newbies.md), [Intermediates](./audiences/intermediates.md), [Professionals](./audiences/professionals.md).
|
||||
|
||||
## Repository Hub
|
||||
## Repository hub
|
||||
|
||||
- Core: `gregCore/FrikaMF-StandaloneRepo/`
|
||||
- Mods: `gregMods/` (Repos `gregMod.<Name>`)
|
||||
- Extensions: `gregExtensions/` (Repos `gregExt.<Name>`)
|
||||
- Wiki: `gregWiki/`
|
||||
- Mods: `gregMods/` (repos `gregMod.<Name>`)
|
||||
- Extensions: `gregExtensions/` (repos `gregExt.<Name>`)
|
||||
- Wiki: `gregWiki/` (this site)
|
||||
|
||||
## Hooks and releases
|
||||
|
||||
- [FMF hook naming](./reference/fmf-hook-naming.md) — `FMF.<Domain>.…` and legacy `FFM.*`
|
||||
- [FMF hooks catalog](./reference/fmf-hooks-catalog.md) — generated from `framework/FrikaMF/HookNames.cs`
|
||||
- [FMF hooks catalog](./reference/fmf-hooks-catalog.md) — generated from core `HookNames.cs`
|
||||
- [Release channels](./reference/release-channels.md) — Steam Workshop vs GitHub (beta)
|
||||
- [MCP server](./reference/mcp-server.md) — LLM/IDE tools over docs + `fmf_hooks.json` (optional Docker bundle)
|
||||
- [MCP server](./reference/mcp-server.md) — optional LLM/IDE tooling over docs + `fmf_hooks.json`
|
||||
|
||||
## Repository layout (contributors)
|
||||
## Layout (contributors)
|
||||
|
||||
- [Repo inventory](./contributors/repo-inventory.md) — aktuelle Projekt-/Repo-Übersicht
|
||||
- Split-Konvention: `gregMod.<Name>`, `gregExt.<Name>`, `gregSta.<Name>`
|
||||
- [Repo inventory](./contributors/repo-inventory.md) — project and repository overview
|
||||
- Split naming: `gregMod.<Name>`, `gregExt.<Name>`, `gregSta.<Name>`
|
||||
|
||||
## Source model
|
||||
|
||||
- **Authoring:** Inhalte liegen im `gregWiki`-Repo.
|
||||
- **Core source of truth:** technische Runtime-/Bridge-Details kommen aus `gregCore`.
|
||||
- **RustBridge:** ist im Core integriert unter `FrikaMF-StandaloneRepo/bridges/gregSta.RustBridge/`.
|
||||
- **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/`.
|
||||
|
||||
@@ -15,7 +15,7 @@ All **new** public hook and event identifiers should follow:
|
||||
FMF.<Domain>.<EventOrHook>
|
||||
```
|
||||
|
||||
- **`FMF`** — Fixed prefix (Frika Mod Framework).
|
||||
- **`FMF`** — Fixed prefix (Greg Mod Framework / **gregFramework** hook namespace).
|
||||
- **`<Domain>`** — Uppercase domain from the [approved domain list](#approved-domain-segments). Describes *where* the signal belongs in the game (player, rack, server, economy, …).
|
||||
- **`<EventOrHook>`** — `PascalCase` segment(s), usually `OnSomething` for events or a verb phrase for commands.
|
||||
|
||||
|
||||
@@ -11,7 +11,7 @@ import ModReleasePage from '@site/src/components/ModReleasePage';
|
||||
dllName="FMF.ConsoleInputGuard.dll"
|
||||
releaseReady={false}
|
||||
version="NotReleasedYet"
|
||||
author="mleem97 / FrikaMF Community"
|
||||
author="mleem97 / gregFramework Community"
|
||||
category="Mod"
|
||||
dependencies={['MelonLoader', 'Harmony']}
|
||||
codeLanguages={['C#']}
|
||||
|
||||
@@ -11,7 +11,7 @@ import ModReleasePage from '@site/src/components/ModReleasePage';
|
||||
dllName="FMF.GregifyEmployees.dll"
|
||||
releaseReady={false}
|
||||
version="NotReleasedYet"
|
||||
author="mleem97 / FrikaMF Community"
|
||||
author="mleem97 / gregFramework Community"
|
||||
category="Mod"
|
||||
dependencies={['MelonLoader', 'Harmony']}
|
||||
codeLanguages={['C#']}
|
||||
|
||||
@@ -11,7 +11,7 @@ import ModReleasePage from '@site/src/components/ModReleasePage';
|
||||
dllName="FMF.HexLabelMod.dll"
|
||||
releaseReady={false}
|
||||
version="NotReleasedYet"
|
||||
author="mleem97 / FrikaMF Community"
|
||||
author="mleem97 / gregFramework Community"
|
||||
category="Mod"
|
||||
dependencies={['MelonLoader', 'Harmony']}
|
||||
codeLanguages={['C#']}
|
||||
|
||||
@@ -11,7 +11,7 @@ import ModReleasePage from '@site/src/components/ModReleasePage';
|
||||
dllName="FMF.JoniMLCompatMod.dll"
|
||||
releaseReady={false}
|
||||
version="NotReleasedYet"
|
||||
author="mleem97 / FrikaMF Community"
|
||||
author="mleem97 / gregFramework Community"
|
||||
category="Mod"
|
||||
dependencies={['MelonLoader']}
|
||||
codeLanguages={['C#']}
|
||||
|
||||
@@ -11,9 +11,9 @@ import ModReleasePage from '@site/src/components/ModReleasePage';
|
||||
dllName="FFM.Plugin.AssetExporter.dll"
|
||||
releaseReady={false}
|
||||
version="NotReleasedYet"
|
||||
author="mleem97 / FrikaMF Community"
|
||||
author="mleem97 / gregFramework Community"
|
||||
category="Plugin"
|
||||
dependencies={['MelonLoader', 'FrikaMF']}
|
||||
dependencies={['MelonLoader', 'gregFramework']}
|
||||
codeLanguages={['C#']}
|
||||
description="Provides export-focused tooling for asset-related workflows in Data Center modding pipelines."
|
||||
banner="Asset exporter plugin release"
|
||||
|
||||
@@ -11,11 +11,11 @@ import ModReleasePage from '@site/src/components/ModReleasePage';
|
||||
dllName="FFM.Plugin.Multiplayer.dll"
|
||||
releaseReady={false}
|
||||
version="NotReleasedYet"
|
||||
author="mleem97 / FrikaMF Community"
|
||||
author="mleem97 / gregFramework Community"
|
||||
category="Plugin"
|
||||
dependencies={['MelonLoader', 'FrikaMF']}
|
||||
dependencies={['MelonLoader', 'gregFramework']}
|
||||
codeLanguages={['C#']}
|
||||
description="Contains multiplayer-oriented plugin functionality for FrikaMF ecosystems."
|
||||
description="Contains multiplayer-oriented plugin functionality for gregFramework ecosystems."
|
||||
banner="Multiplayer plugin release"
|
||||
releaseNotesPath="/mods/extensions/ffm-plugin-multiplayer"
|
||||
/>
|
||||
|
||||
@@ -11,9 +11,9 @@ import ModReleasePage from '@site/src/components/ModReleasePage';
|
||||
dllName="FFM.Plugin.PlayerModels.dll"
|
||||
releaseReady={false}
|
||||
version="NotReleasedYet"
|
||||
author="mleem97 / FrikaMF Community"
|
||||
author="mleem97 / gregFramework Community"
|
||||
category="Plugin"
|
||||
dependencies={['MelonLoader', 'FrikaMF']}
|
||||
dependencies={['MelonLoader', 'gregFramework']}
|
||||
codeLanguages={['C#']}
|
||||
description="Extends player model handling and related rendering/gameplay presentation behavior."
|
||||
banner="Player models plugin release"
|
||||
|
||||
@@ -11,9 +11,9 @@ import ModReleasePage from '@site/src/components/ModReleasePage';
|
||||
dllName="FFM.Plugin.Sysadmin.dll"
|
||||
releaseReady={false}
|
||||
version="NotReleasedYet"
|
||||
author="mleem97 / FrikaMF Community"
|
||||
author="mleem97 / gregFramework Community"
|
||||
category="Plugin"
|
||||
dependencies={['MelonLoader', 'FrikaMF']}
|
||||
dependencies={['MelonLoader', 'gregFramework']}
|
||||
codeLanguages={['C#']}
|
||||
description="Provides sysadmin-focused controls and quality-of-life command utilities."
|
||||
banner="Sysadmin plugin release"
|
||||
|
||||
@@ -11,9 +11,9 @@ import ModReleasePage from '@site/src/components/ModReleasePage';
|
||||
dllName="FFM.Plugin.WebUIBridge.dll"
|
||||
releaseReady={false}
|
||||
version="NotReleasedYet"
|
||||
author="mleem97 / FrikaMF Community"
|
||||
author="mleem97 / gregFramework Community"
|
||||
category="Plugin"
|
||||
dependencies={['MelonLoader', 'FrikaMF']}
|
||||
dependencies={['MelonLoader', 'gregFramework']}
|
||||
codeLanguages={['C#']}
|
||||
description="Bridges runtime data to web interfaces for dashboards and remote overlays."
|
||||
banner="Web UI bridge plugin release"
|
||||
|
||||
@@ -12,7 +12,7 @@ import ModReleasePage from '@site/src/components/ModReleasePage';
|
||||
dllName="FMF.ModPathRedirector.dll"
|
||||
releaseReady={true}
|
||||
version="1.5.0"
|
||||
author="DataCenterExporter / FrikaMF Community"
|
||||
author="DataCenterExporter / gregFramework Community"
|
||||
category="MelonLoader plugin"
|
||||
dependencies={['MelonLoader', 'Steam (client)', 'Data Center']}
|
||||
codeLanguages={['C#']}
|
||||
|
||||
Reference in New Issue
Block a user