WolfWiki - User contributions [en]

Lua Mod API

2007-02-07T15:25:02Z

Lagger: change of wording made obscure answer

__NOEDITSECTION__
[[ETPro]] now supports server-side mods via the [http://www.lua.org/ Lua] scripting language. For more information about Lua, visit the [http://www.lua.org/manual/5.0/ Reference manual], the online edition of the book [http://www.lua.org/pil/ Programming in Lua] or the [http://lua-users.org/wiki/ lua-users wiki].

ETPro has an embedded Lua 5.0.2 interpreter, and if present will load user-defined scripts from the ETPro directory. It also provides an "et" library of function calls for Lua that allow access to the server engine, and provides callbacks so a server side mod may trigger on specific server events.

The following standard Lua libraries are initialized by default and available to ETPro Lua scripts:
[http://www.lua.org/manual/5.0/manual.html#5.1 basic], [http://www.lua.org/manual/5.0/manual.html#5.4 table], [http://www.lua.org/manual/5.0/manual.html#5.6 i/o], [http://www.lua.org/manual/5.0/manual.html#5.7 os] (available features vary depending on your OS), [http://www.lua.org/manual/5.0/manual.html#5.3 string], [http://www.lua.org/manual/5.0/manual.html#5.5 math].

A list of ETPro mods can be found [[:Category:ETPro:Mods|here]].

A tutorial about ETPro Lua scripting can be found [[Lua Tutorials|here]].

API requests can be discussed at the [[Talk:Lua_Mod_API|Lua Mod API talk page]].

==client commands==
===lua_status===
:lists all currently loaded lua modules.
:''lua mods cannot override this client command.''

==server commands==
===lua_status===
:lists all currently loaded lua modules.

==cvars==
===lua_modules===
:(default "", disabled)
:space separated list of lua modules for ETPro to load. modules will be run in the order listed.

===lua_allowedmodules===
:(default "", disabled)
:if set, only lua modules with the matching sha1 signatures listed in this cvar will be allowed to load.
 
:changing either cvar will cause all currently loaded modules to :quit and be unloaded until the next map_restart. 
 

==et library calls==

===modules===
et.RegisterModname( '''modname''' )
:Registers a descriptive string '''modname''' for this mod.
'''vmnumber''' = et.FindSelf()
:Returns a number indicating the VM slot the current mod is loaded into.
'''modname''', '''signature''' = et.FindMod( '''vmnumber''' )
:Returns the '''modname''' and sha1 '''signature''' for the mod loaded in the VM slot '''vmnumber'''. Returns nil, nil if the VM slot is invalid.
'''success''' = et.IPCSend( '''vmnumber''', '''message''' )
:Sends the string '''message''' to the mod in the VM slot indicated by '''vmnumber'''. The mod receiving '''message''' must have an ''et_IPCReceive()'' callback. If the message is successfully sent, '''success''' will be 1. On failure it will be 0.
 

===printing===
et.G_Print( '''text''' )
:Prints the string '''text''' to the server console.
et.G_LogPrint( '''text''' )
:Prints the string '''text''' to the server console and writes it to the server log.
 

===argument handling===
These functions are to be used within the [[#commands|command callback functions]]. 
'''args''' = et.ConcatArgs( '''index''' )
:Returns all arguments beginning from '''index''' concatenated into a single string '''args'''
'''argcount''' = et.trap_Argc()
:Returns a number indicating the number of command line arguments in the command buffer.
'''arg''' = et.trap_Argv( '''argnum''' )
:Returns the contents of the command line argument '''argnum'''.
 

===cvars===
'''cvarvalue''' = et.trap_Cvar_Get( '''cvarname''' )
:Returns the value of the cvar '''cvarname''' as a string. If there is no cvar named '''cvarname''', returns a zero length string.
et.trap_Cvar_Set( '''cvarname''', '''cvarvalue''' )
:Sets the cvar '''cvarname''' to '''cvarvalue'''
 

===configstrings===
'''configstringvalue''' = et.trap_GetConfigstring( '''index''' )
:Returns the string '''configstringvalue''' containing the contents of the configstring '''index'''
et.trap_SetConfigstring( '''index''', '''configstringvalue''' )
:Sets the configstring '''index''' to the string '''configstringvalue'''
 

===server===
et.trap_SendConsoleCommand( '''when''', '''command''' )
:Sends the command '''command''' to the server console, to be executed '''when''' (see et.EXEC_* constants)
 

===clients===
et.trap_DropClient( '''clientnum''', '''reason''', '''ban_time''' )
:Disconnects '''clientnum''' from the server, with descriptive string '''reason''' reported to clients. '''ban_time''' is the time in seconds to ban the client from the server. '''ban_time''' is optional and may be entirely omitted, in which case the ban time defaults to the cvar ''b_defaultbantime''
et.trap_SendServerCommand( '''clientnum''', '''[[SendServerCommand|command]]''' )
:Sends the command '''[[SendServerCommand|command]]''' to the client '''clientnum'''. If '''clientnum''' is -1, the '''[[SendServerCommand|command]]''' is broadcast to all connected clients.
et.G_Say( '''clientNum''', '''mode''', '''text''' )
:Sends a chat command on behalf of client '''clientNum''' with the mode '''mode''' (see et.SAY_* constants) and chat text '''text'''.
et.ClientUserinfoChanged( '''clientNum''' )
:Loads the new [[Userinfo]] of '''clientNum''' and stores it in the configstring and client variables
 

===userinfo===
'''userinfo''' = et.trap_GetUserinfo( '''clientnum''' )
:Returns the contents of the [[Userinfo]] string for the client '''clientnum'''
et.trap_SetUserinfo( '''clientnum''', '''userinfo''' )
:Sets the [[Userinfo]] string for the client '''clientnum''' to '''userinfo'''
 

===string utility functions===
'''infostring''' = et.Info_RemoveKey( '''infostring''', '''key''' )
:Removes key '''key''' from infostring '''infostring''' and returns the modified infostring.
'''infostring''' = et.Info_SetValueForKey( '''infostring''', '''key''', '''value''' )
:Sets the key '''key''' in the infostring '''infostring''' to '''value''' and returns the modified infostring. If '''value''' is an empty string, '''key''' is removed from the string.
'''keyvalue''' = et.Info_ValueForKey( '''infostring''', '''key''' )
:Returns the value of the key '''key''' in the infostring '''infostring'''. If '''key''' is not present in the string, an empty string is returned.
'''cleanstring''' = et.Q_CleanStr( '''string''' )
:Returns '''string''' stripped of all color codes
 

===ET filesystem===
'''fd''', '''len''' = et.trap_FS_FOpenFile( '''filename''', '''mode''' )
:Attempts to open the file '''filename''' with the access mode '''mode''' (see et.FS_ constants). Returns the filedescriptor '''fd''' and file length '''len'''. On error, '''len''' returns -1.
'''filedata''' = et.trap_FS_Read( fd, count )
:Reads '''count''' bytes from filedescriptor '''fd'''.
'''count''' = et.trap_FS_Write( '''filedata''', '''count''', '''fd''' )
:Attempts to write '''count''' bytes of '''filedata''' to filedescriptor '''fd'''. Returns number of bytes successfully written.
et.trap_FS_Rename( '''oldname''', '''newname''' )
:Renames file '''oldname''' to '''newname'''.
et.trap_FS_FCloseFile( '''fd''' )
:Closes filedescriptor '''fd'''
 

===indexes===
'''soundindex''' = et.G_SoundIndex( '''filename''' )
:Returns an index to the soundfile indicated by '''filename'''
'''modelindex''' = et.G_ModelIndex( '''filename''' )
:Returns an index to the model indicated by '''filename'''
 

===sound===
et.G_globalSound( '''sound''' )
:Plays the global sound indicated by the filename '''sound'''.
et.G_Sound( '''entnum''', '''soundindex''' )
:Plays the sound '''soundindex''' at the location of entity '''entnum'''
 

===miscellaneous===
'''milliseconds''' = et.trap_Milliseconds()
:Returns a number indicating the current server time in milliseconds.
et.G_Damage( '''target''', '''inflictor''', '''attacker''', '''damage''', '''[[etdamage|dflags]]''', '''[[etdamage|mod]]''' )
:Does '''damage''' amount of damage on '''target''' inflicted by '''inflictor''' and cased by '''attacker'''
:'''target''', '''inflictor''', '''attacker''' are entity numbers
:'''[[etdamage|dflags]]''' is a [[Bitmask-cvar|bitflag]] number to decide how the damage is inflickted, see '''[[etdamage|dflags]]''' [[etdamage|flaglist]]
:'''[[etdamage|mod]]''' is a number from 0 up to 64 o set the type of damage, see '''[[etdamage|mod]]''' [[etdamage|list]]
 

===entities===
'''entnum''' = et.G_Spawn()
:Spawns a new entity and returns the new entity number.
'''entnum''' = et.G_TempEntity( '''origin''', '''event''' )
:Spawns a new TempEntity of event type '''event''' and places it at '''origin''' in the world.
:'''Warning:''' up to and including ETPro 3.2.4 the signature of the method is broken and expects four instead of two parameters. To successfully call it, you need to prepend the parameter list with two dummy parameters like et.G_TempEntity( 0, 0, origin, event ). Use this method with care, because in future ETPro versions it will probably be corrected to the one stated above and might break your script.
et.G_FreeEntity( '''entnum''' )
:Frees the entity '''entnum'''
'''spawnval''' = et.G_GetSpawnVar( '''entnum''', '''key''' )
:Returns the value of spawnvar '''key''' for entity '''entnum'''
et.G_SetSpawnVar( '''entnum''', '''key''', '''value''' )
:Sets the spawnvar '''key''' to '''value''' for entity '''entnum'''
'''integer entnum''' = et.G_SpawnGEntityFromSpawnVars( string spawnvar, string spawnvalue, ... )
:This function can only be called inside the '''et_InitGame''' callback
et.trap_LinkEntity( '''entnum''' )
:Links the entity '''entnum'''
et.trap_UnlinkEntity( '''entnum''' )
:Unlinks the entity '''entnum'''
'''(variable)''' = et.gentity_get ( '''entnum''', '''[[Fieldname]]''' '',arrayindex'' )
:Gets the value of '''[[Fieldname]]''' from entity '''entnum''' out of the g_entity struct. For NULL entities or clients, ''nil'' is returned. 
:''arrayindex'' is used to specify which element of an array entity field to get. It is required when accessing array type fields. Entity field array indexes start at 0.
et.gentity_set( '''entnum''', '''[[Fieldname]]''', ''arrayindex,'' '''(value)''' )
:Sets the value of '''[[Fieldname]]''' from entity '''entnum''' in the g_entity struct to '''(value)'''
:''arrayindex'' is used to specify which element of an array entity field to set.
et.G_AddEvent( '''ent''', '''event''', '''eventparm'''' )
:Adds event '''event''' whit eventparameter '''eventparm'''' to entity '''ent'''
 

==callbacks==

===qagame execution===
et_InitGame( '''levelTime''', '''randomSeed''', '''restart''' )
:Called when qagame initializes. '''levelTime''' is the current level time in milliseconds. '''randomSeed''' is a number that can be used to seed random number generators. '''restart''' indicates if et_InitGame() is being called due to a map restart (1) or not (0).
et_ShutdownGame( '''restart''' )
:Called when qagame shuts down. '''restart''' indicates if the shutdown is being called due to a map_restart (1) or not (0).
et_RunFrame( '''levelTime''' )
:Called when qagame runs a server frame. '''levelTime''' is the current level time in milliseconds.
et_Quit()
:Called when ETPro unloads the mod. The mod should close all open filedescriptors and perform all cleanup.
 

===client management===
'''rejectreason''' = et_ClientConnect( '''clientNum''', '''firstTime''', '''isBot''' )
:Called when a client attempts to connect to the server. '''clientNum''' is the client slot id, '''firstTime''' indicates if this is a new connection (1) or a reconnection (0). '''isBot''' indicates if the client is a bot (1) or not (0). If the mod accepts the connection, it should return nil. Otherwise, the mod should return a string describing the reason the client connection was rejected.
et_ClientDisconnect( '''clientNum''' )
:Called when a client disconnects. '''clientNum''' is the client slot id.
et_ClientBegin( '''clientNum''' )
:Called when a client begins (becomes active, and enters the gameworld). '''clientNum''' is the client slot id.
et_ClientUserinfoChanged( '''clientNum''' )
:Called when a client's [[Userinfo]] string has changed. '''clientNum''' is the client slot id.
et_ClientSpawn( '''clientNum''', '''revived''' )
:Called when a client is spawned. '''clientNum''' is the client slot id. '''revived''' is 1 if the client was spawned by beeying revived.
 

===commands===
'''intercepted''' = et_ClientCommand( '''clientNum''', '''command''' )
:Called when a command is received from a client. '''clientNum''' is the client slot id. '''command''' is the command. The mod should return 1 if the command was intercepted by the mod, and 0 if the command was ignored by the mod and should be passed through to the server (and other mods in the chain).
:The actual command can be accessed through the [[#argument_handling|argument handling]] functions, as seen in the [[ETPro:Lua Sample Code]].
'''intercepted''' = et_ConsoleCommand()
:Called when a command is entered on the server console. The mod should return 1 if the command was intercepted by the mod, and 0 if the command was ignored by the mod and should be passed through to the server (and other mods in the chain).
:The actual command can be accessed through the [[#argument_handling|argument handling]] functions, as seen in the [[ETPro:Lua Sample Code]].
 

===xp===
et_UpgradeSkill( '''cno''', '''skill''' )
:Called when client on slot '''cno''' gets an upgrade on skill '''skill'''. Return -1 to override (abort) the qagame function, anything else to "passthrough". Callback may modify skills (or do anything else it wants) during passthrough.
et_SetPlayerSkill( '''cno''', '''skill''' )
:Called when clients (on slot '''cno''') skill level '''skill''' is set. Return -1 to override (abort) the qagame function, anything else to "passthrough". Callback may modify skills (or do anything else it wants) during passthrough.
 

===miscellaneous===
et_IPCReceive( '''vmnumber''', '''message''' )
:Called when another mod sends an et.IPCSend() message to this mod. '''vmnumber''' is the VM slot number of the sender, and '''message''' is the message.
et_Print( '''text''' )
:Called whenever the server or qagame prints a string to the console.
et_Obituary( '''victim''', '''killer''', '''meansOfDeath''' )
:Called whenever a player is killed.
 

==predefined constants==
et.EXEC_NOW 
et.EXEC_INSERT 
et.EXEC_APPEND 
et.FS_READ 
et.FS_WRITE 
et.FS_APPEND 
et.FS_APPEND_SYNC 
et.SAY_ALL 
et.SAY_TEAM 
et.SAY_BUDDY 
et.SAY_TEAMNL 
 
et.HOSTARCH
:set to WIN32 or UNIX depending on the host architecture qagame is running on.
LUA_PATH
:set to fs_homepath/fs_game/?.lua in order to ease use of the [http://www.lua.org/pil/8.1.html require] function.
 

==configs==
If a config is loaded, all modules are shutdown and reloaded. If a ''certified'' config is loaded, all modules are shutdown and reloaded, and additionally the following functions are disabled: '''require()''', '''loadfile()''', '''loadlib()''', '''loadstring()''', '''dofile()''' 
 

==caveats==
Like qagame, lua modules are unloaded and reloaded on map_restart and map changes. This means that all global variables and other information is lost. Mods may choose to store persistent data in cvars or external files. 
 

==FAQ==

Q: OMG I hate the libary prefix et.* on everything!!11!1oneone 
A: table.foreach(et, function (func, value) _G[func] = value; end)

Q: How do a reload my lua file without restarting the whole server? 
A: Use ''map_restart'', ''reset_match'' or simply change map.

Q: Can I see some sample code? 
A: [[ETPro:Lua Sample Code|Lua sample code]]

Q: Is there a list of [[ETPro]] Lua mods? 
A: Yes, [[:Category:ETPro:Mods|here]].

Q: OMG my mod doesn't work! 
A: Make sure you added your mod's filename to the lua_modules cvar (e.g. set lua_modules mymod.lua).

Q: OMG why has et_ClientSay been removed? 
A: That's a secret but, to keep the function as it was, just add the following code to your et_ClientCommand() function 
<pre> -- et_ClientSay had to be removed in order to intercept all commands
-- so here's a wrapper for that
arg0 = et.trap_Argv(0) -- get the main command

if arg0 == "say" then
return et_ClientSay( clientNum, et.SAY_ALL, et.ConcatArgs(1))
elseif arg0 == "say_team" then
return et_ClientSay( clientNum, et.SAY_TEAM, et.ConcatArgs(1))
elseif arg0 == "say_buddy" then
return et_ClientSay( clientNum, et.SAY_BUDDY, et.ConcatArgs(1))
elseif arg0 == "say_teamnl" then
return et_ClientSay( clientNum, et.SAY_TEAMNL, et.ConcatArgs(1))
end
-- et_ClientSay wrapper end
</pre>

[[Category:Lua]]

ETTVd:Readme

2006-11-28T13:33:43Z

Lagger: /* Requirements: */ xampp linky

=== Important ===

For an updated manual visit http://eicher.homelinux.com/ettvd/ - this one sucks bigtime
thanks a lot eicher for creating this documentation project for ettvd

=== Requirements: ===

* php5 cli installed (install [http://www.apachefriends.org XAMPP] if you dont want to compile)
(some people also report it working on some php4 versions but with 5 you are on the safe side)

=== Remarks ===

BETA2 24.11.2006

=== Changes for b2 ===

* New options in config.php - watch out
* Fixed a mean bug cloning objects by accident
* Quick serverswitch
* More ingame information
* Better playlists
* Increased security
* Control IP whitelisting
* Improved logging
* Maximum recorders, replayers, slots that can be spawned from the control interface
* Number of people to start recording with now configurable via the interface
* Added example demo file to get it to run faster
* A lot of stupid warnings removed
* Cleaned up the servers directory from more files that are not needed
* a lot of small stuff
* a completely new webinterface but skooli is too lazy to document it

=== Features b1 ===

Complete management of all ettv servers - the servers are started as children of the ettvd process
for full control over them. The servers will recieve all commands needed from the ettvd service.

* Start of recording when enough players are ready
* Recording pause when players leave the server
* Disconnect from matchserver after timeout
* Simultanious recording of as many games as you want (limited by cpu/ram)
* Replay of recorded games
* Multiple broadcast servers showing the same or different games in Live, Semi-Live or Replay mode.
* Spam protection with a sticky mute system (/reconnect doesnt help)
* A fully featured webinterface (by skooli)
* ETTVoD ready
* Display of intermediate maptimes
* Announcer for next game, current game both ingame and in sv_hostname
* Most settings configurable in a single file
* Fully painless matchserver crash recovery
* Recovery of all sorts of ettv broadcaster crashes (replayers continue where they crashed)
* Ingame admin commands !mute, !kick, !reclist, etc
* Complete demo management for archiving
* Constantly maintaining the correct ettv_delay
* Replay Playlists or playing specific games again
* Probably more

=== Installation: ===

ETTVd:
Edit: start.sh, config.php
Add maps and pak0.pk3 to etmain
Make ettv.x86 executable

Webinterface:
upload to php'able webspace
configure includes/config.php

=== Starting: ===

./start.sh as superuser (edit it first) - if you're not root change start.sh acordingly

My _example_ script will automatically set a higher priority and change user to my ettv user

=== Thanks ===

Big thanks to skooli for the webinterface
Big thanks to zinx and bani for caring about my ettv whine
Thanks to frop for pimping the webinterface
Thanks again to eicher for starting a proper documentation for ettvd
Thanks to everyone reporting bugs

=== Ingame chat commands ===

These commands are available for all people who have logged in to the webinterface
within the past 6 hours or used the adminip console command.

!admintest
--Check if you have admin access ingame

!recordmode <mode>
--Same as console recordmode, see below

!nextmap
--Jumps to the next map of the current recording
--See console nextmap for more information

!autoreplaynum
--See below

!reclist
--A quick ingame overview what the recorders are doing

!findviewer
--Debug function for viewer matching function used by below functions
--Supports partial matches, strips colours and is case insensitive

!mute <match> <time>
--Mute a viewer specified by the <match> for <time> minutes, if <time> is not given default is to 5min

!unmute <match>
--Unmutes the viewer (also removes the sticky mute)

!kick <match>
--Goodbye <match> (banned for 5min by default)

=== Basic Commands (Not needed when using webinterface) ===

connect <ip> <gpw> <ettvpw>
--Creates a new recorder and connects it to this server

gamename <recid> <name>
--Sets the name of the currently running game on a recorder

recordmode <recid> <mode>
--Sets the recordmode for a recorder, the following modes are currently supported.
--ready - recording starts once 4 players are ready
--connect - recording starts as soon as the recorder is connected

--Remark to recording: Recording stops when less than 50% of the players the game started
--with remain on the server, it resumes when 2/3 of those players rejoin.
--Please do not forget to kill your recorders even if they paused recording

livecast <recid> <repid>
--Tells a replayer that it should replay whatever that recorder will be recording
--If the replayer is not running at the point that the recorder starts recording it will not work

broadcast <slots> <port> <privateslots> <gameid> <config>
--Starts a new broadcaster - you can omit everything except slots

killrec <recid>
--kills a recorder after broadcast

killrep <repid>
--kills a replayer for whatever reason

quit_rly
--shuts down everything cleanly - better than killing the process

reloaddemos
--reloads the demolist from disk in case you deleted some or whatever

demolist
--shows a list of all recorded games

viewerlist <repid>
--shows some info about connected viewers

playgame <repid> <gameid>
--plays a certain game

nextmap <repid>
--jumps to the next map - if it was the last map of the game it will chose the next game in the reply cycle
--if you do this in live broadcast mode you will leave the live broadcast, because we cant jump into the future !!

autoreplaynum <repid> <number>
--the number of recent games the replayer will automatically replay

serverlist
--shows all server processes currently managed by ettvd

debug <1/0>
--turns debug information on or off

There are more functions used by the webinterface - if you really care, please check the
sourcecode of ettvd.php - commands are pretty easy to understand

Hitsounds

2006-11-14T17:32:32Z

Lagger: /* Client configuration */ it's 2 not 3

'''Hitsounds''' are sounds that are played when you hit another player. There are three different sounds:

* when you hit an enemy
* when you hit an enemy in the head hitbox
* when you hit a teammate

==Client configuration==

The hitsounds are controlled by the cvar <tt style="color: green;">b_hitsounds</tt>. There are three different settings that can be used with this cvar:

0 = off, no sounds are played
1 = all sounds are played
2 = a sound occurs only when you hit the enemy's head

Of course you can also configure hitsounds using the ingame ETPro menu.

==Server configuration==

Server administrators may disable hitsounds on their server using the cvar <tt style="color: green;">b_sv_hitsounds</tt> (default 1, enable).

0 = server globally disables hitsounds
1 = server allows clients to use hitsounds

[[Category:ETPro:Client_Cvars]]

Server Configuration

2006-10-16T16:58:23Z

Lagger: /* Configuration: */ added link to Pluggable config files

==Installation==
File installation:
Note that the <tt>etpro</tt> directory should be in the same directory as <tt>etmain</tt>. Do NOT extract the files to etmain
:Linux:
Unzip the server archive to <tt>enemy-territory/etpro/</tt>
:Windows:
Unzip the server archive to <tt>Wolfenstein - Enemy Territory\etpro</tt>
Starting an ETPro server requires <tt>+set fs_game etpro</tt> to be appended to the end of the command line.
:Linux example:
::<tt> ./etded +set fs_game etpro</tt>
:Windows:
::<tt> etded.exe +set fs_game etpro</tt>
:Windows Shortcut:
::Right click on the shortcut for Enemy Territory and select "Properties." In the "Target" Box (Top text box) add <tt>+set fs_game etpro</tt> to the end, after the quotes.
::<tt> "C:\Program Files\Wolfenstein - Enemy Territory\et.exe" +set fs_game etpro</tt> 

''Note'': Starting from version ET 2.60, the Windows executables are et.exe for the game and etded.exe for the server. If you want to run a listen server on Windows start your game with et.exe, otherwise use etded.exe for a dedicated server.

If you want to run 2.56 or earlier servers on Windows, you can only use et.exe and append <tt>+set dedicated 1</tt> (or 2).

==Warnings==
WARNING: Server improperly installed! Incorrect fs_game setting! Please notify administrator.
:Incorrect <tt>+set fs_game</tt> string. Make sure it is set to <tt>+set fs_game etpro</tt>.
fs_game is write protected.
:You must start your server via the command line (Or by changing the shortcut) with the <tt>+set fs_game etpro</tt> command. 
Client .pk3 missing!
:The PK3 file that is contained in the server install file is missing. Download the [http://bani.anime.net/etpro/download.html server install] again and place the PK3 file in the server's ETPro directory. 
Incorrect client .pk3 installed on server!
:The PK3 file mentioned above does not match the version of the server. Download the PK3 (And possibly updated server) from the [http://bani.anime.net/etpro/download.html download page].
Multiple client .pk3 versions installed on server!
:This means that the server has more than one ETPro client PK3. Remove the older versions from the server's ETPro directory.
:This can also happen from having fs_game set twice in your shortcut or config. 
Incorrect ET version!
:This happens when you are attempting to install ETPro on a non-patched ET server. Download the [http://games.activision.com/games/wolfenstein patch] and try again. 
Cvar dedicated is 0! Some features will break!
:ETPro is meant to be installed on a dedicated server. Set the server to dedicated by using <tt>+set dedicated 2</tt> in the command-line used to start the server. 
etpro_cheats.dat is corrupt or missing!
:The ETPro database file for positively identifying cheats has either been corrupted or does not exist on the server. Download a recent version of [http://etpro.anime.net/etpro_cheats.dat the database].
 
==Other Errors==
Server sends users the ETPro PK3 file over and over. 
:If you are using download redirects, make sure that the download path is set correctly if changed between versions. eg: If the old PK3 was in <tt>server/etpro2</tt> and the new version is in <tt>server/etpro3</tt> and the redirect path in the server configuration was not changed, it would send the old ETPro 2.x files; which not being what the server is using, it would cause the download to start again. 
:If you are redirecting to an http or ftp server, make sure the pk3 on the http/ftp server exactly matches the pk3 on the game server.
:Some http servers may incorrectly try to send pk3 files as text/plain, which will corrupt downloads. Make sure they are sent as application/octet-stream:
*WARNING*: PunkBuster Reports PB Server Running Old Version Cx.xxx 
Windows:
:Run <tt>\Wolfenstein - Enemy territory\pb\pbweb.exe</tt> 
Linux:
:Run <tt>/path_to_et_server/pb/pbweb.x86</tt> (first chmod +x pbweb.x86) 

==Configuration:==
[[:Category:ETPro:Server_Cvars|ETPro Server CVAR Explanations]]

[[ETPro:Pluggable Config Files]]

[http://bani.anime.net/banimod/forums/viewforum.php?f=13 Server Admin Forums]

[http://rtcw.jolt.co.uk/content/enemy_territory/server_guide/index.html DG's Advanced Server Guide]

[http://et.d1p.de/etadmin_mod/wiki/index.php/User:Phats#Advanced_Campaign_Structure_-_Using_etadmin_mod____.28Prototype.29 Advanced Campaign Structure - Using etadmin_mod (Prototype)]

[[Category:ETPro]]

WolfWiki talk:Community Portal

2006-09-04T19:35:37Z

Lagger: votinated

The vote is: "Prohibit clans from being listed on the community portal page"
Addendum: The number of clans is rather large. Another page, perhaps?
:For --[[User:WeblionX|WeblionX]] 09:22, 4 September 2006 (PDT)
Not only is the number of clans rather large, most don't last two weeks. And who would want to keep the list up to date?
:For --[[User:Lagger|Lagger]] 12:35, 4 September 2006 (PDT)

ETTV

2006-09-03T12:38:31Z

Lagger: link fixorage

http://ettv.anime.net/tvlogo.gif

==What is ETTV?==

ETTV allows you to connect up to a special server using your PC, and view a game in progress much like a spectator would. But it's more powerful than any normal spectator function - ETTV allows you all the features of a [[Shoutcasting|shoutcaster]] - being able to see the names of players over their heads, seeing a dynamite timer over the dynamite, etc. You can even watch spectators on the server, such as 'cameramen', people that ensure you get the best overview shots of battles, the best 1st person views during 1 on 1's, and those crucial views just before a panzer dishes out some ownage on an unsuspecting enemy group.

Because you're using ETTV rather than just spectating the game, the server can relay the broadcast of the game to other servers - meaning 100's or even 1000's of us can watch world-class teams battling without lagging them out by crowding their server.

*For more information, see the [[ETTV:Viewer%27s_Guide|Viewer's Guide]]

[[Category:ETTV]]

Performance Tuning

2006-08-27T04:43:15Z

Lagger: /* Improving performance on video card limited systems */ - Added r_subdivisions and r_lodcurveerror

==Performance bottlenecks and workarounds==
The following describes general areas which can affect game performance, and possible workarounds. Network performance is not addressed here, except as it relates to CPU usage.

Hardware mentioned is meant only as a general example.

==CPU and system memory speed==
;As a general rule, ET likes lots of CPU and memory/cache/FSB bandwidth.
Anything less than an Athlon XP 2000 or Pentium 4 2GHZ. Systems with poor memory bandwidth (SDR or DDD266 RAM) or crippled cache (celeron, duron) will suffer.
===Improving performance on CPU limited systems===
*'''b_optimizeprediction 1'''
*Higher ping and packet loss put more load on the CPU
*Larger servers put more load on your system

==Video card==
Anything less than a geforce4 (not MX) or radeon 9600 will be a serious handicap. Beware of manufacturers deceptive naming conventions, a FooBar 1000XTS might be the best available card while the FooBar 1000LE is utter crap.
===Improving performance on video card limited systems===
Note: you may experience that maps appear to load twice because of restrictions enforced on these cvars by server and league admins.
*'''Lower resolution'''
:Choose a lower value for r_mode; use /modelist to see available modes
*'''Lower texture quality'''
**Set [[r_picmip]] to a higher value (up to 3).
**Set [[r_texturebits]] to 16
**Set [[r_texturemode]] to <tt>GL_NEAREST_MIPMAP_NEAREST</tt>, <tt>GL_LINEAR</tt> or <tt>GL_NEAREST</tt>
**Set texture compression [[r_ext_compressed_textures]] to 1 (Note that this may have a positive or negative impact on performance, depending on your system)
*'''Lower color depth'''
**Set [[r_colorbits]] to 16
*'''Lower Curve Detail'''
**Set r_subdivisions 25 - higher value gives lower detail. sane values are 1 - 25.
**Set r_lodCurveError 125 - controls the distance from you where detail is lowered, sane values are 100 - 10000.
*'''Other quality settings'''
**Set r_fastsky to 1

==Available Physical RAM==
256 megabytes or less of system RAM will impact level load times and cause hitching (momentary drops in FPS) in game. If levels take a long time to load, or your hard disk is frequently active during gameplay, you are most likely need more RAM.
===Settings for systems without much system RAM===
*r_picmip and r_texturebits, as above
*lower sound quality
*set com_hunkmegs to 56, or the lowest value that works with all the maps you want to play.
*other [[memory cvars]] should not be set too high above the default.

==Integrated sound ==
Most integrated sound devices suck, and can cause noticeable FPS loss and stuttering.

==External Programs==
In general, the less you run when you play ET, the better. However, some programs are known to have disproportionate performance impacts.
*'''x-fire''' in game integration features.
*'''p2p''' bittorrent, kazaa etc.
*'''malware''' viruses, spyware and addware can all cause serious performance problems.
*'''scheduled tasks''' such as windows update or antivirus updates
*'''software firewalls and antivirus''' some of these products have been reported to cause problems. (TODO more details)

==Benchmarking and Testing==
To get the best performance out of your particular system, you should test each tweak to ensure it has the desired effect.

You can use the '''timedemo''' cvar to benchmark demo playback. Do this by setting <tt>timedemo 1</tt> in the console, and then playing back a demo. When the demo playback completes, the console contains an average framerate. If you have problems playing back demos, see [[Client_Configuration]]

If you want to compare performance between mods, you can use an etmain (or any server only mod such as etpub or shrubet) demo and play it back both in etmain and etpro.

It is important to remember that '''demo playback is not directly comparable to online play'''. In general, demo playback depends more on the video card than online play does. A tweak that shows a huge improvement in demo playback may have little effect in online play.

To test performance in real play, you should use [[DrawFPS|cg_drawFPS]] and then pick a standard location. This will not give you exactly the same results every time, but will show major effects. Ideally, the test should be done on an otherwise empty dedicated server with a consistent ping. If you host the server on the same machine as the client you are testing, this will affect the results.

TODO: it would be nice to have a standard timedemo demo, so people can compare results.

==TODO==
This page is a draft. The following need to be added or expanded:
*examples of FPS for various typical systems/settings, so people can know if they are getting expected performance out of their hardware.
*more complete list of useful cvars.
*links to config sites.
*links to more detailed descriptions of settings.
*benchmarking

[[Category:ETPro]]

ETTV:Viewer's Guide

2006-08-05T17:35:46Z

Lagger: wollfog?

== ETTV Viewer's Guide ==
=== Introduction ===
ETTV is a modification that allows anybody to spectate Enemy Territory matches without actually being on the server the teams are playing on. The purpose is so that you have have thousands of people all able to watch an exciting match live, without being able to interfere or otherwise cause problems with the match.

The ETTV modification is supplied within the ETPro modification, you do not need any further modification unless you intend to run an [[ETTV:Server_Configuration|ETTV Server]].

=== Watching ETTV ===
Simply connect to an ETTV server like any other Enemy Territory server. Once you are connected it will look and feel very much like you are in spectator mode on any normal server.

There are some issues which occur frequently enough to make it worth noting here, however.

* ETTV servers frequently do not allow clients (that's you/your game) to auto-download any missing files. You should try to ensure you '''have the correct patch, modification and custom map versions before you join'''. This is usually, but not necessarily the latest official version. If you do not have the correct versions you may be unable to join, or disconnected at some point during viewing.

* '''Do not be concerned about interfering with the match''', you cant. The ETTV server you join is essentially playing a live demo of the match which is actually being played on another server. You can spectate freely and talk crap with the other viewers on the same ETTV server, thats it. Chat from ETTV viewers is distinguished from chat in the match by the red "ETTV" preceding it.

* '''Connecting via IP address''' (command-line or console) is identical to any other Enemy Territory server. If you've been given the IP address of an ETTV server and are wondering what to do with it, open the console (usually by pressing the key under ESCape, often the ~ or ` key) and use the following command (including the forwardslash) - <tt>/connect ip.add.ress:port</tt>
:(for example: <tt>/connect 62.75.178.112:27962</tt>)

=== Additional Controls ===
* cycle between everybody on the server (who shows up on the scoresheet)
:fire <tt><Left Mouse button></tt>
* cycle following only objective carriers
:Prone + (fire / altweapon) <tt><X + LeftMouse></tt>
* cycle following only spectators / shoutcasters
:Zoom + (fire / altweapon) <tt><nowiki></nowiki></tt>
* Jump directly to following a player in view
: Press activate while pointing crosshair at player
* return to free floating mode.
: Press jump or activate <tt><Spacebar></tt>

=== Generally Useful Tips ===
* Chats from other ETTV spectators can be hidden with the console command <tt>/tvchat off</tt>, and re-enabled with <tt>/tvchat on</tt>. All chat done on ETTV won't be seen on the game server (luckily). If certain chatters start to irritate you, you can easily ignore specific people with the <tt>/ignore</tt> command and can use the <tt>/unignore</tt> command to show their chat messages again.

* To spectate a specific player through their eyes, open console and put in the command <tt>/players</tt>, and notice the player number. Now just <tt>/follow x</tt>. If you're new to Enemy Territory, you might find it most entertaining to follow a shoutcaster, if there is one.

* Viewing ETTV in a window can be convenient while you find other IP's, talk in IRC, or access WinAmp, for example. To do this, you can go to the options screen and set a resolution which is smaller than your desktop screen resolution, and then select windowed mode. Alternatively, enter <tt>/r_mode 3</tt> into console, and then hit ALT+Enter.

* Normal cvar restrictions dont apply when viewing demos, nor do they (usually) when viewing ETTV. This is OK because you're not playing against anyone. Several leagues remove the foliage (all the grassy stuff) on Radar because it hurts performance and, some say, isnt good for competitive gaming. As an ETTV viewer you can remove it via console: <tt>/r_drawfoliage 0</tt>. To further incrase performance you can remove wolffog (an effect which "adds" fog to the map, sometimes restricting the viewing distance [e.g. Railgun]) by setting <tt>r_wolffog 0</tt>. You might want to ensure that is reset to 1 before you join a normal gameserver however.

* ETTV is generally not live; normally a few minute long delay is added so competing teams cannot have another member watching and sending participants advantagous information.

== Shoutcasts ==
A [http://en.wikipedia.org/wiki/Shoutcast shoutcast] is essentially a match commentary, broadcast over something akin to internet radio. The shoutcaster is usually someone heavily involved with the ET community and listening to the shoutcast greatly enhances the entertainment value of ETTV.

A shoutcast is completely seperate from ETTV however, to listen to a shoutcast you will need to open the URL with a suitable program - [http://winamp.com/ WinAmp] being one of many such programs. The shoutcast URL is often available at the same place you found the ETTV details for the match you want to watch.

Like ETTV, shoutcasts are usually not totally live - normally a few minutes delay is added so competing teams cannot have another member watching or listening in and sending participants advantagous information. Typically ETTV has a longer delay than the shoutcast does, so the result is ETTV and shoutcast are out of sync.

Fortunately it isnt the other way around, because you can pause WinAmp to syncronise the two. Simply listen for some event in the shoutcast (often shoutcaster will read out the time on the clock for this purpose, or you can listen for event's like 'FIGHT!' or 'dynamite planted') and immediately hit pause. When the event occurs in ETTV, hit play again. This can be easier if you view ETTV in windowed mode, also if you make a mistake and pause WinAmp for too long, reconnect to the shoutcast URL.

== Replaying ETTV demos on a local Windows server ==

If you have ETTV Demo files (*.tv84), you can watch them locally on your windows machine. in order to do so, you will need a ETTV-Server. Download the latest version (currently: http://returntocastlewolfenstein.filefront.com/file/ETTV;52030) and proceed with the following steps:

* Extract all files except tvgame.mp.i386.so into your "Wolfenstein - Enemy Territory" root directory (not etmain).
* The tvgame.mp.i386.so file goes into the etpro directory.
* Put the *.tv_84 files in your etpro\demos directory
* Create a shortcut to ETTV.exe (Right click in explorer windows, "new..." -> "Shortcut").
* Change the program call in the shortcut (Right click, "Properties") to: '"path\ettv.exe" +set fs_game etpro +set ettv_autoplay 1 +demo demo0000'

When you double click on the shortcut, ETTV should come up displaying a console and starting the playback. Note that the demo files are required to be named like demo0000.tv_84, demo0001.tv_84, etc. in order to work like this. The server will autoplay all demos in successive order. You can now start your ET and connect to your local server (choose "Internet Play", then "connect to IP" 127.0.0.1.

==== Known Issues ====

You have to install the complete etpro package for servers - the pk3 file that clients have is not enough.

I have discovered client error "MAX_GAMESTATE_CHARS" on several demos: The ETTV seems to run fine but local clients get kicked for that reason. I have not yet found why this happens, nor a solution. Any hints on that would be helpful.

This short How-To was written on request for gamestv.org, they are hereby permitted to use this text on their own site.

== External Links ==
* [http://www.gamestv.org/ GamesTV.org] is an ETTV listings site.
* [http://www.radioitg.com/schedule.php Radio iTG's schedule] is a source of shoutcasts.

[[Category:ETTV]]

User:Rookie One

2006-04-28T08:18:41Z

Lagger: link fix

== [http://bani.anime.net/banimod/forums/profile.php?mode=viewprofile&u=4183 Rookie One] ==
<table witdh=100% height=100>
<tr><td width=400 align=center valign=center>http://a.deviantart.com/avatars/r/o/rookie0ne.jpg</td><td width=100% align=left valign=center>
* '''Game modding'''
** ''[http://www.moh.gamesnet.pl/rookieone/?lang=english Rookie One's Command Post] ''
* '''Other stuff'''
** ''[http://rookie0ne.deviantart.com/ My DeviantArt profile]''
** ''[http://rookie0ne.dmusic.com/ My dmusic profile]'' 
Currently playing around with [[ETPro]]'s new [[Lua_Mod_API|server-side mod]] ability. :) Also an overzealous WoflWiki contributor, causing much mess. :S
</td></tr></table>
== Contact ==
* '''E-mail/MSN:''' rookie underscore one at army dot com
* '''[http://en.wikipedia.org/wiki/Jabber Jabber]:''' r00kie underscore 0ne at chrome dot pl

User:Infty

2006-04-28T08:18:22Z

Lagger: link fix

<table witdh=100% height=100>
<tr><td width=400 align=center valign=center >http://www.matthiaswetzka.de/images/ich.png</td><td width=100% align=left valign=center>
== Contact ==
* '''Homepage'''
** ''[http://www.fueldump.de www.fueldump.de]'' - PM me in the forum for contact.
* '''[[IRC]]'''
**''#fueldump.de'' - fd.de channel on quakenet [[irc://irc.quakenet.org:6667/fueldump.de]]
**''#etpro'' - [[ETPro]] channel on freenode [[irc://irc.freenode.net:6667/etpro]]
**''#etpro'' - [[ETPro]] support channel on quakenet [[irc://irc.quakenet.org:6667/etpro]]
</td></tr></table>

== '''[[Lua_Mod_API|ETPro Lua]] scripts''' ==

=== [http://fueldump.matthiaswetzka.de/lua/nokill.lua NoKill v1.0] ===

Completely disables the /kill command and displays a notifcation to the player who tried the /kill. Unlike other mods, this script doesnt kick players after a certain amount of /kills.

[[Category:ETPro:Mods]]

Fieldname

2006-04-28T08:17:55Z

Lagger: link fix

__NOEDITSECTION__
==Entity Fieldnames==
List of fields supported by [[Lua Mod API#entities|et.gentity_get() and et.gentity_set()]] functions 
<pitatable columns=3 headlines="field;type;access" widths="180;120;60" headerfontcolor="#FFFFFF">
activator;entity;RO;
chain;entity;RW;
classname;string;RW;
client.inactivityTime;integer;RW;
client.inactivityWarning;qboolean;RW;
clipmask;integer;?;
closespeed;float;RW;
count;integer;RW;
count2;integer;RW;
damage;integer;RW;
deathType;meansOfDeath_t;RW;
delay;float;RW;
dl_atten;integer;RW;
dl_color;vec3;RW;
dl_shader;string;RO;
dl_stylestring;string;RO;
duration;float;RW;
end_size;integer;RW;
enemy;entity;RW;
flags;bitflag;RO;
harc;float;RW;
health;integer;RW;
inuse;qboolean;RO;
isProp;qboolean;RO;
item;string;RW;
key;integer;RW;
message;string;RW;
methodOfDeath;integer;RW;
mg42BaseEnt;integer;RW;
missionLevel;integer;RW;
model;string;RO;
model2;string;RO;
nextTrain;entity;RW;
noise_index;integer;RW;
origin;vec3;RW;
pers.connected;connected_t;?;
pers.netname;string;?;
pers.localClient;qboolean;?;
pers.initialSpawn;qboolean;?;
pers.enterTime;integer;?;
pers.connectTime;integer;?;
pers.teamState.state;teamstatestate_t;?;
pers.voteCount;integer;?;
pers.teamVoteCount;integer;?;
pers.complaints;integer;?;
pers.complaintClient;integer;?;
pers.complaintEndTime;integer;?;
pers.lastReinforceTime;integer;?;
pers.applicationClient;integer;?;
pers.applicationEndTime;integer;?;
pers.invitationClient;integer;?;
pers.invitationEndTime;integer;?;
pers.propositionClient;integer;?;
pers.propositionClient2;integer;?;
pers.propositionEndTime;integer;?;
pers.autofireteamEndTime;integer;?;
pers.autofireteamCreateEndTime;integer;?;
pers.autofireteamJoinEndTime;integer;?;
pers.lastSpawnTime;integer;?;
pers.ready;qboolean;?;
prevTrain;entity;RW;
props_frame_state;integer;RO;
ps.stats;integer array;RW;
ps.persistant;integer array;RW;
ps.ping;integer;?;
ps.powerups;integer array;RW;
ps.ammo;integer array;RW;
ps.ammoclip;integer array;RW;
r.absmax;vec3;RO;
r.absmin;vec3;RO;
r.bmodel;qboolean;RO;
r.contents;integer;RW;
r.currentAngles;vec3;RW;
r.currentOrigin;vec3;RW;
r.eventTime;integer;RW;
r.linkcount;integer;RO;
r.linked;qboolean;RO;
r.maxs;vec3;RW;
r.mins;vec3;RW;
r.ownerNum;integer;RW;
r.singleClient;integer;RW;
r.svFlags;integer;RW;
r.worldflags;integer;RO;
radius;integer;RW;
random;float;RW;
rotate;vec3;RW;
s.angles;vec3;RW;
s.angles2;vec3;RW;
s.apos;trajectory;RW;
s.clientNum;integer;RW;
s.constantLight;integer;RW;
s.density;integer;RW;
s.dl_intensity;integer;RW;
s.dmgFlags;integer;RW;
s.eFlags;integer;RW;
s.eType;integer;?;
s.effect1Time;integer;RW;
s.effect2Time;integer;RW;
s.effect3Time;integer;RW;
s.frame;integer;RW;
s.groundEntityNum;integer;RO;
s.loopSound;integer;RW;
s.modelindex;integer;RW;
s.modelindex2;integer;RW;
s.number;integer;RO;
s.onFireEnd;integer;RW;
s.onFireStart;integer;RW;
s.origin;vec3;?;
s.origin2;vec3;?;
s.pos;trajectory;RW;
s.powerups;integer;RO;
s.solid;integer;RW;
s.teamNum;integer;RW;
s.time;integer;RW;
s.time2;integer;RW;
s.weapon;integer;RO;
scriptName;string;RO;
sess.sessionTeam;team_t;RW;
sess.spectatorTime;integer;RW;
sess.spectatorState;spectatorState_t;RW;
sess.spectatorClient;integer;RW;
sess.latchSpectatorClient;integer;RW;
sess.playerType;integer;RW;
sess.playerWeapon;integer;RW;
sess.playerWeapon2;integer;RW;
sess.spawnObjectiveIndex;integer;RW;
sess.latchPlayerType;integer;RW;
sess.latchPlayerWeapon;integer;RW;
sess.latchPlayerWeapon2;integer;RW;
sess.damage_given;integer;RW;
sess.damage_received;integer;RW;
sess.deaths;integer;RW;
sess.game_points;integer;RW;
sess.gibs;integer;RW;
sess.kills;integer;RW;
sess.medals;integer array;RW;
sess.muted;qboolean;RW;
sess.rank;integer;RW;
sess.referee;integer;RW;
sess.rounds;integer;RW;
sess.semiadmin;integer;RW;
sess.skill;integer array;RW;
sess.spec_invite;integer;RW;
sess.spec_team;integer;RW;
sess.suicides;integer;RW;
sess.team_damage;integer;RW;
sess.team_kills;integer;RW;
sess.team_received;integer;RW;
sess.aWeaponStats;weapon_stat_t;RW;
spawnflags;integer;RO;
spawnitem;string;RO;
speed;float;RW;
splashDamage;integer;RW;
splashMethodOfDeath;integer;RW;
splashRadius;integer;RW;
start_size;integer;RW;
tagName;string;RO;
tagParent;entity;RW;
takedamage;boolean;RW;
tankLink;entity;RW;
target;string;RW;
TargetAngles;vec3;RW;
TargetFlag;integer;RO;
targetname;string;RO;
teamchain;entity;RW;
teammaster;entity;RW;
track;string;RO;
varc;float;RW;
wait;float;RW;
waterlevel;integer;RO;
watertype;integer;RO;
</pitatable>
:''note'': all the sess.* fields will return nil unless the entity is associated with client slot < sv_maxclients.
:''note'': all array variables need to be get or set with an additional parameter.

----

==ET variable types==

===qboolean===
:a '''qboolean''' is a number representing a boolean value.
:0 is false
:1 is true

----

===vec3===
:a '''vec3_t''' is a 3-element array of numbers (C definition: typedef float vec3_t[3];). It is usually used to store and process coordinates in 3D space. 
:In etpro-lua a vector is an array (table indexed by integers) containing 3 numbers. It can be accessed by
:doing:
<pre>
origin = et.gentity_get(entNum,"r.currentOrigin") --a vec3 value
x,y,z = origin[1],origin[2],origin[3]</pre>

----

===array===
:The fields listed as having type '''array''' represent an entity value which is an array. Individual elements of the array are accessed by passing the desired index in the ''arrayindex'' argument to the et.gentity_get and et.gentity_set functions. Valid array indexes are integers from 0 up to some field specific maximum. The ''arrayindex'' argument is '''required''' when accessing array type fields, so only one element of an array can be accessed in a given call to the gentity_* functions. 

----

===trajectory===
:a '''trajectory''' is returned as a lua table described below
<pre>{
trDuration = <number>, --- int
trTime = <number>, -- int
trType = <number>, -- see below for allowed values
trBase = <vec3_t>, -- vec3, as described above
trDelta = <vec3_t> -- also a vec3
}</pre>
: the allowed values for trType (along with the enum names and original comments from the ET source), are as follows. Note
: that not all values make sense for all entity types
<pitatable columns=3 headlines="number;type;discription" widths="40;160;450" headerfontcolor="#FFFFFF">
1;TR_STATIONARY;
2;TR_INTERPOLATE;non-parametric, but interpolate between snapshots;
3;TR_LINEAR;
4;TR_LINEAR_STOP;
5;TR_LINEAR_STOP_BACK;reverse movement can be different than forward;
6;TR_SINE;value = base + sin( time / duration ) * delta;
7;TR_GRAVITY;
8;TR_GRAVITY_LOW;
9;TR_GRAVITY_FLOAT;super low grav with no gravity acceleration;
10;TR_GRAVITY_PAUSED;has stopped, but trace to see if it should be switched back to TR_GRAVITY;
11;TR_ACCELERATE;
12;TR_DECCELERATE;
13;TR_SPLINE;
14;TR_LINEAR_PATH;
</pitatable>

----

===entity===
:The fields listed as having type '''enitity''' return an entity number or nil. Entity numbers are integers from 0 through 1023. Some of the entity numbers have special meanings:
:0 - (sv_privateclients - 1) are reserved for clients who connect with the private slot password
:0 - 63 are reserved for clients. A client's entity number is also its client number (as shown by /players for example)
:1022 is the '''worldspawn''' entity
:1023 is '''ENTITYNUM_NONE''' which is used instead of null in C under some circumstances to indicate no entity. This is needed where an entity number will be passed over the network.
:''Note'': Some other fields not listed as type 'entity' may take an entity number value. '''mg42BaseEnt''' and '''s.number''' are examples. 

----

===meansOfDeath===
:a '''meansOfDeath_t''' is a number indicating the [[etdamage|Method of Death]] Click [[etdamage|here]] for a list whit posable value's

[[Category:ETPro]]
[[Category:ETPro:Mods]]

ETPro:Server cvar list

2006-04-28T08:17:32Z

Lagger: link fix

== '''ETPro Server cvars/commands''' ==
By Birdman & =FF=im2good4u

This list contains all ETPro server cvars and commands (hopefully).

We have tried to include as much information in each description as possible, but some might require more explaining, so links to other pages here or the forums have been added.

'''Note:'''
If there is any ETPro server cvars/commands that you think we have omitted or any that you think the description is wrong then pm me [http://bani.anime.net/banimod/forums/profile.php?mode=viewprofile&u=3475 here]. Before pm’ing are you sure it’s a ETPro cvar/command and not another mods or an ETmain one, if it is ETPro then let me know what cvar/command we’ve omitted, adding a short description of what it’s use if known to you. If you think a description is wrong, quote the cvar/command and it’s description adding your description of it.

Apologies for all the ..... to try create new lines or push things along to create a line so things look a bit better in some of the description sections, but i couldn't start new lines using the pitatable.

=== Cvars/Commands ===

Most of these cvars are either 0 (disabled) or 1 (enabled), those that differ I have included the values in the description. For an explanation of how bitmask cvars work see [[Bitmask-cvar|here]].

<pitatable columns=2 headlines="Cvar/Command;Description" headerbgcolor="0b53b4" headerfontcolor="#FFFFFF" border1=2 border2=1 aligns="left;left">
b_anticheat;Controls ETPro's anticheat, default 1, enabled...... 0 = Disabled, 1 = Enabled (normal restriction, recommended), 2 = More restrictive, 3 = Only allow 100% clean players (not recommended)
b_antiwarp;Controls players 'warping', default 1, enabled.
b_bannerlocation;Bitmask which determines the location of the banners print out area, default 128, valid values 0 – 248, you can still use the older values 0 – 4 this auto adds 64 and prints them to the console also.... 0 or 8 = Player chat area, 1 or 16 = Left popup area (not recommended), 2 or 32 = Centred (above the chat area), 3 or 64 = Console only, 4 or 128 = Banner area (top of screen, recommended).
b_banner;Use for specifying the text of each banner, b_bannern defines the text to be displayed for banner number n in the banner rotation, where n is an integer between 1 & 999, (i.e. set banner1 "I’m a banner", set banner2 "I’m another banner", etc).
b_banners;Defines the number of rotating server banners, (using the example in b_banner, the banners ("I’m a banner", "I’m another banner") you would then set b_banners 2), default 0 disabled, valid values 0 - 999.
b_bannertime;Defines the duration between banners, default 0, valid values 0 – n, where n is the time in seconds between banners. Values below 30 (in our opinion) would be just spamming, especially if you are printing them in the centre print area, who what’s to play in a server that is bombarding them with banners.
b_brokenlogtimestamps;Controls whether timestamps are written in a fixed-width 7 character space. This should only be enabled if you are using a log file analyser that requires the broken timestamps in order to function properly, default 0, disabled.
b_campaignFile;Allows specifying a specific campaign file, so that clients aren't forced to download every referenced pk3 on the server, default "", disabled. The syntax is "scripts/xxx.campaign".
b_chargetransfer;Controls whether use of mines to transfer charge between players or 'store charge' (exploit) is allowed, default 1, enabled (allowed).
b_cheatkicktime;Duration of auto-kick for cheater detections, (i.e. set b_cheatkicktime n, where n = how long in minutes a player is kicked for), default -1, disabled, if left disabled a report will still be logged in the b_cheatlog, if b_cheatlog is not set, it logs cheat messages to g_logfile.
b_cheatlog;Defines the name of the cheat log (ETPro anticheat), (i.e. set b_cheatlog "etpro_cheats.log"), default "", disabled. If b_cheatlog is is not set, it will still log cheat messages to g_logfile.
b_crashlogpath;Set the cvar b_crashlogpath to the path you want to save crash dump files to, (e.g. on win32 set b_crashlogpath c:\ , on Linux set b_crashlogpath /home/etserver).
b_crashpopup;On win32 you can enable a gui crash popup window - !!warning!! server will be halted until the crash dialog box is closed –, default 0, disabled.
b_cursefilter;Determines which words you would like filtered out, but it’s not a good filter as players can spell swear words in many different ways using numbers, letter spacing etc and there are just to many variations to include in this filter. A good use for it, is to help protect your rcon, ref, semiadmin etc passwords, just in case a trusted member or even yourself forget to put the / (slash) before said passwords when signing in. Should you wish to use it, just list all the passwords/forbidden words leaving a space between each word (i.e. set b_cursefilter "pass1 pass2 swear1 swear2 etc"), default "", disabled.
b_cursefilteraction;Controls what action to take with filtered words, default 3...... 0 = do nothing (not a wise choice if your wishing to filter certain words out lol), 1 = silently filter the messages (it will still appear to the player as though his/her message was sent), 2 = censor (e.g. "hey, you are a *******"), 3 = filter the message (it isn't displayed to anybody).
b_customVoiceChat;Controls whether to allow clients use custom voice chats, but not custom audio sound packs, default 1, enabled.
b_cvarempty;Resets all ETPro cvars to their defaults. If using this in a cfg/config, make sure to place it at the start, anywhere else and all cvars adjusted before it will be reset to default.
b_damagexp;Controls whether certain types of XP will be rewarded based on the damage given to other players instead of the number of complete kills. This can help even game play on extremely offence-biased maps, it solves some problems with the original per-kill system (e.g. an air strike takes a player down to 1 health and blasts them into the air, but you receive no XP when they fall to their death.) The damage-based XP system rewards 1 XP per kill and 1 XP for each 50hp of damage inflicted on an enemy player, default 0, disabled.
b_defaultbantime;Defines the time in seconds for bans without explicitly defined ban time, default 300.
b_defaultskills;Defines the skill levels granted to new players when they connect, default "", valid values 0 – 4 for each skill.This variable takes 7 space-separated integers to define each starting skill level in the following order: b_defaultskills "0 0 0 0 0 0 0", 1st 0 = Battle Sense, 2nd 0 = Explosives and Construction (Engineering), 3rd 0 = First Aid (Medic), 4th 0 = Signals(Field Ops), 5th 0 = Light Weapons, 6th 0 = Heavy Weapons (Soldier), 7th 0 = Military Intelligence and Scoped Weapons (Covert Ops). Example: To give everyone default battle sense 2 and light weapons 3, you would set b_defaultskills "2 0 0 0 3 0 0", To lock players permanently at those skill levels, you would additionally do b_noskillupgrades 1, See b_noskillupgrades for explanation.
b_distancefalloff;Controls whether bullets lose some of there hit point damage inflicted over long-range shots, default 1, enabled.
b_emptyscript;Assign the name of a script to execute when the last player leaves the server, default "", disabled.
b_ettv_flags;Bitmask controlling special features for ETTV slave clients, default 3, valid values 0-3...... 0 = Disabled, 1 = Don't allow ETTV slaves to be kicked, 2 = Automatically give ETTV slaves shoutcaster status, 3 = 1 and 2.
b_extendedprone;Controls accurate hitbox for proning animations, and makes the prone animation transition through crouching, default 0, disabled.
b_fallingbugfix;Controls whether to enable/disable a fix in the physics code, which should prevent players from getting stuck on edges and subsequently falling to their death from a small height, default 1, enabled.
b_fixedphysics;Controls various physics fixes, default 0, valid values 0-2...... 0 = Standard ET physics, 1 = Don't snap positions (avoiding rounding error), jump velocity set to match etmain's at b_fixedphysicsfps fps, 2 = Standard ET physics with anti-333fps, doesn't snap positions above 166fps or change etmain jump velocity.
b_fixedphysicsfps;Controls jump velocity when using b_fixedphysics 1. Since jump height/velocity is so strongly tied to rounding error in etmain physics, the etmain velocity doesn't make sense when no longer rounding positions. To compensate, b_fixedphysics 1 will set the player's jump velocity to the etmain equivalent at whatever frame rate b_fixedphysicsfps is set to, default 125. See also b_fixedphysics.
b_floodMaxCommands;Controls the client only being able to send the specified number of rate-limited commands per 30 seconds, to protect the server from flooding, default 6.
b_flushItems;Controls whether dropped items like medic packs lay flush to the ground they land on (same angle), default 0, disabled.
b_headshot;Bitmask controlling ETPro headshot mode, default 0, valid values 0 – 15......... 0 = disabled, 1 = headshots only, 2 = instagib (see also b_instagibDamage), 4 = clients can only damage other clients, 8 = clients only receive damage from other clients.
b_helmetprotection;Controls whether damage is reduced for the first headshot received, default 1, enabled.
b_instagibDamage;Controls the damage done when b_headshot mode's instagib is enabled, (e.g. set this to 160 so that a player can still be revived after being shot.), default 400.
b_intermissiontime;Defines the duration of the end-round intermission between maps, in seconds, default 60.
b_intreadypercent;Determines the percentage of clients needed to press ready to skip intermission countdown and continue to the next map, default 75, valid values 0 – 100.
b_levels_battlesense;Defines the amount of XP required to reach each level upgrade, 1 - 4 space-separated integers. Omitting values will disable any of the levels higher than those specified. A value of -1 for any skill level also disables that particular level, although the associated skills will still be gained when reaching a higher level, if allowed. Leaving the value blank ("") causes the default values to be used: "20 50 90 140". Examples: Disable level 3 and 4 engineers: b_levels_engineer "20 50", Don't give medics full revive until level 4: b_levels_medic "20 50 -1 140", Give everyone binoculars almost immediately: b_levels_battlesense "5 50 90 140".
b_levels_covertops;See b_levels_battlesense explanation, same rule applies.
b_levels_engineer;See b_levels_battlesense explanation, same rule applies.
b_levels_fieldops;See b_levels_battlesense explanation, same rule applies.
b_levels_lightweapons;See b_levels_battlesense explanation, same rule applies.
b_levels_medic;See b_levels_battlesense explanation, same rule applies.
b_levels_soldier;See b_levels_battlesense explanation, same rule applies.
b_logrealtimestamps;Controls whether to log the time of day (hh:mm:ss) or the amount of time the server has been on the current map, default 1 (hh:mm:ss).
b_mapconfigdirectory;Defines the folder name to look for map specific cfg/config files.
b_mapscriptdirectory;Defines the folder name to look for map scripts (i.e. set b_mapscriptdirectory "etpromapscripts").
b_match_warmupjoin;Controls whether clients are able to join teams during warm-ups, default 0, disabled.
b_maxmortarpitch;Controls whether to limit effective range of ground slope angles for mortar deployment, (e.g. if set to 20, then a mortar deployed on a slope greater than 20 degrees (e.g. 30 or 40) would behave as if it were deployed on a slope of 20 degrees), default 0, disabled.
b_moverscale;Controls how fast most movers (i.e. vehicles) will move compared to their normal speed. Extremely high values will cause erratic behaviour, default 1.0.
b_multiview;Controls enabling/disabling OSP's multiview. Multiview allows spectators to view multiple players at the same time, but clients who are using multiview consume slightly more bandwidth and CPU time than normal spectators, so not advisable unless you know your server can handle it, especially if a few specs are using it at the one time (lags server), default 1, enabled.
b_noskillupgrades;When set to 1, players may still score XP, but they will no longer gain skill or rank upgrades. This is especially useful in combination with b_defaultskills to even out game play when playing in non-campaign mode, default 0, disabled. See also b_defaultskills.
b_panzerlevelup;Determines the skill level at which the panzerfausts receive the 'Improved Projectile Resources' upgrade. The mortar is unaffected. A value of 5 means that the panzerfaust will never be subject to this upgrade, default 1, valid values 1 – 5.
b_privatemessages;Determines the minimum number of allowable characters for name matching of private messages. A value of "0" disables private messaging entirely, default 2, valid values 0 – 36.
b_pronedelay;Implements a delay in the client's proning action, default 0...... 0 = etmain normal behaviour, no spread change, players may not un-prone for 750ms, 1 = max spread for 1 second after proning, players may not un-prone for 1750ms.
b_realhead;Controls correcting the head hit box, when enabled, the head hit box is where the head is drawn on the client, instead of at the top-centre of the body-hit box, default 1, enabled. Settings other than 0/1 are for debugging.
b_riflegrenades;Controls whether to allow rifle grenades, default 1 enabled. See also team_maxriflegrenades.
b_semiAdminCmds;Defines what commands are available for each semiadmin level.
b_semiAdminLevels;Defines the number of semi admin levels. If undefined ("") or 0, then the semi admin feature is disabled, default 0, disabled, valid values 0 – 99.
b_semiAdminPass;Defines the required password for clients to become a semi admin. A different password is required for each b_semiadminlevel.
b_shoutcastpassword;Defines the password required for special spectator class.
b_shove;Controls how strong shoves are, default 80, 0 to disable.
b_shove_noz;Controls vertical shoving, default 1, enabled. When enabled this prevents players shoving others over walls or up to unreachable places.
b_showClientCmds;Controls whether all commands clients send to the server are written to the log file, default 0, disabled.
b_shrug;Controls whether clients can use shrug, default 0, disabled.
b_spectatorNames;Controls whether spectators are allowed to see the player name popup when looking at another player, default 1. 0 = No names shown, disabled, 1 = Names shown to referees and semiadmins only, 2 = Names shown to all players.
b_statsaver;Controls whether client's xp and stats are restored if they exit, then return to the server. This is not XP save it’s only a stats saver, all stats will be reset whenever the game normally does a stats reset (e.g. when restarting a campaign or starting a new campaign), default 1, enabled.
b_stickycharge;When set to 1, per-class charge bars become 'sticky', players will only have their charge bar refilled on respawn if they were killed by an enemy player, default 1, valid values 0 – 2...... 0 = Full recharge, 1 = If killed by enemy, then full recharge, otherwise normal recharge, 2 = Normal recharge no matter how you died, Normal recharge = Gradually filling as if you weren’t killed.
b_sv_hitsounds;Controls whether clients are allowed use hit sounds, default 1, enabled.
b_watermark;Specifies the location of the watermark file, default "", disabled. Automatically prepends "watermark/". Links to more info at bottom of page.
b_watermarkFadeAfter;Determines how long the watermark will stay on the screen before fading away. A value of -1 and the watermark will not fade off, default -1, valid values -1, 0, n, where n = the length of time in seconds before the watermark starts fading.
b_watermarkFadeTime;Determines the duration the watermark image takes to actually fade away, default 1.5, valid values: 0 - n, where n = the length of time in seconds before the watermark fades out.
b_wolfrof;Controls whether the SMG rate of fire is equal to that of RTCW's Thompson (much faster), default 0...... 0 = ET Standard SMG Rate of fire, 1 = RTCW Standard SMG Rate of fire.
b_xpstopwatch;Controls whether XP remains over stopwatch rounds, default 0, disabled. If set to 1 XP gained in the first round remains in the concluding round.
config;Used for loading an ETPro style config file (i.e. config clanwar, would load clanwar.config).
forcecvar;Used to force cvars to a specified value for all connected clients, (i.e. command "forcecvar r_drawfoliage 0", commonly used for the map Radar). Link for more info at bottom of page.
lua_allowedmodules;If set, only lua modules with the matching sha1 signatures listed in this cvar will be allowed to load, default "", disabled.
lua_modules;Space separated list of lua modules for ETPro to load, modules will be run in the order listed, default "", disabled. Links for more info on Lua's at bottom of page.
p;Replaces Players_Allies and Players_axis. Goto link at bottom of page for better explanation.
sv_cvar;Used for ETPro cvar restrictions. Goto Link at bottom of page for an explanation on how to use them.
team_maxCovertops;Determines the max number of covert ops allowed on each team, default –1, unlimited
team_maxEngineers;Determines the max number of engineers allowed on each team, default –1, unlimited.
team_maxFieldops;Determines the max number of field ops allowed on each team, default –1, unlimited.
team_maxFlamers;Determines the max number of flamers allowed for each team, default –1, unlimited.
team_maxMedics;Determines the max number of medics allowed on each team, default –1, unlimited.
team_maxMg42s;Determines the max number of mobile MG's allowed for each team, default –1, unlimited.
team_maxMines;Determines the max number of mines available for each team, default 10, -1 unlimited
team_maxMortars;Determines the max number of mortars allowed for each team, default –1, unlimited.
team_maxPanzers;Determines the max number of panzerfausts allowed for each team, default –1, unlimited.
team_maxplayers;Determines the max number of players that can join each team.
team_maxriflegrenades;Determines the max number of riflegrenades allowed for each team, default –1, unlimited. See also b_riflegrenades.
team_maxSoldiers;Determines the max number of soldiers allowed on each team, default -1, unlimited.
vote_allow_config;Specify config's that can be loaded by vote, default "", disabled, "*" to allow all config's.
vote_allow_surrender;Controls whether teams can call a vote to surrender, default 1, enabled.
</pitatable>

=== Links ===

*[[IAC]]
*[[AntiWarp]]
*[[Cursefilter]]
*[[ETPro_CVARS | Fixedphysics]]
*[[SemiAdmin]]
*[[Shoutcasting]]
*[http://bani.anime.net/etpro/adminguide.html Watermark]
*[http://bani.anime.net/banimod/forums/viewtopic.php?t=2033 Watermark]
*[[Forced_Cvars]]
*[[Lua_Mod_API | Lua Mod]]
*[[ETPro:Lua_Sample_Code | Lua Sample Code]]
*[[Cvar_Restrictions | sv_cvar Restrictions]]
*[[ETPro:Server_Configuration]]
*[[Extended_ASCII]]

Talk:Client cvar list

2006-04-28T04:43:41Z

Lagger:

Thanks [[User:The Birdman|The Birdman]] for the work one the server and client cvar and command list. They are very helpful. However, it seems like there is a basic problem. The pitatable doesn't allow formatting and linking, and some of these things are complex enough to justify having their own page. Some command/cvars are related, and are described on a single page (e.g. [[Physics cvars]]).

Putting each item on it's own page, and using a wiki catagory to generate a bare list of the names (as in [[:Category:ETPro:Client Cvars]]) isn't a complete solution either. When trying to find a command or cvar, without knowing exactly what it is, you want to look at a list with brief descriptions of each item, and a link to further information where it is available. Suggestions as to how to cleanly achieve this with wiki are requested.

[[User:ReyalP|ReyalP]] 19:29, 20 March 2006 (PST)

I guess someone with too much time on his hands could convert the tables to wiki tables. Descriptions can be shortened immensely with linking. --[[User:Lagger|Lagger]] 21:01, 27 April 2006 (PDT)

And of course that someone would be me. Anyways, as a test, I have converted the first table to a wiki table using [http://de.wikipedia.org/wiki/Wikipedia:Helferlein/EXCEL_Tabellenumwandlung]. The tradeoff is that it's basically a pain to insert new entries. If it doesn't work out just revert the changes. --[[User:Lagger|Lagger]] 21:43, 27 April 2006 (PDT)

Client cvar list

2006-04-28T04:22:25Z

Lagger: Tried converting the pitatable to a wikitable - allowing links to be put into the table

== '''ETPro Client cvars and commands''' ==
By The Birdman & =FF=im2good4u

This list contains all ETPro client cvars and commands (hopefully).

We have tried to include as much information in each description as possible, but some might require more explaining, so links to other pages here or the forums have been added.

'''Note:'''
If there is any ETPro client cvars/commands that you think we have omitted or any that you think the description is wrong then pm me [http://bani.anime.net/banimod/forums/profile.php?mode=viewprofile&u=3475 here], if you don't know how to edit this page. Before pm’ing/editing are you sure it’s an ETPro cvar/command and not another mods or an ETmain one, if it is ETPro then either edit or let me know what cvar/command we’ve omitted, adding a short description of what it’s use is, if known to you. If you think a description is wrong, quote the cvar/command and it’s description adding your description of it or edit.

Apologies for all the ..... to try create new lines or push things along to create a line so things look a bit better in some of the description sections, but i couldn't start new lines using the pitatable.

=== Cvars ===

Most of these cvars are either 0 (disabled) or 1 (enabled), those that differ I have included the values in the description. See [[Bitmask-cvar]] for more information on bit mask cvars.

{|{{prettytable}}
|- style="font-weight:bold" valign="bottom"
| width="153.75" Height="12.75" | Cvar
| width="1342.5" | Purpose

|- style="background-color:#C0C0C0" valign="bottom"
| Height="12.75" | b_altHud
| Controls which hud design you use, default 0 (normal hud), valid values 0, 1, 2 and 3. Three is custom mode where you can drag and drop the hud objects (i.e. compass, chargebar etc) where you would like them, but work was never finished on this.

|- valign="bottom"
| Height="12.75" | b_altHudFlags
| Bitmask for controlling various hud settings if b_altHud = 1 or 2, default 0, valid values 0-7................... 1 = Move round timer, 2 = Don't display rank in hud, 3 = RTCW-ish message placement, 4 = Custom (drag and drop not working, coding was never finished)

|- style="background-color:#C0C0C0" valign="bottom"
| Height="12.75" | b_antilag
| Controls whether shots are lag-compensated by the server, default 1, enabled, valid values 0,1,2........... 0 = Disabled, 1 = ETPro antilag enabled (best), 2 = ETmain antilag enabled

|- valign="bottom"
| Height="12.75" | b_backupcvars
| Controls whether backup files are made when ETPro cvar restrictions are applied, default 1, enabled.

|- style="background-color:#C0C0C0" valign="bottom"
| Height="12.75" | b_beginround
| Assign commands to this and they will be automatically executed at the start of new a round/map. See also b_endround.

|- valign="bottom"
| Height="12.75" | b_centeredWeapons
| Centers weapon models on entity origins, making weapon pickup more predictable. default 1 = enabled, 0 old ET way.

|- style="background-color:#C0C0C0" valign="bottom"
| Height="12.75" | b_chatAlpha
| Defines the alpha of the chat text, default 0.33, valid values 0.0 – 1.0, (0.0 = 100% transparent).

|- valign="bottom"
| Height="12.75" | b_chatFlags
| Controls whether the team flag is drawn by each chat text, default 1, enabled.

|- style="background-color:#C0C0C0" valign="bottom"
| Height="12.75" | b_chatsounds
| Controls playing a sound with chats, default 0, disabled.

|- valign="bottom"
| Height="12.75" | b_cmdwarnings
| Controls notifications from the tjl_* commands, default 1, enabled.

|- style="background-color:#C0C0C0" valign="bottom"
| Height="12.75" | b_debugfakebmodel
| Controls debugging EF_FAKEBMODEL brushes in map scripts, default 0, disabled, (cheat protected).

|- valign="bottom"
| Height="12.75" | b_debuglocations
| Bitmask to enable debugging/design aids for location names. Works with external dats as well as target_location ents, default 0, valid values: 0 - 31, (cheat protected).................................................. 1 = Draw a bubble sprite at each location marker. The nearest location is drawn in green, with all the others being drawn in red...... 2 = Add a dynamic light at each location marker. The nearest location is lit in red, with all the others being lit in green...... 4 = Draw floating text at each location marker containing the location's name. The nearest location is colored green instead of white...... 8 = Send updates to other players when a location is added, deleted, or renamed. This function is designed to allow several people to work on adding locations to a level simultaneously...... 16 = Accept updates to locations from other players who are using b_debuglocations 8.

|- style="background-color:#C0C0C0" valign="bottom"
| Height="12.75" | b_demo_autotimescale
| Controls the timescale to switch to when a weapon set in b_demo_autotimescaleweapons is fired, default 1.

|- valign="bottom"
| Height="12.75" | b_demo_autotimescaleweapons
| Bitmask to automatically change the timescale when a certain type of weapon is fired, default 0, disabled, valid values 0 – 31. 1 = Panzerfaust, 2 = Grenade, 4 = Dynamite, 8 = Mortar, 16 = Smoke grenades and airstrike markers

|- style="background-color:#C0C0C0" valign="bottom"
| Height="12.75" | b_demo_drawspectatormessages
| Controls whether "spectator/weaponcam/shoutcaster/etc" overlay is drawn in demo playback, default 1, enabled.

|- valign="bottom"
| Height="12.75" | b_demo_dynamitecam
| Controls whether to attach the camera to dynamite during demo playback, default 0, disabled.

|- style="background-color:#C0C0C0" valign="bottom"
| Height="12.75" | b_demo_dynamitecounter
| Controls drawing a floating counter above armed dynamite during demo playback and when spectating as a shoutcaster, default 0, disabled.

|- valign="bottom"
| Height="12.75" | b_demo_followxDistance
| Controls camera offset when attached to a weapon, default 50.

|- style="background-color:#C0C0C0" valign="bottom"
| Height="12.75" | b_demo_followyDistance
| Controls camera offset when attached to a weapon, default 0.

|- valign="bottom"
| Height="12.75" | b_demo_followzDistance
| Controls camera offset when attached to a weapon, default 20.

|- style="background-color:#C0C0C0" valign="bottom"
| Height="12.75" | b_demo_freecamspeed
| Controls the freecam movement speed, default 800.

|- valign="bottom"
| Height="12.75" | b_demo_grenadecam
| Controls whether to attach the camera to these types of grenades during demo playback, default 0, valid values 0, 1, 2, 3.................. 0 = Disabled, 1 = Grenades (hand-thrown thrown and rifle grenades), 2 = Airstrike markers, smoke grenades, 3 = 1 and 2

|- style="background-color:#C0C0C0" valign="bottom"
| Height="12.75" | b_demo_lookat
| Causes the freecam to lock its view on the specified player (i.e. /b_demo_lookat clientnum), default –1, disabled. To get client numbers in demos see b_demo_nametags for explanation.

|- valign="bottom"
| Height="12.75" | b_demo_mortarcam
| Controls whether to attach the camera to mortars during demo playback, default 0, disabled.

|- style="background-color:#C0C0C0" valign="bottom"
| Height="12.75" | b_demo_nametags
| Bitmask controlling how floating names above each player are drawn during demo playback and when spectating as a shoutcaster, default 0, valid values 0-15............ 0 = Disabled, 1 = Draw visible players, 2 = Draw all players, 4 = Draw the player's client number, 8 = Draw the player's class.

|- valign="bottom"
| Height="12.75" | b_demo_nopitch
| Controls whether the camera pitch’s while it's attached to weapons, default 1, enabled (no pitch).

|- style="background-color:#C0C0C0" valign="bottom"
| Height="12.75" | b_demo_panzercam
| Controls whether to attach the camera to panzers during demo playback, default 0, disabled.

|- valign="bottom"
| Height="12.75" | b_demo_pitchturnspeed
| Defines the pitch turn speed while using the +freecam_* commands (demo playback only), default 140, see also b_demo_rollspeed and b_demo_yawturnspeed

|- style="background-color:#C0C0C0" valign="bottom"
| Height="12.75" | b_demo_playersprites
| Controls whether the floating sprites (e.g. voicechat, objective, invulnerability, fireteam, and connection markers) are drawn above players' heads in demo playback, default 1, enabled.

|- valign="bottom"
| Height="12.75" | b_demo_pvshint
| Controls whether to draw a line from the freecam origin to the origin of the demo recorder, default 0, disabled.

|- style="background-color:#C0C0C0" valign="bottom"
| Height="12.75" | b_demo_rollspeed
| Defines the roll speed while using the +freecam_* commands (demo playback only), default 140, see also b_demo_pitchturnspeed and b_demo_yawturnspeed

|- valign="bottom"
| Height="12.75" | b_demo_teamonlymissilecam
| Controls whether to attach the camera to weapons fired by demo recorders team only, default 0, disabled.

|- style="background-color:#C0C0C0" valign="bottom"
| Height="12.75" | b_demo_yawturnspeed
| Defines the yaw turn speed while using the +freecam_* commands (demo playback only), default 140, see also b_demo_rollspeed and b_demo_pitchturnspeed

|- valign="bottom"
| Height="12.75" | b_demorecord_statusline
| Controls the y offset of the demo/tjl/tjg recording status line. Use -1 to disable these status lines completely, default: 470, valid values -1, 0 - 480.

|- style="background-color:#C0C0C0" valign="bottom"
| Height="12.75" | b_descriptiveTextscale
| Controls the limbo hud text size, default 0.8.

|- valign="bottom"
| Height="12.75" | b_dinghy
| Have no idea what this does, or maybe we do.

|- style="background-color:#C0C0C0" valign="bottom"
| Height="12.75" | b_drawclock
| Controls whether to show a clock with your local time on the hud, default 0, disabled.

|- valign="bottom"
| Height="12.75" | b_drawPromotions
| Controls whether the rank promotion messages are shown (and whether sounds played) when receiving a promotion, default 1, enabled.

|- style="background-color:#C0C0C0" valign="bottom"
| Height="12.75" | b_drawranks
| Controls whether ranks of other players are drawn when using cg_crosshairnames, default 1, enabled.

|- valign="bottom"
| Height="12.75" | b_drawRewards
| Controls whether skill level increases and reward messages are shown (and whether sounds played), default 1, enabled.

|- style="background-color:#C0C0C0" valign="bottom"
| Height="12.75" | b_drawspectatoralpha
| Defines the alpha of the "spectator", "shoutcaster", "freecam", etc. notices (0 = 100% transparent), default 1, valid values 0.00 - 1.00

|- valign="bottom"
| Height="12.75" | b_drawspectatorteamflags
| Controls whether to draw a small team flag beside the player name when following players in spectator mode, default 1, enabled.

|- style="background-color:#C0C0C0" valign="bottom"
| Height="12.75" | b_drawspeed
| Controls whether to draw a speedometer on the hud, default 0, valid values 0, 1, 2, 3, 4, 5................... 0 = Disabled..... 1, 5 = Draw a speedometer....... 2, 4 = Draw a speedometer and the maximum speed reached...... 3, 4, 5 = Draw a speed graph if the lagometer is not being drawn

|- valign="bottom"
| Height="12.75" | b_endround
| Assign commands to this and they will be automatically executed at round end. See also b_beginround.

|- style="background-color:#C0C0C0" valign="bottom"
| Height="12.75" | b_fireteamAlpha
| Defines the alpha of the fireteam overlay, (0 = 100% transparent), default 1.0, valid values 0.00 – 1.00.

|- valign="bottom"
| Height="12.75" | b_fireteamLatchedClass
| Controls showing latched player class instead of rank in fire team hud display, default 1, enabled.

|- style="background-color:#C0C0C0" valign="bottom"
| Height="12.75" | b_goatsound
| Controls whether a sound is played on knife kills, default 1, enabled.

|- valign="bottom"
| Height="12.75" | b_hitsounds
| Controls whether to enable hit sounds, default 0, valid values 0, 1, 2............ 0 = disabled, 1 = enabled, 2 = enabled for headshots only

|- style="background-color:#C0C0C0" valign="bottom"
| Height="12.75" | b_hudYoffset
| Moves the hud so it is out of the way of the demo status line. Set to 0 to move the hud flush with the edge of the screen, default 10.0, valid values 0 – 640.

|- valign="bottom"
| Height="12.75" | b_killshot_delay
| Determines the time in milliseconds to take an automatic screenshot after a kill, default 0, disabled.

|- style="background-color:#C0C0C0" valign="bottom"
| Height="12.75" | b_lagometerAlpha
| Defines the alpha of the lagometer, default 1.0, valid values 0.00 – 1.0 (0 = 100% transparent). Link at the bottom of page for more info about the lagometer.

|- valign="bottom"
| Height="12.75" | b_locationJustify
| Controls justification of locations in fire team hud, default 0....................... -1 = left justify with padding, 0 = left justify no padding, 1 = right justify with padding

|- style="background-color:#C0C0C0" valign="bottom"
| Height="12.75" | b_locationMaxChars
| Controls the number of characters of location names in the Fireteam hud, default 25, valid values 0-76.

|- valign="bottom"
| Height="12.75" | b_locationMode
| Bitmask to control how locations are displayed in the fireteam hud, default 0, valid values 0-31............ 0 = Default, currently equivalent to '1'...... 1 = Show location names...... 2 = Show location coordinates, 4 = Do not check whether locations are in your PVS when searching for a location name. Applies to b_debuglocations and add/del/etc., too...... 8 = Don’t fall back to location coordinates when no location name was found, instead, show "unknown"

|- style="background-color:#C0C0C0" valign="bottom"
| Height="12.75" | b_logbanners
| Controls whether server banners are logged in your console, default 1, enabled.

|- valign="bottom"
| Height="12.75" | b_mapconfigdirectory
| Defines the folder name to look for map-specific cfg/config files.

|- style="background-color:#C0C0C0" valign="bottom"
| Height="12.75" | b_mapzoom
| Controls the zoom level for the map shown in the compass, default 5.159, valid values 1.0 - 7.43.

|- valign="bottom"
| Height="12.75" | b_muzzleflash
| Controls whether first-person muzzle flash is drawn, default 1, enabled.

|- style="background-color:#C0C0C0" valign="bottom"
| Height="12.75" | b_noactivatelean
| Controls whether to enable/disable leaning behaviour when strafing with +activate, default 0.................. 0 = +activate and +moveleft/+moveright causes the player to lean left/right........ 1 = leaning behaviour is disabled

|- valign="bottom"
| Height="12.75" | b_numPopups
| Controls the number of popup messages on the hud, default –1...... -1 = Use ETmain cg_drawSmallPopupIcons setting, (if cg var = 0) 5 popups, (if cg var = 1) 8 popups...... 0 = Disable popup messages entirely...... 1 = Use ETmain cg_drawSmallPopupIcons 1, 8 popups...... 'number' = Limit the number of popup messages on the hud to the number of your choice

|- style="background-color:#C0C0C0" valign="bottom"
| Height="12.75" | b_optimizePrediction
| Controls whether to attempt to use previously calculated prediction results when possible to increase performance or not, default 1, enabled. Link at bottom of page for more info on this.

|- valign="bottom"
| Height="12.75" | b_panzerhack
| Controls whether the secondary MP40/Thompson (for a soldier with level 4 heavy weapons) is moved to weaponbank 2, default 1, enabled.

|- style="background-color:#C0C0C0" valign="bottom"
| Height="12.75" | b_placebo
| When this cvar is enabled, anything is possible. Link at bottom of page which explains this better.

|- valign="bottom"
| Height="12.75" | b_popupFadeTime
| Defines the time in milliseconds that popups take to fade out, default 2500.

|- style="background-color:#C0C0C0" valign="bottom"
| Height="12.75" | b_popupStayTime
| Defines the time in milliseconds that popups will stay before fading, default 2000.

|- valign="bottom"
| Height="12.75" | b_popupTime
| Defines the time in milliseconds between popups, default 1000.

|- style="background-color:#C0C0C0" valign="bottom"
| Height="12.75" | b_predefineddemokeys
| Controls whether demo playback uses hard-coded key bindings, which cannot be overridden, default 1, enabled...... 0 = Lets you use your own key bindings in demo playback, at the loss of the predefined key actions...... 1 = Hard-coded key bindings, which cannot be overridden.

|- valign="bottom"
| Height="12.75" | b_shovesounds
| Controls whether you hear shove sounds, default 1, enabled.

|- style="background-color:#C0C0C0" valign="bottom"
| Height="12.75" | b_simpleItems
| Controls whether to draw sprites instead of models for items, for a slight performance/visibility increase, default 0, disabled.

|- valign="bottom"
| Height="12.75" | b_spectatorteamflags
| default 1, enabled.

|- style="background-color:#C0C0C0" valign="bottom"
| Height="12.75" | b_speedinterval
| Defines the time in milliseconds between two speedometer updates, default 100.

|- valign="bottom"
| Height="12.75" | b_speedunit
| Controls the speed unit used for the ups meter, default 0, valid values 0, 1, 2...... 0 = (ups), 1 = (mph), 2 = (km/h)

|- style="background-color:#C0C0C0" valign="bottom"
| Height="12.75" | b_textcolorfilter
| Strips certain colour characters from names and most text messages, default "", use "*" to filter all.

|- valign="bottom"
| Height="12.75" | b_tracers
| Controls bullet tracers, default 1, valid values 0, 1, 2...... 0 = Disabled, 1 = Show all tracers, 2 = Don't show own tracers

|- style="background-color:#C0C0C0" valign="bottom"
| Height="12.75" | b_votetextscale
| Defines the scaling for the vote text, default 0.8.

|- valign="bottom"
| Height="12.75" | b_watermarkAlpha
| Defines the alpha of a watermark (if server has one), default 1, valid values 0.00 – 1.0 (0 = 100% transparent).

|- style="background-color:#C0C0C0" valign="bottom"
| Height="12.75" | b_weapaltReloads
| Controls whether weapalt doubles as reload for weapons lacking an alternate fire mode, default 1, enabled.

|}

=== Commands ===
Clients can use to either bind, get info in the console or use with rcon, ref and semiadmin.
<pitatable columns=2 headlines="Cvar;Description" headerbgcolor="0b53b4" headerfontcolor="#FFFFFF" border1=2 border2=1 aligns="left;left">
guids;Displays a list of players and their ETPro guid’s in the console.
b_cvarlist;Displays a list of ETPro cvar limits of the server you are in, (only shows if the server has cvar limits set).
b_cvarempty;Resets all ETPro cvars to their defaults.
Bp;Sends text to all clients to be displayed in the banner area.
camera;Used to run scripted cameras, whatever.camera files. 2 Links at bottom of page which helps explain this better.
cancelvote;Cancels any vote in progress.
cheaters;Lists all clients in console, with info on whether they are cheating.To check on just one particular client use /cheaters client slot, this will return the IAC info of only that chosen client. Link at bottom of page, for better explanation.
class;Class allows you to script the selection of team and class, (syntax: class class weapon {secondary weapon}, e.g. cs_mg42 "class s 2 3). Link at bottom of page for better explanation.
classmenu;Command for opening the class selection menu. Link at bottom of page for better explanation.
clearlines;Empties out the debug line queue (e.g. if a bunch of railtrail lines with a huge cg_railtrailtime are in the buffer.)
Cp;Sends text to all clients to be displayed in the centerprint area.
etpro_alliedmapxp;Non-user, write-protected cvar for internal use in ETPro.
etpro_axismapxp;Non-user, write-protected cvar for internal use in ETPro.
etpro_lastmapname;Non-user, write-protected cvar for internal use in ETPro.
etpro_session;Non-user, write-protected cvar for internal use in ETPro.
exec_at_time;Allows scripts to be executed exactly at a specified frame number (demo playback only).
follow;For specifying which player to spectate (i.e. /follow <client slot>).
follownext;Spectate the next guy (normally bound to your fire button (mouse1) when spectating).
followprev;Spectate the previous guy.
freecam;Allows for you to switch in and out of freecam in demo playback.
freecamgetpos;Retrieves the position of the camera.
freecamsetpos;Sets the position of the camera. (mainly for use with scripted cameras)
inviteall;Used with fireteam to invite all teammates into fireteam, if they aren’t already in one (i.e. /fireteam inviteall).
kill;ETPro change: /kill now counts as a death.
Listcs;Dumps all of the current configstrings to the server console, (mostly useful as a debugging or map making tool).
loc_add;For adding location names. Link at bottom of page for better explanation of loc_* vars.
loc_del;For deleting location names, (doesn’t have to be the exact name, it will delete the closest one).
loc_load;Load the specified location-name file, (i.e. loc_load filename).
loc_rename;For renaming location names, (doesn’t have to be the exact name, it will rename the closest one to what was specified).
loc_save;Saves location names to the specified file, (i.e. loc_save filename).
loc_show;Shows location name of an imperfectly specified location.
m;Pretext for sending a private message (i.e. /m playername message), to send to all clan members in the server, instead of a playername use your clan tag (i.e. if your clan tag is -lol- then, /m -lol- hi guys, would send the message ‘hi guys’ to all players with -lol- in their name, naturally just your clan mates).
makesc, makeshoutcast, makeshoutcaster;Use to give a specified player shoutcaster status, (i.e. /makesc clientid).
msg;Same as /m, but broken on servers.
mt;Similar to m, but this pretext just sends private messages to players on your own team axis/allies (i.e. /mt playername message), if you try using this to send a private message to a player on the opposing team then he won’t receive it, it only search’s for players playername on your own team.
mv_sensitivity;MultiView : Note NEED MORE INFO ON MULTIVEIW CVARS, feel free to edit
mvactivate;Command to enter and exit Multiview mode, more info <a href="http://bani.anime.net/etpro/playerguide.html">here</a>.
mvadd;MultiView
mvall;Command to view all players in multiview.
mvallies;Command to view all allied players in multiview.
mvaxis;Command to view all Axis players in multiview.
mvdel;MultiView
mvhide;MultiView
mvnew;MultiView
mvnone;MultiView
mvshow;MultiView
mvswap;MultiView
mvtoggle;MultiView
notice;Don’t know what this is used for but when you type it in the console (/notice) it returns with some lol statements, for example: “etpro comes with no warranties of any kind – if it breaks, you get to keep both pieces”, “heeey, sticklyman! WhaaAaAaAAaaAt are you doing?!” Etc
openTimerInput;For setting ETPro’s enemy spawn time. This opens a box to set the enemy's spawn time in. See also resetTimer and timerSet.
passvote;Passes any vote in progress.
pm;Same as /m, but broken on servers.
qsay;Sends text to all clients to be displayed in the chat area without the server: prefix.
ref;For logging in with a password for Ref status. Allows access to the referee commands from the server console/menu.
reflogout;For logging out from Ref status.
removesc, removeshoutcast, removeshoutcaster;Use to remove a specified player from shoutcaster status, (i.e. /removesc clientid).
resetmaxspeed;Clears/resets max speed.
resetTimer;Resets ETPro’s enemy spawntimer. See also openTimerInput and timerSet.
sa, semiAdmin;For use when logged in as a semiAdmin. This all depends on what commands the server admin has assigned to you for use. Semiadmins may also check their current level and available commands with /sa or /semiadmin by itself with no parameters. Example: If the server admin has assigned you the command map_restart, then when logged in as semiadmin to restart the current map you would type into the console /sa map_restart
sal, semiAdminLogin;For logging in with a password for SemiAdmin status, (i.e. /semiadminlogin password or /sal password)
say_buddy;Used to send chat messages to all in your fireteam or one particular fireteam mate (i.e. /say_buddy1 hi)
scLogin, shoutCastLogin;For logging in with a password for shoutcaster status.
scLogout, shoutCastLogout;For logging out of shoutcaster status.
setcs;Sets the value of configstring number num to value (i.e. setcs num value).
show_framecount;Shows the frame count in demo playback, default 0...... 0 = No frame counter, 1 = Show frame counter, 2 = Snapshot current frame number.
shrug;Allows for the use of shrug silliness if enabled on the server, (i.e. bind w "+forward; shrug").
shuffleteamsxp_norestart;Command to shuffle teams by XP, without restarting the map.
skills;Lists in console what XP is required to reach each promotion level of each particular class (i.e. /skills). An easier option now is the menu "+stats" (normally bound to alt), this shows what you require as the class you are playing.
spechelp;Toggles spectator help in multiview.
teammenu;Command to open a v-chat style menu to select your class & weapon.
Time;Reports the game state and round time remaining.
timerSet;For setting ETPro’s enemy spawntimer. See also resetTimer and openTimerInput.
ui_browserShowETPro;Controls what type mod servers you see in your browser server list...... 0 = Show all...... 1 = Only show ETPro servers...... 2 = Don’t show ETPro servers.
weapons;Lists in the console what weapon you or your teammates have now and what they are going to spawn with next, but only if another respawn class choice is picked and only if the weapon has a max amount set.
vsay num;If a voicechat has multiple announcements you can specify which one to call, (i.e. /vsay num voicechat, /vsay 2 FTAttack)
</pitatable>

=== Trickjump Cvars ===
Note: cheats must be enabled to use these. See the pages for [[TrickJumpLines]] (tjl) and [[TrickJumpGhosts]] (tjg) for more information.

<pitatable columns=2 headlines="Cvar;Description" headerbgcolor="0b53b4" headerfontcolor="#FFFFFF" border1=2 border2=1 aligns="left;left">
b_tjg_ghostfx;Controls special effects for trick jump ghosts to distinguish them from normal players, default 2, valid values 0 - 4... 0 = No effect, 1 = Flicker, 2 = Ghost, 3 = Flaming, 4 = Flame only
b_tjl_color;Sets the default trick jump line color default green, valid values: any hex RGB color values (e.g. 0x56789a), or a known color name (e.g. "red", "white", "green", etc), -1 to disable.
b_tjl_draw;Controls whether trick jump lines will be drawn, default 1, enabled.
b_tjl_quickslot;Defines the slot used when specifying "quickslot" to tjl_startrecord, this is also the slot used by tjl_menu, default 0, disabled.
b_tjl_showmaxspeed;Controls whether the top speed reached will be drawn at the appropriate point on a trickjump line, default 0, disabled.
b_tjl_stepsize;Controls the minimum distance between any two points of the drawn trick jump line (increasing this may improve rendering performance for very long lines), default 0.5.
b_tjl_stoponnomove;Controls whether the trick jump line recording will automatically stop when the player being recorded stops moving, default 1, enabled.
</pitatable>

=== Trickjump Commands ===
<pitatable columns=2 headlines="Command;Description" headerbgcolor="0b53b4" headerfontcolor="#FFFFFF" border1=2 border2=1 aligns="left;left">
tjg_info;This will give you detailed information about all the tjg command's and cvars.
tjg_load;Loads a recording from a file, (i.e. tjg_load filename).
tjg_menu;A convenient menu for the tjg tools.
tjg_pause;Pauses/resumes the ghost playback.
tjg_play;Plays back a recorded ghost.
tjg_record;Starts recording your movements.
tjg_save;Saves a recording to a file, (i.e. tjg_save filename).
tjg_stop;Stops playing or recording.
tjl_drawslot;Controls drawing for a given slot or changes a slot's color (i.e. /tjl_drawslot slot OR slot color), b_tjl_color must be set to -1 in order to use this option.
tjl_info;This will give you detailed information about all the tjl command's and cvars.
tjl_load;Loads the current file into a slot (i.e. /tjl_load filename slot), (file extension = .tjl_1.dat (1 = version #)).
tjl_menu;A convenient menu for the tjl tools.
tjl_save;Saves the current slot into a file (i.e. / tjl_save filename slot), (file extension = .tjl_1.dat (1 = version #)).
tjl_startrecord;Starts recording you or a clients movements (i.e. tjl_startrecord clientnum slot OR slot OR no parameters records your own movements).
tjl_stoprecord;Stops recording movements.
</pitatable>

=== Links ===
Links to more info about some of the above or other useful client pages here on WolfWiki.

*[[Lagometer]]
*[[Physics cvars]]
*[[B_placebo]]
*[http://bani.anime.net/banimod/forums/viewtopic.php?t=3332 Camera]
*[http://bani.anime.net/banimod/forums/viewtopic.php?t=6305 Camera]
*[http://bani.anime.net/banimod/forums/viewtopic.php?t=3333 Cheaters]
*[[Player_Scripting | Class & Classmenu]]
*[[Target_location | Locations]]
*[http://bani.anime.net/etpro/playerguide.html Multiview]
*[[SemiAdmin]]
*[[Memory_cvars | Hunk, Zone and sound Megs]]
*[[DrawFPS]]
*[[Client Configuration]]
*[[EDV]]
*[[Extended ASCII]]
*[[ETTV:Server Configuration]]
*[[ETTV:Viewer's Guide]]
*[[Voicechat]]

[[Category:ETPro:Client_Cvars]]

Talk:Client cvar list

2006-04-28T04:01:24Z

Lagger:

Players

2006-04-28T03:25:51Z

Lagger: categorized

The serverinfo cvars ''Players_Axis'',''Players_Allies'' have been removed from etpro.

== Reasons ==
The cvars could get very long, in some cases so long that they would overflow the serverinfo string and crash the server.
There was no way to associate spectator client ID#'s with listed players, nor players who had not yet finished connecting.

== Solution ==

ETPro introduces a new cvar which is shorter (so it doesn't overflow the serverinfo string and cause server crashes), easier to parse, and allows for associating player client ID's in all cases.

== Format ==

The new cvar is P, and probably the easiest way to show its usage is by example:

<pre>29 frags 30ms bani
106 frags 20ms rain
189 frags 50ms zinx
63 frags 32ms fretn
43 frags 96ms duke'ku
0 frags 999ms ikkyo
100 frags 56ms majikthise
22 frags 108ms boco
31 frags 101ms vio
0 frags 44ms ohayden

P=--------221120111-3</pre>

In this case the first 8 server slots are empty (client id 0-7), probably private server slots. bani and rain are client ids 8 and 9, both allies. zinx and fretn are client ids 10 and 11, both axis. duke'ku is allied in client id 12. ikkyo is still connecting in client id 13 and has not been assigned a team yet. majikthise, boco and vio are all axis in slots 14-16. slot 17 is empty. slot 18 is ohayden as spectator.
[[Category:ETPro]][[Category:ETPro:Server_Cvars]]

Client cvar list

2006-04-28T03:21:38Z

Lagger: categorized

== '''ETPro Client cvars and commands''' ==
By The Birdman & =FF=im2good4u

This list contains all ETPro client cvars and commands (hopefully).

We have tried to include as much information in each description as possible, but some might require more explaining, so links to other pages here or the forums have been added.

'''Note:'''
If there is any ETPro client cvars/commands that you think we have omitted or any that you think the description is wrong then pm me [http://bani.anime.net/banimod/forums/profile.php?mode=viewprofile&u=3475 here], if you don't know how to edit this page. Before pm’ing/editing are you sure it’s an ETPro cvar/command and not another mods or an ETmain one, if it is ETPro then either edit or let me know what cvar/command we’ve omitted, adding a short description of what it’s use is, if known to you. If you think a description is wrong, quote the cvar/command and it’s description adding your description of it or edit.

Apologies for all the ..... to try create new lines or push things along to create a line so things look a bit better in some of the description sections, but i couldn't start new lines using the pitatable.

=== Cvars ===

Most of these cvars are either 0 (disabled) or 1 (enabled), those that differ I have included the values in the description. See [[Bitmask-cvar]] for more information on bit mask cvars.

<pitatable columns=2 headlines="Cvar;Description" headerbgcolor="0b53b4" headerfontcolor="#FFFFFF" border1=2 border2=1 aligns="left;left">
b_altHud;Controls which hud design you use, default 0 (normal hud), valid values 0, 1, 2 and 3. Three is custom mode where you can drag and drop the hud objects (i.e. compass, chargebar etc) where you would like them, but work was never finished on this.
b_altHudFlags;Bitmask for controlling various hud settings if b_altHud = 1 or 2, default 0, valid values 0-7................... 1 = Move round timer, 2 = Don't display rank in hud, 3 = RTCW-ish message placement, 4 = Custom (drag and drop not working, coding was never finished)
b_antilag;Controls whether shots are lag-compensated by the server, default 1, enabled, valid values 0,1,2........... 0 = Disabled, 1 = ETPro antilag enabled (best), 2 = ETmain antilag enabled
b_backupcvars;Controls whether backup files are made when ETPro cvar restrictions are applied, default 1, enabled.
b_beginround;Assign commands to this and they will be automatically executed at the start of new a round/map. See also b_endround.
b_centeredWeapons;Centers weapon models on entity origins, making weapon pickup more predictable. default 1 = enabled, 0 old ET way.
b_chatAlpha;Defines the alpha of the chat text, default 0.33, valid values 0.0 – 1.0, (0.0 = 100% transparent).
b_chatFlags;Controls whether the team flag is drawn by each chat text, default 1, enabled.
b_chatsounds;Controls playing a sound with chats, default 0, disabled.
b_cmdwarnings;Controls notifications from the tjl_* commands, default 1, enabled.
b_debugfakebmodel;Controls debugging EF_FAKEBMODEL brushes in map scripts, default 0, disabled, (cheat protected).
b_debuglocations;Bitmask to enable debugging/design aids for location names. Works with external dats as well as target_location ents, default 0, valid values: 0 - 31, (cheat protected).................................................. 1 = Draw a bubble sprite at each location marker. The nearest location is drawn in green, with all the others being drawn in red...... 2 = Add a dynamic light at each location marker. The nearest location is lit in red, with all the others being lit in green...... 4 = Draw floating text at each location marker containing the location's name. The nearest location is colored green instead of white...... 8 = Send updates to other players when a location is added, deleted, or renamed. This function is designed to allow several people to work on adding locations to a level simultaneously...... 16 = Accept updates to locations from other players who are using b_debuglocations 8.
b_demo_autotimescale;Controls the timescale to switch to when a weapon set in b_demo_autotimescaleweapons is fired, default 1.
b_demo_autotimescaleweapons;Bitmask to automatically change the timescale when a certain type of weapon is fired, default 0, disabled, valid values 0 – 31. 1 = Panzerfaust, 2 = Grenade, 4 = Dynamite, 8 = Mortar, 16 = Smoke grenades and airstrike markers
b_demo_drawspectatormessages;Controls whether "spectator/weaponcam/shoutcaster/etc" overlay is drawn in demo playback, default 1, enabled.
b_demo_dynamitecam;Controls whether to attach the camera to dynamite during demo playback, default 0, disabled.
b_demo_dynamitecounter;Controls drawing a floating counter above armed dynamite during demo playback and when spectating as a shoutcaster, default 0, disabled.
b_demo_followxDistance;Controls camera offset when attached to a weapon, default 50.
b_demo_followyDistance;Controls camera offset when attached to a weapon, default 0.
b_demo_followzDistance;Controls camera offset when attached to a weapon, default 20.
b_demo_freecamspeed;Controls the freecam movement speed, default 800.
b_demo_grenadecam;Controls whether to attach the camera to these types of grenades during demo playback, default 0, valid values 0, 1, 2, 3.................. 0 = Disabled, 1 = Grenades (hand-thrown thrown and rifle grenades), 2 = Airstrike markers, smoke grenades, 3 = 1 and 2
b_demo_lookat;Causes the freecam to lock its view on the specified player (i.e. /b_demo_lookat clientnum), default –1, disabled. To get client numbers in demos see b_demo_nametags for explanation.
b_demo_mortarcam;Controls whether to attach the camera to mortars during demo playback, default 0, disabled.
b_demo_nametags;Bitmask controlling how floating names above each player are drawn during demo playback and when spectating as a shoutcaster, default 0, valid values 0-15............ 0 = Disabled, 1 = Draw visible players, 2 = Draw all players, 4 = Draw the player's client number, 8 = Draw the player's class.
b_demo_nopitch;Controls whether the camera pitch’s while it's attached to weapons, default 1, enabled (no pitch).
b_demo_panzercam;Controls whether to attach the camera to panzers during demo playback, default 0, disabled.
b_demo_pitchturnspeed;Defines the pitch turn speed while using the +freecam_* commands (demo playback only), default 140, see also b_demo_rollspeed and b_demo_yawturnspeed; the units are degrees/second, as with cl_pitchspeed and cl_yawspeed.
b_demo_playersprites;Controls whether the floating sprites (e.g. voicechat, objective, invulnerability, fireteam, and connection markers) are drawn above players' heads in demo playback, default 1, enabled.
b_demo_pvshint;Controls whether to draw a line from the freecam origin to the origin of the demo recorder, default 0, disabled.
b_demo_rollspeed;Defines the roll speed while using the +freecam_* commands (demo playback only), default 140, see also b_demo_pitchturnspeed and b_demo_yawturnspeed; the units are degrees/second, as with cl_pitchspeed and cl_yawspeed.
b_demo_teamonlymissilecam;Controls whether to attach the camera to weapons fired by demo recorders team only, default 0, disabled.
b_demo_yawturnspeed;Defines the yaw turn speed while using the +freecam_* commands (demo playback only), default 140, see also b_demo_rollspeed and b_demo_pitchturnspeed; the units are degrees/second, as with cl_pitchspeed and cl_yawspeed.
b_demorecord_statusline;Controls the y offset of the demo/tjl/tjg recording status line. Use -1 to disable these status lines completely, default: 470, valid values -1, 0 - 480.
b_descriptiveTextscale;Controls the limbo hud text size, default 0.8.
b_dinghy;Have no idea what this does, or maybe we do.
b_drawclock;Controls whether to show a clock with your local time on the hud, default 0, disabled.
b_drawPromotions;Controls whether the rank promotion messages are shown (and whether sounds played) when receiving a promotion, default 1, enabled.
b_drawranks;Controls whether ranks of other players are drawn when using cg_crosshairnames, default 1, enabled.
b_drawRewards;Controls whether skill level increases and reward messages are shown (and whether sounds played), default 1, enabled.
b_drawspectatoralpha;Defines the alpha of the "spectator", "shoutcaster", "freecam", etc. notices (0 = 100% transparent), default 1, valid values 0.00 - 1.00
b_drawspectatorteamflags;Controls whether to draw a small team flag beside the player name when following players in spectator mode, default 1, enabled.
b_drawspeed;Controls whether to draw a speedometer on the hud, default 0, valid values 0, 1, 2, 3, 4, 5................... 0 = Disabled..... 1, 5 = Draw a speedometer....... 2, 4 = Draw a speedometer and the maximum speed reached...... 3, 4, 5 = Draw a speed graph if the lagometer is not being drawn
b_endround;Assign commands to this and they will be automatically executed at round end. See also b_beginround.
b_fireteamAlpha;Defines the alpha of the fireteam overlay, (0 = 100% transparent), default 1.0, valid values 0.00 – 1.00.
b_fireteamLatchedClass;Controls showing latched player class instead of rank in fire team hud display, default 1, enabled.
b_goatsound;Controls whether a sound is played on knife kills, default 1, enabled.
b_hitsounds;Controls whether to enable hit sounds, default 0, valid values 0, 1, 2............ 0 = disabled, 1 = enabled, 2 = enabled for headshots only
b_hudYoffset;Moves the hud so it is out of the way of the demo status line. Set to 0 to move the hud flush with the edge of the screen, default 10.0, valid values 0 – 640.
b_killshot_delay;Determines the time in milliseconds to take an automatic screenshot after a kill, default 0, disabled.
b_lagometerAlpha;Defines the alpha of the lagometer, default 1.0, valid values 0.00 – 1.0 (0 = 100% transparent). Link at the bottom of page for more info about the lagometer.
b_locationJustify;Controls justification of locations in fire team hud, default 0....................... -1 = left justify with padding, 0 = left justify no padding, 1 = right justify with padding
b_locationMaxChars;Controls the number of characters of location names in the Fireteam hud, default 25, valid values 0-76.
b_locationMode;Bitmask to control how locations are displayed in the fireteam hud, default 0, valid values 0-31............ 0 = Default, currently equivalent to '1'...... 1 = Show location names...... 2 = Show location coordinates, 4 = Do not check whether locations are in your PVS when searching for a location name. Applies to b_debuglocations and add/del/etc., too...... 8 = Don’t fall back to location coordinates when no location name was found, instead, show "unknown"
b_logbanners;Controls whether server banners are logged in your console, default 1, enabled.
b_mapconfigdirectory;Defines the folder name to look for map-specific cfg/config files.
b_mapzoom;Controls the zoom level for the map shown in the compass, default 5.159, valid values 1.0 - 7.43.
b_muzzleflash;Controls whether first-person muzzle flash is drawn, default 1, enabled.
b_noactivatelean;Controls whether to enable/disable leaning behaviour when strafing with +activate, default 0.................. 0 = +activate and +moveleft/+moveright causes the player to lean left/right........ 1 = leaning behaviour is disabled; player can use +activate while strafing.
b_numPopups;Controls the number of popup messages on the hud, default –1...... -1 = Use ETmain cg_drawSmallPopupIcons setting, (if cg var = 0) 5 popups, (if cg var = 1) 8 popups...... 0 = Disable popup messages entirely...... 1 = Use ETmain cg_drawSmallPopupIcons 1, 8 popups...... 'number' = Limit the number of popup messages on the hud to the number of your choice
b_optimizePrediction;Controls whether to attempt to use previously calculated prediction results when possible to increase performance or not, default 1, enabled. Link at bottom of page for more info on this.
b_panzerhack;Controls whether the secondary MP40/Thompson (for a soldier with level 4 heavy weapons) is moved to weaponbank 2, default 1, enabled.
b_placebo;When this cvar is enabled, anything is possible. Link at bottom of page which explains this better.
b_popupFadeTime;Defines the time in milliseconds that popups take to fade out, default 2500.
b_popupStayTime;Defines the time in milliseconds that popups will stay before fading, default 2000.
b_popupTime;Defines the time in milliseconds between popups, default 1000.
b_predefineddemokeys;Controls whether demo playback uses hard-coded key bindings, which cannot be overridden, default 1, enabled...... 0 = Lets you use your own key bindings in demo playback, at the loss of the predefined key actions...... 1 = Hard-coded key bindings, which cannot be overridden.
b_shovesounds;Controls whether you hear shove sounds, default 1, enabled.
b_simpleItems;Controls whether to draw sprites instead of models for items, for a slight performance/visibility increase, default 0, disabled.
b_spectatorteamflags;default 1, enabled.
b_speedinterval;Defines the time in milliseconds between two speedometer updates, default 100.
b_speedunit;Controls the speed unit used for the ups meter, default 0, valid values 0, 1, 2...... 0 = (ups), 1 = (mph), 2 = (km/h)
b_textcolorfilter;Strips certain colour characters from names and most text messages, default "", use "*" to filter all.
b_tracers;Controls bullet tracers, default 1, valid values 0, 1, 2...... 0 = Disabled, 1 = Show all tracers, 2 = Don't show own tracers
b_votetextscale;Defines the scaling for the vote text, default 0.8.
b_watermarkAlpha;Defines the alpha of a watermark (if server has one), default 1, valid values 0.00 – 1.0 (0 = 100% transparent).
b_weapaltReloads;Controls whether weapalt doubles as reload for weapons lacking an alternate fire mode, default 1, enabled.
</pitatable>

=== Commands ===
Clients can use to either bind, get info in the console or use with rcon, ref and semiadmin.
<pitatable columns=2 headlines="Cvar;Description" headerbgcolor="0b53b4" headerfontcolor="#FFFFFF" border1=2 border2=1 aligns="left;left">
guids;Displays a list of players and their ETPro guid’s in the console.
b_cvarlist;Displays a list of ETPro cvar limits of the server you are in, (only shows if the server has cvar limits set).
b_cvarempty;Resets all ETPro cvars to their defaults.
Bp;Sends text to all clients to be displayed in the banner area.
camera;Used to run scripted cameras, whatever.camera files. 2 Links at bottom of page which helps explain this better.
cancelvote;Cancels any vote in progress.
cheaters;Lists all clients in console, with info on whether they are cheating.To check on just one particular client use /cheaters client slot, this will return the IAC info of only that chosen client. Link at bottom of page, for better explanation.
class;Class allows you to script the selection of team and class, (syntax: class class weapon {secondary weapon}, e.g. cs_mg42 "class s 2 3). Link at bottom of page for better explanation.
classmenu;Command for opening the class selection menu. Link at bottom of page for better explanation.
clearlines;Empties out the debug line queue (e.g. if a bunch of railtrail lines with a huge cg_railtrailtime are in the buffer.)
Cp;Sends text to all clients to be displayed in the centerprint area.
etpro_alliedmapxp;Non-user, write-protected cvar for internal use in ETPro.
etpro_axismapxp;Non-user, write-protected cvar for internal use in ETPro.
etpro_lastmapname;Non-user, write-protected cvar for internal use in ETPro.
etpro_session;Non-user, write-protected cvar for internal use in ETPro.
exec_at_time;Allows scripts to be executed exactly at a specified frame number (demo playback only).
follow;For specifying which player to spectate (i.e. /follow <client slot>).
follownext;Spectate the next guy (normally bound to your fire button (mouse1) when spectating).
followprev;Spectate the previous guy.
freecam;Allows for you to switch in and out of freecam in demo playback.
freecamgetpos;Retrieves the position of the camera.
freecamsetpos;Sets the position of the camera. (mainly for use with scripted cameras)
inviteall;Used with fireteam to invite all teammates into fireteam, if they aren’t already in one (i.e. /fireteam inviteall).
kill;ETPro change: /kill now counts as a death.
Listcs;Dumps all of the current configstrings to the server console, (mostly useful as a debugging or map making tool).
loc_add;For adding location names. Link at bottom of page for better explanation of loc_* vars.
loc_del;For deleting location names, (doesn’t have to be the exact name, it will delete the closest one).
loc_load;Load the specified location-name file, (i.e. loc_load filename).
loc_rename;For renaming location names, (doesn’t have to be the exact name, it will rename the closest one to what was specified).
loc_save;Saves location names to the specified file, (i.e. loc_save filename).
loc_show;Shows location name of an imperfectly specified location.
m;Pretext for sending a private message (i.e. /m playername message), to send to all clan members in the server, instead of a playername use your clan tag (i.e. if your clan tag is -lol- then, /m -lol- hi guys, would send the message ‘hi guys’ to all players with -lol- in their name, naturally just your clan mates).
makesc, makeshoutcast, makeshoutcaster;Use to give a specified player shoutcaster status, (i.e. /makesc clientid).
msg;Same as /m, but broken on servers.
mt;Similar to m, but this pretext just sends private messages to players on your own team axis/allies (i.e. /mt playername message), if you try using this to send a private message to a player on the opposing team then he won’t receive it, it only search’s for players playername on your own team.
mv_sensitivity;MultiView : Note NEED MORE INFO ON MULTIVEIW CVARS, feel free to edit
mvactivate;Command to enter and exit Multiview mode, more info <a href="http://bani.anime.net/etpro/playerguide.html">here</a>.
mvadd;MultiView
mvall;Command to view all players in multiview.
mvallies;Command to view all allied players in multiview.
mvaxis;Command to view all Axis players in multiview.
mvdel;MultiView
mvhide;MultiView
mvnew;MultiView
mvnone;MultiView
mvshow;MultiView
mvswap;MultiView
mvtoggle;MultiView
notice;Don’t know what this is used for but when you type it in the console (/notice) it returns with some lol statements, for example: “etpro comes with no warranties of any kind – if it breaks, you get to keep both pieces”, “heeey, sticklyman! WhaaAaAaAAaaAt are you doing?!” Etc
openTimerInput;For setting ETPro’s enemy spawn time. This opens a box to set the enemy's spawn time in. See also resetTimer and timerSet.
passvote;Passes any vote in progress.
pm;Same as /m, but broken on servers.
qsay;Sends text to all clients to be displayed in the chat area without the server: prefix.
ref;For logging in with a password for Ref status. Allows access to the referee commands from the server console/menu.
reflogout;For logging out from Ref status.
removesc, removeshoutcast, removeshoutcaster;Use to remove a specified player from shoutcaster status, (i.e. /removesc clientid).
resetmaxspeed;Clears/resets max speed.
resetTimer;Resets ETPro’s enemy spawntimer. See also openTimerInput and timerSet.
sa, semiAdmin;For use when logged in as a semiAdmin. This all depends on what commands the server admin has assigned to you for use. Semiadmins may also check their current level and available commands with /sa or /semiadmin by itself with no parameters. Example: If the server admin has assigned you the command map_restart, then when logged in as semiadmin to restart the current map you would type into the console /sa map_restart
sal, semiAdminLogin;For logging in with a password for SemiAdmin status, (i.e. /semiadminlogin password or /sal password)
say_buddy;Used to send chat messages to all in your fireteam or one particular fireteam mate (i.e. /say_buddy1 hi)
scLogin, shoutCastLogin;For logging in with a password for shoutcaster status.
scLogout, shoutCastLogout;For logging out of shoutcaster status.
setcs;Sets the value of configstring number num to value (i.e. setcs num value).
show_framecount;Shows the frame count in demo playback, default 0...... 0 = No frame counter, 1 = Show frame counter, 2 = Snapshot current frame number.
shrug;Allows for the use of shrug silliness if enabled on the server, (i.e. bind w "+forward; shrug").
shuffleteamsxp_norestart;Command to shuffle teams by XP, without restarting the map.
skills;Lists in console what XP is required to reach each promotion level of each particular class (i.e. /skills). An easier option now is the menu "+stats" (normally bound to alt), this shows what you require as the class you are playing.
spechelp;Toggles spectator help in multiview.
teammenu;Command to open a v-chat style menu to select your class & weapon.
Time;Reports the game state and round time remaining.
timerSet;For setting ETPro’s enemy spawntimer. See also resetTimer and openTimerInput.
ui_browserShowETPro;Controls what type mod servers you see in your browser server list...... 0 = Show all...... 1 = Only show ETPro servers...... 2 = Don’t show ETPro servers.
weapons;Lists in the console what weapon you or your teammates have now and what they are going to spawn with next, but only if another respawn class choice is picked and only if the weapon has a max amount set.
vsay num;If a voicechat has multiple announcements you can specify which one to call, (i.e. /vsay num voicechat, /vsay 2 FTAttack)
</pitatable>

=== Trickjump Cvars ===
Note: cheats must be enabled to use these. See the pages for [[TrickJumpLines]] (tjl) and [[TrickJumpGhosts]] (tjg) for more information.

<pitatable columns=2 headlines="Cvar;Description" headerbgcolor="0b53b4" headerfontcolor="#FFFFFF" border1=2 border2=1 aligns="left;left">
b_tjg_ghostfx;Controls special effects for trick jump ghosts to distinguish them from normal players, default 2, valid values 0 - 4... 0 = No effect, 1 = Flicker, 2 = Ghost, 3 = Flaming, 4 = Flame only
b_tjl_color;Sets the default trick jump line color default green, valid values: any hex RGB color values (e.g. 0x56789a), or a known color name (e.g. "red", "white", "green", etc), -1 to disable.
b_tjl_draw;Controls whether trick jump lines will be drawn, default 1, enabled.
b_tjl_quickslot;Defines the slot used when specifying "quickslot" to tjl_startrecord, this is also the slot used by tjl_menu, default 0, disabled.
b_tjl_showmaxspeed;Controls whether the top speed reached will be drawn at the appropriate point on a trickjump line, default 0, disabled.
b_tjl_stepsize;Controls the minimum distance between any two points of the drawn trick jump line (increasing this may improve rendering performance for very long lines), default 0.5.
b_tjl_stoponnomove;Controls whether the trick jump line recording will automatically stop when the player being recorded stops moving, default 1, enabled.
</pitatable>

=== Trickjump Commands ===
<pitatable columns=2 headlines="Command;Description" headerbgcolor="0b53b4" headerfontcolor="#FFFFFF" border1=2 border2=1 aligns="left;left">
tjg_info;This will give you detailed information about all the tjg command's and cvars.
tjg_load;Loads a recording from a file, (i.e. tjg_load filename).
tjg_menu;A convenient menu for the tjg tools.
tjg_pause;Pauses/resumes the ghost playback.
tjg_play;Plays back a recorded ghost.
tjg_record;Starts recording your movements.
tjg_save;Saves a recording to a file, (i.e. tjg_save filename).
tjg_stop;Stops playing or recording.
tjl_drawslot;Controls drawing for a given slot or changes a slot's color (i.e. /tjl_drawslot slot OR slot color), b_tjl_color must be set to -1 in order to use this option.
tjl_info;This will give you detailed information about all the tjl command's and cvars.
tjl_load;Loads the current file into a slot (i.e. /tjl_load filename slot), (file extension = .tjl_1.dat (1 = version #)).
tjl_menu;A convenient menu for the tjl tools.
tjl_save;Saves the current slot into a file (i.e. / tjl_save filename slot), (file extension = .tjl_1.dat (1 = version #)).
tjl_startrecord;Starts recording you or a clients movements (i.e. tjl_startrecord clientnum slot OR slot OR no parameters records your own movements).
tjl_stoprecord;Stops recording movements.
</pitatable>

=== Links ===
Links to more info about some of the above or other useful client pages here on WolfWiki.

*[[Lagometer]]
*[[Physics cvars]]
*[[B_placebo]]
*[http://bani.anime.net/banimod/forums/viewtopic.php?t=3332 Camera]
*[http://bani.anime.net/banimod/forums/viewtopic.php?t=6305 Camera]
*[http://bani.anime.net/banimod/forums/viewtopic.php?t=3333 Cheaters]
*[[Player_Scripting | Class & Classmenu]]
*[[Target_location | Locations]]
*[http://bani.anime.net/etpro/playerguide.html Multiview]
*[[SemiAdmin]]
*[[Memory_cvars | Hunk, Zone and sound Megs]]
*[[DrawFPS]]
*[[Client Configuration]]
*[[EDV]]
*[[Extended ASCII]]
*[[ETTV:Server Configuration]]
*[[ETTV:Viewer's Guide]]
*[[Voicechat]]

[[Category:ETPro:Client_Cvars]]

Client Configuration

2006-04-28T03:12:54Z

Lagger: link beautification (yes, i'm very bored)

==Client Side Install==
;To play ETPro online
Simply connect to an ETPro server with downloads enabled on your client. 
;To host your own game
Download the desired ETPro .zip from the [http://etpro.anime.net/download.html ETPro download page] and unzip it into your ET directory, then start ET with fs_game set as described below. 
For additional information see the [http://wolfwiki.anime.net/index.php/ETPro:Server_Configuration Server Configuration page]
;To play demos
<ul>
<li>Open the [http://bani.anime.net/etpro/download.html PK3] in a program that can handle <tt>zip</tt> files. Extract the following files to the ETPro directory:
:cgame_mp_x86.dll
:ui_mp_x86.dll
<li>Start the client with the <tt>+set fs_game etpro</tt>.
<ul><li>Command line: Append <tt>+set fs_game etpro</tt> to the command line.
<li>Windows Shortcut: Append <tt>+set fs_game etpro</tt> to the target box, usually after <tt>"C:\Program Files\Wolfenstein - Enemy Territory"</tt>. Make sure to place it after the double-quote.</ul>
</ul>

==Warnings==
While viewing a demo: Client/Server game mismatch: 'Enemy Territory/ET pro 
While viewing a demo: Unknown event: 131 
While viewing a demo: BG_EvaluateTrajectory: unknown trType: 0 
While viewing a demo: BG_IndexForString: unknown token 'NOT' 
:This happens when you use the wrong client to playback ETPro 3 demos. The solution is to extract cgame_mp_x86.dll and ui_mp_x86.dll from the most recent [http://bani.anime.net/etpro/download.html ETPro PK3] and put it in your ETPro directory.

==Related links==
*[http://rarlabs.com/download.htm WinRAR] - Can open PK3 files (Recommended).
*[http://www.winzip.com WinZip] - Can open PK3 files.
*[[:Category:ETPro:Client Cvars|Client cvars]].
*[[Client cvar list]].
*[[Server Configuration]].
*[[Performance Tuning]].

==Additional troubleshooting==
Most problems with hosting games and playing demos, as well as some problems with playing online, are caused by having multiple versions of the etpro files present, or simply having too many files.
;For reliable demo playback and local hosting
* There should be only one etpro-X_Y_Z.pk3 in your etpro directory.
* Unless you have a specific reason to do otherwise, always use the most recent version. ETPro is backwards comatible with older demos, as well as demos from etmain.
* The ui and cgame .dll files in the etpro directory must match those in the etpro .pk3 file. Extract them as described above.
* Many servers force you to download additional skin packs, sound packs, other content. All of this will be present in demo playback or hosted games, unless your move the corresponding files to somewhere that outside of etpro or etmain, or delete them.
*In addition to the etpro .pk3 the following are required by ET.
** mp_bin.pk3
** pak0.pk3
** pak1.pk3
** pak2.pk3
To play back a demo, you must also have the .pk3 corresponding to the map it was recorded on. All other .pk3 files may be safely deleted or moved to another directory.

[[Category:ETPro]]

ETPro:Lua Mod API

2006-04-28T03:00:30Z

Lagger: move borked links to page, added redirect

#REDIRECT [[Lua Mod API]]

Performance Tuning

2006-04-28T02:47:01Z

Lagger: same broken link

==Performance bottlenecks and workarounds==
The following describes general areas which can affect game performance, and possible workarounds. Network performance is not addressed here, except as it relates to CPU usage.

Hardware mentioned is meant only as a general example.

==CPU and system memory speed==
;As a general rule, ET likes lots of CPU and memory/cache/FSB bandwidth.
Anything less than an Athlon XP 2000 or Pentium 4 2GHZ. Systems with poor memory bandwidth (SDR or DDD266 RAM) or crippled cache (celeron, duron) will suffer.
===Improving performance on CPU limited systems===
*'''b_optimizeprediction 1'''
*Higher ping and packet loss put more load on the CPU
*Larger servers put more load on your system

==Video card==
Anything less than a geforce4 (not MX) or radeon 9600 will be a serious handicap. Beware of manufacturers deceptive naming conventions, a FooBar 1000XTS might be the best available card while the FooBar 1000LE is utter crap.
===Improving performance on video card limited systems===
*'''lower resolution'''
:Choose a lower value for r_mode; use /modelist to see available modes
*'''Lower texture quality'''
**Set [[r_picmip]] to a higher value (up to 3).
**Set [[r_texturebits]] to 16
**Set [[r_texturemode]] to <tt>GL_NEAREST_MIPMAP_NEAREST</tt>, <tt>GL_LINEAR</tt> or <tt>GL_NEAREST</tt>
**Set texture compression [[r_ext_compressed_textures]] to 1 (Note that this may have a positive or negative impact on performance, depending on your system)
*'''lower color depth'''
:Set [[r_colorbits]] to 16
*'''Other quality settings'''
:Set r_fastsky to 1
:Set curve settings (TODO)

==Available Physical RAM==
256 megabytes or less of system RAM will impact level load times and cause hitching (momentary drops in FPS) in game. If levels take a long time to load, or your hard disk is frequently active during gameplay, you are most likely need more RAM.
===Settings for systems without much system RAM===
*r_picmip and r_texturebits, as above
*lower sound quality
*set com_hunkmegs to 56, or the lowest value that works with all the maps you want to play.
*other [[memory cvars]] should not be set too high above the default.

==Integrated sound ==
Most integrated sound devices suck, and can cause noticeable FPS loss and stuttering.

==External Programs==
In general, the less you run when you play ET, the better. However, some programs are known to have disproportionate performance impacts.
*'''x-fire''' in game integration features.
*'''p2p''' bittorrent, kazaa etc.
*'''malware''' viruses, spyware and addware can all cause serious performance problems.
*'''scheduled tasks''' such as windows update or antivirus updates
*'''software firewalls and antivirus''' some of these products have been reported to cause problems. (TODO more details)

==Benchmarking and Testing==
To get the best performance out of your particular system, you should test each tweak to ensure it has the desired effect.

You can use the '''timedemo''' cvar to benchmark demo playback. Do this by setting <tt>timedemo 1</tt> in the console, and then playing back a demo. When the demo playback completes, the console contains an average framerate. If you have problems playing back demos, see [[Client_Configuration]]

If you want to compare performance between mods, you can use an etmain (or any server only mod such as etpub or shrubet) demo and play it back both in etmain and etpro.

It is important to remember that '''demo playback is not directly comparable to online play'''. In general, demo playback depends more on the video card than online play does. A tweak that shows a huge improvement in demo playback may have little effect in online play.

To test performance in real play, you should use [[DrawFPS|cg_drawFPS]] and then pick a standard location. This will not give you exactly the same results every time, but will show major effects. Ideally, the test should be done on an otherwise empty dedicated server with a consistent ping. If you host the server on the same machine as the client you are testing, this will affect the results.

TODO: it would be nice to have a standard timedemo demo, so people can compare results.

==TODO==
This page is a draft. The following need to be added or expanded:
*examples of FPS for various typical systems/settings, so people can know if they are getting expected performance out of their hardware.
*more complete list of useful cvars.
*links to config sites.
*links to more detailed descriptions of settings.
*benchmarking

[[Category:ETPro]]

Client cvar list

2006-04-28T02:40:33Z

Lagger: fixed broken link

== '''ETPro Client cvars and commands''' ==
By The Birdman & =FF=im2good4u

This list contains all ETPro client cvars and commands (hopefully).

We have tried to include as much information in each description as possible, but some might require more explaining, so links to other pages here or the forums have been added.

'''Note:'''
If there is any ETPro client cvars/commands that you think we have omitted or any that you think the description is wrong then pm me [http://bani.anime.net/banimod/forums/profile.php?mode=viewprofile&u=3475 here], if you don't know how to edit this page. Before pm’ing/editing are you sure it’s an ETPro cvar/command and not another mods or an ETmain one, if it is ETPro then either edit or let me know what cvar/command we’ve omitted, adding a short description of what it’s use is, if known to you. If you think a description is wrong, quote the cvar/command and it’s description adding your description of it or edit.

Apologies for all the ..... to try create new lines or push things along to create a line so things look a bit better in some of the description sections, but i couldn't start new lines using the pitatable.

=== Cvars ===

Most of these cvars are either 0 (disabled) or 1 (enabled), those that differ I have included the values in the description. See [[Bitmask-cvar]] for more information on bit mask cvars.

<pitatable columns=2 headlines="Cvar;Description" headerbgcolor="0b53b4" headerfontcolor="#FFFFFF" border1=2 border2=1 aligns="left;left">
b_altHud;Controls which hud design you use, default 0 (normal hud), valid values 0, 1, 2 and 3. Three is custom mode where you can drag and drop the hud objects (i.e. compass, chargebar etc) where you would like them, but work was never finished on this.
b_altHudFlags;Bitmask for controlling various hud settings if b_altHud = 1 or 2, default 0, valid values 0-7................... 1 = Move round timer, 2 = Don't display rank in hud, 3 = RTCW-ish message placement, 4 = Custom (drag and drop not working, coding was never finished)
b_antilag;Controls whether shots are lag-compensated by the server, default 1, enabled, valid values 0,1,2........... 0 = Disabled, 1 = ETPro antilag enabled (best), 2 = ETmain antilag enabled
b_backupcvars;Controls whether backup files are made when ETPro cvar restrictions are applied, default 1, enabled.
b_beginround;Assign commands to this and they will be automatically executed at the start of new a round/map. See also b_endround.
b_centeredWeapons;Centers weapon models on entity origins, making weapon pickup more predictable. default 1 = enabled, 0 old ET way.
b_chatAlpha;Defines the alpha of the chat text, default 0.33, valid values 0.0 – 1.0, (0.0 = 100% transparent).
b_chatFlags;Controls whether the team flag is drawn by each chat text, default 1, enabled.
b_chatsounds;Controls playing a sound with chats, default 0, disabled.
b_cmdwarnings;Controls notifications from the tjl_* commands, default 1, enabled.
b_debugfakebmodel;Controls debugging EF_FAKEBMODEL brushes in map scripts, default 0, disabled, (cheat protected).
b_debuglocations;Bitmask to enable debugging/design aids for location names. Works with external dats as well as target_location ents, default 0, valid values: 0 - 31, (cheat protected).................................................. 1 = Draw a bubble sprite at each location marker. The nearest location is drawn in green, with all the others being drawn in red...... 2 = Add a dynamic light at each location marker. The nearest location is lit in red, with all the others being lit in green...... 4 = Draw floating text at each location marker containing the location's name. The nearest location is colored green instead of white...... 8 = Send updates to other players when a location is added, deleted, or renamed. This function is designed to allow several people to work on adding locations to a level simultaneously...... 16 = Accept updates to locations from other players who are using b_debuglocations 8.
b_demo_autotimescale;Controls the timescale to switch to when a weapon set in b_demo_autotimescaleweapons is fired, default 1.
b_demo_autotimescaleweapons;Bitmask to automatically change the timescale when a certain type of weapon is fired, default 0, disabled, valid values 0 – 31. 1 = Panzerfaust, 2 = Grenade, 4 = Dynamite, 8 = Mortar, 16 = Smoke grenades and airstrike markers
b_demo_drawspectatormessages;Controls whether "spectator/weaponcam/shoutcaster/etc" overlay is drawn in demo playback, default 1, enabled.
b_demo_dynamitecam;Controls whether to attach the camera to dynamite during demo playback, default 0, disabled.
b_demo_dynamitecounter;Controls drawing a floating counter above armed dynamite during demo playback and when spectating as a shoutcaster, default 0, disabled.
b_demo_followxDistance;Controls camera offset when attached to a weapon, default 50.
b_demo_followyDistance;Controls camera offset when attached to a weapon, default 0.
b_demo_followzDistance;Controls camera offset when attached to a weapon, default 20.
b_demo_freecamspeed;Controls the freecam movement speed, default 800.
b_demo_grenadecam;Controls whether to attach the camera to these types of grenades during demo playback, default 0, valid values 0, 1, 2, 3.................. 0 = Disabled, 1 = Grenades (hand-thrown thrown and rifle grenades), 2 = Airstrike markers, smoke grenades, 3 = 1 and 2
b_demo_lookat;Causes the freecam to lock its view on the specified player (i.e. /b_demo_lookat clientnum), default –1, disabled. To get client numbers in demos see b_demo_nametags for explanation.
b_demo_mortarcam;Controls whether to attach the camera to mortars during demo playback, default 0, disabled.
b_demo_nametags;Bitmask controlling how floating names above each player are drawn during demo playback and when spectating as a shoutcaster, default 0, valid values 0-15............ 0 = Disabled, 1 = Draw visible players, 2 = Draw all players, 4 = Draw the player's client number, 8 = Draw the player's class.
b_demo_nopitch;Controls whether the camera pitch’s while it's attached to weapons, default 1, enabled (no pitch).
b_demo_panzercam;Controls whether to attach the camera to panzers during demo playback, default 0, disabled.
b_demo_pitchturnspeed;Defines the pitch turn speed while using the +freecam_* commands (demo playback only), default 140, see also b_demo_rollspeed and b_demo_yawturnspeed; the units are degrees/second, as with cl_pitchspeed and cl_yawspeed.
b_demo_playersprites;Controls whether the floating sprites (e.g. voicechat, objective, invulnerability, fireteam, and connection markers) are drawn above players' heads in demo playback, default 1, enabled.
b_demo_pvshint;Controls whether to draw a line from the freecam origin to the origin of the demo recorder, default 0, disabled.
b_demo_rollspeed;Defines the roll speed while using the +freecam_* commands (demo playback only), default 140, see also b_demo_pitchturnspeed and b_demo_yawturnspeed; the units are degrees/second, as with cl_pitchspeed and cl_yawspeed.
b_demo_teamonlymissilecam;Controls whether to attach the camera to weapons fired by demo recorders team only, default 0, disabled.
b_demo_yawturnspeed;Defines the yaw turn speed while using the +freecam_* commands (demo playback only), default 140, see also b_demo_rollspeed and b_demo_pitchturnspeed; the units are degrees/second, as with cl_pitchspeed and cl_yawspeed.
b_demorecord_statusline;Controls the y offset of the demo/tjl/tjg recording status line. Use -1 to disable these status lines completely, default: 470, valid values -1, 0 - 480.
b_descriptiveTextscale;Controls the limbo hud text size, default 0.8.
b_dinghy;Have no idea what this does, or maybe we do.
b_drawclock;Controls whether to show a clock with your local time on the hud, default 0, disabled.
b_drawPromotions;Controls whether the rank promotion messages are shown (and whether sounds played) when receiving a promotion, default 1, enabled.
b_drawranks;Controls whether ranks of other players are drawn when using cg_crosshairnames, default 1, enabled.
b_drawRewards;Controls whether skill level increases and reward messages are shown (and whether sounds played), default 1, enabled.
b_drawspectatoralpha;Defines the alpha of the "spectator", "shoutcaster", "freecam", etc. notices (0 = 100% transparent), default 1, valid values 0.00 - 1.00
b_drawspectatorteamflags;Controls whether to draw a small team flag beside the player name when following players in spectator mode, default 1, enabled.
b_drawspeed;Controls whether to draw a speedometer on the hud, default 0, valid values 0, 1, 2, 3, 4, 5................... 0 = Disabled..... 1, 5 = Draw a speedometer....... 2, 4 = Draw a speedometer and the maximum speed reached...... 3, 4, 5 = Draw a speed graph if the lagometer is not being drawn
b_endround;Assign commands to this and they will be automatically executed at round end. See also b_beginround.
b_fireteamAlpha;Defines the alpha of the fireteam overlay, (0 = 100% transparent), default 1.0, valid values 0.00 – 1.00.
b_fireteamLatchedClass;Controls showing latched player class instead of rank in fire team hud display, default 1, enabled.
b_goatsound;Controls whether a sound is played on knife kills, default 1, enabled.
b_hitsounds;Controls whether to enable hit sounds, default 0, valid values 0, 1, 2............ 0 = disabled, 1 = enabled, 2 = enabled for headshots only
b_hudYoffset;Moves the hud so it is out of the way of the demo status line. Set to 0 to move the hud flush with the edge of the screen, default 10.0, valid values 0 – 640.
b_killshot_delay;Determines the time in milliseconds to take an automatic screenshot after a kill, default 0, disabled.
b_lagometerAlpha;Defines the alpha of the lagometer, default 1.0, valid values 0.00 – 1.0 (0 = 100% transparent). Link at the bottom of page for more info about the lagometer.
b_locationJustify;Controls justification of locations in fire team hud, default 0....................... -1 = left justify with padding, 0 = left justify no padding, 1 = right justify with padding
b_locationMaxChars;Controls the number of characters of location names in the Fireteam hud, default 25, valid values 0-76.
b_locationMode;Bitmask to control how locations are displayed in the fireteam hud, default 0, valid values 0-31............ 0 = Default, currently equivalent to '1'...... 1 = Show location names...... 2 = Show location coordinates, 4 = Do not check whether locations are in your PVS when searching for a location name. Applies to b_debuglocations and add/del/etc., too...... 8 = Don’t fall back to location coordinates when no location name was found, instead, show "unknown"
b_logbanners;Controls whether server banners are logged in your console, default 1, enabled.
b_mapconfigdirectory;Defines the folder name to look for map-specific cfg/config files.
b_mapzoom;Controls the zoom level for the map shown in the compass, default 5.159, valid values 1.0 - 7.43.
b_muzzleflash;Controls whether first-person muzzle flash is drawn, default 1, enabled.
b_noactivatelean;Controls whether to enable/disable leaning behaviour when strafing with +activate, default 0.................. 0 = +activate and +moveleft/+moveright causes the player to lean left/right........ 1 = leaning behaviour is disabled; player can use +activate while strafing.
b_numPopups;Controls the number of popup messages on the hud, default –1...... -1 = Use ETmain cg_drawSmallPopupIcons setting, (if cg var = 0) 5 popups, (if cg var = 1) 8 popups...... 0 = Disable popup messages entirely...... 1 = Use ETmain cg_drawSmallPopupIcons 1, 8 popups...... 'number' = Limit the number of popup messages on the hud to the number of your choice
b_optimizePrediction;Controls whether to attempt to use previously calculated prediction results when possible to increase performance or not, default 1, enabled. Link at bottom of page for more info on this.
b_panzerhack;Controls whether the secondary MP40/Thompson (for a soldier with level 4 heavy weapons) is moved to weaponbank 2, default 1, enabled.
b_placebo;When this cvar is enabled, anything is possible. Link at bottom of page which explains this better.
b_popupFadeTime;Defines the time in milliseconds that popups take to fade out, default 2500.
b_popupStayTime;Defines the time in milliseconds that popups will stay before fading, default 2000.
b_popupTime;Defines the time in milliseconds between popups, default 1000.
b_predefineddemokeys;Controls whether demo playback uses hard-coded key bindings, which cannot be overridden, default 1, enabled...... 0 = Lets you use your own key bindings in demo playback, at the loss of the predefined key actions...... 1 = Hard-coded key bindings, which cannot be overridden.
b_shovesounds;Controls whether you hear shove sounds, default 1, enabled.
b_simpleItems;Controls whether to draw sprites instead of models for items, for a slight performance/visibility increase, default 0, disabled.
b_spectatorteamflags;default 1, enabled.
b_speedinterval;Defines the time in milliseconds between two speedometer updates, default 100.
b_speedunit;Controls the speed unit used for the ups meter, default 0, valid values 0, 1, 2...... 0 = (ups), 1 = (mph), 2 = (km/h)
b_textcolorfilter;Strips certain colour characters from names and most text messages, default "", use "*" to filter all.
b_tracers;Controls bullet tracers, default 1, valid values 0, 1, 2...... 0 = Disabled, 1 = Show all tracers, 2 = Don't show own tracers
b_votetextscale;Defines the scaling for the vote text, default 0.8.
b_watermarkAlpha;Defines the alpha of a watermark (if server has one), default 1, valid values 0.00 – 1.0 (0 = 100% transparent).
b_weapaltReloads;Controls whether weapalt doubles as reload for weapons lacking an alternate fire mode, default 1, enabled.
</pitatable>

=== Commands ===
Clients can use to either bind, get info in the console or use with rcon, ref and semiadmin.
<pitatable columns=2 headlines="Cvar;Description" headerbgcolor="0b53b4" headerfontcolor="#FFFFFF" border1=2 border2=1 aligns="left;left">
guids;Displays a list of players and their ETPro guid’s in the console.
b_cvarlist;Displays a list of ETPro cvar limits of the server you are in, (only shows if the server has cvar limits set).
b_cvarempty;Resets all ETPro cvars to their defaults.
Bp;Sends text to all clients to be displayed in the banner area.
camera;Used to run scripted cameras, whatever.camera files. 2 Links at bottom of page which helps explain this better.
cancelvote;Cancels any vote in progress.
cheaters;Lists all clients in console, with info on whether they are cheating.To check on just one particular client use /cheaters client slot, this will return the IAC info of only that chosen client. Link at bottom of page, for better explanation.
class;Class allows you to script the selection of team and class, (syntax: class class weapon {secondary weapon}, e.g. cs_mg42 "class s 2 3). Link at bottom of page for better explanation.
classmenu;Command for opening the class selection menu. Link at bottom of page for better explanation.
clearlines;Empties out the debug line queue (e.g. if a bunch of railtrail lines with a huge cg_railtrailtime are in the buffer.)
Cp;Sends text to all clients to be displayed in the centerprint area.
etpro_alliedmapxp;Non-user, write-protected cvar for internal use in ETPro.
etpro_axismapxp;Non-user, write-protected cvar for internal use in ETPro.
etpro_lastmapname;Non-user, write-protected cvar for internal use in ETPro.
etpro_session;Non-user, write-protected cvar for internal use in ETPro.
exec_at_time;Allows scripts to be executed exactly at a specified frame number (demo playback only).
follow;For specifying which player to spectate (i.e. /follow <client slot>).
follownext;Spectate the next guy (normally bound to your fire button (mouse1) when spectating).
followprev;Spectate the previous guy.
freecam;Allows for you to switch in and out of freecam in demo playback.
freecamgetpos;Retrieves the position of the camera.
freecamsetpos;Sets the position of the camera. (mainly for use with scripted cameras)
inviteall;Used with fireteam to invite all teammates into fireteam, if they aren’t already in one (i.e. /fireteam inviteall).
kill;ETPro change: /kill now counts as a death.
Listcs;Dumps all of the current configstrings to the server console, (mostly useful as a debugging or map making tool).
loc_add;For adding location names. Link at bottom of page for better explanation of loc_* vars.
loc_del;For deleting location names, (doesn’t have to be the exact name, it will delete the closest one).
loc_load;Load the specified location-name file, (i.e. loc_load filename).
loc_rename;For renaming location names, (doesn’t have to be the exact name, it will rename the closest one to what was specified).
loc_save;Saves location names to the specified file, (i.e. loc_save filename).
loc_show;Shows location name of an imperfectly specified location.
m;Pretext for sending a private message (i.e. /m playername message), to send to all clan members in the server, instead of a playername use your clan tag (i.e. if your clan tag is -lol- then, /m -lol- hi guys, would send the message ‘hi guys’ to all players with -lol- in their name, naturally just your clan mates).
makesc, makeshoutcast, makeshoutcaster;Use to give a specified player shoutcaster status, (i.e. /makesc clientid).
msg;Same as /m, but broken on servers.
mt;Similar to m, but this pretext just sends private messages to players on your own team axis/allies (i.e. /mt playername message), if you try using this to send a private message to a player on the opposing team then he won’t receive it, it only search’s for players playername on your own team.
mv_sensitivity;MultiView : Note NEED MORE INFO ON MULTIVEIW CVARS, feel free to edit
mvactivate;Command to enter and exit Multiview mode, more info <a href="http://bani.anime.net/etpro/playerguide.html">here</a>.
mvadd;MultiView
mvall;Command to view all players in multiview.
mvallies;Command to view all allied players in multiview.
mvaxis;Command to view all Axis players in multiview.
mvdel;MultiView
mvhide;MultiView
mvnew;MultiView
mvnone;MultiView
mvshow;MultiView
mvswap;MultiView
mvtoggle;MultiView
notice;Don’t know what this is used for but when you type it in the console (/notice) it returns with some lol statements, for example: “etpro comes with no warranties of any kind – if it breaks, you get to keep both pieces”, “heeey, sticklyman! WhaaAaAaAAaaAt are you doing?!” Etc
openTimerInput;For setting ETPro’s enemy spawn time. This opens a box to set the enemy's spawn time in. See also resetTimer and timerSet.
passvote;Passes any vote in progress.
pm;Same as /m, but broken on servers.
qsay;Sends text to all clients to be displayed in the chat area without the server: prefix.
ref;For logging in with a password for Ref status. Allows access to the referee commands from the server console/menu.
reflogout;For logging out from Ref status.
removesc, removeshoutcast, removeshoutcaster;Use to remove a specified player from shoutcaster status, (i.e. /removesc clientid).
resetmaxspeed;Clears/resets max speed.
resetTimer;Resets ETPro’s enemy spawntimer. See also openTimerInput and timerSet.
sa, semiAdmin;For use when logged in as a semiAdmin. This all depends on what commands the server admin has assigned to you for use. Semiadmins may also check their current level and available commands with /sa or /semiadmin by itself with no parameters. Example: If the server admin has assigned you the command map_restart, then when logged in as semiadmin to restart the current map you would type into the console /sa map_restart
sal, semiAdminLogin;For logging in with a password for SemiAdmin status, (i.e. /semiadminlogin password or /sal password)
say_buddy;Used to send chat messages to all in your fireteam or one particular fireteam mate (i.e. /say_buddy1 hi)
scLogin, shoutCastLogin;For logging in with a password for shoutcaster status.
scLogout, shoutCastLogout;For logging out of shoutcaster status.
setcs;Sets the value of configstring number num to value (i.e. setcs num value).
show_framecount;Shows the frame count in demo playback, default 0...... 0 = No frame counter, 1 = Show frame counter, 2 = Snapshot current frame number.
shrug;Allows for the use of shrug silliness if enabled on the server, (i.e. bind w "+forward; shrug").
shuffleteamsxp_norestart;Command to shuffle teams by XP, without restarting the map.
skills;Lists in console what XP is required to reach each promotion level of each particular class (i.e. /skills). An easier option now is the menu "+stats" (normally bound to alt), this shows what you require as the class you are playing.
spechelp;Toggles spectator help in multiview.
teammenu;Command to open a v-chat style menu to select your class & weapon.
Time;Reports the game state and round time remaining.
timerSet;For setting ETPro’s enemy spawntimer. See also resetTimer and openTimerInput.
ui_browserShowETPro;Controls what type mod servers you see in your browser server list...... 0 = Show all...... 1 = Only show ETPro servers...... 2 = Don’t show ETPro servers.
weapons;Lists in the console what weapon you or your teammates have now and what they are going to spawn with next, but only if another respawn class choice is picked and only if the weapon has a max amount set.
vsay num;If a voicechat has multiple announcements you can specify which one to call, (i.e. /vsay num voicechat, /vsay 2 FTAttack)
</pitatable>

=== Trickjump Cvars ===
Note: cheats must be enabled to use these. See the pages for [[TrickJumpLines]] (tjl) and [[TrickJumpGhosts]] (tjg) for more information.

<pitatable columns=2 headlines="Cvar;Description" headerbgcolor="0b53b4" headerfontcolor="#FFFFFF" border1=2 border2=1 aligns="left;left">
b_tjg_ghostfx;Controls special effects for trick jump ghosts to distinguish them from normal players, default 2, valid values 0 - 4... 0 = No effect, 1 = Flicker, 2 = Ghost, 3 = Flaming, 4 = Flame only
b_tjl_color;Sets the default trick jump line color default green, valid values: any hex RGB color values (e.g. 0x56789a), or a known color name (e.g. "red", "white", "green", etc), -1 to disable.
b_tjl_draw;Controls whether trick jump lines will be drawn, default 1, enabled.
b_tjl_quickslot;Defines the slot used when specifying "quickslot" to tjl_startrecord, this is also the slot used by tjl_menu, default 0, disabled.
b_tjl_showmaxspeed;Controls whether the top speed reached will be drawn at the appropriate point on a trickjump line, default 0, disabled.
b_tjl_stepsize;Controls the minimum distance between any two points of the drawn trick jump line (increasing this may improve rendering performance for very long lines), default 0.5.
b_tjl_stoponnomove;Controls whether the trick jump line recording will automatically stop when the player being recorded stops moving, default 1, enabled.
</pitatable>

=== Trickjump Commands ===
<pitatable columns=2 headlines="Command;Description" headerbgcolor="0b53b4" headerfontcolor="#FFFFFF" border1=2 border2=1 aligns="left;left">
tjg_info;This will give you detailed information about all the tjg command's and cvars.
tjg_load;Loads a recording from a file, (i.e. tjg_load filename).
tjg_menu;A convenient menu for the tjg tools.
tjg_pause;Pauses/resumes the ghost playback.
tjg_play;Plays back a recorded ghost.
tjg_record;Starts recording your movements.
tjg_save;Saves a recording to a file, (i.e. tjg_save filename).
tjg_stop;Stops playing or recording.
tjl_drawslot;Controls drawing for a given slot or changes a slot's color (i.e. /tjl_drawslot slot OR slot color), b_tjl_color must be set to -1 in order to use this option.
tjl_info;This will give you detailed information about all the tjl command's and cvars.
tjl_load;Loads the current file into a slot (i.e. /tjl_load filename slot), (file extension = .tjl_1.dat (1 = version #)).
tjl_menu;A convenient menu for the tjl tools.
tjl_save;Saves the current slot into a file (i.e. / tjl_save filename slot), (file extension = .tjl_1.dat (1 = version #)).
tjl_startrecord;Starts recording you or a clients movements (i.e. tjl_startrecord clientnum slot OR slot OR no parameters records your own movements).
tjl_stoprecord;Stops recording movements.
</pitatable>

=== links ===
Links to more info about some of the above or other useful client pages here on WolfWiki.

*[[Lagometer]]
*[[Physics cvars]]
*[[B_placebo]]
*[http://bani.anime.net/banimod/forums/viewtopic.php?t=3332 Camera]
*[http://bani.anime.net/banimod/forums/viewtopic.php?t=6305 Camera]
*[http://bani.anime.net/banimod/forums/viewtopic.php?t=3333 Cheaters]
*[[Player_Scripting | Class & Classmenu]]
*[[Target_location | Locations]]
*[http://bani.anime.net/etpro/playerguide.html Multiview]
*[[SemiAdmin]]
*[[Memory_cvars | Hunk, Zone and sound Megs]]
*[[DrawFPS]]
*[[Client Configuration]]
*[[EDV]]
*[[Extended ASCII]]
*[[ETTV:Server Configuration]]
*[[ETTV:Viewer's Guide]]
*[[Voicechat]]

AutoExec

2006-04-28T02:32:53Z

Lagger: corrected autoexec launch mixup

== Default AutoExec ==

When connecting to any server, the client will look for the file ''AutoExec.cfg'' in the base folder of whatever mod the '''client''' is running, in ETPro's case this would be ''\Wolfenstein - Enemy Territory\etpro\'' and if found that file will be launched. It is advised that you start up the client with the mod of the server you are connecting to. This is especially true if you have a different config for each mod.

This is often used to store important settings that would normally be in your ''ETConfig.cfg'' file, as if the server forces a cvar to a value that does not match what you set the cvar's value to in your ETConfig.cfg file then that value will then be changed in your config file.

However if you store the cvar setting in your AutoExec.cfg file, then even if a server changes the cvar value, the next time you connect to a server the original setting you chose will be used again.

== Client Auto Map Scripts ==

When a map loads or restarts, the client will look for the following scripts and run them if found:

* autoexec_''mapname''.cfg
* autoexec_default.cfg

For example if the map rotates to battery, the client would look for autoexec_battery.cfg and run it. If autoexec_battery.cfg is not found, it would try to run autoexec_default.cfg instead.

== Client Auto Team/Class Scripts ==

When players spawn with a changed team or class, the client will look for the following scripts and run them if found:

* autoexec_axis.cfg
* autoexec_allies.cfg
* autoexec_spectator.cfg

* autoexec_soldier.cfg
* autoexec_medic.cfg
* autoexec_engineer.cfg
* autoexec_fieldops.cfg
* autoexec_covertops.cfg

These are only run when the team or class changes, they are not run on every spawn.

[[Category:ETPro]]

Lua Tutorials

2006-04-27T02:11:18Z

Lagger: spelling

__NOEDITSECTION__

This page isn't finished but its supposed to make you understand [[ETPro]] [http://www.lua.org/ lua] functions.

Before you start on this tutorial its assumed you do know basic [http://www.lua.org/ lua] scripting ,if not then i suggest you take a look at the online edition of the book [http://www.lua.org/pil/ Programming in Lua] or the [http://lua-users.org/wiki/ lua-users wiki].
You can also take a look at someone else his code, a list of [[ETPro]] mods can be found [[:Category:ETPro:Mods|here]].

==Getting started==
===Loading a Script===
:Scripts are loaded by their file name out of the /etpro sub directory of your Enemy Territory installation, so don't forget to save them in the right folder. 
:if you want to load HelloWorld.lua you would have to set the server cvar '''lua_modules''' to ''"HelloWorld.lua"''. 
:If you want to load more mods you can add them to the same variables separated by a space like ''"HelloWorld.lua lol.lua pingpong.lua"''
:'''NOTE''': if u modify this cvar all currently loaded [http://www.lua.org/ lua] modules will be unloaded.

:After editing your script you save it and then reload it in [[ETPro]] to make your chances take effect, this can simply be done by '''reset_match''' server command.

===Development Environment===
:While scripting you will see your code gets hard to read, its much easier to read whit syntax highlighting. this can be done be scripting inside an [http://www.lua.org/ lua] development environment.

:At [http://lua-users.org/wiki/LuaAddons this page] under ''[http://lua-users.org/wiki/LuaAddons development environments]'' you will find a list of [[http://lua-users.org/wiki/LuaAddons development environments].

==Tutorials==
:'''NOTE''': Lines written in '''Bold''' are the actual lines we gonna write to our script.
===Hello World===
:here we will show an simple hello world example for the server console
:just follow the steps and read the comments.

:1. First we need a new file so, create a new file and name it HelloWorld.lua.

::Now we need a [[ETPro]] [http://www.lua.org/ lua] function that will automagicly called by [[ETPro]] when we want it. Therefor we will use ''et_InitGame(levelTime,randomSeed,restart)'' that function is called ones every round at the beginning. its a good function to do some initial settings. We don't have to worry about those parameters (levelTime,randomSeed,restart) in this example.

:2. inside our file at line ''1'' we will write '''function et_InitGame(levelTime,randomSeed,restart) --called at beginning of a gameround'''

::Now we got a part of our script that is called at the beginning of a round so, now we can add our code to it. we are going to print ''"hello world"'' in the server console therefor we will use ''et.G_Print("message")'' that function will simply print the ''"message"'' in the server console

:3. now at line ''2'' we will write ''' et.G_Print("Hello World!!!\n") --printout our text to the console'''

::and as last we need to end out function at line ''1'' whit a simple ''end''

:4. at line ''3'' place '''end --close et_InitGame()'''

::now if you did it right you should have something like [http://home.zonnet.nl/westhof99/lua/HelloWorld.lua this]:
function et_InitGame(levelTime,randomSeed,restart) --called at beginning of a gameround
et.G_Print("Hello World!!!\n") --printout our text to the console
end --close et_InitGame()

::now save and load your script and you will see Hello World!!! in the server console.

<hr>
===Hello Spam===
:here we will show an simple Spammy hello world example for the server console
:just follow the steps and read the comments.

:1. First we need a new file so, create a new file and name it '''HelloSpam.lua'''.

::Now we need a [[ETPro]] [http://www.lua.org/ lua] function that will automagicly called by [[ETPro]] many times to make it spammy. Therefor we will use ''et_RunFrame(levelTime)'' that function is called every server frame. its a good function for stuff u need to constantly check but u should not put to much code in here. We don't have to worry about those parameter (levelTime) in this example.

:2. inside our file at line ''1'' we will write '''function et_RunFrame(levelTime) --called every serverframe'''

::Now we got a part of our script that is called at the beginning of a round so, now we can add our code to it. we are going to print ''"hello world"'' in the server console therefor we will use ''et.G_Print("message")'' that function will simply print the ''"message"'' in the server console

:3. now at line ''2'' we will write ''' et.G_Print("Hello Spam!!!\n") --printout our text to the console'''

::and as last we need to end our function at line ''1'' whit a simple at line ''3'' ''end''

:4. at line ''3'' place '''end --close et_RunFrame()'''

::now if u did it right u should have something like [http://home.zonnet.nl/westhof99/lua/HelloSpam.lua this]:
function et_RunFrame(levelTime) --called every serverframe
et.G_Print("Hello Spam!!!\n") --printout our text to the console
end --close et_RunFrame()
::now save and load your script and u will see Hello Spam!!! in the server console.
<hr>
===Hello Client===
:here we will show a simple hello world example for the client console
:just follow the steps and read the comments.

:1. First we need a new file so, create a new file and name it HelloClient.lua.

::Now we need a [[ETPro]] [http://www.lua.org/ lua] function that will automagicly called by [[ETPro]] when we want it. Therefor we will use ''et_InitGame(levelTime,randomSeed,restart)'' as shown in the ''Hello World'' example.

:2. inside our file at line ''1'' we will write '''function et_InitGame(levelTime,randomSeed,restart) --called at beginning of a gameround'''

::Now we need a function to print a message to the client his console therefor we will use et.trap_SendServerCommand(-1,"print \"message\n\"")'' that function will simply print the ''"message"'' in the client console console.
::The first parameter is client slot to send to if is -1 it will send to all clients. the 2nd parameters looks confusing and it is. First u got the main command witch is "print .." then, at the place of the dots comes the data to send whit the print in our case its "message\n""
::The \n will send a newline command to the console so the next message written to the console is on the next line. The \" are just " but since they are already inside a string u need to prefix them whit a \

:3. so just write this at line ''2'' ''' et.trap_SendServerCommand(-1,"print \"Hello Client\n\"") --printout our text to the console'''

::and as last we need to end out function at line ''1'' with a simple ''end''

:4. at line ''3'' place '''end --close et_InitGame()'''

::now if you did it right you should have something like [http://home.zonnet.nl/westhof99/lua/HelloClient.lua this]:
function et_InitGame(levelTime,randomSeed,restart) --called at beginning of a gameround
et.trap_SendServerCommand(-1,"print \"Hello Client\n\"") --printout our text to the console
end --close et_InitGame()

::now save and load your script and you will see Hello World!!! in the client console at the begin of a round.
<hr>
[[Category:ETPro]]
[[Category:ETPro:Mods]]
[[Category:ETPro:LUA]]

Lua Mod API

2006-04-27T02:08:07Z

Lagger: the spelling bee strikes again

__NOEDITSECTION__
ETPro now supports server side mods via the [http://www.lua.org/ lua] scripting language. For more information about lua, visit the [http://www.lua.org/manual/5.0/ Reference manual], the online edition of the book [http://www.lua.org/pil/ Programming in Lua] or the [http://lua-users.org/wiki/ lua-users wiki].

ETPro has an embedded lua 5.0.2 interpreter, and if present will load user-defined scripts from the etpro directory. ETPro also provides an "et" library of function calls for lua to access the server engine, and provides callbacks so a server side mod may trigger on specific server events.

The following standard lua libraries are initialized by default and available to ETPro lua scripts:
[http://www.lua.org/manual/5.0/manual.html#5.1 basic], [http://www.lua.org/manual/5.0/manual.html#5.4 table], [http://www.lua.org/manual/5.0/manual.html#5.6 i/o], [http://www.lua.org/manual/5.0/manual.html#5.3 string], [http://www.lua.org/manual/5.0/manual.html#5.5 math].

A list of [[ETPro]] mods can be found [[:Category:ETPro:Mods|here]].

A Tutorial about [[ETPro]] [http://www.lua.org/ lua] scripting for nubs can be found [[Lua Tutorials|here]].

API Requests can be discussed [http://wolfwiki.anime.net/index.php/Talk:ETPro:Lua_Mod_API here].

==client commands==
===lua_status===
:lists all currently loaded lua modules.
:''lua mods cannot override this client command.''

==server commands==
===lua_status===
:lists all currently loaded lua modules.

==cvars==
===lua_modules===
:(default "", disabled)
:space separated list of lua modules for ETPro to load. modules will be run in the order listed.

===lua_allowedmodules===
:(default "", disabled)
:if set, only lua modules with the matching sha1 signatures listed in this cvar will be allowed to load.
 
:changing either cvar will cause all currently loaded modules to :quit and be unloaded until the next map_restart. 
 

==et library calls==

===modules===
et.RegisterModname( '''modname''' )
:Registers a descriptive string '''modname''' for this mod.
'''vmnumber''' = et.FindSelf()
:Returns a number indicating the VM slot the current mod is loaded into.
'''modname''', '''signature''' = et.FindMod( '''vmnumber''' )
:Returns the '''modname''' and sha1 '''signature''' for the mod loaded in the VM slot '''vmnumber'''. Returns nil, nil if the VM slot is invalid.
'''success''' = et.IPCSend( '''vmnumber''', '''message''' )
:Sends the string '''message''' to the mod in the VM slot indicated by '''vmnumber'''. The mod receiving '''message''' must have an ''et_IPCReceive()'' callback. If the message is successfully sent, '''success''' will be 1. On failure it will be 0.
 

===printing===
et.G_Print( '''text''' )
:Prints the string '''text''' to the server console.
et.G_LogPrint( '''text''' )
:Prints the string '''text''' to the server console and writes it to the server log.
 

===argument handling===
These functions are to be used within the [[#commands|command callback functions]]. 
'''args''' = et.ConcatArgs( '''index''' )
:Returns all arguments beginning from '''index''' concatenated into a single string '''args'''
'''argcount''' = et.trap_Argc()
:Returns a number indicating the number of command line arguments in the command buffer.
'''arg''' = et.trap_Argv( '''argnum''' )
:Returns the contents of the command line argument '''argnum'''.
 

===cvars===
'''cvarvalue''' = et.trap_Cvar_Get( '''cvarname''' )
:Returns the value of the cvar '''cvarname''' as a string. If there is no cvar named '''cvarname''', returns a zero length string.
et.trap_Cvar_Set( '''cvarname''', '''cvarvalue''' )
:Sets the cvar '''cvarname''' to '''cvarvalue'''
 

===configstrings===
'''configstringvalue''' = et.trap_GetConfigstring( '''index''' )
:Returns the string '''configstringvalue''' containing the contents of the configstring '''index'''
et.trap_SetConfigstring( '''index''', '''configstringvalue''' )
:Sets the configstring '''index''' to the string '''configstringvalue'''
 

===server===
et.trap_SendConsoleCommand( '''when''', '''command''' )
:Sends the command '''command''' to the server console, to be executed '''when''' (see et.EXEC_* constants)
 

===clients===
et.trap_DropClient( '''clientnum''', '''reason''', '''ban_time''' )
:Disconnects '''clientnum''' from the server, with descriptive string '''reason''' reported to clients. '''ban_time''' is the time in seconds to ban the client from the server. '''ban_time''' is optional and may be entirely omitted, in which case the ban time defaults to the cvar ''b_defaultbantime''
et.trap_SendServerCommand( '''clientnum''', '''[[SendServerCommand|command]]''' )
:Sends the command '''[[SendServerCommand|command]]''' to the client '''clientnum'''. If '''clientnum''' is -1, the '''[[SendServerCommand|command]]''' is broadcast to all connected clients.
et.G_Say( '''clientNum''', '''mode''', '''text''' )
:Sends a chat command on behalf of client '''clientNum''' with the mode '''mode''' (see et.SAY_* constants) and chat text '''text'''.
et.ClientUserinfoChanged( '''clientNum''' )
:Loads the new Userinfo of '''clientNum''' and stores it in the configstring and client variables
 

===userinfo===
'''userinfo''' = et.trap_GetUserinfo( '''clientnum''' )
:Returns the contents of the userinfo string for the client '''clientnum'''
et.trap_SetUserinfo( '''clientnum''', '''userinfo''' )
:Sets the userinfo string for the client '''clientnum''' to '''userinfo'''
 

===string utility functions===
'''infostring''' = et.Info_RemoveKey( '''infostring''', '''key''' )
:Removes key '''key''' from infostring '''infostring''' and returns the modified infostring.
'''infostring''' = et.Info_SetValueForKey( '''infostring''', '''key''', '''value''' )
:Sets the key '''key''' in the infostring '''infostring''' to '''value''' and returns the modified infostring. If '''value''' is an empty string, '''key''' is removed from the string.
'''keyvalue''' = et.Info_ValueForKey( '''infostring''', '''key''' )
:Returns the value of the key '''key''' in the infostring '''infostring'''. If '''key''' is not present in the string, an empty string is returned.
'''cleanstring''' = et.Q_CleanStr( '''string''' )
:Returns '''string''' stripped of all color codes
 

===ET filesystem===
'''fd''', '''len''' = et.trap_FS_FOpenFile( '''filename''', '''mode''' )
:Attempts to open the file '''filename''' with the access mode '''mode''' (see et.FS_ constants). Returns the filedescriptor '''fd''' and file length '''len'''. On error, '''len''' returns -1.
'''filedata''' = et.trap_FS_Read( fd, count )
:Reads '''count''' bytes from filedescriptor '''fd'''.
'''count''' = et.trap_FS_Write( '''filedata''', '''count''', '''fd''' )
:Attempts to write '''count''' bytes of '''filedata''' to filedescriptor '''fd'''. Returns number of bytes successfully written.
et.trap_FS_Rename( '''oldname''', '''newname''' )
:Renames file '''oldname''' to '''newname'''.
et.trap_FS_FCloseFile( '''fd''' )
:Closes filedescriptor '''fd'''
 

===indexes===
'''soundindex''' = et.G_SoundIndex( '''filename''' )
:Returns an index to the soundfile indicated by '''filename'''
'''modelindex''' = et.G_ModelIndex( '''filename''' )
:Returns an index to the model indicated by '''filename'''
 

===sound===
et.G_globalSound( '''sound''' )
:Plays the global sound indicated by the filename '''sound'''.
et.G_Sound( '''entnum''', '''soundindex''' )
:Plays the sound '''soundindex''' at the location of entity '''entnum'''
 

===miscellaneous===
'''milliseconds''' = et.trap_Milliseconds()
:Returns a number indicating the current server time in milliseconds.
et.G_Damage( '''target''', '''inflictor''', '''attacker''', '''damage''', '''[[etdamage|dflags]]''', '''[[etdamage|mod]]''' )
:Does '''damage''' amount of damage on '''target''' inflicted by '''inflictor''' and cased by '''attacker'''
:'''target''', '''inflictor''', '''attacker''' are entity numbers
:'''[[etdamage|dflags]]''' is a [[Bitmask-cvar|bitflag]] number to decide how the damage is inflickted, see '''[[etdamage|dflags]]''' [[etdamage|flaglist]]
:'''[[etdamage|mod]]''' is a number from 0 up to 64 o set the type of damage, see '''[[etdamage|mod]]''' [[etdamage|list]]
 

===entities===
'''entnum''' = et.G_Spawn()
:Spawns a new entity and returns the new entity number.
'''entnum''' = et.G_TempEntity( '''origin''', '''event''' )
:Spawns a new TempEntity of event type '''event''' and places it at '''origin''' in the world.
:'''Warning:''' up to and including ETPro 3.2.4 the signature of the method is broken and expects four instead of two parameters. To successfully call it, you need to prepend the parameter list with two dummy parameters like et.G_TempEntity( 0, 0, origin, event ). Use this method with care, because in future ETPro versions it will probably be corrected to the one stated above and might break your script.
et.G_FreeEntity( '''entnum''' )
:Frees the entity '''entnum'''
'''spawnval''' = et.G_GetSpawnVar( '''entnum''', '''key''' )
:Returns the value of spawnvar '''key''' for entity '''entnum'''
et.G_SetSpawnVar( '''entnum''', '''key''', '''value''' )
:Sets the spawnvar '''key''' to '''value''' for entity '''entnum'''
'''integer entnum''' = et.G_SpawnGEntityFromSpawnVars( string spawnvar, string spawnvalue, ... )
:This function can only be called inside the '''et_InitGame''' callback
et.trap_LinkEntity( '''entnum''' )
:Links the entity '''entnum'''
et.trap_UnlinkEntity( '''entnum''' )
:Unlinks the entity '''entnum'''
'''(variable)''' = et.gentity_get ( '''entnum''', '''[[Fieldname]]''' '',arrayindex'' )
:Gets the value of '''[[Fieldname]]''' from entity '''entnum''' out of the g_entity struct. For NULL entities or clients, ''nil'' is returned. 
:''arrayindex'' is used to specify which element of an array entity field to get. It is required when accessing array type fields. Entity field array indexes start at 0.
et.gentity_set( '''entnum''', '''[[Fieldname]]''', ''arrayindex,'' '''(value)''' )
:Sets the value of '''[[Fieldname]]''' from entity '''entnum''' in the g_entity struct to '''(value)'''
:''arrayindex'' is used to specify which element of an array entity field to set.
et.G_AddEvent( '''ent''', '''event''', '''eventparm'''' )
:Adds event '''event''' whit eventparameter '''eventparm'''' to entity '''ent'''
 

==callbacks==

===qagame execution===
et_InitGame( '''levelTime''', '''randomSeed''', '''restart''' )
:Called when qagame initializes. '''levelTime''' is the current level time in milliseconds. '''randomSeed''' is a number that can be used to seed random number generators. '''restart''' indicates if et_InitGame() is being called due to a map restart (1) or not (0).
et_ShutdownGame( '''restart''' )
:Called when qagame shuts down. '''restart''' indicates if the shutdown is being called due to a map_restart (1) or not (0).
et_RunFrame( '''levelTime''' )
:Called when qagame runs a server frame. '''levelTime''' is the current level time in milliseconds.
et_Quit()
:Called when ETPro unloads the mod. The mod should close all open filedescriptors and perform all cleanup.
 

===client management===
'''rejectreason''' = et_ClientConnect( '''clientNum''', '''firstTime''', '''isBot''' )
:Called when a client attempts to connect to the server. '''clientNum''' is the client slot id, '''firstTime''' indicates if this is a new connection (1) or a reconnection (0). '''isBot''' indicates if the client is a bot (1) or not (0). If the mod accepts the connection, it should return nil. Otherwise, the mod should return a string describing the reason the client connection was rejected.
et_ClientDisconnect( '''clientNum''' )
:Called when a client disconnects. '''clientNum''' is the client slot id.
et_ClientBegin( '''clientNum''' )
:Called when a client begins (becomes active, and enters the gameworld). '''clientNum''' is the client slot id.
et_ClientUserinfoChanged( '''clientNum''' )
:Called when a client's Userinfo string has changed. '''clientNum''' is the client slot id.
et_ClientSpawn( '''clientNum''', '''revived''' )
:Called when a client is spawned. '''clientNum''' is the client slot id. '''revived''' is 1 if the client was spawned by beeying revived.
 

===commands===
'''intercepted''' = et_ClientCommand( '''clientNum''', '''command''' )
:Called when a command is received from a client. '''clientNum''' is the client slot id. '''command''' is the command. The mod should return 1 if the command was intercepted by the mod, and 0 if the command was ignored by the mod and should be passed through to the server (and other mods in the chain).
:The actual command can be accessed through the [[#argument_handling|argument handling]] functions, as seen in the [[ETPro:Lua Sample Code]].
'''intercepted''' = et_ConsoleCommand()
:Called when a command is entered on the server console. The mod should return 1 if the command was intercepted by the mod, and 0 if the command was ignored by the mod and should be passed through to the server (and other mods in the chain).
:The actual command can be accessed through the [[#argument_handling|argument handling]] functions, as seen in the [[ETPro:Lua Sample Code]].
 

===xp===
et_UpgradeSkill( '''cno''', '''skill''' )
:Called when client on slot '''cno''' gets a skill upgrade on skill '''skill''', return -1 to override (abort) the qagame function, anything else to "passthrough" callback may modify skills (or do anything else it wants) during passthrough.
et_UpgradeSkill( '''cno''', '''skill''' )
:Called when client '''cno''' his skill level of '''skill''' is set, return -1 to override (abort) the qagame function, anything else to "passthrough" callback may modify skills (or do anything else it wants) during passthrough.

===miscellaneous===
et_IPCReceive( '''vmnumber''', '''message''' )
:Called when another mod sends an et.IPCSend() message to this mod. '''vmnumber''' is the VM slot number of the sender, and '''message''' is the message.
et_Print( '''text''' )
:Called whenever the server or qagame prints a string to the console.
et_Obituary( '''victim''', '''killer''', '''meansOfDeath''' )
:Called whenever a player is killed.
 

==predefined constants==
et.EXEC_NOW 
et.EXEC_INSERT 
et.EXEC_APPEND 
et.FS_READ 
et.FS_WRITE 
et.FS_APPEND 
et.FS_APPEND_SYNC 
et.SAY_ALL 
et.SAY_TEAM 
et.SAY_BUDDY 
et.SAY_TEAMNL 
 
et.HOSTARCH
:set to WIN32 or UNIX depending on the host architecture qagame is running on.
LUA_PATH
:set to fs_homepath/fs_game/?.lua in order to ease use of the [http://www.lua.org/pil/8.1.html require] function.
 

==configs==
If a config is loaded, all modules are shutdown and reloaded. If a ''certified'' config is loaded, all modules are shutdown and reloaded, and additionally the following functions are disabled: '''require()''', '''loadfile()''', '''loadlib()''', '''loadstring()''', '''dofile()''' 
 

==caveats==
Like qagame, lua modules are unloaded and reloaded on map_restart and map changes. This means that all global variables and other information is lost. Mods may choose to store persistent data in cvars or external files. 
 

==FAQ==

Q: OMG I hate the libary prefix et.* on everything!!11!1oneone 
A: table.foreach(et, function (func, value) _G[func] = value; end)

Q: How do a re-load my lua file without restarting the whole server ? 
A: change maps or map_restart

Q: Can I see some sample code? 
A: [[ETPro:Lua Sample Code]]

Q: Is there a list of [[ETPro]] mods? 
A: Yes, [[:Category:ETPro:Mods|here]].

Q: OMG my mod doesn't work! 
A: Make sure you added your mod's filename to the lua_modules cvar (e.g. set lua_modules mymod.lua).

Q: OMG why has et_ClientSay been removed? 
A: Thats a secret but, to keep the function as it was, just add the following code to your et_ClientCommand() function 
<pre> -- et_ClientSay had to be removed in order to intercept all commands
-- so here's a wrapper for that
arg0 = et.trap_Argv(0) -- get the main command

if arg0 == "say" then
return et_ClientSay( clientNum, et.SAY_ALL, et.ConcatArgs(1))
elseif arg0 == "say_team" then
return et_ClientSay( clientNum, et.SAY_TEAM, et.ConcatArgs(1))
elseif arg0 == "say_buddy" then
return et_ClientSay( clientNum, et.SAY_BUDDY, et.ConcatArgs(1))
elseif arg0 == "say_teamnl" then
return et_ClientSay( clientNum, et.SAY_TEAMNL, et.ConcatArgs(1))
end
-- et_ClientSay wrapper end
</pre>

[[Category:ETPro]]
[[Category:ETPro:Mods]]

Category:ETPro:Server Cvars

2006-01-22T13:21:55Z

Lagger: now with table goodness

This category contains all articles with references to server-side cvars.
== List of server cvars without an article (very incomplete) ==
<pitatable columns=3 headlines="Cvar;Default;Description" aligns="left;center;left">
b_chargetransfer;1;0 = Disallow use of mines to transfer charge between players or 'store charge'. 1 = Default etmain behavior, allow charge transfer and storage.;
b_defaultbantime;300;Time in seconds for bans without explicitly defined ban time.;
b_distancefalloff; 1; 0 = Disable distance damage falloff for bullet weapons. 1 = Enable distance damage falloff for bullet weapons.;
b_emptyscript;"";Name of a script to execute when the last player leaves the server.;
b_flushitems; 0;Enables/disables ground-oriented items (medpacks, ammopacks).;
b_helmetprotection; 1;Allows server to enable/disable helmet damage reduction.;
b_maxmortarpitch; 0;Allows server to limit effective range of ground slope angles for mortar deployment. If set to eg 20, then a mortar deployed on a slope greater than 20 degrees (eg 30 or 40) would behave as if it were deployed on a slope of 20 degrees.;
b_shrug; 0;0 = Disable /shrug. 1 = Enable /shrug.;
b_sv_hitsounds; 1;0 = Server globally disables hitsounds. 1 = Server allows clients to use hitsounds.;
b_wolfrof; 0;0 = ET Standard SMG Rate of fire. 1 = RTCW Standard SMG Rate of fire.;
vote_allow_surrender;1;Enables/disables surrender callvoting.;
</pitatable>

[[Category:ETPro]]

Category:ETPro:Server Cvars

2006-01-22T12:57:15Z

Lagger: added a few cvars not described in articles (blatant c/p from 3.2.0 changelog)

This category contains all articles with references to server-side cvars.
== List of server cvars without an article (very incomplete) ==
'''vote_allow_surrender''' (default 1, enabled)
Enables/disables surrender callvoting.

'''b_flushitems''' (default 0, disabled)
Enables/disables ground-oriented items (medpacks, ammopacks).

'''b_helmetprotection''' (default 1, enable)
Allows server to enable/disable helmet damage reduction.

'''b_maxmortarpitch''' (default 0, disable)
Allows server to limit effective range of ground slope angles for mortar deployment. If set to eg 20, then a mortar deployed on a slope greater than 20 degrees (eg 30 or 40) would behave as if it were deployed on a slope of 20 degrees.

'''b_chargetransfer''' (default 1, enable)
0 = Disallow use of mines to transfer charge between players or 'store charge'
1 = Default etmain behavior, allow charge transfer and storage

'''b_sv_hitsounds''' (default 1, enable)
0 = Server globally disables hitsounds.
1 = Server allows clients to use hitsounds.

'''b_emptyscript''' (default "", disabled)
Name of a script to execute when the last player leaves the server.

'''b_defaultbantime''' (default 300)
Time in seconds for bans without explicitly defined ban time.

'''b_wolfrof''' (default 0)
0 = ET Standard SMG Rate of fire.
1 = RTCW Standard SMG Rate of fire.

'''b_shrug''' (default 0)
0 = Disable /shrug.
1 = Enable /shrug.

'''b_distancefalloff''' (default 1)
0 = Disable distance damage falloff for bullet weapons.
1 = Enable distance damage falloff for bullet weapons.

[[Category:ETPro]]

Shoutcasting

2005-12-19T09:59:12Z

Lagger: cleaned up fusen's mess, then made it worse

A shoutcaster is a spectating player with enhanced spectating abilities.

Shoutcasters see:
* Floating player names
* Dynamite counter
* Truck/tank health
* Unspotted/spotted mines

Shoutcasters are:
* Not affected by speclock.
* Marked with "shoutcaster" in the scoreboard.
* Unable to join a team.

== Becoming a shoutcaster ==
To become a shoutcaster, login with ''sclogin'' <pass> or ''shoutcastlogin'' <pass>, using the password provided by the server admin. Use ''sclogout'' or ''shoutcastlogout'' to log out.

To promote spectators to shoutcasters, referees and admins with rcon access can use these commands:

* ''makeshoutcaster'''''|'''''makeshoutcast'''''|'''''makesc'' <clientid>

* ''removeshoutcaster'''''|'''''removeshoutcast'''''|'''''removesc'' <clientid>

== Admins ==
Enable shoutcasting by setting a non-empty shoutcast password in the cvar ''b_shoutcastpassword''. Disable shoutcasting by using an empty string.

[[Category:ETPro:Server_Cvars]]

Headshot Mode

2005-12-19T09:05:54Z

Lagger: category, bitmask link added

A headshot mode is included in ETPro, controlled by the [[bitmask-cvar|bitmask cvar]] ''b_headshot'':
<pre>
0 = disabled
1 = only headshots do damage
2 = instagib headshots : hit = kill
4 = only clients can be damaged, not world entities (e.g. barrels)
8 = you can only receive damage from other clients, you can't receive damage from the world, e.g. from an exploding barrel</pre>

The instagib damage is controlled by the cvar ''b_instagibdamage'', 400 is the default value.

[[Category:ETPro:Server_Cvars]]

User talk:Infty

2005-11-28T22:01:47Z

Lagger:

\o/ --[[User:Deus|Deus]] 11:06, 28 November 2005 (PST)

/me slaps Infty with the preview whip --[[User:Lagger|Lagger]] 14:01, 28 November 2005 (PST)

Category talk:ETPro:Mods

2005-11-15T18:23:13Z

Lagger:

can my name be added here ? i dont seem tobe able to edit this page (=FF=im2good4u)

use the <nowiki>[[Category:ETPro:Mods]]</nowiki> tag in your article like the others did --[[User:Lagger|Lagger]] 10:23, 15 November 2005 (PST)

Physics cvars

2005-11-12T00:56:25Z

Lagger: categories added

Since Quake 3, the function that's responsible for game physics ''(amongst other things)'' is named Pmove(). Normally, this function is run once every client frame, and this is where framerate-dependant physics (most notably jump heights) come from. pmove_fixed is an attempt to level the playing field by running this function at a fixed rate ''(every pmove_msec milliseconds.)'' The default pmove_msec of 8 is equivalent to normal physics at 1000 / 8 = 125 frames/second.

* '''pmove_fixed''' can be set on either the client or the server--the client will default to the value on the server ''(And, on non-ETPro servers, it will be reset to the value of the server quite frequently due to some silliness in the code.)'' pmove_msec can only be set on the server side.
:''note'': setting pmove_fixed on etpro can still have some undesired side effects. In particular, there is still a bug when using weapons that recoil which makes it very hard to hit.

* '''b_fixedphysics''' is a server-side setting with similar goals to pmove_fixed. b_fixedphysics 1 avoids rounding the velocity at all ''(Removing the framerate-dependent behavior in movement)''; however, it offers b_fixedphysicsfps to adjust the jump velocity to emulate the old framerate-dependent behavior. This is the best of both worlds—no movement speed problems ''(as several people observed at 333fps)'' nor any of the problems that pmove_fixed brings with it ''(some parts of the game behave poorly at high fps, most notably mounted MG42 and mortar aiming)'', but the same jump heights trickjumpers would kill us for taking away. b_fixedphysics 2 is a cross between normal behavior and fixed behavior, which effectively just caps the maximum framerate-dependent behavior to 166fps.

* '''b_optimizedprediction''' is a client-side setting that ''(theoretically)'' has no effect other than increasing performance. Basically, etmain ''(and RTCW, and Q3)'' will re-do all the physics computations for up to the previous 64 frames in order to figure out where you should be for the current one. b_optimizedprediction will store the result of the previous computations and reuse them ''(Only if the results look acceptable based on the latest data the client has from the server)'' instead of doing all the math again. This provides a rather dramatic performance boost, especially if you have a high ping.

[[Category:ETPro]][[Category:ETPro:Server_Cvars]][[Category:ETPro:Client_Cvars]]

Player Scripting

2005-11-09T23:27:53Z

Lagger: client side scripting: i might expand it later with autoexec_whatever usage

== Team and class selection ==

Players no longer have to use the ''limbo menu'' or the complex ''team'' command to select team and class.

=== Class command ===

the command ''class'' allows you to script the selection of team and class.

syntax: '''class''' ''class weapon {secondary weapon}''

Class:
* s: soldier
* m: medic
* f: field-op
* e: engineer
* c: covert-op

Weapon:
use the weapon numbers from the class menu below:

Secondary Weapon (optional):
# pistol
# akimbo-pistol
# smg (for soldiers with level 4 heavy weapons)

Here's a template for making your own class binds:
bind KP_END "vstr cs_medic"
bind KP_DOWNARROW "vstr cs_fieldop"
bind KP_PGDN "vstr cs_engi_smg"
bind KP_LEFTARROW "vstr cs_covert_sniper"
bind KP_5 "vstr cs_panz"
 // class vstr's
set cs_mg42 "class s 2 3;echo spawning as: soldier w/mg42"
set cs_flamer "class s 3 3;echo spawning as: soldier w/flamethrower"
set cs_panz "class s 4 3;echo spawning as: soldier w/panzerfaust"
set cs_mortar "class s 5 3;echo spawning as: soldier w/mortar"
set cs_medic "class m 1 2;echo spawning as: medic"
set cs_fieldop "class f 1 2;echo spawning as: field-ops"
set cs_engi_smg "class e 1 2;echo spawning as: engineer w/smg"
set cs_engi_rifle "class e 2 2;echo spawning as: engineer w/rifle"
set cs_covert_sniper "class c 3 2;echo spawning as: covert-ops w/sniper rifle"
set cs_covert_fg42 "class c 2 2;echo spawning as: covert-ops w/fg42"
set cs_covert_sten "class c 1 2;echo spawning as: covert-ops w/sten"

=== Class menu ===

using the command ''classmenu'' allows the player to select class and weapon:

bind x "classmenu"

# soldier
## smg
## mg42
## flamethrower
## panzerfaust
## mortar
# medic
# field-op
# engineer
## smg
## garand/k43
# covert-op
## sten
## fg42
## scoped garand/k43

=== Team menu ===

the command ''teammenu'' allows the player to select a team before selecting class and weapon:

bind x "teammenu"

# axis --> class menu
# allies --> class menu
# spectator

[[category:ETPro]]

Talk:Physics cvars

2005-11-08T01:04:43Z

Lagger:

worst. headline. ever.

DrawFPS

2005-11-05T17:08:49Z

Lagger: category client cvars

The FPS counter in ETPro is been extended from the default setting.

There are now three different settings you can use to show more detailed information about your frames per second.

'''cg_DrawFPS 2'''
Draws a more accurate fps meter, it updates every second

'''cg_DrawFPS 3'''
Draws the time needed to render a frame in milliseconds

'''cg_DrawFPS >3'''
The same as 2 but here you can you specify the time in milliseconds between two updates

[[Category:ETPro:Client_Cvars]]

Hitsounds

2005-11-05T16:44:08Z

Lagger: added category: client cvars

ETPro uses hitsounds like those used in Quake 3 Arena, hitsounds are sounds that are played when you hit another player, there are three different instances when a sound will play:

* When you shoot an enemy
* When you shoot an enemy in the head hitbox
* When you shoot a teammate

== Using Hitsounds ==

The hitsounds are controlled by the cvar '''b_hitsounds'''
There are three different settings that can be used with this cvar;

<pre>1 = On, All sounds are used
0 = Off, No sounds are used
2 = A sound occurs only when you get a headshot</pre>

[[Category:ETPro:Client_Cvars]]

AntiWarp

2005-11-05T16:43:15Z

Lagger:

ET Pro implements an antiwarp system to keep players from "warping" or "teleporting" around, accidentally or intentionally.

== Controlling the antiwarp system ==

'''b_antiwarp''' controls the antiwarp system. The possible settings are:
<pre>0 - disabled. ET Pro does no antiwarp at all.
1 - enabled (default). ET Pro keeps players from "warping"</pre>

== What is "warping" ==

"Warping" occurs when the server recieves several new commands for a player in a very short period of time. This happens because packets from the player were lost or never sent. The player will appear to cross a great distance in a very short period of time, making them hard to hit and possibly allowing them to avoid landmine damage.

== How the antiwarp system keeps players from warping ==

The antiwarp system in ET Pro delays commands when they are recieved too quickly. Thus, when a player sends 700ms worth of commands in 50ms, the commands will be spread out over 700ms, causing the player to move smoothly to other players. This affects the player who sent the commands too quickly only by increasing their ping, and will not keep increasing ping endlessly - at maximum, the added ping is the highest ping the player is actually getting. If temporary network issues cause ping to increase beyond a sensible number, the player can stand still for a moment and their ping will normalize.

[[Category:ETPro:Client_Cvars]]

Category:ETPro:Client Cvars

2005-11-05T16:42:22Z

Lagger: good way to index cvar descriptions, and tell server and client cvars apart

This is a list of articles describing the console variables available to the player.

WolfWiki:Community Portal

2005-11-04T08:36:24Z

Lagger: /* Leagues / Competitions */

== News Sites ==

* [http://www.et-center.com/ ET-Center]
* [http://www.xfire.be/ Xfire.be]
* [http://www.gamestv.org/ GAMESTV.ORG]
* [http://www.swertcw.com/ sweRTCW]
* [http://www.planetwolfenstein.com/ Planet Wolfenstein]
* [http://www.etnation.co.uk/ ETNation.co.uk]
* [http://www.splashdamage.com/ SplashDamage.com]
* [http://www.planetwolfenstein.de/ PlanetWolfenstein.de]
* [http://www.rtcw.co.uk/ rtcw.co.uk]

== Leagues / Competitions ==

* [http://www.clanbase.com/ Clanbase]
* [http://www.teamwarfare.com/ TeamWarfare League]
* [http://www.sta-league.org/ Stronger Than All]
* [http://www.et-cup.net/ ET-Cup]
* [http://www.warleagues.com/ Warleagues]

== Mods ==

* [http://stealthy.foolishgames.net/ FalckonET]
* [http://www.truecombat.com/intro.php TC:Elite]
* [http://www.omni-bot.com/ Omni-Bot]
* [http://www.priceofpeace.net/ The Price of Peace]
* [http://www.etpub.org/news.php ETPub]
* [http://jaymod.clanfu.org/ Jaymod]