-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Migrate some more server config docs
- Loading branch information
Showing
2 changed files
with
86 additions
and
23 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,11 +1,91 @@ | ||
| glowstone.yml | ||
| ============= | ||
| ############# | ||
|
|
||
| The :code:`glowstone.yml` file allows you to edit your server settings. | ||
|
|
||
| .. toctree:: | ||
| :maxdepth: 2 | ||
| :caption: Sections | ||
| :titlesonly: | ||
| This section documents the different options inside the file. We recommend using the navigation tree on the left | ||
| to move around. | ||
|
|
||
| server | ||
| server | ||
| ====== | ||
|
|
||
| +--------------------------------+-------------------+--------------------------------+-------------------------------------------------------------+ | ||
| | Key | Type | Default | Description | | ||
| +================================+===================+================================+=============================================================+ | ||
| | ip | text *(optional)* | *(Blank)* | Which interface the server should listen on, usually blank. | | ||
| +--------------------------------+-------------------+--------------------------------+-------------------------------------------------------------+ | ||
| | port | integer | 25565 | The port the server should listen on. | | ||
| +--------------------------------+-------------------+--------------------------------+-------------------------------------------------------------+ | ||
| | name | text | Glowstone Server | The server's name, used in queries. | | ||
| +--------------------------------+-------------------+--------------------------------+-------------------------------------------------------------+ | ||
| | log-file | text | logs/log-%D.txt | Where the log is stored relative to the server folder. | | ||
| +--------------------------------+-------------------+--------------------------------+-------------------------------------------------------------+ | ||
| | | | | Whether connecting players are authenticated. | | ||
| | online-mode | true/false | true | Only disable this if you know what you are doing. | | ||
| +--------------------------------+-------------------+--------------------------------+-------------------------------------------------------------+ | ||
| | max-players | integer | 20 | The maximum number of players on the server. | | ||
| +--------------------------------+-------------------+--------------------------------+-------------------------------------------------------------+ | ||
| | whitelisted | true/false | false | Whether the whitelist is enabled. | | ||
| +--------------------------------+-------------------+--------------------------------+-------------------------------------------------------------+ | ||
| | motd | text | Glowstone Server | The message shown in the server list. | | ||
| +--------------------------------+-------------------+--------------------------------+-------------------------------------------------------------+ | ||
| | shutdown-message | text | Server shutting down. | The message used to kick players when the server stops. | | ||
| +--------------------------------+-------------------+--------------------------------+-------------------------------------------------------------+ | ||
| | allow-client-mods | true/false | true | Tell Forge clients whether or not the server allows | | ||
| | | | | for client mods. | | ||
| +--------------------------------+-------------------+--------------------------------+-------------------------------------------------------------+ | ||
| | snooper-enabled | true/false | false | Whether Minecraft stats reporting is enabled. | | ||
| | | | | Currently not implemented. | | ||
| +--------------------------------+-------------------+--------------------------------+-------------------------------------------------------------+ | ||
| | prevent-proxy-connections | true/false | true | Whether the server should verify that the IP that is | | ||
| | | | | used for connecting to the server is also used for | | ||
| | | | | authenticating with the Mojang servers. | | ||
| +--------------------------------+-------------------+--------------------------------+-------------------------------------------------------------+ | ||
|
|
||
| console | ||
| ======= | ||
|
|
||
| +--------------------------------+-------------------+--------------------------------+-------------------------------------------------------------+ | ||
| | Key | Type | Default | Description | | ||
| +================================+===================+================================+=============================================================+ | ||
| | use-jline | true/false | true | Whether the fancy console is enabled. | | ||
| | | | | Disable if you're having console problems. | | ||
| +--------------------------------+-------------------+--------------------------------+-------------------------------------------------------------+ | ||
| | prompt | text | :code:`'> '` | The console prompt that appears before the input field. | | ||
| +--------------------------------+-------------------+--------------------------------+-------------------------------------------------------------+ | ||
| | date-format | text | HH:mm:ss | How the time and date are displayed within the console. | | ||
| +--------------------------------+-------------------+--------------------------------+-------------------------------------------------------------+ | ||
| | log-date-format | text | yyyy/MM/dd HH:mm:ss | How the time and date are logged in the log files. | | ||
| +--------------------------------+-------------------+--------------------------------+-------------------------------------------------------------+ | ||
|
|
||
| game | ||
| ==== | ||
|
|
||
| +--------------------------------+-------------------+--------------------------------+-------------------------------------------------------------+ | ||
| | Key | Type | Default | Description | | ||
| +================================+===================+================================+=============================================================+ | ||
| | gamemode | text *(enum)* | SURVIVAL | The default gamemode, one of | | ||
| | | | | SURVIVAL, CREATIVE, ADVENTURE, or SPECTATOR. | | ||
| +--------------------------------+-------------------+--------------------------------+-------------------------------------------------------------+ | ||
| | gamemode-force | true/false | false | Whether players are forced to the default gamemode on join. | | ||
| +--------------------------------+-------------------+--------------------------------+-------------------------------------------------------------+ | ||
| | difficulty | text *(enum)* | NORMAL | The difficulty, one of | | ||
| | | | | PEACEFUL, EASY, NORMAL, or HARD. | | ||
| +--------------------------------+-------------------+--------------------------------+-------------------------------------------------------------+ | ||
| | hardcore | true/false | false | Whether hardcore mode (ban on death) is enabled. | | ||
| +--------------------------------+-------------------+--------------------------------+-------------------------------------------------------------+ | ||
| | pvp | true/false | true | Whether player vs. player mode is enabled. | | ||
| +--------------------------------+-------------------+--------------------------------+-------------------------------------------------------------+ | ||
| | max-build-height | integer | 256 | The maximum height at which players may build. | | ||
| +--------------------------------+-------------------+--------------------------------+-------------------------------------------------------------+ | ||
| | announce-achievements | true/false | true | Whether achievements are announced in the chat. Unused. | | ||
| | *(deprecated)* | | | | | ||
| +--------------------------------+-------------------+--------------------------------+-------------------------------------------------------------+ | ||
| | allow-flight | true/false | false | Whether unauthorized flight prevention is disabled. | | ||
| +--------------------------------+-------------------+--------------------------------+-------------------------------------------------------------+ | ||
| | command-blocks | true/false | false | Whether command blocks are enabled. Unused. | | ||
| +--------------------------------+-------------------+--------------------------------+-------------------------------------------------------------+ | ||
| | resource-pack | text *(optional)* | *(Blank)* | The URL of the resource pack to send to clients by default. | | ||
| +--------------------------------+-------------------+--------------------------------+-------------------------------------------------------------+ | ||
| | resource-pack-hash | text *(optional)* | *(Blank)* | The hash of the resource pack for data integrity purposes. | | ||
| +--------------------------------+-------------------+--------------------------------+-------------------------------------------------------------+ |
This file was deleted.
Oops, something went wrong.