Skip to content

Commit a445ffc

Browse files
committed
docs(README): 📝 add spacing for improved readability
1 parent 4a7c4c9 commit a445ffc

1 file changed

Lines changed: 3 additions & 0 deletions

File tree

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,21 @@
33
A [ResoniteModLoader](https://github.com/resonite-modding-group/ResoniteModLoader) mod for [Resonite](https://resonite.com/) that mirrors the Asset Optimization workflow to bulk swap every matching `ISyncRef` inside a single undo batch.
44

55
## Features
6+
67
- Dev Tool context-menu entry (**Reference Replacement…**) to open the dialog from any inspected slot.
78
- Userspace dialog with pickers for process root, source reference, and replacement target.
89
- Analyze button that previews compatible vs incompatible hits before committing.
910
- Replace button that writes every compatible reference atomically for clean undo support.
1011
- Automatic skip counters so incompatible targets are reported instead of silently failing.
1112

1213
## Installation
14+
1315
1. Install [ResoniteModLoader](https://github.com/resonite-modding-group/ResoniteModLoader).
1416
2. Download the latest `ReferenceReplacement.dll` from this repo’s Releases page and place it in the `rml_mods` folder inside your Resonite install (e.g., `C:\Program Files (x86)\Steam\steamapps\common\Resonite\rml_mods`). Create the folder if it does not exist.
1517
3. Launch Resonite and confirm the mod loads via the in-game logs if desired.
1618

1719
## Build & Hot Reload
20+
1821
1. Install the .NET 9 SDK.
1922
2. `dotnet build ReferenceReplacement.sln` auto-detects `Resonite` next to the repo, the default Steam Windows path, then the default Steam Linux path. If the game lives elsewhere, pass `-p:ResoniteAssembliesDir="/absolute/path/to/Resonite"` so the build can find `FrooxEngine.dll`, `Elements.Core.dll`, `Libraries/ResoniteModLoader.dll`, and `rml_libs/0Harmony.dll`.
2023
3. Set `CopyToMods=true` when invoking `dotnet build` to copy the compiled DLL into `$(ResoniteAssembliesDir)/rml_mods` after each build.

0 commit comments

Comments
 (0)