Skip to content

TISUnion/VelocityWhitelist

Folders and files

NameName
Last commit message
Last commit date

Latest commit

0e1ab96 · Feb 8, 2025

History

22 Commits
Aug 20, 2024
Oct 28, 2023
Feb 8, 2025
Oct 28, 2023
Oct 28, 2023
Aug 21, 2024
Aug 20, 2024
Feb 8, 2025
Oct 28, 2023
Oct 28, 2023
Oct 28, 2023

Repository files navigation

VelocityWhitelist

A simple whitelist plugin for velocity

Tested with velocity 3.3.0, java 17

Files

Config

File location: plugins/velocitywhitelist/config.yml

# If the whitelist functionality is enabled
enabled: true

# The way to identify a player
# Options: name, uuid. Default: name
identify_mode: name

# Message sent to those not whitelisted players
kick_message: You are not in the whitelist!

Whitelist

File location: plugins/velocitywhitelist/whitelist.yml

# Whitelisted player names. Used in "name" mode only
names:
- Fallen_Breath
- Steve

# Whitelisted player UUIDs. Used in "uuid" mode only
uuids:
- 85dbd009-69ed-3cc4-b6b6-ac1e6d07202e
- 5c93374f-2d55-3003-a4b5-ca885736fb0f

Additionally, items of the uuids list can be a map containing exactly 1 entry, indicating uuid to the player name. This is designed for easier identifying what the UUID belongs to

uuids:
- 85dbd009-69ed-3cc4-b6b6-ac1e6d07202e: Fallen_Breath
- 5c93374f-2d55-3003-a4b5-ca885736fb0f: Steve

Command

Require permission velocitywhitelist.command

/vwhitelist is an alias of /whitelist

  • /whitelist: Show plugin status
  • /whitelist add <value>: Add a player to the whitelist
  • /whitelist remove <value>: Remove a player from the whitelist
  • /whitelist list: List all whitelist players
  • /whitelist reload: Reload whitelist from whitelist file from the disk. Notes that config will not be reloaded

For player operation commands, <value> has different meaning depends on the identity mode:

  • name mode: <value> should be the name of the player
  • uuid mode: <value> should be the UUID of the player, or the name of the player. If it's a player name, and the player is connected to the proxy, the player's UUID will be used, otherwise it will try to fetch and use the player's online UUID from mojang API

TODO

  • UUID support

About

A simple whitelist plugin for velocity

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages