teamGreg/gregWiki
1
0
Fork 0
mirror of https://github.com/mleem97/gregWiki.git synced 2026-04-11 03:29:19 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: flatten player sidebar; rename WorkshopManager to GregModManager

Browse Source 
Made-with: Cursor
This commit is contained in:
Marvin
2026-04-10 03:55:28 +02:00
parent af20f95965
commit 9f37e5d6ef
13 changed files with 68 additions and 80 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
docs/guides/contributors/contributor-workshop.md
View File

@@ -1,22 +1,22 @@
---
id: contributor-workshop
title: Contributor Guide — WorkshopManager
title: Contributor Guide — GregModManager
sidebar_label: Contributor Guide
description: Development setup, building, publishing workflow, and release process for the WorkshopManager.
description: Development setup, building, publishing workflow, and release process for GregModManager.
sidebar_position: 20
tags:
- audience:contributor
- workshop
---
# Contributor Guide — WorkshopManager
# Contributor Guide — GregModManager
This guide covers the development workflow for the WorkshopManager and how to publish mods to the Steam Workshop.
This guide covers the development workflow for **GregModManager** and how to publish mods to the Steam Workshop.
## Prerequisites
- **Visual Studio 2022** with **.NET Multi-platform App UI** and **Windows App SDK** workloads.
- **.NET 9 SDK** (for the WorkshopManager MAUI app).
- **.NET 9 SDK** (for the GregModManager MAUI app).
- **.NET 6 SDK** (for framework, plugins, and mods targeting MelonLoader).
- **Steam** with Data Center installed (App ID 4170200).
@@ -26,10 +26,10 @@ Paths are relative to the **`gregFramework/`** workspace root (split repos clone
| Path | Purpose |
|------|---------|
| `gregCore/framework/FrikaMF.csproj` | Core MelonLoader framework DLL |
| `gregCore/framework/FrikaMF.csproj` (via `gregCore/FrikaMF.sln`) | Core MelonLoader framework DLL |
| `gregExt.*/` | FFM framework plugins (`FFM.Plugin.*` assemblies — one repo per plugin) |
| `gregMod.*/` | Standalone gameplay mods (`FMF.*` assemblies) |
| `gregModmanager/WorkshopUploader.csproj` | WorkshopManager MAUI app |
| `gregModmanager/WorkshopUploader.csproj` | GregModManager MAUI app |
| `gregFramework/scripts/Deploy-Release-ToWorkshop.ps1` | Package all builds into Workshop folders (when present in your clone) |
| `gregFramework/scripts/Deploy-Release-ToDataCenter.ps1` | Deploy to game for local testing |
@@ -50,7 +50,7 @@ dotnet build gregMod.HexLabelMod/FMF.HexLabelMod.csproj -c Release
dotnet build gregMod.LangCompatBridge/FMF.JoniMLCompatMod.csproj -c Release
```
### Build WorkshopManager only
### Build GregModManager only
```bash
dotnet build gregModmanager/WorkshopUploader.csproj -c Release
@@ -96,7 +96,7 @@ This script:
### GUI (recommended)
1. Run the WorkshopManager app.
1. Run the GregModManager app.
2. Open a project from the **Projects** tab.
3. Edit title, description, tags, visibility, and preview image.
4. Write **change notes** describing what changed.
@@ -135,4 +135,4 @@ The `SteamWorkshopService` in `gregModmanager/Services/SteamWorkshopService.cs`
1. Create the mod as a split repo folder `gregMod.<Name>/` under the gregFramework workspace (or clone an existing `gregMod.*` repo).
2. Add it to the `$mods` array in `Deploy-Release-ToWorkshop.ps1`.
3. Run the deploy script.
4. Open the new workshop project in the WorkshopManager and publish.
4. Open the new workshop project in the GregModManager and publish.

4
docs/guides/contributors/release.md
View File

@@ -39,7 +39,7 @@ The following components are built and packaged for Steam Workshop distribution:
| FMF.HexLabelMod | `FMF.HexLabelMod.dll` | `content/Mods/` | modded, melonloader, mod |
| FMF.JoniMLCompatMod | `FMF.JoniMLCompatMod.dll` | `content/Mods/` | modded, melonloader, mod |
### Gregtools Modmanager (WorkshopManager)
### Gregtools Modmanager (GregModManager)
| Version | Component | Target | Description |
|---------|-----------|--------|-------------|
@@ -51,7 +51,7 @@ The following components are built and packaged for Steam Workshop distribution:
1. Install **MelonLoader** (IL2CPP) for Data Center.
2. Start the game once, then close it.
3. Subscribe to mods via the **WorkshopManager** Mod Store or the [Steam Workshop](https://steamcommunity.com/app/4170200/workshop/).
3. Subscribe to mods via the **GregModManager** Mod Store or the [Steam Workshop](https://steamcommunity.com/app/4170200/workshop/).
4. Start the game.
### Manual installation

14
docs/guides/players/enduser-workshop.md
View File

@@ -1,27 +1,27 @@
---
id: enduser-workshop
title: End-User Guide — WorkshopManager
title: End-User Guide — GregModManager
sidebar_label: End-User Guide
description: How to browse, install, and manage Data Center mods using the WorkshopManager.
description: How to browse, install, and manage Data Center mods using GregModManager (Gregtools Modmanager).
sidebar_position: 10
tags:
- audience:enduser
- workshop
---
# End-User Guide — WorkshopManager
# End-User Guide — GregModManager
This guide is for players who want to **install and manage mods** for Data Center using the WorkshopManager desktop app.
This guide is for players who want to **install and manage mods** for Data Center using **GregModManager** — the Gregtools desktop app (executable on disk is still `WorkshopUploader.exe`; sources live under **`gregModmanager/`**).
## 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.
- **GregModManager** (`WorkshopUploader.exe` in release builds) — either built from source or installed from a release.
## Installation
You can run WorkshopManager from **any folder you prefer** (for example `Program Files`, Desktop, Downloads, or a folder next to the game). **Source code** for the app lives in the repo folder **`gregModmanager/`** (release ZIPs ship `WorkshopUploader.exe` / **Gregtools Modmanager**).
You can run GregModManager from **any folder you prefer** (for example `Program Files`, Desktop, Downloads, or a folder next to the game). **Source code** for the app lives in the repo folder **`gregModmanager/`** (release ZIPs ship `WorkshopUploader.exe` / **Gregtools Modmanager**).
### Option A — Installer setup (recommended)
@@ -31,7 +31,7 @@ You can run WorkshopManager from **any folder you prefer** (for example `Program
### Option B — Portable / ZIP build
1. Download or build the WorkshopManager files.
1. Download or build the GregModManager files.
2. Extract/copy the folder to any location you want.
3. Launch `WorkshopUploader.exe` directly from that folder.