Configuration
After you've set the basic configuration you may now customize it.
Setup the Database
Setting up a database is important since it's used for temporary player informations and player statistics storage.
- Set
"H2"in yourdatabase-typefield in theconfig.ymlfile.
- Set
"MySQL"in yourdatabase-typefield in theconfig.ymlfile. - Set your
mysql-hostin theconfig.ymlfile, it'sIP:PORTformat. - Set your
mysql-database-namein theconfig.ymlfile, leaving it as default should be good. - Set your
mysql-usernameandmysql-passwordin theconfig.ymlfile.
Tip
It's recommended to choose MySQL as your database since it's much more stable and optimized.
Configuration Files
If you're interested in the default configuration files, you can copy them here:
config.yml
# /$$$$$$ /$$ /$$ /$$$$$$$$ /$$
# /$$__ $$| $$ | $$ | $$_____/ | $$
# | $$ \__/| $$ /$$$$$$ /$$ /$$ /$$$$$$$ /$$$$$$$| $$ /$$ /$$ /$$$$$$ /$$$$$$$ /$$$$$$ /$$$$$$$
# | $$ | $$ /$$__ $$| $$ | $$ /$$__ $$ /$$_____/| $$$$$| $$ /$$//$$__ $$| $$__ $$|_ $$_/ /$$_____/
# | $$ | $$| $$ \ $$| $$ | $$| $$ | $$| $$$$$$ | $$__/ \ $$/$$/| $$$$$$$$| $$ \ $$ | $$ | $$$$$$
# | $$ $$| $$| $$ | $$| $$ | $$| $$ | $$ \____ $$| $$ \ $$$/ | $$_____/| $$ | $$ | $$ /$$\____ $$
# | $$$$$$/| $$| $$$$$$/| $$$$$$/| $$$$$$$ /$$$$$$$/| $$$$$$$$\ $/ | $$$$$$$| $$ | $$ | $$$$//$$$$$$$/
# \______/ |__/ \______/ \______/ \_______/|_______/ |________/ \_/ \_______/|__/ |__/ \___/ |_______/
# CloudsEvents Config File
# Put here your license!
license: ""
# The server name for better proxy distinction.
server-name: ""
# Database Section
## Available Types: H2, MySQL (Recommended)
database-type: "H2"
## MySQL Section
mysql-host: "127.0.0.1:3306"
mysql-database-name: "CloudsEvents"
mysql-username: "root"
mysql-password: ""
# If this is set to true, every player with the permission "cloudsevents.updatealerts" will receive an alert about a new update upon joining.
update-alerts: true
# If this is set to true, the help message will display the required permission for every command that needs one.
help-commands-permissions: true
# Setup section.
setup:
# The location where players will spawn when setting up an event (X,Y,Z,Yaw,Pitch).
default_spawn_location: "0.5,60,0.5,0,0"
# If this is set to true, each event will have its exclusive chat. NOTE: This may interfere with some chat cooldown plugins.
world-exclusive-chat: false
# The message format for the exclusive chat.
# - %prefix% for the player prefix (LuckPerms | includes a space at the end);
# - %player% for the player name;
# - %message% for the message.
chat-format: "%prefix%&f%player% &7» &f%message%"
# The maximum number of players to appear in the leaderboard at the end of each event.
max-top-players: 5
# Items
## For materials use the latest Material API
items:
quit-event:
material: "COMPASS"
name: "&7&o(( &5Quit Event &7&o))"
# In seconds
delay: 3
snowball-colorparty:
material: "SNOWBALL"
name: "&dSnowball"
amount: 1
setup-pos1:
material: "DIAMOND_PICKAXE"
name: "&5Position 1"
setup-pos2:
material: "DIAMOND_AXE"
name: "&dPosition 2"
# Events section: [map name: event type]. Available event types: Color Party, Sumo FFA, Timer Spleef.
events:
cp_1: "Color Party"
# Don't change this or the plugin won't work correctly!
config-version: 2
messages.yml
# /$$$$$$ /$$ /$$ /$$$$$$$$ /$$
# /$$__ $$| $$ | $$ | $$_____/ | $$
# | $$ \__/| $$ /$$$$$$ /$$ /$$ /$$$$$$$ /$$$$$$$| $$ /$$ /$$ /$$$$$$ /$$$$$$$ /$$$$$$ /$$$$$$$
# | $$ | $$ /$$__ $$| $$ | $$ /$$__ $$ /$$_____/| $$$$$| $$ /$$//$$__ $$| $$__ $$|_ $$_/ /$$_____/
# | $$ | $$| $$ \ $$| $$ | $$| $$ | $$| $$$$$$ | $$__/ \ $$/$$/| $$$$$$$$| $$ \ $$ | $$ | $$$$$$
# | $$ $$| $$| $$ | $$| $$ | $$| $$ | $$ \____ $$| $$ \ $$$/ | $$_____/| $$ | $$ | $$ /$$\____ $$
# | $$$$$$/| $$| $$$$$$/| $$$$$$/| $$$$$$$ /$$$$$$$/| $$$$$$$$\ $/ | $$$$$$$| $$ | $$ | $$$$//$$$$$$$/
# \______/ |__/ \______/ \______/ \_______/|_______/ |________/ \_/ \_______/|__/ |__/ \___/ |_______/
# CloudsEvents Messages File
# The main prefix of the plugin, most of the messages will start with this prefix (leave a blank space at the end!).
prefix: "&5&lClouds&d&lEvents &7» "
# The colors of the help command.
main-command-primary-color: "&5"
main-command-secondary-color: "&d"
# The message that appears when the command executor doesn't have the permission to execute it
# - %prefix% for the plugin prefix, don't leave a space after it.
not-permission-command: "%prefix%&cYou don't have the permission to execute this command!"
# The message that appears when someone makes a mistake in a command (%usage% for the correct usage).
incorrect-usage: "&cIncorrect usage: %usage%"
# Config files reload successful message.
reload-message: "&fFiles &asuccessfully &freloaded!"
# The message that appears when the console tries to execute an only-player command.
no-console: "&cThis command is available only for players!"
# The message that appears in every command where there's a player to insert, if that player never joined this message gets sent.
# - %player% for the inserted player name.
not-existent-player: "&cCan't find any player named %player%. Please check if they have joined at least once."
# The message that appears when someone tries to start a map with an invalid event type.
incorrect-event-type: "&cThe current event type set for this map is invalid!"
# The message that appears when someone tries to start a non-existent map.
map-doesnt-exists-start: "&cThe map you're trying to start doesn't exists!"
# The message that appears when someone tries to stop a non-existent map.
map-doesnt-exists-stop: "&cThe map you're trying to stop doesn't exists!"
# The message that appears when someone tries to join a non-existent map.
map-doesnt-exists-join: "&cThe map you're trying to join doesn't exists!"
# The message that appears when someone tries to start a non-set up map.
map-is-not-setup-start: "&fThe map you're trying to start is not set up, entering setup..."
# The message that appears when someone tries to set up a map from the console.
cant-setup-console: "&cYou can't use the console to setup a map!"
# The message that appears when someone tries to start a map with an outdated map config.
mapconfig-outdated: "&cThe mapconfig.yml of the map you're trying to start is outdated. Please back it up, delete it, wait for the default one to be recreated, and then add any changes to your new mapconfig.yml."
# The message that appears when the map config is not correctly configured.
error-in-the-mapconfig: "&cThe mapconfig.yml is not correctly configured, please check the console for more details!"
# The message that appears when someone tries to stop a non-started map.
map-is-not-started: "&cThe map you're trying to stop is not started!"
# The message that appears when someone tries to host an event but there isn't any available map.
no-maps-available: "&cThere isn't a map available right now, please try again later."
# The message that appears when someone tries to load a world in a newer version.
# - %worldversion% for the world version;
# - %serverversion% for the server version.
new-world: "&cThe world you're trying to load is saved in a newer version (%worldversion%), please downgrade it to the server version (%serverversion%)."
# The message that appears to everyone when someone starts an event:
# - %prefix% for the plugin prefix, don't leave a space after it;
# - %player% for the player that started the event;
# - %event% for the event type.
event-started: "%prefix%&5%player% &fstarted a &d%event% &fevent!"
# The "Click here" message that appears when hovering the mouse on the precedent message.
event-started-click-message: "&5&lClick here to join!"
# The message that appears when someone tries to join a full event.
full-event: "&cThe event you're trying to join reached it's maximum player count."
# The message that appears when someone tries to join a new event in an event.
already-in-event: "&cYou can't join an event while you're already in one!"
# The message that appears when someone tries to join an event that already started.
already-started: "&cYou can't join an event that already started!"
# The message that appears when someone tries to do something without being in an event.
not-in-an-event: "&cYou are not in an event!"
# The message that appears when someone clicks the quit item.
## - %delay% for the click delay.
quit-click: "&fYou will be teleported in &d%delay% &fseconds."
# The message that appears when someone re-clicks the quit item.
quit-cancelled: "&fYou &dcancelled &fyour quit."
# The message that appears when the event's start is cancelled for the minimum players.
start-cancelled: "&cThe event is no longer starting because there are not enough players!"
# The message that appears when someone leave an event.
# - %player% for the player that started the event;
# - %event% for the event type.
event-left: "&fYou left the &d%event% &fhosted by &5%player%&f!"
# The message that appears when the host leave an event.
# - %player% for the player that started the event.
host-event-left: "&5%player% &fleft the event, event cancelled!"
# The message that appears when there are enough players to start the event.
# - %event% for the event type;
# - %time% for the start time.
event-start-in: "&5%event% &fstarting in &d%time% seconds&f."
# The title that appears when the event starts (leave empty for no title).
event-started-title: "&5GO!"
# The message that appears when the pvp gets enabled.
event-pvp-enabled: "&dThe PVP is now enabled!"
# The title that appears when the players die.
you-died: "&cYou Died!"
# The title that appears when the players win.
win: "&6&lVictory!"
# The title that appears to the other players when someone wins.
game-over: "&c&lGame Over!"
game-over-subtitle: "&5%player% &dwon&f!"
# The message that appears when a player dies in the void.
# - %player% for the player that died.
player-void: "&5%player% &ffell in the &dvoid&f!"
# The message that appears when a player leaves the already-started event.
# - %player% for the player that left the event.
player-quit: "&5%player% &fleft the &devent&f!"
# The message that appears when the event finishes.
thanks-for-participating: "&d&lCongratulations&f, and thank you for participating in this &5event&f!"
# The event's finish top first part.
# - %number% for the players' quantity.
top-start: "&dTop %number% &fof this &devent&f:"
# The event's finish top template.
# - %position% for the player's position;
# - %player% for the player's name.
top-template: " %position% &f• &d%player%"
# The position colors for the event's finish top (default for every other one).
top-number's-colors:
1: "&e&l"
2: "&7&l"
3: "&6&l"
default: "&5"
# The /host GUI name.
host-gui-name: "&d&lCloudsEvents • Host GUI"
# The Color Party block selection GUI name.
color-party-block-gui-name: "&d&lCloudsEvents • Block GUI"
# The Color Party PvP type selection GUI name.
color-party-pvp-type-gui-name: "&d&lCloudsEvents • PvP Type GUI"
# Setup section.
setup:
# The welcome and goodbye messages, divide wih ;; the title from the subtitle.
welcome: "&f&lWelcome!;;&fTo the &5&lClouds&d&lEvents &fsetup!"
goodbye: "&f&lThank You!;;&fAnd goodbye!"
# Section limits messages.
no-back: "&cYou can't go back because this is the first section of the setup!"
no-next: "&cYou can't proceed because this is the last section of the setup!"
# Errors
int: "&cPlease type the required number after the 2."
# All the mapConfig messages
spawn-location: "&fSet the location where players will spawn when they join an event."
spawn-cage: "&fSet the cage area using the provided items."
max-players: "&fSet the maximum number of players that can join the event. &o(%number%)"
min-players: "&fSet the minimum number of players to start the event. &o(%number%)"
start-time: "&fSet the seconds needed to start the event. &o(%number%)"
game-spawn-location: "&fSet the location where players will spawn when starting an event."
y-death: "&fSet the death height. &o(%number%)"
game-base: "&fSet the game base area with the provided items."
color-block: "&fSet the game base block type from the GUI."
pvp-level: "&fSet the round in which the PvP will be enabled. &o(-1 to disable it) &o(%number%)"
pvp-type: "&fSet the PvP gamemodes from the GUI."
snowball-hotbar: "&fSet the hotbar number in which the snowballs will be given. &o(Ignore if disabled) &o(%number%)"
level-time: "&fSet the seconds for the block to disappear."
advanced: "&fThis section &o(%key%) &fis an advanced-only feature, to set it up do it from the config.yml"
# Don't change this or the plugin won't work correctly!
messages-version: 2.0
mapConfig.yml
# /$$$$$$ /$$ /$$ /$$$$$$$$ /$$
# /$$__ $$| $$ | $$ | $$_____/ | $$
# | $$ \__/| $$ /$$$$$$ /$$ /$$ /$$$$$$$ /$$$$$$$| $$ /$$ /$$ /$$$$$$ /$$$$$$$ /$$$$$$ /$$$$$$$
# | $$ | $$ /$$__ $$| $$ | $$ /$$__ $$ /$$_____/| $$$$$| $$ /$$//$$__ $$| $$__ $$|_ $$_/ /$$_____/
# | $$ | $$| $$ \ $$| $$ | $$| $$ | $$| $$$$$$ | $$__/ \ $$/$$/| $$$$$$$$| $$ \ $$ | $$ | $$$$$$
# | $$ $$| $$| $$ | $$| $$ | $$| $$ | $$ \____ $$| $$ \ $$$/ | $$_____/| $$ | $$ | $$ /$$\____ $$
# | $$$$$$/| $$| $$$$$$/| $$$$$$/| $$$$$$$ /$$$$$$$/| $$$$$$$$\ $/ | $$$$$$$| $$ | $$ | $$$$//$$$$$$$/
# \______/ |__/ \______/ \______/ \_______/|_______/ |________/ \_/ \_______/|__/ |__/ \___/ |_______/
# CloudsEvents Map Config File
## Generals
# The location where players will spawn when joining the event (X,Y,Z,Yaw,Pitch).
spawn-location: "0.5,70.0,0.5,0.0,0.0"
# The two vertices of the spawn cage (X,Y,Z).
spawn-cage-pos1: "-5,60,-5"
spawn-cage-pos2: "5,65,5"
# The maximum number of players required to start the event.
max-players: 16
# The minimum number of players required to join the event.
min-players: 2
# The time it takes to start the event once the minimum number of players is reached (in seconds).
start-time: 15
# The location where players will spawn when the event starts (X,Y,Z,Yaw,Pitch).
game-spawn-location: "0.5,60.0,0.5,0.0,0.0"
# The Y level at which players will die.
y-death: 50
## Color Party section
# The two vertices of the game base (X,Y,Z).
game-base-pos1: "25,60,25"
game-base-pos2: "-25,60,-25"
# The blocks used in the game base. Available blocks: wool, terracotta, concrete.
color-block: "wool"
# The level at which the PvP will be enabled. To disable it, type -1.
pvp-level: 10
# The PvP type, if multiple, separate by ;;
# - HAND (fist combat);
# - SNOWBALL.
pvp-type: "HAND;;SNOWBALL"
# The snowball hotbar position (1-9)
snowball-hotbar: 9
# Levels section
levels:
# {Level}: {Seconds}
1: 5
3: 4
5: 3
10: 2
## Timer Spleef section
# The blocks in the different levels, use the server version Material API (level: "material") [For legacy versions, use Material:Data].
blocks-level:
0: "WOOL:0"
1: "WOOL:4"
2: "WOOL:1"
3: "WOOL:14"
# The seconds between every level.
level-time: 5
# Don't change this or the plugin won't work correctly!
mapconfig-version: 1