openac-mosswartmassacre/README.md
Erik 336c5cfdf5 One plugin-bar button and one tabbed window, as the original
Live in 0.1.19 the plugin put three buttons on the plugin bar (MM, Mossy
Tracker, Metas), the tracker carried the icon that belongs to the main
window, and the metas downloads were in a window of their own.

Now only the main window has a bar button: "MM" with the original
window's icon (7735, 0x06001E37). Its tabs follow the original's notebook:
Main, Settings, Statistics, Mossy Tracker, Metas, Tools. The Mossy Tracker
tab is the original page, one "Open Mossy Tracker" button that opens the
tracker window; that window is registered without a bar button and
opened through the host's ShowPanel. The Metas tab holds everything the
metas window had (list with search, refresh, check, download outdated,
download one file, last check, status), plus the repository address and
the two folders the files land in. The main window forwards those
bindings to the meta sync's view model, since markup binds one object.

Downloads already went to the host's VTank profile storage, the one
MossTank reads, under mosstank/metas and mosstank/navs with each file's
own name and extension; the tab now shows those full folder paths
instead of the storage root. Backend frames are untouched.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-09-26 06:56:10 +02:00

58 lines
2.2 KiB
Markdown

# Mosswart Massacre for OpenAC
A private OpenAC port of the Mosswart Massacre DECAL plugin: it streams
telemetry, vitals, chat, inventory, combat and character stats to the Mosswart
Overlord backend, shares vitals and debuffs across machines, runs the commands
typed into the Overlord chat box, keeps the flag tracker and syncs metas.
**The backend contract is fixed.** Every frame this plugin sends or accepts is
byte-for-byte what the DECAL plugin sent and accepted; the golden tests under
`tests/` pin each one. Change a frame only together with the backend.
## Building
The plugin contract is `AcDream.Plugin.Abstractions` of the version named in
`Directory.Build.props` (`PluginApiPackageVersion`), currently 0.1.19, the
OpenAC 0.1.19 release. Put that release's package in `packages-local/`; an
OpenAC client from 0.1.19 on loads the plugin.
```
gh release download v0.1.19 --repo eriknihlen/OpenAC -p "AcDream.Plugin.Abstractions.0.1.19.nupkg" -D packages-local
dotnet build OpenAC.MosswartMassacre.slnx
dotnet test OpenAC.MosswartMassacre.slnx
```
## Installing
Copy `src/OpenAC.MosswartMassacre/bin/<config>/net10.0/` (the dll, its
`.deps.json`, `Newtonsoft.Json.dll`, `plugin.json` and the markup) into
`%LOCALAPPDATA%\acdream\plugins\openac.mosswartmassacre\`.
## First run
Streaming is off until you turn it on. The shared secret is never compiled in:
```
/mm ws secret <the backend's shared secret>
/mm ws enable
```
`/mm help` lists every command.
The plugin has one button on the plugin bar, MM. Its Metas tab downloads the
club's metas and navs into the shared VTank profile folder the client
configures (by default `%LOCALAPPDATA%\OpenAC\vtank`), under `mosstank\metas`
and `mosstank\navs`, where MossTank loads them; the tab shows both folders.
## Testing against a stand-in backend
`tools/FrameRecorder` accepts the plugin's socket like the backend does,
records every frame to a JSON-lines file, relays `share_*` frames between
subscribed clients as the backend does, and compares two recordings by
frame shape:
```
dotnet run --project tools/FrameRecorder -- record 18765 frames.jsonl
/mm ws url ws://localhost:18765/websocket/
dotnet run --project tools/FrameRecorder -- compare decal.jsonl port.jsonl
```