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

update: docs to new architecture

Browse Source
This commit is contained in:
Marvin
2026-04-10 16:41:04 +02:00
parent 539254db8c
commit 97977a333c
6 changed files with 218 additions and 66 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
docs/framework/hexmod.md
View File

@@ -1,19 +1,22 @@
---
title: HexMod
sidebar_label: HexMod
description: Hex label mod — in-world hex color labels for cable spinners and racks.
description: Hex label mod — in-world hex color labels for cable spinners and racks, now powered by Lua.
---
# HexMod
The **Hex Label** mod adds in-world hex color labels for cable spinners and racks.
Since **v00.02**, HexLabel is a **pure Lua mod** powered by gregCore's Lua runtime. All mod logic lives in `lua/hexlabel/main.lua`; the C# assembly is a thin metadata-only bootstrap.
## Steamworks Info
| Field | Value |
|-------|-------|
| **Assembly** | `FMF.HexLabelMod.dll` |
| **Version** | `00.01.0009` |
| **Assembly** | `FMF.HexLabelMod.dll` (bootstrap only) |
| **Lua script** | `Mods/ScriptMods/lua/hexlabel/main.lua` |
| **Version** | `00.02.0000` |
| **Author** | mleem97 |
| **Game** | Data Center (App 4170200) |
| **Workshop Tags** | `modded`, `melonloader`, `mod` |
@@ -21,11 +24,19 @@ The **Hex Label** mod adds in-world hex color labels for cable spinners and rack
## Downloads
- **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/`
- **GitHub:** [Latest release](https://github.com/mleem97/gregModHexLabelMod/releases/latest)
- **Manual:** Copy `lua/hexlabel/` to `Mods/ScriptMods/lua/hexlabel/`
## Architecture
| Component | Location | Role |
|-----------|----------|------|
| **Lua script** | `lua/hexlabel/main.lua` | All mod logic: labeling, HUD, hex viewer, config |
| **C# bootstrap** | `Main.cs` → `FMF.HexLabelMod.dll` | MelonLoader metadata only |
| **gregCore APIs** | `greg.unity.*`, `greg.hook.*`, `greg.gui.*`, `greg.io.*`, `greg.input.*` | Generic framework services used by the Lua script |
## Source & layout
- **Repository:** [`mleem97/gregModHexLabelMod`](https://github.com/mleem97/gregModHexLabelMod) (assembly `FMF.HexLabelMod.dll`)
- **Repository:** [`mleem97/gregModHexLabelMod`](https://github.com/mleem97/gregModHexLabelMod)
See also the detailed wiki article [FMF.HexLabelMod](/wiki/mods/fmf-hex-label-mod).