EML Docs

CrashReports

CrashReports sends crash reports about the launcher to EML AdminTool.

Warning

CrashReports requires an EML AdminTool instance. It is not available in agnostic mode.

Note

To be compliant with the GDPR, never send crash reports without the user’s consent. You should ask the user for consent before sending any crash reports, and only send crash reports if the user has given their consent. This class automatically hides the user’s username and token from the crash report, so that it does not send any personally identifiable information.

import { CrashReports } from 'eml-lib'

sendCrashReports()

async function sendCrashReports() {
  const crashReports = new CrashReports('https://at.myserver.com')

  launcher.on('launch_crash', async (crashData) => { // `launcher` is an instance of the `Launcher` class
    try {
      await crashReports.send(launcher, crashData)
    } catch (err) {
      console.error('Failed to send crash report:', err)
    }
  })
}

Before sending any stats, the class performs a handshake with the EML AdminTool instance. To prevent abuse, the server may reject the request if it is sent too frequently. The EML AdminTool allows a maximum of 1 handshake per 10 minutes and 10 stats events per 10 minutes. If the limit is exceeded, the server will respond with a 429 Too Many Requests error.

Constructor

ParameterTypeDescriptionRequired?
urlstringThe URL of your EML AdminTool website.Yes

send() method

Send the crash report to EML AdminTool. This method should be called when the game crashes, and only if the user has given their consent to send crash reports. This method will read the latest.log file and the latest crash report file, sanitize them, and send them to the server.

ParameterTypeDescriptionRequired?
launcherLauncherThe Launcher instance used to launch the game.Yes
crashDataCrashDataThe crash data emited by the launch_crash event of the Launcher.Yes

Returns: Promise<void>

Throws: FETCH_ERROR — If the request to the server fails. • UNKNOWN_ERROR — In case of an unknown error.