Configuration

The configuration file for Vulcan Punishments+ are stored under /plugins/Vulcan-PunishmentsPlus/.

The configuration is pretty self-explanatory. You can edit the files and then save them. Once you've configured them to your liking, run the command /vulcanpunishmentsplus reload in game or through console to reload the config and language files.

For reference, the default configuration file is:

# Vulcan Punishments+ | Plugin Config
# Made by Ray_y
# Need help? Visit the Support Discord at: https://discord.gg/EshbnCjhfc
# THE SUPPORT LINK ABOVE IS NOT FOR VULCAN
# DO NOT ASK FOR HELP WITH VULCAN IN RAY'S SUPPORT SERVER.
# You must have Vulcan installed on your server for the plugin to work. The plugin will disable itself if Vulcan is not detected.

# --- Options ---
plugin-prefix: "&7[Vulcan Punishments&c+&7]"
# Colour codes are allowed in the plugin prefix.

check-for-updates: true
# Automatically check if a plugin update is available

# --- Messages ---
# All messages accept colour codes.
message-no-permission: "&cYou do not have permission to execute that command!"
# Will send when a player without permissions executes a command.
# Colour codes are allowed

message-reload: "&fReloading Plugin Config!"
# Will send when a player runs /vulcanpunishmentsplus reload
# Colour codes are allowed

message-reload-success: "&fReloaded!"
# Will send if a config reload is successful
# Colour codes are allowed

message-update-available: "%prefix% &7There is an update of VPP available to download. Current Version: %current_version%. Latest Version: %latest_version%"
# Message sent if there is an available update to download (if check-for-updates is true).
# Colour codes are allowed
# Placeholders:
# %prefix% - Plugin prefix (config option plugin-prefix).
# %current_version% - Plugin's Current Version.
# %latest_version% - Latest Plugin Version
# %link% - Link to download the latest version

message-cleared-punishments: "&fYou have reset &7%player%&f's Vulcan punishment Level."
# Message sent when /reset-vulcanpunishments <player> is executed.
# Placeholders:
# %player% - Player in argument 1 (player)

message-invalid-player: "&fThat player is not in the database."
# Message that is sent when a player tries to reset the punishment level of someone who isn't in the database.

message-unknown-argument: "&cUnknown Argument"
# Message that is sent when you execute a command (from the plugin) that does not recognise an argument

# --- Punishments ---
# When editing punishment commands, don't include the /.
# Note: This plugin does NOT add punishment commands. That is up to you to have punishment commands.
# This plugin only lets you have different punishments depending on how many times vulcan has punished them.
# DO NOT EDIT THE db.yml FILE. If you need to reset someone's punishment level, use /reset-vulcanpunishments <player>
# Add more punishment levels by using the either single command or multi command format (Check Docs) and naming it "punishment-x" with x being -
# - the next punishment. For example; punishment-2, punishment-3, etc.
punishment-1:
  command: warn %player% Cheat Detection

How to configure

The # --- Punishments --- section allows you to define the specific commands executed in replacement of Vulcan kicking the player. You can execute single commands, multiple commands, or log an event without taking action.

Multi-Commands

If you wish to trigger multiple commands simultaneously on the same punishment, you can do this by changing the command: section under the punishment to commands: and use a numbered list.

Example:

punishment-1:
  commands:
    1: command to execute
    2: another command to execute
punishment-2:
  command: example command

Silent Monitor

You can also silently monitor a player. For instance if you don't want a command to be executed, but still log it as them being flagged, set the command: setting to ignore.

This will not execute a command, however it will still add their punishment to the database.

Example:

punishment-1:
  command: ignore
punishment-2:
  command: kick %player%

Placeholders

You can use the %player% placeholder any time within the punishment command sections. This will replace the %player% variable with the player that is in question.

Databases

By default, the configured database is set to yml. However, this can be changed to use SQLite instead. Please read the Database Documentation for more information.

Vulcan Punishments+ does not add any new punishment commands.
The commands mentioned within the default config are for example purposes only.
You will need an external punishment plugin or use commands your server already has.