|
1 |
| - |
| 1 | +<p align="center"> |
| 2 | + <a href="https://banmanagement.com"> |
| 3 | + <img src="https://banmanagement.com/images/banmanager-icon.png" height="128"> |
| 4 | + <h1 align="center">BanManager</h1> |
| 5 | + </a> |
| 6 | +</p> |
2 | 7 |
|
3 |
| -[](https://travis-ci.org/BanManagement/BanManager) |
4 |
| -============== |
5 |
| -The Java based plugin for Bukkit/Sponge released under the Creative Commons Attribution-NonCommercial-ShareAlike 2.0 UK: England & Wales |
| 8 | +<h3 align="center"> |
| 9 | + The defacto plugin for Minecraft to manage punishments and moderate more effectively |
| 10 | +</h3> |
6 | 11 |
|
7 |
| -Further information available at https://banmanagement.com/ |
| 12 | +<p align="center"> |
| 13 | + <strong> |
| 14 | + <a href="https://banmanagement.com">Website</a> |
| 15 | + | |
| 16 | + <a href="https://banmanagement.com/docs/webui/install">Docs</a> |
| 17 | + | |
| 18 | + <a href="https://demo.banmanagement.com">Demo</a> |
| 19 | + </strong> |
| 20 | +</p> |
| 21 | +<p align="center"> |
| 22 | + <a aria-label="Tests status" href="https://github.com/BanManagement/BanManager/actions/workflows/build.yml"> |
| 23 | + <img alt="" src="https://img.shields.io/github/workflow/status/BanManagement/BanManager/Java%20CI?label=Tests&style=for-the-badge&labelColor=000000"> |
| 24 | + </a> |
| 25 | + <a aria-label="Join the community on Discord" href="https://discord.gg/59bsgZB"> |
| 26 | + <img alt="" src="https://img.shields.io/discord/664808009393766401?label=Support&style=for-the-badge&labelColor=000000&color=7289da"> |
| 27 | + </a> |
| 28 | +</p> |
| 29 | + |
| 30 | +## Overview |
| 31 | +- **Robust.** Used and battle tested by some of the largest Minecraft servers |
| 32 | +- **Maintained.** Actively developed since 2012, 10+ years |
| 33 | +- **Cross platform.** Supports Bukkit, Spigot, Bungeecord & Sponge |
| 34 | +- **Feature rich.** An advanced punishment system, reports, appeals, network friendly and [website compatible](https://github.com/BanManagement/BanManager-WebUI) |
| 35 | +- **Flexible.** [Fully customisable](https://banmanagement.com/docs/banmanager/configuration) with [extensive player permissions](https://banmanagement.com/docs/banmanager/permissions) |
| 36 | + |
| 37 | +To learn more about configuration, usage and features of BanManager, take a look at [the website](https://banmanagement.com/docs/banmanager/configuration) or view [the website demo](https://demo.banmanagement.com). |
| 38 | + |
| 39 | +## Requirements |
| 40 | +- Java 8+ |
| 41 | +- CraftBukkit/Spigot/Paper, BungeeCord or Sponge for Minecraft 1.7.2+ |
| 42 | +- Optionally [MySQL or MariaDB](https://banmanagement.com/docs/banmanager/install#setup-shared-database-optional) |
| 43 | + |
| 44 | +## Installation |
| 45 | +- Download from https://banmanagement.com/download |
| 46 | +- Copy jar to plugins (Spigot/BungeeCord) or mods (Sponge) folder |
| 47 | +- For further instructions on how to support multiple servers [click here](https://banmanagement.com/docs/banmanager/install-network) |
| 48 | + |
| 49 | +## Commands |
| 50 | +View [full list here](https://banmanagement.com/docs/banmanager/commands) |
| 51 | +- `/ban <player> <reason>` - Permanently ban a player, requires permission, requires permission `bm.command.ban` |
| 52 | +- `/tempban <player> <timeDiff> <reason>` - Temporarily ban a player, requires permission `bm.command.tempban` |
| 53 | +- `/unban <player> [reason]` - Unban a player, requires permission `bm.command.unban` |
| 54 | +- `/mute <player> <reason>` - Permanently mute a player, requires permission `bm.command.mute` |
| 55 | +- `/tempmute <player> <timeDiff> <reason>` - Temporarily mute a player, requires permission `bm.command.tempmute` |
| 56 | +- `/unmute <player> [reason]` - Unmute a player, requires permission `bm.command.unmute` |
| 57 | +- `/banip <player || ip> <reason>` - Permanently ban an ip address or ip of a player, requires permission `bm.command.banip` |
| 58 | +- `/tempbanip <player || ip> <timeDiff> <reason>` - Temporarily ban an ip address or ip of a player, requires permission `bm.command.tempbanip` |
| 59 | +- `/unbanip <ip> [reason]` - Unban an ip address, requires permission `bm.command.unbanip` |
| 60 | +- `/muteip <player || ip> <reason>` - Permanently mute an ip address or ip of a player, requires permission `bm.command.muteip` |
| 61 | +- `/tempmuteip <player || ip> <timeDiff> <reason>` - Temporarily mute an ip address or ip of a player, requires permission `bm.command.tempmuteip` |
| 62 | +- `/unmuteip <ip> [reason]` - Unmute an ip address, requires permission `bm.command.unmuteip` |
| 63 | +- `/baniprange <cidr || wildcard> <reason>` - Permanently ban a cidr or wildcard ip range, e.g. 192.168.0.1/16 or 192.168.*.*, requires permission `bm.command.baniprange` |
| 64 | +- `/tempbaniprange <cidr || wildcard> <timeDiff> <reason>` - Temporarily ban a cidr or wildcard ip range, requires permission `bm.command.tempbaniprange` |
| 65 | +- `/unbaniprange <cidr || wildcard || player>` - Unban an ip range, requires permission `bm.command.unbaniprange` |
| 66 | +- `/warn <player> <reason>` - Warn a player, requires permission `bm.command.warn` |
| 67 | +- `/tempwarn <player> <timeDiff> <reason>` - Temporarily warn a player, requires permission `bm.command.tempwarn` |
| 68 | +- `/dwarn <player>` - Delete the last warning a player received, requires permission `bm.command.dwarn` |
| 69 | +- `/addnote <player> <message>` - Add a note against a player, requires permission `bm.command.addnote` |
| 70 | +- `/notes [player]` - View notes of all online players or a particular player, requires permission `bm.command.notes` |
| 71 | +- `/kick <player> <reason>` - Kick a player from the server, requires permission `bm.command.kick` |
| 72 | +- `/nlkick <player> <reason>` - Kick a player from the server without logging the kick if kick logging enabled, requires permission `bm.command.nlkick` |
| 73 | +- `/bminfo [player]` - Look up information of a player, requires permission `bm.command.bminfo` |
| 74 | +- `/bmimport`, Check the [migration guides](https://banmanagement.com/docs/banmanager/migrations) for more information, requires permission `bm.command.import` |
| 75 | +- `/bmexport <players || ips>` - Export bans to vanilla format, requires permission `bm.command.export` |
| 76 | +- `/bmreload` - Reload plugin configuration and messages (excludes database connection info), requires permission `bm.command.reload` |
| 77 | +- `/banlist [players || ipranges || ips]` - List all bans stored in memory, requires permission `bm.command.banlist` |
| 78 | +- `/bmsync <local || external>` - Force the server to syncronise with the database, requires permission `bm.command.sync` |
| 79 | +- `/bmclear <player> [banrecords || baniprecords || kicks || muterecords || notes || warnings]` - Clear all records of a player or specify a type, requires permission `bm.command.clear` |
| 80 | +- `/bmdelete <banrecords || kicks || muterecords || notes || warnings> <ids>` - Delete specific records for a player based on ids from /bminfo, requires permission `bm.command.delete` |
| 81 | +- `/bmactivity <timeDiff> [player]` - View recent activity of staff, or a particular player, requires permission `bm.command.bmactivity` |
| 82 | +- `/alts <player || ip>` - List players which have the same ip address, requires permission `bm.command.alts` |
| 83 | +- `/report <player> <reason>` - Report a player for rule breaking, logs their location and the actors location, as well as other data, requires permission `bm.command.report` |
| 84 | +- `/reports` - Report management, executes list by default, requires permission `bm.command.reports` |
| 85 | +- `/reports assign <ids> [player]` - Assign a report to a player, if none given assigns to self, requires permission `bm.command.reports.assign` |
| 86 | +- `/reports close <ids> [/command || comment]` - Marks a report as closed, with an optional comment or command, requires permission `bm.command.reports.close` |
| 87 | +- `/reports list [page] [state]` - Lists reports, requires permission `bm.command.reports.list` |
| 88 | +- `/reports tp <id>` - Teleports you to where the report was created, requires permission `bm.command.reports.tp` |
| 89 | +- `/reports unassign <ids>` - Unassigns reports from a player, requires permission `bm.command.reports.unassign` |
| 90 | +- `/bmrollback <player> <timeDiff> [types]` - Allows rolling back malicious actions by a staff member, requires permission `bm.command.bmrollback` |
| 91 | +- `/banname <name> <reason>` - Ban any players with the name specified, requires permission `bm.command.banname` |
| 92 | +- `/tempbanname <name> <timeDiff> <reason>` - Temporarily ban a name, requires permission `bm.command.tempbanname` |
| 93 | +- `/unbanname <name> [reason]` - Unban a name, requires permission `bm.command.unbanname` |
| 94 | +- `/bmutils <duplicates||missingplayers>` - Utility commands to aid with resolving issues, requires permission `bm.command.bmutils` |
| 95 | +- `/bmutils duplicates [UUID] [newName]` - Finds duplicate player names and allows manual updating of a player name, requires permission `bm.command.bmutils.duplicates` |
| 96 | +- `/bmutils missingplayers` - Finds missing player records associated to punishments and creates them, requires permission `bm.command.bmutils.missingplayers` |
| 97 | + |
| 98 | +## Permissions |
| 99 | +View [full list here](https://banmanagement.com/docs/banmanager/permissions) |
| 100 | + |
| 101 | +## Development |
| 102 | +``` |
| 103 | +git clone git@github.com:BanManagement/BanManager.git |
| 104 | +``` |
| 105 | + |
| 106 | +## Contributing |
| 107 | +If you'd like to contribute, please fork the repository and use a feature branch. Pull requests are warmly welcome. |
| 108 | + |
| 109 | +## Help / Bug / Feature Request |
| 110 | +If you have found a bug please [open an issue](https://github.com/BanManagement/BanManager/issues/new) with as much detail as possible, including relevant logs and screenshots where applicable |
| 111 | + |
| 112 | +Have an idea for a new feature? Feel free to [open an issue](https://github.com/BanManagement/BanManager/issues/new) or [join us on Discord](https://discord.gg/59bsgZB) to chat |
| 113 | + |
| 114 | +## License |
| 115 | +Free to use under the [Creative Commons Attribution-NonCommercial-ShareAlike 2.0 UK: England & Wales](LICENCE) |
0 commit comments