You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-8Lines changed: 7 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,22 +14,24 @@ An event is fired when a player reaches this, regardless of whether `kick_on_max
14
14
15
15
See more about events and settings below.
16
16
17
-
**Note**: all the functions and events listed below are serverside unless otherwise stated.
18
-
19
17
20
18
21
19
## Getting Started
22
20
23
-
Download the repo and extract it to your server resources folder and start it, like you would with any other resource.
21
+
If you're experienced, you can integrate this resource directly into your own, however for basic usage it's best to keep things separate and use exports as explained below.
24
22
25
-
23
+
Download the repo and extract the contents to a folder in your server's resources, like you would with any other resource.
24
+
25
+
For this example we'll assume you named the resource `conguard`. To create a ConGuard instance, use the following export in **your own resource**:
26
26
27
-
For this example we'll assume your resource folder is called `conguard`. To create a ConGuard instance, use the following:
27
+
### Note: all functions/exports and events listed here are serverside only, unless otherwise stated
**Note**: If you want to create a global instance (running in all dimensions) then pass `-1` as the dimension. If an instance already exists in a specific dimension, it will take precedence over the global instance.
34
+
33
35
34
36
35
37
You can turn a ConGuard instance on or off, temporarily:
@@ -46,9 +48,6 @@ You can also destroy a ConGuard instance entirely by doing:
0 commit comments