Config.yml

« Back to PlayerServers Wiki

Config

Config.yml is located in the BungeeCord PlayerServers plugin folder. (ie. bungee/plugins/PlayerServers/config.yml)
Check #comments below for tips on usage or valid values.
You can edit this while the server is running, and use /psa reload in-game or from console to reload the config.

prefix: '&b&oPlayrSrv &7&o»&f '     # customize the prefix for messages.
ps-custom-command: '/playerserver'  # customize the /playerserver command.
wrapper: 'default'                  # Select the server wrapper you want to use: 'default' (the included PSWrapper) or 'screen' are the choices
wrapper-control-address: 'localhost'# Leave this at localhost until remote server creation is implemented.
wrapper-control-port: 5155          # The port to connect to the default wrapper (PSWrapper) on to control servers. If you have something running on port 5155 change this, otherwise leave it alone.
hub-server: 'default'               # customize the server players are sent if they leave/are kicked from a player server. "default" will use BungeeCord's default_server setting.
servers-folder: 'default'           # customize the folder where player servers are stored. "default" will store them in the PlayerServers plugin folder.
startup-join-delay: 10              # the delay (in seconds) after starting a server, before they are sent to the server. Minimum 5 seconds.
online-join-delay: 3                # the delay (in seconds) before a player is sent to an already online server.
next-port: 26000                    # set the port to be used by the next server. set to a custom starting port if you want, but then DON'T TOUCH or ports could conflict!
use-expire-dates: true              # will servers expire? dates will always be tracked, but servers will only be blocked from starting if this is "true"
reset-expiry-on-create: false       # If true, will reset a players expire time every time they create a server.
debug: false                        # if true, it will spam your logs with tons of very useful debug messages for troubleshooting.
use-titles: true                    # When true, uses titles for many messages. If false, falls back to chat messages.
use-startup-queue: true             # Enable/disable server queuing when global-max-RAM or global-max-servers limit is reached.
global-max-RAM: -1                  # Maximum allowed RAM allocated by PlayerServers. Can be a plain number (of Mb), or a string like "1024M" or "2G". -1 to disable.
global-max-servers: -1              # Maxium allowed servers running at once. -1 to disable.
purge-servers: false                # Enable/disable server purging (deleting) after a time period.
purge-after: '30 days'              # Time period AFTER EXPIRE that it should wait before deleting servers.
purge-check-interval: '6 hours'     # How often to check for servers to be purged.
blocked-commands:                   # Define custom commands to be blocked (unless a user has "playerservers.admin" permission). Commands are defined using regex. Use regexr.com for regex help/testing
  - '^(/execute(.*)|/)(minecraft:)(ban(-ip)?|pardon(-ip)?|stop|reload)($|\s.*)?'
always-op:                          # Define players (by name OR UUID) that will ALWAYS be OPed when they join a PlayerServer. Typically add yourself + other admins here.
  - Notch
  - 069a79f4-44e9-4726-a5be-fca90e38aaf5