Table of Contents

1. Introduction

2. Conventions

3. Quickies

3.1 Starting up the server
3.2 Setting the admin and super admin passwords
3.3 Setting up a countdown on your pub
3.4 Setting up the server for Instantkill Railwar
3.5 Setting up Intermission Wars

4. Server Commands

4.1 Setting up administrator passwords
4.2 Open server commands (non-admin commands)
4.2.1 callvote bw_elect
4.2.2 bw_help
4.2.3 bw_time
4.2.4 bw_players
4.2.5 bw_admin
4.2.6 bw_scores
4.3 Admin server commands
4.3.1 bw_match
4.3.2 bw_start
4.3.3 bw_end
4.3.4 bw_lock
4.3.5 bw_unlock
4.3.6 bw_move
4.3.7 bw_allspec
4.3.8 bw_kick
4.3.9 bw_timelimit
4.3.10 bw_fraglimit
4.3.11 bw_capturelimit
4.3.12 bw_dmflags
4.3.13 bw_gametype
4.3.14 bw_restart
4.3.15 bw_map

5. Client Features

5.1 Enhanced scoreboards
5.2 Remaining time
5.3 Teamate ID

6. Additional gametypes

6.1 Weapon wars
6.1.1 bw_war_sg
6.1.2 bw_war_gl
6.1.3 bw_war_rl
6.1.4 bw_war_lg
6.1.5 bw_war_rg
6.1.6 bw_war_rg1shot
6.1.7 bw_war_pg
6.1.8 bw_war_bfg
6.2 InstantKill Railwar
6.3 Intermission wars

7. Misc Features

7.1 Public Countdown
7.2 Team rail color
7.3 BFG banning

8. New cvars

8.1 Server cvars
8.2 Client cvars

9. Sample configuration files and Server Startup


10. Contact Info



1. Introduction


The Bloodwolf Match Mod is a quake 3: Arena modification that provides a rich feature set for playing clan matches. It also provides with teamplay enchancement features and some nifty features for pubs (railwars, intermission wepaon wars, countdowns, etc.)

The Bloodwolf Match Mod works as a SERVER SIDE mod. *BUT*, there is also an optional Bloodwolf client available. However you should all download it. It is labeled 'optional' only because you don't need it to play on a bloodwolf server. But it provides features such as:

Right now, when a client connects to a bloodwolf server without the bloodwolf client, with an improper version of the client or without having launched quake 3: Arena with the '+set fs_game bloodwolf' parameter, he will be given a message indicating a possible bad config or a missing component, and the URL where to find the client mod and instructions.

When id software implements autodownload, this will not be necessary anymore. All clients will automatically receive the client mod.

The Bloodwolf Match Mod works with all gametypes. You do not need (obviously!) a different qvm for each gametype. However, you will not really need any bloodwolf features for tourney mode: id's tourney mode is fine as it is.



2. Conventions


All Bloodwolf commands start with '/bw_', and all Bloodwolf related cvars start with 'bwc_'. This will prevent future name clashing with any new id software commands, and also draws a clear line between Bloodwolf and id related commands and cvars.

BW Command examples:

/bw_kick, /bw_admin, /bw_match, /bw_start

BW cvar examples:

bwc_bfgban, bwc_interwar, bwc_pwd, bwc_superpwd



3. Quickies


Please note that the mod comes packaged with a few .cfg files that require minimal modifications to setup your server (one of them comes ready for setting up your server for instantkill railwar).

3.1. Starting up the server

To quickly start up your server, jump to section 9. Remember to edit the configuration files with your own passwords (if you don't it's not dangerous since there simply won't be any bloodwolf admin password, but you won't be able to authenticate).


3.2. Setting the admin and super admin passwords

To quickly configure administrator passwords, jump to section 4.1.


3.3. Setting up a countdown on your pub

To setup a countdown on your server at the start of each game (which gives players with slower machines time to connect before the game starts), jump to section 7.1.

(note that by default there is a 45 seconds countdown).


3.4. Setting up the server for Instantkill Railwar

If you want to setup your server for instantkill railgun war, jump to section 6.2.

The railwar.cfg file package with the mod is pre-configured to run your server as an instantkill railwar server.


3.5. Setting up Intermission Wars

To setup intermission wars on your server, jump to section 6.3.


This wraps up the quickies. What follows is a complete documentation of all bloodwolf commands.



4. Server Commands

IMPORTANT: Remember to ALWAYS preceed your commands with a '/'.


