This repository has been archived by the owner on Nov 9, 2017. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 122
Configuration Guide
mastercoms edited this page Dec 24, 2014
·
11 revisions
The glowstone.yml file allows you to edit your server settings. It can be found by default in the config directory in your server installation.
| Key | Type | Default | Description |
|---|---|---|---|
| ip | string | Which interface the server should listen on, usually blank. | |
| port | integer | 25565 | The port the server should listen on. |
| name | string | Glowstone Server | The server's name, used in queries. |
| log-file | string | logs/log-%D.txt | Where the log is stored relative to the server folder. |
| online-mode | boolean | true | Whether connecting players are authenticated. Only disable this if you know what you are doing. |
| max-players | integer | 20 | The maximum number of players on the server. |
| whitelisted | boolean | false | Whether the whitelist is enabled. |
| motd | string | Glowstone Server | The message shown in the server list. |
| shutdown-message | string | Server shutting down. | The message used to kick players when the server stops. |
| use-jline | boolean | true | Whether the fancy console is enabled. Disable if you're having console problems. |
| snooper-enabled | boolean | false | Whether Minecraft stats reporting is enabled. Currently not implemented. |
Used to configure gameplay settings.
| Key | Type | Default | Description |
|---|---|---|---|
| gamemode | string | SURIVAL | The default gamemode, one of SURVIVAL, CREATIVE, or ADVENTURE. |
| gamemode-force | boolean | false | Whether players are forced to the default gamemode on join. |
| difficulty | string | NORMAL | The difficulty, one of PEACEFUL, EASY, NORMAL, or HARD. |
| hardcore | boolean | false | Whether hardcore mode (ban on death) is enabled. |
| pvp | boolean | true | Whether player vs. player mode is enabled. |
| max-build-height | integer | 256 | The maximum height at which players may build. |
| announce-achievements | boolean | true | Whether achievements are announced in the chat. |
| allow-flight | boolean | false | Whether flight prevention is disabled. Currently not implemented. |
| command-blocks | boolean | false | Whether command blocks are enabled. Currently not implemented. |
| resource-pack | string | The URL of the resource pack to send to clients by default. |
Used to choose how the default worlds are configured. For advanced world configuration, a plugin such as Multiverse may be appropriate.
| Key | Type | Default | Description |
|---|---|---|---|
| name | string | world | The name of the main world. |
| seed | string | The seed to use for the main world, or blank for random. | |
| level-type | string | DEFAULT | The world type to use for the main world, one of DEFAULT, FLAT, DEFAULT_1_1, LARGEBIOMES, or AMPLIFIED. |
| spawn-radius | integer | 16 | The radius around a world's spawn point to protect from damage, or 0 to disable. |
| view-distance | integer | 8 | The radius of the area of chunks to send to players. |
| gen-structures | boolean | true | Whether structures (villages, strongholds, etc.) are generated. |
| gen-settings | string | The settings string for the main world's generator. | |
| allow-nether | boolean | true | Whether a Nether is created by default. |
| allow-end | boolean | true | Whether an End is created by default. |
| keep-spawn-loaded | boolean | true | Whether chunks around world spawns are kept loaded by default. |
| Key | Type | Default | Description |
|---|---|---|---|
| plugins | string | plugins | The plugins directory relative to server root. |
| update | string | update | The directory relative to 'plugins' to copy updates from on startup. |
| worlds | string | worlds | The world container relative to server root. |
All files are relative to the config directory.
| Key | Type | Default | Description |
|---|---|---|---|
| permissions | string | permissions.yml | The file to read custom permissions from. |
| commands | string | commands.yml | The file to read command aliases from. |
| help | string | help.yml | The file to read help topics from. |
Advanced server configuration options.
| Key | Type | Default | Description |
|---|---|---|---|
| connection-throttle | integer | 4000 | Time in milliseconds a client must wait before reconnecting. |
| idle-timeout | integer | 0 | How long until an AFK player is kicked (0 for never). |
| warn-on-overload | boolean | true | Whether to show warnings if the server is overloaded. |
| exact-login-location | boolean | false | Whether to skip fixing block collisions on player login. |
| plugin-profiling | boolean | false | Whether the /timings command is enabled. |
| deprecated-verbose | true, false, default | false | Whether to always, never, or only sometimes show deprecation warnings for plugins. |
| compression-threshold | integer | 256 | The minimum packet size to compress. -1 to disable, 0 to compress everything. |
| proxy-support | boolean | false | Whether proxy (e.g. BungeeCord) support is enabled, granting access to the real IP and UUID of proxied players. Requires the proxy to be configured correctly. |
Extra services which Glowstone can optionally provide.
| Key | Type | Default | Description |
|---|---|---|---|
| query-enabled | boolean | false | Whether the query server is enabled. |
| query-port | integer | 25614 | The port the query server runs on. |
| query-plugins | boolean | true | Whether the query response includes plugin info. |
| rcon-enabled | boolean | false | Whether the rcon server is enabled. |
| rcon-password | string | glowstone | The rcon password. |
| rcon-port | integer | 25575 | The port the rcon server runs on. |
| rcon-colors | boolean | true | Whether the server should send color-codes to the rcon client. |
Used to control mob spawn limits. Currently not implemented.
Used to control the database engine used by some plugins. Glowstone now includes MySQL/SQLite by default.