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
30
docs/guides/players/audiences-overview.md
Normal file
30
docs/guides/players/audiences-overview.md
Normal file
@@ -0,0 +1,30 @@
|
||||
---
|
||||
id: audiences-overview
|
||||
title: By audience
|
||||
sidebar_label: By audience
|
||||
description: Vier Rollen — Spieler, Moddevs, Contributor, Sponsoren — plus Erfahrungsstufen (Newbies bis Pros).
|
||||
---
|
||||
|
||||
# By audience
|
||||
|
||||
Die Dokumentation richtet sich an **vier Hauptrollen** (und an Erfahrungsstufen darunter). Wähle, was zu dir passt — die Sprache der meisten Seiten ist **Englisch**, mit deutschsprachigen Importen unter `legacy/wiki-import/` wo vorhanden.
|
||||
|
||||
## Die vier Rollen
|
||||
|
||||
| Rolle | Für wen? | Einstieg |
|
||||
|--------|----------|----------|
|
||||
| **Spieler** (End users) | Installation, Mods nutzen, Troubleshooting, FAQ | [End users (hub)](./overview) → [End user wiki](/wiki/legacy/wiki-import/EndUser/), [Data center FAQ](/wiki/legacy/wiki-import/DataCenterFAQ/) |
|
||||
| **Mod-Entwickler** (Mod developers) | Mods bauen, Hooks, Konfiguration, Debug | [Mod developers (hub)](../mod-developers/overview) → [ModDevs wiki](/wiki/legacy/wiki-import/ModDevs/), [Framework](/wiki/mods/framework) |
|
||||
| **Contributor** (Repo & Framework) | PRs, Doku, Plugins, CI, Design | [Contributors (workflow)](../contributors/topics-overview) → [Contributors wiki](/wiki/legacy/wiki-import/Contributors/), [Repo inventory](/wiki/contributors/repo-inventory) |
|
||||
| **Sponsorinnen & Sponsoren** | Unterstützung, Transparenz, rechtlicher Kontext | [Sponsors (hub)](../sponsors/overview) → [Sponsors (EN)](/wiki/legacy/wiki-import/Sponsors), [Sponsoren (DE)](/wiki/legacy/wiki-import/Sponsoren) |
|
||||
|
||||
## Erfahrungsstufen (alle Rollen)
|
||||
|
||||
- [Newbies](./newbies) — erste Schritte, Begriffe, sichere Defaults.
|
||||
- [Intermediates](./intermediates) — Workflows, Tooling, typische Stolpersteine.
|
||||
- [Professionals](./professionals) — Architektur, FFI, Performance, Release-Kanäle.
|
||||
|
||||
## Thematische Übersicht
|
||||
|
||||
- [Topics hub](/wiki/topics/) — Security, Multiplayer, Assets, FFI, Roadmap, Meta.
|
||||
- Importierte Legacy-Guides: [Legacy wiki import](/wiki/topics/wiki-import/overview).
|
||||
134
docs/guides/players/enduser-workshop.md
Normal file
134
docs/guides/players/enduser-workshop.md
Normal file
@@ -0,0 +1,134 @@
|
||||
---
|
||||
id: enduser-workshop
|
||||
title: End-User Guide — WorkshopManager
|
||||
sidebar_label: End-User Guide
|
||||
description: How to browse, install, and manage Data Center mods using the WorkshopManager.
|
||||
sidebar_position: 10
|
||||
tags:
|
||||
- audience:enduser
|
||||
- workshop
|
||||
---
|
||||
|
||||
# End-User Guide — WorkshopManager
|
||||
|
||||
This guide is for players who want to **install and manage mods** for Data Center using the WorkshopManager desktop app.
|
||||
|
||||
## What you need
|
||||
|
||||
- **Data Center** installed via Steam.
|
||||
- **Steam** running and logged in.
|
||||
- **WorkshopManager** (`WorkshopUploader.exe`) — either built from source or provided as a release.
|
||||
|
||||
## Installation
|
||||
|
||||
You can run WorkshopManager from **any folder you prefer** (for example `Program Files`, Desktop, Downloads, or `<Data Center install>/WorkshopUploader/`).
|
||||
|
||||
### Option A — Installer setup (recommended)
|
||||
|
||||
1. Run the latest `GregToolsModmanager-<version>-Setup.exe`.
|
||||
2. Complete the installer wizard (default path is under `Program Files`).
|
||||
3. Start the app from the Start Menu or desktop shortcut.
|
||||
|
||||
### Option B — Portable / ZIP build
|
||||
|
||||
1. Download or build the WorkshopManager files.
|
||||
2. Extract/copy the folder to any location you want.
|
||||
3. Launch `WorkshopUploader.exe` directly from that folder.
|
||||
|
||||
After startup, the Steam status indicator in the top-right should turn green.
|
||||
|
||||
## Browsing mods (Mod Store)
|
||||
|
||||
1. Open the **Mod Store** tab.
|
||||
2. Use the **Store** sub-tab to browse all available mods.
|
||||
3. Filter by tag (vanilla, modded, melonloader, fmf, framework) or sort by popularity, date, score, etc.
|
||||
4. Use the **Search** bar to find specific mods by name.
|
||||
5. Click on any mod to see its **detail page** with full stats, description, and action buttons.
|
||||
|
||||
## Installing mods (Subscribe)
|
||||
|
||||
1. In the Store or on an item's detail page, click **Subscribe**.
|
||||
2. Steam downloads the mod automatically.
|
||||
3. Check the **Installed** sub-tab to see all your subscribed mods.
|
||||
|
||||
Subscribed mods are managed by Steam — they update automatically when the author publishes changes.
|
||||
|
||||
## Favorites
|
||||
|
||||
1. On an item's detail page, click **Favorite** to bookmark it.
|
||||
2. View all your favorites in the **Favorites** sub-tab.
|
||||
3. Click **Unfavorite** to remove.
|
||||
|
||||
## Voting
|
||||
|
||||
On an item's detail page:
|
||||
|
||||
- Click **Vote Up** to recommend the mod.
|
||||
- Click **Vote Down** if there's a quality issue.
|
||||
|
||||
Your votes help the community find the best mods.
|
||||
|
||||
## Dependency Health (Health tab)
|
||||
|
||||
The **Health** sub-tab checks whether your game has:
|
||||
|
||||
- MelonLoader installed
|
||||
- Il2Cpp interop assemblies generated
|
||||
- FrikaModFramework core DLL
|
||||
- FMF plugins directory
|
||||
- Mod config directory
|
||||
|
||||
If anything is missing, follow the instructions shown.
|
||||
|
||||
### Installing MelonLoader
|
||||
|
||||
1. Go to the Health tab and click **Download page**.
|
||||
2. Download the latest **MelonLoader Installer** from GitHub.
|
||||
3. Run the installer, select **Data Center** as the game, choose **IL2CPP**.
|
||||
4. Start the game once and close it (this generates required assemblies).
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### "Steam - offline" in the title bar
|
||||
|
||||
- Make sure Steam is running and you are logged in.
|
||||
- Ensure `steam_appid.txt` (containing `4170200`) exists next to `WorkshopUploader.exe`.
|
||||
- If you use the portable/ZIP variant, make sure you copied the full app folder (not just the `.exe`).
|
||||
|
||||
### Mod does not load in-game
|
||||
|
||||
- Check `MelonLoader/Latest.log` in the game directory.
|
||||
- Ensure `FrikaModdingFramework.dll` is in `<game>/Mods/`.
|
||||
- Verify the mod DLL is also in `<game>/Mods/` or `<game>/FMF/Plugins/`.
|
||||
|
||||
### Subscription does not appear
|
||||
|
||||
- Wait a few seconds and refresh the Installed list.
|
||||
- Steam may need a moment to process the subscription.
|
||||
|
||||
### App crashes only after installer install
|
||||
|
||||
- Reinstall using the latest setup build.
|
||||
- Open **Settings -> Logs** and include the newest log lines when reporting the issue.
|
||||
- If available, report crash details via GitHub Issues.
|
||||
|
||||
## Reporting bugs and issues
|
||||
|
||||
If you find a bug, crash, or unexpected behavior, please open an issue on GitHub:
|
||||
|
||||
- [Report an issue](https://github.com/mleem97/GregToolsModmanager/issues)
|
||||
|
||||
To help us fix issues faster, include:
|
||||
|
||||
- What you were doing when the problem happened
|
||||
- Clear steps to reproduce
|
||||
- Your app version and Windows version
|
||||
- Error message or screenshot (if any)
|
||||
- Relevant logs from **Settings -> Logs**
|
||||
- A repro ZIP from **Settings -> Create repro bundle**
|
||||
|
||||
## Uninstalling mods
|
||||
|
||||
1. Go to the **Installed** sub-tab.
|
||||
2. Click **Unsubscribe** on the mod you want to remove.
|
||||
3. Steam removes the mod files automatically.
|
||||
30
docs/guides/players/intermediates.md
Normal file
30
docs/guides/players/intermediates.md
Normal file
@@ -0,0 +1,30 @@
|
||||
---
|
||||
id: intermediates
|
||||
title: Intermediates
|
||||
slug: /audiences/intermediates
|
||||
---
|
||||
|
||||
## Goal
|
||||
|
||||
Build and debug your own mods with stable framework workflows.
|
||||
|
||||
## Learning path
|
||||
|
||||
1. Pick one track: C# or Rust.
|
||||
2. Learn hooks/events flow.
|
||||
3. Use verified targets from `HOOKS.md`.
|
||||
4. Implement mod config and diagnostics.
|
||||
|
||||
## Read next
|
||||
|
||||
- `.wiki/Mod-Developer-Debug.md`
|
||||
- `.wiki/Mod-Developer-Debug-en.md`
|
||||
- `.wiki/Modding-Guide.md`
|
||||
- `.wiki/FFI-Bridge-Reference.md`
|
||||
- `.wiki/Web-UI-Bridge.md`
|
||||
|
||||
## Practical checkpoints
|
||||
|
||||
- Build passes in debug/release
|
||||
- Hook target is verified in `HOOKS.md`
|
||||
- Events are version-safe and documented
|
||||
29
docs/guides/players/newbies.md
Normal file
29
docs/guides/players/newbies.md
Normal file
@@ -0,0 +1,29 @@
|
||||
---
|
||||
id: newbies
|
||||
title: Newbies
|
||||
slug: /audiences/newbies
|
||||
---
|
||||
|
||||
## Goal
|
||||
|
||||
Get FrikaMF running safely and understand the minimum concepts.
|
||||
|
||||
## Start here
|
||||
|
||||
1. Install MelonLoader and run the game once.
|
||||
2. Copy `FrikaModdingFramework.dll` into `Data Center/Mods`.
|
||||
3. Add the mod that depends on FrikaMF.
|
||||
4. Check `MelonLoader/Latest.log`.
|
||||
|
||||
## Read next
|
||||
|
||||
- `.wiki/End-User-Release.md`
|
||||
- `.wiki/End-User-Release-en.md`
|
||||
- `.wiki/Known-Incompatibilities-en.md`
|
||||
- `.wiki/Bekannte-Inkompatibilitaeten.md`
|
||||
|
||||
## Common mistakes
|
||||
|
||||
- Wrong folder (`Mods` vs `RustMods`)
|
||||
- Missing first game start after MelonLoader install
|
||||
- Mixing incompatible game/framework versions
|
||||
13
docs/guides/players/overview.md
Normal file
13
docs/guides/players/overview.md
Normal file
@@ -0,0 +1,13 @@
|
||||
---
|
||||
title: End users
|
||||
sidebar_label: End users (hub)
|
||||
description: FAQs, install paths, troubleshooting — plus legacy wiki-import entry points.
|
||||
---
|
||||
|
||||
# End users
|
||||
|
||||
**Spielerinnen und Spieler** — Mods installieren und spielen, ohne am Framework mitzuentwickeln. Überblick über alle Rollen: [By audience](/wiki/guides/players/audiences-overview).
|
||||
|
||||
- [By audience — newbies](/wiki/guides/players/newbies)
|
||||
- Imported: [End user index](/wiki/legacy/wiki-import/EndUser/), [Data center FAQ](/wiki/legacy/wiki-import/DataCenterFAQ/), [Known incompatibilities](/wiki/legacy/wiki-import/Known-Incompatibilities)
|
||||
- Imported: [End user release notes](/wiki/legacy/wiki-import/EndUser/End-User-Release)
|
||||
32
docs/guides/players/professionals.md
Normal file
32
docs/guides/players/professionals.md
Normal file
@@ -0,0 +1,32 @@
|
||||
---
|
||||
id: professionals
|
||||
title: Pros
|
||||
slug: /audiences/professionals
|
||||
---
|
||||
|
||||
## Goal
|
||||
|
||||
Work on framework internals, ABI stability, CI quality, and long-term maintainability.
|
||||
|
||||
## Focus areas
|
||||
|
||||
- Runtime architecture and ownership boundaries
|
||||
- C#↔Rust ABI evolution
|
||||
- Compatibility arbitration and diagnostics
|
||||
- Release assets and template integrity
|
||||
- Security review pipeline for future Mod Store
|
||||
|
||||
## Read next
|
||||
|
||||
- `.wiki/Architecture.md`
|
||||
- `.wiki/Framework-Features-Use-Cases.md`
|
||||
- `.wiki/StandaloneMods.md`
|
||||
- `.wiki/Repository-Status-2026-04-04.md`
|
||||
- `.wiki/ROADMAP.md`
|
||||
- `.wiki/TASKLIST.md`
|
||||
|
||||
## Professional quality gates
|
||||
|
||||
- Explicit migration notes for contracts/events
|
||||
- Reproducible build and release pipelines
|
||||
- Documented rollback and incompatibility strategy
|
||||
Reference in New Issue
Block a user