4.1. Setting up administrator passwords

In this version, there is no advanced admininistrator permission configuration. There are two ways to gain administrator rights, and both ways grant the same rights (except for the superadmin as we will see below):

/bw_admin checks against the bloodwolf admin password, which has nothing to do with the rcon password. There are two admin passwords:

To set those two passwords, simply give a value to each of the two cvars in your config file (or command line). Example:

seta bwc_superpwd gaga412
seta bwc_pwd gamma33


4.2 Open server commands (non admin commands)

This section describes the commands available to everyone, not only administrators.


4.2.1. callvote bw_elect

/callvote bw_elect

'callvote' is not a Bloodwolf specific command, but bw_elect is a new command you can vote on. When calling this command, and provided voting is allowed on the server, clients will be asked to vote for YOUR election to administrator (you cannot be elected as superadmin).

Remember to enable voting on your server by doing:

seta g_allowvote 1


4.2.2. bw_help

/bw_help

Will bring up a help text in the console.


4.2.3. bw_time

/bw_time

Will print the remaining time to the game in the console.


4.2.4. bw_players

/bw_players

Will print all clients (including bots) in the console, with their ping, score, client number and name.

The client number is very useful for kicking players with undecipherable names!

In team modes, player names are printed in the color of their team. You are printed in yellow. Players who have been authenticated as admins or superadmins will have a mention next to their name.


4.2.5. bw_admin

/bw_admin password

This is used to authenticate your admin rights. You either enter the admin or superadmin password.


4.2.6. bw_scores

/bw_scores

This command is specific to the Capture The Flag game mode.

/bw_scores will print the caps/frags for the red and blue teams. This is useful since the original q3 ctf does not even keep track of the frags. Many gaming leagues and ladders determine the winner with frags in case of cap equality.

If you have the bloodwolf client, you will automatically see the frags for each team on the new scoreboard.


4.3. Admin server commands

4.3.1. bw_match

/bw_match

This will enter the server in the match setup state. Scores are reset, and all players (not specs) are put in a ghost-like state (which is like spec but without clipping - they can go through walls).

All weapons, powerups and other items are reset. The timers are reset (if there is a timelimit).

Whether they have the bloodwolf client or not, all players are given visual feedback about the current state. Information will be printed in the center of their screen. The display will be something like:

Match setup mode
Teams UNLOCKED
Timelimit 20

Additionally, players who have the bloodwolf client will see a detailed list of the various server flags (dm flags, capture limit, frag limit, etc).

From here, you can call bw_end to end the match (without even having starting it in fact) and 'bw_start' to start the match with a countdown.


4.3.2. bw_start

/bw_start [seconds]

For this command to work, you must be in match setup mode. (see bw_match). This will start a countdown that will last [seconds] seconds, after which the game will start and all players will be spawned.

When the game ends, all players are spawned into the ghost-like state once again. The game will stay in a 'linger' mode to give people time to take note of the team and individual scores (which can be important for match reporting). When the 'bw_end' command is issued, or when all administrators leave, the server will go into pub mode again and all players will be spawned in a fresh game.


4.3.3. bw_end

/bw_end

Stops a match if the game is in match setup mode or during a match. All scores and objects are reset and the server goes back into pub mode.


4.3.4. bw_lock

/bw_lock

Locks the teams. The only team change allowed will be from any team to spectator.

Very useful command during matches. Sometimes newbies connect to a server during a game and join one of the team, without realizing that this is a match!


4.3.5 bw_unlock

/bw_unlock

Unlocks the teams.


4.3.6. bw_move

/bw_move [player] [team]

This will move a player to the team you specified.

You can use partial name matching. So if you want to move '{^^}monster' to a spectator, you can type /bw_move mons spectator. You can also use 's' instead of 'spectator'.

The valid teams are (without the quotes):

'blue' for blue team
'red' for red team
's' or 'spectator' for spectator
'free' for free, but 'red' and 'blue' yield the same result.


4.3.7 bw_allspec

/bw_allspec

Moves all players to spectators. One case where this command can be useful is when you are trying to organize a match but no one is listening and/or everyone keeps playing. Just put them all to specs and from this point you can reorganize the teams!


4.3.8. bw_kick

/bw_kick [clientnum/clientname]

This command will kick a client. You can use the client number as the parameter (which you can obtain with the /bw_players command) or the client's name (partial names are accepted).


4.3.9. bw_timelimit

