CrashCatch

💥 A modern, single-header crash reporting library for C++ on Windows.

---

🚀 What is CrashCatch?

CrashCatch is a zero-dependency, header-only crash reporting library for C++ applications. It captures crashes, generates .dmp and .txt files, includes stack traces, and can show a GUI-friendly message box — all from a single include.

---

⚡ Quick Start

Zero Config (Auto-init)

#define CRASHCATCH_AUTO_INIT
#include "CrashCatch.hpp"

int main() {
    int* ptr = nullptr;
    *ptr = 42; // simulated crash
}

One-Liner Setup

#include "CrashCatch.hpp"

int main() {
    CrashCatch::enable();
    int* ptr = nullptr;
    *ptr = 42;
}

Full Config Example

#include "CrashCatch.hpp"

int main() {
    CrashCatch::Config config;
    config.appVersion = "1.0.0";
    config.buildConfig = "Release";
    config.additionalNotes = "Test build";
    config.showCrashDialog = true;
    config.onCrash = [] {
        std::cout << "Cleaning up before crash...\n";
    };

    CrashCatch::initialize(config);

    int* ptr = nullptr;
    *ptr = 42;
}

---

📦 Installing with CMake

mkdir build && cd build
cmake .. -DCMAKE_INSTALL_PREFIX=./install
cmake --build . --target install

Then in another project:

find_package(CrashCatch REQUIRED)
target_link_libraries(MyApp PRIVATE CrashCatch::CrashCatch)

---

🧪 Examples

Explore working examples in the GitHub repo: - ZeroConfig - OneLiner - FullConfig - ThreadCrash - DivideByZero

View Examples Folder

---

📸 Screenshots

---

🛠 Features

• ✅ Header-only — drop-in, no dependencies
• ✅ .dmp and .txt crash logs
• ✅ Symbol resolution for stack trace
• ✅ GUI message box support
• ✅ CMake + CI friendly
• 🔜 Linux/macOS and remote reporting coming soon

---

📄 License

MIT License — created and maintained by Keith Pottratz
GitHub Repo

Created by Keith Pottratz
MIT Licensed