config.yml

Main configuration file.

server-type

Server type defines the way you want to run the plugin. Available types:

• MULTI_ARENA - when you want to run the plugin on a single server with multiple arenas and a lobby where you can select arenas.

• BUNGEE - if you want to run multiple arenas on a server without a lobby. Players will join from a remote server using SteveSus-Connector plugin.

• BUNGEE_LEGACY - where the server will run a single arena. Players can join directly and will be added to the game. It will adjust server slots and MOTD.

server-display-name

Server DNS replacement for {server_name} placeholder in language files.

store-link

This link is opened when players click on certain chat messages they receive when vip features are required.

default-locale

Default or fallback server language. The language ISO code you're adding here points to a language file at this path: SteveSus/Locales/messages_<iso>.yml so make sure it exists.

custom-path

Here you can tell the plugin where to create or take the configuration from. This is useful when you want to use the same configuration between mini-game nodes. You can point SteveSus-Connector plugin at the same locations. Leave path empty to use default values.

• locales-path - Languages folder path.

• database-path - Database config location.

• templates-path - Game templates folder path.

• selector-path - Game selector config location.

• sounds-path - Game sounds path.

• stats-path - Stats GUI configuration path.

• join-items-path - Join items configuration path.

• teleporter-path - Spectator teleporter configuration path.

• abuse-prevention-path - Anti abuse configuration path.

• exclusion-vote-path - Vote GUI config location.

common-section

Common configuration section where common means every server type use this configuration part.

game-countdown

Game contdowns in seconds.

• start-countdown - When minimum players to start is reached.

• shortened-countdown - Shortened to this when max players is reached.

Countdowns can be configured per arena as well, just add this in the arena configuration:

game-countdown:
  start-countdown: 70
  shortened-countdown: 20

register-leave-cmd

Should /leave command be registered?

internal-disconnect-handler

If not overwritten trough the API, list of servers, separated by comma, where to move players when a game ends or when they use a leave cmd.

parties

Parties configuration section.

• enable - true if you want to allow parties

• internal - Default parties implementation configuration.

  • register-sub-command - true to register ss partysub-command

  • offline-tolerance - How many seconds before removing a player from a party if he left the server. Use -1 or 0 for always.

  • party-size-limit - Amount of players allowed in a party.

sidebar

Scoreboard configuration section.

• placeholders-refresh-interval - How often should placeholders be refreshed? In server ticks. Default value is 20.

• title-refresh-interval - How often should scoreboard title be refreshed? In server ticks. Seting this under 20 may cause lag.

multi-arena-section

This configuration section contains settings used only when your server is running in MULTI_ARENA mode.

spawn-point

Location where to spawn players when they join the server.

bungee-section

This configuration section contains settings used only when your server is running in BUNGEE mode.

server-name

Server's name in bungee config. This must correspond to the server's name in Bungeecord's configuration because this string is sent to the SteveSus-Connector plugin and used later when a player wants to join an arena from this server.

lobby-sockets

List of ip:port where to send arena data. Do not insert the minecraft server port here but use the SteveSus-Connector port insead. Example:

lobby-sockets: 
  - localhost:11058
  - 127.1.0.0:11058
  - 111.222.333.444:11058
  - my.minecraft-server.ro:11058

update-lobbies-interval

How often (in seconds) to check for newly started up lobbies. Default: 10.

ping-lobbies-interval

How often (in seconds) to tell remote lobbies that this server is still online and arena data is up to date. Default: 5.

bungee-legacy-section

This configuration section contains settings used only when your server is running in BUNGEE_LEGACY mode.

games-before-restart

How many arena re-starts before re-starting the server itself? Set it to -1 to disable or 1 to always restart.

restart-command

When the countdown above reaches 0 it will execute this command.

whitelisted-commands

List of commands that are allowed to be used in pre-game and in-game. You can allow a root command like 'party' or with sub-commands: 'party leave'. Example:

whitelisted-commands:
    # Commands allowed when game status is waiting or starting.
    pre-game: 
    - au
    - lang
    # Commands allowed during the game.
    in-game: 
    - au
    - lang
    - party