/bw_timelimit [value]
/bw_timelimit

Sets the timelimit. Give the timelimit as a parameter. A timelimit of 0 means no timelimit.

Calling the /bw_timelimit command without a value will print the current timelimit.


4.3.10 bw_fraglimit

/bw_fraglimit [value]
/bw_fraglimit

Sets the fraglimit. Give the fraglimit as a parameter. A fraglimit of 0 means no fraglimit.

Calling the /bw_fraglimit command without a value will print the current fraglimit.


4.3.11 bw_capturelimit

/bw_capturelimit [value]
/bw_capturelimit

Sets the capturelimit. Give the capturelimit as a parameter. A capturelimit of 0 means no capturelimit.

Calling the /bw_capturelimit command without a value will print the current capturelimit.


4.3.12 bw_dmflags

/bw_dmflags [value]
/bw_dmflags

Sets the dmflags. Give the dmflags you want as a parameter.

Calling the /bw_dmflags command without a value will print the current dmflags.


4.3.13 bw_gametype

/bw_gametype [value]
/bw_gametype

Sets the gametype. Changes only take effect on game restart (which you can do with /bw_restart). The possible values are:

0: Free for All
1: Tournament
3: Team deathmatch
4: Capture the flag

Note that the Bloodwolf Matchmod does not allow you to set the gametype to single player (obviously).


4.3.14 bw_restart

/bw_restart

Will restart the map. You should issue this command if you have changed the gametype (unless your also changing maps).


4.3.15. bw_map

/bw_map [mapname]

Changes the map to 'mapname'. Must be a valid map. If you want to change to a map that is meant for a different gametype then the current gametype, you should issue a /bw_gametype call before to set the game to the appropriate gametype (see /bw_gametype).



5. Client Features


This section explains the various features offered by the client side bloodwolf mod. If the server you are connecting to has autodownload and you have autodownload, you will automatically have the client side mod. If either you or the server doesn't have (or hasn't set) autodownload, you will be displayed a message indicating where you should download the client side mod.


5.1 Enhanced scoreboards

The bloodwolf scoreboards are roomier then the original ones. The teams are displayed in columns so no longer do the losing team's members dissappear in the case of very large games.

In capture the flag, both frags AND caps are displayed for each team.

Actually, check out this screenshot.


5.2 Remaining time

A timer with the remaining time will be displayed on the right of your screen. The time is displayed in minutes as long as there is more then a minute of time left. The display then switches to seconds when there is less then a minute left.

As for colors, the time is displayed in green when there is more then a minute remaining, and in cyan when there is less then a minute remaining.


5.3 Teamate ID

In the original q3, when you point at a player, his name is displayed under your crosshair.

With the bloodwolf client, if the player in your crosshair is in your team, you will also see his health, armor and his current weapon.



6. Additional gametypes


6.1 Weapon wars

At any point, you can enter the weapon wars game mode. Weapon wars is actually not a game mode by itself, you can just call it at any point and every player will be given only one weapon, infinite ammo, health and armor. You can play CTF (and any other game type as a matter of fact) with weapon wars!

All other weapons and ammo are removed from the level.

This can be pretty fun, and actually pretty useful for clans wanting to practice a perticular weapon. Here are the commands for each weapon:


6.1.1 bw_war_sg

/bw_war_sg

Shotgun war.


6.1.2 bw_war_gl

/bw_war_gl

Grenade launcher war. In this mode you have grenades bouncing all over.


6.1.3 bw_war_rl

/bw_war_rl

Rocket launcher war.


6.1.4 bw_war_lg

/bw_war_lg

Lightning gun war. Coming from a quake 2 background, I found this mode to be good practice since I had never used such a weapon before.


6.1.5 bw_war_rg

/bw_war_rg

Railgun war.


6.1.6 bw_war_rg1shot

/bw_war_rg1shot

Instant kill railgun (also refered to as 1 shot 1 kill railgun war, sorry for my apparent lack of consistancy!)

This is definitely very fun.


6.1.7 bw_war_pg

/bw_war_pg

Plasmagun war.


6.1.8 bw_war_bfg

/bw_war_bfg

BFG war. Yes you heard it right. Everyone with a BFG and infinite ammo.


6.2 InstantKill Railwar

If you want your server to exclusively play instantkill railwar matches, set the bwc_railwar cvar to 1:

seta bwc_railwar 1

Players will spawn with infinite ammo, and every railgun hit will result in instant death.

