Extended Ban Mod for Minetest
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
sys4 1faa658651 Merge remote-tracking branch 'upstream/master' into nalc-1.2-dev 3 years ago
doc First commit. 9 years ago
importers Add `.luacheckrc` and fix warnings. 6 years ago
.luacheckrc Add `.luacheckrc` and fix warnings. 6 years ago
README.md Add /xban_cleanup command to purge unbanned entries (#20) 4 years ago
bower.json Add `bower.json`. 8 years ago
dbimport.lua Add `.luacheckrc` and fix warnings. 6 years ago
gui.lua Improve behavior of GUI search field 3 years ago
init.lua Merge branch 'master' of yunohost:minetest-mods/xban2 into nalc-1.2-dev 3 years ago
mod.conf Create mod.conf 6 years ago
serialize.lua Changed DB format from 2 space indent to tabs. 9 years ago


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.


Bans a player permanently.

Usage: /xban <player_or_ip> <reason>

Example: /xban Some reason.


Bans a player temporarily.

Usage: /xtempban <player_or_ip> <time> <reason>

The time parameter is a string in the format <count><unit> where <unit> is one of s for seconds, m for minutes, h for hours, D for days, W for weeks, M for months, or Y for years. If the unit is omitted, it is assumed to mean seconds. For example, 42s means 42 seconds, 1337m 1337 minutes, and so on. You can chain more than one such group and they will add up. For example, 1Y3M3D7h will ban for 1 year, 3 months, 3 days and 7 hours.

Example: /xtempban Joe 3600 Some reason.


Unbans a player.

Usage: /xunban <player_or_ip>

Example: /xunban Joe


Shows the ban record on chat.

Usage: /xban_record <player_or_ip>

This prints one ban entry per line, with the time the ban came into effect, the expiration time (if applicable), the reason, and the source of the ban. The record is printed to chat with one entry per line.

Example: /xban_record Joe


Manages the whitelist.

Usage: /xban_wl (add|del|get) <player_or_ip>

Whitelisted players are allowed on the server even if it's otherwise marked as banned. This is useful to only allow certain users from shared computers, for example.

The add subcommand adds the player to the whitelist. The del subcommand removes the player from the whitelist. The get subcommand checks if the player is in the whitelist, and prints the status to chat.

Example: /xban_record add Jane


Shows a form to consult the database interactively.

Usage: /xban_gui

Administrator commands

The following commands require the server privilege, so they are only available to server administrators.


Imports ban entries from other database formats.

Usage: /xban_dbi <importer>

The importer argument specifies from which database to import. These are the supported import plugins at the time of writing:

  • minetest: Import entries from Minetest's ban list (ipban.txt).
  • v1: Old format used by xban (players.iplist).
  • v2: Old format used by xban (players.iplist.v2).

Example: /xban_dbi minetest


Removes all non-banned entries from the xban db.

Usage: /xban_cleanup