Update README.md

[skip build]
This commit is contained in:
Sebastian Hugentobler 2016-10-31 10:26:36 +00:00
parent 437654b167
commit 4beb2b2c1a

View File

@ -1,6 +1,6 @@
A [Minecraft](https://minecraft.net) server running on [Spigot](https://www.spigotmc.org/). A [Minecraft](https://minecraft.net) server running on [Spigot](https://www.spigotmc.org/).
## Volumes # Volumes
- `/var/lib/minecraft/plugins` - `/var/lib/minecraft/plugins`
- `/var/lib/minecraft/world` - `/var/lib/minecraft/world`
- `/var/lib/minecraft/world_nether` - `/var/lib/minecraft/world_nether`
@ -10,23 +10,23 @@ A [Minecraft](https://minecraft.net) server running on [Spigot](https://www.spig
- `/var/lib/minecraft/banned-ips.json` - `/var/lib/minecraft/banned-ips.json`
- `/var/lib/minecraft/banned-players.json` - `/var/lib/minecraft/banned-players.json`
## Environment Variables # Environment Variables
### SERVER_NAME ## SERVER_NAME
The name of the server. The name of the server.
### MOTD ## MOTD
Message of the day. Message of the day.
### LEVEL_SEED ## LEVEL_SEED
[Seed](http://minecraft.gamepedia.com/Seed_(level_generation)) for level generation. [Seed](http://minecraft.gamepedia.com/Seed_(level_generation)) for level generation.
### BUKKIT_CONNECTION_THROTTLE ## BUKKIT_CONNECTION_THROTTLE
- default: 4000 - default: 4000
The delay before a client is allowed to connect again after a recent connection attempt in milliseconds. The delay before a client is allowed to connect again after a recent connection attempt in milliseconds.
`0` disables the limit. `0` disables the limit.
### OP_PERMISSION_LEVEL ## OP_PERMISSION_LEVEL
- default: 4 - default: 4
One of: One of:
@ -35,28 +35,28 @@ One of:
- 3: Ops can use /ban, /deop, /kick, and /op. - 3: Ops can use /ban, /deop, /kick, and /op.
- 4: Ops can use /stop. - 4: Ops can use /stop.
### ALLOW_NETHER ## ALLOW_NETHER
- default: true - default: true
Whether players can travel to the Nether. Whether players can travel to the Nether.
### ALLOW_FLIGHT ## ALLOW_FLIGHT
- default: false - default: false
Allows users to use flight on your server while in Survival mode, if they have a mod that provides flight installed. Allows users to use flight on your server while in Survival mode, if they have a mod that provides flight installed.
No effect in Creative mode. No effect in Creative mode.
### ANNOUNCE_PLAYER_ACHIEVEMENTS ## ANNOUNCE_PLAYER_ACHIEVEMENTS
- default: true - default: true
Whether there is a server announcment when a player gets an achievement. Whether there is a server announcment when a player gets an achievement.
### MAX_WORLDSIZE ## MAX_WORLDSIZE
- default: 29999984 - default: 29999984
This sets the maximum possible size in blocks, expressed as a radius, that the world border can obtain. This sets the maximum possible size in blocks, expressed as a radius, that the world border can obtain.
### LEVEL_TYPE ## LEVEL_TYPE
- default: DEFAULT - default: DEFAULT
One of: One of:
@ -66,47 +66,47 @@ One of:
- AMPLIFIED: Same as default but world-generation height limit is increased. - AMPLIFIED: Same as default but world-generation height limit is increased.
- CUSTOMIZED: Same as default unless generator-settings is set to a preset. - CUSTOMIZED: Same as default unless generator-settings is set to a preset.
### MAX_BUILD_HEIGHT ## MAX_BUILD_HEIGHT
- default: 256 - default: 256
The maximum height in which building is allowed. Terrain may still naturally generate above a low height limit. The maximum height in which building is allowed. Terrain may still naturally generate above a low height limit.
### SPAWN_NPCS ## SPAWN_NPCS
- default: true - default: true
Determines whether villagers will be spawned. Determines whether villagers will be spawned.
### SPAWN_ANIMALS ## SPAWN_ANIMALS
- default: true - default: true
Determines if [animals](http://minecraft.gamepedia.com/Mob#Passive) will be able to spawn. Determines if [animals](http://minecraft.gamepedia.com/Mob#Passive) will be able to spawn.
### SPAWN_MONSTERS ## SPAWN_MONSTERS
- default: true - default: true
Determines if monsters will be spawned. Determines if monsters will be spawned.
### GENERATE_STRUCTURES ## GENERATE_STRUCTURES
- default: true - default: true
Defines whether [structures](http://minecraft.gamepedia.com/Generated_structures) will be generated. Defines whether [structures](http://minecraft.gamepedia.com/Generated_structures) will be generated.
### WHITELIST ## WHITELIST
- default: false - default: false
Whether the whitelist is used. Whether the whitelist is used.
### HARDCORE ## HARDCORE
- default: false - default: false
If set to true, players will be set to spectator mode if they die. If set to true, players will be set to spectator mode if they die.
### PVP ## PVP
- default: true - default: true
Whether PvP is enabled. Whether PvP is enabled.
### DIFFICULTY ## DIFFICULTY
- default: 2 - default: 2
Defines the [difficulty](http://minecraft.gamepedia.com/Difficulty) of the server. Defines the [difficulty](http://minecraft.gamepedia.com/Difficulty) of the server.
@ -117,7 +117,7 @@ One of:
- 2: Normal - 2: Normal
- 3: Hard - 3: Hard
### GAMEMODE ## GAMEMODE
- default: 0 - default: 0
Defines the [mode of gameplay](http://minecraft.gamepedia.com/Gameplay#Game_modes). Defines the [mode of gameplay](http://minecraft.gamepedia.com/Gameplay#Game_modes).
@ -128,43 +128,43 @@ One of:
- 2: Adventure - 2: Adventure
- 3: Spectator - 3: Spectator
### ONLINE_MODE ## ONLINE_MODE
- default: true - default: true
Whether to authenticate players with the mojang database. Disable it when running behind bungeecord. Whether to authenticate players with the mojang database. Disable it when running behind bungeecord.
### PLAYER_IDLE_TIMEOUT ## PLAYER_IDLE_TIMEOUT
- default: 0 - default: 0
If non-zero, players are kicked from the server if they are idle for more than that many minutes. If non-zero, players are kicked from the server if they are idle for more than that many minutes.
### MAX_PLAYERS ## MAX_PLAYERS
- default: 20 - default: 20
The maximum number of players that can play on the server at the same time. The maximum number of players that can play on the server at the same time.
### VIEW_DISTANCE ## VIEW_DISTANCE
- default: 10 - default: 10
Sets the amount of world data the server sends the client, measured in chunks in each direction of the player (radius, not diameter). Sets the amount of world data the server sends the client, measured in chunks in each direction of the player (radius, not diameter).
### BUNGEECORD ## BUNGEECORD
- default: false - default: false
Whether the server runs behind a bungeecord instance. Whether the server runs behind a bungeecord instance.
### MIN_RAM ## MIN_RAM
- default: 512M - default: 512M
Minimal heapsize for the jvm. Minimal heapsize for the jvm.
### MAX_RAM ## MAX_RAM
- default: 512M - default: 512M
Maximal heapsize for the jvm. Maximal heapsize for the jvm.
## Ports # Ports
- 25565 - 25565
## Capabilities # Capabilities
- CHOWN - CHOWN
- DAC_OVERRIDE - DAC_OVERRIDE
- FOWNER - FOWNER