Skip to content

Commit 3011fca

Browse files
Update config settings with detailed explanations (#603)
* Update config settings with detailed explanations Improved clarity for new users editing the config.yml. * Update config.yml Clarify fake death and outside arena damage options * Clarify damage settings for arena boundaries Updated comments for clarity on damage mechanics outside the arena boundaries.
1 parent d781395 commit 3011fca

File tree

1 file changed

+51
-3
lines changed

1 file changed

+51
-3
lines changed

docs/config.md

Lines changed: 51 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,17 +26,40 @@ prevent-killing-villagers: true
2626
compass-enabled: true
2727
# should BedWars join the player to a random team when he joins the lobby?
2828
join-randomly-on-lobby-join: false
29+
# Should a wool block be given to the player when joining the lobby?
2930
add-wool-to-inventory-on-join: true
31+
# Prevent natural mob spawning in the arena world
32+
# (zombies, skeletons, etc.)
3033
prevent-spawning-mobs: true
34+
# Enable holograms above resource generators
35+
# Displays resource type and possibly countdown
3136
spawner-holograms: true
37+
# Disable merging of dropped resource items
38+
# true = items stay separate
39+
# false = items stack together
3240
spawner-disable-merge: true
41+
# Prevent mob spawning within a specific radius around the lobby spawn
42+
# Value is measured in blocks
3343
prevent-lobby-spawn-mobs-in-radius: 16
44+
# Vertical offset of generator holograms (in blocks)
45+
# Adjust if holograms appear too high or too low
3446
spawner-holo-height: 0.25
47+
# Show countdown timer in generator holograms
48+
# true = shows time until next resource spawn
3549
spawner-holograms-countdown: true
50+
# Allow players to take damage when outside the arena boundaries.
51+
# This includes falling into the void, walking past the arena border, etc.
52+
# True = players take damage normally outside the arena and can die if they don't return quickly.
53+
# False = damage is handled differently, but players can still die in extreme cases (e.g., void fall).
3654
damage-when-player-is-not-in-arena: false
55+
# Remove unused target blocks (beds/anchors) automatically
56+
# Helps keep arena clean after rebuild
3757
remove-unused-target-blocks: true
58+
# Allow sand/gravel and similar blocks to fall naturally
3859
allow-block-falling: true
60+
# Enable giving predefined items at game start
3961
game-start-items: false
62+
# Enable giving predefined items on player respawn
4063
player-respawn-items: false
4164
# When game-start-items is enabled, the player is going to get all items listed in the following list.
4265
# Example:
@@ -48,23 +71,43 @@ player-respawn-items: false
4871
# - leather_chestplate
4972
gived-game-start-items: []
5073
gived-player-respawn-items: []
74+
# Disable hunger depletion inside arenas
75+
# true = players do not lose hunger
76+
# false = normal hunger mechanics apply
5177
disable-hunger: false
78+
# Automatically apply team colors to items in the shop GUI
5279
automatic-coloring-in-shop: true
80+
# Allow players to purchase up to 64 items at once
81+
# when using SHIFT + click in the shop GUI
5382
sell-max-64-per-click-in-shop: true
83+
# Allow administrators to use /bw cheat | /bw cheatIn in game
5484
enable-cheat-command-for-admins: false
85+
# Prevent shopkeepers from making any sounds
5586
shopkeepers-are-silent: true
87+
# List of placed block materials that should NOT be destroyed by explosions
5688
destroy-placed-blocks-by-explosion-except: []
89+
# Allow explosions to destroy blocks placed during the game
5790
destroy-placed-blocks-by-explosion: true
91+
# Display a hologram above beds or other target blocks
5892
holo-above-bed: true
93+
# Allow players to join an arena as spectators
5994
allow-spectator-join: false
95+
# Disable default server join/leave messages
6096
disable-server-message:
6197
player-join: false
6298
player-leave: false
99+
# Disable flight for players inside arenas
63100
disable-flight: true
101+
# Configure respawn cooldown settings
64102
respawn-cooldown:
65103
enabled: true
66-
time: 5
104+
time: 5 # Respawn delay in seconds
105+
# Stop team generators when the last player on a team dies
67106
stop-team-spawners-on-die: false
107+
# Enables "fake death" handling for plugin compatibility with Via*, Geyser, and other proxies.
108+
# When enabled, normal respawn logic is skipped, preventing the standard "You Died" screen.
109+
# Example: player falls into the void, inventory cleared, teleported to spectator spawn,
110+
# but no death screen appears. Useful to avoid conflicts with other plugins.
68111
allow-fake-death: false
69112
# Whether or not should 1.19.4 display entities be used or not. Does work only on 1.19.4+
70113
prefer-1-19-4-display-entities: true
@@ -73,11 +116,13 @@ use-chunk-tickets-if-available: true
73116
reset-full-spawner-countdown-after-picking: true
74117
players-can-win-game-only-after-seconds: 0
75118
disable-locator-bars-in-arena-worlds: true
119+
# Prevent players from opening other teams' shopkeepers
76120
disable-opening-stores-of-other-teams: false
77121
disable-waterlogging-of-original-blocks: false
122+
# Kick players after final death instead of keeping them as spectators
78123
kick-players-upon-final-death:
79124
enabled: false
80-
delay: 5
125+
delay: 5 # In seconds
81126
allowed-commands: []
82127
change-allowed-commands-to-blacklist: false
83128
bungee:
@@ -357,6 +402,9 @@ chat:
357402
all-chat: '[ALL] '
358403
team-chat: '[TEAM] '
359404
death-chat: '[DEATH] '
405+
# Disable all chat messages for spectators
406+
# false = spectators can send messages in the main chat like normal players with prefix [DEATH]
407+
# true = spectators can only use the spectator chat; their messages won't appear in the main game chat
360408
disable-all-chat-for-spectators: false
361409
rewards:
362410
enabled: false
@@ -671,4 +719,4 @@ game-effects:
671719
BLUE: 255
672720
GREEN: 255
673721
type: BALL # effect type
674-
```
722+
```

0 commit comments

Comments
 (0)