When in railwar mode, intermission wars do not occur at the end of a game, even if you set your bwc_interwar cvar to 1.

Note: Instantkill railwar is a blast!


6.3 Intermission wars

This is something that can definitely add some originality to your pub.

The intermission war is a last man (or team) standing competition with a weapon "theme" (which is simply one of the weapon wars being activated, please see the weapon wars section).

The intermission war starts after a pub game is finished (not a match). Players will see the normal intermission screen, and when enough of them press ready, the intermission war starts.

When a player is killed he is moved to a spectator. When only one player remains in last man standing, or only one team remains in last team standing, the intermission war ends.

You can setup the intermission war with always the same weapon, or with a random weapon.

To activate intermission wars, set the bwc_interwar cvar to 1 in your config file:

seta bwc_interwar 1

To set the weapon, set the bwc_interwep cvar to one of them weapon war codes (sg, gl, rl, lg, rg, bfg) or you can set it to a random weapon for each level by setting the cvar to rand. If this cvar is not set, the default weapon is rail. Example:

seta bwc_interwep rand



7. Misc features


7.1 Pub countdown

Loading a quake3 map is a very long process, especially on slower machines. When the server switches to a new map, players with fast machines will enter the game much quicker then players with slow machines, and will gain an advantage from that.

To correct this situation you can set a countdown:

seta bwc_pubcount 45

This will cause the server to generate a countdown of 45 seconds before the game starts. Players will be in a ghost-like state until the game starts, at which point they will be spawned in the level.

Setting bwc_pubcount to 0 will disable to pub count.

Also please note that this has nothing to do with the match countdown that is part of the match administration features.


7.2. Team rail color

This feature only works in team games (if activated). It changes players rail trails colors to the color of their team. So all red players will fire red trails and all blue players will fire blue trails.


7.3. BFG Banning

If bwc_bfgban is set to 1, at the start of each level, every bfg and every bfg ammo will be removed from the level. If you activate this cvar during a game, you will have to restart the game (/bw_restart) in order for it to take effect.



8. New cvars


The following new cvars are defined by the Bloodwolf mod:

8.1. Server cvars

bwc_pubcount
Default: 45
Whether or not there should be a pub countdown. If set to 0, there will NOT be a countdown. Otherwise, the value will be the countdown in seconds.

bwc_railwar
Default: 0
If set to 1, your server will become an instant kill railwar server. (see section 6.2)

bwc_interwar
Default: 1
If set to 1, after each game, an intermission weapon war will start. (see section 6.4)

bwc_interwep
Default: rand
The weapon to be used in the intermission weapon war. (see section 6.3)

bwc_railcolor
Default: 1
Rail trails will take the color of the player's team. (see section 7.2)

bwc_bfgban
Default: 0
Bans the BFG. (see section 7.3)


8.2. Client cvars

bwc_drawid
Default: 1
Determines whether or not teammate / enemy id is enabled. A value of 1 will enable this option. While enabled, this will show the name or the person in your crosshairs in the center of the screen. If this person is on your team you will also be able to see his health, armor and currently selected weapon.

bwc_drawtime
Default: 1
When set to 1, this will display the time remaining on the map in the upper right of the screen. If the time limit is set to unlimited, the time will not be displayed.



9. Sample configuration files and Server Startup


The mod comes packaged with a few configuration files. Among them, railwar.cfg (which will turn your server into an instantkill railwar server) and standard.cfg (which is the standard one you should use).

These configuration files should be in the /bloodwolf dir, under your quake3 dir. The bloodwolf dir should be a sibling to baseq3 (same deepness). You don't really have to worry about that anyway since if you extract the zip or tar under quake3, the configuration files will automatically go under /bloodwolf.

To startup the bloodwolf mod, run your server like so:

quake3.exe +dedicated 2 +set fs_game bloodwolf +exec standard.cfg

(remember to edit the passwords in the configuration file your are using)

A dedicated value of "2" will advertise your server. If you want to keep your server private, change that value to "1".

To run your server as an instantkill railwar server, just replace "standard.cfg" with "railwar.cfg".

The instructions should vary slightly under linux (notably the executable name), but if you're running linux, you can probably manage on your own.

If you are running the server without the CD, add the following to your command line:

+set bot_enable 0

I don't have a mac or access to a mac. If you want to contribute mac specific instructions please email me.

10. Contact Information

For any questions regarding this manual, the mod in general, or trouble with setting up your server, please email sting.