You are viewing a potentially older version of this package. View all versions.
GangDesNuages-NuageReport-1.0.0 icon

NuageReport

Host-authoritative R.E.P.O. run recap and salvage report mod with client report sync.

Date uploaded a month ago
Version 1.0.0
Download link GangDesNuages-NuageReport-1.0.0.zip
Downloads 228
Dependency string GangDesNuages-NuageReport-1.0.0

This mod requires the following mods to function

BepInEx-BepInExPack-5.4.2305 icon
BepInEx-BepInExPack

BepInEx pack for Mono Unity games. Preconfigured and ready to use.

Preferred version: 5.4.2305

README

NuageReport

NuageReport is a R.E.P.O. BepInEx mod that records host-observed run events and turns them into a level recap.

Maintained by TheoHay and published on Thunderstore under GangDesNuages.

It is meant to answer simple post-run questions: what spawned, what was extracted, what was missed or destroyed, how much value was lost, and which player-facing events the host could observe with reasonable confidence.

Features

  • Host-authoritative recording for normal run levels.
  • Tabbed report menu, opened with O by default.
  • Optional JSON report export under the game's persistent user data folder.
  • Final report sharing from the host to clients that also have NuageReport installed.
  • Optional live debug report tab when enabled.
  • Optional live report sharing for modded clients.
  • Conservative player attribution with confidence labels in the internal event model.

What It Tracks

NuageReport currently records and summarizes:

  • objects detected at level start;
  • objects extracted, missed, damaged, destroyed, and value lost;
  • monster loot orb collection and loss;
  • monster damage and kills observed by the host;
  • player damage taken;
  • per-player object/cart/cashout contribution stats where attribution is available.

NuageReport is a recap tool, not a blame tool. Some in-game events are easy for the host to observe directly, while others are noisy or indirect. Player attribution should be treated as useful context, not perfect truth.

Installation

Install NuageReport through a mod manager or place the packaged files in your BepInEx plugins folder.

Required dependency:

  • BepInEx-BepInExPack-5.4.2305

Only the host needs NuageReport for recording and exporting host reports. Clients can play without it. Clients that do install NuageReport can receive the host's completed report in-game.

Usage

  1. Start or join a run.
  2. Finish a level or transition out of it.
  3. Press O to open the report menu.

The same key closes the open report overlay. When live reporting is enabled, the menu includes both Summary and Live tabs.

When General.EnableJsonOutput is enabled, reports are exported as JSON to:

<Unity persistent data path>/NuageReport/runs/

On Windows, this is normally:

%USERPROFILE%\AppData\LocalLow\semiwork\Repo\NuageReport\runs\

NuageReport also writes last-startup.txt next to the runs folder, which can help confirm where the game resolved the output path and whether JSON output is enabled.

Configuration

NuageReport uses a BepInEx config file under the plugin GUID:

com.theohay.nuagereport

Useful options include:

Section Key Default Purpose
General EnableRecording true Enables NuageReport. When disabled, recording, report UI, polling, and multiplayer sync stay inactive.
General EnableLiveReport false Enables the live report tab and allows live report sharing when multiplayer report sharing is enabled.
General EnableJsonOutput true Writes completed run reports as JSON files under the NuageReport runs folder.
General CartConfirmationSeconds 0.5 How long a valuable must stay detected in a cart before NuageReport confirms it as first carted, reducing accidental touch/flicker noise.
Keybinds ReportMenuKeybind O Opens or closes the report menu.
Multiplayer ShareReports true Shares completed reports with modded clients. Live reports are shared too when General.EnableLiveReport is enabled.
Multiplayer LiveReportSyncIntervalSeconds 2 Minimum seconds between live report sync packets. Allowed range: 0.5 to 10.
Diagnostics LogRecordedEvents false Logs every accepted recorder event to the BepInEx console for debugging.

Development

From the monorepo root:

./scripts/verify.ps1 -Mod NuageReport
./scripts/package.ps1 -Mod NuageReport

The project layout is:

mods/NuageReport/
  src/NuageReport.Core/       Unity-free recorder, model, and formatters.
  src/NuageReport.Plugin/     BepInEx plugin, Harmony patches, UI, networking, export.
  tests/NuageReport.Core.Tests/
  manifest.json, README.md, CHANGELOG.md, assets/icon.png

NuageReport.Core intentionally avoids Unity, BepInEx, Harmony, Photon, and R.E.P.O. references so report logic can be tested without launching the game.

License

NuageReport is licensed under the MIT License.

CHANGELOG

Changelog

1.0.0

  • Initial public release of NuageReport.
  • Add host-authoritative run recap recording for normal R.E.P.O. levels.
  • Add an in-game tabbed report menu, opened with O by default.
  • Summarize spawned, extracted, missed, damaged, and destroyed valuables, including value lost.
  • Track monster-loot orbs, cosmetic objects, player contributions, player damage, monster damage, and monster kills where the host can observe them.
  • Export completed reports as summary JSON under the game's persistent user data folder, with General.EnableJsonOutput available to disable disk output.
  • Share completed host reports with clients that also have NuageReport installed.
  • Add an optional live report tab and optional live report sync for modded clients.
  • Provide a clean 1.0 config surface for recording, JSON output, live reports, keybinds, multiplayer sharing, cart confirmation timing, and diagnostics.
  • Keep diagnostics logging disabled by default, with opt-in hook and recorded-event logs for troubleshooting.