summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README15
1 files changed, 15 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..62e942a
--- /dev/null
+++ b/README
@@ -0,0 +1,15 @@
+rkick: Restricted kick mod for Minetest
+=======================================
+
+Privs:
+rkick - Can kick players that do not have the rkick_immune priv
+rkick_immune - Cannot be kicked with /rkick
+
+Command (just the one):
+/rkick <player> - Kicks a player that does not have the rkick_immune priv (requires the rkick priv). The kick reason is fixed to "Kicked by %s", where "%s" is replaced by the name of the player that issued the command.
+
+Command Output:
+"ERROR: You don't exist. Go away!" - The player that issued the command does not exist. Should never happen.
+"ERROR: You did not specify a player, or the player you specified does not exist." - The player specified could not be found.
+"You cannot kick %s.", where "%s" is replaced by a name - The player that you attempted to kick has the rkick_immune priv.
+"Kicked %s", where "%s" is replaced by a name - The player specified was successfully kicked.