3.0.0

README.md

@@ -1,42 +1,9 @@
 <p align="center"><img src="https://raw.githubusercontent.com/JujuAdams/Snitch/master/LOGO.png" style="display:block; margin:auto; width:300px"></p>
 
-<h1 align="center">Snitch 1.1.3</h1>
+<h1 align="center">Snitch 3.0.0</h1>
 
-<p align="center">Logging and crash handling system for GameMaker Studio 2.3.2 by <b>@jujuadams</b></p>
+<p align="center">Logging and crash handling system for GameMaker Studio 2022.9 by <b>@jujuadams</b></p>
 
 <p align="center"><a href="https://github.com/JujuAdams/Snitch/releases/">Download the .yymps</a></p>
 
-<p align="center">Chat about Snitch on the <a href="https://discord.gg/8krYCqr">Discord server</a></p>
-
-&nbsp;
-
-&nbsp;
-
-Snitch is a logging and crash handling tool that helps smooth the debugging process. Snitch allows you to capture crash information in a file on disk, as well as logging debug messages that the game creates. Additionally, the header for each log file contains a bunch of information about the player's machine as well as details for the build of your game that they're running. Putting all this information together will greatly improve your chances of fixing bugs, especially bugs that have been discovered in the wild by players.
-
-&nbsp;
-
-Snitch has only four functions:
-
-- `Snitch(value, ...)` outputs a debug message. If logging is turned on, these messages will be written to a file on disk. You'll probaby want to rename this function
-- `SnitchCrashCollect()` tries to read the crash dump from disk, and returns it as a struct if any crash dump is found
-- `SnitchLogSet(state)` turns logging to file on and off
-- `SnitchLogGet()` returns whether logging to file is on or off
-
-Snitch's behaviour can be adjusted by editing macros found in `__SnitchConfig()`. This function is commented with details on what each macro controls.
-
-&nbsp;
-
-### Logging
-
-Logging can be set up to store messages from only a specific function - `Snitch()` - or to capture debug messages from all calls to `show_debug_message()`. Logging can be toggled with a function call, can be set to always be on (via `SNITCH_LOG_DEFAULT`), or can be activated when the game is booted using an execution parameter (`-log`). This last feature is especially useful for production builds as it allows logging to be activated by players. Because behaviour is controlled largely with macros, Snitch can be controlled by using GameMaker's configurations.
-
-**Please note** that because logging involves file access, this can incur a non-trivial performance penalty in your game. It is recommended that you do not release production builds with logging forced on.
-
-&nbsp;
-
-### Crash Dumps
-
-Snitch will save a small file to disk whenever a crash happens - this is just the exception struct JSON encoded. When `SnitchCrashCollect()` is called, Snitch will scan for the crash dump file, attempt to decode it, delete the crash dump, then return the exception struct that was saved to the file (as a struct). You can then do whatever you want with that! A dedicated programmer might send that crash data off to a server (such as [sentry.io](https://sentry.io/)) automatically for later analysis.
-
-Additionally, Snitch can be set up to prompt the user to copy the exception data to their clipboard. This is especially helpful for crash reporting as it reduces the friction for players to report issues with your game.
+<p align="center">Chat about Snitch on the <a href="https://discord.gg/8krYCqr">Discord server</a></p>

scripts/__SnitchSystem/__SnitchSystem.gml

@@ -10,7 +10,7 @@
 
 
 #macro SNITCH_VERSION               "3.0.0"
-#macro SNITCH_DATE                  "2021-12-30"
+#macro SNITCH_DATE                  "2022-10-17"
 #macro SNITCH_SHARED_EVENT_PAYLOAD  global.__snitchSharedEventPayload
 #macro SNITCH_OS_NAME               global.__snitchOSName
 #macro SNITCH_OS_VERSION            global.__snitchOSVersion