Skip to content

A game crash reporting service to help mod creators and players alike

License

Notifications You must be signed in to change notification settings

ezmode-games/ctd

CTD - Crash To Desktop Reporter

Automatic crash reporting for modded games. Captures crash context and helps identify patterns across users.

Hosted: ctd.ezmode.games API Docs: OpenAPI 3.1 License: AGPL-3.0

Supported Games

Game Plugin Status Version Download
Cyberpunk 2077 RED4ext Beta v0.1.4 v0.1.4
Elden Ring UE4SS Alpha v0.1.4 v0.1.4
Fallout 3 FOSE Beta v0.1.4 v0.1.4
Fallout 4 F4SE Beta v0.1.4 v0.1.4
Fallout: New Vegas NVSE Beta v0.1.4 v0.1.4
Oblivion Remastered UE4SS Alpha v0.1.4 v0.1.4
The Elder Scrolls V: Skyrim SKSE64 Beta v0.1.4 v0.1.4

What It Captures

  • Stack traces with module offsets
  • Resolved function names (when PDB available)
  • Load order at crash time
  • Mod fingerprints (file hashes)
  • Crash patterns across users

Installation

Download from Releases or Nexus Mods.

Extract to your game's mod directory or install via Vortex/MO2.

For Mod Creators

CTD helps you understand crashes affecting your users:

  • Crash visibility - See reports where your mod is in the load order
  • Pattern detection - Identify common crash signatures across users
  • Correlation analysis - Find which mod combinations cause issues
  • Export data - CSV export for your own analysis

For technical details on how CTD works internally, see Architecture.

Providing Debug Symbols

Include your .pdb file alongside your DLL for resolved stack traces:

Data/SKSE/Plugins/
  MyMod.dll
  MyMod.pdb      <- Users get function names in crash reports

Building

Cargo Mods (Cyberpunk)

cargo build --release -p ctd-cyberpunk

CMake Mods (Skyrim, Fallout 4)

.\scripts\build-mod.ps1 -Mod skyrim
.\scripts\build-mod.ps1 -Mod fallout4

Packaging

.\scripts\package-mod.ps1 -Mod skyrim -Version 0.1.2

Self-Hosting

cd api
pnpm install
pnpm dev

API Endpoints

Endpoint Description
POST /crashes Submit a crash report
GET /crashes/{id} Get crash report details
POST /api-keys Create an API key
GET /api-keys List your API keys
GET /setup?key=<api_key> Download ctd.toml config
GET /patterns List crash patterns
GET /patterns/{id} Pattern details with mod correlations
GET /calibration/metrics Prediction calibration metrics
GET /docs Interactive API documentation

User Setup

Users need a ctd.toml config file with your server URL and their API key.

Option 1: Download via API

curl "https://your-server.com/setup?key=ctd_yourkey" -o ctd.toml

Option 2: Manual creation

# ctd.toml
[api]
url = "https://your-server.com"
api_key = "ctd_yourkey"

Installation paths:

Game Path
Skyrim SE Data/SKSE/Plugins/ctd.toml
Fallout 4 Data/F4SE/Plugins/ctd.toml
Fallout 3 Data/FOSE/Plugins/ctd.toml
Fallout: New Vegas Data/NVSE/Plugins/ctd.toml
Cyberpunk 2077 red4ext/plugins/ctd/ctd.toml

See API Documentation for full endpoint details.

License

AGPL-3.0 - Modifications must be open sourced.

About

A game crash reporting service to help mod creators and players alike

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •