Create README.md

opcode86 · Feb 7, 2022 · 8ddb2d2 · 8ddb2d2
1 parent e359aee
commit 8ddb2d2
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,12 @@
+# Unset Cheater
+
+### Purpose
+Unsets players as cheaters that are globally banned from your GOKZ server.
+
+### Usage
+Add to your plugins folder and run ``sm plugins load unsetcheater``. If you want all players joining your server to be unset as cheaters then run the plugin without a config file. If you however only want a few select players to count as non-cheaters then you need to create ``configs/unsetcheaters.cfg`` and add their SteamID's to it like shown below.
+
+```
+STEAM_1:0:12345
+STEAM_0:1:76582134
+```