docs/symbol_server.md

   1 # OpenTTD's Symbol Server
   2
   3 For all official releases, OpenTTD collects the Breakpad Symbols (SYM-files) and Microsoft's Symbols (PDB-files), and publishes them on our own Symbol Server (https://symbols.openttd.org).
   4
   5 These symbol files are needed to analyze `crash.dmp` files as attached to issues by users.
   6 A `crash.dmp` is created on Windows, Linux, and MacOS when a crash happens.
   7 This combined with the `crash.log` should give a pretty good indication what was going on at the moment the game crashed.
   8
   9 ## Analyzing a crash.dmp
  10
  11 ### MSVC
  12
  13 In MSVC you can add the above URL as Symbol Server (and please enable MSVC's for all other libraries), allowing you to analyze `crash.dmp`.
  14
  15 Now simply open up the `crash.dmp`, and start debugging.
  16
  17 ### All other platforms
  18
  19 The best tool to use is `minidump-stackwalk` as published in the Rust's cargo index:
  20
  21 ```bash
  22 cargo install --locked minidump-stackwalk
  23 ```
  24
  25 For how to install Rust, please see [here](https://doc.rust-lang.org/cargo/getting-started/installation.html).
  26
  27 Now run the tool like:
  28
  29 ```bash
  30 minidump-stackwalk <crash.dmp> --symbols-url https://symbols.openttd.org
  31 ```
  32
  33 For convenience, the above Symbol Server also check with Mozilla's Symbol Server in case any other library but OpenTTD is requested.
  34 This means files like `libc`, `kernel32.dll`, etc are all available on the above mentioned Symbol Server.