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:
34
docs/framework/architecture.md
Normal file
34
docs/framework/architecture.md
Normal file
@@ -0,0 +1,34 @@
|
||||
---
|
||||
title: Repository architecture
|
||||
sidebar_label: Repository architecture
|
||||
description: Aktuelle Multi-Repo-Architektur mit `gregFramework` als Wrapper und klarer Repo-Trennung.
|
||||
---
|
||||
|
||||
## Modding language
|
||||
|
||||
Mods, MelonLoader-Plugins und Extensions liefern ihre **Logik ausschließlich in C#** (MelonLoader / .NET). Details und Abgrenzung zum Framework-Kern (z. B. Rust-Bridge): [Modding language (C# only)](/wiki/reference/modding-language-requirement).
|
||||
|
||||
## Layers
|
||||
|
||||
| Layer | Role |
|
||||
| ------ | ------ |
|
||||
| **Wrapper** | `gregFramework/` enthält lokal alle Einzel-Repositories. |
|
||||
| **Core** | `gregCore/FrikaMF-StandaloneRepo/` — **Framework-Kern**: Übersetzung, Hooks, Harmony/Event-Laufzeit, MCP, Templates und zugehörige Kernfunktionen. |
|
||||
| **Rust bridge** | In Core integriert unter `gregCore/FrikaMF-StandaloneRepo/bridges/gregSta.RustBridge/`. |
|
||||
| **Mods** | `gregMods/` + pro Mod eigenes Repo (`gregMod.<Name>`). |
|
||||
| **Extensions** | `gregExtensions/` + pro Extension eigenes Repo (`gregExt.<Name>`). |
|
||||
| **Docs** | `gregWiki/` als eigenes Repo für Dokumentation. |
|
||||
|
||||
## Hook registry
|
||||
|
||||
Hook-Naming und Registry bleiben fachlich im Core verankert; bei Split-Änderungen gilt immer der Core-Stand als Referenz.
|
||||
|
||||
## Tools
|
||||
|
||||
- **Core tools:** `gregCore/FrikaMF-StandaloneRepo/tools/`
|
||||
- **MCP runtime:** `gregCore/FrikaMF-StandaloneRepo/mcp-server/`
|
||||
- **Hook-/Mapping-Utilities:** ebenfalls unter Core-Tools, versioniert mit dem Core-Repo.
|
||||
|
||||
## Steam & Workshop
|
||||
|
||||
Workshop-Templates und Deployment-Skripte liegen im Core-Repo unter `FrikaMF-StandaloneRepo/Templates/` und `FrikaMF-StandaloneRepo/scripts/`.
|
||||
98
docs/framework/fmf-hooks.mdx
Normal file
98
docs/framework/fmf-hooks.mdx
Normal file
@@ -0,0 +1,98 @@
|
||||
---
|
||||
id: fmf-hooks
|
||||
title: FMF Hook Reference
|
||||
sidebar_label: FMF Hook Reference
|
||||
description: Auto-generated from FrikaModFramework/fmf_hooks.json — run tools/fmf-hook-scanner.
|
||||
---
|
||||
|
||||
:::info
|
||||
This page is generated by `tools/fmf-hook-scanner`. Do not edit by hand.
|
||||
:::
|
||||
|
||||
# FMF Hook Reference
|
||||
|
||||
## EMPLOYEE
|
||||
|
||||
### FMF.EMPLOYEE.Hired
|
||||
|
||||
**Description:** An employee was hired into the roster.
|
||||
|
||||
**Payload:**
|
||||
|
||||
- `employeeId` (string)
|
||||
- `role` (string)
|
||||
|
||||
**Example (C#)**
|
||||
|
||||
```csharp
|
||||
FmfApi.On("FMF.EMPLOYEE.Hired", payload => { });
|
||||
```
|
||||
|
||||
## GAMEPLAY
|
||||
|
||||
### FMF.GAMEPLAY.JobCompleted
|
||||
|
||||
**Description:** Emitted when a job has been fully processed.
|
||||
|
||||
**Payload:**
|
||||
|
||||
- `jobId` (string)
|
||||
- `durationSeconds` (number)
|
||||
- `revenue` (number)
|
||||
|
||||
**Example (C#)**
|
||||
|
||||
```csharp
|
||||
FmfApi.On("FMF.GAMEPLAY.JobCompleted", payload => { });
|
||||
```
|
||||
|
||||
## PLAYER
|
||||
|
||||
### FMF.PLAYER.LevelUp
|
||||
|
||||
**Description:** Player progression level increased.
|
||||
|
||||
**Payload:**
|
||||
|
||||
- `newLevel` (number)
|
||||
- `previousLevel` (number)
|
||||
|
||||
**Example (C#)**
|
||||
|
||||
```csharp
|
||||
FmfApi.On("FMF.PLAYER.LevelUp", payload => { });
|
||||
```
|
||||
|
||||
## RACK
|
||||
|
||||
### FMF.RACK.PowerLimitExceeded
|
||||
|
||||
**Description:** Power draw or allocation for a rack exceeded configured limits.
|
||||
|
||||
**Payload:**
|
||||
|
||||
- `rackId` (string)
|
||||
- `watts` (number)
|
||||
|
||||
**Example (C#)**
|
||||
|
||||
```csharp
|
||||
FmfApi.On("FMF.RACK.PowerLimitExceeded", payload => { });
|
||||
```
|
||||
|
||||
## SERVER
|
||||
|
||||
### FMF.SERVER.RackOverheated
|
||||
|
||||
**Description:** Server rack exceeded a critical temperature threshold.
|
||||
|
||||
**Payload:**
|
||||
|
||||
- `rackId` (string)
|
||||
- `temperature` (number)
|
||||
|
||||
**Example (C#)**
|
||||
|
||||
```csharp
|
||||
FmfApi.On("FMF.SERVER.RackOverheated", payload => { });
|
||||
```
|
||||
30
docs/framework/hexmod.md
Normal file
30
docs/framework/hexmod.md
Normal file
@@ -0,0 +1,30 @@
|
||||
---
|
||||
title: HexMod
|
||||
sidebar_label: HexMod
|
||||
description: Hex label mod — in-world hex color labels for cable spinners and racks.
|
||||
---
|
||||
|
||||
# HexMod
|
||||
|
||||
The **Hex Label** mod adds in-world hex color labels for cable spinners and racks.
|
||||
|
||||
## Steamworks Info
|
||||
|
||||
| Field | Value |
|
||||
|-------|-------|
|
||||
| **Assembly** | `FMF.HexLabelMod.dll` |
|
||||
| **Version** | `00.01.0009` |
|
||||
| **Author** | mleem97 |
|
||||
| **Game** | Waseku — Data Center (App 4170200) |
|
||||
| **Workshop Tags** | `modded`, `melonloader`, `mod` |
|
||||
|
||||
## Downloads
|
||||
|
||||
- **Steam Workshop:** Subscribe via the Gregtools Modmanager or the [Steam Workshop](https://steamcommunity.com/app/4170200/workshop/)
|
||||
- **Manual:** Drop `FMF.HexLabelMod.dll` into `<Data Center>/Mods/`
|
||||
|
||||
## Source & layout
|
||||
|
||||
- **Build sources:** [`mods/FMF.Mod.HexLabelMod`](https://github.com/mleem97/gregFramework/tree/master/mods/FMF.Mod.HexLabelMod)
|
||||
|
||||
See also the detailed wiki article [FMF.HexLabelMod](/wiki/mods/fmf-hex-label-mod).
|
||||
Reference in New Issue
Block a user