mirror of
https://github.com/mleem97/gregWiki.git
synced 2026-04-11 03:29:19 +02:00
docs(hexlabel): mark FMF.HexLabelMod released; Steam + gregModHexLabelMod repo
Made-with: Cursor
This commit is contained in:
@@ -20,11 +20,12 @@ The **Hex Label** mod adds in-world hex color labels for cable spinners and rack
|
|||||||
|
|
||||||
## Downloads
|
## Downloads
|
||||||
|
|
||||||
- **Steam Workshop:** Subscribe via the Gregtools Modmanager or the [Steam Workshop](https://steamcommunity.com/app/4170200/workshop/)
|
- **Steam Workshop:** [FMF.HexLabelMod — workshop item](https://steamcommunity.com/sharedfiles/filedetails/?id=3701404621) (subscribe in-game or via GregModManager)
|
||||||
|
- **GitHub:** [Latest release](https://github.com/mleem97/gregModHexLabelMod/releases/latest) (`FMF.HexLabelMod.dll`)
|
||||||
- **Manual:** Drop `FMF.HexLabelMod.dll` into `<Data Center>/Mods/`
|
- **Manual:** Drop `FMF.HexLabelMod.dll` into `<Data Center>/Mods/`
|
||||||
|
|
||||||
## Source & layout
|
## Source & layout
|
||||||
|
|
||||||
- **Build sources:** [`gregMod.HexLabelMod`](https://github.com/mleem97/gregFramework/tree/main/gregMod.HexLabelMod) (assembly `FMF.HexLabelMod.dll`)
|
- **Repository:** [`mleem97/gregModHexLabelMod`](https://github.com/mleem97/gregModHexLabelMod) (assembly `FMF.HexLabelMod.dll`)
|
||||||
|
|
||||||
See also the detailed wiki article [FMF.HexLabelMod](/wiki/mods/fmf-hex-label-mod).
|
See also the detailed wiki article [FMF.HexLabelMod](/wiki/mods/fmf-hex-label-mod).
|
||||||
|
|||||||
@@ -46,7 +46,7 @@ dotnet build gregCore/FrikaMF.sln -c Release
|
|||||||
```bash
|
```bash
|
||||||
dotnet build gregMod.ConsoleInputGuard/FMF.ConsoleInputGuard.csproj -c Release
|
dotnet build gregMod.ConsoleInputGuard/FMF.ConsoleInputGuard.csproj -c Release
|
||||||
dotnet build gregMod.GregifyEmployees/FMF.GregifyEmployees.csproj -c Release
|
dotnet build gregMod.GregifyEmployees/FMF.GregifyEmployees.csproj -c Release
|
||||||
dotnet build gregMod.HexLabelMod/FMF.HexLabelMod.csproj -c Release
|
dotnet build gregModHexLabelMod/FMF.HexLabelMod.csproj -c Release
|
||||||
dotnet build gregMod.LangCompatBridge/FMF.JoniMLCompatMod.csproj -c Release
|
dotnet build gregMod.LangCompatBridge/FMF.JoniMLCompatMod.csproj -c Release
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|||||||
@@ -10,10 +10,10 @@
|
|||||||
"author": "mleem97",
|
"author": "mleem97",
|
||||||
"workshopTags": ["modded", "melonloader", "mod"],
|
"workshopTags": ["modded", "melonloader", "mod"],
|
||||||
"workshopContentPath": "content/Mods/",
|
"workshopContentPath": "content/Mods/",
|
||||||
"workshopUrl": "",
|
"workshopUrl": "https://steamcommunity.com/sharedfiles/filedetails/?id=3701404621",
|
||||||
"githubReleaseUrl": "",
|
"githubReleaseUrl": "https://github.com/mleem97/gregModHexLabelMod/releases/latest",
|
||||||
"wikiPath": "/wiki/mods/fmf-hex-label-mod",
|
"wikiPath": "/wiki/mods/fmf-hex-label-mod",
|
||||||
"sourcePath": "gregMod.HexLabelMod"
|
"sourcePath": "gregModHexLabelMod"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"id": "console-input-guard",
|
"id": "console-input-guard",
|
||||||
|
|||||||
@@ -5,7 +5,14 @@ sidebar_label: FMF.HexLabelMod
|
|||||||
|
|
||||||
<!-- markdownlint-disable MD060 -->
|
<!-- markdownlint-disable MD060 -->
|
||||||
|
|
||||||
`gregMod.HexLabelMod/` (assembly `FMF.HexLabelMod.dll`)
|
[`gregModHexLabelMod`](https://github.com/mleem97/gregModHexLabelMod) (assembly `FMF.HexLabelMod.dll`)
|
||||||
|
|
||||||
|
## Release
|
||||||
|
|
||||||
|
| Channel | Link |
|
||||||
|
| --- | --- |
|
||||||
|
| **Steam Workshop** | [Subscribe (item 3701404621)](https://steamcommunity.com/sharedfiles/filedetails/?id=3701404621) |
|
||||||
|
| **GitHub** | [Releases](https://github.com/mleem97/gregModHexLabelMod/releases/latest) |
|
||||||
|
|
||||||
## Purpose
|
## Purpose
|
||||||
|
|
||||||
@@ -23,8 +30,9 @@ This mod runs standalone and does **not** require FMF runtime APIs.
|
|||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
1. Drop `FMF.HexLabelMod.dll` into your `Mods/` folder.
|
1. **Recommended:** Subscribe on the [Steam Workshop](https://steamcommunity.com/sharedfiles/filedetails/?id=3701404621), or download `FMF.HexLabelMod.dll` from the [latest GitHub release](https://github.com/mleem97/gregModHexLabelMod/releases/latest).
|
||||||
2. Launch the game — the config file is created automatically on first run at:
|
2. If you use a manual DLL, drop `FMF.HexLabelMod.dll` into your `Mods/` folder.
|
||||||
|
3. Launch the game — the config file is created automatically on first run at:
|
||||||
|
|
||||||
```text
|
```text
|
||||||
UserData/hexposition.cfg
|
UserData/hexposition.cfg
|
||||||
@@ -78,7 +86,7 @@ Pressing **Ctrl+F1** toggles live config reload (6-second interval), allowing yo
|
|||||||
## Build
|
## Build
|
||||||
|
|
||||||
```powershell
|
```powershell
|
||||||
dotnet build .\gregMod.HexLabelMod\FMF.HexLabelMod.csproj
|
dotnet build .\gregModHexLabelMod\FMF.HexLabelMod.csproj
|
||||||
```
|
```
|
||||||
|
|
||||||
Output lands in the standard MelonLoader `Mods/` folder as configured in the `.csproj`.
|
Output lands in the standard MelonLoader `Mods/` folder as configured in the `.csproj`.
|
||||||
@@ -94,11 +102,11 @@ Output lands in the standard MelonLoader `Mods/` folder as configured in the `.c
|
|||||||
## Notes
|
## Notes
|
||||||
|
|
||||||
- Original gameplay behavior is unaffected.
|
- Original gameplay behavior is unaffected.
|
||||||
- This mod is developed in `gregMod.HexLabelMod/` (workspace root), not under a legacy `mods/` tree.
|
- Source lives in the split repo [`gregModHexLabelMod`](https://github.com/mleem97/gregModHexLabelMod), not under a legacy `mods/` tree.
|
||||||
- The config file is fully rewritten if any expected keys are missing (for example, after an update adds new keys).
|
- The config file is fully rewritten if any expected keys are missing (for example, after an update adds new keys).
|
||||||
- FMF assembly presence is no longer required as a startup gate.
|
- FMF assembly presence is no longer required as a startup gate.
|
||||||
|
|
||||||
## Sources
|
## Sources
|
||||||
|
|
||||||
- Module path: `gregMod.HexLabelMod/`
|
- Repository: [github.com/mleem97/gregModHexLabelMod](https://github.com/mleem97/gregModHexLabelMod)
|
||||||
- See also: [Mods overview](/wiki/mods/)
|
- See also: [Mods overview](/wiki/mods/) · [HexMod hub](/wiki/framework/hexmod)
|
||||||
|
|||||||
@@ -9,13 +9,13 @@ import ModReleasePage from '@site/src/components/ModReleasePage';
|
|||||||
title="FMF.HexLabelMod"
|
title="FMF.HexLabelMod"
|
||||||
kind="mod"
|
kind="mod"
|
||||||
dllName="FMF.HexLabelMod.dll"
|
dllName="FMF.HexLabelMod.dll"
|
||||||
releaseReady={false}
|
releaseReady={true}
|
||||||
version="NotReleasedYet"
|
version="00.01.0009"
|
||||||
author="mleem97 / FrikaMF Community"
|
author="mleem97 / gregFramework Community"
|
||||||
category="Mod"
|
category="Mod"
|
||||||
dependencies={['MelonLoader', 'Harmony']}
|
dependencies={['MelonLoader', 'Harmony']}
|
||||||
codeLanguages={['C#']}
|
codeLanguages={['C#']}
|
||||||
description="Overlays cable spinner and rack color hex labels directly in-world."
|
description="Overlays cable spinner and rack color hex labels directly in-world."
|
||||||
banner="Hex label mod release"
|
banner="Hex label mod release — Steam Workshop and GitHub."
|
||||||
releaseNotesPath="/wiki/mods/fmf-hex-label-mod"
|
releaseNotesPath="/wiki/mods/fmf-hex-label-mod"
|
||||||
/>
|
/>
|
||||||
|
|||||||
@@ -176,7 +176,7 @@ const config = {
|
|||||||
from: ['/mod/FMF.GregifyEmployees.dll'],
|
from: ['/mod/FMF.GregifyEmployees.dll'],
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
to: 'https://github.com/mleem97/gregFramework/releases/latest/download/FMF.HexLabelMod.dll',
|
to: 'https://github.com/mleem97/gregModHexLabelMod/releases/latest/download/FMF.HexLabelMod.dll',
|
||||||
from: ['/mod/FMF.HexLabelMod.dll'],
|
from: ['/mod/FMF.HexLabelMod.dll'],
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -141,17 +141,17 @@ export const moduleCatalog: ModuleEntry[] = [
|
|||||||
{
|
{
|
||||||
id: 'fmf-hex-label-mod',
|
id: 'fmf-hex-label-mod',
|
||||||
name: 'FMF.HexLabelMod',
|
name: 'FMF.HexLabelMod',
|
||||||
repoFolder: 'gregMod.HexLabelMod',
|
repoFolder: 'gregModHexLabelMod',
|
||||||
type: 'mod',
|
type: 'mod',
|
||||||
description: 'In-world hex color labels for cable spinners and racks.',
|
description: 'In-world hex color labels for cable spinners and racks.',
|
||||||
version: 'NotReleasedYet',
|
version: '00.01.0009',
|
||||||
author: 'mleem97 / gregFramework Community',
|
author: 'mleem97 / gregFramework Community',
|
||||||
languages: ['C#'],
|
languages: ['C#'],
|
||||||
dependencies: ['MelonLoader', 'Harmony'],
|
dependencies: ['MelonLoader', 'Harmony'],
|
||||||
wikiPath: '/wiki/mods/fmf-hex-label-mod',
|
wikiPath: '/wiki/mods/fmf-hex-label-mod',
|
||||||
releasePath: '/wiki/releases/mods/fmf-hex-label-mod-release',
|
releasePath: '/wiki/releases/mods/fmf-hex-label-mod-release',
|
||||||
downloadPath: '/mod/FMF.HexLabelMod.dll',
|
downloadPath: '/mod/FMF.HexLabelMod.dll',
|
||||||
releaseReady: false,
|
releaseReady: true,
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
id: 'fmf-lang-compat-bridge',
|
id: 'fmf-lang-compat-bridge',
|
||||||
|
|||||||
Reference in New Issue
Block a user