mirror of https://github.com/mleem97/gregWiki.git synced 2026-04-11 11:39:18 +02:00

Files

Marvin ea92a0baf8 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.

2026-04-10 01:20:22 +02:00

4.4 KiB

Raw Blame History

id, title, sidebar_label, description, sidebar_position, tags

title

sidebar_label

description

sidebar_position

Release

Release artifacts

The following components are built and packaged for Steam Workshop distribution:

Core Framework

Component	Assembly	Workshop content path	Tags
FrikaModFramework	`FrikaModdingFramework.dll`	`content/Mods/`	modded, melonloader, framework, fmf

FMF Plugins

Plugin	Assembly	Workshop content path	Tags
FFM.Plugin.Multiplayer	`FFM.Plugin.Multiplayer.dll`	`content/FMF/Plugins/`	modded, fmf, plugin
FFM.Plugin.Sysadmin	`FFM.Plugin.Sysadmin.dll`	`content/FMF/Plugins/`	modded, fmf, plugin
FFM.Plugin.AssetExporter	`FFM.Plugin.AssetExporter.dll`	`content/FMF/Plugins/`	modded, fmf, plugin
FFM.Plugin.WebUIBridge	`FFM.Plugin.WebUIBridge.dll`	`content/FMF/Plugins/`	modded, fmf, plugin
FFM.Plugin.PlayerModels	`FFM.Plugin.PlayerModels.dll`	`content/FMF/Plugins/`	modded, fmf, plugin

Gameplay Mods

Mod	Assembly	Workshop content path	Tags
FMF.ConsoleInputGuard	`FMF.ConsoleInputGuard.dll`	`content/Mods/`	modded, melonloader, mod
FMF.GregifyEmployees	`FMF.GregifyEmployees.dll`	`content/Mods/`	modded, melonloader, mod
FMF.HexLabelMod	`FMF.HexLabelMod.dll`	`content/Mods/`	modded, melonloader, mod
FMF.JoniMLCompatMod	`FMF.JoniMLCompatMod.dll`	`content/Mods/`	modded, melonloader, mod

Gregtools Modmanager (WorkshopManager)

Version	Component	Target	Description
1.0	Gregtools Modmanager	`net9.0-windows` (win10-x64), self-contained	Steam Workshop client + Mod Store + Mod Manager. No .NET runtime required. See GregTools 1.0 Modmanager release.

Installation for end users

Quick start

Install MelonLoader (IL2CPP) for Data Center.
Start the game once, then close it.
Subscribe to mods via the WorkshopManager Mod Store or the Steam Workshop.
Start the game.

Manual installation

Download the DLL from the Workshop or a release.
Framework: place FrikaModdingFramework.dll in <Data Center>/Mods/.
Plugins: place FFM.Plugin.*.dll in <Data Center>/FMF/Plugins/.
Mods: place FMF.*.dll in <Data Center>/Mods/.
Start the game and check MelonLoader/Latest.log.

Game directory structure

Data Center/
├── Mods/
│   ├── FrikaModdingFramework.dll
│   ├── FMF.ConsoleInputGuard.dll
│   ├── FMF.GregifyEmployees.dll
│   ├── FMF.HexLabelMod.dll
│   └── FMF.JoniMLCompatMod.dll
├── FMF/
│   └── Plugins/
│       ├── FFM.Plugin.Multiplayer.dll
│       ├── FFM.Plugin.Sysadmin.dll
│       ├── FFM.Plugin.AssetExporter.dll
│       ├── FFM.Plugin.WebUIBridge.dll
│       └── FFM.Plugin.PlayerModels.dll
├── MelonLoader/
│   └── Latest.log
├── UserData/
│   └── ModCfg/
└── workshop/
    ├── FrikaModFramework/
    │   ├── content/Mods/FrikaModdingFramework.dll
    │   └── metadata.json
    ├── FFM.Plugin.Multiplayer/
    │   ├── content/FMF/Plugins/FFM.Plugin.Multiplayer.dll
    │   └── metadata.json
    ├── Gregtools Modmanager/
    │   ├── content/   (self-contained WorkshopUploader.exe + dependencies)
    │   └── metadata.json
    └── ... (one folder per component)

Build and deploy (contributors)

# Build everything and package into Workshop folders
pwsh -File scripts/Deploy-Release-ToWorkshop.ps1

# Deploy to game Mods/ and FMF/Plugins/ for local testing
pwsh -File scripts/Deploy-Release-ToDataCenter.ps1

Compatibility

Component	Requires
All mods/plugins	Data Center (Steam App 4170200)
All mods/plugins	MelonLoader (IL2CPP, stable)
FMF Plugins	FrikaModdingFramework.dll in Mods/
Gregtools Modmanager	Windows 10 1809+ (self-contained, no runtime install needed)

4.4 KiB Raw Blame History