-
Notifications
You must be signed in to change notification settings - Fork 274
Configuration Guide
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. |
| allow-client-mods | boolean | true | Tell Forge clients whether or not the server allows for client mods. |
| snooper-enabled | boolean | false | Whether Minecraft stats reporting is enabled. Currently not implemented. |
| prevent-proxy-connections | boolean | true | Whether the server should verify that the same IP that is used for connecting to the server is also used for authenticating with the Mojang servers. |
| Key | Type | Default | Description |
|---|---|---|---|
| use-jline | boolean | true | Whether the fancy console is enabled. Disable if you're having console problems. |
| prompt | string | '>' | The console prompt that appears before the input field |
| date-format | string | HH:mm:ss | How the time and date are displayed within the console. |
| log-date-format | string | yyyy/MM/dd HH:mm:ss | How the time and date are logged in the log files. |
Used to configure gameplay settings.
| Key | Type | Default | Description |
|---|---|---|---|
| gamemode | string | SURIVAL | The default gamemode, one of SURVIVAL, CREATIVE, ADVENTURE, or SPECTATOR. |
| 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. Currently not implemented. |
| 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. | |
| resource-pack-hash | string | The hash of the resource pack for data integrity purposes. |
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. |
| 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. |
| populate-anchored-chunks | boolean | false | Whether anchored chunks, like world spawns, are populated as soon as they are loaded. False means that these chunks will wait to be populated until a player loads those chunks for the first time, resulting in a long "Downloading terrain" wait time, and server stutter on first world join. |
| classic-style-water | boolean | false | Changes the water flow behavior to be finite with a moving source. |
| disable-generation | boolean | false | Disables world generation. |
| 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. |
| libraries | string | lib | The libraries directory 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. | |
| player-sample-count | integer | 12 | How many online players are shown in the server list. | |
| graphics-compute | enable | boolean | false | Whether GPU-based computations are enabled. |
| use-any-device | boolean | false | Whether any device can be used for OpenCL computations. | |
| region-file | cache-size | integer | 256 | The region file cache size, in MB. |
| compression | boolean | true | Whether region files should be compressed. | |
| profile-lookup-timeout | integer | 12 | Timeout for Mojang profile lookups, in seconds. | |
| library-checksum-validation | boolean | true | Whether downloaded libraries should be validated using their checksum. | |
| library-repository-url | string | https://repo.glowstone.net/service/local/repositories/central/content/ | The repository URL to download libraries from. | |
| library-download-attempts | integer | 2 | The maximum amount of attempts to download each library. | |
| suggest-player-name-when-null-tab-completions | boolean | true | Checks if player names should be suggested when a command returns null as their tab completion result. | |
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.
The libraries section is a list of objects representing information about libraries to download on server startup. Libraries are downloaded from a Maven repository defined in the advanced.library-repository-url setting. Each file is downloaded from the location defined using the format: {library-repository-url}/{group-id}/{artifact-id}/{version}.jar
Each element of the list is defined using this format:
| Key | Type | Description | |
|---|---|---|---|
| group-id | string | The group ID of the library. | |
| artifact-id | string | The artifact ID of the library. | |
| version | string | The version of the library. | |
| checksum (optional) | type | string (sha1 or md5) | The checksum algorithm of the checksum. Only SHA-1 and MD5 are supported. |
| value | string | The checksum of the library. | |
This is used to customize the terrain generation and other world specific settings that don't belong in the main configuration file.
Getting Started:
Using Glowstone:
- Configuration Guide
- Plugin Compatibility
- Opening Tickets
- Library Management
- Server Icon
- Community Projects
Contributing:
Documentation:
-
Plugin Reference
-
Glowstone Internals