You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Add tournament and gameplay docs, update commands and cvars
Added new documentation for gameplay balance, gametypes/modifiers, monsters, spawn points, and tournaments. Updated command and cvar references for new tournament and practice features, clarified map system fields, and improved documentation structure and terminology throughout. Code and menu changes support new tournament logic, forfeit voting, and expanded admin tools.
Copy file name to clipboardExpand all lines: README.md
+4-9Lines changed: 4 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,9 +28,9 @@ It dramatically extends entity and gameplay support, integrates modern competiti
28
28
**WORR** transforms QUAKE II’s multiplayer into a flexible, competitive, and feature-rich platform.
29
29
30
30
#### Gametypes
31
-
-**18 competitive gametypes plus Practice Mode**, including:
31
+
-**18 competitive gametypes plus a practice format**, including:
32
32
-*Duel, Domination, Head Hunters, Clan Arena, Freeze Tag* and more
33
-
-*Practice Mode* for no-score warmups with self-damage disabled
33
+
-*Practice format* for no-score warmups
34
34
35
35
#### Game Modifiers
36
36
- Unique match modifiers such as:
@@ -53,14 +53,9 @@ It dramatically extends entity and gameplay support, integrates modern competiti
53
53
- Dynamic **match announcer** for event feedback
54
54
-**QUAKE** and **QUAKE III: ARENA-style rulesets** that auto-apply during compatible maps
55
55
56
-
## Documentation & Wiki
57
-
- Browse the [WORR Knowledge Base](https://github.com/themuffinator/WORR-kex/wiki) for persona guides, cvar/command references, and feature overviews tailored to hosts, players, designers, and programmers. See [wiki/Home.md](wiki/Home.md) for the source file.
58
-
- Markdown sources for the live wiki live in the repository's [wiki/](wiki/) folder so documentation changes can travel alongside code updates.
59
-
60
-
---
61
-
62
56
## Documentation
63
-
-**[WORR Wiki](docs/wiki/index.md)** - Persona-focused guides for server hosts, players, level designers, and programmers, plus links to broader reference material.
57
+
-**[WORR Knowledge Base](docs/wiki/index.md)** - Persona-focused guides for server hosts, players, level designers, and programmers, plus links to broader reference material.
58
+
-**GitHub Wiki** - Published copy of the knowledge base for quick browsing: https://github.com/themuffinator/WORR-kex/wiki (mirrors `docs/wiki/` via `wiki/`).
64
59
- Additional technical references live throughout the [`docs/`](docs/) directory, including changelog comparisons and versioning policy.
65
60
66
61
> WORR does not currently ship a standalone web UI. To browse the wiki, open the Markdown files directly in your editor or render them with your preferred static site tooling.
Copy file name to clipboardExpand all lines: docs/headhunters.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ Head Hunters is a WORR multiplayer mode that rewards risk management and map awa
6
6
7
7
-**Heads on death.** Each player drops every head they were holding when eliminated. The server spawns physical skull pickups that can be scooped up by anyone in play.
8
8
-**Carry limit.** Players may hold up to 20 heads at a time; attempting to grab more while at the cap ignores the pickup.
9
-
-**Deposit to score.** Touching a receptacle while carrying heads awards triangular scoring—`1 + 2 + … + n`—so bigger runs pay off exponentially (e.g., 3 heads = 6 points, 5 heads = 15). The deposit also resets the carrier’s held heads and triggers the receptacle spike display.
9
+
-**Deposit to score.** Touching a receptacle while carrying heads awards triangular scoring-`1 + 2 + ... + n`-so bigger runs pay off exponentially (e.g., 3 heads = 6 points, 5 heads = 15). The deposit also resets the carrier's held heads and triggers the receptacle spike display.
10
10
-**HUD feedback.** While Head Hunters is active, the HUD exposes the number of heads you currently hold so you know when it is safe to bank or keep hunting.
Copy file name to clipboardExpand all lines: docs/wiki/commands.md
+26-6Lines changed: 26 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -56,10 +56,14 @@ These flags appear in each `RegisterCommand` call alongside the handler function
56
56
-*Syntax:*`end_match`
57
57
-*Permissions:* Admin-only; usable while spectating or during intermission.
58
58
-*Example:*`\end_match`
59
-
-**`reset_match`**— Restarts the live match after confirming it has begun and is not already at intermission.
59
+
-**`reset_match`**- Restarts the live match after confirming it has begun and is not already at intermission.
60
60
-*Syntax:*`reset_match`
61
61
-*Permissions:* Admin-only; usable while spectating or during intermission.
62
62
-*Example:*`\reset_match`
63
+
-**`replay`** - Replays a specific tournament game in the current match set (confirmation required).
64
+
-*Syntax:*`replay <game#> [confirm]`
65
+
-*Permissions:* Admin-only; usable while spectating or during intermission.
66
+
-*Example:*`\replay 2 confirm`
63
67
-**`map_restart`** — Issues a `gamemap` reload for the current BSP, effectively soft-restarting the server session.
64
68
-*Syntax:*`map_restart`
65
69
-*Permissions:* Admin-only; usable while spectating or during intermission.
@@ -103,10 +107,10 @@ These flags appear in each `RegisterCommand` call alongside the handler function
103
107
-*Syntax:*`arena [number]`
104
108
-*Permissions:* Admin-only; callable while spectating (intermission restricted).
105
109
-*Example:*`\arena 3`
106
-
-**`gametype`**— Lists available gametypes on `?` and switches modes when supplied a valid identifier; use `practice` for no-score warmups with self-damage disabled.
110
+
-**`gametype`**- Lists available gametypes on `?` and switches modes when supplied a valid identifier; `none` sets a no-score ruleset (also disables self-damage). For persistent warmup sessions, set `g_practice 1`.
107
111
-*Syntax:*`gametype <name>`
108
112
-*Permissions:* Admin-only; usable while spectating or during intermission.
109
-
-*Example:*`\gametype practice`
113
+
-*Example:*`\gametype duel`
110
114
-**`ruleset`** — Shows the active ruleset and applies a new one by identifier, updating the `g_ruleset` cvar.
111
115
-*Syntax:*`ruleset <q1|q2|q3a>`
112
116
-*Permissions:* Admin-only; usable while spectating or during intermission.
@@ -142,19 +146,35 @@ These flags appear in each `RegisterCommand` call alongside the handler function
142
146
-*Syntax:*`forfeit`
143
147
-*Permissions:* Usable while dead; flood-exempt.
144
148
-*Example:*`\forfeit`
145
-
-**`timeout`** / **`timein`**— Starts a timeout (respecting per-player limits) or ends one if called by the owner or an admin.
149
+
-**`timeout`** / **`timein`**- Starts a timeout (respecting per-player limits) or ends one if called by the owner or an admin.
146
150
-*Syntax:*`timeout` / `timein`
147
151
-*Permissions:* Usable while dead or spectating.
148
152
-*Example:*`\timeout`
149
-
-**`timer`**— Toggles the HUD match timer widget for the caller.
153
+
-**`timer`**- Toggles the HUD match timer widget for the caller.
150
154
-*Syntax:*`timer`
151
155
-*Permissions:* Usable while dead or spectating.
152
156
-*Example:*`\timer`
153
-
-**`putaway`**— Closes active menus, scoreboards, and help screens, restoring the regular HUD.
157
+
-**`putaway`**- Closes active menus, scoreboards, and help screens, restoring the regular HUD.
154
158
-*Syntax:*`putaway`
155
159
-*Permissions:* Usable while spectating.
156
160
-*Example:*`\putaway`
157
161
162
+
### Tournament veto tools
163
+
164
+
- Tournament vetoes are menu-driven; captains (or the home/away players in FFA) can still use the commands below when needed.
165
+
-**`tourney_pick`** - Selects a map for the tournament series during the veto phase (captain only).
166
+
-*Syntax:*`tourney_pick <mapname>`
167
+
-*Permissions:* Usable while dead or spectating.
168
+
-*Example:*`\tourney_pick q2dm1`
169
+
-**`tourney_ban`** - Bans a map from the tournament series during the veto phase (captain only).
170
+
-*Syntax:*`tourney_ban <mapname>`
171
+
-*Permissions:* Usable while dead or spectating.
172
+
-*Example:*`\tourney_ban q2dm2`
173
+
-**`tourney_status`** - Prints the current tournament pool, picks, bans, and whose turn is next.
174
+
-*Syntax:*`tourney_status`
175
+
-*Permissions:* Usable while dead or spectating.
176
+
-*Example:*`\tourney_status`
177
+
158
178
### Spectating and camera tools
159
179
160
180
-**`follow`** — As a spectator, lock the camera onto a named or numbered player after validating they are active.
0 commit comments