wrapperconfig.rst

< class Config file items and layout >

'''

wrapperconfig.py is the default config file. Changes made here are inserted or deleted from the the wrapper config each time wrapper starts.

The wrapper.config.json file contents will look like this, but without all the comment lines.

'''

CONFIG = {

# Backups - Automatic backups with pruning. Intervals are specified in seconds.

"Backups":

"backup-compression": False,

# Specify server files and folders you want backed up. Items must be in your server folder (see 'General' section)

"backup-folders":

[

"server.properties",

"world",

"wrapper-data",

],

# backup interval in seconds: 3600 = hourly, 86400 = Daily, 604800 = weekly

"backup-interval": 3600,

# backup location is inside wrapper's directory, unless you use an absolute path (such as /home/otherdirectory/backups)

"backup-location": "backup-directory",

"backup-notification": True,

"backups-keep": 10,

"enabled": False

# Alerts - provide email or other notification of wrapper problems (server down, etc).

"Alerts":

# with some modern email providers, you may need to "allow less secure apps” on your account..

# You should use a dedicated email with a password that is different from your other accounts for this purpose.

"enabled": False,

# enable a server item by setting login name to something other than "False". Use your email address for login-name and the associated password (encrypt it first).

"servers": [

{

# built in alerts use "wrapper" group.

"group": "wrapper",

"subject": "Wrapper.py Alert",

"type": "email",

"address": "smtp.gmail.com",

"port": 587,

"login-name": False,

"encrypted-password": "Copy and Paste from 'password' after wrapper encrypts it.",

"recipients": ["email1@provider.com", "email2@provider.com"]

}

],

# -plaintext items are converted to hashed items by wrapper

"password-plaintext": False,

"password": "use /password -s Alerts password <your password> to set this (or enter a password-plaintext).",

# Gameplay - miscellaneous configuration items.

"Gameplay":

# Use of timer-tick is not recommended. 1/20th of a second timer option for plugin use. May impact wrapper performance negatively.

"use-timer-tick-event": False,

# Entity processing - This is somewhat superfluous now that minecraft has more built-in entity management gamerules now. Must be turned on to use player.mount / unmount events.

"Entities":

# whether to use the wrapper entity controls. With new minecraft versions, these are largely unnecessary and better done with the Gamerules.

"enable-entity-controls": False,

# how often the entity processor updates world entity counts

"entity-update-frequency": 4,

# how often thinning of mobs runs, in seconds. a large difference between this and the entity update frequency will ensure no 'overkill" occurs.

"thinning-frequency": 30,

# when mobs < this threshhold, thinning is inactive (server or player)

"thinning-activation-threshhold": 100,

# The following items thin specific mobs over the stated count. This only happens after the total mob count threshold above is met first. For example, 'thin-Cow: 40` starts thinning cows > 40. Entity names must match minecraft naming exactly as they would appear in the game.

# Check /wrapper-data/json/entities.json

# there are some surprising changes after 1.11, like "PigZombie" is now zombie_pigman and EntityHorse is horse, etc. Sheep, Cow, anc Chicken are now lower case: sheep, cow, chicken.. etc.

"thin-cow": 40,

"thin-zombie_pigman": 40,

"thin-sheep": 40,

"thin-chicken": 30

# Updates - Control wrapper update behaviour.

"Updates":

# Use one of the names listed herein (i.e. 'stable-branch')

"auto-update-branch": None,

# If True, an "auto-update-branch" must be specified.

"auto-update-wrapper": False,

# You can point these to another branch, if desired.

"stable-branch": "https://raw.githubusercontent.com/benbaptist/minecraft-wrapper/master",

"dev-branch": "https://raw.githubusercontent.com/benbaptist/minecraft-wrapper/development",

# Misc - look 'n' feel type customizations

"Misc":

# Reboot message occurs with automatic timed server restarts ["General"]["timed-reboot"]

"reboot-message": "Server is conducting a scheduled reboot. The server will be back momentarily!",

# Restart message occurs when console command "/restart" is run.

"default-restart-message": "Server restarting...",

# Stop message is generated from wrapper "/stop" command.

"stop-message": "Stopping The Minecraft Server",

# message when wrapper halt is called.

"halt-message": "Halting Wrapper...",

# Specify if wrapper should trap control-z and shutdown in a controlled manner (similar to ctrl-c). If false, follows the behavior permitted by your system (and that might not end well!) - Discussion: #521

"trap-ctrl-z": True,

# Use-betterconsole replaces "use-readline" for clarity about what this option does. The default is False because use-betterconsole may not be fully cross-platform. Better Console makes it easier for the console operator too see what they are typing, even while the server or wrapper my be writing output at the same time, essentially produces jline-like functionality to the wrapper console...

"use-betterconsole": False,

# General wrapper and server startup options

"General":

# restart server automatically if it stops (unless you explicity used the "/stop" command within the console).

"auto-restart": True,

# You will need to update this to your particular server start command line.

"command": "java -jar -Xmx2G -Xms1G server.jar nogui",

# If not uft-8, specify your system's encoding here.

"encoding": "utf-8",

# Using the default '.' roots the server in the same folder with wrapper. Change this to another folder to keep the wrapper and server folders separate. Do not use a trailing slash... e.g. - '/full/pathto/the/server'. relative paths are ok too, as long as there is no trailing slash. For instance, to use a sister directory, use ../server.

"server-directory": ".",

"shell-scripts": False,

"timed-reboot": False,

# salt is used internally for wrapper encryption. Do not edit this; Wrapper will create the salt. It does not matter much that it is on disk here, as the user must create a passphrase also. This just prevents the need for a hardcoded salt and ensures each wrapper installation will use a different one.

"salt": False,

"timed-reboot-minutes": 1440,

"timed-reboot-warning-minutes": 5,

# IRC - This allows your users to communicate to and from the server via IRC and vice versa.

"IRC":

"autorun-irc-commands":

[

"COMMAND 1",

"COMMAND 2"

],

"channels":

[

"#wrapper"

],

"command-character": ".",

"control-from-irc": False,

# enter a password here and wrapper will convert it to a hashed password

"control-irc-pass-plaintext": False,

"control-irc-pass": "from console use /password IRC control-irc-pass <your password>",

"irc-enabled": False,

"nick": "MinecraftWrap",

"obstruct-nicknames": False,

# enter a password here and wrapper will convert it to a hashed password

"password-plaintext": False,

"password": "from console use /password IRC password <your password>",

"port": 6667,

"server": "benbaptist.com",

"show-channel-server": True,

"show-irc-join-part": True

# Proxy settings -

# This is a man-in-the-middle proxy similar to BungeeCord, which is used for extra plugin functionality. Online-mode must be set to False in server.properties. Make sure that the server port is not accessible directly from the outside world.

# Note: the online-mode option here refers to the proxy only, not to the server's offline mode. Each server's online mode will depend on its setting in server.properties. If you experience issues, you might try turning network-compression-threshold to -1 (off) in server.properties.

"Proxy":

# Must be a single character.

"command-prefix": "/",

# This will kick players that are not in the playerlist (because they entered the server port directly).

"disconnect-nonproxy-connections": True,

# The number of players the proxy will hold. This includes connected players from all hub worlds

"max-players": 1024,

# Flush rate sets the interval for packet flushing. This is a fine-tuning mechanism. 50 Ms is one minecraft tick. Faster (smaller) rates result in dropped items disappearing. Larger values can create jerkiness or lag, but result in more reliable transmission. This is a fine tuning that may be different for each server based on the number of plugins, whether the server is hub, etc.. 50-100 is recommended for most servers. Hub servers with limited play can be set at 10.

"flush-rate-ms": 50,

# Auto name changes causes wrapper to automatically change the player's server name. Enabling this makes name change handling automatic, but will prevent setting your own custom names on the server.

"auto-name-changes": True,

# the wrapper's online mode, NOT the server.

"online-mode": True,

"proxy-bind": "0.0.0.0",

"proxy-enabled": False,

# the wrapper's proxy port that accepts client connections from the internet. This port is exposed to the internet via your port forwards.

"proxy-port": 25565,

# silent bans cause your server to ignore sockets from that IP (for IP bans). This will cause your server to appear offline and avoid possible confrontations.

"silent-ipban": True,

"hidden-ops":

# these players do not appear in the sample server player list pings.

[

"SurestTexas00",

"BenBaptist"

],

# set to True to use the wrapper built in Hub system (you must specify all your "worlds").

"built-in-hub": False,

# Define your worlds here to give players access to multiple worlds (with no plugin required).

"worlds":

# "world"= the name used in the hub/ command. "port" = its value, corresponding to the local port. "desc" is the world's meta description that fits this sentence: ` Go to "".`. worlds and help are reserved (do not use them for world names). These names can also be used to drive the world change confirmation message, even if you are using your own player.connect() plugin. 'ip' is optional and defaults to 127.0.0.1 / localhost.

{

"world": {"port": 25565, "desc": "a world description", "ip": "localhost"},

},

# Web - Web mode allows you to control and monitor the server. This is not a https connection. Be mindful of that and don't use the same password you use anywhere else. It is also advised that this be open only to the localhost.

"Web":

"web-allow-file-management": True,

"web-bind": "0.0.0.0",

"web-enabled": False,

# enter a password here and wrapper will convert it to a hashed password

"web-password-plaintext": False,

"web-password": "to set this, from console use /password Web web-password <your password>",

"web-port": 8070,

# By default, wrapper only accepts connections from "safe" IP addresses. Disable (set 'safe-ips-use' ot false) or add the IP address of computers you may use to access web mode.

"safe-ips": ["127.0.0.1"],

"safe-ips-use": True,

"server-name": "Minecraft Server",

#