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:
@@ -6,7 +6,7 @@ description: Index of plugin and mod release pages (download metadata, notes lin
|
||||
|
||||
# Releases
|
||||
|
||||
Release pages list **download targets**, **version placeholders**, and links back to the **wiki articles** for each plugin or mod. Non-release documentation lives under [Mods](/wiki/mods/extensions) in the sidebar.
|
||||
Release pages list **download targets**, **version placeholders**, and links back to the **wiki articles** for each plugin or mod. Non-release documentation lives under [Plugins](/wiki/plugins/) and [Mods](/wiki/mods/) in the sidebar.
|
||||
|
||||
## Plugin releases
|
||||
|
||||
|
||||
@@ -17,5 +17,5 @@ import ModReleasePage from '@site/src/components/ModReleasePage';
|
||||
codeLanguages={['C#']}
|
||||
description="Provides guardrails around console input handling and accidental interactions."
|
||||
banner="Console input guard mod release"
|
||||
releaseNotesPath="/mods/mods/fmf-console-input-guard"
|
||||
releaseNotesPath="/wiki/mods/fmf-console-input-guard"
|
||||
/>
|
||||
|
||||
@@ -17,5 +17,5 @@ import ModReleasePage from '@site/src/components/ModReleasePage';
|
||||
codeLanguages={['C#']}
|
||||
description="Applies themed employee customization to hiring-related gameplay flows."
|
||||
banner="Gregify employees mod release"
|
||||
releaseNotesPath="/mods/mods/fmf-gregify-employees"
|
||||
releaseNotesPath="/wiki/mods/fmf-gregify-employees"
|
||||
/>
|
||||
|
||||
@@ -11,11 +11,11 @@ import ModReleasePage from '@site/src/components/ModReleasePage';
|
||||
dllName="FMF.HexLabelMod.dll"
|
||||
releaseReady={false}
|
||||
version="NotReleasedYet"
|
||||
author="mleem97 / gregFramework Community"
|
||||
author="mleem97 / FrikaMF Community"
|
||||
category="Mod"
|
||||
dependencies={['MelonLoader', 'Harmony']}
|
||||
codeLanguages={['C#']}
|
||||
description="Overlays cable spinner and rack color hex labels directly in-world."
|
||||
banner="Hex label mod release"
|
||||
releaseNotesPath="/mods/extensions/fmf-hex-label-mod"
|
||||
releaseNotesPath="/wiki/mods/fmf-hex-label-mod"
|
||||
/>
|
||||
|
||||
@@ -11,11 +11,11 @@ import ModReleasePage from '@site/src/components/ModReleasePage';
|
||||
dllName="FMF.JoniMLCompatMod.dll"
|
||||
releaseReady={false}
|
||||
version="NotReleasedYet"
|
||||
author="mleem97 / gregFramework Community"
|
||||
author="mleem97 / FrikaMF Community"
|
||||
category="Mod"
|
||||
dependencies={['MelonLoader']}
|
||||
codeLanguages={['C#']}
|
||||
description="Provides language/localization compatibility bridging for mixed mod stacks."
|
||||
banner="Language compatibility bridge release"
|
||||
releaseNotesPath="/mods/extensions/fmf-lang-compat-bridge"
|
||||
releaseNotesPath="/wiki/mods/fmf-lang-compat-bridge"
|
||||
/>
|
||||
|
||||
@@ -11,5 +11,5 @@ import ModReleasePage from '@site/src/components/ModReleasePage';
|
||||
dllName="FMF.UIReplacementMod.dll"
|
||||
description="Replaces and modernizes selected in-game UI layers with improved readability and layout behavior."
|
||||
banner="UI replacement mod release"
|
||||
releaseNotesPath="/mods/extensions/fmf-ui-replacement-mod"
|
||||
releaseNotesPath="/wiki/mods/fmf-ui-replacement-mod"
|
||||
/>
|
||||
|
||||
@@ -11,11 +11,11 @@ import ModReleasePage from '@site/src/components/ModReleasePage';
|
||||
dllName="FFM.Plugin.AssetExporter.dll"
|
||||
releaseReady={false}
|
||||
version="NotReleasedYet"
|
||||
author="mleem97 / gregFramework Community"
|
||||
author="mleem97 / FrikaMF Community"
|
||||
category="Plugin"
|
||||
dependencies={['MelonLoader', 'gregFramework']}
|
||||
dependencies={['MelonLoader', 'FrikaMF']}
|
||||
codeLanguages={['C#']}
|
||||
description="Provides export-focused tooling for asset-related workflows in Data Center modding pipelines."
|
||||
banner="Asset exporter plugin release"
|
||||
releaseNotesPath="/mods/extensions/ffm-plugin-asset-exporter"
|
||||
releaseNotesPath="/wiki/plugins/ffm-plugin-asset-exporter"
|
||||
/>
|
||||
|
||||
@@ -11,11 +11,11 @@ import ModReleasePage from '@site/src/components/ModReleasePage';
|
||||
dllName="FFM.Plugin.Multiplayer.dll"
|
||||
releaseReady={false}
|
||||
version="NotReleasedYet"
|
||||
author="mleem97 / gregFramework Community"
|
||||
author="mleem97 / FrikaMF Community"
|
||||
category="Plugin"
|
||||
dependencies={['MelonLoader', 'gregFramework']}
|
||||
dependencies={['MelonLoader', 'FrikaMF']}
|
||||
codeLanguages={['C#']}
|
||||
description="Contains multiplayer-oriented plugin functionality for gregFramework ecosystems."
|
||||
description="Contains multiplayer-oriented plugin functionality for FrikaMF ecosystems."
|
||||
banner="Multiplayer plugin release"
|
||||
releaseNotesPath="/mods/extensions/ffm-plugin-multiplayer"
|
||||
releaseNotesPath="/wiki/plugins/ffm-plugin-multiplayer"
|
||||
/>
|
||||
|
||||
@@ -11,11 +11,11 @@ import ModReleasePage from '@site/src/components/ModReleasePage';
|
||||
dllName="FFM.Plugin.PlayerModels.dll"
|
||||
releaseReady={false}
|
||||
version="NotReleasedYet"
|
||||
author="mleem97 / gregFramework Community"
|
||||
author="mleem97 / FrikaMF Community"
|
||||
category="Plugin"
|
||||
dependencies={['MelonLoader', 'gregFramework']}
|
||||
dependencies={['MelonLoader', 'FrikaMF']}
|
||||
codeLanguages={['C#']}
|
||||
description="Extends player model handling and related rendering/gameplay presentation behavior."
|
||||
banner="Player models plugin release"
|
||||
releaseNotesPath="/mods/extensions/ffm-plugin-player-models"
|
||||
releaseNotesPath="/wiki/plugins/ffm-plugin-player-models"
|
||||
/>
|
||||
|
||||
@@ -11,11 +11,11 @@ import ModReleasePage from '@site/src/components/ModReleasePage';
|
||||
dllName="FFM.Plugin.Sysadmin.dll"
|
||||
releaseReady={false}
|
||||
version="NotReleasedYet"
|
||||
author="mleem97 / gregFramework Community"
|
||||
author="mleem97 / FrikaMF Community"
|
||||
category="Plugin"
|
||||
dependencies={['MelonLoader', 'gregFramework']}
|
||||
dependencies={['MelonLoader', 'FrikaMF']}
|
||||
codeLanguages={['C#']}
|
||||
description="Provides sysadmin-focused controls and quality-of-life command utilities."
|
||||
banner="Sysadmin plugin release"
|
||||
releaseNotesPath="/mods/extensions/ffm-plugin-sysadmin"
|
||||
releaseNotesPath="/wiki/plugins/ffm-plugin-sysadmin"
|
||||
/>
|
||||
|
||||
@@ -11,11 +11,11 @@ import ModReleasePage from '@site/src/components/ModReleasePage';
|
||||
dllName="FFM.Plugin.WebUIBridge.dll"
|
||||
releaseReady={false}
|
||||
version="NotReleasedYet"
|
||||
author="mleem97 / gregFramework Community"
|
||||
author="mleem97 / FrikaMF Community"
|
||||
category="Plugin"
|
||||
dependencies={['MelonLoader', 'gregFramework']}
|
||||
dependencies={['MelonLoader', 'FrikaMF']}
|
||||
codeLanguages={['C#']}
|
||||
description="Bridges runtime data to web interfaces for dashboards and remote overlays."
|
||||
banner="Web UI bridge plugin release"
|
||||
releaseNotesPath="/mods/extensions/ffm-plugin-web-ui-bridge"
|
||||
releaseNotesPath="/wiki/plugins/ffm-plugin-web-ui-bridge"
|
||||
/>
|
||||
|
||||
@@ -12,13 +12,13 @@ import ModReleasePage from '@site/src/components/ModReleasePage';
|
||||
dllName="FMF.ModPathRedirector.dll"
|
||||
releaseReady={true}
|
||||
version="1.5.0"
|
||||
author="DataCenterExporter / gregFramework Community"
|
||||
author="DataCenterExporter / FrikaMF Community"
|
||||
category="MelonLoader plugin"
|
||||
dependencies={['MelonLoader', 'Steam (client)', 'Data Center']}
|
||||
codeLanguages={['C#']}
|
||||
description="MelonLoader plugin: after Il2Cpp assembly generation, blocks MelonMods load until each subscribed Workshop item is downloaded (Steam) and workshop_* folders exist under Data Center_Data/StreamingAssets/Mods/, with per-item DownloadItem and timeouts. Does not redirect native mod paths."
|
||||
banner="Workshop download helper (MelonLoader Plugins/)"
|
||||
releaseNotesPath="/wiki/workshop-uploader"
|
||||
releaseNotesPath="/wiki/tools/workshop-uploader"
|
||||
installation={
|
||||
<ol>
|
||||
<li>
|
||||
|
||||
@@ -28,15 +28,15 @@ Push tag **`gregtools-modmanager-v1.0.0`** on `main` (or run the workflow manual
|
||||
## Install
|
||||
|
||||
1. Download **`Gregtools-Modmanager-1.0.0-win10-x64.zip`** from the release.
|
||||
2. Extract to a folder of your choice (or next to the game — see [Workshop uploader](/wiki/workshop-uploader)).
|
||||
2. Extract to a folder of your choice (or next to the game — see [Workshop uploader](/wiki/tools/workshop-uploader)).
|
||||
3. Run **`WorkshopUploader.exe`**. **Steam** must be installed; the app uses the Steamworks API for Workshop.
|
||||
|
||||
## Documentation
|
||||
|
||||
- [Workshop uploader (full guide)](/wiki/workshop-uploader)
|
||||
- [Workshop uploader (full guide)](/wiki/tools/workshop-uploader)
|
||||
- [End-user Workshop guide](/wiki/guides/enduser-workshop)
|
||||
- Open-source and third-party components: [`WorkshopUploader/EXTERNAL_DEPENDENCIES.md`](https://github.com/mleem97/gregFramework/blob/main/WorkshopUploader/EXTERNAL_DEPENDENCIES.md) in the repository
|
||||
|
||||
## Scope of 1.0
|
||||
|
||||
Initial **1.0** marks a stable baseline for the MAUI Windows app (self-contained publish, trimmed Release builds, localization, Mod Store / Mod Manager / editor flows). Patch and feature releases will use **1.0.x** / **1.x** as versioning on the [application version](/wiki/workshop-uploader) in the project file.
|
||||
Initial **1.0** marks a stable baseline for the MAUI Windows app (self-contained publish, trimmed Release builds, localization, Mod Store / Mod Manager / editor flows). Patch and feature releases will use **1.0.x** / **1.x** as versioning on the [application version](/wiki/tools/workshop-uploader) in the project file.
|
||||
|
||||
Reference in New Issue
Block a user