error-popper/README.md

10 lines
635 B
Markdown
Raw Permalink Normal View History

# Error Popper
This is a small library meant to handle the tracking of all errors on the server, subsequently sending them as formatted discord webhook messages.
It offers a few helper methods to specify which webhook URL, which will be converted into a proxy mask, as well as any custom fields you would like.
2025-04-26 16:03:34 +00:00
2025-04-26 16:17:40 +00:00
## CustomFields
The add chainable method allows you to specify custom fields, the value of which can either be a static value or a function which will be called upon each error being prepared for messaging.
2025-04-26 16:03:34 +00:00
2025-04-26 16:17:40 +00:00
## Example
You can find an example file inside of src/ServerScripts/Example.server.lua for how to use the library.