-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
9ead4e8
commit 801c658
Showing
1 changed file
with
31 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,32 @@ | ||
# sentry-roblox | ||
An unofficial Roblox SDK for Sentry.io | ||
An unofficial Roblox SDK for [Sentry.io](http://sentry.io) | ||
|
||
## Getting Started | ||
There are two supported ways to get Sentry quickly up-and-running in your game: | ||
|
||
### Public Module Install | ||
This install has the benefit of auto-updating whenever we release bugfixes, security patches and even new features; all without having to update your game or pre-existing code. | ||
|
||
*Note:* This method cannot be used from a client script. To forward errors from the client, you must use another installation method. | ||
|
||
Create a server-sided script in your game, and paste the following contents: | ||
```lua | ||
local SentrySDK = require(11721929587) | ||
|
||
SentrySDK:Init({ | ||
DSN = "<DSN FROM YOUR SENTRY PROJECT>" | ||
}) | ||
``` | ||
|
||
### Static Install | ||
Head over to the [releases tab](http://github.com/devSparkle/sentry-roblox/releases) and download the prepared `.rbxm` file. Insert this file into your game and drag it wherever you'd like to keep your ModuleScripts. It must be parented somewhere that replicates to clients, such as `ReplicatedStorage`, if you intend to monitor client errors too. | ||
|
||
Then, require your script by calling its path: | ||
|
||
```lua | ||
local SentrySDK = require(game:GetService("ReplicatedStorage").SentrySDK) | ||
|
||
SentrySDK:Init({ | ||
DSN = "<DSN FROM YOUR SENTRY PROJECT>" | ||
}) | ||
``` |