INTRODUCTION
The UFT Basic Server Config Pak is a small collection of game modes and a launcher script for Ultra Freeze Tag. The game modes are based on the Absolute Zero Freeze League (AZFL) Certified Server Configs. These configs are provided to the gaming community as an example of how to create a multi-config environment in Ultra Freeze Tag and in the hope that it will help foster standards for all community servers.
The UFT Basic Server Config Pak assumes Quake III Arena is installed and the 1.32c patch has been applied. Build 60 of the Ultra Freeze Tag mod is required.
CONTENTS [TOP]
The UFT Basic Server Config Pak consists of a launcher script, a set of votable config files, a set of map-config files, a set of PunkBuster configuration files, and a set of files for an in-game help system. A number of individual custom maps are required but are not supplied with the UFT Basic Server Config Pak.
Server.cfg
The server.cfg file is the launcher script which performs the initial server setup and then calls one of the modes listed below. Any customization to the Quake III environment required by the server hardware or the network infrastructure is made in server.cfg and then those customizations apply to each mode as they are invoked. The server.cfg file is documented via comments so it should be easy to figure out what is going on.
Adminfo.cfg
The admininfo.cfg file is a script which contains the public information cvars and administrative password information for the server. It is called by each mode file to refresh and validate the information as the mode file is loaded. The adminfo.cfg file is documented via comments so it should be easy to figure out what is going on.
Modes
The game modes are actually individual Quake III Arena configuration files that define specific styles of game play within Ultra Freeze Tag. Players are able to use the /CALLVOTE CONFIG command from the console of their game to pick the particular style they wish to play. Four ready-to-play modes are included in the UFT Basic Server Config Pak. The Casual config file is commented so admins can use it as a guide for creating their own config files.
- Casual.cfg – This mode is designed for quick, pick-up games. It is a fun, fast public mode. Settings: 20 minutes, 10 points, up to 5 players per side, no timeouts, no teamnames, no doready. Maps: 6++, ospdm6, ospdm15rc3, overkill, polo3dm5, pro-q3dm6, q3dm7, q3dm8, and teddm1.
- Comp.cfg – This mode designed for "serious" competition. This is one of the competition modes used in AZFL events. Settings: No point limit, 20 minute time limit, up to 4 players per side, teamnames are player set-able, 100% doReady required to start a match, 3 timeouts per side, no delag, no playernudge, no projectilenudge, and no weaponskins. Maps: cpm4, cpm9, cpm14, ospdm6, ospdm15rc3, polo3dm5, pro-q3dm6, q3dm14tmp, and teddm1.
- Insta.cfg –This mode is based on the OGL Quake 3 Insta-Freeze Ladder configuration and is the competition mode used by the Ufreeze Insta OGL Ladder. Settings: 15 minutes, 15 point limit, rail only, up to 5 players per side, server-side delag disabled but votable to on, callvote railjump enabled, grapple on but votable off, friendly fire on but votable off, 100% doReady required to start a match, 3 timeouts per side. Maps: 6++, cpm4, fff, ospdm6, polo3dm5, q3dm3, q3dm6, q3dm7, q3dm8, q3dm13, q3dm14, q3dm16, q3tourney2, and teddm1.
- OGL.cfg – This is the competition mode used by the All Weapons Ufreeze OGL Ladder. Settings: 20 minutes, no point limit, up to 4 players per side, teamnames are player set-able, 100% doReady required to start a match, 3 timeouts per side, no delag but playernudge and projectilenudge are allowed. Maps: 5+, 6++, ci, cpm4, cpm9, cpm14, cpm21, ospdm6, ospdm15rc3, polo3dm5, poq3dm5, pro-q3dm6, q3dm7, q3dm14tmp, and teddm1.
Map-config Files
As Ultra Freeze Tag begins to load a map, either as part of the map rotation script or due to a callvote, it automatically checks for a file called map-default.cfg and for a file called <mapname>.cfg, both in the ufreeze\map-cfgs folder on the server or in the folder specified by “sv_mapcfgdir” in each mode config file. The commands in map-default.cfg and <mapname>.cfg are executed before the map loads. The map-default.cfg file provided with the UFT Basic Server Config Pak simply performs a “writeconfig q3config.cfg” command on the server. Most maps do not have a <mapname>.cfg file but the few that do typically perform a “set wpflags” command to set the spawn weapons for the map.
Each map-cfgs folder will also contain a maplist.txt file. This is a simple text file, similar in layout to the help files (below) that list the available maps in the currently selected mode.
In-game Help
A number of simple text files are included with the UFT Basic Server Config Pak in the HELP directory. When installed in the ufreeze\help directory on the server, these files can be accessed via the Q3A console by typing the /HELP command. The included help files give information about playing Ultra Freeze Tag, general game etiquette, UFT client network settings, UFT client nudge settings, using ProMode skins in UFT, and more. Server administrators are free to expand the help system if they wish.
PunkBuster Support
Server admins implementing the UFT Basic Server Config Pak may use the provided PunkBuster configuration files (pbsv.cfg, pbsvuser.cfg, and pbbans.dat) or create their own configuration files if they wish to add PunkBuster capability to their server. (Check out www.punksbusted.com if you need help with your PunkBuster installation or configuration.)
MAP LIST [TOP]
Maps, of course, go in the server’s baseq3 directory. In addition to the maps supplied with Quake III Arena, the following custom maps are needed to run the map rotations in the modes supplied in this config pak. Individual custom maps can be downloaded from www.planetfreeze.com.
Team Deathmatch Maps (15)
- 5+
- 6++
- ci
- cpm4
- cpm9
- cpm14
- cpm21
- fff
- ospdm6 (Stand-alone version)
- ospdm15rc3
- overkill (Version 2, 08-10-2000 .bsp build date)
- polo3dm5
- poq3dm5
- q3dm14tmp
- teddm1 (Stand-alone version of ospdm5)
INSTALLATION [TOP]
This installation may overwrite parts of the server's default PunkBuster installation! If present, BACKUP the server ban list (pb\pbbans.dat) and the server configuration files (pb\pbsv.cfg and pb\pbsvuser.cfg)! You have been warned!
1) The UFT Basic Server Config Pak assumes the server is running Quake III Arena with the 1.32c patch. If PunkBuster will be used, PunkBuster is assumed to be installed and up-to-date.
2) The UFT Basic Server Config Pak assumes the server has a clean install of build 60 of the Ultra Freeze Tag mod. Only the following files should be in the ufreeze directory on the server.
- pmskins.pk3
- ufreeze-60gfx.pk3
- ufreeze-60core.pk3
- ufreeze-voc.pk3
- wpskins.pk3
3) PK3 files for maps and any skins, models, etc. you wish to include on your server must be placed in the baseq3 directory only. If any map, skin, or model files (with the exception of pmskins.pk3 and wpskins.pk3) are in the ufreeze directory on the server, delete them or move them to the baseq3 directory. Finally, install the required maps in the baseq3 directory now
4) The ufreeze directory on the server may have additional subdirectories present which may contain additional files. Delete all subdirectories in the ufreeze directory on the server, including any files in them. =:O The necessary subdirectories and files will be automatically recreated by the Ufreeze mod or by the UFT Basic Server Config Pak installation process.
5) The UFT Basic Server Config Pak is distributed in a zipped file. Use WinZip, WinRar, 7Zip, or a similar utility to extract the files to the Quake III Arena directory on the server with ‘Use Folder Names’ selected.
The following required files are extracted into the ufreeze directory on the server.
- adminfo.cfg
- server.cfg
These files are extracted to the pb directory on the server.
- pbbans.dat
- pbsv.cfg
- pbsvuser.cfg
The following mode files are extracted into the ufreeze\votecfgs directory on the server.
- casual.cfg
- comp.cfg
- insta.cfg
- ogl.cfg
The following file and folders are extracted into the ufreeze\map-cfgs directory on the server.
- map-default.cfg
- casual directory containing 3 files
- comp directory containing 5 files
- insta directory containing 2 files
- ogl directory containing 7 files
The in-game help system is extracted into the ufreeze\help directory on the server.
- help.txt
- hints.txt
- hud.txt
- hunt.txt
- links.txt
- modes.txt
- network.txt
- nudges.txt
- rules.txt
- skins.txt
Now that all the required files are in place, they must be properly configured. This will require using a text editor (such as Notepad) to edit specific settings and values in the adminfo.cfg file, the server.cfg file, and the mode files in the ufreeze\votecfgs directory.
6) Enter the necessary public information and assign the server passwords in the adminfo.cfg file.
7) Verify the server memory, network settings, client settings, and global bot settings in the server.cfg file are correct for your hardware and network configuration. Pay particular attention to sv_maxclients and sv_privateclients settings and adjust them accordingly so at least 10 (or better yet, 11) public slots are always available.
8) Select the default mode the server will run by uncommenting the appropriate ‘set g_revertconfig’ and ‘exec votecfgs’ lines at the end of the server.cfg file. This is the mode the server will run at boot and that it will revert to after 20 minutes of inactivity. The UFT Basic Server Configs default to OGL mode for these settings.
9) In the UFT Basic Server Configs there are two methods for naming the server and assigning the Message of the Day.
- Method 1 uses a server name that is set once in the server.cfg file and does not change across the various modes while G_MOTD varies slightly and is set in each mode file. If using Method 1, verify the server name is correctly set in the server.cfg file. Appropriate G_MOTD messages are already set in each of the mode files installed on the server. If the server administrator wishes to modify the G_MOTD messages in each mode file, please leave the name of the current mode in the message since this is the only way players have to tell which mode they are currently playing.
- Method 2 changes the server name slightly depending on the mode currently in use on the server but G_MOTD is set once in server.cfg and remains static across all modes. If using Method 2, verify G_MOTD is correctly set in server.cfg and the server name is correctly set in the config files for each of the mode files in ufreeze\votecfgs on the server.
Suggested naming formats and G_MOTD messages are provided for both Method 1 and Method 2 in the server.cfg file and the various mode files, respectively. The UFT Basic Server Configs default to using Method 1 since it is the quickest and easiest for new server administrators to get up and running. Obviously, server administrators are free to choose the method and/or the naming convention they prefer.
10) The installation and configuration process is complete. The server is ready to launch! These commands work for Windows and Linux and will launch the server with a port address of 27960 (scripts for both Windows and Linux which run these commands are included in the ufreeze directory) …
- Windows – quake3.exe +set dedicated 2 +set net_port 27960 +set sv_punkbuster 1 +set vm_game 2 +set fs_game ufreeze +exec server.cfg
- Linux – ./q3ded +set dedicated 2 +set net_port 27960 +set sv_punkbuster 1 +sets gamestartup "`date +"%m-%d-%y %T"`" +set vm_game 2 +set fs_game ufreeze +exec server.cfg
If operating the server on a LAN with no Internet access, use one of the following commands to launch the server with a port address of 27960 …
- Windows – quake3.exe +set dedicated 1 +set net_port 27960 +set sv_punkbuster 1 +set vm_game 2 +set fs_game ufreeze +exec server.cfg
- Linux – ./q3ded +set dedicated 1 +set net_port 27960 +set sv_punkbuster 1 +sets gamestartup "`date +"%m-%d-%y %T"`" +set vm_game 2 +set fs_game ufreeze +exec server.cfg
Also, if PunkBuster is installed and enabled, change ‘PB_SV_LAN 0’ in pb\pbsv.cfg to ‘PB_SV_LAN 1’ when operating the server on a LAN with no Internet access.
11) Frag the weak and hurdle the frozen … Have fun! :)
LINKS [TOP]
www.planetfreeze.com (Get maps here and check for updates to these configs)www.ufreeze.net (Documentation and forums supporting the UFT mod)
www.worldogl.com (The Online Gaming League)
CREDITS [TOP]
AZFL Administrators
- Alien
- Coalshaft
- Wingrdr
AZFL Server Configurators
Whatever those are … ;)- Alien
- Coalshaft
- Ic3-IX
- Lardarse
- Bloodwolf
UFT Programming/Design/Graphics/Development
- Neil 'Haste' Toronto - USA
- Orion 'Borland' Edwards - New Zealand
- Gregory R. 'Lardarse' Payne - United Kingdom
Other Contributions
- arQon for promode skins, promode game integration, and assistance at various stages of development
- Darrell 'Doolittle' Bircsak for the original freezetag mod
- To all UFT server admins and UFT players worldwide, a special thanks for supporting the mod
CHANGE LOG [TOP]
BASICconfigs_071007
- Added – 5+, ci, cpm21, and poq3dm5, to ogl.cfg map rotation
BASICconfigs_060908
- Changed – many things to take advantage of UFT build 60 features
- Removed – all the modes except Casual, Comp, Insta, and OGL (the removed modes will be added to the UFT Advanced Server Config Pak)
BASICconfigs_050613
- Added – polo3dm5 to insta.cfg map rotation
BASICconfigs_050424
- Added – 5+, c2kdm1, ci, poq3dm5, pro-bgmp6, and ts_dm5 to casual.cfg map rotation
- Added – ospctf2, q3ctf2, q3w3, q3w5, q3w7, q3wcp11, q3wcp15, q3wcp17, q3wcp18, and q3wcp22 to ctf.cfg map rotation
- Added – cpm4, cpm9, and ospdm13rc1 to euro.cfg map rotation
- Added – ts_dm5 to insta.cfg map rotation
- Added – 5+, ci (railgun removed), ospdm13rc1, poq3dm5 to ogl.cfg map rotation
- Added – jof3dm2 to 2v2.cfg map rotation
- Changed – "pb_sv_cvar snaps IN 20 40" to "pb_sv_cvar snaps IN 20 60"
- Removed – ospdm11 to 2v2.cfg map rotation
BASICconfigs_050316
- Changed – "pb_sv_cvar cg_fov IN 0 300" to "pb_sv_cvar cg_fov IN 0 140"
BASICconfigs_050228
- Added – cpm9, cpm14, and cpm21 to ogl.cfg map rotation
- Added – Euro.cfg to votecfgs folder
- Added – PunkBuster banlist and MD5tool support
- Changed – Server hostname and MoTD configuration in all modes
- Changed – vote_lagcomp from "0" to "1" in Insta.cfg
BASICconfigs_041124
- Added – pro-dcmap7 and area-52 to 2v2.cfg map rotation
- Changed – g_delagHitscan from "1" to "0" in Insta.cfg
- Changed – g_friendlyFire from "0" to "1" in Insta.cfg
- Changed – g_knockback from "2000 to "1250" in Insta.cfg
- Changed – vote_lagcomp from "1" to "0" in Insta.cfg
BASICconfigs_041117
- Added – Adminfo.cfg file and PunkBuster support to all modes
- Added – 2v2.cfg to votecfgs folder
- Added – ospdm13rc1 (will all weapons) to map rotation in Casual.cfg
- Changed – g_hardcore from "1" to "0" in Casual.cfg
- Changed – Insta.cfg to make gameplay more like OGL Insta-freeze style
- Changed – Insta map rotation significantly
- Removed – OGL-specific ref_password and sv_privatepassword from OGL.cfg
- Removed – q3dm10 and q3dm11 from map rotation in Casual.cfg
BASICconfigs_041105
- Added – Ogl.cfg to votecfgs folder
- Added – Vote_huntmode "1" to Casual.cfg
- Removed – Hunt.cfg from BASIC Config Pak
- Removed – Open.cfg from BASIC Config Pak
BASICconfigs_041017
- Added – CTF.cfg in votecfgs folder
- Added – Hunt.cfg in votecfgs folder
BASICconfigs_041011
- Changed – wpflags on q3dm8 from 127 to 111 in Casual.cfg
BASICconfigs_041009
- Changed – Stylesheet formatting in ReadMe.htm
- Changed – Legal statement and copyright info
BASICconfigs_041008
- Added – Change log to ReadMe.htm
- Added – Even more verbage to release notes section in ReadMe.htm
- Changed – ReadMe from simple text to HTML
BASICconfigs_041007
- Added – Insta.cfg
- Added – Insta.cfg as a default server mode in server.cfg
- Added – Links to UFT Forums for support and feedback
- Added – Modes.txt to in-game help system
- Changed – Installation instructions to point out that sv_maxclients and sv_privateclients must be adjusted so 10 public slots are available
- Changed – Name of Release Notes.txt to ReadMe.txt
- Removed – Email addresses from ReadMe.txt and configs (support via UFT forums and IRC)
BASICconfigs_041006
- Intial Release