Skip to content

Telemetry

smallketchup82 edited this page Oct 29, 2026 · 2 revisions

Reporting controls

Open Settings → Telemetry in the lobby. Automatic Crash Reporting starts on; Automatic Error Reporting, all attachment switches and Disable All Telemetry start off. Existing saved choices are preserved. Telemetry is used only to fix bugs and crashes. Sentry uploads are available only in builds produced by the release pipeline. Ordinary local builds never send Sentry reports or show crash-report prompts; their Report a Bug… button can still open GitHub with build details.

Setting Behavior
Automatic Crash Reporting Sends qualifying macOS-port crashes without asking
Automatic Error Reporting Independently sends recognized macOS-port errors
Disable All Telemetry Requires a full app restart, including when turning it off. Forces both automatic options off, suppresses crash prompts and prevents all Sentry requests

With automatic crash reporting off, a qualifying crash offers a review dialog before sending. You can decline. Apple sometimes writes the crash report after the app exits, so the offer may appear on the next launch. Turning the master switch off does not restore automatic reporting.

Optional attachments

Each attachment switch is independent and off by default. These saved choices apply to automatic reports. Manual bug and crash reports start with the same choices, but changing a manual report does not change the saved settings.

Attachment What it includes
Replay and game timestamp The replay identified by the affected game, if it exists, with last-observed frame/game time in the event. Recoil normally saves replay contents at game exit; a hard crash may leave no replay
Full logs Complete available infolog.txt, log/launcher.log, and log/engine-launch.log snapshots, without truncating them
Engine screenshot For live error/manual reports, requests the engine's screenshot command. For crashes, can include an existing screenshot from the same match; a fresh image cannot be captured after the process dies. Capture time is recorded
Configuration data Sanitized springsettings and lobby preference exports. Credential, account, user, chat, path and similar sensitive keys are removed; this is not the raw lobby file containing saved account state

Logs, screenshots and replays can reveal player names, chat and game activity. They are not anonymous. Inspect optional files before sending them manually. Automatic uploads use the saved consent switches without another review.

Files are limited to 20 MB each and 50 MB total per report. Missing, oversized and uncorrelated files are listed as unavailable/omitted. The reporter does not substitute an unrelated replay or screenshot. Screenshot capture can fail while the engine is busy or unavailable. Previous-launch logs are snapshotted before the new process overwrites them; historical files that are already gone cannot be recovered.

Report a bug manually

Choose Report a Bug…, adjust the attachment checkboxes for this report, and review the exact filenames and sizes. Inspect Files… opens a temporary local folder for inspection; edits there do not alter the prepared upload. Cancel to change your selection. After uploading, the app opens GitHub's new-issue form with environment information and the confirmed Sentry event ID. Fill in Description and Steps to reproduce, then submit the issue yourself.

You can choose Open GitHub Only without a Sentry upload. When telemetry is disabled or the app is a development build, this is the available reporting route. A failed or rate-limited upload is shown as unconfirmed, rather than claiming files were received.

The GitHub form starts with Environment, followed by Description, Steps to reproduce, Screenshots & Files, and optional Workarounds and comparisons. Environment, description and reproduction details are required by the normal GitHub form. Sentry attachments remain private to the maintainer's Sentry project; anything you add directly to a public GitHub issue is public.

Data and attribution

The technical event includes macOS, app and engine versions; bundled app, engine, lobby and infrastructure commits; and available match context: game ID, map, game/mod name and version, last-observed frame and game seconds. The game ID identifies a match, not a machine, but may let someone correlate the report with public match/player information. Game context is written locally about once per second and matched to the incident; absent or stale context is omitted. An error's logged frame is also included when available. Last-observed game time is an estimate, not a claim of the exact faulting instruction's game frame.

The base event sends no account name, email, persistent machine identifier, raw Apple report, chat or full log. Selected attachments are the explicit exception. Events use an anonymized IP value to prevent Sentry's automatic location enrichment; Sentry still receives the network connection's IP address. There is no promise of complete anonymity, particularly with attachments or a public GitHub issue.

Automatic attribution is conservative: the first relevant crash frame must implicate identifiable macOS bridge code, the launcher or bundled translation libraries. General engine/gameplay/network errors and unrelated upstream Lua errors are excluded. Expected fallbacks such as unsupported HDR are excluded. This is a heuristic, not a statistically measured confidence percentage. A manually submitted bug is an explicit user report and need not pass the automatic classifier.

Uploads are deduplicated and limited to ten attempts per day. Old crash reports are limited to seven days. Some frames may remain unsymbolicated. Reporting requires the launcher to remain running or the app to be reopened. See Reporting Bugs for reports with reproduction steps.

Clone this wiki locally