https://github.com/ecorte/ecortewhitelist
A MariaDB whitelist plugin.
https://github.com/ecorte/ecortewhitelist
minecraft paper paper-plugin papermc papermc-plugin plugin
Last synced: 8 months ago
JSON representation
A MariaDB whitelist plugin.
- Host: GitHub
- URL: https://github.com/ecorte/ecortewhitelist
- Owner: Ecorte
- License: mit
- Created: 2024-12-14T21:35:34.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-12-24T20:31:06.000Z (10 months ago)
- Last Synced: 2025-02-19T12:15:04.046Z (8 months ago)
- Topics: minecraft, paper, paper-plugin, papermc, papermc-plugin, plugin
- Language: Java
- Homepage:
- Size: 60.5 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# EcorteWhitelist
A simple MariaDB whitelist plugin for PaperMC servers.
## Features
- Whitelist users by name (saved with UUIDs)
- Saved in a MariaDB database (useful for multiple servers)
- LuckPerms Contexts support
- Allow players to join even if they are not whitelisted (to use LuckPerms Contexts)
- Permissions for all subcommands
## Dependencies
- [CommandAPI](https://github.com/CommandAPI/CommandAPI)
- [LuckPerms](https://luckperms.net/)
## Installation
1. Download the latest release of [CommandAPI](https://github.com/CommandAPI/CommandAPI) from the [releases page](https://github.com/CommandAPI/CommandAPI/releases).
2. Download the latest release of [LuckPerms](https://luckperms.net/) from the [downloads page](https://luckperms.net/download).
3. Download the latest release from the [releases page](https://github.com/Ecorte/EcorteWhitelist/releases).
4. Place the downloaded files in the `plugins` folder of your PaperMC server.
5. Configure the plugin in `plugins/EcorteWhitelist/config.yml`.
6. Start your server.
## Usage
### Whitelist
Whitelist a player by name:
```
/ewl add
```
Permission: `ecortewhitelist.whitelist.add`
Remove a player from the whitelist:
```
/ewl remove
```
Permission: `ecortewhitelist.whitelist.remove`
Get the whitelist status of a player:
```
/ewl status
```
Permission: `ecortewhitelist.whitelist.status`
### Permissions
The plugin add the following permissions:
- `ecortewhitelist.whitelist.bypass`: Allow to bypass the whitelist
### LuckPerms Contexts
This plugin adds the `iswhitelisted` context to LuckPerms. This context is true if the player is whitelisted, false otherwise.