README.txt 939 B

12345678910111213141516171819202122232425262728293031323334353637383940414243444546
  1. Advanced Ban [advancedban]
  2. ===========
  3. This mod will ban player based on its username, not its IP address.
  4. # License
  5. MIT License (see LICENSE file)
  6. # Usage
  7. ## Parameter
  8. - FILE_NAME: name of the file that contains list of banned player
  9. - BAN_MESSAGE: a message that will be sent to the banned player each time it connects
  10. ## Chat commands
  11. ### Check ban for a player
  12. /abancheck <player name>
  13. ### Simple ban/unban
  14. (requires "ban" privilege)
  15. /aban <player name>
  16. /unaban <player name>
  17. ### Ban with kick
  18. (requires "ban" and "kick" privileges)
  19. /abankick <player name>
  20. ### Ban/unban with its IP
  21. (requires "ban" privilege)
  22. /aban+ <player name>
  23. /unban+ <player name>
  24. ## API
  25. advancedban.is_banned(player_name)
  26. -- true if the player is banned, false if not
  27. advancedban.ban(player_name)
  28. -- true if OK, false if the player has been banned before
  29. advancedban.unban(player_name)
  30. -- true if OK, false if the player hasn't been banned before