Crash-reporting setting
Expose Send crash reports in the launcher’s settings. Automatic reporting is enabled by default. Reports include a memory dump and diagnostic details sent to Sentry to help investigate client crashes and unresponsive games.
Explain this beside the switch. Memory dumps can contain sensitive values from process memory, so avoid describing reports as anonymous.
Read the saved setting
Section titled “Read the saved setting”Run:
.\client-helper.exe diagnosticsThe terminal result contains the saved value:
{"protocolVersion":1,"event":"diagnostics","crashReports":true}Use crashReports to set the switch when the settings page opens. The command
works offline, before choosing a server or resource folder, and while a
download is running.
The preference is saved in %LOCALAPPDATA%\revo\diagnostics.json. Use the helper
to read and change it.
Save the player’s choice
Section titled “Save the player’s choice”To disable reporting:
.\client-helper.exe diagnostics --crash-reports falseTo enable it:
.\client-helper.exe diagnostics --crash-reports trueBoth commands return diagnostics with the resulting boolean. Wait for that
event and exit code 0 before showing the change as saved. While saving,
disable the switch. On failure, show the error and read the saved setting again.
Write only when the player changes the value. Repeatedly sending true starts
a new reporting period and makes reports queued under the previous period
ineligible for upload.
The existing Electron helper integration
can run these commands with diagnostics as the expected successful event.
What the switch controls
Section titled “What the switch controls”Turning reporting off prevents new uploads, including queued reports. An upload already in progress may finish. Turning it back on allows future reports to be sent. Reports captured while disabled, or left queued before the previous opt-out, stay local.
Local capture continues while automatic reporting is disabled. The client still saves memory dumps and text summaries for troubleshooting.
When reporting is enabled, temporary upload failures are retried in the background or on a later launch. The saved boolean expresses the player’s preference.
Open local reports
Section titled “Open local reports”Offer Open logs and Open crash reports actions using these locations:
<storage>\projects\<projectId>\logs<storage>\projects\<projectId>\crashdumpsUse storagePath and projectId from inspection to locate them. Inside
crashdumps, reports are grouped under client, client-2 and similar
instance folders. Each report contains:
| File | Contents |
|---|---|
.dmp |
Memory dump for debugging. |
.txt |
Report type, session details and capture result. |
.json |
Delivery status, such as pending, sent or local. |
Open the containing folder so the player can choose what to share with support. Older reports are removed automatically, so collect the relevant files soon after the problem occurs.