Skip to content

Commit 203aad9

Browse files
authored
Create README.md
1 parent 8d44e12 commit 203aad9

File tree

1 file changed

+63
-0
lines changed

1 file changed

+63
-0
lines changed

README.md

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
<br>
2+
<img align='center' src='https://cdn.discordapp.com/attachments/882573745913479228/1009950600227729459/unknown.png?size=4096'>
3+
4+
<h4 align='center'>Prevents cheaters from exploiting server events</h4>
5+
<p align='center'><b><a href='https://github.com/xariesnull'>xaries</a> - <a href='https://github.com/tekkenkkk'>tekken</a></b></p>
6+
7+
<h1>Important Notice</h1>
8+
If you rename a script, it will no longer work properly
9+
10+
<h1>Important Notice</h1>
11+
If you rename a script, it will no longer work properly
12+
13+
<h1>Features</h1>
14+
<ul>
15+
<li>Player bans for all identifiers and `Player Tokens`</li>
16+
<li>Discord Webhook logs when a player tries to trigger an event with no arguments / or with an invalid token</li>
17+
<li>Using State Bags for storing data</li>
18+
<li>Fully standalone</li>
19+
<li>Well optimized ~0.00ms</li>
20+
</ul>
21+
22+
<h1>Usage</h1>
23+
24+
<h2>Client</h2>
25+
26+
```lua
27+
exports["secured"]:call(eventName, [, ...])
28+
```
29+
30+
<h4>Required arguments</h4>
31+
eventName: A string representing the event name to call on the server.
32+
33+
<h4>Optional arguments</h4>
34+
...: Any additional data that should be passed along.
35+
36+
<h3>Example</h3>
37+
38+
```lua
39+
exports["secured"]:call("Test", "test1")
40+
```
41+
42+
<h2>Server</h2>
43+
44+
```lua
45+
exports["secured"]:handler(eventName, callback)
46+
```
47+
48+
<h4>Required arguments</h4>
49+
<b>eventName</b>: The name of the event you want to listen to.
50+
<br>
51+
<b>callback</b>: The function to run when the event is called.
52+
53+
<h3>Example</h3>
54+
55+
```lua
56+
exports["secured"]:handler("Test", function(arg)
57+
local player = source
58+
if arg ~= "test" then
59+
return false
60+
end
61+
return true
62+
end)
63+
```

0 commit comments

Comments
 (0)