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 quality.
This commit is contained in:
Marvin
@@ -1,15 +0,0 @@
|
||||
---
|
||||
title: FFM.Plugin.AssetExporter
|
||||
sidebar_label: FFM.Plugin.AssetExporter
|
||||
---
|
||||
|
||||
`StandaloneMods/FFM.Plugin.AssetExporter`
|
||||
|
||||
## Purpose
|
||||
|
||||
Provides export-focused tooling for asset-related workflows.
|
||||
|
||||
## Sources
|
||||
|
||||
- Module path: `StandaloneMods/FFM.Plugin.AssetExporter`
|
||||
- Overview: [`Standalone Mods`](/wiki/wiki-import/StandaloneMods)
|
||||
@@ -1,15 +0,0 @@
|
||||
---
|
||||
title: FFM.Plugin.Multiplayer
|
||||
sidebar_label: FFM.Plugin.Multiplayer
|
||||
---
|
||||
|
||||
`StandaloneMods/FFM.Plugin.Multiplayer`
|
||||
|
||||
## Purpose
|
||||
|
||||
Contains standalone multiplayer-oriented plugin functionality.
|
||||
|
||||
## Sources
|
||||
|
||||
- Module path: `StandaloneMods/FFM.Plugin.Multiplayer`
|
||||
- Roadmap context: [`Steamworks P2P Multiplayer Roadmap`](/wiki/wiki-import/Steamworks-P2P-Multiplayer-Roadmap)
|
||||
@@ -1,15 +0,0 @@
|
||||
---
|
||||
title: FFM.Plugin.PlayerModels
|
||||
sidebar_label: FFM.Plugin.PlayerModels
|
||||
---
|
||||
|
||||
`StandaloneMods/FFM.Plugin.PlayerModels`
|
||||
|
||||
## Purpose
|
||||
|
||||
Hosts standalone player-model specific behavior and integration.
|
||||
|
||||
## Sources
|
||||
|
||||
- Module path: `StandaloneMods/FFM.Plugin.PlayerModels`
|
||||
- Debug docs: [`Mod Developer Debug`](/wiki/wiki-import/Mod-Developer-Debug)
|
||||
@@ -1,15 +0,0 @@
|
||||
---
|
||||
title: FFM.Plugin.Sysadmin
|
||||
sidebar_label: FFM.Plugin.Sysadmin
|
||||
---
|
||||
|
||||
`StandaloneMods/FFM.Plugin.Sysadmin`
|
||||
|
||||
## Purpose
|
||||
|
||||
Contains system-administration oriented standalone plugin features.
|
||||
|
||||
## Sources
|
||||
|
||||
- Module path: `StandaloneMods/FFM.Plugin.Sysadmin`
|
||||
- Framework context: [`Framework Features & Use Cases`](/wiki/wiki-import/Framework-Features-Use-Cases)
|
||||
@@ -1,15 +0,0 @@
|
||||
---
|
||||
title: FFM.Plugin.WebUIBridge
|
||||
sidebar_label: FFM.Plugin.WebUIBridge
|
||||
---
|
||||
|
||||
`StandaloneMods/FFM.Plugin.WebUIBridge`
|
||||
|
||||
## Purpose
|
||||
|
||||
Focuses on standalone web UI bridge integration flows.
|
||||
|
||||
## Sources
|
||||
|
||||
- Module path: `StandaloneMods/FFM.Plugin.WebUIBridge`
|
||||
- Reference: [`Web UI Bridge (DC2WEB)`](/wiki/wiki-import/Web-UI-Bridge)
|
||||
@@ -1,15 +0,0 @@
|
||||
---
|
||||
title: FMF.ConsoleInputGuard
|
||||
sidebar_label: FMF.ConsoleInputGuard
|
||||
---
|
||||
|
||||
`StandaloneMods/FMF.ConsoleInputGuard`
|
||||
|
||||
## Purpose
|
||||
|
||||
Provides guardrails around console input handling.
|
||||
|
||||
## Sources
|
||||
|
||||
- Module path: `StandaloneMods/FMF.ConsoleInputGuard`
|
||||
- Overview: [`Standalone Mods`](/wiki/wiki-import/StandaloneMods)
|
||||
@@ -1,15 +0,0 @@
|
||||
---
|
||||
title: FMF.GregifyEmployees
|
||||
sidebar_label: FMF.GregifyEmployees
|
||||
---
|
||||
|
||||
`StandaloneMods/FMF.GregifyEmployees`
|
||||
|
||||
## Purpose
|
||||
|
||||
Contains standalone custom employee-related gameplay behavior.
|
||||
|
||||
## Sources
|
||||
|
||||
- Module path: `StandaloneMods/FMF.GregifyEmployees`
|
||||
- HR context: [`Framework Features & Use Cases`](/wiki/wiki-import/Framework-Features-Use-Cases)
|
||||
@@ -1,37 +0,0 @@
|
||||
---
|
||||
title: Standalone Plugins & Mods
|
||||
sidebar_label: Overview
|
||||
---
|
||||
|
||||
This section contains the first-party standalone modules currently maintained in this repository.
|
||||
|
||||
## Classification
|
||||
|
||||
- **Plugins** extend the framework runtime capabilities.
|
||||
- **Mods** extend the game behavior/content by using framework and plugin capabilities.
|
||||
|
||||
## Loading path
|
||||
|
||||
- **MelonLoader mods** load from `{GameRoot}/Mods/` (standard MelonLoader behavior).
|
||||
- **FMF framework plugins** (`FFM.Plugin.*`) are deployed under `{GameRoot}/FMF/Plugins/`; MelonLoader does not scan that folder by default — see [Game folder layout](/wiki/topics/meta/game-folder-layout).
|
||||
- Rust mods via FrikaMF follow the same runtime rules as other MelonLoader mods unless documented otherwise.
|
||||
|
||||
## Standalone Plugins
|
||||
|
||||
- [FFM.Plugin.AssetExporter](./ffm-plugin-asset-exporter.md)
|
||||
- [FFM.Plugin.Multiplayer](./ffm-plugin-multiplayer.md)
|
||||
- [FFM.Plugin.PlayerModels](./ffm-plugin-player-models.md)
|
||||
- [FFM.Plugin.Sysadmin](./ffm-plugin-sysadmin.md)
|
||||
- [FFM.Plugin.WebUIBridge](./ffm-plugin-web-ui-bridge.md)
|
||||
|
||||
## Standalone Mods
|
||||
|
||||
- [FMF.ConsoleInputGuard](./fmf-console-input-guard.md)
|
||||
- [FMF.GregifyEmployees](./fmf-gregify-employees.md)
|
||||
- [FMF.HexLabelMod](./fmf-hex-label-mod.md)
|
||||
- [FMF.LangCompatBridge](./fmf-lang-compat-bridge.md)
|
||||
- [FMF.UIReplacementMod](./fmf-ui-replacement-mod.md)
|
||||
|
||||
## Additional context
|
||||
|
||||
- [`Standalone Mods` wiki page](/wiki/wiki-import/StandaloneMods)
|
||||
@@ -3,6 +3,8 @@ title: Framework
|
||||
sidebar_label: Framework
|
||||
---
|
||||
|
||||
**Language:** mod, plugin, and extension **logic must be written in C#** — see [Modding language (C# only)](/wiki/reference/modding-language-requirement).
|
||||
|
||||
The core `FrikaMF` runtime provides:
|
||||
|
||||
- Harmony patch integration for gameplay hooks
|
||||
|
||||
22
docs/mods/index.md
Normal file
22
docs/mods/index.md
Normal file
@@ -0,0 +1,22 @@
|
||||
---
|
||||
title: Gameplay mods (FMF)
|
||||
sidebar_label: Mods overview
|
||||
description: Standalone MelonLoader gameplay mods (FMF.*) — separate from FFM framework plugins.
|
||||
---
|
||||
|
||||
# Gameplay mods
|
||||
|
||||
These pages document **gameplay mods** (`FMF.*` assemblies), hosted under `gregMods/` in the workspace. They are **not** the same as [FFM plugins](../plugins/index), which extend the framework inside the game process.
|
||||
|
||||
## Mods
|
||||
|
||||
- [FMF.ConsoleInputGuard](./fmf-console-input-guard)
|
||||
- [FMF.GregifyEmployees](./fmf-gregify-employees)
|
||||
- [FMF.HexLabelMod](./fmf-hex-label-mod)
|
||||
- [FMF.LangCompatBridge](./fmf-lang-compat-bridge)
|
||||
- [FMF.UIReplacementMod](./fmf-ui-replacement-mod)
|
||||
|
||||
## See also
|
||||
|
||||
- [Framework](./framework) — FMF runtime & plugin host
|
||||
- [Releases](../releases/index) — versioned release notes
|
||||
@@ -1,14 +0,0 @@
|
||||
---
|
||||
title: Mods Wiki
|
||||
sidebar_label: Mods Overview
|
||||
---
|
||||
|
||||
This section contains gameplay mod wiki pages, separated from plugins.
|
||||
|
||||
## Mod Projects
|
||||
|
||||
- [FMF.ConsoleInputGuard](./fmf-console-input-guard)
|
||||
- [FMF.GregifyEmployees](./fmf-gregify-employees)
|
||||
- [FMF.HexLabelMod](../extensions/fmf-hex-label-mod)
|
||||
- [FMF.LangCompatBridge](../extensions/fmf-lang-compat-bridge)
|
||||
- [FMF.UIReplacementMod](../extensions/fmf-ui-replacement-mod)
|
||||
@@ -1,35 +0,0 @@
|
||||
---
|
||||
title: FMF.HexLabelMod
|
||||
sidebar_label: FMF.HexLabelMod
|
||||
description: Hex label display mod for Data Center — overlays cable spinner and rack color hex labels in-world.
|
||||
---
|
||||
|
||||
## Description
|
||||
|
||||
Overlays cable spinner and rack color hex labels directly in-world so you can identify cable and rack colors at a glance without opening any menu.
|
||||
|
||||
## Steamworks Metadata
|
||||
|
||||
| Field | Value |
|
||||
|-------|-------|
|
||||
| **Assembly** | `FMF.HexLabelMod.dll` |
|
||||
| **Version** | `00.01.0009` |
|
||||
| **Author** | mleem97 |
|
||||
| **Game** | Waseku — Data Center (App 4170200) |
|
||||
| **Workshop Tags** | `modded`, `melonloader`, `mod` |
|
||||
| **Workshop Content Path** | `content/Mods/` |
|
||||
| **Needs FMF** | No (standalone MelonLoader mod) |
|
||||
|
||||
## Wiki Group
|
||||
|
||||
- Category: Mod
|
||||
- Primary Language: C#
|
||||
- Project Path: `mods/FMF.Mod.HexLabelMod`
|
||||
|
||||
## Installation
|
||||
|
||||
Drop `FMF.HexLabelMod.dll` into `<Data Center>/Mods/`. Requires [MelonLoader](https://melonwiki.xyz/) (IL2CPP).
|
||||
|
||||
## Release
|
||||
|
||||
- [Open Release Page](/wiki/releases/mods/fmf-hex-label-mod-release)
|
||||
Reference in New Issue
Block a user