-
Notifications
You must be signed in to change notification settings - Fork 64
Configsetup
The current default config.yml
Once you change a config option you will need to reload the config.
- /arena reload
- /spleef reload
Victory Conditions are the conditions under which a match will end. Currently these are the valid victory conditions
- LastManStanding: Match will end when there is only one team left (or player if teamSize: 1)
- nLives: Every player has a set number of lives. Match ends when only one team is left (or player if teamSize: 1)
- nLives needs a line below it with the line ' nLives: <number or lives>', ' nlives: 3' as an example
- InfiniteLives: teams have infinite lives
- TimeLimit: Only use a time limit, or when not enough teams remain
- HighestKills: Players have infinite lives and the team with the highest kills wins
There is a config option called onServerStart: []. If you want to start running scheduled events continuously add the option startContinuous, if you just want to start the next event, put startNext. Example:
defaultOptions:
onServerStart: [startContinuous]
If you want to change the announcement settings for all matches/events then change the options found inside of defaultOptions: Example:
defaultOptions:
announcements:
onPreStart: [ dontannounce ]
onStart: [ dontannounce ]
onVictory: [ dontannounce ]
If you just want to change the announcement settings for one particular match type. then add the lines to the match type you want. Example using skirmish
skirmish:
announcements:
onPreStart: [ dontannounce ]
onStart: [ dontannounce ]
onVictory: [ dontannounce ]
By default most event messages get announced to the server. If you want it to only be to people inside the event then change "announce" to "dontannounce". If you have herochat or another vault based chat plugin you can change the channel of the messages by putting in "channel=<channel>"
eventAnnouncements:
onCountDownToEvent: [ announce, server ] ## event is now open
onOpen: [ announce, server ] ## event is now open
onStart: [ announce, server ] ## event is starting
onVictory: [ announce, server ] ## event has been won
onCancel: [ announce, server ] ## event has been cancelled
- add the option woolTeams in the option area where you want players to start having wool heads (usually when they first get teleported into the arena, the option teleportIn)
### Skirmish
skirmish:
enabled: true
onStart:
options: [teleportIn, pvpOn, blockBreakOff, woolTeams]
- Additionally, using alwaysWoolTeams will force everyone to receive a wool head even if teams are 1v1.
- add the option nTeams: with the amount of teams to the base match/event type config
only 2 teams will play
skirmish:
nTeams: 2
Allow 3 teams or up to 5 teams play
skirmish:
nTeams: 3-5
allow 2 or more teams to play
skirmish:
nTeams: 2+
- add the option teamSize: with the team size to the base match/event type config
Example to set 4 players per team:
skirmish:
teamSize: 4
Example to set 2 through 5 players per team:
skirmish:
teamSize: 2-5
Allow any number of players to join a team
skirmish:
teamSize: 1+
- add the option matchTime: <x> to specify how long you want the match to last ( add this option if it doesn't exist). set to -1 if you want it to run forever until someone wins
skirmish:
matchTime: 240 ## <- match will now last 240 seconds
skirmish:
matchTime: -1 ## <- match will now last until someone wins
- add the option money=<amount> into the winner: config section. Create the section winner: if it doesn't exist.
- To give money to the losers, do the same but in the section losers:
winner:
options: [money=100]
losers:
options: [money=5]
- add the option giveItems into the winner: config section. Create the section winner: if it doesn't exist. After that you will need to list out your items: in a list below the options (see below example)
- To give money to the losers, do the same but in the section losers:
winner:
options: [giveItems]
items:
- diamond: 1
- gold_ingot: 1
losers:
options: [giveItems]
items:
- fish: 1
- add the option money=<amount> into the winner: config section. Create the section firstPlace: if it doesn't exist.
- To give money to the losers, do the same but in the section losers:
firstPlace:
options: [money=100]
participants:
options: [money=5]
- add the option giveItems into the firstPlace: config section. Create the section firstPlace: if it doesn't exist. After that you will need to list out your items: in a list below the options (see below example)
- To give money to the losers, do the same but in the section participants:
firstPlace:
options: [giveItems]
items:
- diamond: 1
- gold_ingot: 1
participants:
options: [giveItems]
items:
- fish: 1
- add the option clearInventory into the onDeath: config section. Create the section onDeath: if it doesn't exist.
onDeath:
options: [clearInventory]
- add the option respawn or randomRespawn into the onDeath: config section. Create the section onDeath: if it doesn't exist.
onDeath:
options: [randomRespawn]
- You will also need to add/change the victoryCondition to HighestKills (otherwise it defaults to the last person alive wins).
battleground:
victoryCondition: highestKills
Add in a section called "doCommands" inside of the stage you want (probably onEnter). The format is
- <player or console> <commands that you want to run>
If in the commands the word "player" appears it will then be substituted with the player name.
For example. Lets say alkarin_v is entering the arena, and the command is "- player fly stop player". This will run the command "fly stop alkarin_v" as the player "alkarin_v"
onStart:
doCommands:
- player fly stop
- console deop player
Add a configuration section victoryCondition to the match/event.
Current Valid victoryConditions
- lastManStanding
- highestKills
- nDeaths (To be changed to nLives)
- timeLimit (Nobody will ever win)
- noTeamsLeft (All teams are dead)
battleground:
victoryCondition: highestKills
Add the config option sameWorld to the preReqs: section (add it if it doesn't exit)
Example:
battleground:
preReqs:
options: [sameWorld]
Add the config option withinDistance=<distance> to the preReqs: section (add it if it doesn't exit). Distance is based off of distance to spawn points.
Example:
battleground:
preReqs:
options: [withinDistance=30] # limit joining to players within 30 blocks of the arena
Add the config option alwaysJoin to the onJoin: section.
Example:
battleground:
onJoin:
options: [alwaysJoin]
- add the option money=<amount> into the preReqs: config section. Create the section preReqs: if it doesn't exist.
preReqs:
options: [money=100]
See ClassSetup
All stages and transitions can have any of the 'options'.
A match is composed of different stages.
- onOpen: For events this happens when you open the event. For matches when players get matched from the queue.
- onPrestart: time between onOpen and onStart.
- onStart: Match starts
- onVictory: One player or team is victorious
- onComplete: match was completed successfully
- onCancel: match was cancelled
- onFinish: happens after onComplete or onCancel
During the match many different transitions can happen
- onSpawn: Happens on teleport or on player Respawn ( if respawn is set within onDeath)
- onDeath: What happens when a player dies
- onJoin: player joining a match
- onEnter: Happens when the player first enters the arena. right after before they are teleported in.
- onLeave: Happens when the player leaves the arena(aka if they win(after onComplete), or if they die(and dont respawn) )
- losers: Happens after onVictory, before onComplete, used for prizes
- winner: Happens after onVictory, before onComplete, used for prizes
- drawers: Happens after onVictory, before onComplete, used for prizes
- firstPlace: Prizes for tournaments
- participants: Prizes for tournaments
See the Options page