diff --git a/README.md b/README.md new file mode 100644 index 0000000..90eed0d --- /dev/null +++ b/README.md @@ -0,0 +1,106 @@ + +# Extended Ban Mod for Minetest + +This mod attempts to be an improvement to Minetest's ban system. + +* It supports normal bans and temporary bans (from 60 seconds up to the end of + time, with 1 second granularity). +* Records and joins all accounts using the same IP address and several IP + addresses using the same name into a single record, and can ban/unban them as + a single user. +* Can ban offline players if you know their IP or username. +* Holds a record of bans for each user, so moderators and administrators can + consult it to know if a player is a repeat offender. +* Does not modify the default ban database in any way (`ipban.txt'). +* Has an API to ban and check the ban database to allows other mods to manage + users (for example, anticheat mods). + +## Chat commands + +The mod provides the following chat commands. All commands require the `ban` +privilege. + +### `xban` + +Bans a player permanently. + +**Usage:** `/xban ` + +**Example:** `/xban 127.0.0.1 Some reason.` + +### `xtempban` + +Bans a player temporarily. + +**Usage:** `/xtempban