Unvanquished - User contributions [en-gb]

MediaWiki:Sidebar

2014-01-04T02:47:51Z

Anomalous: Add “www.” where appropriate

* Wiki pages
** //www.unvanquished.net/wiki|Main page
** Special:RecentChanges|Recent changes
** Special:NewFiles|New file gallery
** Special:AllPages|All pages
** Special:LonelyPages|Orphaned pages
** Special:Random|Random page

* In-Browser IRC
** http://webchat.freenode.net/?channels=unvanquished|#unvanquished
** http://webchat.freenode.net/?channels=unvanquished-dev|#unvanquished-dev

* navigation
** //www.unvanquished.net|unvanquished.net
** //www.unvanquished.net/about|*/about
** //www.unvanquished.net/gallery|*/gallery
** //www.unvanquished.net/servers|*/servers
** //www.unvanquished.net/news|*/news
** //www.unvanquished.net/forum|*/forum

* SEARCH
* TOOLBOX
* LANGUAGES

MediaWiki:Sidebar

2014-01-04T02:46:11Z

Anomalous: Link format change (default to current protocol)

* Wiki pages
** //unvanquished.net/wiki|Main page
** Special:RecentChanges|Recent changes
** Special:NewFiles|New file gallery
** Special:AllPages|All pages
** Special:LonelyPages|Orphaned pages
** Special:Random|Random page

* In-Browser IRC
** http://webchat.freenode.net/?channels=unvanquished|#unvanquished
** http://webchat.freenode.net/?channels=unvanquished-dev|#unvanquished-dev

* navigation
** //unvanquished.net|unvanquished.net
** //unvanquished.net/about|*/about
** //unvanquished.net/gallery|*/gallery
** //unvanquished.net/servers|*/servers
** //unvanquished.net/news|*/news
** //unvanquished.net/forum|*/forum

* SEARCH
* TOOLBOX
* LANGUAGES

MediaWiki:Sidebar

2014-01-04T02:45:08Z

Anomalous: Reverted edits by Anomalous (talk) to last revision by Veyrdite

* Wiki pages
** https://unvanquished.net/wiki|Main page
** Special:RecentChanges|Recent changes
** Special:NewFiles|New file gallery
** Special:AllPages|All pages
** Special:LonelyPages|Orphaned pages
** Special:Random|Random page

* In-Browser IRC
** http://webchat.freenode.net/?channels=unvanquished|#unvanquished
** http://webchat.freenode.net/?channels=unvanquished-dev|#unvanquished-dev

* navigation
** https://unvanquished.net|unvanquished.net
** https://unvanquished.net/about|*/about
** https://unvanquished.net/gallery|*/gallery
** https://unvanquished.net/servers|*/servers
** https://unvanquished.net/news|*/news
** https://unvanquished.net/forum|*/forum

* SEARCH
* TOOLBOX
* LANGUAGES

MediaWiki:Sidebar

2014-01-04T02:44:12Z

Anomalous: Testing link format change

* Wiki pages
** [//www.unvanquished.net/wiki Main page]
** Special:RecentChanges|Recent changes
** Special:NewFiles|New file gallery
** Special:AllPages|All pages
** Special:LonelyPages|Orphaned pages
** Special:Random|Random page

* In-Browser IRC
** http://webchat.freenode.net/?channels=unvanquished|#unvanquished
** http://webchat.freenode.net/?channels=unvanquished-dev|#unvanquished-dev

* navigation
** https://www.unvanquished.net|unvanquished.net
** https://www.unvanquished.net/about|*/about
** https://www.unvanquished.net/gallery|*/gallery
** https://www.unvanquished.net/servers|*/servers
** https://www.unvanquished.net/news|*/news
** https://www.unvanquished.net/forum|*/forum

* SEARCH
* TOOLBOX
* LANGUAGES

Maps

2013-12-12T01:10:55Z

Anomalous: Yocto level shot

=Official Unvanquished Maps=
These maps are distributed with the default installation

==New Maps==
Maps that have been made or updated for Unvanquished

{|class="wikitable"
|-
! Name and Description
! Levelshot
|-

| '''Parpax'''
* Medium sized
* Many branching paths
* Crawl spaces and piping
* Elevators
by Viech

|[[File:Levelshots-Parpax_compressed.jpg|400px]]
|-

| '''Platform 23'''
* Symmetrical
* Replacement for ATCS
* Two route design
|[[File:Levelshots-Plat23-b11.jpg|400px]]
|-

|'''Snowstation (beta 4)'''
* Two route design
* Medium sized
* Outside area
|[[File:Levelshots-Snowstation-b4.jpg|400px]]
|-

| '''Thunder'''
* Very large
|[[File:Levelshot-Thunder-b3.png|400px]]
|-

| '''Yocto'''
|[[File:Levelshot-Yocto-b1a.jpg|400px]]
|-

|}

==Gentrified Maps==
Maps that were born in Tremulous.

{|class="wikitable"
|-
! Name and Description
! Levelshot
|-

| '''.:U.T:C.S:.'''
* Symmetrical
* Two route design
* Small
| [[File:Levelshot-Utcs.jpg|400px]]
|-

| '''Arachnid 2'''
* Varied rooms, corridors and layers
* Crawl spaces and piping
* Medium sized
| [[File:Levelshots-Arachnid2.jpg|400px]]
|-

|'''Karith Station 2'''
* Varied rooms, corridors and layers
* Outside area
* Crawl spaces
* Large
* Elevators
by Godmil
|[[File:Levelshots-Karith.jpg|400px]]
|-

| '''Methane (beta 1)'''
* Large
* Vertically complex
by Ingar
|[[File:Levelshots-Methane-beta1.jpg|400px]]
|-

|'''Nano!'''
* Small
* Symmetrical
by Ingar
|[[File:Levelshots-Nano.jpg|400px]]
|-

|'''Nexus 6'''
* Varied rooms, corridors and layers
* Crawl spaces
* Medium sized
|[[File:Levelshots-Nexus6.jpg|400px]]
|-

|'''Niveus : Outpost 652'''
* Varied rooms, corridors and layers
* Medium sized
|[[File:Levelshots-Niveus.jpg|400px]]
|-

|'''Orion I - communication ship (beta 2)'''
|[[File:Levelshots-Orion.jpg|400px]]
|-

|'''Spacetracks Release 1'''
* Varied rooms, corridors and layers
* Many Elevators
* Crawl spaces
by Supertanker
|[[ File:Levelshots-Spacetracks-r1.jpg |400px]]
|-

| '''Station15 Release 1'''
* Varied rooms and corridors
* Elevators
by Supertanker
|[[File:Levelshots-Station15-r1.jpg|400px]]
|-

|'''Tremor'''
* Medium sized
* Large rooms and corridors
* Crawl spaces (underground section)
by Vedacon
|[[File:Levelshots-Tremor.jpg|400px]]
|-

|}

File:Levelshot-Yocto-b1a.jpg

2013-12-12T01:10:06Z

Anomalous: From map-yocto-b1a.pk3

From map-yocto-b1a.pk3

Maps

2013-12-12T01:01:07Z

Anomalous: /* New Maps */

{{OutOfDate}}

=Official Unvanquished Maps=
These maps are distributed with the default installation

==New Maps==
Maps that have been made or updated for Unvanquished

{|class="wikitable"
|-
! Name and Description
! Levelshot
|-

| '''Parpax'''
* Medium sized
* Many branching paths
* Crawl spaces and piping
* Elevators
by Viech

|[[File:Levelshots-Parpax_compressed.jpg|400px]]
|-

| '''Platform 23'''
* Symmetrical
* Replacement for ATCS
* Two route design
|[[File:Levelshots-Plat23-b11.jpg|400px]]
|-

|'''Snowstation (beta 4)'''
* Two route design
* Medium sized
* Outside area
|[[File:Levelshots-Snowstation-b4.jpg|400px]]
|-

| '''Thunder'''
* Very large
|[[File:Levelshot-Thunder-b3.png|400px]]
|-

| '''Yocto'''
| TODO
|-

|}

==Gentrified Maps==
Maps that were born in Tremulous.

{|class="wikitable"
|-
! Name and Description
! Levelshot
|-

| '''.:U.T:C.S:.'''
* Symmetrical
* Two route design
* Small
| [[File:Levelshot-Utcs.jpg|400px]]
|-

| '''Arachnid 2'''
* Varied rooms, corridors and layers
* Crawl spaces and piping
* Medium sized
| [[File:Levelshots-Arachnid2.jpg|400px]]
|-

|'''Karith Station 2'''
* Varied rooms, corridors and layers
* Outside area
* Crawl spaces
* Large
* Elevators
by Godmil
|[[File:Levelshots-Karith.jpg|400px]]
|-

| '''Methane (beta 1)'''
* Large
* Vertically complex
by Ingar
|[[File:Levelshots-Methane-beta1.jpg|400px]]
|-

|'''Nano!'''
* Small
* Symmetrical
by Ingar
|[[File:Levelshots-Nano.jpg|400px]]
|-

|'''Nexus 6'''
* Varied rooms, corridors and layers
* Crawl spaces
* Medium sized
|[[File:Levelshots-Nexus6.jpg|400px]]
|-

|'''Niveus : Outpost 652'''
* Varied rooms, corridors and layers
* Medium sized
|[[File:Levelshots-Niveus.jpg|400px]]
|-

|'''Orion I - communication ship (beta 2)'''
|[[File:Levelshots-Orion.jpg|400px]]
|-

|'''Spacetracks Release 1'''
* Varied rooms, corridors and layers
* Many Elevators
* Crawl spaces
by Supertanker
|[[ File:Levelshots-Spacetracks-r1.jpg |400px]]
|-

| '''Station15 Release 1'''
* Varied rooms and corridors
* Elevators
by Supertanker
|[[File:Levelshots-Station15-r1.jpg|400px]]
|-

|'''Tremor'''
* Medium sized
* Large rooms and corridors
* Crawl spaces (underground section)
by Vedacon
|[[File:Levelshots-Tremor.jpg|400px]]
|-

|}

Maps

2013-12-12T01:00:16Z

Anomalous: Thunder levelshot

{{OutOfDate}}

=Official Unvanquished Maps=
These maps are distributed with the default installation

==New Maps==
Maps that have been made or updated for Unvanquished

{|class="wikitable"
|-
! Name and Description
! Levelshot
|-

| '''Parpax'''
* Medium sized
* Many branching paths
* Crawl spaces and piping
* Elevators
by Viech

|[[File:Levelshots-Parpax_compressed.jpg|400px]]
|-

| '''Platform 23'''
* Symmetrical
* Replacement for ATCS
* Two route design
|[[File:Levelshots-Plat23-b11.jpg|400px]]
|-

|'''Snowstation (beta 4)'''
* Two route design
* Medium sized
* Outside area
|[[File:Levelshots-Snowstation-b4.jpg|400px]]
|-

| '''Thunder'''
* Very large
|[[File:Levelshots-Thunder-b3.png|400px]]
|-

| '''Yocto'''
| TODO
|-

|}

==Gentrified Maps==
Maps that were born in Tremulous.

{|class="wikitable"
|-
! Name and Description
! Levelshot
|-

| '''.:U.T:C.S:.'''
* Symmetrical
* Two route design
* Small
| [[File:Levelshot-Utcs.jpg|400px]]
|-

| '''Arachnid 2'''
* Varied rooms, corridors and layers
* Crawl spaces and piping
* Medium sized
| [[File:Levelshots-Arachnid2.jpg|400px]]
|-

|'''Karith Station 2'''
* Varied rooms, corridors and layers
* Outside area
* Crawl spaces
* Large
* Elevators
by Godmil
|[[File:Levelshots-Karith.jpg|400px]]
|-

| '''Methane (beta 1)'''
* Large
* Vertically complex
by Ingar
|[[File:Levelshots-Methane-beta1.jpg|400px]]
|-

|'''Nano!'''
* Small
* Symmetrical
by Ingar
|[[File:Levelshots-Nano.jpg|400px]]
|-

|'''Nexus 6'''
* Varied rooms, corridors and layers
* Crawl spaces
* Medium sized
|[[File:Levelshots-Nexus6.jpg|400px]]
|-

|'''Niveus : Outpost 652'''
* Varied rooms, corridors and layers
* Medium sized
|[[File:Levelshots-Niveus.jpg|400px]]
|-

|'''Orion I - communication ship (beta 2)'''
|[[File:Levelshots-Orion.jpg|400px]]
|-

|'''Spacetracks Release 1'''
* Varied rooms, corridors and layers
* Many Elevators
* Crawl spaces
by Supertanker
|[[ File:Levelshots-Spacetracks-r1.jpg |400px]]
|-

| '''Station15 Release 1'''
* Varied rooms and corridors
* Elevators
by Supertanker
|[[File:Levelshots-Station15-r1.jpg|400px]]
|-

|'''Tremor'''
* Medium sized
* Large rooms and corridors
* Crawl spaces (underground section)
by Vedacon
|[[File:Levelshots-Tremor.jpg|400px]]
|-

|}

File:Thunder-b3.png

2013-12-12T00:46:49Z

Anomalous: From map-thunder-b3.pk3

From map-thunder-b3.pk3

Compiling the source

2013-12-04T00:02:05Z

Anomalous: Update Debian & Ubuntu build information

==Mac OS X==

First, you need to [[Getting_the_source|acquire the source code]].

Regardless of what interface you may use to compile the source, you will need [http://www.cmake.org/cmake/resources/software.html CMake] to generate makefiles. You will also need to install [https://developer.apple.com/xcode/ Xcode] (making sure to choose to install the command-line utilities when prompted by the installer).

Then, you will need to acquire (and in some cases, manually compile) at a minimum the [[#Dependencies|necessary libraries]].

Once you have the source code and the libraries installed, you may actually proceed to compile the source. You have several options:
* '''Compile the source at the command line'''. This is the easiest if you would just like to compile the game to use yourself and you do not intend to work on the code.
* '''Compile the source using an IDE'''. This is preferred if you intend on developing the source.
** Xcode is Apple's flagship IDE and you should have installed to compile the source regardless of which method you use.
** [http://qt-project.org/downloads QtCreator] is cross-platform and provides real-time feedback of syntax errors, a Vim mode, as well as other features.
** [http://www.codeblocks.org/ Code::Blcoks] is also cross-platform but lacks some of the features of Xcode and QtCreator.

===Dependencies===

You only need to use one of the following methods (HomeBrew or compiling by hand). Please try and avoid mixing methods as this may produce unexpected results.

Unvanquished requires the following libraries:
* [[#JPEG|JPEG]], version 8 or higher. (Version 6 was known to have problems)
* [[#Simple_DirectMedia_Layer_.28SDL.29|Simple DirectMedia Layer]] (The binary provided by libsdl.org causes graphical corruptions. Compile from source or use homebrew/macports)
* [[#The_OpenGL_Extension_Wrangler_Library_.28GLEW.29|The OpenGL Extension Wrangler Library]]
* CuRL
* [[#The_GNU_MP_Bignum_Library_.28libgmp.29|GMP]]
* [[#WebP|WebP]] (v0.2.0 or newer)

The following libraries are optional:
* Theora
* Speex
* [[#Ogg|Ogg]]
* [[#Vorbis|Vorbis]]

====HomeBrew====
Install [http://mxcl.github.com/homebrew/ HomeBrew] and then run the following command

$ brew install nettle libjpeg curl sdl webp xvid gmp glew speex libvorbis theora

All the necessary libraries should now have been installed.

====Compiling by hand====
The following are shell scripts that download, compile, and install various libraries. This is more time consuming then other methods but might be useful if you need more control over your libraries

=====JPEG=====

$ curl http://www.ijg.org/files/jpegsrc.v8d.tar.gz > jpegsrc.v8d.tar.gz
$ tar xvzf jpegsrc.v8d.tar.gz
$ cd jpeg-8d
$ ./configure
$ make
$ sudo make install

=====The OpenGL Extension Wrangler Library (GLEW)=====

$ curl -L https://sourceforge.net/projects/glew/files/glew/1.7.0/glew-1.7.0.tgz/download > glew-1.7.0.tgz
$ tar xvzf glew-1.7.0.tgz
$ cd glew-1.7.0
$ make
$ sudo make install

=====Simple DirectMedia Layer (SDL)=====

Do not use the binaries provided by libsdl.org, as these are known to cause issues with gamma and color display. Instead, compile your own:

$ curl http://www.libsdl.org/release/SDL-1.2.15.tar.gz > SDL-1.2.15.tar.gz
$ tar xvzf SDL-1.2.15.tar.gz
$ cd SDL-1.2.15
$ ./configure
$ make
$ sudo make install

=====The GNU MP Bignum Library (libgmp)=====

$ curl ftp://ftp.gmplib.org/pub/gmp-5.0.5/gmp-5.0.5.tar.bz2 > gmp-5.0.5.tar.bz2
$ tar xvjf gmp-5.0.5.tar.bz2
$ cd gmp-5.0.5
$ ./configure
$ make
$ sudo make install

=====Ogg=====

$ curl http://downloads.xiph.org/releases/ogg/libogg-1.3.0.tar.gz > libogg-1.3.0.tar.gz
$ tar xvzf libogg-1.3.0.tar.gz
$ cd libogg-1.3.0
$ ./configure
$ make
$ sudo make install

=====Vorbis=====

$ curl http://downloads.xiph.org/releases/vorbis/libvorbis-1.3.3.tar.gz > libvorbis-1.3.3.tar.gz
$ tar xvzf libvorbis-1.3.3.tar.gz
$ cd libvorbis-1.3.3
$ ./configure
$ make
$ sudo make install

=====WebP=====

You do not need to compile WebP by hand; Google provides binaries for Mac OS X available from their [https://code.google.com/p/webp/downloads/detail?name=libwebp-0.2.0-mac-10.5.tar.gz project page]. You will need version 0.2.0 or newer.

Once downloaded, you must still install the header files and the binary:

$ curl https://webp.googlecode.com/files/libwebp-0.2.0-mac-10.5.tar.gz > libwebp-0.2.0-mac-10.5.tar.gz
$ tar xvzf libwebp-0.2.0-mac-10.5.tar.gz
$ cd libwebp-0.2.0-mac-10.5
$ sudo cp include/webp /usr/local/include
$ sudo cp lib/libwebp.a /usr/local/lib

===Configuring with CMake===

# Run CMake.
# Enter the location of the source code.
# Enter the location in which you would like to build the source code. This should be a different directory.
# Hit "Configure". You will be prompted as to which generator you would like to use. If you have Xcode installed, choose that. Wait while the configuration process runs. You may have to set the following:
## If CMake did not find your jpeg headers for some reason, set <code>JPEG_INCLUDE_DIR</code> to <code>/path/to/Unvanquished/src/libs/jpeg</code>.
## Check <code>USE_INTERNAL_CRYPTO</code> to avoid having to compile nettle and hogweed yourself.
## Check <code>USE_INTERNAL_SPEEX</code> to avoid having to compile Speex yourself.
## Uncheck <code>USE_CIN_THEORA</code> and <code>USE_CIN_XVID</code> to avoid having to compile Theora or Xvid. (At present, there are not cutscenes or any such that require it.)
## '''You will probably not be able to compile with the GLSL optimizer enabled; uncheck <code>USE_GLSL_OPTIMIZER</code>'''
## If you have selected to generate Xcode project files, make the <code>SDLMAIN_LIBRARY</code> field blank. This option is not available if you have the generator set to Unix makefiles.
# Hit "Generate".
# You may now close CMake.

===Compiling===

====With Xcode====

<ol>
<li>Compilation will fail unless you manually create certain directories needed by the build scripts:
<pre>
$ cd /path/to/build/dir/CMakeFiles
$ mkdir gpp{game,trem,ui}-qvm.dir
</pre>
This is a workaround to {{Issue|101}}.
</li>
<li>Either start Xcode and open the project file (in the build directory you specified) or double-click the project file in Finder.</li>
<li>Open the project file created by CMake, which should be in the build directory you specified.</li>
<li>Change the active target to "ALL_BUILD" and click Product→Build.</li>
</ol>

====With Unix Makefiles====

<ul>
<li>Start Terminal (Applications → Utilities → Terminal).</li>
<li>Input the following commands:
<pre>
$ cd /path/to/Unvanquished-build
$ make
</pre>
If you are on a multi-core or multi-processor machine, you may speed up the process by passing the <code>-j</code> argument followed by the number of available cores to <code>make</code>; e.g., <code>make -j4</code>. Note that doing so makes reading error messages more difficult, as multiple instances of the compiler will print to the screen at once, causing information to appear out of order.
</li>
</ul>

===Testing the build===

====With Xcode 4====

To test the game, select the "client" scheme from the combo box on the toolbar, and click the run button or press {{Hotkey|MacCommand}}{{Hotkey|R}}.

====With Unix Makefiles====

After compiling, you'll have to place the data files in the <code>main</code> directory in your build directory. [[#Acquiring the Game Files|For download instructions, see below.]]

Your file structure should look as follows:

[[File:Build_dir_Mac_OS_X.png]]

You may now start the application as such:

$ ./daemon.i386

Note that older machines will not support the new OpenGL 3 renderer, and must be started specifying the "vanilla" (aka "GL") renderer:

$ ./daemon.i386 +set cl_renderer GL

===Bundling the Application===

====With CPack====

CPack is able to create standalone bundles (as well as many other types of installers). However you must generate the files using Unix Makefiles instead of Xcode.

$ cd /path/to/Unvanquished-build
$ cpack -G Bundle

Some warnings will be printed however these can be safely ignored. There should be a file called Unvanquished.dmg in the Unvanquished-build folder.

====Manually====

{{Note|header=Important|content=
Please be aware that these instructions are very much out of date, and may not work. Also note that the dynamic library bundler does '''not''' work as intended and although you will be able to run your build on your machine, it will most likely not work on other machines. It is strongly suggested that you compile the source using Xcode.
}}

You'll find the Mac [http://macdylibbundler.sourceforge.net/ dynamic library bundler] to be quite useful (you must generate the files using Unix Makefiles instead of Xcode):

$ curl -L http://sourceforge.net/projects/macdylibbundler/files/macdylibbundler/0.4.1/dylibbundler0.4.1.zip/download > \
dylibbundler0.4.1.zip
$ unzip dylibbundler0.4.1.zip
$ cd dylibbundler
$ make
$ sudo make install

Once you've done that, you can proceed to create the application bundle. Note that these steps assume that you have downloaded the data files to <code>main/</code> as shown above:

<pre>
$ git=/path/to/Unvanquished-git-repo
$ build=/path/to/Unvanquished-build-dir
$ mkdir -pv Unvanquished.app/Contents/{libs,MacOS,Resources,Frameworks}
$ cp -r $build/main Unvanquished.app/Contents/MacOS
$ sips -s format tiff $git/debian/unvanquished.png --out temp.tiff
$ tiff2icns temp.tiff Unvanquished.app/Contents/Resources/Unvanquished.icns
$ rm temp.tiff
$ cp $build/daemon{,ded}.i386 $build/*.dylib Unvanquished.app/Contents/MacOS
$ cp -r /Library/Frameworks/SDL.framework Unvanquished.app/Contents/Frameworks
$ install_name_tool -id \
@executable_path/../Frameworks/SDL.framework/Versions/A/SDL \
Unvanquished.app/Contents/Frameworks/SDL.framework/Versions/A/SDL
$ install_name_tool -change @rpath/SDL.framework/Versions/A/SDL \
@executable_path/../Frameworks/SDL.framework/Versions/A/SDL \
Unvanquished.app/Contents/MacOS/daemon.i386
$ install_name_tool -change @rpath/SDL.framework/Versions/A/SDL \
@executable_path/../Frameworks/SDL.framework/Versions/A/SDL \
Unvanquished.app/Contents/MacOS/librendererGLi386.dylib
$ install_name_tool -change @rpath/SDL.framework/Versions/A/SDL \
@executable_path/../Frameworks/SDL.framework/Versions/A/SDL \
Unvanquished.app/Contents/MacOS/librendererGL3i386.dylib
$ for binary in Unvanquished.app/Contents/MacOS/*.{i386,dylib}; do
dylibbundler -b -x $binary -d $dest/Unvanquished.app/Contents/libs/; done
$ cp /usr/lib/libGLEW.1.7.0.dylib ./Unvanquished.app/Contents/libs/libGLEW.1.7.0.dylib
$ chmod +w ./Unvanquished.app/Contents/libs/libGLEW.1.7.0.dylib
$ install_name_tool -id @executable_path/../libs/libGLEW.1.7.0.dylib \
./Unvanquished.app/Contents/libs/libGLEW.1.7.0.dylib
$ install_name_tool -change /usr/lib/libGLEW.1.7.0.dylib \
@executable_path/../libs/libGLEW.1.7.0.dylib \
./Unvanquished.app/Contents/MacOS/daemon.i386
$ cat > Unvanquished.app/Contents/Info.plist
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN"
"http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>CFBundleName</key>
<string>Unvanquished</string>
<key>CFBundleDisplayName</key>
<string>Unvanquished</string>
<key>CFBundleExecutable</key>
<string>daemon.i386</string>
<key>CFBundleIconFile</key>
<string>Unvanquished.icns</string>
<key>CFBundleIdentifier</key>
<string>net.Unvanquished</string>
<key>CFBundleInfoDictionaryVersion</key>
<string>6.0</string>
<key>CFBundlePackageType</key>
<string>APPL</string>
<key>CFBundleShortVersionString</key>
<string>0.4.0</string>
<key>CFBundleVersion</key>
<string>0.4.0</string>
</dict>
</plist>
^d
</pre>

Note: <code>^d</code> indicates pressing {{Hotkey|Ctrl}}{{Hotkey|D}} on the keyboard.

The contents of the completed application bundle should look like this:

[[File:Bundle_dir_Mac_OS_X.png]]

'''Note''': If you compiled SDL from source, you will not see a directory titled <code>SDL.framework</code>.

==Windows==

===Visual Studio===

CMake can generate Visual Studio projects for Unvanquished.

# Run the <code>Visual_Studio32.bat</code> batch script in your source directory by double-clicking it. Alternatively, you may use the <code>Visual_Studio64.bat</code> shell script if you have the [http://www.microsoft.com/en-us/download/details.aspx?id=8279 Windows 7 SDK] installed and a 64-bit system.
# Open <code>build-32/Daemon.sln</code> in Visual Studio 2010.
# In the two text boxes in the toolbar, select "Release" or "Debug" in the first one and Win32 in the second one
# Press {{Hotkey|F5}} to build solution and run application, or just use Build → Build Solution to compile the code.

====Important Notes====

* LLVM is disabled and does not work correctly with CMake generated Visual Studio projects.
* ncurses is not supported under Visual Studio.
* The path to the build folder must not have any spaces otherwise generation of QVMs will fail. See {{Issue|102}}.
* Due to limitations with CMake, neither the startup project nor the working directory can be specified. These must be set manually to debug the client with Visual Studio:
** Right click on client and select "Set as StartUp project".
** Right click on client, select properties, select Debugging and set "Working Directory" to <code>$(TargetPath)\..</code>.

====Troubleshooting====

If installing the Windows 7 SDK [http://support.microsoft.com/kb/2717426?ppud=4&wa=wsignin1.0 fails with error code 5100] (when the installation fails, click "View Log", and search for "5100"), remove any installed copies of the Microsoft Visual C++ 2010 x86 Redistributable and Microsoft Visual C++ 2010 x64 Redistributable via the control panel (Control Panel → Programs and Features), then run the installer again.

===MinGW===

It is possible to build Unvanquished with MinGW, although the process is rather arduous compared to Visual Studio or compiling for other platforms. Currently, you will also need [http://cygwin.com/setup.exe Cygwin] to build the GMP library as well.

====Notes====

* The easiest way to acquire and install MinGW is with the graphical [http://sourceforge.net/projects/mingw/files/Installer/mingw-get-inst/ mingw-get-inst installer]. At a minimum, you will need to install the C and C++ compilers. 
* When configuring the build with CMake, you will find that you will have to set a number of libraries manually. You can find precompiled DLLs for most of the dependencies; those that are not pre-compiled can be built with the corresponding <code>USE_INTERNAL_</code> setting.
* '''The build will fail during QVM compilation if your source or build directories contain spaces.''' This is due to a bug with lcc. If your home directory contains a space, you may want to create source and build directories at the root of one of your drives (e.g., <code>C:\Unvanquished\Source</code> and <code>C:\Unvanquished\Build</code>.)

====Instructions====

The easiest way to get a build up (at the time of writing) is as follows:

{{Note|content=Although there are 64-bit binaries of most of the libraries required to build the game, these do not work with MinGW at present, so the following instructions all use the 32-bit binaries.}}

<ol>
<li>You will need to download and install some version of the DirectX SDK to compile the source. You may download the June 2010 release from [http://www.microsoft.com/en-us/download/details.aspx?id=6812 Microsoft].</li>
<li>Although there are binaries of gmp distributed with the source, they have are dependent on Visual Studio's implementations of <code>_ftol2_sse</code> and <code>_alloca_probe_16</code>. A fix may be found on [http://stackoverflow.com/questions/6753111/static-linking-with-openssl Stack Exchange], but requires that Visual Studio be installed, which defeats the purpose of attempting to use MinGW to compile the source. You can build gmp yourself:
<ol>
<li>Download and extract the latest version of the [http://gmplib.org/ GNU MP Bignum Library (GMP)]. (You will need either cygwin with tar and bz2 installed or 7-zip to extract the archive.)</li>
<li>Install the following Cygwin packages if you have not already:
* binutils
* gcc
* gcc-g++
* m4
* make
</li>
<li>As part of the GMP compilation process, a file called <code>gen-fib.c</code> generates a table of numbers in the Fibonacci sequence. The generated file does not play nicely with Cygwin or MinGW, so you must fix it. Edit <code>gen-fib.c</code>, and at around line 100, change these lines
<pre>
for (i = 0; i < fnum; i++)
{
printf (" CNST_LIMB (0x");
mpz_out_str (stdout, 16, f[i]);
printf ("), /* %d */\n", i-1);
}
printf ("};\n");
</pre>
to look like this:
<pre>
for (i = 0; i < fnum; i++)
{
printf (" CNST_LIMB (0x");
mpz_out_str (stdout, 16, f[i]);
printf (")%c /* %d */\n", (i == (fnum-1)) ? ' ' : ',', i-1);
}
printf ("};\n");
</pre>
The patch file looks like this:
<pre>
@@ -100,7 +100,7 @@
{
printf (" CNST_LIMB (0x");
mpz_out_str (stdout, 16, f[i]);
- printf ("), /* %d */\n", i-1);
+ printf (")%c /* %d */\n", (i == (fnum-1)) ? ' ' : ',', i-1);
}
printf ("};\n");
}
</pre>
</li>
<li>Compiling with MinGW does not work, so you will need to compile with Cygwin. At the prompt:
<pre>
$ ./configure --disable-static --enable-shared
$ make
</pre>
The <code>--disable-static</code> and <code>--enable-shared</code> flags configure GMP to build a DLL instead of a static library. You may optionally perform <code>make install</code>. Additional compilation instructions [http://www.cs.nyu.edu/exact/core/gmp/ are available].
If you experience difficulties with compilation and it appears that MinGW gcc is being detected by <code>configure</code> and not Cygwin gcc, you can try editing your <code>PATH</code> variable:
<pre>
$ export PATH=`echo $PATH | sed "s|/cygdrive/c/MinGW/bin:||"`
</pre>
Re-run <code>configure</code> and <code>make</code> afterwards.
</ol>
</li>
<li>Download the [http://www.libsdl.org/release/SDL-1.2.15-win32.zip latest stable version] of SDL for Windows. Extract the archive and copy <code>SDL.dll</code> from it to the root of your build directory.</li>
<li>Set the following CMake flags:
{| class="wikitable"
! Setting
! Description
! Type
! Value
|-
| <code>USE_INTERNAL_CRYPTO</code>
| Use the provided copies of crypto libraries. 
| <code>BOOL</code>
| <code>true</code>
|-
| <code>USE_INTERNAL_GLEW</code>
| Use the provided copy of GLEW.
| <code>BOOL</code>
| <code>true</code>
|-
| <code>USE_INTERNAL_JPEG</code>
| Use the provided copy of JPEG.
| <code>BOOL</code>
| <code>true</code>
|-
| <code>USE_INTERNAL_SDL</code>
| Use the provided copy of SDL.
| <code>BOOL</code>
| <code>true</code>
|-
| <code>USE_INTERNAL_SPEEX</code>
| Use the provided copy of Speex.
| <code>BOOL</code>
| <code>true</code>
|-
| <code>USE_INTERNAL_WEBP</code>
| Use the provided copy of WebP.
| <code>BOOL</code>
| <code>true</code>
|-
| <code>USE_CURSES</code>
| Enables/disables curses.
| <code>BOOL</code>
| <code>false</code>
|-
| <code>PNG_LIBRARY</code>
| Path to the PNG library DLL.
| <code>FILEPATH</code>
| <code><var>SourcePath</var>/src/libs/libpng/libs/win32/libpng.lib</code>
|-
| <code>PNG_PNG_INCLUDE_DIR</code>
| Path to the PNG library header files.
| <code>PATH</code>
| <code><var>SourcePath</var>/src/libs/libpng</code>
|-
| <code>FREETYPE_LIBRARY</code>
| Path to the compiled FreeType library.
| <code>FILEPATH</code>
| <code><var>SourcePath</var>/src/libs/freetype/lib/freetype.lib</code>
|-
| <code>FREETYPE_INCLUDE_DIR_freetype2</code>
| Path to the FreeType library header files.
| <code>PATH</code>
| <code><var>SourcePath</var>/src/libs/freetype/include/freetype2</code>
|-
| <code>FREETYPE_INCLUDE_DIR_ft2build</code>
| Path to the FreeType library file "ftbuild.h".
| <code>FILEPATH</code>
| <code><var>SourcePath</var>/src/libs/freetype/include/</code>
|-
| <code>GMP_INCLUDE_DIR</code>
| Path to the GMP library header files.
| <code>PATH</code>
| <code><var>SourcePath</var>/src/libs/gmp/include</code>
|-
| <code>GMP_LIBRARY</code>
| Path to the GMP library.
| <code>FILEPATH</code>
| <code><var>path/to/compiled/gmp/</var>.libs/cyggmp-10.dll</code>
|-
| <code>ZLIB_INCLUDE_DIR</code>
| Path to the zlib library header files.
| <code>PATH</code>
| <code><var>SourcePath</var>/src/libs/zlibwapi/include</code>
|-
| <code>ZLIB_LIBRARY</code>
| Path to the zlib library.
| <code>FILEPATH</code>
| <code><var>SourcePath</var>/src/libs/zlibwapi/lib/x32/zlib1.dll</code>
|-
| <code>CURL_LIBRARY</code>
| Path to the CURL library.
| <code>FILEPATH</code>
| <code><var>SourcePath</var>/src/libs/curl-7.21.6/lib/win32/release/libcurl.dll</code>
|-
| <code>CURL_INCLUDE_DIR</code>
| Path to the zlib library.
| <code>PATH</code>
| <code><var>SourcePath</var>/src/libs/curl-7.21.6/include/curl</code>
|-
| <code>USE_OPENAL</code>
| Enables/disables OpenAL support.
| <code>BOOL</code>
| <code>false</code>
|-
| <code>USE_CIN_THEORA</code>
| Enables/disables Theora support.
| <code>BOOL</code>
| <code>false</code>
|-
| <code>USE_CIN_XVID</code>
| Enables/disables Xvid support.
| <code>BOOL</code>
| <code>false</code>
|-
| <code>USE_CODEC_THEORA</code>
| Enables/disables Ogg support.
| <code>BOOL</code>
| <code>false</code>
|-
| <code>SDL_LIBRARY</code>
| The path to the SDL DLL.
| <code>FILEPATH</code>
| <code><var>BuildPath</var>/SDL.dll</code>
|-
| <code>SDLMAIN_LIBRARY</code>
| Enables/disables Ogg support.
| <code>FILEPATH</code>
| <code><var>SourcePath</var>/src/libs/libsdl/src/main/win32/SDL_win32_main.c</code>
|-
|}
Do note that CMake is slash-direction–agnostic; it can handle both forward- and backslashes on Windows.
If you would like to compile a debug build, change <code>CMAKE_RELEASE_TYPE</code> from <code>Release</code> to <code>Debug</code>.
</li>
<li>Open <code><var>SourcePath</var>/CMakeLists.txt</code> and edit the line
<pre>
set( OS_LIBRARIES m winmm ws2_32 psapi z )
</pre>
(around line 1040) to look like this:
<pre>
set( OS_LIBRARIES m winmm ws2_32 psapi )
</pre>
Also edit around line 1700:
<pre>
###########################
#Configure Download Script#
###########################

if( NOT MSVC )
</pre>
to look like this:
<pre>
###########################
#Configure Download Script#
###########################

if( NOT WIN32 )
</pre>
</li>
<li>Open <code><var>SourcePath</var>/src/libs/libsdl/src/main/win32/SDL_win32_main.c</code> and edit the lines:
<pre>
/* Include the SDL main definition header */
#include "SDL.h"
#include "SDL_main.h"
</pre>
to look like:
<pre>
/* Include the SDL main definition header */
#include "../../../include/SDL.h"
#include "../../../include/SDL_main.h"
</pre>
<li>Open a command prompt and <code>cd</code> to your source directory.</li>
<li>Run <code>make</code>:
<pre>
> mingw32-make
</pre>
If you would like verbose output, set the <code>VERBOSE</code> environment variable before running <code>make</code>.
<pre>
> set VERBOSE=1
</pre>
To make it easier to build the source, you can create a batch file (call it something like <code>compile.bat</code>) and place it in your build directory:
<pre>
@echo off

set RETURN=compile

:get_time
:: Thank you, Rob van der Woude:
:: (http://www.robvanderwoude.com/datetimentparse.php)
FOR /F "tokens=1,2,3 delims=:." %%A IN ("%Time%") DO (
SET /A HOURS = 100%%A %% 100
SET /A MINUTES = 100%%B %% 100
SET /A SECONDS = 100%%C %% 100
)
SET /A TICKS=( %HOURS% * 3600 ) + ( %MINUTES% * 60 ) + %SECONDS%
GOTO %RETURN%

:compile
SET START_TICKS=%TICKS%

SET VERBOSE=1
:: mingw32-make clean
mingw32-make -j4

set RETURN=finish
GOTO get_time

:finish
SET /A COMPILE_TIME=%TICKS% - %START_TICKS%
SET /A MINUTES=%COMPILE_TIME% / 60
SET /A SECONDS=%COMPILE_TIME% %% 60
ECHO.
ECHO Compilation took %MINUTES%m %SECONDS%s.
PAUSE
</pre>
</li>
<li>Once compilation finishes, you will find that the game will fail to run due to DLL dependencies. To resolve these:
<ul>
<li>You will need to move <code>INTERNAL_GLEW</code> from the <code>Release/</code> folder of the build directory to the root of the build directory.</li>
<li>You will need to place the following other DLLs in your build directory:
* freetype6.dll
* libcurl.dll
* libpng14-14.dll
* zlib1.dll
If the renderer's DLL dependencies are not met, you will be informed that the game failed to load a renderer. If you receive an error stating that the application failed to start at all, then you are likely missing some version of the Microsoft Visual C runtime redistributable.
You may find that you also need these DLLs (if you configured your build differently):
* libbz2.dll
* libogg.dll
* libtheora.dll
* libvorbis.dll
* libvorbisfile.dll
* msvcr100.dll
* msvcr100d.dll
* zlibwapi.dll
The easiest way to obtain these DLLs is by copying them from the installation directory of an [http://sourceforge.net/projects/unvanquished/files/latest/download official release] of Unvanquished.
</li>
<li>You will need to copy your compiled DLL of GMP to your build directory. It may be found in <code><var>path/to/compiled/gmp/</var>.libs/cyggmp-10.dll</code>.</li>
<li>As you compiled GMP with Cygwin, it in turn depends on <code>cygwin1.dll</code>, which may typically be found in <code>C:\cygwin\bin\</code>. Copy and paste it into your build directory.</li>
</ul>
Once you have completed these steps, you should never have to do them again.
</li>
</ol>

====Notes====

* If you would like to use curses, try using [http://sourceforge.net/projects/pdcurses/files/pdcurses PDCurses].

===QtCreator===

# Install MinGW and follow the above instructions, except select Code::Blocks as the generator.
# Start QtCreator, and select "Open File or Project…" from the File menu.
# Navigate to your source directory and open CMakeLists.txt.
# At the CMake Wizard, select the same build directory you already configured using CMake. (If you did not chose Code::Blocks as the generator, you will have to start over again, as QtCreator requires a Code::Blocks project file in order to compile the source.)
# Ensure that a generator is selected in the combo box, and click "Run CMake". If there is no generator listed, see the [[#Troubleshooting|troubleshooting]] section below.
# Click "Finish" to close the wizard.

You should now be able to compile, run, and debug the code using QtCreator.

====Troubleshooting====

If at the "Run CMake" prompt of the the CMake Wizard, select "Run CMake" and are warned that no generator was selected, and notice that there are no generators in the combo box, you will likely have to [http://doc.qt.digia.com/qtcreator-2.4/creator-tool-chains.html manually configure your toolchain]. Select "Options…" from the "Tools" menu, then navigate to "Build & Run".

At the options window,
* Go to the "Kits" tab, and mouse over the "Desktop (default)" kit under "Manual". If there were any errors in configuring this kit, they will be displayed in the tool tip. If there are problems, select the kit. You may need to manually specify the location of the MinGW debugger, for example, which is typically <code>C:\MinGW\bin\gdb.exe</code>.
* Go to the "Compilers" tab, and ensure that MinGW is present. If not, you will need to add it manually.

==Linux==

===Dependencies===


====Debian/Ubuntu====

$ sudo apt-get install g++ gcc cmake libcurl4-gnutls-dev libfreetype6-dev \
libglew-dev libgmp-dev nettle-dev zlib1g-dev libncursesw5-dev \
libsdl2-dev libopenal-dev libjpeg8-dev libpng12-dev libwebp-dev \
libogg-dev libvorbis-dev libspeexdsp-dev libtheora-dev libopusfile-dev \
libxvidcore-dev

If libsdl2-dev isn't available, you can use libsdl1.2-dev instead.

If the version of WebP supplied by your version of Debian or Ubuntu is older than v0.2.0, you will need to [https://code.google.com/p/webp/downloads/detail?name=libwebp-0.2.0.tar.gz download] and [https://developers.google.com/speed/webp/docs/compiling#unix compile it from source]. After compiling and installing with <code>sudo make install</code>, in CMake, you'll need to set <code>WEBP_INCLUDE_DIR</code> to <code>/usr/local/include/webp</code> and <code>WEBP_LIBRARY</code> to <code>/usr/local/lib/libwebp.so</code>.

'''We currently provide ready-to-use libwebp-dev, libogg-dev libopusfile-dev where needed in our [http://{{SERVERNAME}}/index.php/Download#ubuntu Debian and Ubuntu repositories], alongside .debs of the game and server.'''

Actual dev package names may vary, e.g. libgmp3-dev instead of libgmp-dev and libglew1.7-dev instead of libglew-dev.

Since we have a debian directory in the source, you can also to check what's needed then install the listed packages (choosing from alternatives as needed):

$ cd <var>/path/to/unvanquished</var>
$ dpkg-checkbuilddeps
…
$ sudo apt-get install <var>package(s)</var>

If dpkg-checkbuilddeps produces no output, you have all necessary build dependencies. Also, debhelper's only needed if you're building .debs.

====Gentoo====

$ emerge curl freetype glew gmp jpeg ncurses libogg openal libpng libsdl libvorbis zlib

====openSUSE====

$ sudo install zypper gcc gcc-c++ Mesa-libGL-devel SDL-devel libjpeg8-devel \
libpng12-devel glew-devel webp-devel ncurses-devel gmp-devel libcurl-devel \
libnettle-devel openal-soft-devel speex-devel libvorbis-devel \
libtheora-devel

The latest version of WebP must be installed manually:

$ wget https://webp.googlecode.com/files/libwebp-0.2.1.tar.gz
$ tar xvzf libwebp-0.2.1.tar.gz
$ cd libwebp-0.2.1
$ ./configure && make
$ sudo make install

You must disable curses (set <code>USE_CURSES</code> appropriately in CMake) as failing to do so will cause Unvanquished to crash on startup.

===Configuring the code with CMake===

After you have [[Getting the source|acquired the source code]], you can proceed to compile. Unvanquished uses CMake, so you must have that installed.

====Using ccmake (curses-based front-end)====

On Debian or Ubuntu:

$ sudo apt-get install cmake-curses-gui

On Gentoo you should set the '''ncurses''' USE flag either globally or individually, just for cmake.
To add the USE flag globally, edit the USE array in /etc/make.conf for it to include '''ncurses'''.
To only install cmake with ncurses functionality, you could do the following:

$ echo 'dev-util/cmake ncurses' >> /etc/portage/package.use && emerge cmake

Note that in Ubuntu, <code>cmake-curses-gui</code> is in Universe, which you may have to enable with <code>software-properties-gtk</code>. Make sure to reload the software sources with <code>sudo apt-get update</code> afterwards.

Next, configure the codebase.

$ cd <var>/path/to/unvanquished</var>
$ mkdir build
$ cd build
$ ccmake ..

Or, in Debian or Ubuntu, you can build a package (but you'll need to have devscripts and fakeroot installed):

$ cd <var>/path/to/unvanquished</var>
$ fakeroot dpkg-buildpackage -b -uc
$ sudo dpkg -i <var>../unvanquished_*.deb</var>

Once in <code>ccmake</code>, use the following keys:

* Press {{Hotkey|c}} to configure. If an error occurs during this phase, make note of it and press {{Hotkey|e}} to dismiss it.
* Use the up and down arrow keys to navigate the compilation options.
* Press {{Hotkey|Enter}} to enable or disable boolean options (i.e., on/off) or to edit textual options.
** Press {{Hotkey|Esc}} when editing a textual option to cancel the change.

Once you have finished the configuration process, press {{Hotkey|C}} again, then {{Hotkey|G}} to generate the makefile.

====Using cmake-qt-gui (graphical front-end)====

This graphical front end for cmake has its own package you must install:

=====Debian/Ubuntu=====

$ sudo apt-get install cmake-qt-gui

=====Gentoo=====

With the '''qt4''' USE flag enabled:

$ emerge cmake

Once installed, run with <code>cmake-gui</code>.

[[Image:Cmake-qt-gui.png|thumb]]

# Set the path where you have the source code downloaded.
# Set the path where you would like to build the engine. This may be the same directory if you wish.
# Click 'Configure'.
# Click 'Generate'.

====Unnecessary libraries====

Regardless of which front-end to cmake you use, you may want to disable some libraries that are not strictly necessary:

* <code>USE_OPENAL</code> — If this is disabled, SDL is used instead for sound.
* <code>USE_CODEC_VORBIS</code> — Disabling this will cause certain sound effects (those using the <code>.ogg</code> format) not to play. At present, this has only a minor impact on gameplay, but more and more sounds will likely use the format in the future.
* <code>USE_CURSES</code> — Disabling this will cause the external (not in-game) console to not use curses; it will not be scrollable and will be similar to the console in the original Tremulous. This does in no way affect gameplay.
* <code>USE_CIN_THEORA</code> — Disabling this prevents videos from being recorded in Theora.
* <code>USE_CIN_XVID</code> — Disabling this prevents videos from being recorded in Xvid.
* <code>USE_VOIP</code> — Disabling this removes VOIP support. Alternatively enabling <code>USE_INTERNAL_SPEEX</code> will use the libraries distributed with Unvanquished for VoIP
* <code>USE_INTERNAL_CRYPTO</code> — Enable this to use the crypto libraries provided by Unvanquished.

===Compiling===

$ cd <var>path/to/unvanquished/build</var>
$ make -j4

The <code>-j</code> switch to make allows you to speed up the compilation process by running it in multiple threads; set the number following this to the number of cores your processor(s) have.

==Acquiring the Game Files==

===Acquiring mandatory game files===

The game files are not in the Git repository, and must be downloaded separately. This may be done on the command line or from your web browser. The downloads may be found on [http://sourceforge.net/projects/unvanquished/files/Assets SourceForge.net]. If you download the files from your browser, just download the files named "pak*.pk3", and save them to the [[Running_the_game#Data_locations|data location]] for your system.

On Linux, this may be done as follows:

$ cd <var>[path to Unvanquished installation or build]</var>/main
$ for file in {{CurrentVersion|PakFiles}}; do
if [ ! -e $file ]; then
wget -O $file "http://sourceforge.net/projects/unvanquished/files/Assets/$file/download"
fi
done

On FreeBSD, using the <code>sh</code> shell:

$ cd <var>[path to Unvanquished installation or build]</var>/main
$ for file in {{CurrentVersion|PakFiles}}; do
if [ ! -e $file ]; then
fetch -r -o $file "http://sourceforge.net/projects/unvanquished/files/Assets/$file/download"
fi
done

On Mac OS X:

$ cd ~/Library/Application\ Support/Unvanquished/main
$ for file in {{CurrentVersion|PakFiles}}; do
if [ ! -e $file ]; then
curl -L "http://sourceforge.net/projects/unvanquished/files/Assets/$file/download" > $file
fi
done

Linux users may also use the <code>download-pk3.sh</code> script that is distributed with the source code, which requires that curl be installed:

$ cd <var>[path to Unvanquished source code]</var>
$ mkdir -p ~/.Unvanquished/main
$ ./download-pk3.sh ~/.Unvanquished/main

===Downloading the map pack===

The map pack exists only for convenience; if you do not download the map pack, Unvanquished will automatically download maps as needed when you attempt to play online.

To download the map pack on Linux:

$ wget -O maps.7z "http://sourceforge.net/projects/unvanquished/files/Map%20Pack/maps.7z"; done

To download the map pack on Mac OS X:

$ curl -L "http://sourceforge.net/projects/unvanquished/files/Map%20Pack/maps.7z" > maps.7z; done

Note that you will need to unzip the map pack on either system as it is compressed with LZMA. Mac users can use the [http://wakaba.c3.cx/s/apps/unarchiver.html Unarchiver]. Uncompressing the archive on Linux is highly dependent on your distribution.

===Verifying the Files===

Download the latest [http://sourceforge.net/projects/unvanquished/files/Assets/{{CurrentVersion|MD5HashFile}} MD5 hash file] and save it to your system's [[Running_the_game#Data_directory|data location]].

On systems with the <code>md5</code> command (Mac OS X):

$ cd ~/Library/Application\ Support/Unvanquished/main
$ cat {{CurrentVersion|MD5HashFile}} | while read line; do
file="`echo "$line" | sed -E "s/^[a-fA-F0-9]+ +\*?//"`"
if [ -e "$file" ]; then
if [ `md5 -r "$file" | cut -d\ -f1` = "`echo "$line" | cut -d\ -f1`" ]
then echo "File \"$file\" appears okay."
else echo "File \"$file\" is corrupt"'!' >&2
fi; fi; done

On systems with the <code>md5sum</code> command (most Linux distributions):

$ cd <var>[[Running_the_game#Data_directory|/path/to/data/files]]</var>
$ md5sum -c {{CurrentVersion|MD5HashFile}} 2>&1 | grep -v "open or read\|file or directory"

The <code>grep</code> invocation is used to strip output complaining about missing files.

Any files that are found to be corrupt should be replaced; just download a [http://sourceforge.net/projects/unvanquished/files/Assets new copy] of the affected file(s).

==Errors==

===CMake cannot locate Newton===

If CMake cannot find Newton, you'll need to set it up yourself.

It should be in <code><var>/path/to/Unvanquished</var>/src/libs/libnewton/libs/<var>your_os</var>/libNewton.so</code>.
Be sure to replace <var>your_os</var> with the proper directory name.

Use CMake as before to change the <code>NEWTON_LIBRARY</code> build setting to the said path:

# Start the CMake configurator:<pre>$ ccmake ..</pre>
# Scroll down and highlight <code>NEWTON_LIBRARY</code>.
# Press {{Hotkey|Enter}} to begin editing and input in the path.
# Press {{Hotkey|C}} to configure and {{Hotkey|G}} to generate the new makefiles.
# Press {{Hotkey|Q}} to quit.
# Recompile the source:<pre>$ make</pre>

===The C Compiler is not able to compile a simple test program===

When attempting to generate a solution for Xcode CMake fails with the following error
-- Check for working C compiler using: Xcode -- broken
CMake Error at /Applications/CMake 2.8-8.app/Contents/share/cmake-2.8/Modules/CMakeTestCCompiler.cmake:52 (MESSAGE):
The C compiler "/usr/bin/gcc" is not able to compile a simple test program.

It fails with the following output:

Change Dir: /Users/danielmaloney/Documents/Unvanquished/build-xcode/CMakeFiles/CMakeTmp

Run Build Command:/Applications/CMake\ 2.8-8.app/Contents/bin/cmakexbuild
-project CMAKE_TRY_COMPILE.xcodeproj build -target
cmTryCompileExec1400153232 -configuration Debug

Error: No developer directory found at /Developer. Run
/usr/bin/xcode-select to update the developer directory path.

CMake will not be able to correctly generate this project.
Call Stack (most recent call first):
CMakeLists.txt:19 (project)

This is due to Xcode 4.3 having a different directory structure to previous versions. Simply running the following command will correct this error:
sudo /usr/bin/xcode-select -switch /Applications/Xcode.app/Contents/Developer/

Template:SupportedModelFormats

2013-10-11T21:28:11Z

Anomalous:

The Daemon engine currently only supports the following:
{| class="wikitable"
|-
! rowspan="2" | Format
! colspan="2" | Introduced in
! rowspan="2" | Supported techniques
! rowspan="2" | Exporter availability
|-
! Title
! Year
|-
| MD3
| Quake 3
| 1999
| Per-frame vertex animation
|
* Milkshape 3d
* Blender 2.4 or newer
|-
| [http://udn.epicgames.com/Two/BinaryFormatSpecifications.html PSK]
| Unreal Tournament 2003 (Unreal Engine 2)1
| 2002
| Bones with vertex weights
|
* Maya2
* 3ds Max2
* SoftImage
|-
| MDC
| Wolfenstein: Enemy Territory
| 2003
| Unsure
| Unsure
|-
| MD5
| Doom 3
| 2004
| Bones with vertex weights
|
* Maya
* 3ds Max
* Blender 2.4 or newer
|-
|}
# Actually, America's Army 1.0 was the first title to be released using this format, as it used Unreal Engine 2 as well; it was released in June of that year, and Unreal Tournament 2003 in October.
# With the [http://udn.epicgames.com/Two/ActorX.html ActorX plugin].
# With a plugin provided by [http://udn.epicgames.com/Two/ActorX.html#XSI%20Exporter%20Plugins SoftImage].

However, we recommend that you use the MD5 format at this time.

Support for the IQM format has been planned, but it is unlikely that it will be added any time in the future.

Note that mappers may use other formats for static models, such as the ASE ('''A'''SCII '''S'''cene '''E'''xport, not to be confused with Adobe's .ase format) and Wavefront Obj formats. A complete listing is available on the [[Mapping#Models|mapping]] page.

Tutorials/Exporting models

2013-10-11T21:24:36Z

Anomalous: /* MD5 */

[[Category:Modeling]]
==Overview==

''Notice: This guide was written for the 2.6 series of Blender. Most of this guide should apply for other versions of Blender, but this is not guaranteed.''

Getting a finished model out of Blender and into the game is a relatively involved process with a number of possible pitfalls. This guide aims to describe the process in as much detail as possible to assist users who have not done it before, or those who have exported models for other games and would like to know what (if anything) is different.

If you would like to export from Maya, you may find the official [http://www.iddevnet.com/quake4/Animations id Software documentation] useful.

At present, this guide primarily describes the process for exporting models to the MD5 format. While the engine supports both MD3 and MD5, the latter is preferred. The reasons for this are discussed [[#What_is_MD5?|below]].

Before a model may be exported and used in-game, it must be adequately prepared: 

* [[#Limitations_of_the_engine|Engine limitations]] must be adhered to.
* The model must have a texture applied to it. This texture is not automagically applied to the model after it is exported and loaded in-game, this is only necessary to satisfy the MD5 exporter; that is, the game cannot read from the exported model the filename of the texture to use.
* The model must be a mesh and must have an armature modifier applied to it.
* The armature's bones all must have at least one keyframe.

The actual process of exporting a model is straightforward:

# After ensuring that the above requirements are met, the mesh itself is exported.
# If using the old exporter, each animation is exported separately. The new exporter adds support for [[#Batch_export_with_the_new_exporter|batch export]] of animations.
# A [[#Configuring_the_model|configuration file]] specifying data such as the bounding box size and vertical offset is written. This may include information that is specific to the particular type of model (i.e., buildable or player model).
# A [[#Writing_shaders|shader]] is written that determines how the model is textured in-game.
# Finally, after everything is properly named and configured, the files are [[Packaging_game_data|packaged]] and placed in the correct game data folder to allow it to be loaded in-game.

==What is MD5?==

MD5 is the model format created by id Software for Doom 3 which is also used by Unvanquished. It is an improvement over its predecessor, MD3, in that it uses bones to pose the model.

{{Note|header=What about MD3? IQM? PSK? ASE? Obj?|content=
{{SupportedModelFormats}}
}}

===Advantages over MD3===

* Unlike MD3, MD5 is bone-based, meaning that instead of storing an entire mesh for each frame of animation, there is only one mesh file. This single mesh file is deformed using a vertex shader.
* Because there is only one mesh, only one VBO (vertex buffer object) needs to be created for each MD5 model. The deformation is performed entirely on the GPU, so it is (theoretically) faster than MD3, and uses less memory.
* Because the format is in plain-text, it can be easily verified for sanity (i.e., to ensure that it was exported correctly and not corrupted in some way).

===Disadvantages over MD3===

* Some forms of motion are more difficult to achieve; certain animation techniques (such as lattices) are not usable.
* Because the format is in plain-text, it takes up more space than it needs to, though this is negligible and a MD5 model will typically be smaller than the same model in MD3 format as less data is used per each frame of animation with MD5 as compared to MD3.

===Limitations of the engine===

The engine places certain limitations on the fidelity of your models when using the MD5 format. These are:

* There may not be more than 128 bones. (Note: this was increased from 64.)
* There may not be more than 100,000 vertices.
* There may not be more than 10,000 triangles.
* No vertex may belong to more than four vertex groups (i.e., one vertex may not be controlled by more than four bones). An error message will be displayed in-game if this requirement is not met. A [[#.22R_LoadMD5:_vertex_.25i_requires_more_than_.25i_weights_on_surface_.28.25i.29_in_model_.27.25s.27.22|script]] may be used before exporting to check that this limitation is not exceeded.

{{Note|header=Developer Note|content=The limitation on vertex groups is a hard-coded limitation of the vertex shader ({{SourceFile|main/glsl/vertexSkinning_vp.glsl}}) that deforms the base mesh.}}

===Limitations of the format===

The MD5 format only supports bones. You may not

* Use lattices or any other means of deformation.
* Scale bones.
* Use keyframes on anything other than bone poses. You may, however, set keyframes on bone constraint influences or anything else that would affect a bone's position or rotation.

Note that you do not have to have a parent/child relationship between bones. In fact, in some instances, avoiding a parent/child relationship is necessary to achieve certain effects, such as moving bones around.

==Acquiring and installing the exporter==

===MD3===

If for some reason you are interested in the MD3 exporter, it is available from [http://sourceforge.net/projects/md3exporter/ SourceForge].

===MD5===

====Old exporter====

''Please be aware that there are numerous issues with the old exporter and the newer versions of Blender. See [[#All_or_part_of_the_mesh_appears_to_be_sucked_to_the_center|the troubleshooting section]] below for more information. It is strongly recommended that you use the [[#New_exporter|new exporter]] instead.''

You can download the exporter from [http://www.katsbits.com/smforum/index.php?topic=178.0 this thread on katsbits.com]. Installation instructions are in the thread.

====New exporter====

As of 15 May 2012, there is another [http://sourceforge.net/projects/blenderbitsbobs/ MD5 exporter available for Blender 2.63+] ([http://www.katsbits.com/smforum/index.php?topic=404.0 discussion on katsbits]). This has been found to be superior to the old exporter. Note that portions of this guide have not yet been updated to reflect the differences in the new exporter.

We have [http://sourceforge.net/u/dsalt/blenderbitsbobs/ a patched version] which allows each mesh objects to have a custom property, <var>q3tex</var>, which contains the name of a shader. This is output in the ‘shader’ line for that mesh in the md5mesh file.

==Exporting the mesh==

===MD5===

Note that for buildables and weapons, the filename of the exported mesh is dictated by the corresponding [[#Configuring_the_model|configuration file]]. All player models, however, are hardcoded to look for <code>body.md5mesh</code>.

====Old exporter====

''Please be aware that there are numerous issues with the old exporter and the newer versions of Blender. See [[#All_or_part_of_the_mesh_appears_to_be_sucked_to_the_center|the troubleshooting section]] below for more information. It is strongly recommended that you use the [[#New_exporter|new exporter]] instead.''

# Select the armature and the mesh. The order in which you select the two does not matter.
# Click File → Export → Quake Model 5 (.md5)
# On the left shelf that appears in the file prompt, change the Exports combo box to "Mesh only." Don't worry about the scale or name fields.
# Click "Export MD5".

Once this has been completed, you must manually edit the mesh file (the one with a <code>.md5mesh</code> extension) to specify the correct shader to use.

<pre>
--- snip ---
mesh {
shader "models/buildables/medistat"

numverts 4
vert 0 ( 1.000000 0.000000 ) 0 1
vert 1 ( 0.000000 0.000000 ) 1 1
--- snip ---
</pre>

Note that <code>models/buildables/medistat</code> is '''not''' a file path to a shader; it is the name (again, not filename) of the shader to use. That is, a shader with the matching name will be used for this model.

To avoid having to do this every time you export the mesh, set the name of the material applied to the object in Blender to the same as you edited the md5mesh.

====New exporter====

* Select the mesh to export.
* Click File → Export → MD5 Mesh (.md5mesh).
* Specify the output filename in the dialog, and click "Export MD5MESH".

The exported model is not ready to be used in-game just yet; it must be manually edited. Open the exported <code>.md5mesh</code> file in a text editor, and manually delete the top three lines of the file (highlighted in red below):

// Parameters used during export:
// Reorient: True
// Scale: 1.0
MD5Version 10
commandline ""

numJoints 4
numMeshes 1

joints {

...

remainder of file omitted for brevity

Be sure to save the file when you are done. You will also have to do this for each animation file that you export.

If you do not want to have to do this each time, you can edit the exporter script. Open the <code>export_md5.py</code> script in the <code>io_scene_md5</code> folder where you installed the script, at around line 30, edit this code:

def record_parameters(correctionMatrix):
return [
"// Parameters used during export:\n",
"// Reorient: {}\n".format(bool(correctionMatrix.to_euler()[2])),
"// Scale: {}\n".format(correctionMatrix.decompose()[2][0])]

to look like this:

def record_parameters(correctionMatrix):
return []

If you are comfortable with applying patches, you may use this:

<pre>
@@ -27,10 +27,7 @@
return pairs

def record_parameters(correctionMatrix):
- return [
- "// Parameters used during export:\n",
- "// Reorient: {}\n".format(bool(correctionMatrix.to_euler()[2])),
- "// Scale: {}\n".format(correctionMatrix.decompose()[2][0])]
+ return []

def define_components(obj, bm, bones, correctionMatrix):
scaleFactor = correctionMatrix.to_scale()[0]
</pre>

Note that you will also have to manually set the shader as with the [[#Old_exporter_2|old exporter]].

==Exporting the animations==

===MD3===

Exported MD3 animations require a configuration file that specifies which frames of the animation correspond to which actions the game will display.

This varies slightly by the type (i.e., weapon or buildable) of model.

===MD5===

====Old exporter====

''Please be aware that there are numerous issues with the old exporter and the newer versions of Blender. See [[#All_or_part_of_the_mesh_appears_to_be_sucked_to_the_center|the troubleshooting section]] below for more information. It is strongly recommended that you use the [[#New_exporter|new exporter]] instead.''

The procedure for exporting animations is the same as for exporting the mesh with regard to selecting the mesh and the armature. Before using the exporter, however, you must be certain to set the start and end frames to encompass only the particular animation that you wish to export; each animation must be exported separately, unless the [[#New_exporter|new exporter]] is used, which adds a [[#Batch_export_with_the_new_exporter|batch export]] feature.

[[Image:Md5_export_timeline.png|frame|center|The timeline view in Blender, which is used to set which frames of animation to export. Here, only one frame of animation (frame 180) is being exported.]]

At the export file prompt, choose "Anim only." from the "Exports" combo box. Enter as the filename the name of the particular animation that you are exporting; the correct names to use are given below.

====Batch export with the new exporter====

The [[Exporting Models#Batch export|new exporter]] now supports batch export of models.

To make use of this feature, you must set [http://wiki.blender.org/index.php/Doc:2.6/Manual/Animation/Markers frame markers] denoting the start and end of each animation. The name of frame markers denoting the start of an animation must end in "_start" and markers denoting the end of an animation must end in "_end"; for example, frame markers denoting the start and end of a buildable's construct animation would be "construct_start" and "construct_end". Avoid using frame markers with duplicate names, as which one will be used by the exporter is not predictable. Note that frame markers may overlap however you please; this is useful when two animations share a frame or you would like to automate the process of exporting the same few frames of animation as several different animation files (e.g., for testing purposes).

All operations in modifying frame markers are performed in the [http://wiki.blender.org/index.php/Doc:2.6/Manual/Animation/Timeline timeline]:
* To create a frame marker, move the timeline to the desired frame and press M.
* To select a frame marker, click with the right mouse button.
* To move a frame marker, select it and press G.
* To delete a frame marker, select it and press X.
* To rename a frame marker, select it and press CtrlM.

The actual exportation process becomes much simpler:

# Click File → Export → MD5 (batch export).
# Specify the filename of the <code>.md5mesh</code> to export.

==Animation names==

The filenames for each exported animation must be what the engine expects for it to be able to load them, and vary depending on the format (MD3 or MD5) and type (e.g., buildable, weapon, or player) of model being exported.

===Weapons===

{{Note|header = Developer Note|disregardby = artists|content =
See the <code>CG_ParseWeaponFile()</code> function in {{SourceFile|src/gamelogic/cgame/cg_weapons.c}}</code>.

Weapon state constants are enumerated in the <code>weaponstate_t</code> enum in {{SourceFile|src/gamelogic/game/bg_public.h}}</code>:

{{{!}} class{{=}}"wikitable"
{{!}}-
! Constant
! Description
{{!}}-
{{!}} <code>WEAPON_READY</code>
{{!}} The weapon at its idle state, ready to fire.
{{!}}-
{{!}} <code>WEAPON_RAISING</code>
{{!}} The weapon as it is being raised. It may not be fired in this state.
{{!}}-
{{!}} <code>WEAPON_DROPPING</code>
{{!}} The weapon as it is being put away. It may not be fired in this state.
{{!}}-
{{!}} <code>WEAPON_FIRING</code>
{{!}} The weapon as it is being fired.
{{!}}-
{{!}} <code>WEAPON_RELOADING</code>
{{!}} The weapon as it is being reloaded.
{{!}}-
{{!}} <code>WEAPON_NEEDS_RESET</code>
{{!}} The Lucifer Cannon in its overcharged state.
{{!}}-
{{!}}}

Control of weapon states is done by <code>PM_Weapon()</code>, <code>PM_BeginWeaponChange()</code>, and <code>PM_FinishWeaponChange()</code> in {{SourceFile|src/gamelogic/game/bg_pmove.c}}</code>.
}}

Note that for both MD3 and MD5 models, there may be separate models for first- and third-person views. Please see "[[#Weapons|Configuring the model]]" for more information regarding how to specify separate models.

====MD3====

MD3 does not use separate files for separate animations. Instead, a configuration file specifies what frames of a single MD3 animation are used for each in-game animation.

''TODO: Find out how barrel spin is handled by the engine. Is it animated into the barrel model or is it done procedurally?''

In addition to the base weapon mesh, there may be as many as three additional MD3 meshes:

{| class="wikitable"
|-
! Search string
! Tag
! Description
|-
| <code>%s_flash.md3</code>
| <code>tag_flash</code>
| The weapon's muzzle flash.
|-
| <code>%s_barrel.md3</code>
| <code>tag_barrel</code>
| The weapon's barrel.
|-
| <code>%s_hand.md3</code>
| N/A
| Hands holding the weapon model. Note: this is not used for third person models.
|}

For non-programmers, the <code>%s</code> string is replaced by the parameter given to the <code>weaponModel</code> or <code>weaponModel3rdPerson</code> keyword.

The tag <code>tag_weapon</code> is used on the main weapon model to align the third person weapon model to the third person player model.

====MD5====

Note that each animation filename must have the <code>.md5anim</code> extension.

{| class="wikitable"
|-
! Animation name
! Engine constant
! Description
|-
| <code>%s_view_idle</code>
| <code>WANIM_IDLE</code>
| Animation played when a weapon is not being fired
|-
| <code>%s_view_lower</code>
| <code>WANIM_DROP</code>
| Animation played when a weapon is being put away
|-
| <code>%s_view_reload</code>
| <code>WANIM_RELOAD</code>
| Weapon reload animation
|-
| <code>%s_view_raise</code>
| <code>WANIM_RAISE</code>
| Animation played when a weapon is switched to
|-
| <code>%s_view_fire</code>
| <code>WANIM_ATTACK1</code>
| Default attack animation
|-
|
| <code>WANIM_ATTACK2</code>
| rowspan="7" | Usage of these is highly dependent on the player class. The marauder, for example, may randomly use one of these instead of <code>WANIM_ATTACK1</code>.1
|-
|
| <code>WANIM_ATTACK3</code>
|-
|
| <code>WANIM_ATTACK4</code>
|-
|
| <code>WANIM_ATTACK5</code>
|-
|
| <code>WANIM_ATTACK6</code>
|-
|
| <code>WANIM_ATTACK7</code>
|-
|
| <code>WANIM_ATTACK8</code>
|-
|}

# See <code>PM_Weapon()</code>.

===Buildables===

====MD3====

As always, MD3 buildable models require a separate configuration file that specifies which frames of the animation correspond to actions displayed by the game.

{{Note|header = Developer Note|disregardby = artists|content =
This file is parsed by <code>CG_ParseBuildableAnimationFile()</code> in {{SourceFile|src/gamelogic/cgame/cg_buildable.c}}.
}}

Each line in the configuration file corresponds to a single animation. Those animations are in the same order as in the table for MD5 animation names below.

The order that animations appear in the configuration file must match this order exactly. Animations may not be omitted.

The syntax is as follows:

<var>firstFrame</var> <var>numFrames</var> [<var>loopFrames</var> [<var>fps</var>]]

* <var>firstFrame</var> — Specifies the initial frame of the animation.
* <var>numFrames</var> — Specifies the number of frames following the initial frame that comprise that animation.
* <var>loopFrames</var> — (''Optional'')
* <var>fps</var> — (''Optional, may only be used if loopFrames is specified'') Specifies the framerate of the animation. If not specified, defaults to 1.

C and C++ style comments (i.e., <code>//</code> and <code>/* */</code>) are permitted past the last argument.

====MD5====

As with weapon animations, each animation filename must have the <code>.md5anim</code> extension.

{{Note|header = Developer Note|disregardby = artists|content =
These animation constants are in the <code>buildableAnimNumber_t</code> enumeration in {{SourceFile|src/gamelogic/game/bg_public.c}}. Animations are set using the <code>G_SetIdleBuildableAnim()</code> and <code>G_SetBuildableAnim()</code> functions. All animations are in entity behavior functions in {{SourceFile|src/gamelogic/game/g_buildable.c}}.

Sounds for animations are enumerated in the <code>cg_buildableSoundNames</code> array in {{SourceFile|src/gamelogic/game/bg_public.h}}. Which animations are loaded is defined in
}}


{| class="wikitable"
|-
! Animation name
! Engine constant
! Used by
! Description
|-
| <code>idle</code>
| <code>BANIM_IDLE1</code>
| All
| Idle animation, shown when the buildable is not doing anything (and in the case of human buildables, when they are also powered). Used in place of other animations if they are missing unless otherwise noted.
|-
| <code>idle2</code>
| <code>BANIM_IDLE2</code>
| Medistation, telenode, barricade, egg
| ‘Active’ idle state, e.g. while the medistation is currently healing (and not transitioning into or out of the healing state).
|-
| <code>powerdown</code>
| <code>BANIM_POWERDOWN</code>
| Human buildables, (barricade)
| Animation played when a buildable has just lost power.
|-
| <code>idle_unpowered</code>
| <code>BANIM_IDLE_UNPOWERED</code>
| Human buildables, (barricade)
| Idle animation played when a buildable has no power. ''(Formerly <code>idle3</code>.)''
|-
| <code>construct</code>
| <code>BANIM_CONSTRUCT1</code>
| All
| Construction animation, shown when the buildable is being built.
|-
| <code>construct2</code>
| <code>BANIM_CONSTRUCT2</code>
| Medistation, (telenode), (egg)
| Animation played when returning to the primary idle state, e.g. medistation transitioning from healing.
|-
| <code>attack</code>
| <code>BANIM_ATTACK1</code>
| All (except tesla)
| Animation played when a buidlable is attacking or transitioning to its ‘active’ idle state. For the barricade, the animation when it is shrinking.
|-
| <code>attack2</code>
| <code>BANIM_ATTACK2</code>
| (Medistation), (telenode), barricade, (egg)
| Unshrink animation for the barricade. (Falls back on <code>BANIM_ATTACK1</code>.)
|-
| <code>spawn</code>
| <code>BANIM_SPAWN1</code>
| Telenode, Egg
| Animation for when when someone is spawning from a telenode or egg.
|-
| <code>spawn2</code>
| <code>BANIM_SPAWN2</code>
| Currently unused.
|
|-
| <code>pain</code>
| <code>BANIM_PAIN1</code>
| All
| Default pain animation, used when a buildable is damaged.
|-
| <code>pain2</code>
| <code>BANIM_PAIN2</code>
| (Medistation), barricade, (egg)
| Pain animation used for the barricade when it is damaged and shrunk. (Falls back on <code>BANIM_PAIN1</code>.)
|-
| <code>destroy</code>
| <code>BANIM_DESTROY1</code>
| All
| Played when a buildable is killed or destroyed.
|-
| <code>destroy_unpowered</code>
| <code>BANIM_DESTROY_UNPOWERED</code>
| All which can be unpowered
| Played when an unpowered buildable is killed or destroyed. (Falls back on <code>BANIM_DESTROY1</code>.)
|-
| <code>destroyed</code>
| <code>BANIM_DESTROYED</code>
| All
| The animation played after the buildable's destroy animation finishes playing but before it blows up; essentially, the buildable in a dead state. For the barricade, this is the same animation as for its shrunk state.
|-
|}

''Note: buildables whose names are in (parentheses) may not actually use the animation, but it is possible that at some point they will. However, the animations are loaded.''

===Player models===

====MD5====

As with weapon animations, each animation filename must have the <code>.md5anim</code> extension.

Items in italics need to be double-checked.

Note that at present, some of these strings do not match the constants.

{| class="wikitable"
|-
! colspan="3" | Animation name
! colspan="2" | Engine constant
! rowspan="2" | Humans?
! rowspan="2" | Aliens?
! rowspan="2" | Description
|-
! Assumed Correct
! Actual (Humans)
! Actual (Aliens)
! Humans
! Aliens
|-
| <code>attack</code> 
| <code>attack</code>
| <code>attack</code>
| <code>TORSO_ATTACK</code>
| <code>NSPA_ATTACK1</code>
| style="background:#3c9e2d;color:#fff;" | Yes
| style="background:#3c9e2d;color:#fff;" | Yes
|
|-
| <code>attack2</code> 
| <code>idle</code>
| <code>attack2</code>
| <code>TORSO_ATTACK2</code>
| <code>NSPA_ATTACK2</code>
| style="background:#3c9e2d;color:#fff;" | Yes
| style="background:#3c9e2d;color:#fff;" | Yes
|
|-
| <code>attack3</code> 
| <code>attack3</code>
| <code>attack3</code>
| N/A
| <code>NSPA_ATTACK3</code>
| style="background:#ff1a1d;color:#fff;" | No
| style="background:#3c9e2d;color:#fff;" | Yes
|
|-
| <code>charge</code> 
| N/A
| <code>charge</code>
| N/A
| <code>NSPA_CHARGE</code>
| style="background:#ff1a1d;color:#fff;" | No
| style="background:#3c9e2d;color:#fff;" | Yes
| Tyrant charge animation
|-
| <code>crouch</code> 
| <code>crouch</code>
| N/A
| <code>LEGS_IDLECR</code>
| N/A
| style="background:#3c9e2d;color:#fff;" | Yes
| style="background:#ff1a1d;color:#fff;" | No
|
|-
| <code>crouch_backward</code> 
| <code>crouch_forward</code>
| N/A
| <code>LEGS_BACKCR</code>
| N/A
| style="background:#3c9e2d;color:#fff;" | Yes
| style="background:#ff1a1d;color:#fff;" | No
|
|-
| <code>crouch_forward</code> 
| <code>crouch_forward</code>
| N/A
| <code>LEGS_WALKCR</code>
| N/A
| style="background:#3c9e2d;color:#fff;" | Yes
| style="background:#ff1a1d;color:#fff;" | No
|
|-
| <code>die</code> 
| <code>die</code>
| <code>die</code>
| <code>BOTH_DEATH1</code>
| <code>NSPA_DEATH1</code>
| style="background:#3c9e2d;color:#fff;" | Yes
| style="background:#3c9e2d;color:#fff;" | Yes
|
|-
| <code>gesture</code> 
| <code>gesture</code>
| <code>gesture</code>
| <code>TORSO_GESTURE</code>
| <code>NSPA_GESTURE</code>
| style="background:#3c9e2d;color:#fff;" | Yes
| style="background:#3c9e2d;color:#fff;" | Yes
|
|-
| <code>idle</code> 
| <code>idle</code>
| N/A
| <code>LEGS_IDLE</code>
| N/A
| style="background:#3c9e2d;color:#fff;" | Yes
| style="background:#ff1a1d;color:#fff;" | No
| Human idle animation. It seems as though NSPA_STAND ("stand") is used as the idle animation for aliens.
|-
| <code>jump</code> 
| <code>jump</code>
| <code>jump</code>
| <code>LEGS_JUMP</code>
| <code>NSPA_JUMP</code>
| style="background:#3c9e2d;color:#fff;" | Yes
| style="background:#3c9e2d;color:#fff;" | Yes
|
|-
| <code>jump_back</code> 
| <code>jump</code>
| <code>jump_back</code>
| <code>LEGS_JUMPB</code>
| <code>NSPA_JUMPBACK</code>
| style="background:#3c9e2d;color:#fff;" | Yes
| style="background:#3c9e2d;color:#fff;" | Yes
| Evidently although humans have a separate constant for jumping backwards, they use the same animation file as for jumping forwards.
|-
| <code>land</code> 
| <code>land</code>
| <code>land</code>
| <code>LEGS_LAND</code>
| <code>NSPA_LAND</code>
| style="background:#3c9e2d;color:#fff;" | Yes
| style="background:#3c9e2d;color:#fff;" | Yes
|
|-
| <code>land_back</code> 
| <code>land</code>
| <code>land_back</code>
| <code>LEGS_LANDB</code>
| <code>NSPA_LANDBACK</code>
| style="background:#3c9e2d;color:#fff;" | Yes
| style="background:#3c9e2d;color:#fff;" | Yes
| Like with jumping, humans evidently use the same animation for both LEGS_LAND and LEGS_LANDB.
|-
| <code>pain1</code> 
| N/A
| <code>pain1</code>
| N/A
| <code>NSPA_PAIN1</code>
| style="background:#ff1a1d;color:#fff;" | No
| style="background:#3c9e2d;color:#fff;" | Yes
| Humans evidently do not have a pain animation?
|-
| <code>pain2</code> 
| N/A
| <code>pain2</code>
| N/A
| <code>NSPA_PAIN2</code>
| style="background:#ff1a1d;color:#fff;" | No
| style="background:#3c9e2d;color:#fff;" | Yes
|
|-
| <code>run</code> 
| <code>run</code>
| <code>run</code>
| <code>LEGS_RUN</code>
| <code>NSPA_RUN</code>
| style="background:#3c9e2d;color:#fff;" | Yes
| style="background:#3c9e2d;color:#fff;" | Yes
|
|-
| <code>run_backwards</code> 
| <code>run</code> (?)
| <code>run_backwards</code>
| <code>LEGS_BACK</code>
| <code>NSPA_RUNBACK</code>
| style="background:#3c9e2d;color:#fff;" | Yes
| style="background:#3c9e2d;color:#fff;" | Yes
| Note: Not sure if this is correct for the humans
|-
| <code>run_left</code> 
| N/A
| <code>run_left</code>
| N/A
| <code>NSPA_RUNLEFT</code>
| style="background:#ff1a1d;color:#fff;" | No
| style="background:#3c9e2d;color:#fff;" | Yes
|
|-
| <code>run_right</code> 
| N/A
| <code>run_right</code>
| N/A
| <code>NSPA_RUNLEFT</code>
| style="background:#ff1a1d;color:#fff;" | No
| style="background:#3c9e2d;color:#fff;" | Yes
|
|-
| <code>stand</code> 
| <code>?</code>
| <code>stand</code>
| <code></code>
| <code>NSPA_STAND</code>
| ''No''
| style="background:#3c9e2d;color:#fff;" | Yes
| TORSO_STAND is in the code, but I didn't see an animation loaded for the humans
|-
| <code>stand2</code> 
| <code>idle</code>
| <code></code>
| <code>TORSO_STAND2</code>
| <code></code>
| style="background:#3c9e2d;color:#fff;" | Yes
| ''No''
|
|-
| <code>step</code>
| <code>step</code>
| <code></code>
| <code>LEGS_TURN</code>?
| <code></code>
| style="background:#3c9e2d;color:#fff;" | Yes
| ''No''
|
|-
| <code>swim</code> 
| <code>swim</code>
| <code>swim</code>
| <code>LEGS_SWIM</code>
| <code>NSPA_SWIM</code>
| style="background:#3c9e2d;color:#fff;" | Yes
| style="background:#3c9e2d;color:#fff;" | Yes
|
|-
| <code>turn</code>
| <code>step</code>
| <code></code>
| <code>LEGS_TURN</code>
| <code></code>
| style="background:#ff1a1d;color:#fff;" | No
| style="background:#3c9e2d;color:#fff;" | Yes
|
|-
| <code>walk</code> 
| <code>walk</code>
| <code>walk</code>
| <code>LEGS_WALK</code>
| <code>NSPA_WALK</code>
| style="background:#3c9e2d;color:#fff;" | Yes
| style="background:#3c9e2d;color:#fff;" | Yes
|
|-
| <code>walk_backwards</code> 
| <code>walk</code>
| <code>walk_backwards</code>
| <code>LEGS_BACKWALK</code>
| <code>NSPA_WALKBACK</code>
| style="background:#3c9e2d;color:#fff;" | Yes
| style="background:#3c9e2d;color:#fff;" | Yes
|
|-
| <code>walk_left</code> 
| N/A
| <code>walk_left</code>
| N/A
| <code>NSPA_WALKLEFT</code>
| style="background:#ff1a1d;color:#fff;" | No
| style="background:#3c9e2d;color:#fff;" | Yes
|
|-
| <code>walk_right</code> 
| N/A
| <code>walk_right</code>
| N/A
| <code>NSPA_WALKLEFT</code>
| style="background:#ff1a1d;color:#fff;" | No
| style="background:#3c9e2d;color:#fff;" | Yes
|
|-
|}



==Writing shaders==

As was implied before, the texture(s) used by a model are not stored in the md5mesh or md5anim files; they are specified by a separate shader file that is placed in the <code>scripts/</code> directory.

Shaders are a very large topic and are outside the scope of this guide. The [http://tremap.xtr3m.net/__Games/Xreal/Manual_Shader_1/ShaderManual.htm XReal shader guide] explains shaders in detail. However, the following shader should do for most purposes:

<pre>
models/buildables/trapper
{
diffuseMap models/buildables/trapper/trapper.tga
bumpMap models/buildables/trapper/trapper_n.tga
specularMap models/buildables/trapper/trapper_s.tga
}
</pre>

Do take note that
* <code>models/buildables/trapper</code> is NOT a path, it is merely a string that matches the shader specified by the <code>.md5mesh</code>, and
* <code>bumpMap</code> actually refers to a normal map.

==Configuring the model==

Aside from the textures used by a model, the scale, vertical position, and bounding box size of the model must be specified. This is done with a configuration file. These were formerly placed in <code>overrides/buildables/</code> (for buildables) or <code>overrides/classes/</code> (for player models), but are now placed in <code>configs/</code>.

===Player models===

{{Note|header = Developer Note|disregardby = artists|content =
Reading the configuration file for player models is handled by the <code>CG_ParseCharacterFile()</code> function in {{SourceFile|src/gamelogic/cgame/cg_players.c}}</code>.
}}

The configuration file may use the following keywords:

''Note: this list is incomplete''

<ul>
<li><code>headoffset <var>x</var> <var>y</var> <var>z</var></code></li>
<li><code>sex <var>gender</var></code>

Sets the gender of the model. Options are <code>f</code> for female or <code>n</code> for neuter. Any other character is interpreted as male.

</li>
<li><code>fixedlegs</code></li>
<li><code>fixedtorso</code></li>
<li><code>firstTorsoBoneName</code></li>
<li><code>footsteps</code>

* <code>default</code>
* <code>flesh</code>
* <code>metal</code>
* <code>splash</code>
* <code>none</code>

</li>
<li><code>lastTorsoBoneName</code></li>
<li><code>torsoControlBoneName</code></li>
<li><code>neckControlBoneName</code></li>
<li><code>modelScale</code></li>
</ul>

As an example:

<pre>
name "Basilisk"
model level1
modelScale 1.0
skin default
shadowScale 1.0
hud alien_general_hud
mins -18 -18 -18
maxs 18 18 18
crouchMaxs 18 18 18
deadMins -18 -18 -4
deadMaxs 18 18 4
zOffset 0.0
</pre>

===Weapons===

{{Note|header = Developer Note|disregardby = artists|content =
Weapon configuration files are parsed with <code>CG_ParseWeaponConfig()</code> function in {{SourceFile|src/gamelogic/cgame/cg_weapons.c}}</code>.
}}

The configuration file may use the following keywords:

<ul>
<li><code>weaponModel <var>path</var></code></li>
<li><code>weaponModel3rdPerson <var>path</var></code></li>
<li><code>idleSound <var>path</var></code></li>
<li><code>icon <var>path</var></code> — The relative path to the icon that is displayed in the HUD for that weapon.</li>
<li><code>crosshair <var>path</var></code></li>
<li><code>disableIn3rdPerson</code></li>
</ul>

After those keywords, one of the following keywords must be used, followed by an opening curly brace (<code>{</code>), more commands, and a final closing curly brace (<code>}</code>):

* <code>primary</code> (engine constant: <code>WPM_PRIMARY</code>)
* <code>secondary</code> (engine constant: <code>WPM_SECONDARY</code>)
* <code>tertiary</code> (engine constant: <code>WPM_TERTIARY</code>)

The configuration between the curly braces is handled by <code>CG_ParseWeaponModeSection</code>, in the same file. It accepts the following keywords:

<ul>
<li><code>missileModel <var>path</var></code></li>
<li><code>missileSprite <var>size</var> <var>shader</var></code>
* <var>size</var> — The size of the missile sprite. If this value is negative, it is made zero.
* <var>shader</var> — The shader describing the missile sprite.
</li>
<li><code>missileRotates</code></li>
<li><code>missileAnimates <var>startFrame</var> <var>numFrames</var> <var>frameRate</var> <var>looping</var></code></li>
<li><code>missileParticleSystem <var>name</var></code></li>
<li><code>missileTrailSystem <var>name</var></code></li>
<li><code>muzzleParticleSystem <var>name</var></code></li>
<li><code>impactParticleSystem <var>name</var></code></li>
<li><code>impactMark <var>size</var> <var>shader</var></code></li>
<li><code>impactSound <var>index</var> <var>path</var></code>
* <var>index</var> — The index of the sound file, clamped to the range [0,3]; up to four impact sounds may be defined with this keyword.
* <var>path</var> — The file path of the sound file to use.
</li>
<li><code>impactFleshSound <var>index</var> <var>path</var></code>
* <var>index</var> — The index of the sound file, clamped to the range [0,3]; up to four impact sounds may be defined with this keyword.
* <var>path</var> — The file path of the sound file to use.
</li>
<li><code>alwaysImpact</code></li>
<li><code>flashDLightColor <var>red</var> <var>green</var> <var>blue</var></code>
Specifies the color of the muzzle flash  dynamic lighting.
* <var>red</var> — The red color component as a floating point number in the range [0,1].
* <var>green</var> — The green color component as a floating point number in the range [0,1].
* <var>blue</var> — The blue color component as a floating point number in the range [0,1].
</li>
<li><code>continuousFlash</code></li>
<li><code>missileDlightColor <var>red</var> <var>green</var> <var>blue</var></code>
* <var>red</var> — The red color component as a floating point number in the range [0,1].
* <var>green</var> — The green color component as a floating point number in the range [0,1].
* <var>blue</var> — The blue color component as a floating point number in the range [0,1].
</li>
<li><code>missileDlight <var>size</var></code>
* <var>size</var> — If this value is negative, it is made zero.
</li>
<li><code>firingSound <var>path</var></code></li>
<li><code>missileSound <var>path</var></code></li>
<li><code>flashSound <var>index</var> <var>path</var></code>
* <var>index</var> — The index of the sound file, clamped to the range [0,3]; up to four impact sounds may be defined with this keyword.
* <var>path</var> — The file path of the sound file to use.
</li>
</ul>

As an example, this is the configuration for the chaingun (<code>models/weapons/chaingun/weapon.cfg</code>):

<pre>
weaponModel models/weapons/chaingun/chaingun.md3

icon icons/iconw_chaingun
crosshair 48 gfx/2d/crosshair-chaingun_s

primary
{
flashDlightColor 1.0 1.0 0.0
flashSound 0 models/weapons/chaingun/flash0.wav
flashSound 1 models/weapons/chaingun/flash1.wav
flashSound 2 models/weapons/chaingun/flash2.wav
flashSound 3 models/weapons/chaingun/flash3.wav

impactMark 8 gfx/marks/bullet_mrk

impactSound 0 models/weapons/chaingun/impact0.wav

impactParticleSystem models/weapons/rifle/impactPS
muzzleParticleSystem models/weapons/chaingun/muzzlePS
}
</pre>

===Buildables===

{{Note|header = Developer Note|disregardby = artists|content =
Reading the configuration file for buildables is handled by the <code>BG_ParseBuildableFile()</code> function in {{SourceFile|src/gamelogic/game/bg_misc.c}}</code>.
}}

The configuration file may use the following keywords:

<ul>
<li><code>model <var>index</var> <var>path</var></code>
* <var>index</var> Some models may actually have several different model files (not sure why); this argument specifies which. Clamped to the range [0,3] (which should actually be [0, MAX_BUILDABLE_MODELS]), which means that you may use as many as four models per buildable. This is only used by the machine gun turret, which is composed of different parts.
* <var>path</var> The file path where the model file is located. Note that for MD5 models, an extension of <code>.md3</code> is still to be used; it will automatically be changed by the engine.
</li>
<li><code>modelScale <var>scale</var></code>
Scales the model linearly.
</li>
<li><code>mins <var>minX</var> <var>minY</var> <var>minZ</var></code>
The coordinates passed to this and <code>maxs</code> define the bounding box for the model that is used for collision. The bounding box is always aligned to the global coordinate axes regardless of the orientation of the model, which is something to keep in mind when defining these values. You will likely have to debug these values by enabling drawing the bounding boxes. Load a map in developer mode with <code>\devmap</code> and set <code>\cg_drawBBOX</code> to 1. The three arguments combined form the coordinate of one corner of the bounding box, and <code>maxs</code> the opposite corner.
</li>
<li><code>maxs <var>minX</var> <var>minY</var> <var>minZ</var></code>
Defines the opposite corner of the AABB. (See above.)
</li>
<li><code>zOffset <var>offset</var></code>
Sets the vertical offset of the model; in other words, how far off the ground it is.
* <var>offset</var> The offset as a floating point (decimal) value.
</li>
</ul>

As an example:

<pre>
model 0 models/buildables/trapper/trapper.md3
modelScale 0.8
mins -15 -15 -15
maxs 15 15 15
zOffset -15
</pre>

Note that at present, you do not have to change the filename extension of the model to match what it actually is; that is, if the model is actually an md5, you may leave the extension as ".md3" and not ".md5mesh" or whatever.

==Directory overview==

This section provides an overview of the subset of the directory structure used by models; directories used for other purposes have been omitted.

* <code>armor/</code> Location of configurations for the three armor types (i.e., light, helmet, and battlesuit). You should not have to edit these.
* <code>configs/</code> Location of configuration files for various models.
** <code>buildables/</code>
* <code>scripts/</code>
* <code>gfx/</code> Location of various 2d effect textures, such as those used for weapons.
** ''Subdirectories omitted for brevity''
* <code>models/</code>
** <code>ammo/</code>
*** <code>tesla/</code> Contains a single image used for the tesla sparks. Not sure why it's located here.
** <code>buildables/</code>
*** <code>acid_tube/</code> Acid tube
*** <code>arm/</code> Armory
*** <code>barricade/</code> Barricade
*** <code>booster/</code> Booster
*** <code>dcc/</code> Defense Computer
*** <code>eggpod/</code> Egg
*** <code>hive/</code> Hive
*** <code>hovel/</code> Hovel
*** <code>medistat/</code> Medistation
*** <code>mgturret/</code> Machinegun Turret
*** <code>overmind/</code> Overmind
*** <code>reactor/</code> Reactor
*** <code>repeater/</code> Repeater
*** <code>telenode/</code> Telenode
*** <code>tesla/</code> Tesla generator
*** <code>trapper/</code> Trapper
** <code>players/</code>
*** <code>builder/</code> Human builder model.
*** <code>human_base/</code> Unarmored human model. Also includes the jetpack and battery pack.
*** <code>human_bsuit/</code> Battlesuit model.
*** <code>level0/</code> Dretch.
*** <code>level1/</code> Basilisk and advanced basilisk. (The advanced basilisk uses the same model as the regular dragoon, but a different texture.)
*** <code>level2/</code> Marauder and advanced marauder. (Same as basilisk with regard to advanced model.)
*** <code>level3/</code> Dragoon and advanced dragoon. (Same as basilisk with regard to advanced model.)
*** <code>level4/</code> Tyrant.
** <code>weapons/</code>
*** <code>abuild/</code> As there is no weapon model for the granger, the only thing in this directory is a config to hide the (nonexistant) weapon model in third person (a hack, I guess).
*** <code>abuildupg/</code> Advanced granger weapon. Same as above, except the config file specifies sounds for the attack sounds (which are also located in this directory).
*** <code>ackit/</code> Advanced construction kit.
*** <code>blaster/</code> Blaster.
*** <code>chaingun/</code> Chaingun.
*** <code>ckit/</code> Construction kit.
*** <code>flamer/</code> Flamethrower.
*** <code>grenade/</code> Grenade.
*** <code>hive/</code> Sprites, configuration file, and sound file for the hive.
*** <code>lcannon/</code> Lucifer cannon.
*** <code>level0/</code> Dretch configuration and attack sound file.
*** <code>level1/</code> Basilisk configuration and attack sound files (hit and miss).
*** <code>level1upg/</code> Advanced Basilisk configuration and added gas attack sound file.
*** <code>level2/</code> Marauder configuration and attack sound files (hit and miss).
*** <code>level2upg/</code> Advanced Marauder configuration and added electric attack sound file.
*** <code>level3/</code> Dragoon configuration and attack sound files (hit, miss, and pounce).
*** <code>level3upg/</code> Advanced Dragoon configuration and added barb sound files and model.
*** <code>level4/</code> Tyrant configuration and attack sound files (hit and miss).
*** <code>lgun/</code> Lasgun
*** <code>lockblob/</code>
*** <code>mdriver/</code> Mass Driver
*** <code>mgturret/</code> Machinegun turret '''''FIXME: why does this show up twice?'''''
*** <code>prifle/</code> Plasma rifle
*** <code>psaw/</code> Painsaw
*** <code>rifle/</code> Rifle
*** <code>shells/</code>
*** <code>shotgun/</code> Shotgun
*** <code>teslagen/</code> Tesla generator '''''FIXME: why does this show up twice?'''''
* <code>overrides/</code> Depreciated directory for model configuration files. Use <code>configs/</code> instead.
** <code>buildables/</code> Depreceated location for buildable model configs.
** <code>classes/</code> Depreceated location for character model configs.
* <code>scripts/</code> Location for shaders.

==Getting the model in game==

There are two approaches to test your model in-game. The model and related files may be in actual folders, or the engine can load them from a <code>.pk3</code> (package) file, which is really just a zip-compressed archive with the extension changed. The process for creating these archives is discussed on the [[packaging game data]] page.

==Testing the model==

Once you have the model exported, the shader and configuration written, and everything packaged into a .pk3 file and in place, you are ready to test.

===Testing externally===

Rather than testing the exported model in-game, you may also test the model with a stand-alone MD5 viewer. At present, there is a viewer for Windows available [http://www.katsbits.com/files/md5/modelviewer_0.93a.zip here].

===Testing in game===

See the [[testing]] page.

==Troubleshooting==

===Old exporter===

''Please be aware that there are numerous issues with the old exporter and the newer versions of Blender. See [[#All_or_part_of_the_mesh_appears_to_be_sucked_to_the_center|the troubleshooting section]] below for more information. It is strongly recommended that you use the [[#New_exporter|new exporter]] instead.''

====Error while exporting from Blender====

{| class="wikitable"
|-
| [[Image:Md5_export_error_no_armature.png]]
| style="vertical-align:top;" | This error displays when the selected object does not have an armature modifier. Any object exported as an md5 needs bones, even if it is static. If you are unsure of how to create a static object with md5, just add an armature, set the playback start and end frame to 1, and add a location or rotation keyframe at frame 1.
|-
| [[Image:Md5_export_error_no_animation.png]]
| style="vertical-align:top;" | This error displays when there are no keyframes. Follow the abov instructions for exporting a static object with md5.
|-
| [[Image:Md5_export_error_no_material.png]]
| style="vertical-align:top;" | This error displays when the object does not have a material applied to it. This is required by the script, even though it really does not affect the exported result.
|-
|}

===Appearance problems in-game===

====All or part of the mesh appears to be sucked to the center====

''Please note that as of 2012-02-27, the MD5 exporter does not work properly in several more recent versions of Blender. Use Blender 2.59 until this is fixed. See [http://www.katsbits.com/smforum/index.php?topic=167.msg2135#msg2135 the MD5 exporter thread] for more information.''

This can happen for a number of reasons:
<ul>
<li>There are vertices without weights.
''Solution'': apply weights to vertices that do not have them. If those verts are not to be animated, weight them to a bone that does not move.
</li>
<li>You are using Blender 2.61 and you have bones that have animated positions.
''Solution'': Use an earlier version of blender until this is fixed in the exporter.
</li>
<li>You are using Blender 2.62 and you have bones that are not located at the origin and do not have a parent or have animated positions.
''Solution'': Again, use an earlier version of blender until this is fixed in the exporter.
</li>
</ul>

==="R_LoadMD5: vertex %i requires more than %i weights on surface (%i) in model '%s'"===

This error is displayed in the console in game when a vertex belongs to too many groups.

You can use this script to check your model for this before exporting:

<pre>
# Copyright 2012 Nicholas De Cicco. <velociostrich@gmail.com>
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

import bpy, math
from bpy.props import *

MAX_GROUPS_PER_VERT = 4

# Switch to object mode for vertex selection to work
bpy.ops.object.mode_set(mode='OBJECT')

for obj in bpy.context.selected_objects:
# Check to see that the object is a mesh.
if obj.type != 'MESH':
continue

# Select verts that belong to too many groups
for vertex in obj.data.vertices:
if len(vertex.groups) > MAX_GROUPS_PER_VERT:
vertex.select = True
else:
vertex.select = False

# Switch back to edit mode so the user can see any selected verts
bpy.ops.object.mode_set(mode='EDIT')
</pre>

====Using the Script====

# Select the mesh (or meshes) that you would like to check.
# Create a new text editor window and text data block.
# Copy and paste the script into the text editor.
# Click "Run Script".

Once the script has ran, the 3d view will switch to edit mode and any offending vertices will be selected. A handy tip: clicking an individual vertex will reveal which groups it is a member of in the properties shelf.

[[Image:Properties_shelf_vertex_groups.png|frame|center|The vertex group section of the properties shelf]]

==Resources==

* [http://www.modwiki.net/wiki/MD5_%28file_format%29 MD5 file format documentation]
* [http://www.katsbits.com/tools/# Tools for MD5 and other file formats]
* [http://download.blender.org/release/ Older versions of Blender]

Tutorials/Exporting models

2013-10-11T21:20:45Z

Anomalous: /* New exporter */

[[Category:Modeling]]
==Overview==

''Notice: This guide was written for the 2.6 series of Blender. Most of this guide should apply for other versions of Blender, but this is not guaranteed.''

Getting a finished model out of Blender and into the game is a relatively involved process with a number of possible pitfalls. This guide aims to describe the process in as much detail as possible to assist users who have not done it before, or those who have exported models for other games and would like to know what (if anything) is different.

If you would like to export from Maya, you may find the official [http://www.iddevnet.com/quake4/Animations id Software documentation] useful.

At present, this guide primarily describes the process for exporting models to the MD5 format. While the engine supports both MD3 and MD5, the latter is preferred. The reasons for this are discussed [[#What_is_MD5?|below]].

Before a model may be exported and used in-game, it must be adequately prepared: 

* [[#Limitations_of_the_engine|Engine limitations]] must be adhered to.
* The model must have a texture applied to it. This texture is not automagically applied to the model after it is exported and loaded in-game, this is only necessary to satisfy the MD5 exporter; that is, the game cannot read from the exported model the filename of the texture to use.
* The model must be a mesh and must have an armature modifier applied to it.
* The armature's bones all must have at least one keyframe.

The actual process of exporting a model is straightforward:

# After ensuring that the above requirements are met, the mesh itself is exported.
# If using the old exporter, each animation is exported separately. The new exporter adds support for [[#Batch_export_with_the_new_exporter|batch export]] of animations.
# A [[#Configuring_the_model|configuration file]] specifying data such as the bounding box size and vertical offset is written. This may include information that is specific to the particular type of model (i.e., buildable or player model).
# A [[#Writing_shaders|shader]] is written that determines how the model is textured in-game.
# Finally, after everything is properly named and configured, the files are [[Packaging_game_data|packaged]] and placed in the correct game data folder to allow it to be loaded in-game.

==What is MD5?==

MD5 is the model format created by id Software for Doom 3 which is also used by Unvanquished. It is an improvement over its predecessor, MD3, in that it uses bones to pose the model.

{{Note|header=What about MD3? IQM? PSK? ASE? Obj?|content=
{{SupportedModelFormats}}
}}

===Advantages over MD3===

* Unlike MD3, MD5 is bone-based, meaning that instead of storing an entire mesh for each frame of animation, there is only one mesh file. This single mesh file is deformed using a vertex shader.
* Because there is only one mesh, only one VBO (vertex buffer object) needs to be created for each MD5 model. The deformation is performed entirely on the GPU, so it is (theoretically) faster than MD3, and uses less memory.
* Because the format is in plain-text, it can be easily verified for sanity (i.e., to ensure that it was exported correctly and not corrupted in some way).

===Disadvantages over MD3===

* Some forms of motion are more difficult to achieve; certain animation techniques (such as lattices) are not usable.
* Because the format is in plain-text, it takes up more space than it needs to, though this is negligible and a MD5 model will typically be smaller than the same model in MD3 format as less data is used per each frame of animation with MD5 as compared to MD3.

===Limitations of the engine===

The engine places certain limitations on the fidelity of your models when using the MD5 format. These are:

* There may not be more than 128 bones. (Note: this was increased from 64.)
* There may not be more than 100,000 vertices.
* There may not be more than 10,000 triangles.
* No vertex may belong to more than four vertex groups (i.e., one vertex may not be controlled by more than four bones). An error message will be displayed in-game if this requirement is not met. A [[#.22R_LoadMD5:_vertex_.25i_requires_more_than_.25i_weights_on_surface_.28.25i.29_in_model_.27.25s.27.22|script]] may be used before exporting to check that this limitation is not exceeded.

{{Note|header=Developer Note|content=The limitation on vertex groups is a hard-coded limitation of the vertex shader ({{SourceFile|main/glsl/vertexSkinning_vp.glsl}}) that deforms the base mesh.}}

===Limitations of the format===

The MD5 format only supports bones. You may not

* Use lattices or any other means of deformation.
* Scale bones.
* Use keyframes on anything other than bone poses. You may, however, set keyframes on bone constraint influences or anything else that would affect a bone's position or rotation.

Note that you do not have to have a parent/child relationship between bones. In fact, in some instances, avoiding a parent/child relationship is necessary to achieve certain effects, such as moving bones around.

==Acquiring and installing the exporter==

===MD3===

If for some reason you are interested in the MD3 exporter, it is available from [http://sourceforge.net/projects/md3exporter/ SourceForge].

===MD5===

====Old exporter====

''Please be aware that there are numerous issues with the old exporter and the newer versions of Blender. See [[#All_or_part_of_the_mesh_appears_to_be_sucked_to_the_center|the troubleshooting section]] below for more information. It is strongly recommended that you use the [[#New_exporter|new exporter]] instead.''

You can download the exporter from [http://www.katsbits.com/smforum/index.php?topic=178.0 this thread on katsbits.com]. Installation instructions are in the thread.

====New exporter====

As of 15 May 2012, there is another [http://sourceforge.net/projects/blenderbitsbobs/ MD5 exporter available for Blender 2.63+] ([http://www.katsbits.com/smforum/index.php?topic=404.0 discussion on katsbits]). This has been found to be superior to the old exporter. Note that portions of this guide have not yet been updated to reflect the differences in the new exporter.

We have [http://sourceforge.net/u/dsalt/blenderbitsbobs/ a patched version] which allows each mesh objects to have a custom property, <var>q3tex</var>, which contains the name of a shader. This is output in the ‘shader’ line for that mesh in the md5mesh file.

==Exporting the mesh==

===MD5===

Note that for buildables and weapons, the filename of the exported mesh is dictated by the corresponding [[#Configuring_the_model|configuration file]]. All player models, however, are hardcoded to look for <code>body.md5mesh</code>.

====Old exporter====

''Please be aware that there are numerous issues with the old exporter and the newer versions of Blender. See [[#All_or_part_of_the_mesh_appears_to_be_sucked_to_the_center|the troubleshooting section]] below for more information. It is strongly recommended that you use the [[#New_exporter|new exporter]] instead.''

# Select the armature and the mesh. The order in which you select the two does not matter.
# Click File → Export → Quake Model 5 (.md5)
# On the left shelf that appears in the file prompt, change the Exports combo box to "Mesh only." Don't worry about the scale or name fields.
# Click "Export MD5".

Once this has been completed, you must manually edit the mesh file (the one with a <code>.md5mesh</code> extension) to specify the correct shader to use.

<pre>
--- snip ---
mesh {
shader "models/buildables/medistat"

numverts 4
vert 0 ( 1.000000 0.000000 ) 0 1
vert 1 ( 0.000000 0.000000 ) 1 1
--- snip ---
</pre>

Note that <code>models/buildables/medistat</code> is '''not''' a file path to a shader; it is the name (again, not filename) of the shader to use. That is, a shader with the matching name will be used for this model.

To avoid having to do this every time you export the mesh, set the name of the material applied to the object in Blender to the same as you edited the md5mesh.

====New exporter====

* Select the mesh to export.
* Click File → Export → MD5 Mesh (.md5mesh).
* Specify the output filename in the dialog, and click "Export MD5MESH".

The exported model is not ready to be used in-game just yet; it must be manually edited. Open the exported <code>.md5mesh</code> file in a text editor, and manually delete the top three lines of the file (highlighted in red below):

// Parameters used during export:
// Reorient: True
// Scale: 1.0
MD5Version 10
commandline ""

numJoints 4
numMeshes 1

joints {

...

remainder of file omitted for brevity

Be sure to save the file when you are done. You will also have to do this for each animation file that you export.

If you do not want to have to do this each time, you can edit the exporter script. Open the <code>export_md5.py</code> script in the <code>io_scene_md5</code> folder where you installed the script, at around line 30, edit this code:

def record_parameters(correctionMatrix):
return [
"// Parameters used during export:\n",
"// Reorient: {}\n".format(bool(correctionMatrix.to_euler()[2])),
"// Scale: {}\n".format(correctionMatrix.decompose()[2][0])]

to look like this:

def record_parameters(correctionMatrix):
return []

If you are comfortable with applying patches, you may use this:

<pre>
@@ -27,10 +27,7 @@
return pairs

def record_parameters(correctionMatrix):
- return [
- "// Parameters used during export:\n",
- "// Reorient: {}\n".format(bool(correctionMatrix.to_euler()[2])),
- "// Scale: {}\n".format(correctionMatrix.decompose()[2][0])]
+ return []

def define_components(obj, bm, bones, correctionMatrix):
scaleFactor = correctionMatrix.to_scale()[0]
</pre>

Note that you will also have to manually set the shader as with the [[#Old_exporter_2|old exporter]].

==Exporting the animations==

===MD3===

Exported MD3 animations require a configuration file that specifies which frames of the animation correspond to which actions the game will display.

This varies slightly by the type (i.e., weapon or buildable) of model.

===MD5===

====Old exporter====

''Please be aware that there are numerous issues with the old exporter and the newer versions of Blender. See [[#All_or_part_of_the_mesh_appears_to_be_sucked_to_the_center|the troubleshooting section]] below for more information. It is strongly recommended that you use the [[#New_exporter|new exporter]] instead.''

The procedure for exporting animations is the same as for exporting the mesh with regard to selecting the mesh and the armature. Before using the exporter, however, you must be certain to set the start and end frames to encompass only the particular animation that you wish to export; each animation must be exported separately, unless the [[#New_exporter|new exporter]] is used, which adds a [[#Batch_export_with_the_new_exporter|batch export]] feature.

[[Image:Md5_export_timeline.png|frame|center|The timeline view in Blender, which is used to set which frames of animation to export. Here, only one frame of animation (frame 180) is being exported.]]

At the export file prompt, choose "Anim only." from the "Exports" combo box. Enter as the filename the name of the particular animation that you are exporting; the correct names to use are given below.

====Batch export with the new exporter====

The [[Exporting Models#Batch export|new exporter]] now supports batch export of models.

To make use of this feature, you must set [http://wiki.blender.org/index.php/Doc:2.6/Manual/Animation/Markers frame markers] denoting the start and end of each animation. The name of frame markers denoting the start of an animation must end in "_start" and markers denoting the end of an animation must end in "_end"; for example, frame markers denoting the start and end of a buildable's construct animation would be "construct_start" and "construct_end". Avoid using frame markers with duplicate names, as which one will be used by the exporter is not predictable. Note that frame markers may overlap however you please; this is useful when two animations share a frame or you would like to automate the process of exporting the same few frames of animation as several different animation files (e.g., for testing purposes).

All operations in modifying frame markers are performed in the [http://wiki.blender.org/index.php/Doc:2.6/Manual/Animation/Timeline timeline]:
* To create a frame marker, move the timeline to the desired frame and press M.
* To select a frame marker, click with the right mouse button.
* To move a frame marker, select it and press G.
* To delete a frame marker, select it and press X.
* To rename a frame marker, select it and press CtrlM.

The actual exportation process becomes much simpler:

# Click File → Export → MD5 (batch export).
# Specify the filename of the <code>.md5mesh</code> to export.

==Animation names==

The filenames for each exported animation must be what the engine expects for it to be able to load them, and vary depending on the format (MD3 or MD5) and type (e.g., buildable, weapon, or player) of model being exported.

===Weapons===

{{Note|header = Developer Note|disregardby = artists|content =
See the <code>CG_ParseWeaponFile()</code> function in {{SourceFile|src/gamelogic/cgame/cg_weapons.c}}</code>.

Weapon state constants are enumerated in the <code>weaponstate_t</code> enum in {{SourceFile|src/gamelogic/game/bg_public.h}}</code>:

{{{!}} class{{=}}"wikitable"
{{!}}-
! Constant
! Description
{{!}}-
{{!}} <code>WEAPON_READY</code>
{{!}} The weapon at its idle state, ready to fire.
{{!}}-
{{!}} <code>WEAPON_RAISING</code>
{{!}} The weapon as it is being raised. It may not be fired in this state.
{{!}}-
{{!}} <code>WEAPON_DROPPING</code>
{{!}} The weapon as it is being put away. It may not be fired in this state.
{{!}}-
{{!}} <code>WEAPON_FIRING</code>
{{!}} The weapon as it is being fired.
{{!}}-
{{!}} <code>WEAPON_RELOADING</code>
{{!}} The weapon as it is being reloaded.
{{!}}-
{{!}} <code>WEAPON_NEEDS_RESET</code>
{{!}} The Lucifer Cannon in its overcharged state.
{{!}}-
{{!}}}

Control of weapon states is done by <code>PM_Weapon()</code>, <code>PM_BeginWeaponChange()</code>, and <code>PM_FinishWeaponChange()</code> in {{SourceFile|src/gamelogic/game/bg_pmove.c}}</code>.
}}

Note that for both MD3 and MD5 models, there may be separate models for first- and third-person views. Please see "[[#Weapons|Configuring the model]]" for more information regarding how to specify separate models.

====MD3====

MD3 does not use separate files for separate animations. Instead, a configuration file specifies what frames of a single MD3 animation are used for each in-game animation.

''TODO: Find out how barrel spin is handled by the engine. Is it animated into the barrel model or is it done procedurally?''

In addition to the base weapon mesh, there may be as many as three additional MD3 meshes:

{| class="wikitable"
|-
! Search string
! Tag
! Description
|-
| <code>%s_flash.md3</code>
| <code>tag_flash</code>
| The weapon's muzzle flash.
|-
| <code>%s_barrel.md3</code>
| <code>tag_barrel</code>
| The weapon's barrel.
|-
| <code>%s_hand.md3</code>
| N/A
| Hands holding the weapon model. Note: this is not used for third person models.
|}

For non-programmers, the <code>%s</code> string is replaced by the parameter given to the <code>weaponModel</code> or <code>weaponModel3rdPerson</code> keyword.

The tag <code>tag_weapon</code> is used on the main weapon model to align the third person weapon model to the third person player model.

====MD5====

Note that each animation filename must have the <code>.md5anim</code> extension.

{| class="wikitable"
|-
! Animation name
! Engine constant
! Description
|-
| <code>%s_view_idle</code>
| <code>WANIM_IDLE</code>
| Animation played when a weapon is not being fired
|-
| <code>%s_view_lower</code>
| <code>WANIM_DROP</code>
| Animation played when a weapon is being put away
|-
| <code>%s_view_reload</code>
| <code>WANIM_RELOAD</code>
| Weapon reload animation
|-
| <code>%s_view_raise</code>
| <code>WANIM_RAISE</code>
| Animation played when a weapon is switched to
|-
| <code>%s_view_fire</code>
| <code>WANIM_ATTACK1</code>
| Default attack animation
|-
|
| <code>WANIM_ATTACK2</code>
| rowspan="7" | Usage of these is highly dependent on the player class. The marauder, for example, may randomly use one of these instead of <code>WANIM_ATTACK1</code>.1
|-
|
| <code>WANIM_ATTACK3</code>
|-
|
| <code>WANIM_ATTACK4</code>
|-
|
| <code>WANIM_ATTACK5</code>
|-
|
| <code>WANIM_ATTACK6</code>
|-
|
| <code>WANIM_ATTACK7</code>
|-
|
| <code>WANIM_ATTACK8</code>
|-
|}

# See <code>PM_Weapon()</code>.

===Buildables===

====MD3====

As always, MD3 buildable models require a separate configuration file that specifies which frames of the animation correspond to actions displayed by the game.

{{Note|header = Developer Note|disregardby = artists|content =
This file is parsed by <code>CG_ParseBuildableAnimationFile()</code> in {{SourceFile|src/gamelogic/cgame/cg_buildable.c}}.
}}

Each line in the configuration file corresponds to a single animation. Those animations are in the same order as in the table for MD5 animation names below.

The order that animations appear in the configuration file must match this order exactly. Animations may not be omitted.

The syntax is as follows:

<var>firstFrame</var> <var>numFrames</var> [<var>loopFrames</var> [<var>fps</var>]]

* <var>firstFrame</var> — Specifies the initial frame of the animation.
* <var>numFrames</var> — Specifies the number of frames following the initial frame that comprise that animation.
* <var>loopFrames</var> — (''Optional'')
* <var>fps</var> — (''Optional, may only be used if loopFrames is specified'') Specifies the framerate of the animation. If not specified, defaults to 1.

C and C++ style comments (i.e., <code>//</code> and <code>/* */</code>) are permitted past the last argument.

====MD5====

As with weapon animations, each animation filename must have the <code>.md5anim</code> extension.

{{Note|header = Developer Note|disregardby = artists|content =
These animation constants are in the <code>buildableAnimNumber_t</code> enumeration in {{SourceFile|src/gamelogic/game/bg_public.c}}. Animations are set using the <code>G_SetIdleBuildableAnim()</code> and <code>G_SetBuildableAnim()</code> functions. All animations are in entity behavior functions in {{SourceFile|src/gamelogic/game/g_buildable.c}}.

Sounds for animations are enumerated in the <code>cg_buildableSoundNames</code> array in {{SourceFile|src/gamelogic/game/bg_public.h}}. Which animations are loaded is defined in
}}


{| class="wikitable"
|-
! Animation name
! Engine constant
! Used by
! Description
|-
| <code>idle</code>
| <code>BANIM_IDLE1</code>
| All
| Idle animation, shown when the buildable is not doing anything (and in the case of human buildables, when they are also powered). Used in place of other animations if they are missing unless otherwise noted.
|-
| <code>idle2</code>
| <code>BANIM_IDLE2</code>
| Medistation, telenode, barricade, egg
| ‘Active’ idle state, e.g. while the medistation is currently healing (and not transitioning into or out of the healing state).
|-
| <code>powerdown</code>
| <code>BANIM_POWERDOWN</code>
| Human buildables, (barricade)
| Animation played when a buildable has just lost power.
|-
| <code>idle_unpowered</code>
| <code>BANIM_IDLE_UNPOWERED</code>
| Human buildables, (barricade)
| Idle animation played when a buildable has no power. ''(Formerly <code>idle3</code>.)''
|-
| <code>construct</code>
| <code>BANIM_CONSTRUCT1</code>
| All
| Construction animation, shown when the buildable is being built.
|-
| <code>construct2</code>
| <code>BANIM_CONSTRUCT2</code>
| Medistation, (telenode), (egg)
| Animation played when returning to the primary idle state, e.g. medistation transitioning from healing.
|-
| <code>attack</code>
| <code>BANIM_ATTACK1</code>
| All (except tesla)
| Animation played when a buidlable is attacking or transitioning to its ‘active’ idle state. For the barricade, the animation when it is shrinking.
|-
| <code>attack2</code>
| <code>BANIM_ATTACK2</code>
| (Medistation), (telenode), barricade, (egg)
| Unshrink animation for the barricade. (Falls back on <code>BANIM_ATTACK1</code>.)
|-
| <code>spawn</code>
| <code>BANIM_SPAWN1</code>
| Telenode, Egg
| Animation for when when someone is spawning from a telenode or egg.
|-
| <code>spawn2</code>
| <code>BANIM_SPAWN2</code>
| Currently unused.
|
|-
| <code>pain</code>
| <code>BANIM_PAIN1</code>
| All
| Default pain animation, used when a buildable is damaged.
|-
| <code>pain2</code>
| <code>BANIM_PAIN2</code>
| (Medistation), barricade, (egg)
| Pain animation used for the barricade when it is damaged and shrunk. (Falls back on <code>BANIM_PAIN1</code>.)
|-
| <code>destroy</code>
| <code>BANIM_DESTROY1</code>
| All
| Played when a buildable is killed or destroyed.
|-
| <code>destroy_unpowered</code>
| <code>BANIM_DESTROY_UNPOWERED</code>
| Human buildings, barricade
| Played when an unpowered buildable is killed or destroyed. (Falls back on <code>BANIM_DESTROY1</code>.)
|-
| <code>destroyed</code>
| <code>BANIM_DESTROYED</code>
| All
| The animation played after the buildable's destroy animation finishes playing but before it blows up; essentially, the buildable in a dead state. For the barricade, this is the same animation as for its shrunk state.
|-
|}

''Note: buildables whose names are in (parentheses) may not actually use the animation, but it is possible that at some point they will. However, the animations are loaded.''

===Player models===

====MD5====

As with weapon animations, each animation filename must have the <code>.md5anim</code> extension.

Items in italics need to be double-checked.

Note that at present, some of these strings do not match the constants.

{| class="wikitable"
|-
! colspan="3" | Animation name
! colspan="2" | Engine constant
! rowspan="2" | Humans?
! rowspan="2" | Aliens?
! rowspan="2" | Description
|-
! Assumed Correct
! Actual (Humans)
! Actual (Aliens)
! Humans
! Aliens
|-
| <code>attack</code> 
| <code>attack</code>
| <code>attack</code>
| <code>TORSO_ATTACK</code>
| <code>NSPA_ATTACK1</code>
| style="background:#3c9e2d;color:#fff;" | Yes
| style="background:#3c9e2d;color:#fff;" | Yes
|
|-
| <code>attack2</code> 
| <code>idle</code>
| <code>attack2</code>
| <code>TORSO_ATTACK2</code>
| <code>NSPA_ATTACK2</code>
| style="background:#3c9e2d;color:#fff;" | Yes
| style="background:#3c9e2d;color:#fff;" | Yes
|
|-
| <code>attack3</code> 
| <code>attack3</code>
| <code>attack3</code>
| N/A
| <code>NSPA_ATTACK3</code>
| style="background:#ff1a1d;color:#fff;" | No
| style="background:#3c9e2d;color:#fff;" | Yes
|
|-
| <code>charge</code> 
| N/A
| <code>charge</code>
| N/A
| <code>NSPA_CHARGE</code>
| style="background:#ff1a1d;color:#fff;" | No
| style="background:#3c9e2d;color:#fff;" | Yes
| Tyrant charge animation
|-
| <code>crouch</code> 
| <code>crouch</code>
| N/A
| <code>LEGS_IDLECR</code>
| N/A
| style="background:#3c9e2d;color:#fff;" | Yes
| style="background:#ff1a1d;color:#fff;" | No
|
|-
| <code>crouch_backward</code> 
| <code>crouch_forward</code>
| N/A
| <code>LEGS_BACKCR</code>
| N/A
| style="background:#3c9e2d;color:#fff;" | Yes
| style="background:#ff1a1d;color:#fff;" | No
|
|-
| <code>crouch_forward</code> 
| <code>crouch_forward</code>
| N/A
| <code>LEGS_WALKCR</code>
| N/A
| style="background:#3c9e2d;color:#fff;" | Yes
| style="background:#ff1a1d;color:#fff;" | No
|
|-
| <code>die</code> 
| <code>die</code>
| <code>die</code>
| <code>BOTH_DEATH1</code>
| <code>NSPA_DEATH1</code>
| style="background:#3c9e2d;color:#fff;" | Yes
| style="background:#3c9e2d;color:#fff;" | Yes
|
|-
| <code>gesture</code> 
| <code>gesture</code>
| <code>gesture</code>
| <code>TORSO_GESTURE</code>
| <code>NSPA_GESTURE</code>
| style="background:#3c9e2d;color:#fff;" | Yes
| style="background:#3c9e2d;color:#fff;" | Yes
|
|-
| <code>idle</code> 
| <code>idle</code>
| N/A
| <code>LEGS_IDLE</code>
| N/A
| style="background:#3c9e2d;color:#fff;" | Yes
| style="background:#ff1a1d;color:#fff;" | No
| Human idle animation. It seems as though NSPA_STAND ("stand") is used as the idle animation for aliens.
|-
| <code>jump</code> 
| <code>jump</code>
| <code>jump</code>
| <code>LEGS_JUMP</code>
| <code>NSPA_JUMP</code>
| style="background:#3c9e2d;color:#fff;" | Yes
| style="background:#3c9e2d;color:#fff;" | Yes
|
|-
| <code>jump_back</code> 
| <code>jump</code>
| <code>jump_back</code>
| <code>LEGS_JUMPB</code>
| <code>NSPA_JUMPBACK</code>
| style="background:#3c9e2d;color:#fff;" | Yes
| style="background:#3c9e2d;color:#fff;" | Yes
| Evidently although humans have a separate constant for jumping backwards, they use the same animation file as for jumping forwards.
|-
| <code>land</code> 
| <code>land</code>
| <code>land</code>
| <code>LEGS_LAND</code>
| <code>NSPA_LAND</code>
| style="background:#3c9e2d;color:#fff;" | Yes
| style="background:#3c9e2d;color:#fff;" | Yes
|
|-
| <code>land_back</code> 
| <code>land</code>
| <code>land_back</code>
| <code>LEGS_LANDB</code>
| <code>NSPA_LANDBACK</code>
| style="background:#3c9e2d;color:#fff;" | Yes
| style="background:#3c9e2d;color:#fff;" | Yes
| Like with jumping, humans evidently use the same animation for both LEGS_LAND and LEGS_LANDB.
|-
| <code>pain1</code> 
| N/A
| <code>pain1</code>
| N/A
| <code>NSPA_PAIN1</code>
| style="background:#ff1a1d;color:#fff;" | No
| style="background:#3c9e2d;color:#fff;" | Yes
| Humans evidently do not have a pain animation?
|-
| <code>pain2</code> 
| N/A
| <code>pain2</code>
| N/A
| <code>NSPA_PAIN2</code>
| style="background:#ff1a1d;color:#fff;" | No
| style="background:#3c9e2d;color:#fff;" | Yes
|
|-
| <code>run</code> 
| <code>run</code>
| <code>run</code>
| <code>LEGS_RUN</code>
| <code>NSPA_RUN</code>
| style="background:#3c9e2d;color:#fff;" | Yes
| style="background:#3c9e2d;color:#fff;" | Yes
|
|-
| <code>run_backwards</code> 
| <code>run</code> (?)
| <code>run_backwards</code>
| <code>LEGS_BACK</code>
| <code>NSPA_RUNBACK</code>
| style="background:#3c9e2d;color:#fff;" | Yes
| style="background:#3c9e2d;color:#fff;" | Yes
| Note: Not sure if this is correct for the humans
|-
| <code>run_left</code> 
| N/A
| <code>run_left</code>
| N/A
| <code>NSPA_RUNLEFT</code>
| style="background:#ff1a1d;color:#fff;" | No
| style="background:#3c9e2d;color:#fff;" | Yes
|
|-
| <code>run_right</code> 
| N/A
| <code>run_right</code>
| N/A
| <code>NSPA_RUNLEFT</code>
| style="background:#ff1a1d;color:#fff;" | No
| style="background:#3c9e2d;color:#fff;" | Yes
|
|-
| <code>stand</code> 
| <code>?</code>
| <code>stand</code>
| <code></code>
| <code>NSPA_STAND</code>
| ''No''
| style="background:#3c9e2d;color:#fff;" | Yes
| TORSO_STAND is in the code, but I didn't see an animation loaded for the humans
|-
| <code>stand2</code> 
| <code>idle</code>
| <code></code>
| <code>TORSO_STAND2</code>
| <code></code>
| style="background:#3c9e2d;color:#fff;" | Yes
| ''No''
|
|-
| <code>step</code>
| <code>step</code>
| <code></code>
| <code>LEGS_TURN</code>?
| <code></code>
| style="background:#3c9e2d;color:#fff;" | Yes
| ''No''
|
|-
| <code>swim</code> 
| <code>swim</code>
| <code>swim</code>
| <code>LEGS_SWIM</code>
| <code>NSPA_SWIM</code>
| style="background:#3c9e2d;color:#fff;" | Yes
| style="background:#3c9e2d;color:#fff;" | Yes
|
|-
| <code>turn</code>
| <code>step</code>
| <code></code>
| <code>LEGS_TURN</code>
| <code></code>
| style="background:#ff1a1d;color:#fff;" | No
| style="background:#3c9e2d;color:#fff;" | Yes
|
|-
| <code>walk</code> 
| <code>walk</code>
| <code>walk</code>
| <code>LEGS_WALK</code>
| <code>NSPA_WALK</code>
| style="background:#3c9e2d;color:#fff;" | Yes
| style="background:#3c9e2d;color:#fff;" | Yes
|
|-
| <code>walk_backwards</code> 
| <code>walk</code>
| <code>walk_backwards</code>
| <code>LEGS_BACKWALK</code>
| <code>NSPA_WALKBACK</code>
| style="background:#3c9e2d;color:#fff;" | Yes
| style="background:#3c9e2d;color:#fff;" | Yes
|
|-
| <code>walk_left</code> 
| N/A
| <code>walk_left</code>
| N/A
| <code>NSPA_WALKLEFT</code>
| style="background:#ff1a1d;color:#fff;" | No
| style="background:#3c9e2d;color:#fff;" | Yes
|
|-
| <code>walk_right</code> 
| N/A
| <code>walk_right</code>
| N/A
| <code>NSPA_WALKLEFT</code>
| style="background:#ff1a1d;color:#fff;" | No
| style="background:#3c9e2d;color:#fff;" | Yes
|
|-
|}



==Writing shaders==

As was implied before, the texture(s) used by a model are not stored in the md5mesh or md5anim files; they are specified by a separate shader file that is placed in the <code>scripts/</code> directory.

Shaders are a very large topic and are outside the scope of this guide. The [http://tremap.xtr3m.net/__Games/Xreal/Manual_Shader_1/ShaderManual.htm XReal shader guide] explains shaders in detail. However, the following shader should do for most purposes:

<pre>
models/buildables/trapper
{
diffuseMap models/buildables/trapper/trapper.tga
bumpMap models/buildables/trapper/trapper_n.tga
specularMap models/buildables/trapper/trapper_s.tga
}
</pre>

Do take note that
* <code>models/buildables/trapper</code> is NOT a path, it is merely a string that matches the shader specified by the <code>.md5mesh</code>, and
* <code>bumpMap</code> actually refers to a normal map.

==Configuring the model==

Aside from the textures used by a model, the scale, vertical position, and bounding box size of the model must be specified. This is done with a configuration file. These were formerly placed in <code>overrides/buildables/</code> (for buildables) or <code>overrides/classes/</code> (for player models), but are now placed in <code>configs/</code>.

===Player models===

{{Note|header = Developer Note|disregardby = artists|content =
Reading the configuration file for player models is handled by the <code>CG_ParseCharacterFile()</code> function in {{SourceFile|src/gamelogic/cgame/cg_players.c}}</code>.
}}

The configuration file may use the following keywords:

''Note: this list is incomplete''

<ul>
<li><code>headoffset <var>x</var> <var>y</var> <var>z</var></code></li>
<li><code>sex <var>gender</var></code>

Sets the gender of the model. Options are <code>f</code> for female or <code>n</code> for neuter. Any other character is interpreted as male.

</li>
<li><code>fixedlegs</code></li>
<li><code>fixedtorso</code></li>
<li><code>firstTorsoBoneName</code></li>
<li><code>footsteps</code>

* <code>default</code>
* <code>flesh</code>
* <code>metal</code>
* <code>splash</code>
* <code>none</code>

</li>
<li><code>lastTorsoBoneName</code></li>
<li><code>torsoControlBoneName</code></li>
<li><code>neckControlBoneName</code></li>
<li><code>modelScale</code></li>
</ul>

As an example:

<pre>
name "Basilisk"
model level1
modelScale 1.0
skin default
shadowScale 1.0
hud alien_general_hud
mins -18 -18 -18
maxs 18 18 18
crouchMaxs 18 18 18
deadMins -18 -18 -4
deadMaxs 18 18 4
zOffset 0.0
</pre>

===Weapons===

{{Note|header = Developer Note|disregardby = artists|content =
Weapon configuration files are parsed with <code>CG_ParseWeaponConfig()</code> function in {{SourceFile|src/gamelogic/cgame/cg_weapons.c}}</code>.
}}

The configuration file may use the following keywords:

<ul>
<li><code>weaponModel <var>path</var></code></li>
<li><code>weaponModel3rdPerson <var>path</var></code></li>
<li><code>idleSound <var>path</var></code></li>
<li><code>icon <var>path</var></code> — The relative path to the icon that is displayed in the HUD for that weapon.</li>
<li><code>crosshair <var>path</var></code></li>
<li><code>disableIn3rdPerson</code></li>
</ul>

After those keywords, one of the following keywords must be used, followed by an opening curly brace (<code>{</code>), more commands, and a final closing curly brace (<code>}</code>):

* <code>primary</code> (engine constant: <code>WPM_PRIMARY</code>)
* <code>secondary</code> (engine constant: <code>WPM_SECONDARY</code>)
* <code>tertiary</code> (engine constant: <code>WPM_TERTIARY</code>)

The configuration between the curly braces is handled by <code>CG_ParseWeaponModeSection</code>, in the same file. It accepts the following keywords:

<ul>
<li><code>missileModel <var>path</var></code></li>
<li><code>missileSprite <var>size</var> <var>shader</var></code>
* <var>size</var> — The size of the missile sprite. If this value is negative, it is made zero.
* <var>shader</var> — The shader describing the missile sprite.
</li>
<li><code>missileRotates</code></li>
<li><code>missileAnimates <var>startFrame</var> <var>numFrames</var> <var>frameRate</var> <var>looping</var></code></li>
<li><code>missileParticleSystem <var>name</var></code></li>
<li><code>missileTrailSystem <var>name</var></code></li>
<li><code>muzzleParticleSystem <var>name</var></code></li>
<li><code>impactParticleSystem <var>name</var></code></li>
<li><code>impactMark <var>size</var> <var>shader</var></code></li>
<li><code>impactSound <var>index</var> <var>path</var></code>
* <var>index</var> — The index of the sound file, clamped to the range [0,3]; up to four impact sounds may be defined with this keyword.
* <var>path</var> — The file path of the sound file to use.
</li>
<li><code>impactFleshSound <var>index</var> <var>path</var></code>
* <var>index</var> — The index of the sound file, clamped to the range [0,3]; up to four impact sounds may be defined with this keyword.
* <var>path</var> — The file path of the sound file to use.
</li>
<li><code>alwaysImpact</code></li>
<li><code>flashDLightColor <var>red</var> <var>green</var> <var>blue</var></code>
Specifies the color of the muzzle flash  dynamic lighting.
* <var>red</var> — The red color component as a floating point number in the range [0,1].
* <var>green</var> — The green color component as a floating point number in the range [0,1].
* <var>blue</var> — The blue color component as a floating point number in the range [0,1].
</li>
<li><code>continuousFlash</code></li>
<li><code>missileDlightColor <var>red</var> <var>green</var> <var>blue</var></code>
* <var>red</var> — The red color component as a floating point number in the range [0,1].
* <var>green</var> — The green color component as a floating point number in the range [0,1].
* <var>blue</var> — The blue color component as a floating point number in the range [0,1].
</li>
<li><code>missileDlight <var>size</var></code>
* <var>size</var> — If this value is negative, it is made zero.
</li>
<li><code>firingSound <var>path</var></code></li>
<li><code>missileSound <var>path</var></code></li>
<li><code>flashSound <var>index</var> <var>path</var></code>
* <var>index</var> — The index of the sound file, clamped to the range [0,3]; up to four impact sounds may be defined with this keyword.
* <var>path</var> — The file path of the sound file to use.
</li>
</ul>

As an example, this is the configuration for the chaingun (<code>models/weapons/chaingun/weapon.cfg</code>):

<pre>
weaponModel models/weapons/chaingun/chaingun.md3

icon icons/iconw_chaingun
crosshair 48 gfx/2d/crosshair-chaingun_s

primary
{
flashDlightColor 1.0 1.0 0.0
flashSound 0 models/weapons/chaingun/flash0.wav
flashSound 1 models/weapons/chaingun/flash1.wav
flashSound 2 models/weapons/chaingun/flash2.wav
flashSound 3 models/weapons/chaingun/flash3.wav

impactMark 8 gfx/marks/bullet_mrk

impactSound 0 models/weapons/chaingun/impact0.wav

impactParticleSystem models/weapons/rifle/impactPS
muzzleParticleSystem models/weapons/chaingun/muzzlePS
}
</pre>

===Buildables===

{{Note|header = Developer Note|disregardby = artists|content =
Reading the configuration file for buildables is handled by the <code>BG_ParseBuildableFile()</code> function in {{SourceFile|src/gamelogic/game/bg_misc.c}}</code>.
}}

The configuration file may use the following keywords:

<ul>
<li><code>model <var>index</var> <var>path</var></code>
* <var>index</var> Some models may actually have several different model files (not sure why); this argument specifies which. Clamped to the range [0,3] (which should actually be [0, MAX_BUILDABLE_MODELS]), which means that you may use as many as four models per buildable. This is only used by the machine gun turret, which is composed of different parts.
* <var>path</var> The file path where the model file is located. Note that for MD5 models, an extension of <code>.md3</code> is still to be used; it will automatically be changed by the engine.
</li>
<li><code>modelScale <var>scale</var></code>
Scales the model linearly.
</li>
<li><code>mins <var>minX</var> <var>minY</var> <var>minZ</var></code>
The coordinates passed to this and <code>maxs</code> define the bounding box for the model that is used for collision. The bounding box is always aligned to the global coordinate axes regardless of the orientation of the model, which is something to keep in mind when defining these values. You will likely have to debug these values by enabling drawing the bounding boxes. Load a map in developer mode with <code>\devmap</code> and set <code>\cg_drawBBOX</code> to 1. The three arguments combined form the coordinate of one corner of the bounding box, and <code>maxs</code> the opposite corner.
</li>
<li><code>maxs <var>minX</var> <var>minY</var> <var>minZ</var></code>
Defines the opposite corner of the AABB. (See above.)
</li>
<li><code>zOffset <var>offset</var></code>
Sets the vertical offset of the model; in other words, how far off the ground it is.
* <var>offset</var> The offset as a floating point (decimal) value.
</li>
</ul>

As an example:

<pre>
model 0 models/buildables/trapper/trapper.md3
modelScale 0.8
mins -15 -15 -15
maxs 15 15 15
zOffset -15
</pre>

Note that at present, you do not have to change the filename extension of the model to match what it actually is; that is, if the model is actually an md5, you may leave the extension as ".md3" and not ".md5mesh" or whatever.

==Directory overview==

This section provides an overview of the subset of the directory structure used by models; directories used for other purposes have been omitted.

* <code>armor/</code> Location of configurations for the three armor types (i.e., light, helmet, and battlesuit). You should not have to edit these.
* <code>configs/</code> Location of configuration files for various models.
** <code>buildables/</code>
* <code>scripts/</code>
* <code>gfx/</code> Location of various 2d effect textures, such as those used for weapons.
** ''Subdirectories omitted for brevity''
* <code>models/</code>
** <code>ammo/</code>
*** <code>tesla/</code> Contains a single image used for the tesla sparks. Not sure why it's located here.
** <code>buildables/</code>
*** <code>acid_tube/</code> Acid tube
*** <code>arm/</code> Armory
*** <code>barricade/</code> Barricade
*** <code>booster/</code> Booster
*** <code>dcc/</code> Defense Computer
*** <code>eggpod/</code> Egg
*** <code>hive/</code> Hive
*** <code>hovel/</code> Hovel
*** <code>medistat/</code> Medistation
*** <code>mgturret/</code> Machinegun Turret
*** <code>overmind/</code> Overmind
*** <code>reactor/</code> Reactor
*** <code>repeater/</code> Repeater
*** <code>telenode/</code> Telenode
*** <code>tesla/</code> Tesla generator
*** <code>trapper/</code> Trapper
** <code>players/</code>
*** <code>builder/</code> Human builder model.
*** <code>human_base/</code> Unarmored human model. Also includes the jetpack and battery pack.
*** <code>human_bsuit/</code> Battlesuit model.
*** <code>level0/</code> Dretch.
*** <code>level1/</code> Basilisk and advanced basilisk. (The advanced basilisk uses the same model as the regular dragoon, but a different texture.)
*** <code>level2/</code> Marauder and advanced marauder. (Same as basilisk with regard to advanced model.)
*** <code>level3/</code> Dragoon and advanced dragoon. (Same as basilisk with regard to advanced model.)
*** <code>level4/</code> Tyrant.
** <code>weapons/</code>
*** <code>abuild/</code> As there is no weapon model for the granger, the only thing in this directory is a config to hide the (nonexistant) weapon model in third person (a hack, I guess).
*** <code>abuildupg/</code> Advanced granger weapon. Same as above, except the config file specifies sounds for the attack sounds (which are also located in this directory).
*** <code>ackit/</code> Advanced construction kit.
*** <code>blaster/</code> Blaster.
*** <code>chaingun/</code> Chaingun.
*** <code>ckit/</code> Construction kit.
*** <code>flamer/</code> Flamethrower.
*** <code>grenade/</code> Grenade.
*** <code>hive/</code> Sprites, configuration file, and sound file for the hive.
*** <code>lcannon/</code> Lucifer cannon.
*** <code>level0/</code> Dretch configuration and attack sound file.
*** <code>level1/</code> Basilisk configuration and attack sound files (hit and miss).
*** <code>level1upg/</code> Advanced Basilisk configuration and added gas attack sound file.
*** <code>level2/</code> Marauder configuration and attack sound files (hit and miss).
*** <code>level2upg/</code> Advanced Marauder configuration and added electric attack sound file.
*** <code>level3/</code> Dragoon configuration and attack sound files (hit, miss, and pounce).
*** <code>level3upg/</code> Advanced Dragoon configuration and added barb sound files and model.
*** <code>level4/</code> Tyrant configuration and attack sound files (hit and miss).
*** <code>lgun/</code> Lasgun
*** <code>lockblob/</code>
*** <code>mdriver/</code> Mass Driver
*** <code>mgturret/</code> Machinegun turret '''''FIXME: why does this show up twice?'''''
*** <code>prifle/</code> Plasma rifle
*** <code>psaw/</code> Painsaw
*** <code>rifle/</code> Rifle
*** <code>shells/</code>
*** <code>shotgun/</code> Shotgun
*** <code>teslagen/</code> Tesla generator '''''FIXME: why does this show up twice?'''''
* <code>overrides/</code> Depreciated directory for model configuration files. Use <code>configs/</code> instead.
** <code>buildables/</code> Depreceated location for buildable model configs.
** <code>classes/</code> Depreceated location for character model configs.
* <code>scripts/</code> Location for shaders.

==Getting the model in game==

There are two approaches to test your model in-game. The model and related files may be in actual folders, or the engine can load them from a <code>.pk3</code> (package) file, which is really just a zip-compressed archive with the extension changed. The process for creating these archives is discussed on the [[packaging game data]] page.

==Testing the model==

Once you have the model exported, the shader and configuration written, and everything packaged into a .pk3 file and in place, you are ready to test.

===Testing externally===

Rather than testing the exported model in-game, you may also test the model with a stand-alone MD5 viewer. At present, there is a viewer for Windows available [http://www.katsbits.com/files/md5/modelviewer_0.93a.zip here].

===Testing in game===

See the [[testing]] page.

==Troubleshooting==

===Old exporter===

''Please be aware that there are numerous issues with the old exporter and the newer versions of Blender. See [[#All_or_part_of_the_mesh_appears_to_be_sucked_to_the_center|the troubleshooting section]] below for more information. It is strongly recommended that you use the [[#New_exporter|new exporter]] instead.''

====Error while exporting from Blender====

{| class="wikitable"
|-
| [[Image:Md5_export_error_no_armature.png]]
| style="vertical-align:top;" | This error displays when the selected object does not have an armature modifier. Any object exported as an md5 needs bones, even if it is static. If you are unsure of how to create a static object with md5, just add an armature, set the playback start and end frame to 1, and add a location or rotation keyframe at frame 1.
|-
| [[Image:Md5_export_error_no_animation.png]]
| style="vertical-align:top;" | This error displays when there are no keyframes. Follow the abov instructions for exporting a static object with md5.
|-
| [[Image:Md5_export_error_no_material.png]]
| style="vertical-align:top;" | This error displays when the object does not have a material applied to it. This is required by the script, even though it really does not affect the exported result.
|-
|}

===Appearance problems in-game===

====All or part of the mesh appears to be sucked to the center====

''Please note that as of 2012-02-27, the MD5 exporter does not work properly in several more recent versions of Blender. Use Blender 2.59 until this is fixed. See [http://www.katsbits.com/smforum/index.php?topic=167.msg2135#msg2135 the MD5 exporter thread] for more information.''

This can happen for a number of reasons:
<ul>
<li>There are vertices without weights.
''Solution'': apply weights to vertices that do not have them. If those verts are not to be animated, weight them to a bone that does not move.
</li>
<li>You are using Blender 2.61 and you have bones that have animated positions.
''Solution'': Use an earlier version of blender until this is fixed in the exporter.
</li>
<li>You are using Blender 2.62 and you have bones that are not located at the origin and do not have a parent or have animated positions.
''Solution'': Again, use an earlier version of blender until this is fixed in the exporter.
</li>
</ul>

==="R_LoadMD5: vertex %i requires more than %i weights on surface (%i) in model '%s'"===

This error is displayed in the console in game when a vertex belongs to too many groups.

You can use this script to check your model for this before exporting:

<pre>
# Copyright 2012 Nicholas De Cicco. <velociostrich@gmail.com>
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

import bpy, math
from bpy.props import *

MAX_GROUPS_PER_VERT = 4

# Switch to object mode for vertex selection to work
bpy.ops.object.mode_set(mode='OBJECT')

for obj in bpy.context.selected_objects:
# Check to see that the object is a mesh.
if obj.type != 'MESH':
continue

# Select verts that belong to too many groups
for vertex in obj.data.vertices:
if len(vertex.groups) > MAX_GROUPS_PER_VERT:
vertex.select = True
else:
vertex.select = False

# Switch back to edit mode so the user can see any selected verts
bpy.ops.object.mode_set(mode='EDIT')
</pre>

====Using the Script====

# Select the mesh (or meshes) that you would like to check.
# Create a new text editor window and text data block.
# Copy and paste the script into the text editor.
# Click "Run Script".

Once the script has ran, the 3d view will switch to edit mode and any offending vertices will be selected. A handy tip: clicking an individual vertex will reveal which groups it is a member of in the properties shelf.

[[Image:Properties_shelf_vertex_groups.png|frame|center|The vertex group section of the properties shelf]]

==Resources==

* [http://www.modwiki.net/wiki/MD5_%28file_format%29 MD5 file format documentation]
* [http://www.katsbits.com/tools/# Tools for MD5 and other file formats]
* [http://download.blender.org/release/ Older versions of Blender]

Creating custom keybinds

2013-10-04T17:14:38Z

Anomalous: /* sell */

{| style="float: right"
| __TOC__
|}

{{StatusWIP|The information on this page is incomplete.}}

==Usage==

Some simple bindings can be made via the configuration menus.

For more complicated bindings and for team bindings, you need to use the console. For example, you could bind commands to set a team and to spawn:

bind F9 "team a"
bind F10 "team h"

// attacking players
teambind aliens F5 "class level0"
teambind humans F5 "class rifle"

// builders
teambind aliens F6 "class builderupg builder"
teambind humans F6 "class ckit"

==Differences from Tremulous==

A number of commands for keybinds have changed since Tremulous, so keybind configurations cannot be directly copied from Tremulous to Unvanquished.

{| class="wikitable"
! Tremulous || Unvanquished || Used for…
|-
| <code>+button2</code> || <code>+useitem</code> || Using an item; granger spit; dragoon barb
|-
| <code>+button3</code> || <code>+taunt</code> || “Come on!” etc.
|-
| <code>+button5</code> || <code>+attack2</code> || Secondary attack
|-
| <code>+button6</code> || <code>+dodge</code> || Dodging
|-
| <code>+button7</code> || <code>+activate</code> || Using a structure; evolving
|-
| <code>+button8</code> || <code>+sprint</code> || Sprinting
|-
|}

As of alpha 3, the <code>+button''N''</code> commands are no longer present.

You may want to bind the new [[Voice say system|vsays]] to different keys.
==Gameplay commands==

This is a partial list of commands added, using Tremulous GPP r2259 as a reference point. Not everything listed is actually useful.

{{note|content=The game handles <tt>+</tt>commands specially, in a way which has implications concerning usage.

There is one way to use them in bindings which works properly, and that's to use the command on its own.

It is possible to have other commands following one of these ''but'' this is not well handled – the game appends information about when the key was pressed but, at present, assumes that there's just one command present in the binding. It also causes problems on key-up when the <tt>+</tt>command is the first command since, while the it will (correctly) be converted to a <tt>-</tt>command, any following commands will be executed unmodifed, except for the last one (which gets the timing information).

If you need to use a binding which contains one of these with other commands then use something like “<samp>wait; +taunt; wait; -taunt</samp>”. Timing information will not be added; the server has information which allows it to calculate ‘close enough’ timing information, and there may be a knock-on effect on an immediately-following action.
}}

===+activate===
Access an armoury; evolve.

===+attack2===
Secondary attack.

===+dodge===
Low jump sideways or backwards. (Humans only.)

===+rally===
“Come on!” etc., as in ‘follow me’.

===+sprint===
Run. (Humans only.)

===+taunt===
“Come on!” etc., as in ‘bring it on!’.

===+useitem===
Use the highlighted item; tertiary attack (granger spit, dragoon snipe).

===buy===

(Changed in Alpha 18.) This command can take multiple parameters. It can also be used to sell items.

{| class="wikitable"
| <code>+item</code> || Sell all which conflicts, then buy <code>item</code>.
|-
| <code>-item or type</code> || Sell <code>item</code>, or all items of the given type. (See sell.)
|-
| <code>?item</code> || Try to buy <code>item</code>, failing quietly.
|-
|}

For example, if you want a sell-all bind, you would use “<samp>buy -all rifle</samp>” – this will get rid of all equipment and re-equip you with a rifle (though if you're building something, you won't lose your construction kit and consequently will not acquire a rifle).

===say_area_team===
Talk to all teammates within a server-set range.

===sell===

(Changed in Alpha 15.) This command can take multiple parameters.

Special item names:

{| class="wikitable"
| <code>weapon</code> || Your current weapon (not blaster)
|-
| <code>weapons</code> || All weapons
|-
| <code>upgrades</code> || All upgrades
|-
| <code>armour</code> or <code>armor</code> || All armour items
|-
| <code>all</code> || Everything
|-
|}

===class===

This command behaves differently depending on which team you are on.

* As a human or alien, when dead, this command will cause you to spawn with the desired class or weapon, respectively.
* As an alien, this command will cause you to evolve to the class specified. You may not "evolve" into lower-level classes.

Note that regardless of when you invoke this command, an argument '''must''' be supplied or no result will occur.

The following arguments may be used:

{| class="wikitable progress"
|-
! Team
! Argument
! Spawnable?
! Availability
! Description
|-
! rowspan="10" | Aliens
| <code>builder</code>
| rowspan="2" class="done" | Yes
| rowspan="5" | Stage 1
| [[Granger]]
|-
| <code>level0</code>
| [[Dretch]]
|-
| <code>level1</code>
| rowspan="3" class="none" | No
| [[Basilisk]]
|-
| <code>level2</code>
| [[Marauder]]
|-
| <code>level3</code>
| [[Dragoon]]
|-
| <code>builderupg</code>
| class="done" | Yes
| rowspan="4" | Stage 2
| [[Advanced Granger]]
|-
| <code>level1upg</code>
| class="none" rowspan="4" | No
| [[Advanced Basilisk]]
|-
| <code>level2upg</code>
| [[Advanced Marauder]]
|-
| <code>level3upg</code>
| [[Advanced Dragoon]]
|-
| <code>level4</code>
| Stage 3
| [[Tyrant]]
|-
! rowspan="2" | Humans
| <code>rifle</code>
| rowspan="2" class="done" | Yes
| rowspan="2" | Stage 1
| [[Rifle]]
|-
| <code>ckit</code>
| [[Construction Kit]]
|-
|}

{{Note|content=
For the aliens, when at a higher stage, you may still spawn as a non-advanced variant of any particular class. For example, if you type

\class builder

you will spawn as a normal Granger even when the Advanced Granger is available.
}}

==Configuration commands==

===alias===
<tt>alias NAME COMMAND [PARAMETERS…]</tt>

Create an alias for the given command. The alias is then useable as a command in its own right.

===aliaslist===
Lists available command aliases.

===bind===
<tt>bind KEY [COMMAND…]</tt>
Binds a command (or sequence of commands) to the given key, or lists the bindings for that key.

All existing bindings on that key are lost.

===clearaliases===
Clears all command aliases.

===cycle===

===editbind===
<tt>editbind [TEAM] KEY</tt>

This inserts a <tt>/bind</tt> or <tt>/teambind</tt> command into the in-game console, ready for editing. The console is opened if needed.

<tt>TEAM</tt> is default, spectators, humans, or aliens. (Initial substrings are accepted.)

===irc_connect===
Start the ingame IRC client

===irc_quit===
Stop the ingame IRC client

===irc_say===
Say something in the desired IRC channel if connected to a server

===listrotation===
Lists the current map rotation. The current map is highlighted.

===loadgame===

===messagemode1===
This command opens a general chat prompt.

===messagemode2===
This command opens a team-chat prompt.

===messagemode3===
This command opens an admin chat prompt.

===messagemode4===
This command opens a chat prompt for the built-in IRC client.

===messagemodec===
This command opens a command prompt.

===modelist===

===teambind===
<tt>teambind TEAM KEY [COMMAND…]</tt>
Binds a command (or sequence of commands) to the given key for use when on the given team, or lists the binding for that key/team.

<tt>TEAM</tt> is default, spectators, humans, or aliens. (Initial substrings are accepted.)

===toggleConsole===
Opens or closes the in-game console.

===ui_restart===
Reloads UI files.

===unalias===
<tt>unalias NAME</tt>

Removes the named alias.

===unbind===
<tt>unbind [TEAM] KEY</tt>
Removes either all bindings for the given key, or the binding for the given team on that key.

<tt>TEAM</tt> is default, spectators, humans, or aliens. (Initial substrings are accepted.)

===undelay===

===undelayAll===

===unregister===
Removes registration of your GUID and name.

==Condition handling==

===if===
<tt>if VALUE CONDITION VALUE THEN [ELSE]</tt>

<tt>if MODIFIERS THEN [ELSE]</tt>

; <tt>VALUE</tt> : a variable or number
; <tt>CONDITION</tt> : comparison operator
; <tt>MODIFIERS</tt> : comma-separated list of keyboard modifiers: Shift, Ctrl, Alt, Command (or Cmd), Mode, Super. Prefix any which must not be pressed with <kbd>!</kbd>.
; <tt>THEN</tt> and <tt>ELSE</tt> : either a variable name or, if prefixed with <kbd>/</kbd> or <kbd>\</kbd>, a command string.

Recognised numeric comparison operators: 
<tt> = != < <= > >= !=</tt>

Recognised string comparison operators: 
<tt> eq ne in !in</tt>

Either the <tt>THEN</tt> clause or the <tt>ELSE</tt> clause (if present) will be executed. If it is a variable name, its content will be executed.

For example:

<pre>/if shift "/echo Hello" "/echo Goodbye"
/bind j "if \$team\$ eq aliens \"/class level1upg level1\""</pre>

(Note the escaping of the cvar <tt>team</tt>.)

===modcase===
<tt>modcase MODIFIERS THEN [MODIFIERS THEN]* [ELSE]</tt>

This works like <tt>if</tt>. The leftmost most-specific <tt>THEN</tt> whose modifier list matches is the one which is executed; if none match, then <tt>ELSE</tt> is executed if it is present.

For example:
<pre>/modcase shift "/echo 1" ctrl "/echo 2" shift,ctrl "/echo 3" shift,!alt "/echo 4"</pre>
works as follows:

# if Shift and Alt (due to clause 4) but not Ctrl (due to clause 3) are pressed;
# if Ctrl but not Shift (due to clause 3);
# if Shift and Ctrl;
# if Shift but neither Alt nor Ctrl.

===strcmp===
Compare the string values of two cvars. ''Obsolete.''

==Admin commands==

===allready===
Quickly move to the next map. Used only during the intermission.

===speclock===
Prevents a player from joining a team for a given time or until the end of the current game.
If necessary, the player is moved to spectators.

===specunlock===
Allows a player, previously locked, to join a team.

==Utility commands==

===calc===
Do math calculations on cvars. Store the value to a cvar Useful in making scripts.

===concat===
Concatenate 2 cvars into a third.

===delay===

===glsl_restart===
Development use. For recompiling the GLSL shader code.

===grep===
<tt>grep TEXT</tt>

Searches the in-game console for occurrences of <tt>TEXT</tt>. Matching lines are reprinted.

===help===

===math===
Do math on cvars. Useful for scripts.

===random===
Generate a random number

===reloadhud===
Reload the HUD without a vid_restart

===screenshotPNG===
Saves a screenshot in the PNG format.

===search===
<tt>search TEXT</tt>

Searches back through the in-game console for <tt>TEXT</tt> and scrolls to it.

===searchDown===
<tt>searchDown TEXT</tt>

Searches forward through the in-game console for <tt>TEXT</tt> and scrolls to it.

===snd_reload===
Reload sounds (includes a vid_restart

===wav_record===

===wav_stoprecord===

==Special uses==

For commands relevant to development and testing purposes, please see the [[Testing]] page.

===buildcubemaps===

===cache_endgather===

===cache_mapchange===

===cache_setindex===

===cache_startgather===

===cache_usedfile===

===fieldinfo===

===gameCompleteStatus===

===openurl===
Open a URL inside the OS's default browser.

===pubkey===
Internal use.

===pubkey_identify===
Internal use.

===setRecommended===

===shaderexp===

===spdevmap===
Does nothing.

===spmap===
Does nothing.

===updatehunkusage===

===updatescreen===

Creating custom keybinds

2013-10-04T17:10:21Z

Anomalous: /* buy */

{| style="float: right"
| __TOC__
|}

{{StatusWIP|The information on this page is incomplete.}}

==Usage==

Some simple bindings can be made via the configuration menus.

For more complicated bindings and for team bindings, you need to use the console. For example, you could bind commands to set a team and to spawn:

bind F9 "team a"
bind F10 "team h"

// attacking players
teambind aliens F5 "class level0"
teambind humans F5 "class rifle"

// builders
teambind aliens F6 "class builderupg builder"
teambind humans F6 "class ckit"

==Differences from Tremulous==

A number of commands for keybinds have changed since Tremulous, so keybind configurations cannot be directly copied from Tremulous to Unvanquished.

{| class="wikitable"
! Tremulous || Unvanquished || Used for…
|-
| <code>+button2</code> || <code>+useitem</code> || Using an item; granger spit; dragoon barb
|-
| <code>+button3</code> || <code>+taunt</code> || “Come on!” etc.
|-
| <code>+button5</code> || <code>+attack2</code> || Secondary attack
|-
| <code>+button6</code> || <code>+dodge</code> || Dodging
|-
| <code>+button7</code> || <code>+activate</code> || Using a structure; evolving
|-
| <code>+button8</code> || <code>+sprint</code> || Sprinting
|-
|}

As of alpha 3, the <code>+button''N''</code> commands are no longer present.

You may want to bind the new [[Voice say system|vsays]] to different keys.
==Gameplay commands==

This is a partial list of commands added, using Tremulous GPP r2259 as a reference point. Not everything listed is actually useful.

{{note|content=The game handles <tt>+</tt>commands specially, in a way which has implications concerning usage.

There is one way to use them in bindings which works properly, and that's to use the command on its own.

It is possible to have other commands following one of these ''but'' this is not well handled – the game appends information about when the key was pressed but, at present, assumes that there's just one command present in the binding. It also causes problems on key-up when the <tt>+</tt>command is the first command since, while the it will (correctly) be converted to a <tt>-</tt>command, any following commands will be executed unmodifed, except for the last one (which gets the timing information).

If you need to use a binding which contains one of these with other commands then use something like “<samp>wait; +taunt; wait; -taunt</samp>”. Timing information will not be added; the server has information which allows it to calculate ‘close enough’ timing information, and there may be a knock-on effect on an immediately-following action.
}}

===+activate===
Access an armoury; evolve.

===+attack2===
Secondary attack.

===+dodge===
Low jump sideways or backwards. (Humans only.)

===+rally===
“Come on!” etc., as in ‘follow me’.

===+sprint===
Run. (Humans only.)

===+taunt===
“Come on!” etc., as in ‘bring it on!’.

===+useitem===
Use the highlighted item; tertiary attack (granger spit, dragoon snipe).

===buy===

(Changed in Alpha 18.) This command can take multiple parameters. It can also be used to sell items.

{| class="wikitable"
| <code>+item</code> || Sell all which conflicts, then buy <code>item</code>.
|-
| <code>-item or type</code> || Sell <code>item</code>, or all items of the given type. (See sell.)
|-
| <code>?item</code> || Try to buy <code>item</code>, failing quietly.
|-
|}

For example, if you want a sell-all bind, you would use “<samp>buy -all rifle</samp>” – this will get rid of all equipment and re-equip you with a rifle (though if you're building something, you won't lose your construction kit and consequently will not acquire a rifle).

===say_area_team===
Talk to all teammates within a server-set range.

===sell===

(Changed in Alpha 15.) This command can take multiple parameters.

===class===

This command behaves differently depending on which team you are on.

* As a human or alien, when dead, this command will cause you to spawn with the desired class or weapon, respectively.
* As an alien, this command will cause you to evolve to the class specified. You may not "evolve" into lower-level classes.

Note that regardless of when you invoke this command, an argument '''must''' be supplied or no result will occur.

The following arguments may be used:

{| class="wikitable progress"
|-
! Team
! Argument
! Spawnable?
! Availability
! Description
|-
! rowspan="10" | Aliens
| <code>builder</code>
| rowspan="2" class="done" | Yes
| rowspan="5" | Stage 1
| [[Granger]]
|-
| <code>level0</code>
| [[Dretch]]
|-
| <code>level1</code>
| rowspan="3" class="none" | No
| [[Basilisk]]
|-
| <code>level2</code>
| [[Marauder]]
|-
| <code>level3</code>
| [[Dragoon]]
|-
| <code>builderupg</code>
| class="done" | Yes
| rowspan="4" | Stage 2
| [[Advanced Granger]]
|-
| <code>level1upg</code>
| class="none" rowspan="4" | No
| [[Advanced Basilisk]]
|-
| <code>level2upg</code>
| [[Advanced Marauder]]
|-
| <code>level3upg</code>
| [[Advanced Dragoon]]
|-
| <code>level4</code>
| Stage 3
| [[Tyrant]]
|-
! rowspan="2" | Humans
| <code>rifle</code>
| rowspan="2" class="done" | Yes
| rowspan="2" | Stage 1
| [[Rifle]]
|-
| <code>ckit</code>
| [[Construction Kit]]
|-
|}

{{Note|content=
For the aliens, when at a higher stage, you may still spawn as a non-advanced variant of any particular class. For example, if you type

\class builder

you will spawn as a normal Granger even when the Advanced Granger is available.
}}

==Configuration commands==

===alias===
<tt>alias NAME COMMAND [PARAMETERS…]</tt>

Create an alias for the given command. The alias is then useable as a command in its own right.

===aliaslist===
Lists available command aliases.

===bind===
<tt>bind KEY [COMMAND…]</tt>
Binds a command (or sequence of commands) to the given key, or lists the bindings for that key.

All existing bindings on that key are lost.

===clearaliases===
Clears all command aliases.

===cycle===

===editbind===
<tt>editbind [TEAM] KEY</tt>

This inserts a <tt>/bind</tt> or <tt>/teambind</tt> command into the in-game console, ready for editing. The console is opened if needed.

<tt>TEAM</tt> is default, spectators, humans, or aliens. (Initial substrings are accepted.)

===irc_connect===
Start the ingame IRC client

===irc_quit===
Stop the ingame IRC client

===irc_say===
Say something in the desired IRC channel if connected to a server

===listrotation===
Lists the current map rotation. The current map is highlighted.

===loadgame===

===messagemode1===
This command opens a general chat prompt.

===messagemode2===
This command opens a team-chat prompt.

===messagemode3===
This command opens an admin chat prompt.

===messagemode4===
This command opens a chat prompt for the built-in IRC client.

===messagemodec===
This command opens a command prompt.

===modelist===

===teambind===
<tt>teambind TEAM KEY [COMMAND…]</tt>
Binds a command (or sequence of commands) to the given key for use when on the given team, or lists the binding for that key/team.

<tt>TEAM</tt> is default, spectators, humans, or aliens. (Initial substrings are accepted.)

===toggleConsole===
Opens or closes the in-game console.

===ui_restart===
Reloads UI files.

===unalias===
<tt>unalias NAME</tt>

Removes the named alias.

===unbind===
<tt>unbind [TEAM] KEY</tt>
Removes either all bindings for the given key, or the binding for the given team on that key.

<tt>TEAM</tt> is default, spectators, humans, or aliens. (Initial substrings are accepted.)

===undelay===

===undelayAll===

===unregister===
Removes registration of your GUID and name.

==Condition handling==

===if===
<tt>if VALUE CONDITION VALUE THEN [ELSE]</tt>

<tt>if MODIFIERS THEN [ELSE]</tt>

; <tt>VALUE</tt> : a variable or number
; <tt>CONDITION</tt> : comparison operator
; <tt>MODIFIERS</tt> : comma-separated list of keyboard modifiers: Shift, Ctrl, Alt, Command (or Cmd), Mode, Super. Prefix any which must not be pressed with <kbd>!</kbd>.
; <tt>THEN</tt> and <tt>ELSE</tt> : either a variable name or, if prefixed with <kbd>/</kbd> or <kbd>\</kbd>, a command string.

Recognised numeric comparison operators: 
<tt> = != < <= > >= !=</tt>

Recognised string comparison operators: 
<tt> eq ne in !in</tt>

Either the <tt>THEN</tt> clause or the <tt>ELSE</tt> clause (if present) will be executed. If it is a variable name, its content will be executed.

For example:

<pre>/if shift "/echo Hello" "/echo Goodbye"
/bind j "if \$team\$ eq aliens \"/class level1upg level1\""</pre>

(Note the escaping of the cvar <tt>team</tt>.)

===modcase===
<tt>modcase MODIFIERS THEN [MODIFIERS THEN]* [ELSE]</tt>

This works like <tt>if</tt>. The leftmost most-specific <tt>THEN</tt> whose modifier list matches is the one which is executed; if none match, then <tt>ELSE</tt> is executed if it is present.

For example:
<pre>/modcase shift "/echo 1" ctrl "/echo 2" shift,ctrl "/echo 3" shift,!alt "/echo 4"</pre>
works as follows:

# if Shift and Alt (due to clause 4) but not Ctrl (due to clause 3) are pressed;
# if Ctrl but not Shift (due to clause 3);
# if Shift and Ctrl;
# if Shift but neither Alt nor Ctrl.

===strcmp===
Compare the string values of two cvars. ''Obsolete.''

==Admin commands==

===allready===
Quickly move to the next map. Used only during the intermission.

===speclock===
Prevents a player from joining a team for a given time or until the end of the current game.
If necessary, the player is moved to spectators.

===specunlock===
Allows a player, previously locked, to join a team.

==Utility commands==

===calc===
Do math calculations on cvars. Store the value to a cvar Useful in making scripts.

===concat===
Concatenate 2 cvars into a third.

===delay===

===glsl_restart===
Development use. For recompiling the GLSL shader code.

===grep===
<tt>grep TEXT</tt>

Searches the in-game console for occurrences of <tt>TEXT</tt>. Matching lines are reprinted.

===help===

===math===
Do math on cvars. Useful for scripts.

===random===
Generate a random number

===reloadhud===
Reload the HUD without a vid_restart

===screenshotPNG===
Saves a screenshot in the PNG format.

===search===
<tt>search TEXT</tt>

Searches back through the in-game console for <tt>TEXT</tt> and scrolls to it.

===searchDown===
<tt>searchDown TEXT</tt>

Searches forward through the in-game console for <tt>TEXT</tt> and scrolls to it.

===snd_reload===
Reload sounds (includes a vid_restart

===wav_record===

===wav_stoprecord===

==Special uses==

For commands relevant to development and testing purposes, please see the [[Testing]] page.

===buildcubemaps===

===cache_endgather===

===cache_mapchange===

===cache_setindex===

===cache_startgather===

===cache_usedfile===

===fieldinfo===

===gameCompleteStatus===

===openurl===
Open a URL inside the OS's default browser.

===pubkey===
Internal use.

===pubkey_identify===
Internal use.

===setRecommended===

===shaderexp===

===spdevmap===
Does nothing.

===spmap===
Does nothing.

===updatehunkusage===

===updatescreen===

Creating custom keybinds

2013-10-04T16:59:58Z

Anomalous: Contents floated right

{| style="float: right"
| __TOC__
|}

{{StatusWIP|The information on this page is incomplete.}}

==Usage==

Some simple bindings can be made via the configuration menus.

For more complicated bindings and for team bindings, you need to use the console. For example, you could bind commands to set a team and to spawn:

bind F9 "team a"
bind F10 "team h"

// attacking players
teambind aliens F5 "class level0"
teambind humans F5 "class rifle"

// builders
teambind aliens F6 "class builderupg builder"
teambind humans F6 "class ckit"

==Differences from Tremulous==

A number of commands for keybinds have changed since Tremulous, so keybind configurations cannot be directly copied from Tremulous to Unvanquished.

{| class="wikitable"
! Tremulous || Unvanquished || Used for…
|-
| <code>+button2</code> || <code>+useitem</code> || Using an item; granger spit; dragoon barb
|-
| <code>+button3</code> || <code>+taunt</code> || “Come on!” etc.
|-
| <code>+button5</code> || <code>+attack2</code> || Secondary attack
|-
| <code>+button6</code> || <code>+dodge</code> || Dodging
|-
| <code>+button7</code> || <code>+activate</code> || Using a structure; evolving
|-
| <code>+button8</code> || <code>+sprint</code> || Sprinting
|-
|}

As of alpha 3, the <code>+button''N''</code> commands are no longer present.

You may want to bind the new [[Voice say system|vsays]] to different keys.
==Gameplay commands==

This is a partial list of commands added, using Tremulous GPP r2259 as a reference point. Not everything listed is actually useful.

{{note|content=The game handles <tt>+</tt>commands specially, in a way which has implications concerning usage.

There is one way to use them in bindings which works properly, and that's to use the command on its own.

It is possible to have other commands following one of these ''but'' this is not well handled – the game appends information about when the key was pressed but, at present, assumes that there's just one command present in the binding. It also causes problems on key-up when the <tt>+</tt>command is the first command since, while the it will (correctly) be converted to a <tt>-</tt>command, any following commands will be executed unmodifed, except for the last one (which gets the timing information).

If you need to use a binding which contains one of these with other commands then use something like “<samp>wait; +taunt; wait; -taunt</samp>”. Timing information will not be added; the server has information which allows it to calculate ‘close enough’ timing information, and there may be a knock-on effect on an immediately-following action.
}}

===+activate===
Access an armoury; evolve.

===+attack2===
Secondary attack.

===+dodge===
Low jump sideways or backwards. (Humans only.)

===+rally===
“Come on!” etc., as in ‘follow me’.

===+sprint===
Run. (Humans only.)

===+taunt===
“Come on!” etc., as in ‘bring it on!’.

===+useitem===
Use the highlighted item; tertiary attack (granger spit, dragoon snipe).

===buy===

(Changed in Alpha 15.) This command can take multiple parameters. It can also be used to sell items.

For example, if you want a sell-all bind, you would use “<samp>buy -all rifle</samp>” – this will get rid of all equipment and re-equip you with a rifle (though if you're building something, you won't lose your construction kit and consequently will not acquire a rifle).

===say_area_team===
Talk to all teammates within a server-set range.

===sell===

(Changed in Alpha 15.) This command can take multiple parameters.

===class===

This command behaves differently depending on which team you are on.

* As a human or alien, when dead, this command will cause you to spawn with the desired class or weapon, respectively.
* As an alien, this command will cause you to evolve to the class specified. You may not "evolve" into lower-level classes.

Note that regardless of when you invoke this command, an argument '''must''' be supplied or no result will occur.

The following arguments may be used:

{| class="wikitable progress"
|-
! Team
! Argument
! Spawnable?
! Availability
! Description
|-
! rowspan="10" | Aliens
| <code>builder</code>
| rowspan="2" class="done" | Yes
| rowspan="5" | Stage 1
| [[Granger]]
|-
| <code>level0</code>
| [[Dretch]]
|-
| <code>level1</code>
| rowspan="3" class="none" | No
| [[Basilisk]]
|-
| <code>level2</code>
| [[Marauder]]
|-
| <code>level3</code>
| [[Dragoon]]
|-
| <code>builderupg</code>
| class="done" | Yes
| rowspan="4" | Stage 2
| [[Advanced Granger]]
|-
| <code>level1upg</code>
| class="none" rowspan="4" | No
| [[Advanced Basilisk]]
|-
| <code>level2upg</code>
| [[Advanced Marauder]]
|-
| <code>level3upg</code>
| [[Advanced Dragoon]]
|-
| <code>level4</code>
| Stage 3
| [[Tyrant]]
|-
! rowspan="2" | Humans
| <code>rifle</code>
| rowspan="2" class="done" | Yes
| rowspan="2" | Stage 1
| [[Rifle]]
|-
| <code>ckit</code>
| [[Construction Kit]]
|-
|}

{{Note|content=
For the aliens, when at a higher stage, you may still spawn as a non-advanced variant of any particular class. For example, if you type

\class builder

you will spawn as a normal Granger even when the Advanced Granger is available.
}}

==Configuration commands==

===alias===
<tt>alias NAME COMMAND [PARAMETERS…]</tt>

Create an alias for the given command. The alias is then useable as a command in its own right.

===aliaslist===
Lists available command aliases.

===bind===
<tt>bind KEY [COMMAND…]</tt>
Binds a command (or sequence of commands) to the given key, or lists the bindings for that key.

All existing bindings on that key are lost.

===clearaliases===
Clears all command aliases.

===cycle===

===editbind===
<tt>editbind [TEAM] KEY</tt>

This inserts a <tt>/bind</tt> or <tt>/teambind</tt> command into the in-game console, ready for editing. The console is opened if needed.

<tt>TEAM</tt> is default, spectators, humans, or aliens. (Initial substrings are accepted.)

===irc_connect===
Start the ingame IRC client

===irc_quit===
Stop the ingame IRC client

===irc_say===
Say something in the desired IRC channel if connected to a server

===listrotation===
Lists the current map rotation. The current map is highlighted.

===loadgame===

===messagemode1===
This command opens a general chat prompt.

===messagemode2===
This command opens a team-chat prompt.

===messagemode3===
This command opens an admin chat prompt.

===messagemode4===
This command opens a chat prompt for the built-in IRC client.

===messagemodec===
This command opens a command prompt.

===modelist===

===teambind===
<tt>teambind TEAM KEY [COMMAND…]</tt>
Binds a command (or sequence of commands) to the given key for use when on the given team, or lists the binding for that key/team.

<tt>TEAM</tt> is default, spectators, humans, or aliens. (Initial substrings are accepted.)

===toggleConsole===
Opens or closes the in-game console.

===ui_restart===
Reloads UI files.

===unalias===
<tt>unalias NAME</tt>

Removes the named alias.

===unbind===
<tt>unbind [TEAM] KEY</tt>
Removes either all bindings for the given key, or the binding for the given team on that key.

<tt>TEAM</tt> is default, spectators, humans, or aliens. (Initial substrings are accepted.)

===undelay===

===undelayAll===

===unregister===
Removes registration of your GUID and name.

==Condition handling==

===if===
<tt>if VALUE CONDITION VALUE THEN [ELSE]</tt>

<tt>if MODIFIERS THEN [ELSE]</tt>

; <tt>VALUE</tt> : a variable or number
; <tt>CONDITION</tt> : comparison operator
; <tt>MODIFIERS</tt> : comma-separated list of keyboard modifiers: Shift, Ctrl, Alt, Command (or Cmd), Mode, Super. Prefix any which must not be pressed with <kbd>!</kbd>.
; <tt>THEN</tt> and <tt>ELSE</tt> : either a variable name or, if prefixed with <kbd>/</kbd> or <kbd>\</kbd>, a command string.

Recognised numeric comparison operators: 
<tt> = != < <= > >= !=</tt>

Recognised string comparison operators: 
<tt> eq ne in !in</tt>

Either the <tt>THEN</tt> clause or the <tt>ELSE</tt> clause (if present) will be executed. If it is a variable name, its content will be executed.

For example:

<pre>/if shift "/echo Hello" "/echo Goodbye"
/bind j "if \$team\$ eq aliens \"/class level1upg level1\""</pre>

(Note the escaping of the cvar <tt>team</tt>.)

===modcase===
<tt>modcase MODIFIERS THEN [MODIFIERS THEN]* [ELSE]</tt>

This works like <tt>if</tt>. The leftmost most-specific <tt>THEN</tt> whose modifier list matches is the one which is executed; if none match, then <tt>ELSE</tt> is executed if it is present.

For example:
<pre>/modcase shift "/echo 1" ctrl "/echo 2" shift,ctrl "/echo 3" shift,!alt "/echo 4"</pre>
works as follows:

# if Shift and Alt (due to clause 4) but not Ctrl (due to clause 3) are pressed;
# if Ctrl but not Shift (due to clause 3);
# if Shift and Ctrl;
# if Shift but neither Alt nor Ctrl.

===strcmp===
Compare the string values of two cvars. ''Obsolete.''

==Admin commands==

===allready===
Quickly move to the next map. Used only during the intermission.

===speclock===
Prevents a player from joining a team for a given time or until the end of the current game.
If necessary, the player is moved to spectators.

===specunlock===
Allows a player, previously locked, to join a team.

==Utility commands==

===calc===
Do math calculations on cvars. Store the value to a cvar Useful in making scripts.

===concat===
Concatenate 2 cvars into a third.

===delay===

===glsl_restart===
Development use. For recompiling the GLSL shader code.

===grep===
<tt>grep TEXT</tt>

Searches the in-game console for occurrences of <tt>TEXT</tt>. Matching lines are reprinted.

===help===

===math===
Do math on cvars. Useful for scripts.

===random===
Generate a random number

===reloadhud===
Reload the HUD without a vid_restart

===screenshotPNG===
Saves a screenshot in the PNG format.

===search===
<tt>search TEXT</tt>

Searches back through the in-game console for <tt>TEXT</tt> and scrolls to it.

===searchDown===
<tt>searchDown TEXT</tt>

Searches forward through the in-game console for <tt>TEXT</tt> and scrolls to it.

===snd_reload===
Reload sounds (includes a vid_restart

===wav_record===

===wav_stoprecord===

==Special uses==

For commands relevant to development and testing purposes, please see the [[Testing]] page.

===buildcubemaps===

===cache_endgather===

===cache_mapchange===

===cache_setindex===

===cache_startgather===

===cache_usedfile===

===fieldinfo===

===gameCompleteStatus===

===openurl===
Open a URL inside the OS's default browser.

===pubkey===
Internal use.

===pubkey_identify===
Internal use.

===setRecommended===

===shaderexp===

===spdevmap===
Does nothing.

===spmap===
Does nothing.

===updatehunkusage===

===updatescreen===

Tutorials/Exporting models

2013-07-30T14:50:05Z

Anomalous: Fix the animations table (somebody sorted it alphabetically) and bring it up to date for 0.18.

[[Category:Modeling]]
==Overview==

''Notice: This guide was written for the 2.6 series of Blender. Most of this guide should apply for other versions of Blender, but this is not guaranteed.''

Getting a finished model out of Blender and into the game is a relatively involved process with a number of possible pitfalls. This guide aims to describe the process in as much detail as possible to assist users who have not done it before, or those who have exported models for other games and would like to know what (if anything) is different.

If you would like to export from Maya, you may find the official [http://www.iddevnet.com/quake4/Animations id Software documentation] useful.

At present, this guide primarily describes the process for exporting models to the MD5 format. While the engine supports both MD3 and MD5, the latter is preferred. The reasons for this are discussed [[#What_is_MD5?|below]].

Before a model may be exported and used in-game, it must be adequately prepared: 

* [[#Limitations_of_the_engine|Engine limitations]] must be adhered to.
* The model must have a texture applied to it. This texture is not automagically applied to the model after it is exported and loaded in-game, this is only necessary to satisfy the MD5 exporter; that is, the game cannot read from the exported model the filename of the texture to use.
* The model must be a mesh and must have an armature modifier applied to it.
* The armature's bones all must have at least one keyframe.

The actual process of exporting a model is straightforward:

# After ensuring that the above requirements are met, the mesh itself is exported.
# If using the old exporter, each animation is exported separately. The new exporter adds support for [[#Batch_export_with_the_new_exporter|batch export]] of animations.
# A [[#Configuring_the_model|configuration file]] specifying data such as the bounding box size and vertical offset is written. This may include information that is specific to the particular type of model (i.e., buildable or player model).
# A [[#Writing_shaders|shader]] is written that determines how the model is textured in-game.
# Finally, after everything is properly named and configured, the files are [[Packaging_game_data|packaged]] and placed in the correct game data folder to allow it to be loaded in-game.

==What is MD5?==

MD5 is the model format created by id Software for Doom 3 which is also used by Unvanquished. It is an improvement over its predecessor, MD3, in that it uses bones to pose the model.

{{Note|header=What about MD3? IQM? PSK? ASE? Obj?|content=
{{SupportedModelFormats}}
}}

===Advantages over MD3===

* Unlike MD3, MD5 is bone-based, meaning that instead of storing an entire mesh for each frame of animation, there is only one mesh file. This single mesh file is deformed using a vertex shader.
* Because there is only one mesh, only one VBO (vertex buffer object) needs to be created for each MD5 model. The deformation is performed entirely on the GPU, so it is (theoretically) faster than MD3, and uses less memory.
* Because the format is in plain-text, it can be easily verified for sanity (i.e., to ensure that it was exported correctly and not corrupted in some way).

===Disadvantages over MD3===

* Some forms of motion are more difficult to achieve; certain animation techniques (such as lattices) are not usable.
* Because the format is in plain-text, it takes up more space than it needs to, though this is negligible and a MD5 model will typically be smaller than the same model in MD3 format as less data is used per each frame of animation with MD5 as compared to MD3.

===Limitations of the engine===

The engine places certain limitations on the fidelity of your models when using the MD5 format. These are:

* There may not be more than 128 bones. (Note: this was increased from 64.)
* There may not be more than 100,000 vertices.
* There may not be more than 10,000 triangles.
* No vertex may belong to more than four vertex groups (i.e., one vertex may not be controlled by more than four bones). An error message will be displayed in-game if this requirement is not met. A [[#.22R_LoadMD5:_vertex_.25i_requires_more_than_.25i_weights_on_surface_.28.25i.29_in_model_.27.25s.27.22|script]] may be used before exporting to check that this limitation is not exceeded.

{{Note|header=Developer Note|content=The limitation on vertex groups is a hard-coded limitation of the vertex shader ({{SourceFile|main/glsl/vertexSkinning_vp.glsl}}) that deforms the base mesh.}}

===Limitations of the format===

The MD5 format only supports bones. You may not

* Use lattices or any other means of deformation.
* Scale bones.
* Use keyframes on anything other than bone poses. You may, however, set keyframes on bone constraint influences or anything else that would affect a bone's position or rotation.

Note that you do not have to have a parent/child relationship between bones. In fact, in some instances, avoiding a parent/child relationship is necessary to achieve certain effects, such as moving bones around.

==Acquiring and installing the exporter==

===MD3===

If for some reason you are interested in the MD3 exporter, it is available from [http://sourceforge.net/projects/md3exporter/ SourceForge].

===MD5===

====Old exporter====

''Please be aware that there are numerous issues with the old exporter and the newer versions of Blender. See [[#All_or_part_of_the_mesh_appears_to_be_sucked_to_the_center|the troubleshooting section]] below for more information. It is strongly recommended that you use the [[#New_exporter|new exporter]] instead.''

You can download the exporter from [http://www.katsbits.com/smforum/index.php?topic=178.0 this thread on katsbits.com]. Installation instructions are in the thread.

====New exporter====

As of 15 May 2012, there is another MD5 exporter available for Blender 2.63+, available on [http://www.katsbits.com/smforum/index.php?topic=404.0 katsbits]. This has been found to be superior to the old exporter. Note that portions of this guide have not yet been updated to reflect the differences in the new exporter.

==Exporting the mesh==

===MD5===

Note that for buildables and weapons, the filename of the exported mesh is dictated by the corresponding [[#Configuring_the_model|configuration file]]. All player models, however, are hardcoded to look for <code>body.md5mesh</code>.

====Old exporter====

''Please be aware that there are numerous issues with the old exporter and the newer versions of Blender. See [[#All_or_part_of_the_mesh_appears_to_be_sucked_to_the_center|the troubleshooting section]] below for more information. It is strongly recommended that you use the [[#New_exporter|new exporter]] instead.''

# Select the armature and the mesh. The order in which you select the two does not matter.
# Click File → Export → Quake Model 5 (.md5)
# On the left shelf that appears in the file prompt, change the Exports combo box to "Mesh only." Don't worry about the scale or name fields.
# Click "Export MD5".

Once this has been completed, you must manually edit the mesh file (the one with a <code>.md5mesh</code> extension) to specify the correct shader to use.

<pre>
--- snip ---
mesh {
shader "models/buildables/medistat"

numverts 4
vert 0 ( 1.000000 0.000000 ) 0 1
vert 1 ( 0.000000 0.000000 ) 1 1
--- snip ---
</pre>

Note that <code>models/buildables/medistat</code> is '''not''' a file path to a shader; it is the name (again, not filename) of the shader to use. That is, a shader with the matching name will be used for this model.

To avoid having to do this every time you export the mesh, set the name of the material applied to the object in Blender to the same as you edited the md5mesh.

====New exporter====

* Select the mesh to export.
* Click File → Export → MD5 Mesh (.md5mesh).
* Specify the output filename in the dialog, and click "Export MD5MESH".

The exported model is not ready to be used in-game just yet; it must be manually edited. Open the exported <code>.md5mesh</code> file in a text editor, and manually delete the top three lines of the file (highlighted in red below):

// Parameters used during export:
// Reorient: True
// Scale: 1.0
MD5Version 10
commandline ""

numJoints 4
numMeshes 1

joints {

...

remainder of file omitted for brevity

Be sure to save the file when you are done. You will also have to do this for each animation file that you export.

If you do not want to have to do this each time, you can edit the exporter script. Open the <code>export_md5.py</code> script in the <code>io_scene_md5</code> folder where you installed the script, at around line 30, edit this code:

def record_parameters(correctionMatrix):
return [
"// Parameters used during export:\n",
"// Reorient: {}\n".format(bool(correctionMatrix.to_euler()[2])),
"// Scale: {}\n".format(correctionMatrix.decompose()[2][0])]

to look like this:

def record_parameters(correctionMatrix):
return []

If you are comfortable with applying patches, you may use this:

<pre>
@@ -27,10 +27,7 @@
return pairs

def record_parameters(correctionMatrix):
- return [
- "// Parameters used during export:\n",
- "// Reorient: {}\n".format(bool(correctionMatrix.to_euler()[2])),
- "// Scale: {}\n".format(correctionMatrix.decompose()[2][0])]
+ return []

def define_components(obj, bm, bones, correctionMatrix):
scaleFactor = correctionMatrix.to_scale()[0]
</pre>

Note that you will also have to manually set the shader as with the [[#Old_exporter_2|old exporter]].

==Exporting the animations==

===MD3===

Exported MD3 animations require a configuration file that specifies which frames of the animation correspond to which actions the game will display.

This varies slightly by the type (i.e., weapon or buildable) of model.

===MD5===

====Old exporter====

''Please be aware that there are numerous issues with the old exporter and the newer versions of Blender. See [[#All_or_part_of_the_mesh_appears_to_be_sucked_to_the_center|the troubleshooting section]] below for more information. It is strongly recommended that you use the [[#New_exporter|new exporter]] instead.''

The procedure for exporting animations is the same as for exporting the mesh with regard to selecting the mesh and the armature. Before using the exporter, however, you must be certain to set the start and end frames to encompass only the particular animation that you wish to export; each animation must be exported separately, unless the [[#New_exporter|new exporter]] is used, which adds a [[#Batch_export_with_the_new_exporter|batch export]] feature.

[[Image:Md5_export_timeline.png|frame|center|The timeline view in Blender, which is used to set which frames of animation to export. Here, only one frame of animation (frame 180) is being exported.]]

At the export file prompt, choose "Anim only." from the "Exports" combo box. Enter as the filename the name of the particular animation that you are exporting; the correct names to use are given below.

====Batch export with the new exporter====

The [[Exporting Models#Batch export|new exporter]] now supports batch export of models.

To make use of this feature, you must set [http://wiki.blender.org/index.php/Doc:2.6/Manual/Animation/Markers frame markers] denoting the start and end of each animation. The name of frame markers denoting the start of an animation must end in "_start" and markers denoting the end of an animation must end in "_end"; for example, frame markers denoting the start and end of a buildable's construct animation would be "construct_start" and "construct_end". Avoid using frame markers with duplicate names, as which one will be used by the exporter is not predictable. Note that frame markers may overlap however you please; this is useful when two animations share a frame or you would like to automate the process of exporting the same few frames of animation as several different animation files (e.g., for testing purposes).

All operations in modifying frame markers are performed in the [http://wiki.blender.org/index.php/Doc:2.6/Manual/Animation/Timeline timeline]:
* To create a frame marker, move the timeline to the desired frame and press M.
* To select a frame marker, click with the right mouse button.
* To move a frame marker, select it and press G.
* To delete a frame marker, select it and press X.
* To rename a frame marker, select it and press CtrlM.

The actual exportation process becomes much simpler:

# Click File → Export → MD5 (batch export).
# Specify the filename of the <code>.md5mesh</code> to export.

==Animation names==

The filenames for each exported animation must be what the engine expects for it to be able to load them, and vary depending on the format (MD3 or MD5) and type (e.g., buildable, weapon, or player) of model being exported.

===Weapons===

{{Note|header = Developer Note|disregardby = artists|content =
See the <code>CG_ParseWeaponFile()</code> function in {{SourceFile|src/gamelogic/cgame/cg_weapons.c}}</code>.

Weapon state constants are enumerated in the <code>weaponstate_t</code> enum in {{SourceFile|src/gamelogic/game/bg_public.h}}</code>:

{{{!}} class{{=}}"wikitable"
{{!}}-
! Constant
! Description
{{!}}-
{{!}} <code>WEAPON_READY</code>
{{!}} The weapon at its idle state, ready to fire.
{{!}}-
{{!}} <code>WEAPON_RAISING</code>
{{!}} The weapon as it is being raised. It may not be fired in this state.
{{!}}-
{{!}} <code>WEAPON_DROPPING</code>
{{!}} The weapon as it is being put away. It may not be fired in this state.
{{!}}-
{{!}} <code>WEAPON_FIRING</code>
{{!}} The weapon as it is being fired.
{{!}}-
{{!}} <code>WEAPON_RELOADING</code>
{{!}} The weapon as it is being reloaded.
{{!}}-
{{!}} <code>WEAPON_NEEDS_RESET</code>
{{!}} The Lucifer Cannon in its overcharged state.
{{!}}-
{{!}}}

Control of weapon states is done by <code>PM_Weapon()</code>, <code>PM_BeginWeaponChange()</code>, and <code>PM_FinishWeaponChange()</code> in {{SourceFile|src/gamelogic/game/bg_pmove.c}}</code>.
}}

Note that for both MD3 and MD5 models, there may be separate models for first- and third-person views. Please see "[[#Weapons|Configuring the model]]" for more information regarding how to specify separate models.

====MD3====

MD3 does not use separate files for separate animations. Instead, a configuration file specifies what frames of a single MD3 animation are used for each in-game animation.

''TODO: Find out how barrel spin is handled by the engine. Is it animated into the barrel model or is it done procedurally?''

In addition to the base weapon mesh, there may be as many as three additional MD3 meshes:

{| class="wikitable"
|-
! Search string
! Tag
! Description
|-
| <code>%s_flash.md3</code>
| <code>tag_flash</code>
| The weapon's muzzle flash.
|-
| <code>%s_barrel.md3</code>
| <code>tag_barrel</code>
| The weapon's barrel.
|-
| <code>%s_hand.md3</code>
| N/A
| Hands holding the weapon model. Note: this is not used for third person models.
|}

For non-programmers, the <code>%s</code> string is replaced by the parameter given to the <code>weaponModel</code> or <code>weaponModel3rdPerson</code> keyword.

The tag <code>tag_weapon</code> is used on the main weapon model to align the third person weapon model to the third person player model.

====MD5====

Note that each animation filename must have the <code>.md5anim</code> extension.

{| class="wikitable"
|-
! Animation name
! Engine constant
! Description
|-
| <code>%s_view_idle</code>
| <code>WANIM_IDLE</code>
| Animation played when a weapon is not being fired
|-
| <code>%s_view_lower</code>
| <code>WANIM_DROP</code>
| Animation played when a weapon is being put away
|-
| <code>%s_view_reload</code>
| <code>WANIM_RELOAD</code>
| Weapon reload animation
|-
| <code>%s_view_raise</code>
| <code>WANIM_RAISE</code>
| Animation played when a weapon is switched to
|-
| <code>%s_view_fire</code>
| <code>WANIM_ATTACK1</code>
| Default attack animation
|-
|
| <code>WANIM_ATTACK2</code>
| rowspan="7" | Usage of these is highly dependent on the player class. The marauder, for example, may randomly use one of these instead of <code>WANIM_ATTACK1</code>.1
|-
|
| <code>WANIM_ATTACK3</code>
|-
|
| <code>WANIM_ATTACK4</code>
|-
|
| <code>WANIM_ATTACK5</code>
|-
|
| <code>WANIM_ATTACK6</code>
|-
|
| <code>WANIM_ATTACK7</code>
|-
|
| <code>WANIM_ATTACK8</code>
|-
|}

# See <code>PM_Weapon()</code>.

===Buildables===

====MD3====

As always, MD3 buildable models require a separate configuration file that specifies which frames of the animation correspond to actions displayed by the game.

{{Note|header = Developer Note|disregardby = artists|content =
This file is parsed by <code>CG_ParseBuildableAnimationFile()</code> in {{SourceFile|src/gamelogic/cgame/cg_buildable.c}}.
}}

Each line in the configuration file corresponds to a single animation. Those animations are in the same order as in the table for MD5 animation names below.

The order that animations appear in the configuration file must match this order exactly. Animations may not be omitted.

The syntax is as follows:

<var>firstFrame</var> <var>numFrames</var> [<var>loopFrames</var> [<var>fps</var>]]

* <var>firstFrame</var> — Specifies the initial frame of the animation.
* <var>numFrames</var> — Specifies the number of frames following the initial frame that comprise that animation.
* <var>loopFrames</var> — (''Optional'')
* <var>fps</var> — (''Optional, may only be used if loopFrames is specified'') Specifies the framerate of the animation. If not specified, defaults to 1.

C and C++ style comments (i.e., <code>//</code> and <code>/* */</code>) are permitted past the last argument.

====MD5====

As with weapon animations, each animation filename must have the <code>.md5anim</code> extension.

{{Note|header = Developer Note|disregardby = artists|content =
These animation constants are in the <code>buildableAnimNumber_t</code> enumeration in {{SourceFile|src/gamelogic/game/bg_public.c}}. Animations are set using the <code>G_SetIdleBuildableAnim()</code> and <code>G_SetBuildableAnim()</code> functions. All animations are in entity behavior functions in {{SourceFile|src/gamelogic/game/g_buildable.c}}.

Sounds for animations are enumerated in the <code>cg_buildableSoundNames</code> array in {{SourceFile|src/gamelogic/game/bg_public.h}}. Which animations are loaded is defined in
}}


{| class="wikitable"
|-
! Animation name
! Engine constant
! Used by
! Description
|-
| <code>idle</code>
| <code>BANIM_IDLE1</code>
| All
| Idle animation, shown when the buildable is not doing anything (and in the case of human buildables, when they are also powered). Used in place of other animations if they are missing unless otherwise noted.
|-
| <code>idle2</code>
| <code>BANIM_IDLE2</code>
| Medistation, telenode, barricade, egg
| ‘Active’ idle state, e.g. while the medistation is currently healing (and not transitioning into or out of the healing state).
|-
| <code>powerdown</code>
| <code>BANIM_POWERDOWN</code>
| Human buildables, (barricade)
| Animation played when a buildable has just lost power.
|-
| <code>idle_unpowered</code>
| <code>BANIM_IDLE_UNPOWERED</code>
| Human buildables, (barricade)
| Idle animation played when a buildable has no power. ''(Formerly <code>idle3</code>.)''
|-
| <code>construct</code>
| <code>BANIM_CONSTRUCT1</code>
| All
| Construction animation, shown when the buildable is being built.
|-
| <code>construct2</code>
| <code>BANIM_CONSTRUCT2</code>
| Medistation, (telenode), (egg)
| Animation played when returning to the primary idle state, e.g. medistation transitioning from healing.
|-
| <code>attack</code>
| <code>BANIM_ATTACK1</code>
| All (except tesla)
| Animation played when a buidlable is attacking or transitioning to its ‘active’ idle state. For the barricade, the animation when it is shrinking.
|-
| <code>attack2</code>
| <code>BANIM_ATTACK2</code>
| (Medistation), (telenode), barricade, (egg)
| Unshrink animation for the barricade. (Falls back on <code>BANIM_ATTACK1</code>.)
|-
| <code>spawn</code>
| <code>BANIM_SPAWN1</code>
| Telenode, Egg
| Animation for when when someone is spawning from a telenode or egg.
|-
| <code>spawn2</code>
| <code>BANIM_SPAWN2</code>
| Currently unused.
|
|-
| <code>pain</code>
| <code>BANIM_PAIN1</code>
| All
| Default pain animation, used when a buildable is damaged.
|-
| <code>pain2</code>
| <code>BANIM_PAIN2</code>
| (Medistation), barricade, (egg)
| Pain animation used for the barricade when it is damaged and shrunk. (Falls back on <code>BANIM_PAIN1</code>.)
|-
| <code>destroy</code>
| <code>BANIM_DESTROY1</code>
| All
| Played when a buildable is killed or destroyed.
|-
| <code>destroy_unpowered</code>
| <code>BANIM_DESTROY_UNPOWERED</code>
| Human buildings, barricade
| Played when an unpowered buildable is killed or destroyed. (Falls back on <code>BANIM_DESTROY1</code>.)
|-
| <code>destroyed</code>
| <code>BANIM_DESTROYED</code>
| All
| The animation played after the buildable's destroy animation finishes playing but before it blows up; essentially, the buildable in a dead state. For the barricade, this is the same animation as for its shrunk state.
|-
|}

''Note: buildables whose names are in (parentheses) may not actually use the animation, but it is possible that at some point they will. However, the animations are loaded.''

===Player models===

====MD5====

As with weapon animations, each animation filename must have the <code>.md5anim</code> extension.

Items in italics need to be double-checked.

Note that at present, some of these strings do not match the constants.

{| class="wikitable"
|-
! colspan="3" | Animation name
! colspan="2" | Engine constant
! rowspan="2" | Humans?
! rowspan="2" | Aliens?
! rowspan="2" | Description
|-
! Assumed Correct
! Actual (Humans)
! Actual (Aliens)
! Humans
! Aliens
|-
| <code>attack</code> 
| <code>attack</code>
| <code>attack</code>
| <code>TORSO_ATTACK</code>
| <code>NSPA_ATTACK1</code>
| style="background:#3c9e2d;color:#fff;" | Yes
| style="background:#3c9e2d;color:#fff;" | Yes
|
|-
| <code>attack2</code> 
| <code>idle</code>
| <code>attack2</code>
| <code>TORSO_ATTACK2</code>
| <code>NSPA_ATTACK2</code>
| style="background:#3c9e2d;color:#fff;" | Yes
| style="background:#3c9e2d;color:#fff;" | Yes
|
|-
| <code>attack3</code> 
| <code>attack3</code>
| <code>attack3</code>
| N/A
| <code>NSPA_ATTACK3</code>
| style="background:#ff1a1d;color:#fff;" | No
| style="background:#3c9e2d;color:#fff;" | Yes
|
|-
| <code>charge</code> 
| N/A
| <code>charge</code>
| N/A
| <code>NSPA_CHARGE</code>
| style="background:#ff1a1d;color:#fff;" | No
| style="background:#3c9e2d;color:#fff;" | Yes
| Tyrant charge animation
|-
| <code>crouch</code> 
| <code>crouch</code>
| N/A
| <code>LEGS_IDLECR</code>
| N/A
| style="background:#3c9e2d;color:#fff;" | Yes
| style="background:#ff1a1d;color:#fff;" | No
|
|-
| <code>crouch_backward</code> 
| <code>crouch_forward</code>
| N/A
| <code>LEGS_BACKCR</code>
| N/A
| style="background:#3c9e2d;color:#fff;" | Yes
| style="background:#ff1a1d;color:#fff;" | No
|
|-
| <code>crouch_forward</code> 
| <code>crouch_forward</code>
| N/A
| <code>LEGS_WALKCR</code>
| N/A
| style="background:#3c9e2d;color:#fff;" | Yes
| style="background:#ff1a1d;color:#fff;" | No
|
|-
| <code>die</code> 
| <code>die</code>
| <code>die</code>
| <code>BOTH_DEATH1</code>
| <code>NSPA_DEATH1</code>
| style="background:#3c9e2d;color:#fff;" | Yes
| style="background:#3c9e2d;color:#fff;" | Yes
|
|-
| <code>gesture</code> 
| <code>gesture</code>
| <code>gesture</code>
| <code>TORSO_GESTURE</code>
| <code>NSPA_GESTURE</code>
| style="background:#3c9e2d;color:#fff;" | Yes
| style="background:#3c9e2d;color:#fff;" | Yes
|
|-
| <code>idle</code> 
| <code>idle</code>
| N/A
| <code>LEGS_IDLE</code>
| N/A
| style="background:#3c9e2d;color:#fff;" | Yes
| style="background:#ff1a1d;color:#fff;" | No
| Human idle animation. It seems as though NSPA_STAND ("stand") is used as the idle animation for aliens.
|-
| <code>jump</code> 
| <code>jump</code>
| <code>jump</code>
| <code>LEGS_JUMP</code>
| <code>NSPA_JUMP</code>
| style="background:#3c9e2d;color:#fff;" | Yes
| style="background:#3c9e2d;color:#fff;" | Yes
|
|-
| <code>jump_back</code> 
| <code>jump</code>
| <code>jump_back</code>
| <code>LEGS_JUMPB</code>
| <code>NSPA_JUMPBACK</code>
| style="background:#3c9e2d;color:#fff;" | Yes
| style="background:#3c9e2d;color:#fff;" | Yes
| Evidently although humans have a separate constant for jumping backwards, they use the same animation file as for jumping forwards.
|-
| <code>land</code> 
| <code>land</code>
| <code>land</code>
| <code>LEGS_LAND</code>
| <code>NSPA_LAND</code>
| style="background:#3c9e2d;color:#fff;" | Yes
| style="background:#3c9e2d;color:#fff;" | Yes
|
|-
| <code>land_back</code> 
| <code>land</code>
| <code>land_back</code>
| <code>LEGS_LANDB</code>
| <code>NSPA_LANDBACK</code>
| style="background:#3c9e2d;color:#fff;" | Yes
| style="background:#3c9e2d;color:#fff;" | Yes
| Like with jumping, humans evidently use the same animation for both LEGS_LAND and LEGS_LANDB.
|-
| <code>pain1</code> 
| N/A
| <code>pain1</code>
| N/A
| <code>NSPA_PAIN1</code>
| style="background:#ff1a1d;color:#fff;" | No
| style="background:#3c9e2d;color:#fff;" | Yes
| Humans evidently do not have a pain animation?
|-
| <code>pain2</code> 
| N/A
| <code>pain2</code>
| N/A
| <code>NSPA_PAIN2</code>
| style="background:#ff1a1d;color:#fff;" | No
| style="background:#3c9e2d;color:#fff;" | Yes
|
|-
| <code>run</code> 
| <code>run</code>
| <code>run</code>
| <code>LEGS_RUN</code>
| <code>NSPA_RUN</code>
| style="background:#3c9e2d;color:#fff;" | Yes
| style="background:#3c9e2d;color:#fff;" | Yes
|
|-
| <code>run_backwards</code> 
| <code>run</code> (?)
| <code>run_backwards</code>
| <code>LEGS_BACK</code>
| <code>NSPA_RUNBACK</code>
| style="background:#3c9e2d;color:#fff;" | Yes
| style="background:#3c9e2d;color:#fff;" | Yes
| Note: Not sure if this is correct for the humans
|-
| <code>run_left</code> 
| N/A
| <code>run_left</code>
| N/A
| <code>NSPA_RUNLEFT</code>
| style="background:#ff1a1d;color:#fff;" | No
| style="background:#3c9e2d;color:#fff;" | Yes
|
|-
| <code>run_right</code> 
| N/A
| <code>run_right</code>
| N/A
| <code>NSPA_RUNLEFT</code>
| style="background:#ff1a1d;color:#fff;" | No
| style="background:#3c9e2d;color:#fff;" | Yes
|
|-
| <code>stand</code> 
| <code>?</code>
| <code>stand</code>
| <code></code>
| <code>NSPA_STAND</code>
| ''No''
| style="background:#3c9e2d;color:#fff;" | Yes
| TORSO_STAND is in the code, but I didn't see an animation loaded for the humans
|-
| <code>stand2</code> 
| <code>idle</code>
| <code></code>
| <code>TORSO_STAND2</code>
| <code></code>
| style="background:#3c9e2d;color:#fff;" | Yes
| ''No''
|
|-
| <code>step</code>
| <code>step</code>
| <code></code>
| <code>LEGS_TURN</code>?
| <code></code>
| style="background:#3c9e2d;color:#fff;" | Yes
| ''No''
|
|-
| <code>swim</code> 
| <code>swim</code>
| <code>swim</code>
| <code>LEGS_SWIM</code>
| <code>NSPA_SWIM</code>
| style="background:#3c9e2d;color:#fff;" | Yes
| style="background:#3c9e2d;color:#fff;" | Yes
|
|-
| <code>turn</code>
| <code>step</code>
| <code></code>
| <code>LEGS_TURN</code>
| <code></code>
| style="background:#ff1a1d;color:#fff;" | No
| style="background:#3c9e2d;color:#fff;" | Yes
|
|-
| <code>walk</code> 
| <code>walk</code>
| <code>walk</code>
| <code>LEGS_WALK</code>
| <code>NSPA_WALK</code>
| style="background:#3c9e2d;color:#fff;" | Yes
| style="background:#3c9e2d;color:#fff;" | Yes
|
|-
| <code>walk_backwards</code> 
| <code>walk</code>
| <code>walk_backwards</code>
| <code>LEGS_BACKWALK</code>
| <code>NSPA_WALKBACK</code>
| style="background:#3c9e2d;color:#fff;" | Yes
| style="background:#3c9e2d;color:#fff;" | Yes
|
|-
| <code>walk_left</code> 
| N/A
| <code>walk_left</code>
| N/A
| <code>NSPA_WALKLEFT</code>
| style="background:#ff1a1d;color:#fff;" | No
| style="background:#3c9e2d;color:#fff;" | Yes
|
|-
| <code>walk_right</code> 
| N/A
| <code>walk_right</code>
| N/A
| <code>NSPA_WALKLEFT</code>
| style="background:#ff1a1d;color:#fff;" | No
| style="background:#3c9e2d;color:#fff;" | Yes
|
|-
|}



==Writing shaders==

As was implied before, the texture(s) used by a model are not stored in the md5mesh or md5anim files; they are specified by a separate shader file that is placed in the <code>scripts/</code> directory.

Shaders are a very large topic and are outside the scope of this guide. The [http://tremap.xtr3m.net/__Games/Xreal/Manual_Shader_1/ShaderManual.htm XReal shader guide] explains shaders in detail. However, the following shader should do for most purposes:

<pre>
models/buildables/trapper
{
diffuseMap models/buildables/trapper/trapper.tga
bumpMap models/buildables/trapper/trapper_n.tga
specularMap models/buildables/trapper/trapper_s.tga
}
</pre>

Do take note that
* <code>models/buildables/trapper</code> is NOT a path, it is merely a string that matches the shader specified by the <code>.md5mesh</code>, and
* <code>bumpMap</code> actually refers to a normal map.

==Configuring the model==

Aside from the textures used by a model, the scale, vertical position, and bounding box size of the model must be specified. This is done with a configuration file. These were formerly placed in <code>overrides/buildables/</code> (for buildables) or <code>overrides/classes/</code> (for player models), but are now placed in <code>configs/</code>.

===Player models===

{{Note|header = Developer Note|disregardby = artists|content =
Reading the configuration file for player models is handled by the <code>CG_ParseCharacterFile()</code> function in {{SourceFile|src/gamelogic/cgame/cg_players.c}}</code>.
}}

The configuration file may use the following keywords:

''Note: this list is incomplete''

<ul>
<li><code>headoffset <var>x</var> <var>y</var> <var>z</var></code></li>
<li><code>sex <var>gender</var></code>

Sets the gender of the model. Options are <code>f</code> for female or <code>n</code> for neuter. Any other character is interpreted as male.

</li>
<li><code>fixedlegs</code></li>
<li><code>fixedtorso</code></li>
<li><code>firstTorsoBoneName</code></li>
<li><code>footsteps</code>

* <code>default</code>
* <code>flesh</code>
* <code>metal</code>
* <code>splash</code>
* <code>none</code>

</li>
<li><code>lastTorsoBoneName</code></li>
<li><code>torsoControlBoneName</code></li>
<li><code>neckControlBoneName</code></li>
<li><code>modelScale</code></li>
</ul>

As an example:

<pre>
name "Basilisk"
model level1
modelScale 1.0
skin default
shadowScale 1.0
hud alien_general_hud
mins -18 -18 -18
maxs 18 18 18
crouchMaxs 18 18 18
deadMins -18 -18 -4
deadMaxs 18 18 4
zOffset 0.0
</pre>

===Weapons===

{{Note|header = Developer Note|disregardby = artists|content =
Weapon configuration files are parsed with <code>CG_ParseWeaponConfig()</code> function in {{SourceFile|src/gamelogic/cgame/cg_weapons.c}}</code>.
}}

The configuration file may use the following keywords:

<ul>
<li><code>weaponModel <var>path</var></code></li>
<li><code>weaponModel3rdPerson <var>path</var></code></li>
<li><code>idleSound <var>path</var></code></li>
<li><code>icon <var>path</var></code> — The relative path to the icon that is displayed in the HUD for that weapon.</li>
<li><code>crosshair <var>path</var></code></li>
<li><code>disableIn3rdPerson</code></li>
</ul>

After those keywords, one of the following keywords must be used, followed by an opening curly brace (<code>{</code>), more commands, and a final closing curly brace (<code>}</code>):

* <code>primary</code> (engine constant: <code>WPM_PRIMARY</code>)
* <code>secondary</code> (engine constant: <code>WPM_SECONDARY</code>)
* <code>tertiary</code> (engine constant: <code>WPM_TERTIARY</code>)

The configuration between the curly braces is handled by <code>CG_ParseWeaponModeSection</code>, in the same file. It accepts the following keywords:

<ul>
<li><code>missileModel <var>path</var></code></li>
<li><code>missileSprite <var>size</var> <var>shader</var></code>
* <var>size</var> — The size of the missile sprite. If this value is negative, it is made zero.
* <var>shader</var> — The shader describing the missile sprite.
</li>
<li><code>missileRotates</code></li>
<li><code>missileAnimates <var>startFrame</var> <var>numFrames</var> <var>frameRate</var> <var>looping</var></code></li>
<li><code>missileParticleSystem <var>name</var></code></li>
<li><code>missileTrailSystem <var>name</var></code></li>
<li><code>muzzleParticleSystem <var>name</var></code></li>
<li><code>impactParticleSystem <var>name</var></code></li>
<li><code>impactMark <var>size</var> <var>shader</var></code></li>
<li><code>impactSound <var>index</var> <var>path</var></code>
* <var>index</var> — The index of the sound file, clamped to the range [0,3]; up to four impact sounds may be defined with this keyword.
* <var>path</var> — The file path of the sound file to use.
</li>
<li><code>impactFleshSound <var>index</var> <var>path</var></code>
* <var>index</var> — The index of the sound file, clamped to the range [0,3]; up to four impact sounds may be defined with this keyword.
* <var>path</var> — The file path of the sound file to use.
</li>
<li><code>alwaysImpact</code></li>
<li><code>flashDLightColor <var>red</var> <var>green</var> <var>blue</var></code>
Specifies the color of the muzzle flash  dynamic lighting.
* <var>red</var> — The red color component as a floating point number in the range [0,1].
* <var>green</var> — The green color component as a floating point number in the range [0,1].
* <var>blue</var> — The blue color component as a floating point number in the range [0,1].
</li>
<li><code>continuousFlash</code></li>
<li><code>missileDlightColor <var>red</var> <var>green</var> <var>blue</var></code>
* <var>red</var> — The red color component as a floating point number in the range [0,1].
* <var>green</var> — The green color component as a floating point number in the range [0,1].
* <var>blue</var> — The blue color component as a floating point number in the range [0,1].
</li>
<li><code>missileDlight <var>size</var></code>
* <var>size</var> — If this value is negative, it is made zero.
</li>
<li><code>firingSound <var>path</var></code></li>
<li><code>missileSound <var>path</var></code></li>
<li><code>flashSound <var>index</var> <var>path</var></code>
* <var>index</var> — The index of the sound file, clamped to the range [0,3]; up to four impact sounds may be defined with this keyword.
* <var>path</var> — The file path of the sound file to use.
</li>
</ul>

As an example, this is the configuration for the chaingun (<code>models/weapons/chaingun/weapon.cfg</code>):

<pre>
weaponModel models/weapons/chaingun/chaingun.md3

icon icons/iconw_chaingun
crosshair 48 gfx/2d/crosshair-chaingun_s

primary
{
flashDlightColor 1.0 1.0 0.0
flashSound 0 models/weapons/chaingun/flash0.wav
flashSound 1 models/weapons/chaingun/flash1.wav
flashSound 2 models/weapons/chaingun/flash2.wav
flashSound 3 models/weapons/chaingun/flash3.wav

impactMark 8 gfx/marks/bullet_mrk

impactSound 0 models/weapons/chaingun/impact0.wav

impactParticleSystem models/weapons/rifle/impactPS
muzzleParticleSystem models/weapons/chaingun/muzzlePS
}
</pre>

===Buildables===

{{Note|header = Developer Note|disregardby = artists|content =
Reading the configuration file for buildables is handled by the <code>BG_ParseBuildableFile()</code> function in {{SourceFile|src/gamelogic/game/bg_misc.c}}</code>.
}}

The configuration file may use the following keywords:

<ul>
<li><code>model <var>index</var> <var>path</var></code>
* <var>index</var> Some models may actually have several different model files (not sure why); this argument specifies which. Clamped to the range [0,3] (which should actually be [0, MAX_BUILDABLE_MODELS]), which means that you may use as many as four models per buildable. This is only used by the machine gun turret, which is composed of different parts.
* <var>path</var> The file path where the model file is located. Note that for MD5 models, an extension of <code>.md3</code> is still to be used; it will automatically be changed by the engine.
</li>
<li><code>modelScale <var>scale</var></code>
Scales the model linearly.
</li>
<li><code>mins <var>minX</var> <var>minY</var> <var>minZ</var></code>
The coordinates passed to this and <code>maxs</code> define the bounding box for the model that is used for collision. The bounding box is always aligned to the global coordinate axes regardless of the orientation of the model, which is something to keep in mind when defining these values. You will likely have to debug these values by enabling drawing the bounding boxes. Load a map in developer mode with <code>\devmap</code> and set <code>\cg_drawBBOX</code> to 1. The three arguments combined form the coordinate of one corner of the bounding box, and <code>maxs</code> the opposite corner.
</li>
<li><code>maxs <var>minX</var> <var>minY</var> <var>minZ</var></code>
Defines the opposite corner of the AABB. (See above.)
</li>
<li><code>zOffset <var>offset</var></code>
Sets the vertical offset of the model; in other words, how far off the ground it is.
* <var>offset</var> The offset as a floating point (decimal) value.
</li>
</ul>

As an example:

<pre>
model 0 models/buildables/trapper/trapper.md3
modelScale 0.8
mins -15 -15 -15
maxs 15 15 15
zOffset -15
</pre>

Note that at present, you do not have to change the filename extension of the model to match what it actually is; that is, if the model is actually an md5, you may leave the extension as ".md3" and not ".md5mesh" or whatever.

==Directory overview==

This section provides an overview of the subset of the directory structure used by models; directories used for other purposes have been omitted.

* <code>armor/</code> Location of configurations for the three armor types (i.e., light, helmet, and battlesuit). You should not have to edit these.
* <code>configs/</code> Location of configuration files for various models.
** <code>buildables/</code>
* <code>scripts/</code>
* <code>gfx/</code> Location of various 2d effect textures, such as those used for weapons.
** ''Subdirectories omitted for brevity''
* <code>models/</code>
** <code>ammo/</code>
*** <code>tesla/</code> Contains a single image used for the tesla sparks. Not sure why it's located here.
** <code>buildables/</code>
*** <code>acid_tube/</code> Acid tube
*** <code>arm/</code> Armory
*** <code>barricade/</code> Barricade
*** <code>booster/</code> Booster
*** <code>dcc/</code> Defense Computer
*** <code>eggpod/</code> Egg
*** <code>hive/</code> Hive
*** <code>hovel/</code> Hovel
*** <code>medistat/</code> Medistation
*** <code>mgturret/</code> Machinegun Turret
*** <code>overmind/</code> Overmind
*** <code>reactor/</code> Reactor
*** <code>repeater/</code> Repeater
*** <code>telenode/</code> Telenode
*** <code>tesla/</code> Tesla generator
*** <code>trapper/</code> Trapper
** <code>players/</code>
*** <code>builder/</code> Human builder model.
*** <code>human_base/</code> Unarmored human model. Also includes the jetpack and battery pack.
*** <code>human_bsuit/</code> Battlesuit model.
*** <code>level0/</code> Dretch.
*** <code>level1/</code> Basilisk and advanced basilisk. (The advanced basilisk uses the same model as the regular dragoon, but a different texture.)
*** <code>level2/</code> Marauder and advanced marauder. (Same as basilisk with regard to advanced model.)
*** <code>level3/</code> Dragoon and advanced dragoon. (Same as basilisk with regard to advanced model.)
*** <code>level4/</code> Tyrant.
** <code>weapons/</code>
*** <code>abuild/</code> As there is no weapon model for the granger, the only thing in this directory is a config to hide the (nonexistant) weapon model in third person (a hack, I guess).
*** <code>abuildupg/</code> Advanced granger weapon. Same as above, except the config file specifies sounds for the attack sounds (which are also located in this directory).
*** <code>ackit/</code> Advanced construction kit.
*** <code>blaster/</code> Blaster.
*** <code>chaingun/</code> Chaingun.
*** <code>ckit/</code> Construction kit.
*** <code>flamer/</code> Flamethrower.
*** <code>grenade/</code> Grenade.
*** <code>hive/</code> Sprites, configuration file, and sound file for the hive.
*** <code>lcannon/</code> Lucifer cannon.
*** <code>level0/</code> Dretch configuration and attack sound file.
*** <code>level1/</code> Basilisk configuration and attack sound files (hit and miss).
*** <code>level1upg/</code> Advanced Basilisk configuration and added gas attack sound file.
*** <code>level2/</code> Marauder configuration and attack sound files (hit and miss).
*** <code>level2upg/</code> Advanced Marauder configuration and added electric attack sound file.
*** <code>level3/</code> Dragoon configuration and attack sound files (hit, miss, and pounce).
*** <code>level3upg/</code> Advanced Dragoon configuration and added barb sound files and model.
*** <code>level4/</code> Tyrant configuration and attack sound files (hit and miss).
*** <code>lgun/</code> Lasgun
*** <code>lockblob/</code>
*** <code>mdriver/</code> Mass Driver
*** <code>mgturret/</code> Machinegun turret '''''FIXME: why does this show up twice?'''''
*** <code>prifle/</code> Plasma rifle
*** <code>psaw/</code> Painsaw
*** <code>rifle/</code> Rifle
*** <code>shells/</code>
*** <code>shotgun/</code> Shotgun
*** <code>teslagen/</code> Tesla generator '''''FIXME: why does this show up twice?'''''
* <code>overrides/</code> Depreciated directory for model configuration files. Use <code>configs/</code> instead.
** <code>buildables/</code> Depreceated location for buildable model configs.
** <code>classes/</code> Depreceated location for character model configs.
* <code>scripts/</code> Location for shaders.

==Getting the model in game==

There are two approaches to test your model in-game. The model and related files may be in actual folders, or the engine can load them from a <code>.pk3</code> (package) file, which is really just a zip-compressed archive with the extension changed. The process for creating these archives is discussed on the [[packaging game data]] page.

==Testing the model==

Once you have the model exported, the shader and configuration written, and everything packaged into a .pk3 file and in place, you are ready to test.

===Testing externally===

Rather than testing the exported model in-game, you may also test the model with a stand-alone MD5 viewer. At present, there is a viewer for Windows available [http://www.katsbits.com/files/md5/modelviewer_0.93a.zip here].

===Testing in game===

See the [[testing]] page.

==Troubleshooting==

===Old exporter===

''Please be aware that there are numerous issues with the old exporter and the newer versions of Blender. See [[#All_or_part_of_the_mesh_appears_to_be_sucked_to_the_center|the troubleshooting section]] below for more information. It is strongly recommended that you use the [[#New_exporter|new exporter]] instead.''

====Error while exporting from Blender====

{| class="wikitable"
|-
| [[Image:Md5_export_error_no_armature.png]]
| style="vertical-align:top;" | This error displays when the selected object does not have an armature modifier. Any object exported as an md5 needs bones, even if it is static. If you are unsure of how to create a static object with md5, just add an armature, set the playback start and end frame to 1, and add a location or rotation keyframe at frame 1.
|-
| [[Image:Md5_export_error_no_animation.png]]
| style="vertical-align:top;" | This error displays when there are no keyframes. Follow the abov instructions for exporting a static object with md5.
|-
| [[Image:Md5_export_error_no_material.png]]
| style="vertical-align:top;" | This error displays when the object does not have a material applied to it. This is required by the script, even though it really does not affect the exported result.
|-
|}

===Appearance problems in-game===

====All or part of the mesh appears to be sucked to the center====

''Please note that as of 2012-02-27, the MD5 exporter does not work properly in several more recent versions of Blender. Use Blender 2.59 until this is fixed. See [http://www.katsbits.com/smforum/index.php?topic=167.msg2135#msg2135 the MD5 exporter thread] for more information.''

This can happen for a number of reasons:
<ul>
<li>There are vertices without weights.
''Solution'': apply weights to vertices that do not have them. If those verts are not to be animated, weight them to a bone that does not move.
</li>
<li>You are using Blender 2.61 and you have bones that have animated positions.
''Solution'': Use an earlier version of blender until this is fixed in the exporter.
</li>
<li>You are using Blender 2.62 and you have bones that are not located at the origin and do not have a parent or have animated positions.
''Solution'': Again, use an earlier version of blender until this is fixed in the exporter.
</li>
</ul>

==="R_LoadMD5: vertex %i requires more than %i weights on surface (%i) in model '%s'"===

This error is displayed in the console in game when a vertex belongs to too many groups.

You can use this script to check your model for this before exporting:

<pre>
# Copyright 2012 Nicholas De Cicco. <velociostrich@gmail.com>
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

import bpy, math
from bpy.props import *

MAX_GROUPS_PER_VERT = 4

# Switch to object mode for vertex selection to work
bpy.ops.object.mode_set(mode='OBJECT')

for obj in bpy.context.selected_objects:
# Check to see that the object is a mesh.
if obj.type != 'MESH':
continue

# Select verts that belong to too many groups
for vertex in obj.data.vertices:
if len(vertex.groups) > MAX_GROUPS_PER_VERT:
vertex.select = True
else:
vertex.select = False

# Switch back to edit mode so the user can see any selected verts
bpy.ops.object.mode_set(mode='EDIT')
</pre>

====Using the Script====

# Select the mesh (or meshes) that you would like to check.
# Create a new text editor window and text data block.
# Copy and paste the script into the text editor.
# Click "Run Script".

Once the script has ran, the 3d view will switch to edit mode and any offending vertices will be selected. A handy tip: clicking an individual vertex will reveal which groups it is a member of in the properties shelf.

[[Image:Properties_shelf_vertex_groups.png|frame|center|The vertex group section of the properties shelf]]

==Resources==

* [http://www.modwiki.net/wiki/MD5_%28file_format%29 MD5 file format documentation]
* [http://www.katsbits.com/tools/# Tools for MD5 and other file formats]
* [http://download.blender.org/release/ Older versions of Blender]

Machinegun Turret

2013-06-23T03:32:16Z

Anomalous:

{{MPBuildable
| name = Machinegun Turret
| image = mgturret_render_300x240.png
| caption = 3×7.62 millimeters of DEAAAAAAAAAATH
| health = 190
| cost = 8
| attack = Bullets
}}
The Machinegun Turret (a.k.a. Ret) is a sentry gun used to ward off alien hordes.

It has a minor delay time and fires bullets at oncoming aliens dealing small damage.

Defence Computer

2013-06-23T03:25:28Z

Anomalous: Redirected page to Defense Computer

#REDIRECT [[Defense Computer]]

Tutorials/Minimap

2013-05-30T17:29:27Z

Anomalous: Transparent background for minimap images

[[File:Minimap_atcshd_example.png|thumb|200px|A basic minimap for atcshd]]

Minimaps have two purposes: help the player navigate some very large and confusing map and promote teamplay by showing the location of your teammates. They are created by the mapper and are part of the assets of a map. They follow more or less [[Feature_Proposals/Minimap|the old design document]]. Each minimap consists of a number of zones: in each region of the map a different image can be used, for example to represent the different floors of a facility.

== How to create a minimap: the quick and simple method ==

* Open the map using netradiant.
* Go in the Build menu and select Customize.
* Search for the minimap command line and set the number after -size to a large value (e.g. 512).
* Go in the Build menu and build the minimap.
* Note the numbers in the log window appearing after ''size_texcoords''.
* Put the resulting tga file in the minimaps/ folder.
* Create a file minimaps/<name of your map>.minimap and write it using the following template (by replacing 1, 2, 4 and 5 by the first, second, fourth and fifth number appearing after ''size_texcoords''):
{
zone {
bounds -100000 -100000 -100000 100000 100000 100000
image "minimaps/<mapname>" 1 2 4 5
}
}
* Load your map and enjoy that magnificient minimap.

== How to create a minimap: tutorial using q3map2 ==

q3map2 can create minimaps from the .map file. These minimaps basically show the solid walls by checking how much solid brush is under each pixel: a wall has a big intersection with the vertical line but a floor not so much.

=== Configuring netRadiant ===

Before you start generating images you probably want to change the options given to q3map2 and make sure the image size is at least 512. To do that go on the Build menu and select Customize. Below is a very simple sample configuration for a minimap build.

[[File:Minimap_customize_options.png]]

You can use the q3map2 minimap options list below to customize the output. A good default build line is

[q3map2] -minimap -samples 10 -size 512 -border 0.0 "[MapFile]"

=== Creating the images ===

[[File:Minimap_atcshd_cutted.png|thumb|200px|atcshd with the center missing and a filled door]]

Running the minimap build at this point will create a single minimap image for the whole map. You might want to create several images either because the maps is too cluttered (many intricate levels) or because the map is too large.

If you simply want to cut the minimap in several parts, first try to make a bigger image (image with a size of 2048 should work in the engine) with a bigger ''globalScale'' parameter in your minimap config file. If you aren't happy with the result, try using the ''minmax'' switch for the minimap build to render a smaller part; make sure the different images overlap so that there is a smooth transition ingame.

When the map is too cluttered, the only solution is to cut parts of it and make differents zones for the different levels of your map. To do this remove all the parts you don't want to see and fill the "holes" left in you map with a solid brush (to avoid leaks).

=== Processing the images ===

Ideally, the images will be rendered on a transparent background, perhaps with some translucent areas (e.g. indicating floors). If you have a grey-scale image without an alpha channel, it's possible to turn this into a transparent background by using a graphics package such as GIMP.

The procedure is as follows:

* Load the image. There will be a single layer containing the map.
* Add a layer mask to the layer. You need to set the mask to a grey-scale representation of the layer (GIMP has an option for this when creating the mask).
* Set the background painting colour to white.
* Clear the layer (not its mask) to the background colour. This will leave only white showing through the layer mask.
* Save the image as .tga, .png or .webp.

=== Creating the minimap file ===

To create the minimap follow the manual, look at the example in the simple tutorial or look at an existing minimap file. You'll have to add parameters and potentially more zones. You can keep most parameters to their default value. The tricky part are the ''bounds'' and ''image'' parameters.

For the ''bounds'' parameter you can either:
* picks the points coordinates by hand in netRadiant
* use the 6 ''size_texcoords'' numbers in the q3map2 output
* use the parameter you gave to the ''minmax'' q3map2 switch is you used it.
These numbers will make a somewhat good default value for the zone bounds then you can tweak it so that it to your taste. Note that the numbers must always by <xmin> then <xmax> as in the doc, otherwise the zone will never be used. You can use multiple zones with the same image to define a more complex shape.

For the ''image'' parameter, first use the image filename without the extension then big the four numbers highlighted in the q3map2 log below and paste them in the same order (do not confuse ''size'' and ''size_texcoords'').

[[File:Minimap_q3map2_texcoords.png]]

== Minimap file manual ==

A minimap file has the following structure (with at least one zone block)

{
<zone blocks or global parameters>
}

With each zone block with the following structure

zone {
<zone-specific parameters>
}

The zone are used to show different images in different regions of the map. When a player gets outside the bounds of the zone he is currently on, zones will be searched in the order defined in the file to choose the new image. If no zone fits then the last one defined will be used. This way you can define a default zone by putting at the end of the minimap file the following zone block:

zone {
bounds 0.0 0.0 0.0 0.0 0.0 0.0
<other parameters>
}

=== Global parameters ===

==== backgroundColor ====

backgroundColor <float r> <float g> <float b> <float a>

Chooses the color of the background of the map. Defaults to opaque black. If the map has been generated by q3map2 you most probably to leave it to opaque black. You can use a transparent background but it won't play well with semi-transparent maps; you'd better use a binary transparency and a semi-transparent background color.

==== globalScale ====

globalScale <float ratio>

Multiplies the size of the minimap and all the minimap objects by the given ratio: it is a sort of global zoom of the map. Defaults to 1.0.

=== Zone-specific parameters ===

Each zone block must have a bounds and image parameter or an error will be generated.

==== bounds ====

bounds <float xmin> <float ymin> <float zmin> <float xmax> <float ymax> <float zmax>

Defines in which "box volume" this zone is in effect. The arguments are world units and must be in that order (xmin < xmax, ...)

==== image ====

image <filename> <float xmin> <float ymin> <float xmax> <float ymax>

Defines which image to use and what rectangular area that image represents in the world. The four position arguments are in world units; they are the X and Y bounds of a brush that would cover the whole minimap. The filename should ideally be without the file extension (you could theoretically use a shader name too).

==== scale ====

scale <float ratio>

When the player is inside the zone, multiplies the size of the minimap and all the minimap objects by the given ratio. Defaults to 1.0.

== q3map2 minimap options ==

The q3map2 commandline looks like this in netRadiant:

[q3map2] -minimap <switches> "[MapFile]"

=== "Color" switches ===

==== autolevel ====

-autolevel

Tries to find automatically the right contrast and brightness values to use. Defaults to off.

==== boost ====

-boost <float b>

Changes the gamma of the resulting image using the following formula color' = color / ((b - 1) * color + 1). Defaults to 1.0. (the pass is made before the contrast/sharpen pass)

==== contrast ====

-contrast <float c>

Changes the contrast of the resulting image using the following formula color' = color * c + sharpen. Defaults to 1.0. (the pass is made after the boost pass)

==== noautolevel ====

-noautolevel

Will not try to find automatically the right contrast and brightness values to use. Defaults to on.

==== sharpen ====

-sharpen <float s>

Changes the brightness of the resulting image using the following formula color' = color * contrast + s. Defaults to 1.0. (the pass is made after the boost pass)

=== Output control switches ===

==== black ====

-black

Writes the resulting minimap as a black TGA file with levels of transparency. (It was not tested yet, maybe the engine will treat it as a completely black image)

==== gray ====

-gray

Writes the image as a GRAY8 TGA file.

==== o ====

-o <filename.tga>

THIS IS SET AUTOMATICALLY BY NETRADIANT. Sets the filename of the output file.

==== white ====

-white

Writes the resulting minimap as a white TGA file with levels of transparency. (It seems our engine converts it in levels of gray)

=== Region switches ===

==== border ====

-border <float ratio>

Adds borders to the image with size (image_size * ratio). Defaults to 0.0 (at least for Tremulous).

==== keepaspect ====

-keepaspect

Makes it so that the resulting image will keep the aspect ratio (a square will stay a square) by adding empty space. Defaults to on.

==== minmax ====

-minmax <float xmin> <float ymin> <float zmin> <float xmax> <float ymax> <float zmax>

Restricts the minimap to the part of the map contained in the box defined by the parameters. By default this box is the bounding box of the whole map.

==== nokeepaspect ====

-nokeepaspect

THIS IS NOT SUPPORTED BY THE UNVANQUISHED MINIMAPS and included for completeness only. Allows q3map2 to not preserve the aspect ratio (in some way). Defaults to off.

==== size ====

-size <int N>

Changes the sizes of the resulting image to NxN. defaults to 512 for Tremulous.

=== Sampling switches ===

==== random ====

-random <int n>

Makes the minimap generation use random samples and sets the number of samples to take for each pixel of the minimap. Defaults to on and 1.

==== samples ====

-samples <int n>

Makes the minimap generation use ordered samples and sets the number of samples to take for each pixel of the minimap. Defaults to off and 1.

Getting the source

2013-05-06T02:01:12Z

Anomalous: Fetching source tarballs

The [https://github.com/Unvanquished/Unvanquished Unvanquished source code] is hosted on GitHub. You can either download a snapshot of the source code in [https://github.com/Unvanquished/Unvanquished/zipball/master ZIP archive form], or you can use Git to clone the repository.

==Installing Git==

If you already have Git installed, you can skip this step.

===Windows===

Windows users can acquire Git from the [http://code.google.com/p/msysgit/ MSysGit project]. If you would prefer a graphical front-end, there is [http://code.google.com/p/tortoisegit/ TortoiseGit], but MSysGit must be installed regardless.

===Mac OS X===

Apple has included Git with Xcode since version 4. You may download [https://developer.apple.com/xcode/ Xcode] from Apple's developer website. Please note that while XCode 4 was available for a very brief time for 32-bit and Snow Leopard users for a small price ($5 from the Mac App Store), this is no longer the case; it is now free, but available only to 64-bit Lion users. Snow Leopard (10.6) users and prior may now only use XCode 3, which does not include Git. If you are one of these users, you may [http://git-scm.com/download/mac acquire a copy of Git] from its site. A [http://git-scm.com/download/gui/mac selection of GUIs for Git] is also available.

===Linux===

====Debian & Ubuntu====

Install Git using the package manager:

$ sudo apt-get install git

====Gentoo====

The ebuilds for Unvanquished (games-fps/unvanquished) and the assets (games-fps/unvanquished-data) are available from the [https://github.com/hasufell/hasufell-overlay ''hasufell''] overlay.
If you don't have layman installed, you can install it with

$ emerge layman

Then, adding the overlay and installing should be trivial.

$ layman -a hasufell
$ emerge unvanquished

See [https://bugs.gentoo.org/show_bug.cgi?id=419421 the entry on bugs.gentoo.org] for additional comments about the ebuilds.

==Downloading the source==

===Command line===

====Releases====

[http://unvanquished.net/downloads/sources/ Release tarballs can be found here.] The tarballs can be unpacked using some GUI-based tools or via a shell:

$ tar xf unvanquished-0.15.0.tar.xz

Either way, the source will be unpacked into a directory whose name reflects the tarball's name; in the example, it will be named ''unvanquised-0.15.0''.

====Development====

The following commands will work on any platform.

$ git clone https://github.com/Unvanquished/Unvanquished.git

This will create a directory called ''Unvanquished''.

If you would like to get the source for a particular version, [http://git-scm.com/docs/git-checkout check out] the associated [http://git-scm.com/book/en/Git-Basics-Tagging tag]:

$ git checkout {{CurrentVersion|Tag}}

To see the list of tags available to check out,

$ git tag

will produce a list.

===Linux===

Please see the [[#Command_line|command line]] instructions.

===Mac OS X===

====Command Line====

Open a Terminal (<code>/Applications/Utilities/Terminal</code>) and follow the [[#Command_line|command line]] instructions.

====Xcode 4====

# Start Xcode.
# Open the Organizer window (Window → Organizer or {{Hotkey|Shift}}{{Hotkey|MacCommand}}{{Hotkey|2}})
# Hit the "Repositories" button on the top bar.
# Hit the "+" button in the lower-left corner, and choose "Checkout or Clone Repository…".
# In the rollout sheet that appears, enter <code>https://github.com/Unvanquished/Unvanquished.git</code> into the "Location" field, and hit "Next".
# Enter "Unvanquished" into the "Name" field, ensure that the "Type" combo box is set to "Git", and hit "Clone".
# You will be prompted where to save the repository. Choose a location and hit "Clone".

===Windows===

====TortoiseGIT====

# Make and enter a new folder to store the source code in
# Right click the inside of the folder → Git Clone...
# In the Url textbox enter: <code>https://github.com/Unvanquished/Unvanquished.git</code>
# Hit OK.

====Command Line====

Open the MsysGit terminal and and follow the [[#Command_line|command line]] instructions.

==Keeping your copy of the source up-to-date==

For more information on using git, an excellent resource is the official [http://git-scm.com/book git book], available to read online for free.

===TortoiseGit===

# Right-click somewhere in the source directory, and choose "Git Sync". 

===Command-line (All platforms)===

{{Note|content=
If you have checked out a particular commit or tag (e.g., <code>{{CurrentVersion|Tag}}</code>), git will inform you afterwards that you are in what it refers to as a "detached head" state. Before you update your copy of the source, you should check out the master branch first:

$ git checkout master
}}

To pull (i.e., fetch and merge) changes made since you checked out the source—that is, to update your working copy to match the current state of the official repository—you (typically) need only run one command:

$ git pull origin master

==Compiling==

After getting the source code, you can [[Compiling the source|compile]] it.

Creating custom keybinds

2013-04-22T01:46:43Z

Anomalous: Example for /buy (sell-all binding)

{| align="right"
| __TOC__
|}

{{StatusWIP|The information on this page is incomplete.}}

==Usage==

Some simple bindings can be made via the configuration menus.

For more complicated bindings and for team bindings, you need to use the console. For example, you could bind commands to set a team and to spawn:

bind F9 "team a"
bind F10 "team h"

// attacking players
teambind aliens F5 "class level0"
teambind humans F5 "class rifle"

// builders
teambind aliens F6 "class builderupg builder"
teambind humans F6 "class ckit"

==Differences from Tremulous==

A number of commands for keybinds have changed since Tremulous, so keybind configurations cannot be directly copied from Tremulous to Unvanquished.

{| class="wikitable"
! Tremulous || Unvanquished || Used for…
|-
| <code>+button2</code> || <code>+useitem</code> || Using an item; granger spit; dragoon barb
|-
| <code>+button3</code> || <code>+taunt</code> || “Come on!” etc.
|-
| <code>+button5</code> || <code>+attack2</code> || Secondary attack
|-
| <code>+button6</code> || <code>+dodge</code> || Dodging
|-
| <code>+button7</code> || <code>+activate</code> || Using a structure; evolving
|-
| <code>+button8</code> || <code>+sprint</code> || Sprinting
|-
|}

As of alpha 3, the <code>+button''N''</code> commands are no longer present.

You may want to bind the new [[Voice say system|vsays]] to different keys.
==Gameplay commands==

This is a partial list of commands added, using Tremulous GPP r2259 as a reference point. Not everything listed is actually useful.

{{note|content=The game handles <tt>+</tt>commands specially, in a way which has implications concerning usage.

There is one way to use them in bindings which works properly, and that's to use the command on its own.

It is possible to have other commands following one of these ''but'' this is not well handled – the game appends information about when the key was pressed but, at present, assumes that there's just one command present in the binding. It also causes problems on key-up when the <tt>+</tt>command is the first command since, while the it will (correctly) be converted to a <tt>-</tt>command, any following commands will be executed unmodifed, except for the last one (which gets the timing information).

If you need to use a binding which contains one of these with other commands then use something like “<samp>wait; +taunt; wait; -taunt</samp>”. Timing information will not be added; the server has information which allows it to calculate ‘close enough’ timing information, and there may be a knock-on effect on an immediately-following action.
}}

===+activate===
Access an armoury; evolve.

===+attack2===
Secondary attack.

===+dodge===
Low jump sideways or backwards. (Humans only.)

===+rally===
“Come on!” etc., as in ‘follow me’.

===+sprint===
Run. (Humans only.)

===+taunt===
“Come on!” etc., as in ‘bring it on!’.

===+useitem===
Use the highlighted item; tertiary attack (granger spit, dragoon snipe).

===buy===

(Changed in Alpha 15.) This command can take multiple parameters. It can also be used to sell items.

For example, if you want a sell-all bind, you would use “<samp>buy -all rifle</samp>” – this will get rid of all equipment and re-equip you with a rifle (though if you're building something, you won't lose your construction kit and consequently will not acquire a rifle).

===say_area_team===
Talk to all teammates within a server-set range.

===sell===

(Changed in Alpha 15.) This command can take multiple parameters.

==Configuration commands==

===alias===
<tt>alias NAME COMMAND [PARAMETERS…]</tt>

Create an alias for the given command. The alias is then useable as a command in its own right.

===aliaslist===
Lists available command aliases.

===bind===
<tt>bind KEY [COMMAND…]</tt>
Binds a command (or sequence of commands) to the given key, or lists the bindings for that key.

All existing bindings on that key are lost.

===clearaliases===
Clears all command aliases.

===cycle===

===editbind===
<tt>editbind [TEAM] KEY</tt>

This inserts a <tt>/bind</tt> or <tt>/teambind</tt> command into the in-game console, ready for editing. The console is opened if needed.

<tt>TEAM</tt> is default, spectators, humans, or aliens. (Initial substrings are accepted.)

===irc_connect===
Start the ingame IRC client

===irc_quit===
Stop the ingame IRC client

===irc_say===
Say something in the desired IRC channel if connected to a server

===listrotation===
Lists the current map rotation. The current map is highlighted.

===loadgame===

===messagemode1===
This command opens a general chat prompt.

===messagemode2===
This command opens a team-chat prompt.

===messagemode3===
This command opens an admin chat prompt.

===messagemode4===
This command opens a chat prompt for the built-in IRC client.

===messagemodec===
This command opens a command prompt.

===modelist===

===teambind===
<tt>teambind TEAM KEY [COMMAND…]</tt>
Binds a command (or sequence of commands) to the given key for use when on the given team, or lists the binding for that key/team.

<tt>TEAM</tt> is default, spectators, humans, or aliens. (Initial substrings are accepted.)

===toggleConsole===
Opens or closes the in-game console.

===ui_restart===
Reloads UI files.

===unalias===
<tt>unalias NAME</tt>

Removes the named alias.

===unbind===
<tt>unbind [TEAM] KEY</tt>
Removes either all bindings for the given key, or the binding for the given team on that key.

<tt>TEAM</tt> is default, spectators, humans, or aliens. (Initial substrings are accepted.)

===undelay===

===undelayAll===

===unregister===
Removes registration of your GUID and name.

==Condition handling==

===if===
<tt>if VALUE CONDITION VALUE THEN [ELSE]</tt>

<tt>if MODIFIERS THEN [ELSE]</tt>

; <tt>VALUE</tt> : a variable or number
; <tt>CONDITION</tt> : comparison operator
; <tt>MODIFIERS</tt> : comma-separated list of keyboard modifiers: Shift, Ctrl, Alt, Command (or Cmd), Mode, Super. Prefix any which must not be pressed with <kbd>!</kbd>.
; <tt>THEN</tt> and <tt>ELSE</tt> : either a variable name or, if prefixed with <kbd>/</kbd> or <kbd>\</kbd>, a command string.

Recognised numeric comparison operators: 
<tt> = != < <= > >= !=</tt>

Recognised string comparison operators: 
<tt> eq ne in !in</tt>

Either the <tt>THEN</tt> clause or the <tt>ELSE</tt> clause (if present) will be executed. If it is a variable name, its content will be executed.

For example:

<pre>/if shift "/echo Hello" "/echo Goodbye"
/bind j "if \$team\$ eq aliens \"/class level1upg level1\""</pre>

(Note the escaping of the cvar <tt>team</tt>.)

===modcase===
<tt>modcase MODIFIERS THEN [MODIFIERS THEN]* [ELSE]</tt>

This works like <tt>if</tt>. The leftmost most-specific <tt>THEN</tt> whose modifier list matches is the one which is executed; if none match, then <tt>ELSE</tt> is executed if it is present.

For example:
<pre>/modcase shift "/echo 1" ctrl "/echo 2" shift,ctrl "/echo 3" shift,!alt "/echo 4"</pre>
works as follows:

# if Shift and Alt (due to clause 4) but not Ctrl (due to clause 3) are pressed;
# if Ctrl but not Shift (due to clause 3);
# if Shift and Ctrl;
# if Shift but neither Alt nor Ctrl.

===strcmp===
Compare the string values of two cvars. ''Obsolete.''

==Admin commands==

===allready===
Quickly move to the next map. Used only during the intermission.

===speclock===
Prevents a player from joining a team for a given time or until the end of the current game.
If necessary, the player is moved to spectators.

===specunlock===
Allows a player, previously locked, to join a team.

==Utility commands==

===calc===
Do math calculations on cvars. Store the value to a cvar Useful in making scripts.

===concat===
Concatenate 2 cvars into a third.

===delay===

===glsl_restart===
Development use. For recompiling the GLSL shader code.

===grep===
<tt>grep TEXT</tt>

Searches the in-game console for occurrences of <tt>TEXT</tt>. Matching lines are reprinted.

===help===

===math===
Do math on cvars. Useful for scripts.

===random===
Generate a random number

===reloadhud===
Reload the HUD without a vid_restart

===screenshotPNG===
Saves a screenshot in the PNG format.

===search===
<tt>search TEXT</tt>

Searches back through the in-game console for <tt>TEXT</tt> and scrolls to it.

===searchDown===
<tt>searchDown TEXT</tt>

Searches forward through the in-game console for <tt>TEXT</tt> and scrolls to it.

===snd_reload===
Reload sounds (includes a vid_restart

===wav_record===

===wav_stoprecord===

==Special uses==

===animationlist===

===buildcubemaps===

===cache_endgather===

===cache_mapchange===

===cache_setindex===

===cache_startgather===

===cache_usedfile===

===fbolist===

===fieldinfo===

===gameCompleteStatus===

===openurl===
Open a URL inside the OS's default browser.

===pubkey===
Internal use.

===pubkey_identify===
Internal use.

===setRecommended===

===shaderexp===

===spdevmap===
Does nothing.

===spmap===
Does nothing.

===updatehunkusage===

===updatescreen===

===vbolist===

Creating custom keybinds

2013-04-22T01:41:51Z

Anomalous: Changes to /buy and /sell

{| align="right"
| __TOC__
|}

{{StatusWIP|The information on this page is incomplete.}}

==Usage==

Some simple bindings can be made via the configuration menus.

For more complicated bindings and for team bindings, you need to use the console. For example, you could bind commands to set a team and to spawn:

bind F9 "team a"
bind F10 "team h"

// attacking players
teambind aliens F5 "class level0"
teambind humans F5 "class rifle"

// builders
teambind aliens F6 "class builderupg builder"
teambind humans F6 "class ckit"

==Differences from Tremulous==

A number of commands for keybinds have changed since Tremulous, so keybind configurations cannot be directly copied from Tremulous to Unvanquished.

{| class="wikitable"
! Tremulous || Unvanquished || Used for…
|-
| <code>+button2</code> || <code>+useitem</code> || Using an item; granger spit; dragoon barb
|-
| <code>+button3</code> || <code>+taunt</code> || “Come on!” etc.
|-
| <code>+button5</code> || <code>+attack2</code> || Secondary attack
|-
| <code>+button6</code> || <code>+dodge</code> || Dodging
|-
| <code>+button7</code> || <code>+activate</code> || Using a structure; evolving
|-
| <code>+button8</code> || <code>+sprint</code> || Sprinting
|-
|}

As of alpha 3, the <code>+button''N''</code> commands are no longer present.

You may want to bind the new [[Voice say system|vsays]] to different keys.
==Gameplay commands==

This is a partial list of commands added, using Tremulous GPP r2259 as a reference point. Not everything listed is actually useful.

{{note|content=The game handles <tt>+</tt>commands specially, in a way which has implications concerning usage.

There is one way to use them in bindings which works properly, and that's to use the command on its own.

It is possible to have other commands following one of these ''but'' this is not well handled – the game appends information about when the key was pressed but, at present, assumes that there's just one command present in the binding. It also causes problems on key-up when the <tt>+</tt>command is the first command since, while the it will (correctly) be converted to a <tt>-</tt>command, any following commands will be executed unmodifed, except for the last one (which gets the timing information).

If you need to use a binding which contains one of these with other commands then use something like “<samp>wait; +taunt; wait; -taunt</samp>”. Timing information will not be added; the server has information which allows it to calculate ‘close enough’ timing information, and there may be a knock-on effect on an immediately-following action.
}}

===+activate===
Access an armoury; evolve.

===+attack2===
Secondary attack.

===+dodge===
Low jump sideways or backwards. (Humans only.)

===+rally===
“Come on!” etc., as in ‘follow me’.

===+sprint===
Run. (Humans only.)

===+taunt===
“Come on!” etc., as in ‘bring it on!’.

===+useitem===
Use the highlighted item; tertiary attack (granger spit, dragoon snipe).

===buy===

(Changed in Alpha 15.) This command can take multiple parameters. It can also be used to sell items. For example, if you want a sell-all bind, you would use “<samp>buy -all rifle</samp>”.

===say_area_team===
Talk to all teammates within a server-set range.

===sell===

(Changed in Alpha 15.) This command can take multiple parameters.

==Configuration commands==

===alias===
<tt>alias NAME COMMAND [PARAMETERS…]</tt>

Create an alias for the given command. The alias is then useable as a command in its own right.

===aliaslist===
Lists available command aliases.

===bind===
<tt>bind KEY [COMMAND…]</tt>
Binds a command (or sequence of commands) to the given key, or lists the bindings for that key.

All existing bindings on that key are lost.

===clearaliases===
Clears all command aliases.

===cycle===

===editbind===
<tt>editbind [TEAM] KEY</tt>

This inserts a <tt>/bind</tt> or <tt>/teambind</tt> command into the in-game console, ready for editing. The console is opened if needed.

<tt>TEAM</tt> is default, spectators, humans, or aliens. (Initial substrings are accepted.)

===irc_connect===
Start the ingame IRC client

===irc_quit===
Stop the ingame IRC client

===irc_say===
Say something in the desired IRC channel if connected to a server

===listrotation===
Lists the current map rotation. The current map is highlighted.

===loadgame===

===messagemode1===
This command opens a general chat prompt.

===messagemode2===
This command opens a team-chat prompt.

===messagemode3===
This command opens an admin chat prompt.

===messagemode4===
This command opens a chat prompt for the built-in IRC client.

===messagemodec===
This command opens a command prompt.

===modelist===

===teambind===
<tt>teambind TEAM KEY [COMMAND…]</tt>
Binds a command (or sequence of commands) to the given key for use when on the given team, or lists the binding for that key/team.

<tt>TEAM</tt> is default, spectators, humans, or aliens. (Initial substrings are accepted.)

===toggleConsole===
Opens or closes the in-game console.

===ui_restart===
Reloads UI files.

===unalias===
<tt>unalias NAME</tt>

Removes the named alias.

===unbind===
<tt>unbind [TEAM] KEY</tt>
Removes either all bindings for the given key, or the binding for the given team on that key.

<tt>TEAM</tt> is default, spectators, humans, or aliens. (Initial substrings are accepted.)

===undelay===

===undelayAll===

===unregister===
Removes registration of your GUID and name.

==Condition handling==

===if===
<tt>if VALUE CONDITION VALUE THEN [ELSE]</tt>

<tt>if MODIFIERS THEN [ELSE]</tt>

; <tt>VALUE</tt> : a variable or number
; <tt>CONDITION</tt> : comparison operator
; <tt>MODIFIERS</tt> : comma-separated list of keyboard modifiers: Shift, Ctrl, Alt, Command (or Cmd), Mode, Super. Prefix any which must not be pressed with <kbd>!</kbd>.
; <tt>THEN</tt> and <tt>ELSE</tt> : either a variable name or, if prefixed with <kbd>/</kbd> or <kbd>\</kbd>, a command string.

Recognised numeric comparison operators: 
<tt> = != < <= > >= !=</tt>

Recognised string comparison operators: 
<tt> eq ne in !in</tt>

Either the <tt>THEN</tt> clause or the <tt>ELSE</tt> clause (if present) will be executed. If it is a variable name, its content will be executed.

For example:

<pre>/if shift "/echo Hello" "/echo Goodbye"
/bind j "if \$team\$ eq aliens \"/class level1upg level1\""</pre>

(Note the escaping of the cvar <tt>team</tt>.)

===modcase===
<tt>modcase MODIFIERS THEN [MODIFIERS THEN]* [ELSE]</tt>

This works like <tt>if</tt>. The leftmost most-specific <tt>THEN</tt> whose modifier list matches is the one which is executed; if none match, then <tt>ELSE</tt> is executed if it is present.

For example:
<pre>/modcase shift "/echo 1" ctrl "/echo 2" shift,ctrl "/echo 3" shift,!alt "/echo 4"</pre>
works as follows:

# if Shift and Alt (due to clause 4) but not Ctrl (due to clause 3) are pressed;
# if Ctrl but not Shift (due to clause 3);
# if Shift and Ctrl;
# if Shift but neither Alt nor Ctrl.

===strcmp===
Compare the string values of two cvars. ''Obsolete.''

==Admin commands==

===allready===
Quickly move to the next map. Used only during the intermission.

===speclock===
Prevents a player from joining a team for a given time or until the end of the current game.
If necessary, the player is moved to spectators.

===specunlock===
Allows a player, previously locked, to join a team.

==Utility commands==

===calc===
Do math calculations on cvars. Store the value to a cvar Useful in making scripts.

===concat===
Concatenate 2 cvars into a third.

===delay===

===glsl_restart===
Development use. For recompiling the GLSL shader code.

===grep===
<tt>grep TEXT</tt>

Searches the in-game console for occurrences of <tt>TEXT</tt>. Matching lines are reprinted.

===help===

===math===
Do math on cvars. Useful for scripts.

===random===
Generate a random number

===reloadhud===
Reload the HUD without a vid_restart

===screenshotPNG===
Saves a screenshot in the PNG format.

===search===
<tt>search TEXT</tt>

Searches back through the in-game console for <tt>TEXT</tt> and scrolls to it.

===searchDown===
<tt>searchDown TEXT</tt>

Searches forward through the in-game console for <tt>TEXT</tt> and scrolls to it.

===snd_reload===
Reload sounds (includes a vid_restart

===wav_record===

===wav_stoprecord===

==Special uses==

===animationlist===

===buildcubemaps===

===cache_endgather===

===cache_mapchange===

===cache_setindex===

===cache_startgather===

===cache_usedfile===

===fbolist===

===fieldinfo===

===gameCompleteStatus===

===openurl===
Open a URL inside the OS's default browser.

===pubkey===
Internal use.

===pubkey_identify===
Internal use.

===setRecommended===

===shaderexp===

===spdevmap===
Does nothing.

===spmap===
Does nothing.

===updatehunkusage===

===updatescreen===

===vbolist===

Creating custom keybinds

2013-04-22T01:37:23Z

Anomalous: /* Gameplay commands */

{| align="right"
| __TOC__
|}

{{StatusWIP|The information on this page is incomplete.}}

==Usage==

Some simple bindings can be made via the configuration menus.

For more complicated bindings and for team bindings, you need to use the console. For example, you could bind commands to set a team and to spawn:

bind F9 "team a"
bind F10 "team h"

// attacking players
teambind aliens F5 "class level0"
teambind humans F5 "class rifle"

// builders
teambind aliens F6 "class builderupg builder"
teambind humans F6 "class ckit"

==Differences from Tremulous==

A number of commands for keybinds have changed since Tremulous, so keybind configurations cannot be directly copied from Tremulous to Unvanquished.

{| class="wikitable"
! Tremulous || Unvanquished || Used for…
|-
| <code>+button2</code> || <code>+useitem</code> || Using an item; granger spit; dragoon barb
|-
| <code>+button3</code> || <code>+taunt</code> || “Come on!” etc.
|-
| <code>+button5</code> || <code>+attack2</code> || Secondary attack
|-
| <code>+button6</code> || <code>+dodge</code> || Dodging
|-
| <code>+button7</code> || <code>+activate</code> || Using a structure; evolving
|-
| <code>+button8</code> || <code>+sprint</code> || Sprinting
|-
|}

As of alpha 3, the <code>+button''N''</code> commands are no longer present.

You may want to bind the new [[Voice say system|vsays]] to different keys.
==Gameplay commands==

This is a partial list of commands added, using Tremulous GPP r2259 as a reference point. Not everything listed is actually useful.

{{note|content=The game handles <tt>+</tt>commands specially, in a way which has implications concerning usage.

There is one way to use them in bindings which works properly, and that's to use the command on its own.

It is possible to have other commands following one of these ''but'' this is not well handled – the game appends information about when the key was pressed but, at present, assumes that there's just one command present in the binding. It also causes problems on key-up when the <tt>+</tt>command is the first command since, while the it will (correctly) be converted to a <tt>-</tt>command, any following commands will be executed unmodifed, except for the last one (which gets the timing information).

If you need to use a binding which contains one of these with other commands then use something like “<samp>wait; +taunt; wait; -taunt</samp>”. Timing information will not be added; the server has information which allows it to calculate ‘close enough’ timing information, and there may be a knock-on effect on an immediately-following action.
}}

===+activate===
Access an armoury; evolve.

===+attack2===
Secondary attack.

===+dodge===
Low jump sideways or backwards. (Humans only.)

===+rally===
“Come on!” etc., as in ‘follow me’.

===+sprint===
Run. (Humans only.)

===+taunt===
“Come on!” etc., as in ‘bring it on!’.

===+useitem===
Use the highlighted item; tertiary attack (granger spit, dragoon snipe).

===say_area_team===
Talk to all teammates within a server-set range.

==Configuration commands==

===alias===
<tt>alias NAME COMMAND [PARAMETERS…]</tt>

Create an alias for the given command. The alias is then useable as a command in its own right.

===aliaslist===
Lists available command aliases.

===bind===
<tt>bind KEY [COMMAND…]</tt>
Binds a command (or sequence of commands) to the given key, or lists the bindings for that key.

All existing bindings on that key are lost.

===clearaliases===
Clears all command aliases.

===cycle===

===editbind===
<tt>editbind [TEAM] KEY</tt>

This inserts a <tt>/bind</tt> or <tt>/teambind</tt> command into the in-game console, ready for editing. The console is opened if needed.

<tt>TEAM</tt> is default, spectators, humans, or aliens. (Initial substrings are accepted.)

===irc_connect===
Start the ingame IRC client

===irc_quit===
Stop the ingame IRC client

===irc_say===
Say something in the desired IRC channel if connected to a server

===listrotation===
Lists the current map rotation. The current map is highlighted.

===loadgame===

===messagemode1===
This command opens a general chat prompt.

===messagemode2===
This command opens a team-chat prompt.

===messagemode3===
This command opens an admin chat prompt.

===messagemode4===
This command opens a chat prompt for the built-in IRC client.

===messagemodec===
This command opens a command prompt.

===modelist===

===teambind===
<tt>teambind TEAM KEY [COMMAND…]</tt>
Binds a command (or sequence of commands) to the given key for use when on the given team, or lists the binding for that key/team.

<tt>TEAM</tt> is default, spectators, humans, or aliens. (Initial substrings are accepted.)

===toggleConsole===
Opens or closes the in-game console.

===ui_restart===
Reloads UI files.

===unalias===
<tt>unalias NAME</tt>

Removes the named alias.

===unbind===
<tt>unbind [TEAM] KEY</tt>
Removes either all bindings for the given key, or the binding for the given team on that key.

<tt>TEAM</tt> is default, spectators, humans, or aliens. (Initial substrings are accepted.)

===undelay===

===undelayAll===

===unregister===
Removes registration of your GUID and name.

==Condition handling==

===if===
<tt>if VALUE CONDITION VALUE THEN [ELSE]</tt>

<tt>if MODIFIERS THEN [ELSE]</tt>

; <tt>VALUE</tt> : a variable or number
; <tt>CONDITION</tt> : comparison operator
; <tt>MODIFIERS</tt> : comma-separated list of keyboard modifiers: Shift, Ctrl, Alt, Command (or Cmd), Mode, Super. Prefix any which must not be pressed with <kbd>!</kbd>.
; <tt>THEN</tt> and <tt>ELSE</tt> : either a variable name or, if prefixed with <kbd>/</kbd> or <kbd>\</kbd>, a command string.

Recognised numeric comparison operators: 
<tt> = != < <= > >= !=</tt>

Recognised string comparison operators: 
<tt> eq ne in !in</tt>

Either the <tt>THEN</tt> clause or the <tt>ELSE</tt> clause (if present) will be executed. If it is a variable name, its content will be executed.

For example:

<pre>/if shift "/echo Hello" "/echo Goodbye"
/bind j "if \$team\$ eq aliens \"/class level1upg level1\""</pre>

(Note the escaping of the cvar <tt>team</tt>.)

===modcase===
<tt>modcase MODIFIERS THEN [MODIFIERS THEN]* [ELSE]</tt>

This works like <tt>if</tt>. The leftmost most-specific <tt>THEN</tt> whose modifier list matches is the one which is executed; if none match, then <tt>ELSE</tt> is executed if it is present.

For example:
<pre>/modcase shift "/echo 1" ctrl "/echo 2" shift,ctrl "/echo 3" shift,!alt "/echo 4"</pre>
works as follows:

# if Shift and Alt (due to clause 4) but not Ctrl (due to clause 3) are pressed;
# if Ctrl but not Shift (due to clause 3);
# if Shift and Ctrl;
# if Shift but neither Alt nor Ctrl.

===strcmp===
Compare the string values of two cvars. ''Obsolete.''

==Admin commands==

===allready===
Quickly move to the next map. Used only during the intermission.

===speclock===
Prevents a player from joining a team for a given time or until the end of the current game.
If necessary, the player is moved to spectators.

===specunlock===
Allows a player, previously locked, to join a team.

==Utility commands==

===calc===
Do math calculations on cvars. Store the value to a cvar Useful in making scripts.

===concat===
Concatenate 2 cvars into a third.

===delay===

===glsl_restart===
Development use. For recompiling the GLSL shader code.

===grep===
<tt>grep TEXT</tt>

Searches the in-game console for occurrences of <tt>TEXT</tt>. Matching lines are reprinted.

===help===

===math===
Do math on cvars. Useful for scripts.

===random===
Generate a random number

===reloadhud===
Reload the HUD without a vid_restart

===screenshotPNG===
Saves a screenshot in the PNG format.

===search===
<tt>search TEXT</tt>

Searches back through the in-game console for <tt>TEXT</tt> and scrolls to it.

===searchDown===
<tt>searchDown TEXT</tt>

Searches forward through the in-game console for <tt>TEXT</tt> and scrolls to it.

===snd_reload===
Reload sounds (includes a vid_restart

===wav_record===

===wav_stoprecord===

==Special uses==

===animationlist===

===buildcubemaps===

===cache_endgather===

===cache_mapchange===

===cache_setindex===

===cache_startgather===

===cache_usedfile===

===fbolist===

===fieldinfo===

===gameCompleteStatus===

===openurl===
Open a URL inside the OS's default browser.

===pubkey===
Internal use.

===pubkey_identify===
Internal use.

===setRecommended===

===shaderexp===

===spdevmap===
Does nothing.

===spmap===
Does nothing.

===updatehunkusage===

===updatescreen===

===vbolist===

Creating custom keybinds

2013-04-22T01:36:26Z

Anomalous: Split out if, modcase and strcmp into their own section.

{| align="right"
| __TOC__
|}

{{StatusWIP|The information on this page is incomplete.}}

==Usage==

Some simple bindings can be made via the configuration menus.

For more complicated bindings and for team bindings, you need to use the console. For example, you could bind commands to set a team and to spawn:

bind F9 "team a"
bind F10 "team h"

// attacking players
teambind aliens F5 "class level0"
teambind humans F5 "class rifle"

// builders
teambind aliens F6 "class builderupg builder"
teambind humans F6 "class ckit"

==Differences from Tremulous==

A number of commands for keybinds have changed since Tremulous, so keybind configurations cannot be directly copied from Tremulous to Unvanquished.

{| class="wikitable"
! Tremulous || Unvanquished || Used for…
|-
| <code>+button2</code> || <code>+useitem</code> || Using an item; granger spit; dragoon barb
|-
| <code>+button3</code> || <code>+taunt</code> || “Come on!” etc.
|-
| <code>+button5</code> || <code>+attack2</code> || Secondary attack
|-
| <code>+button6</code> || <code>+dodge</code> || Dodging
|-
| <code>+button7</code> || <code>+activate</code> || Using a structure; evolving
|-
| <code>+button8</code> || <code>+sprint</code> || Sprinting
|-
|}

As of alpha 3, the <code>+button''N''</code> commands are no longer present.

You may want to bind the new [[Voice say system|vsays]] to different keys.
==Gameplay commands==

This is a partial list of commands added, using Tremulous GPP r2259 as a reference point. Not everything listed is actually useful.

{{note|content=The game handles these commands specially, in a way which has implications concerning usage.

There is one way to use them in bindings which works properly, and that's to use the command on its own.

It is possible to have other commands following one of these ''but'' this is not well handled – the game appends information about when the key was pressed but, at present, assumes that there's just one command present in the binding. It also causes problems on key-up when the <tt>+</tt>command is the first command since, while the it will (correctly) be converted to a <tt>-</tt>command, any following commands will be executed unmodifed, except for the last one (which gets the timing information).

If you need to use a binding which contains one of these with other commands then use something like “<samp>wait; +taunt; wait; -taunt</samp>”. Timing information will not be added; the server has information which allows it to calculate ‘close enough’ timing information, and there may be a knock-on effect on an immediately-following action.
}}

===+activate===
Access an armoury; evolve.

===+attack2===
Secondary attack.

===+dodge===
Low jump sideways or backwards. (Humans only.)

===+rally===
“Come on!” etc., as in ‘follow me’.

===+sprint===
Run. (Humans only.)

===+taunt===
“Come on!” etc., as in ‘bring it on!’.

===+useitem===
Use the highlighted item; tertiary attack (granger spit, dragoon snipe).

===say_area_team===
Talk to all teammates within a server-set range.

==Configuration commands==

===alias===
<tt>alias NAME COMMAND [PARAMETERS…]</tt>

Create an alias for the given command. The alias is then useable as a command in its own right.

===aliaslist===
Lists available command aliases.

===bind===
<tt>bind KEY [COMMAND…]</tt>
Binds a command (or sequence of commands) to the given key, or lists the bindings for that key.

All existing bindings on that key are lost.

===clearaliases===
Clears all command aliases.

===cycle===

===editbind===
<tt>editbind [TEAM] KEY</tt>

This inserts a <tt>/bind</tt> or <tt>/teambind</tt> command into the in-game console, ready for editing. The console is opened if needed.

<tt>TEAM</tt> is default, spectators, humans, or aliens. (Initial substrings are accepted.)

===irc_connect===
Start the ingame IRC client

===irc_quit===
Stop the ingame IRC client

===irc_say===
Say something in the desired IRC channel if connected to a server

===listrotation===
Lists the current map rotation. The current map is highlighted.

===loadgame===

===messagemode1===
This command opens a general chat prompt.

===messagemode2===
This command opens a team-chat prompt.

===messagemode3===
This command opens an admin chat prompt.

===messagemode4===
This command opens a chat prompt for the built-in IRC client.

===messagemodec===
This command opens a command prompt.

===modelist===

===teambind===
<tt>teambind TEAM KEY [COMMAND…]</tt>
Binds a command (or sequence of commands) to the given key for use when on the given team, or lists the binding for that key/team.

<tt>TEAM</tt> is default, spectators, humans, or aliens. (Initial substrings are accepted.)

===toggleConsole===
Opens or closes the in-game console.

===ui_restart===
Reloads UI files.

===unalias===
<tt>unalias NAME</tt>

Removes the named alias.

===unbind===
<tt>unbind [TEAM] KEY</tt>
Removes either all bindings for the given key, or the binding for the given team on that key.

<tt>TEAM</tt> is default, spectators, humans, or aliens. (Initial substrings are accepted.)

===undelay===

===undelayAll===

===unregister===
Removes registration of your GUID and name.

==Condition handling==

===if===
<tt>if VALUE CONDITION VALUE THEN [ELSE]</tt>

<tt>if MODIFIERS THEN [ELSE]</tt>

; <tt>VALUE</tt> : a variable or number
; <tt>CONDITION</tt> : comparison operator
; <tt>MODIFIERS</tt> : comma-separated list of keyboard modifiers: Shift, Ctrl, Alt, Command (or Cmd), Mode, Super. Prefix any which must not be pressed with <kbd>!</kbd>.
; <tt>THEN</tt> and <tt>ELSE</tt> : either a variable name or, if prefixed with <kbd>/</kbd> or <kbd>\</kbd>, a command string.

Recognised numeric comparison operators: 
<tt> = != < <= > >= !=</tt>

Recognised string comparison operators: 
<tt> eq ne in !in</tt>

Either the <tt>THEN</tt> clause or the <tt>ELSE</tt> clause (if present) will be executed. If it is a variable name, its content will be executed.

For example:

<pre>/if shift "/echo Hello" "/echo Goodbye"
/bind j "if \$team\$ eq aliens \"/class level1upg level1\""</pre>

(Note the escaping of the cvar <tt>team</tt>.)

===modcase===
<tt>modcase MODIFIERS THEN [MODIFIERS THEN]* [ELSE]</tt>

This works like <tt>if</tt>. The leftmost most-specific <tt>THEN</tt> whose modifier list matches is the one which is executed; if none match, then <tt>ELSE</tt> is executed if it is present.

For example:
<pre>/modcase shift "/echo 1" ctrl "/echo 2" shift,ctrl "/echo 3" shift,!alt "/echo 4"</pre>
works as follows:

# if Shift and Alt (due to clause 4) but not Ctrl (due to clause 3) are pressed;
# if Ctrl but not Shift (due to clause 3);
# if Shift and Ctrl;
# if Shift but neither Alt nor Ctrl.

===strcmp===
Compare the string values of two cvars. ''Obsolete.''

==Admin commands==

===allready===
Quickly move to the next map. Used only during the intermission.

===speclock===
Prevents a player from joining a team for a given time or until the end of the current game.
If necessary, the player is moved to spectators.

===specunlock===
Allows a player, previously locked, to join a team.

==Utility commands==

===calc===
Do math calculations on cvars. Store the value to a cvar Useful in making scripts.

===concat===
Concatenate 2 cvars into a third.

===delay===

===glsl_restart===
Development use. For recompiling the GLSL shader code.

===grep===
<tt>grep TEXT</tt>

Searches the in-game console for occurrences of <tt>TEXT</tt>. Matching lines are reprinted.

===help===

===math===
Do math on cvars. Useful for scripts.

===random===
Generate a random number

===reloadhud===
Reload the HUD without a vid_restart

===screenshotPNG===
Saves a screenshot in the PNG format.

===search===
<tt>search TEXT</tt>

Searches back through the in-game console for <tt>TEXT</tt> and scrolls to it.

===searchDown===
<tt>searchDown TEXT</tt>

Searches forward through the in-game console for <tt>TEXT</tt> and scrolls to it.

===snd_reload===
Reload sounds (includes a vid_restart

===wav_record===

===wav_stoprecord===

==Special uses==

===animationlist===

===buildcubemaps===

===cache_endgather===

===cache_mapchange===

===cache_setindex===

===cache_startgather===

===cache_usedfile===

===fbolist===

===fieldinfo===

===gameCompleteStatus===

===openurl===
Open a URL inside the OS's default browser.

===pubkey===
Internal use.

===pubkey_identify===
Internal use.

===setRecommended===

===shaderexp===

===spdevmap===
Does nothing.

===spmap===
Does nothing.

===updatehunkusage===

===updatescreen===

===vbolist===

Creating custom keybinds

2013-04-22T01:33:10Z

Anomalous: /* Possible pitfalls */

{| align="right"
| __TOC__
|}

{{StatusWIP|The information on this page is incomplete.}}

==Usage==

Some simple bindings can be made via the configuration menus.

For more complicated bindings and for team bindings, you need to use the console. For example, you could bind commands to set a team and to spawn:

bind F9 "team a"
bind F10 "team h"

// attacking players
teambind aliens F5 "class level0"
teambind humans F5 "class rifle"

// builders
teambind aliens F6 "class builderupg builder"
teambind humans F6 "class ckit"

==Differences from Tremulous==

A number of commands for keybinds have changed since Tremulous, so keybind configurations cannot be directly copied from Tremulous to Unvanquished.

{| class="wikitable"
! Tremulous || Unvanquished || Used for…
|-
| <code>+button2</code> || <code>+useitem</code> || Using an item; granger spit; dragoon barb
|-
| <code>+button3</code> || <code>+taunt</code> || “Come on!” etc.
|-
| <code>+button5</code> || <code>+attack2</code> || Secondary attack
|-
| <code>+button6</code> || <code>+dodge</code> || Dodging
|-
| <code>+button7</code> || <code>+activate</code> || Using a structure; evolving
|-
| <code>+button8</code> || <code>+sprint</code> || Sprinting
|-
|}

As of alpha 3, the <code>+button''N''</code> commands are no longer present.

You may want to bind the new [[Voice say system|vsays]] to different keys.
==Gameplay commands==

This is a partial list of commands added, using Tremulous GPP r2259 as a reference point. Not everything listed is actually useful.

{{note|content=The game handles these commands specially, in a way which has implications concerning usage.

There is one way to use them in bindings which works properly, and that's to use the command on its own.

It is possible to have other commands following one of these ''but'' this is not well handled – the game appends information about when the key was pressed but, at present, assumes that there's just one command present in the binding. It also causes problems on key-up when the <tt>+</tt>command is the first command since, while the it will (correctly) be converted to a <tt>-</tt>command, any following commands will be executed unmodifed, except for the last one (which gets the timing information).

If you need to use a binding which contains one of these with other commands then use something like “<samp>wait; +taunt; wait; -taunt</samp>”. Timing information will not be added; the server has information which allows it to calculate ‘close enough’ timing information, and there may be a knock-on effect on an immediately-following action.
}}

===+activate===
Access an armoury; evolve.

===+attack2===
Secondary attack.

===+dodge===
Low jump sideways or backwards. (Humans only.)

===+rally===
“Come on!” etc., as in ‘follow me’.

===+sprint===
Run. (Humans only.)

===+taunt===
“Come on!” etc., as in ‘bring it on!’.

===+useitem===
Use the highlighted item; tertiary attack (granger spit, dragoon snipe).

===say_area_team===
Talk to all teammates within a server-set range.

==Configuration commands==

===alias===
<tt>alias NAME COMMAND [PARAMETERS…]</tt>

Create an alias for the given command. The alias is then useable as a command in its own right.

===aliaslist===
Lists available command aliases.

===bind===
<tt>bind KEY [COMMAND…]</tt>
Binds a command (or sequence of commands) to the given key, or lists the bindings for that key.

All existing bindings on that key are lost.

===clearaliases===
Clears all command aliases.

===cycle===

===editbind===
<tt>editbind [TEAM] KEY</tt>

This inserts a <tt>/bind</tt> or <tt>/teambind</tt> command into the in-game console, ready for editing. The console is opened if needed.

<tt>TEAM</tt> is default, spectators, humans, or aliens. (Initial substrings are accepted.)

===if===
<tt>if VALUE CONDITION VALUE THEN [ELSE]</tt>

<tt>if MODIFIERS THEN [ELSE]</tt>

; <tt>VALUE</tt> : a variable or number
; <tt>CONDITION</tt> : comparison operator
; <tt>MODIFIERS</tt> : comma-separated list of keyboard modifiers: Shift, Ctrl, Alt, Command (or Cmd), Mode, Super. Prefix any which must not be pressed with <kbd>!</kbd>.
; <tt>THEN</tt> and <tt>ELSE</tt> : either a variable name or, if prefixed with <kbd>/</kbd> or <kbd>\</kbd>, a command string.

Recognised numeric comparison operators: 
<tt> = != < <= > >= !=</tt>

Recognised string comparison operators: 
<tt> eq ne in !in</tt>

Either the <tt>THEN</tt> clause or the <tt>ELSE</tt> clause (if present) will be executed. If it is a variable name, its content will be executed.

For example:

<pre>/if shift "/echo Hello" "/echo Goodbye"
/bind j "if \$team\$ eq aliens \"/class level1upg level1\""</pre>

(Note the escaping of the cvar <tt>team</tt>.)

===irc_connect===
Start the ingame IRC client

===irc_quit===
Stop the ingame IRC client

===irc_say===
Say something in the desired IRC channel if connected to a server

===listrotation===
Lists the current map rotation. The current map is highlighted.

===loadgame===

===messagemode1===
This command opens a general chat prompt.

===messagemode2===
This command opens a team-chat prompt.

===messagemode3===
This command opens an admin chat prompt.

===messagemode4===
This command opens a chat prompt for the built-in IRC client.

===messagemodec===
This command opens a command prompt.

===modcase===
<tt>modcase MODIFIERS THEN [MODIFIERS THEN]* [ELSE]</tt>

This works like <tt>if</tt>. The leftmost most-specific <tt>THEN</tt> whose modifier list matches is the one which is executed; if none match, then <tt>ELSE</tt> is executed if it is present.

For example:
<pre>/modcase shift "/echo 1" ctrl "/echo 2" shift,ctrl "/echo 3" shift,!alt "/echo 4"</pre>
works as follows:

# if Shift and Alt (due to clause 4) but not Ctrl (due to clause 3) are pressed;
# if Ctrl but not Shift (due to clause 3);
# if Shift and Ctrl;
# if Shift but neither Alt nor Ctrl.

===modelist===

===strcmp===
Compare the string values of two cvars. ''Obsolete.''

===teambind===
<tt>teambind TEAM KEY [COMMAND…]</tt>
Binds a command (or sequence of commands) to the given key for use when on the given team, or lists the binding for that key/team.

<tt>TEAM</tt> is default, spectators, humans, or aliens. (Initial substrings are accepted.)

===toggleConsole===
Opens or closes the in-game console.

===ui_restart===
Reloads UI files.

===unalias===
<tt>unalias NAME</tt>

Removes the named alias.

===unbind===
<tt>unbind [TEAM] KEY</tt>
Removes either all bindings for the given key, or the binding for the given team on that key.

<tt>TEAM</tt> is default, spectators, humans, or aliens. (Initial substrings are accepted.)

===undelay===

===undelayAll===

===unregister===
Removes registration of your GUID and name.

==Admin commands==

===allready===
Quickly move to the next map. Used only during the intermission.

===speclock===
Prevents a player from joining a team for a given time or until the end of the current game.
If necessary, the player is moved to spectators.

===specunlock===
Allows a player, previously locked, to join a team.

==Utility commands==

===calc===
Do math calculations on cvars. Store the value to a cvar Useful in making scripts.

===concat===
Concatenate 2 cvars into a third.

===delay===

===glsl_restart===
Development use. For recompiling the GLSL shader code.

===grep===
<tt>grep TEXT</tt>

Searches the in-game console for occurrences of <tt>TEXT</tt>. Matching lines are reprinted.

===help===

===math===
Do math on cvars. Useful for scripts.

===random===
Generate a random number

===reloadhud===
Reload the HUD without a vid_restart

===screenshotPNG===
Saves a screenshot in the PNG format.

===search===
<tt>search TEXT</tt>

Searches back through the in-game console for <tt>TEXT</tt> and scrolls to it.

===searchDown===
<tt>searchDown TEXT</tt>

Searches forward through the in-game console for <tt>TEXT</tt> and scrolls to it.

===snd_reload===
Reload sounds (includes a vid_restart

===wav_record===

===wav_stoprecord===

==Special uses==

===animationlist===

===buildcubemaps===

===cache_endgather===

===cache_mapchange===

===cache_setindex===

===cache_startgather===

===cache_usedfile===

===fbolist===

===fieldinfo===

===gameCompleteStatus===

===openurl===
Open a URL inside the OS's default browser.

===pubkey===
Internal use.

===pubkey_identify===
Internal use.

===setRecommended===

===shaderexp===

===spdevmap===
Does nothing.

===spmap===
Does nothing.

===updatehunkusage===

===updatescreen===

===vbolist===

Creating custom keybinds

2013-04-22T01:32:16Z

Anomalous: Use of ±commands in bindings

{| align="right"
| __TOC__
|}

{{StatusWIP|The information on this page is incomplete.}}

==Usage==

Some simple bindings can be made via the configuration menus.

For more complicated bindings and for team bindings, you need to use the console. For example, you could bind commands to set a team and to spawn:

bind F9 "team a"
bind F10 "team h"

// attacking players
teambind aliens F5 "class level0"
teambind humans F5 "class rifle"

// builders
teambind aliens F6 "class builderupg builder"
teambind humans F6 "class ckit"

==Differences from Tremulous==

A number of commands for keybinds have changed since Tremulous, so keybind configurations cannot be directly copied from Tremulous to Unvanquished.

{| class="wikitable"
! Tremulous || Unvanquished || Used for…
|-
| <code>+button2</code> || <code>+useitem</code> || Using an item; granger spit; dragoon barb
|-
| <code>+button3</code> || <code>+taunt</code> || “Come on!” etc.
|-
| <code>+button5</code> || <code>+attack2</code> || Secondary attack
|-
| <code>+button6</code> || <code>+dodge</code> || Dodging
|-
| <code>+button7</code> || <code>+activate</code> || Using a structure; evolving
|-
| <code>+button8</code> || <code>+sprint</code> || Sprinting
|-
|}

As of alpha 3, the <code>+button''N''</code> commands are no longer present.

You may want to bind the new [[Voice say system|vsays]] to different keys.
==Gameplay commands==

This is a partial list of commands added, using Tremulous GPP r2259 as a reference point. Not everything listed is actually useful.

====Possible pitfalls====
The game handles these commands specially, in a way which has implications concerning usage.

There is one way to use them in bindings which works properly, and that's to use the command on its own.

It is possible to have other commands following one of these ''but'' this is not well handled – the game appends information about when the key was pressed but, at present, assumes that there's just one command present in the binding. It also causes problems on key-up when the <tt>+</tt>command is the first command since, while the it will (correctly) be converted to a <tt>-</tt>command, any following commands will be executed unmodifed, except for the last one (which gets the timing information).

If you need to use a binding which contains one of these with other commands then use something like “<samp>wait; +taunt; wait; -taunt</samp>”. Timing information will not be added; the server has information which allows it to calculate ‘close enough’ timing information, and there may be a knock-on effect on an immediately-following action.

===+activate===
Access an armoury; evolve.

===+attack2===
Secondary attack.

===+dodge===
Low jump sideways or backwards. (Humans only.)

===+rally===
“Come on!” etc., as in ‘follow me’.

===+sprint===
Run. (Humans only.)

===+taunt===
“Come on!” etc., as in ‘bring it on!’.

===+useitem===
Use the highlighted item; tertiary attack (granger spit, dragoon snipe).

===say_area_team===
Talk to all teammates within a server-set range.

==Configuration commands==

===alias===
<tt>alias NAME COMMAND [PARAMETERS…]</tt>

Create an alias for the given command. The alias is then useable as a command in its own right.

===aliaslist===
Lists available command aliases.

===bind===
<tt>bind KEY [COMMAND…]</tt>
Binds a command (or sequence of commands) to the given key, or lists the bindings for that key.

All existing bindings on that key are lost.

===clearaliases===
Clears all command aliases.

===cycle===

===editbind===
<tt>editbind [TEAM] KEY</tt>

This inserts a <tt>/bind</tt> or <tt>/teambind</tt> command into the in-game console, ready for editing. The console is opened if needed.

<tt>TEAM</tt> is default, spectators, humans, or aliens. (Initial substrings are accepted.)

===if===
<tt>if VALUE CONDITION VALUE THEN [ELSE]</tt>

<tt>if MODIFIERS THEN [ELSE]</tt>

; <tt>VALUE</tt> : a variable or number
; <tt>CONDITION</tt> : comparison operator
; <tt>MODIFIERS</tt> : comma-separated list of keyboard modifiers: Shift, Ctrl, Alt, Command (or Cmd), Mode, Super. Prefix any which must not be pressed with <kbd>!</kbd>.
; <tt>THEN</tt> and <tt>ELSE</tt> : either a variable name or, if prefixed with <kbd>/</kbd> or <kbd>\</kbd>, a command string.

Recognised numeric comparison operators: 
<tt> = != < <= > >= !=</tt>

Recognised string comparison operators: 
<tt> eq ne in !in</tt>

Either the <tt>THEN</tt> clause or the <tt>ELSE</tt> clause (if present) will be executed. If it is a variable name, its content will be executed.

For example:

<pre>/if shift "/echo Hello" "/echo Goodbye"
/bind j "if \$team\$ eq aliens \"/class level1upg level1\""</pre>

(Note the escaping of the cvar <tt>team</tt>.)

===irc_connect===
Start the ingame IRC client

===irc_quit===
Stop the ingame IRC client

===irc_say===
Say something in the desired IRC channel if connected to a server

===listrotation===
Lists the current map rotation. The current map is highlighted.

===loadgame===

===messagemode1===
This command opens a general chat prompt.

===messagemode2===
This command opens a team-chat prompt.

===messagemode3===
This command opens an admin chat prompt.

===messagemode4===
This command opens a chat prompt for the built-in IRC client.

===messagemodec===
This command opens a command prompt.

===modcase===
<tt>modcase MODIFIERS THEN [MODIFIERS THEN]* [ELSE]</tt>

This works like <tt>if</tt>. The leftmost most-specific <tt>THEN</tt> whose modifier list matches is the one which is executed; if none match, then <tt>ELSE</tt> is executed if it is present.

For example:
<pre>/modcase shift "/echo 1" ctrl "/echo 2" shift,ctrl "/echo 3" shift,!alt "/echo 4"</pre>
works as follows:

# if Shift and Alt (due to clause 4) but not Ctrl (due to clause 3) are pressed;
# if Ctrl but not Shift (due to clause 3);
# if Shift and Ctrl;
# if Shift but neither Alt nor Ctrl.

===modelist===

===strcmp===
Compare the string values of two cvars. ''Obsolete.''

===teambind===
<tt>teambind TEAM KEY [COMMAND…]</tt>
Binds a command (or sequence of commands) to the given key for use when on the given team, or lists the binding for that key/team.

<tt>TEAM</tt> is default, spectators, humans, or aliens. (Initial substrings are accepted.)

===toggleConsole===
Opens or closes the in-game console.

===ui_restart===
Reloads UI files.

===unalias===
<tt>unalias NAME</tt>

Removes the named alias.

===unbind===
<tt>unbind [TEAM] KEY</tt>
Removes either all bindings for the given key, or the binding for the given team on that key.

<tt>TEAM</tt> is default, spectators, humans, or aliens. (Initial substrings are accepted.)

===undelay===

===undelayAll===

===unregister===
Removes registration of your GUID and name.

==Admin commands==

===allready===
Quickly move to the next map. Used only during the intermission.

===speclock===
Prevents a player from joining a team for a given time or until the end of the current game.
If necessary, the player is moved to spectators.

===specunlock===
Allows a player, previously locked, to join a team.

==Utility commands==

===calc===
Do math calculations on cvars. Store the value to a cvar Useful in making scripts.

===concat===
Concatenate 2 cvars into a third.

===delay===

===glsl_restart===
Development use. For recompiling the GLSL shader code.

===grep===
<tt>grep TEXT</tt>

Searches the in-game console for occurrences of <tt>TEXT</tt>. Matching lines are reprinted.

===help===

===math===
Do math on cvars. Useful for scripts.

===random===
Generate a random number

===reloadhud===
Reload the HUD without a vid_restart

===screenshotPNG===
Saves a screenshot in the PNG format.

===search===
<tt>search TEXT</tt>

Searches back through the in-game console for <tt>TEXT</tt> and scrolls to it.

===searchDown===
<tt>searchDown TEXT</tt>

Searches forward through the in-game console for <tt>TEXT</tt> and scrolls to it.

===snd_reload===
Reload sounds (includes a vid_restart

===wav_record===

===wav_stoprecord===

==Special uses==

===animationlist===

===buildcubemaps===

===cache_endgather===

===cache_mapchange===

===cache_setindex===

===cache_startgather===

===cache_usedfile===

===fbolist===

===fieldinfo===

===gameCompleteStatus===

===openurl===
Open a URL inside the OS's default browser.

===pubkey===
Internal use.

===pubkey_identify===
Internal use.

===setRecommended===

===shaderexp===

===spdevmap===
Does nothing.

===spmap===
Does nothing.

===updatehunkusage===

===updatescreen===

===vbolist===

UI/Implementation

2013-03-30T10:41:50Z

Anomalous: /* Ownerdraws */

User interface code runs in its own [[Virtual_machines|virtual machine]]. Source code for handling user interface controls and loading UI files may be found in <code>[https://github.com/Unvanquished/Unvanquished/tree/master/src/gamelogic/ui src/gamelogic/ui/]</code>; the actual UI content is controlled by configuration files found in <code>[https://github.com/Unvanquished/Unvanquished/tree/master/main/ui main/ui/]</code>. The list of menu files is found in <code>[https://github.com/Unvanquished/Unvanquished/tree/master/main/ui/menus.txt main/ui/menus.txt]</code>. The game will not run without this file present.

==Weapon icons==

Weapon icons are controlled by the <code>icon</code> entry in the weapon's [[Exporting_Models#Weapons_2|configuration file]].

==Editing tools==

There is a Quake 3 HUD editor called [http://plrf.org/q3cpmahudeditor/ q3cmpa hud editor] (which is no longer maintained), and a newer version called [http://plrf.org/superhudeditor/ SuperHud Editor], which appears to be built using wxWidgets.

==Troubleshooting==

===Game crashes for an unknown reason===

Your <code>[https://github.com/Unvanquished/Unvanquished/tree/master/main/ui/menudef.h main/ui/menudef.h]</code> file may be out of date. 

==Transition to libRocket==

A move to use [http://librocket.com/ libRocket] has been planned with support underway. This middleware will allow creating the user interface using HTML and CSS. If you are interested in assisting with the transition, please [[Main_Page#Contributing|contact a member of the team]] to find out how to help.

===libRocket Progress===
====Data Sources (aka feeders)====
*Resolutions - list of resolutions
*VoIP Input - Input devices for OpenAL
*AL Output - Output devices for OpenAL
*HUDS - List of HUDs to choose from
*Languages - List of languages
*Mods - List of mods
*Demos - List of demos
*Maps - List of maps
*Players on team - List of players on each team
*Players - List of players. This and above can probably be combined.
*Server status - Detailed information on a server // Probably can implement without a feeder.
*Find player - Results for a multiserver player search.
*Team list - List of available teams
*Classes - List of classes per team
*Items - List of available items per team
*Armory items - List of items. Can probably be merged with above.
*Alien evo classes - List of classes that can be evo'd to.
*Buildable menu - List of buildables that can be built
*Ignore - List of players/patterns player has ignored
*Help - List of help topics

====Missing Elements====
*Chat field - Field for chat.
*Selectable datagrid - Selectable table, essentially. Warsow has this. Can probably port.
*Model view - Display a model. Low priority imo. Won't do unless there is demand.
*Keyselect - Detect which key is pressed. For binds.

====Ownerdraws====
*<health /> - Player health
*<bar item=(current value) maxValue=(max value) img=(image to draw) direction=(left|right|up|down) /> - Draw a bar for this item. Both $item and $maxvalue are cvars that say the value and maxvalue. img determines which image to draw, if a rectangular bar is not desired. direction is direction it decreases.
*<ammo type=(all|clip) /> - Current ammo value. Type determines whetehr to show current clip's ammo or total ammo.
*<clips /> - Current number of clips
*<btimer /> - Build timer display
*<credits precision=(decimal places) /> - Credits/evos available.
*<stamina /> - Available stamina
*<boost /> - Boosted status and time remaining
*<selected /> - Item selected
*<weapon /> - selected weapon icon
*<wallclimb /> - Wall climbing status indicator
*<alien_sense /> - Alien radar
*<scanner /> - Human radar
*<useable_buildable /> - Indicator that you are near a usable buildable
*<location /> - Player location text
*<team_overlay /> - Team overlay which shows useful team info
*<fps /> - Frames per second
*<timer /> - Time since game began
*<lagometer /> - Lagometer. Quality of connection
*<speedometer /> - Wheeee. Current speed.
*<crosshair_name /> - Name of player in crosshair
*<stage_report /> - Stage report. % of mapcontrol needed for next stage
*<demo /> - State of demo. eg, recording/playing

UI/Implementation

2013-03-30T10:41:28Z

Anomalous: Format string is a bad idea for credits/evos

User interface code runs in its own [[Virtual_machines|virtual machine]]. Source code for handling user interface controls and loading UI files may be found in <code>[https://github.com/Unvanquished/Unvanquished/tree/master/src/gamelogic/ui src/gamelogic/ui/]</code>; the actual UI content is controlled by configuration files found in <code>[https://github.com/Unvanquished/Unvanquished/tree/master/main/ui main/ui/]</code>. The list of menu files is found in <code>[https://github.com/Unvanquished/Unvanquished/tree/master/main/ui/menus.txt main/ui/menus.txt]</code>. The game will not run without this file present.

==Weapon icons==

Weapon icons are controlled by the <code>icon</code> entry in the weapon's [[Exporting_Models#Weapons_2|configuration file]].

==Editing tools==

There is a Quake 3 HUD editor called [http://plrf.org/q3cpmahudeditor/ q3cmpa hud editor] (which is no longer maintained), and a newer version called [http://plrf.org/superhudeditor/ SuperHud Editor], which appears to be built using wxWidgets.

==Troubleshooting==

===Game crashes for an unknown reason===

Your <code>[https://github.com/Unvanquished/Unvanquished/tree/master/main/ui/menudef.h main/ui/menudef.h]</code> file may be out of date. 

==Transition to libRocket==

A move to use [http://librocket.com/ libRocket] has been planned with support underway. This middleware will allow creating the user interface using HTML and CSS. If you are interested in assisting with the transition, please [[Main_Page#Contributing|contact a member of the team]] to find out how to help.

===libRocket Progress===
====Data Sources (aka feeders)====
*Resolutions - list of resolutions
*VoIP Input - Input devices for OpenAL
*AL Output - Output devices for OpenAL
*HUDS - List of HUDs to choose from
*Languages - List of languages
*Mods - List of mods
*Demos - List of demos
*Maps - List of maps
*Players on team - List of players on each team
*Players - List of players. This and above can probably be combined.
*Server status - Detailed information on a server // Probably can implement without a feeder.
*Find player - Results for a multiserver player search.
*Team list - List of available teams
*Classes - List of classes per team
*Items - List of available items per team
*Armory items - List of items. Can probably be merged with above.
*Alien evo classes - List of classes that can be evo'd to.
*Buildable menu - List of buildables that can be built
*Ignore - List of players/patterns player has ignored
*Help - List of help topics

====Missing Elements====
*Chat field - Field for chat.
*Selectable datagrid - Selectable table, essentially. Warsow has this. Can probably port.
*Model view - Display a model. Low priority imo. Won't do unless there is demand.
*Keyselect - Detect which key is pressed. For binds.

====Ownerdraws====
*<health /> - Player health
*<bar item=(current value) maxValue=(max value) img=(image to draw) direction=(left|right|up|down) /> - Draw a bar for this item. Both $item and $maxvalue are cvars that say the value and maxvalue. img determines which image to draw, if a rectangular bar is not desired. direction is direction it decreases.
*<ammo type=(all|clip) /> - Current ammo value. Type determines whetehr to show current clip's ammo or total ammo.
*<clips /> - Current number of clips
*<btimer /> - Build timer display
*<credits precision=(decimal places)> - Credits/evos available.
*<stamina /> - Available stamina
*<boost /> - Boosted status and time remaining
*<selected /> - Item selected
*<weapon /> - selected weapon icon
*<wallclimb /> - Wall climbing status indicator
*<alien_sense /> - Alien radar
*<scanner /> - Human radar
*<useable_buildable /> - Indicator that you are near a usable buildable
*<location /> - Player location text
*<team_overlay /> - Team overlay which shows useful team info
*<fps /> - Frames per second
*<timer /> - Time since game began
*<lagometer /> - Lagometer. Quality of connection
*<speedometer /> - Wheeee. Current speed.
*<crosshair_name /> - Name of player in crosshair
*<stage_report /> - Stage report. % of mapcontrol needed for next stage
*<demo /> - State of demo. eg, recording/playing

Armoury

2013-03-24T20:52:50Z

Anomalous: Redirected page to Armory

#REDIRECT [[Armory]]

Creating custom keybinds

2013-02-03T23:00:08Z

Anomalous:

{| align="right"
| __TOC__
|}

{{StatusWIP|The information on this page is incomplete.}}

==Usage==

Some simple bindings can be made via the configuration menus.

For more complicated bindings and for team bindings, you need to use the console. For example, you could bind commands to set a team and to spawn:

bind F9 "team a"
bind F10 "team h"

// attacking players
teambind aliens F5 "class level0"
teambind humans F5 "class rifle"

// builders
teambind aliens F6 "class builderupg builder"
teambind humans F6 "class ckit"

==Differences from Tremulous==

A number of commands for keybinds have changed since Tremulous, so keybind configurations cannot be directly copied from Tremulous to Unvanquished.

{| class="wikitable"
! Tremulous || Unvanquished || Used for…
|-
| <code>+button2</code> || <code>+useitem</code> || Using an item; granger spit; dragoon barb
|-
| <code>+button3</code> || <code>+taunt</code> || “Come on!” etc.
|-
| <code>+button5</code> || <code>+attack2</code> || Secondary attack
|-
| <code>+button6</code> || <code>+dodge</code> || Dodging
|-
| <code>+button7</code> || <code>+activate</code> || Using a structure; evolving
|-
| <code>+button8</code> || <code>+sprint</code> || Sprinting
|-
|}

As of alpha 3, the <code>+button''N''</code> commands are no longer present.

You may want to bind the new [[Voice say system|vsays]] to different keys.
==Gameplay commands==

This is a partial list of commands added, using Tremulous GPP r2259 as a reference point. Not everything listed is actually useful.

===+activate===
Access an armoury; evolve.

===+attack2===
Secondary attack.

===+dodge===
Low jump sideways or backwards. (Humans only.)

===+rally===
“Come on!” etc., as in ‘follow me’.

===+sprint===
Run. (Humans only.)

===+taunt===
“Come on!” etc., as in ‘bring it on!’.

===+useitem===
Use the highlighted item; tertiary attack (granger spit, dragoon snipe).

===say_area_team===
Talk to all teammates within a server-set range.

==Configuration commands==

===alias===
<tt>alias NAME COMMAND [PARAMETERS…]</tt>

Create an alias for the given command. The alias is then useable as a command in its own right.

===aliaslist===
Lists available command aliases.

===bind===
<tt>bind KEY [COMMAND…]</tt>
Binds a command (or sequence of commands) to the given key, or lists the bindings for that key.

All existing bindings on that key are lost.

===clearaliases===
Clears all command aliases.

===cycle===

===editbind===
<tt>editbind [TEAM] KEY</tt>

This inserts a <tt>/bind</tt> or <tt>/teambind</tt> command into the in-game console, ready for editing. The console is opened if needed.

<tt>TEAM</tt> is default, spectators, humans, or aliens. (Initial substrings are accepted.)

===if===
<tt>if VALUE CONDITION VALUE THEN [ELSE]</tt>

<tt>if MODIFIERS THEN [ELSE]</tt>

; <tt>VALUE</tt> : a variable or number
; <tt>CONDITION</tt> : comparison operator
; <tt>MODIFIERS</tt> : comma-separated list of keyboard modifiers: Shift, Ctrl, Alt, Command (or Cmd), Mode, Super. Prefix any which must not be pressed with <kbd>!</kbd>.
; <tt>THEN</tt> and <tt>ELSE</tt> : either a variable name or, if prefixed with <kbd>/</kbd> or <kbd>\</kbd>, a command string.

Recognised numeric comparison operators: 
<tt> = != < <= > >= !=</tt>

Recognised string comparison operators: 
<tt> eq ne in !in</tt>

Either the <tt>THEN</tt> clause or the <tt>ELSE</tt> clause (if present) will be executed. If it is a variable name, its content will be executed.

For example:

<pre>/if shift "/echo Hello" "/echo Goodbye"
/bind j "if \$team\$ eq aliens \"/class level1upg level1\""</pre>

(Note the escaping of the cvar <tt>team</tt>.)

===irc_connect===
Start the ingame IRC client

===irc_quit===
Stop the ingame IRC client

===irc_say===
Say something in the desired IRC channel if connected to a server

===listrotation===
Lists the current map rotation. The current map is highlighted.

===loadgame===

===messagemode1===
This command opens a general chat prompt.

===messagemode2===
This command opens a team-chat prompt.

===messagemode3===
This command opens an admin chat prompt.

===messagemode4===
This command opens a chat prompt for the built-in IRC client.

===messagemodec===
This command opens a command prompt.

===modcase===
<tt>modcase MODIFIERS THEN [MODIFIERS THEN]* [ELSE]</tt>

This works like <tt>if</tt>. The leftmost most-specific <tt>THEN</tt> whose modifier list matches is the one which is executed; if none match, then <tt>ELSE</tt> is executed if it is present.

For example:
<pre>/modcase shift "/echo 1" ctrl "/echo 2" shift,ctrl "/echo 3" shift,!alt "/echo 4"</pre>
works as follows:

# if Shift and Alt (due to clause 4) but not Ctrl (due to clause 3) are pressed;
# if Ctrl but not Shift (due to clause 3);
# if Shift and Ctrl;
# if Shift but neither Alt nor Ctrl.

===modelist===

===strcmp===
Compare the string values of two cvars. ''Obsolete.''

===teambind===
<tt>teambind TEAM KEY [COMMAND…]</tt>
Binds a command (or sequence of commands) to the given key for use when on the given team, or lists the binding for that key/team.

<tt>TEAM</tt> is default, spectators, humans, or aliens. (Initial substrings are accepted.)

===toggleConsole===
Opens or closes the in-game console.

===ui_restart===
Reloads UI files.

===unalias===
<tt>unalias NAME</tt>

Removes the named alias.

===unbind===
<tt>unbind [TEAM] KEY</tt>
Removes either all bindings for the given key, or the binding for the given team on that key.

<tt>TEAM</tt> is default, spectators, humans, or aliens. (Initial substrings are accepted.)

===undelay===

===undelayAll===

===unregister===
Removes registration of your GUID and name.

==Admin commands==

===allready===
Quickly move to the next map. Used only during the intermission.

===speclock===
Prevents a player from joining a team for a given time or until the end of the current game.
If necessary, the player is moved to spectators.

===specunlock===
Allows a player, previously locked, to join a team.

==Utility commands==

===calc===
Do math calculations on cvars. Store the value to a cvar Useful in making scripts.

===concat===
Concatenate 2 cvars into a third.

===delay===

===glsl_restart===
Development use. For recompiling the GLSL shader code.

===grep===
<tt>grep TEXT</tt>

Searches the in-game console for occurrences of <tt>TEXT</tt>. Matching lines are reprinted.

===help===

===math===
Do math on cvars. Useful for scripts.

===random===
Generate a random number

===reloadhud===
Reload the HUD without a vid_restart

===screenshotPNG===
Saves a screenshot in the PNG format.

===search===
<tt>search TEXT</tt>

Searches back through the in-game console for <tt>TEXT</tt> and scrolls to it.

===searchDown===
<tt>searchDown TEXT</tt>

Searches forward through the in-game console for <tt>TEXT</tt> and scrolls to it.

===snd_reload===
Reload sounds (includes a vid_restart

===wav_record===

===wav_stoprecord===

==Special uses==

===animationlist===

===buildcubemaps===

===cache_endgather===

===cache_mapchange===

===cache_setindex===

===cache_startgather===

===cache_usedfile===

===fbolist===

===fieldinfo===

===gameCompleteStatus===

===openurl===
Open a URL inside the OS's default browser.

===pubkey===
Internal use.

===pubkey_identify===
Internal use.

===setRecommended===

===shaderexp===

===spdevmap===
Does nothing.

===spmap===
Does nothing.

===updatehunkusage===

===updatescreen===

===vbolist===

Compiling the source

2013-02-03T22:56:07Z

Anomalous: /* Debian/Ubuntu */

==Mac OS X==

First, you need to [[Getting_the_source|acquire the source code]].

Regardless of what interface you may use to compile the source, you will need [http://www.cmake.org/cmake/resources/software.html CMake] to generate makefiles. You will also need to install [https://developer.apple.com/xcode/ XCode] (making sure to choose to install the command-line utilities when prompted by the installer).

Then, you will need to acquire (and in some cases, manually compile) at a minimum the [[#Dependencies|necessary libraries]].

Once you have the source code and the libraries installed, you may actually proceed to compile the source. You have several options:
* '''Compile the source at the command line'''. This is the easiest if you would just like to compile the game to use yourself and you do not intend to work on the code.
* '''Compile the source using an IDE'''. This is preferred if you intend on developing the source.
** XCode is Apple's flagship IDE and you should have installed to compile the source regardless of which method you use.
** [http://qt-project.org/downloads QtCreator] is cross-platform and provides real-time feedback of syntax errors, a Vim mode, as well as other features.
** [http://www.codeblocks.org/ Code::Blcoks] is also cross-platform but lacks some of the features of XCode and QtCreator.

===Dependencies===

You only need to use one of the following methods (HomeBrew or compiling by hand). Please try and avoid mixing methods as this may produce unexpected results.

Unvanquished requires the following libraries:
* [[#JPEG|JPEG]], version 8 or higher. (Version 6 was known to have problems)
* [[#Simple_DirectMedia_Layer_.28SDL.29|Simple DirectMedia Layer]] (The binary provided by libsdl.org causes graphical corruptions. Compile from source or use homebrew/macports)
* [[#The_OpenGL_Extension_Wrangler_Library_.28GLEW.29|The OpenGL Extension Wrangler Library]]
* CuRL
* [[#The_GNU_MP_Bignum_Library_.28libgmp.29|GMP]]
* [[#WebP|WebP]] (v0.2.0 or newer)

The following libraries are optional:
* Theora
* Speex
* [[#Ogg|Ogg]]
* [[#Vorbis|Vorbis]]

====HomeBrew====
Install [http://mxcl.github.com/homebrew/ HomeBrew] and then run the following command

$ brew install nettle libjpeg curl sdl webp xvid gmp glew speex libvorbis theora

All the necessary libraries should now have been installed.

====Compiling by hand====
The following are shell scripts that download, compile, and install various libraries. This is more time consuming then other methods but might be useful if you need more control over your libraries

=====JPEG=====

$ curl http://www.ijg.org/files/jpegsrc.v8d.tar.gz > jpegsrc.v8d.tar.gz
$ tar xvzf jpegsrc.v8d.tar.gz
$ cd jpeg-8d
$ ./configure
$ make
$ sudo make install

=====The OpenGL Extension Wrangler Library (GLEW)=====

$ curl -L https://sourceforge.net/projects/glew/files/glew/1.7.0/glew-1.7.0.tgz/download > glew-1.7.0.tgz
$ tar xvzf glew-1.7.0.tgz
$ cd glew-1.7.0
$ make
$ sudo make install

=====Simple DirectMedia Layer (SDL)=====

Do not use the binaries provided by libsdl.org, as these are known to cause issues with gamma and color display. Instead, compile your own:

$ curl http://www.libsdl.org/release/SDL-1.2.15.tar.gz > SDL-1.2.15.tar.gz
$ tar xvzf SDL-1.2.15.tar.gz
$ cd SDL-1.2.15
$ ./configure
$ make
$ sudo make install

=====The GNU MP Bignum Library (libgmp)=====

$ curl ftp://ftp.gmplib.org/pub/gmp-5.0.5/gmp-5.0.5.tar.bz2 > gmp-5.0.5.tar.bz2
$ tar xvjf gmp-5.0.5.tar.bz2
$ cd gmp-5.0.5
$ ./configure
$ make
$ sudo make install

=====Ogg=====

$ curl http://downloads.xiph.org/releases/ogg/libogg-1.3.0.tar.gz > libogg-1.3.0.tar.gz
$ tar xvzf libogg-1.3.0.tar.gz
$ cd libogg-1.3.0
$ ./configure
$ make
$ sudo make install

=====Vorbis=====

$ curl http://downloads.xiph.org/releases/vorbis/libvorbis-1.3.3.tar.gz > libvorbis-1.3.3.tar.gz
$ tar xvzf libvorbis-1.3.3.tar.gz
$ cd libvorbis-1.3.3
$ ./configure
$ make
$ sudo make install

=====WebP=====

You do not need to compile WebP by hand; Google provides binaries for Mac OS X available from their [https://code.google.com/p/webp/downloads/detail?name=libwebp-0.2.0-mac-10.5.tar.gz project page]. You will need version 0.2.0 or newer.

Once downloaded, you must still install the header files and the binary:

$ curl https://webp.googlecode.com/files/libwebp-0.2.0-mac-10.5.tar.gz > libwebp-0.2.0-mac-10.5.tar.gz
$ tar xvzf libwebp-0.2.0-mac-10.5.tar.gz
$ cd libwebp-0.2.0-mac-10.5
$ sudo cp include/webp /usr/local/include
$ sudo cp lib/libwebp.a /usr/local/lib

===Configuring with CMake===

# Run CMake.
# Enter the location of the source code.
# Enter the location in which you would like to build the source code. This should be a different directory.
# Hit "Configure". You will be prompted as to which generator you would like to use. If you have Xcode installed, choose that. Wait while the configuration process runs. You may have to set the following:
## If CMake did not find your jpeg headers for some reason, set <code>JPEG_INCLUDE_DIR</code> to <code>/path/to/Unvanquished/src/libs/jpeg</code>.
## Check <code>USE_INTERNAL_CRYPTO</code> to avoid having to compile nettle and hogweed.
## Check <code>USE_INTERNAL_SPEEX</code> to avoid having to compile Speex.
## Uncheck <code>USE_CIN_THEORA</code> and <code>USE_CIN_XVID</code> to avoid having to compile Theora or Xvid. (At present, there are not cutscenes or any such that require it.)
## '''You will probably not be able to compile with the GLSL optimizer enabled; uncheck <code>USE_GLSL_OPTIMIZER</code>'''
## If you have selected to generate XCode project files, make the <code>SDLMAIN_LIBRARY</code> field blank. This option is not available if you have the generator set to Unix makefiles.
# Hit "Generate".
# You may now close XCode.

===Compiling===

====With XCode====

<ol>
<li>Compilation will fail unless you manually create certain directories needed by the build scripts:
<pre>
$ cd /path/to/build/dir/CMakeFiles
$ mkdir gpp{game,trem,ui}-qvm.dir
</pre>
This is a workaround to {{Issue|101}}.
</li>
<li>Either start XCode and open the project file (in the build directory you specified) or double-click the project file in Finder.</li>
<li>Open the project file created by CMake, which should be in the build directory you specified.</li>
<li>Change the active target to "ALL_BUILD" and click Product→Build.</li>
</ol>

====With Unix Makefiles====

<ul>
<li>Start Terminal (Applications → Utilities → Terminal).</li>
<li>Input the following commands:
<pre>
$ cd /path/to/Unvanquished-build
$ make
</pre>
If you are on a multi-core or multi-processor machine, you may speed up the process by passing the <code>-j</code> argument followed by the number of available cores to <code>make</code>; e.g., <code>make -j4</code>. Note that doing so makes reading error messages more difficult, as multiple instances of the compiler will print to the screen at once, causing information to appear out of order.
</li>
</ul>

===Testing the build===

====With XCode 4====

To test the game, select the "client" scheme from the combo box on the toolbar, and click the run button or press {{Hotkey|MacCommand}}{{Hotkey|R}}.

====With Unix Makefiles====

After compiling, you'll have to place the data files in the <code>main</code> directory in your build directory. [[#Acquiring the Game Files|For download instructions, see below.]]

Your file structure should look as follows:

[[File:Build_dir_Mac_OS_X.png]]

You may now start the application as such:

$ ./daemon.i386

Note that older machines will not support the new OpenGL 3 renderer, and must be started specifying the "vanilla" (aka "GL") renderer:

$ ./daemon.i386 +set cl_renderer GL

===Bundling the Application===

====With CPack====

CPack is able to create standalone bundles (as well as many other types of installers). However you must generate the files using Unix Makefiles instead of XCode.

$ cd /path/to/Unvanquished-build
$ cpack -G Bundle

Some warnings will be printed however these can be safely ignored. There should be a file called Unvanquished.dmg in the Unvanquished-build folder.

====Manually====

You'll find the Mac [http://macdylibbundler.sourceforge.net/ dynamic library bundler] to be quite useful (you must generate the files using Unix Makefiles instead of XCode):

$ curl -L http://sourceforge.net/projects/macdylibbundler/files/macdylibbundler/0.4.1/dylibbundler0.4.1.zip/download > \
dylibbundler0.4.1.zip
$ unzip dylibbundler0.4.1.zip
$ cd dylibbundler
$ make
$ sudo make install

Once you've done that, you can proceed to create the application bundle. Note that these steps assume that you have downloaded the data files to <code>main/</code> as shown above:

<pre>
$ git=/path/to/Unvanquished-git-repo
$ build=/path/to/Unvanquished-build-dir
$ mkdir -pv Unvanquished.app/Contents/{libs,MacOS,Resources,Frameworks}
$ cp -r $build/main Unvanquished.app/Contents/MacOS
$ sips -s format tiff $git/debian/unvanquished.png --out temp.tiff
$ tiff2icns temp.tiff Unvanquished.app/Contents/Resources/Unvanquished.icns
$ rm temp.tiff
$ cp $build/daemon{,ded}.i386 $build/*.dylib Unvanquished.app/Contents/MacOS
$ cp -r /Library/Frameworks/SDL.framework Unvanquished.app/Contents/Frameworks
$ install_name_tool -id \
@executable_path/../Frameworks/SDL.framework/Versions/A/SDL \
Unvanquished.app/Contents/Frameworks/SDL.framework/Versions/A/SDL
$ install_name_tool -change @rpath/SDL.framework/Versions/A/SDL \
@executable_path/../Frameworks/SDL.framework/Versions/A/SDL \
Unvanquished.app/Contents/MacOS/daemon.i386
$ install_name_tool -change @rpath/SDL.framework/Versions/A/SDL \
@executable_path/../Frameworks/SDL.framework/Versions/A/SDL \
Unvanquished.app/Contents/MacOS/librendererGLi386.dylib
$ install_name_tool -change @rpath/SDL.framework/Versions/A/SDL \
@executable_path/../Frameworks/SDL.framework/Versions/A/SDL \
Unvanquished.app/Contents/MacOS/librendererGL3i386.dylib
$ for binary in Unvanquished.app/Contents/MacOS/*.{i386,dylib}; do
dylibbundler -b -x $binary -d $dest/Unvanquished.app/Contents/libs/; done
$ cp /usr/lib/libGLEW.1.7.0.dylib ./Unvanquished.app/Contents/libs/libGLEW.1.7.0.dylib
$ chmod +w ./Unvanquished.app/Contents/libs/libGLEW.1.7.0.dylib
$ install_name_tool -id @executable_path/../libs/libGLEW.1.7.0.dylib \
./Unvanquished.app/Contents/libs/libGLEW.1.7.0.dylib
$ install_name_tool -change /usr/lib/libGLEW.1.7.0.dylib \
@executable_path/../libs/libGLEW.1.7.0.dylib \
./Unvanquished.app/Contents/MacOS/daemon.i386
$ cat > Unvanquished.app/Contents/Info.plist
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN"
"http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>CFBundleName</key>
<string>Unvanquished</string>
<key>CFBundleDisplayName</key>
<string>Unvanquished</string>
<key>CFBundleExecutable</key>
<string>daemon.i386</string>
<key>CFBundleIconFile</key>
<string>Unvanquished.icns</string>
<key>CFBundleIdentifier</key>
<string>net.Unvanquished</string>
<key>CFBundleInfoDictionaryVersion</key>
<string>6.0</string>
<key>CFBundlePackageType</key>
<string>APPL</string>
<key>CFBundleShortVersionString</key>
<string>0.4.0</string>
<key>CFBundleVersion</key>
<string>0.4.0</string>
</dict>
</plist>
^d
</pre>

Note: <code>^d</code> indicates pressing {{Hotkey|Ctrl}}{{Hotkey|D}} on the keyboard.

The contents of the completed application bundle should look like this:

[[File:Bundle_dir_Mac_OS_X.png]]

'''Note''': If you compiled SDL from source, you will not see a directory titled <code>SDL.framework</code>.

==Windows==

===Visual Studio===

CMake can generate Visual Studio projects for unvanquished however this feature is relatively new and may have some bugs.

Steps:

# Double click on Visual_Studio32.bat
# Open build-32/Daemon.sln in Visual Studio 2010.
# In the two text boxes in the toolbar, select "Release" or "Debug" in the first one and Win32 in the second one
# Press F5 to build solution and run application, or just use Build → Build Solution to compile the code.

====Important Notes====

* LLVM is disabled and does not work correctly with CMake generated Visual Studio projects.
* ncurses is not supported under Visual Studio.
* The path to the build folder must not have any spaces otherwise generation of QVMs will fail. See [https://github.com/Unvanquished/Unvanquished/issues/102 issue 102]
* Due to limitations with cmake neither the startup project nor the working directory can be specified. These must be manually set to the following values for debugging the client under Visual Studio
** Right click on client and select "Set as StartUp project".
** Right click on client, select properties, select Debugging and set "Working Directory" to $(TargetPath)\..

===MinGW===

Unvanquished is supported under MinGW. The build process should be fairly similar to the Linux instructions.

The easiest way to acquire and install MinGW is with the graphical [http://sourceforge.net/projects/mingw/files/Installer/mingw-get-inst/ mingw-get-inst installer]. 

When configuring the build with CMake, you will find that you will have to set a number of libraries manually. You can find precompiled DLLs for most of the dependencies; those that are not pre-compiled can be built with the corresponding <code>USE_INTERNAL_</code> setting.

The easiest way to get a build up (at the time of writing) is as follows: 

{{Note|content=Be aware that some of these paths are for the 64 bit versions of libraries; if you are on a 32-bit system, you will need to change some of these paths. The easiest way to locate libraries is to navigate in Windows Explorer to the <code>src/libs</code> directory and search for files matching <code>dll</code>.}}

<ol>

<li>Set the following CMake flags:
{| class="wikitable"
! Setting
! Description
! Type
! Value
|-
| <code>USE_INTERNAL_CRYPTO</code>
| Use the provided copies of crypto libraries. 
| <code>BOOL</code>
| <code>true</code>
|-
| <code>USE_INTERNAL_GLEW</code>
| Use the provided copy of GLEW.
| <code>BOOL</code>
| <code>true</code>
|-
| <code>USE_INTERNAL_JPEG</code>
| Use the provided copy of JPEG.
| <code>BOOL</code>
| <code>true</code>
|-
| <code>USE_INTERNAL_SDL</code>
| Use the provided copy of SDL.
| <code>BOOL</code>
| <code>true</code>
|-
| <code>USE_INTERNAL_SPEEX</code>
| Use the provided copy of Speex.
| <code>BOOL</code>
| <code>true</code>
|-
| <code>USE_INTERNAL_WEBP</code>
| Use the provided copy of WebP.
| <code>BOOL</code>
| <code>true</code>
|-
| <code>USE_CURSES</code>
| Enables/disables curses.
| <code>BOOL</code>
| <code>false</code>
|-
| <code>PNG_LIBRARY</code>
| Path to the PNG library DLL.
| <code>FILEPATH</code>
| <code><var>SourcePath</var>/src/libs/libpng/libs/win64/libpng14-14.dll</code>
|-
| <code>PNG_PNG_INCLUDE_DIR</code>
| Path to the PNG library header files.
| <code>PATH</code>
| <code><var>SourcePath</var>/src/libs/libpng</code>
|-
| <code>FREETYPE_LIBRARY</code>
| Path to the compiled FreeType library.
| <code>FILEPATH</code>
| <code><var>SourcePath</var>/src/libs/freetype/lib/x64/freetype.dll</code>
|-
| <code>FREETYPE_INCLUDE_DIR_freetype2</code>
| Path to the FreeType library header files.
| <code>PATH</code>
| <code><var>SourcePath</var>/src/libs/freetype/include/freetype2</code>
|-
| <code>FREETYPE_INCLUDE_DIR_ft2build</code>
| Path to the FreeType library file "ftbuild.h".
| <code>FILEPATH</code>
| <code><var>SourcePath</var>/src/libs/freetype/include/ftbuild.h</code>
|-
| <code>GMP_INCLUDE_DIR</code>
| Path to the GMP library header files.
| <code>PATH</code>
| <code><var>SourcePath</var>/src/libs/gmp/include</code>
|-
| <code>GMP_LIBRARY</code>
| Path to the GMP library.
| <code>FILEPATH</code>
| <code><var>SourcePath</var></code>
|-
| <code>ZLIB_INCLUDE_DIR</code>
| Path to the zlib library header files.
| <code>PATH</code>
| <code><var>SourcePath</var>/src/libs/zlibwapi/include</code>
|-
| <code>ZLIB_LIBRARY</code>
| Path to the zlib library.
| <code>FILEPATH</code>
| <code><var>SourcePath</var>/src/libs/zlibwapi/lib/x64/zlib1.dll</code>
|-
| <code>CURL_LIBRARY</code>
| Path to the CURL library.
| <code>FILEPATH</code>
| <code><var>SourcePath</var>/src/libs/curl-7.21.6/lib/win64/release/libcurl.dll</code>
|-
| <code>CURL_INCLUDE_DIR</code>
| Path to the zlib library.
| <code>PATH</code>
| <code><var>SourcePath</var>/src/libs/curl-7.21.6/include/curl</code>
|-
| <code>USE_OPENAL</code>
| Enables/disables OpenAL support.
| <code>BOOL</code>
| <code>false</code>
|-
| <code>USE_CIN_THEORA</code>
| Enables/disables Theora support.
| <code>BOOL</code>
| <code>false</code>
|-
| <code>USE_CIN_XVID</code>
| Enables/disables Xvid support.
| <code>BOOL</code>
| <code>false</code>
|-
| <code>USE_CODEC_THEORA</code>
| Enables/disables Ogg support.
| <code>BOOL</code>
| <code>false</code>
|-
| <code>SDLMAIN_LIBRARY</code>
| Enables/disables Ogg support.
| <code>FILEPATH</code>
| <code><var>SourcePath</var>/src/libs/libsdl/src/main/win32/SDL_win32_main.c</code>
|-
|}
Do note that CMake is slash-direction–agnostic; it can handle both forward- and backslashes on Windows.
</li>
</ol>

For a more fully-featured build:
* If you would like to use curses, try using [http://sourceforge.net/projects/pdcurses/files/pdcurses PDCurses].

==Linux==

===Dependencies===


====Debian/Ubuntu====

$ sudo apt-get install libcurl4-gnutls-dev libfreetype6-dev libglew1.5-dev \
libgmp3-dev libjpeg8-dev libncurses5-dev libogg-dev libopenal-dev \
libpng12-dev libsdl1.2-dev libvorbis-dev zlib1g-dev nettle-dev \
libwebp-dev libspeexdsp-dev libtheora-dev

If the version of WebP supplied by your version of Debian or Ubuntu is older than v0.2.0, you will need to [https://code.google.com/p/webp/downloads/detail?name=libwebp-0.2.0.tar.gz download] and [https://developers.google.com/speed/webp/docs/compiling#unix compile it from source]. After compiling and installing with <code>sudo make install</code>, in CMake, you'll need to set <code>WEBP_INCLUDE_DIR</code> to <code>/usr/local/include/webp</code> and <code>WEBP_LIBRARY</code> to <code>/usr/local/lib/libwebp.so</code>.

'''We currently provide a ready-to-use libwebp-dev in our [http://{{SERVERNAME}}/index.php/Download#ubuntu Debian and Ubuntu repositories], alongside .debs of the game and server.'''

Actual dev package names may vary, e.g. libgmp-dev instead of libgmp3-dev and libglew-dev or libglew1.7-dev instead of libglew1.5-dev.

Since we have a debian directory in the source, you can also to check what's needed then install the listed packages (choosing from alternatives as needed):

$ cd <var>/path/to/unvanquished</var>
$ dpkg-checkbuilddeps
…
$ sudo apt-get install <var>package(s)</var>

If dpkg-checkbuilddeps produces no output, you have all necessary build dependencies. Also, debhelper's only needed if you're building .debs.

====Gentoo====

$ emerge curl freetype glew gmp jpeg ncurses libogg openal libpng libsdl libvorbis zlib

====openSUSE====

$ sudo install zypper gcc gcc-c++ Mesa-libGL-devel SDL-devel libjpeg8-devel \
libpng12-devel glew-devel webp-devel ncurses-devel gmp-devel libcurl-devel \
libnettle-devel openal-soft-devel speex-devel libvorbis-devel \
libtheora-devel

The latest version of WebP must be installed manually:

$ wget https://webp.googlecode.com/files/libwebp-0.2.1.tar.gz
$ tar xvzf libwebp-0.2.1.tar.gz
$ cd libwebp-0.2.1
$ ./configure && make
$ sudo make install

You must disable curses (set <code>USE_CURSES</code> appropriately in CMake) as failing to do so will cause Unvanquished to crash on startup.

===Configuring the code with CMake===

After you have [[Getting the source|acquired the source code]], you can proceed to compile. Unvanquished uses CMake, so you must have that installed.

====Using ccmake (curses-based front-end)====

On Debian or Ubuntu:

$ sudo apt-get install cmake-curses-gui

On Gentoo you should set the '''ncurses''' USE flag either globally or individually, just for cmake.
To add the USE flag globally, edit the USE array in /etc/make.conf for it to include '''ncurses'''.
To only install cmake with ncurses functionality, you could do the following:

$ echo 'dev-util/cmake ncurses' >> /etc/portage/package.use && emerge cmake

Note that in Ubuntu, <code>cmake-curses-gui</code> is in Universe, which you may have to enable with <code>software-properties-gtk</code>. Make sure to reload the software sources with <code>sudo apt-get update</code> afterwards.

Next, configure the codebase.

$ cd <var>/path/to/unvanquished</var>
$ mkdir build
$ cd build
$ ccmake ..

Or, in Debian or Ubuntu, you can build a package (but you'll need to have devscripts and fakeroot installed):

$ cd <var>/path/to/unvanquished</var>
$ fakeroot dpkg-buildpackage -b -uc
$ sudo dpkg -i <var>../unvanquished_*.deb</var>

Once in <code>ccmake</code>, use the following keys:

* Press {{Hotkey|c}} to configure. If an error occurs during this phase, make note of it and press {{Hotkey|e}} to dismiss it.
* Use the up and down arrow keys to navigate the compilation options.
* Press {{Hotkey|Enter}} to enable or disable boolean options (i.e., on/off) or to edit textual options.
** Press {{Hotkey|Esc}} when editing a textual option to cancel the change.

Once you have finished the configuration process, press {{Hotkey|C}} again, then {{Hotkey|G}} to generate the makefile.

====Using cmake-qt-gui (graphical front-end)====

This graphical front end for cmake has its own package you must install:

=====Debian/Ubuntu=====

$ sudo apt-get install cmake-qt-gui

=====Gentoo=====

With the '''qt4''' USE flag enabled:

$ emerge cmake

Once installed, run with <code>cmake-gui</code>.

[[Image:Cmake-qt-gui.png|thumb]]

# Set the path where you have the source code downloaded.
# Set the path where you would like to build the engine. This may be the same directory if you wish.
# Click 'Configure'.
# Click 'Generate'.

====Unnecessary libraries====

Regardless of which front-end to cmake you use, you may want to disable some libraries that are not strictly necessary:

* <code>USE_OPENAL</code> — If this is disabled, SDL is used instead for sound.
* <code>USE_CODEC_VORBIS</code> — Disabling this will cause certain sound effects (those using the <code>.ogg</code> format) not to play. At present, this has only a minor impact on gameplay, but more and more sounds will likely use the format in the future.
* <code>USE_CURSES</code> — Disabling this will cause the external (not in-game) console to not use curses; it will not be scrollable and will be similar to the console in the original Tremulous. This does in no way affect gameplay.
* <code>USE_CIN_THEORA</code> — Disabling this prevents videos from being recorded in Theora.
* <code>USE_CIN_XVID</code> — Disabling this prevents videos from being recorded in Xvid.
* <code>USE_VOIP</code> — Disabling this removes VOIP support. Alternatively enabling <code>USE_INTERNAL_SPEEX</code> will use the libraries distributed with Unvanquished for VoIP
* <code>USE_INTERNAL_CRYPTO</code> — Enable this to use the crypto libraries provided by Unvanquished.

===Compiling===

$ cd <var>path/to/unvanquished/build</var>
$ make -j4

The <code>-j</code> switch to make allows you to speed up the compilation process by running it in multiple threads; set the number following this to the number of cores your processor(s) have.

==Acquiring the Game Files==

===Acquiring mandatory game files===

The game files are not in the Git repository, and must be downloaded separately. This may be done on the command line or from your web browser. The downloads may be found on [http://sourceforge.net/projects/unvanquished/files/Assets SourceForge.net]. If you download the files from your browser, just download the files named "pak*.pk3", and save them to the [[Running_the_game#Data_locations|data location]] for your system.

On Linux, this may be done as follows:

$ cd <var>[path to Unvanquished installation or build]</var>/main
$ for file in {{CurrentVersion|PakFiles}}; do
wget -O $file "http://sourceforge.net/projects/unvanquished/files/Assets/$file/download"
done

On FreeBSD, using the <code>sh</code> shell:

$ cd <var>[path to Unvanquished installation or build]</var>/main
$ for file in {{CurrentVersion|PakFiles}}; do
fetch -r -o $file "http://sourceforge.net/projects/unvanquished/files/Assets/$file/download"
done

On Mac OS X:

$ cd ~/Library/Application\ Support/Unvanquished/main
$ for file in {{CurrentVersion|PakFiles}}; do
curl -L "http://sourceforge.net/projects/unvanquished/files/Assets/$file/download" > $file
done

Linux users may also use the <code>download-pk3.sh</code> script that is distributed with the source code, which requires that curl be installed:

$ cd <var>[path to Unvanquished source code]</var>
$ mkdir -p ~/.Unvanquished/main
$ ./download-pk3.sh ~/.Unvanquished/main

===Downloading the map pack===

The map pack exists only for convenience; if you do not download the map pack, Unvanquished will automatically download maps as needed when you attempt to play online.

To download the map pack on Linux:

$ wget -O maps.7z "http://sourceforge.net/projects/unvanquished/files/Map%20Pack/maps.7z"; done

To download the map pack on Mac OS X:

$ curl -L "http://sourceforge.net/projects/unvanquished/files/Map%20Pack/maps.7z" > maps.7z; done

Note that you will need to unzip the map pack on either system as it is compressed with LZMA. Mac users can use the [http://wakaba.c3.cx/s/apps/unarchiver.html Unarchiver]. Uncompressing the archive on Linux is highly dependent on your distribution.

===Verifying the Files===

Download the latest [http://sourceforge.net/projects/unvanquished/files/Assets/{{CurrentVersion|MD5HashFile}} MD5 hash file] and save it to your system's [[Running_the_game#Data_directory|data location]].

On systems with the <code>md5</code> command (Mac OS X):

$ cd ~/Library/Application\ Support/Unvanquished/main
$ cat {{CurrentVersion|MD5HashFile}} | while read line; do
file="`echo "$line" | cut -d\ -f3-`"
if [ -e "$file" ]; then
if [ `md5 -r "$file" | cut -d\ -f1` = "`echo "$line" | cut -d\ -f1`" ]
then echo "File \"$file\" appears okay."
else echo "File \"$file\" is corrupt"'!' >&2
fi; fi; done

On systems with the <code>md5sum</code> command (most Linux distributions):

$ cd <var>[[Running_the_game#Data_directory|/path/to/data/files]]</var>
$ md5sum -c {{CurrentVersion|MD5HashFile}} 2>&1 | grep -v "open or read\|file or directory"

The <code>grep</code> invocation is used to strip output complaining about missing files.

Any files that are found to be corrupt should be replaced; just download a [http://sourceforge.net/projects/unvanquished/files/Assets new copy] of the affected file(s).

==Errors==

===CMake cannot locate Newton===

If CMake cannot find Newton, you'll need to set it up yourself.

It should be in <code><var>/path/to/Unvanquished</var>/src/libs/libnewton/libs/<var>your_os</var>/libNewton.so</code>.
Be sure to replace <var>your_os</var> with the proper directory name.

Use CMake as before to change the <code>NEWTON_LIBRARY</code> build setting to the said path:

# Start the CMake configurator:<pre>$ ccmake ..</pre>
# Scroll down and highlight <code>NEWTON_LIBRARY</code>.
# Press {{Hotkey|Enter}} to begin editing and input in the path.
# Press {{Hotkey|C}} to configure and {{Hotkey|G}} to generate the new makefiles.
# Press {{Hotkey|Q}} to quit.
# Recompile the source:<pre>$ make</pre>

===The C Compiler is not able to compile a simple test program===

When attempting to generate a solution for Xcode CMake fails with the following error
-- Check for working C compiler using: Xcode -- broken
CMake Error at /Applications/CMake 2.8-8.app/Contents/share/cmake-2.8/Modules/CMakeTestCCompiler.cmake:52 (MESSAGE):
The C compiler "/usr/bin/gcc" is not able to compile a simple test program.

It fails with the following output:

Change Dir: /Users/danielmaloney/Documents/Unvanquished/build-xcode/CMakeFiles/CMakeTmp

Run Build Command:/Applications/CMake\ 2.8-8.app/Contents/bin/cmakexbuild
-project CMAKE_TRY_COMPILE.xcodeproj build -target
cmTryCompileExec1400153232 -configuration Debug

Error: No developer directory found at /Developer. Run
/usr/bin/xcode-select to update the developer directory path.

CMake will not be able to correctly generate this project.
Call Stack (most recent call first):
CMakeLists.txt:19 (project)

This is due to Xcode 4.3 having a different directory structure to previous versions. Simply running the following command will correct this error:
sudo /usr/bin/xcode-select -switch /Applications/Xcode.app/Contents/Developer/

Creating custom keybinds

2013-02-03T21:39:20Z

Anomalous: Admin command section

{| align="right"
| __TOC__
|}

'''''The information on this page is incomplete.'''''

==Usage==

Some simple bindings can be made via the configuration menus.

For more complicated bindings and for team bindings, you need to use the console. For example, you could bind commands to set a team and to spawn:

bind F9 "team a"
bind F10 "team h"

// attacking players
teambind aliens F5 "class level0"
teambind humans F5 "class rifle"

// builders
teambind aliens F6 "class builderupg builder"
teambind humans F6 "class ckit"

==Differences from Tremulous==

A number of commands for keybinds have changed since Tremulous, so keybind configurations cannot be directly copied from Tremulous to Unvanquished.

{| class="wikitable"
! Tremulous || Unvanquished || Used for…
|-
| <code>+button2</code> || <code>+useitem</code> || Using an item; granger spit; dragoon barb
|-
| <code>+button3</code> || <code>+taunt</code> || “Come on!” etc.
|-
| <code>+button5</code> || <code>+attack2</code> || Secondary attack
|-
| <code>+button6</code> || <code>+dodge</code> || Dodging
|-
| <code>+button7</code> || <code>+activate</code> || Using a structure; evolving
|-
| <code>+button8</code> || <code>+sprint</code> || Sprinting
|-
|}

As of alpha 3, the <code>+button''N''</code> commands are no longer present.

You may want to bind the new [[Voice say system|vsays]] to different keys.
==Gameplay commands==

This is a partial list of commands added, using Tremulous GPP r2259 as a reference point. Not everything listed is actually useful.

===+activate===
Access an armoury; evolve.

===+attack2===
Secondary attack.

===+dodge===
Low jump sideways or backwards. (Humans only.)

===+rally===
“Come on!” etc., as in ‘follow me’.

===+sprint===
Run. (Humans only.)

===+taunt===
“Come on!” etc., as in ‘bring it on!’.

===+useitem===
Use the highlighted item; tertiary attack (granger spit, dragoon snipe).

===say_area_team===
Talk to all teammates within a server-set range.

==Configuration commands==

===alias===
<tt>alias NAME COMMAND [PARAMETERS…]</tt>

Create an alias for the given command. The alias is then useable as a command in its own right.

===aliaslist===
Lists available command aliases.

===bind===
<tt>bind KEY [COMMAND…]</tt>
Binds a command (or sequence of commands) to the given key, or lists the bindings for that key.

All existing bindings on that key are lost.

===clearaliases===
Clears all command aliases.

===cycle===

===editbind===
<tt>editbind [TEAM] KEY</tt>

This inserts a <tt>/bind</tt> or <tt>/teambind</tt> command into the in-game console, ready for editing. The console is opened if needed.

<tt>TEAM</tt> is default, spectators, humans, or aliens. (Initial substrings are accepted.)

===if===
<tt>if VALUE CONDITION VALUE THEN [ELSE]</tt>

<tt>if MODIFIERS THEN [ELSE]</tt>

; <tt>VALUE</tt> : a variable or number
; <tt>CONDITION</tt> : comparison operator
; <tt>MODIFIERS</tt> : comma-separated list of keyboard modifiers: Shift, Ctrl, Alt, Command (or Cmd), Mode, Super. Prefix any which must not be pressed with <kbd>!</kbd>.
; <tt>THEN</tt> and <tt>ELSE</tt> : either a variable name or, if prefixed with <kbd>/</kbd> or <kbd>\</kbd>, a command string.

Recognised numeric comparison operators: 
<tt> = != < <= > >= !=</tt>

Recognised string comparison operators: 
<tt> eq ne in !in</tt>

Either the <tt>THEN</tt> clause or the <tt>ELSE</tt> clause (if present) will be executed. If it is a variable name, its content will be executed.

For example:

<pre>/if shift "/echo Hello" "/echo Goodbye"
/bind j "if \$team\$ eq aliens \"/class level1upg level1\""</pre>

(Note the escaping of the cvar <tt>team</tt>.)

===irc_connect===
Start the ingame IRC client

===irc_quit===
Stop the ingame IRC client

===irc_say===
Say something in the desired IRC channel if connected to a server

===listrotation===
Lists the current map rotation. The current map is highlighted.

===loadgame===

===messagemode1===
This command opens a general chat prompt.

===messagemode2===
This command opens a team-chat prompt.

===messagemode3===
This command opens an admin chat prompt.

===messagemode4===
This command opens a chat prompt for the built-in IRC client.

===messagemodec===
This command opens a command prompt.

===modcase===
<tt>modcase MODIFIERS THEN [MODIFIERS THEN]* [ELSE]</tt>

This works like <tt>if</tt>. The leftmost most-specific <tt>THEN</tt> whose modifier list matches is the one which is executed; if none match, then <tt>ELSE</tt> is executed if it is present.

For example:
<pre>/modcase shift "/echo 1" ctrl "/echo 2" shift,ctrl "/echo 3" shift,!alt "/echo 4"</pre>
works as follows:

# if Shift and Alt (due to clause 4) but not Ctrl (due to clause 3) are pressed;
# if Ctrl but not Shift (due to clause 3);
# if Shift and Ctrl;
# if Shift but neither Alt nor Ctrl.

===modelist===

===strcmp===
Compare the string values of two cvars. ''Obsolete.''

===teambind===
<tt>teambind TEAM KEY [COMMAND…]</tt>
Binds a command (or sequence of commands) to the given key for use when on the given team, or lists the binding for that key/team.

<tt>TEAM</tt> is default, spectators, humans, or aliens. (Initial substrings are accepted.)

===toggleConsole===
Opens or closes the in-game console.

===ui_restart===
Reloads UI files.

===unalias===
<tt>unalias NAME</tt>

Removes the named alias.

===unbind===
<tt>unbind [TEAM] KEY</tt>
Removes either all bindings for the given key, or the binding for the given team on that key.

<tt>TEAM</tt> is default, spectators, humans, or aliens. (Initial substrings are accepted.)

===undelay===

===undelayAll===

===unregister===
Removes registration of your GUID and name.

==Admin commands==

===allready===
Quickly move to the next map. Used only during the intermission.

===speclock===
Prevents a player from joining a team for a given time or until the end of the current game.
If necessary, the player is moved to spectators.

===specunlock===
Allows a player, previously locked, to join a team.

==Utility commands==

===calc===
Do math calculations on cvars. Store the value to a cvar Useful in making scripts.

===concat===
Concatenate 2 cvars into a third.

===delay===

===glsl_restart===
Development use. For recompiling the GLSL shader code.

===grep===
<tt>grep TEXT</tt>

Searches the in-game console for occurrences of <tt>TEXT</tt>. Matching lines are reprinted.

===help===

===math===
Do math on cvars. Useful for scripts.

===random===
Generate a random number

===reloadhud===
Reload the HUD without a vid_restart

===screenshotPNG===
Saves a screenshot in the PNG format.

===search===
<tt>search TEXT</tt>

Searches back through the in-game console for <tt>TEXT</tt> and scrolls to it.

===searchDown===
<tt>searchDown TEXT</tt>

Searches forward through the in-game console for <tt>TEXT</tt> and scrolls to it.

===snd_reload===
Reload sounds (includes a vid_restart

===wav_record===

===wav_stoprecord===

==Special uses==

===animationlist===

===buildcubemaps===

===cache_endgather===

===cache_mapchange===

===cache_setindex===

===cache_startgather===

===cache_usedfile===

===fbolist===

===fieldinfo===

===gameCompleteStatus===

===openurl===
Open a URL inside the OS's default browser.

===pubkey===
Internal use.

===pubkey_identify===
Internal use.

===setRecommended===

===shaderexp===

===spdevmap===
Does nothing.

===spmap===
Does nothing.

===updatehunkusage===

===updatescreen===

===vbolist===

Creating custom keybinds

2013-02-03T21:32:59Z

Anomalous: /* Usage */

{| align="right"
| __TOC__
|}

'''''The information on this page is incomplete.'''''

==Usage==

Some simple bindings can be made via the configuration menus.

For more complicated bindings and for team bindings, you need to use the console. For example, you could bind commands to set a team and to spawn:

bind F9 "team a"
bind F10 "team h"

// attacking players
teambind aliens F5 "class level0"
teambind humans F5 "class rifle"

// builders
teambind aliens F6 "class builderupg builder"
teambind humans F6 "class ckit"

==Differences from Tremulous==

A number of commands for keybinds have changed since Tremulous, so keybind configurations cannot be directly copied from Tremulous to Unvanquished.

{| class="wikitable"
! Tremulous || Unvanquished || Used for…
|-
| <code>+button2</code> || <code>+useitem</code> || Using an item; granger spit; dragoon barb
|-
| <code>+button3</code> || <code>+taunt</code> || “Come on!” etc.
|-
| <code>+button5</code> || <code>+attack2</code> || Secondary attack
|-
| <code>+button6</code> || <code>+dodge</code> || Dodging
|-
| <code>+button7</code> || <code>+activate</code> || Using a structure; evolving
|-
| <code>+button8</code> || <code>+sprint</code> || Sprinting
|-
|}

As of alpha 3, the <code>+button''N''</code> commands are no longer present.

You may want to bind the new [[Voice say system|vsays]] to different keys.
==Gameplay commands==

This is a partial list of commands added, using Tremulous GPP r2259 as a reference point. Not everything listed is actually useful.

===+activate===
Access an armoury; evolve.

===+attack2===
Secondary attack.

===+dodge===
Low jump sideways or backwards. (Humans only.)

===+rally===
“Come on!” etc., as in ‘follow me’.

===+sprint===
Run. (Humans only.)

===+taunt===
“Come on!” etc., as in ‘bring it on!’.

===+useitem===
Use the highlighted item; tertiary attack (granger spit, dragoon snipe).

==Configuration commands==

===alias===
<tt>alias NAME COMMAND [PARAMETERS…]</tt>

Create an alias for the given command. The alias is then useable as a command in its own right.

===aliaslist===
Lists available command aliases.

===bind===
<tt>bind KEY [COMMAND…]</tt>
Binds a command (or sequence of commands) to the given key, or lists the bindings for that key.

All existing bindings on that key are lost.

===clearaliases===
Clears all command aliases.

===cycle===

===editbind===
<tt>editbind [TEAM] KEY</tt>

This inserts a <tt>/bind</tt> or <tt>/teambind</tt> command into the in-game console, ready for editing. The console is opened if needed.

<tt>TEAM</tt> is default, spectators, humans, or aliens. (Initial substrings are accepted.)

===if===
<tt>if VALUE CONDITION VALUE THEN [ELSE]</tt>

<tt>if MODIFIERS THEN [ELSE]</tt>

; <tt>VALUE</tt> : a variable or number
; <tt>CONDITION</tt> : comparison operator
; <tt>MODIFIERS</tt> : comma-separated list of keyboard modifiers: Shift, Ctrl, Alt, Command (or Cmd), Mode, Super. Prefix any which must not be pressed with <kbd>!</kbd>.
; <tt>THEN</tt> and <tt>ELSE</tt> : either a variable name or, if prefixed with <kbd>/</kbd> or <kbd>\</kbd>, a command string.

Recognised numeric comparison operators: 
<tt> = != < <= > >= !=</tt>

Recognised string comparison operators: 
<tt> eq ne in !in</tt>

Either the <tt>THEN</tt> clause or the <tt>ELSE</tt> clause (if present) will be executed. If it is a variable name, its content will be executed.

For example:

<pre>/if shift "/echo Hello" "/echo Goodbye"
/bind j "if \$team\$ eq aliens \"/class level1upg level1\""</pre>

(Note the escaping of the cvar <tt>team</tt>.)

===irc_connect===
Start the ingame IRC client

===irc_quit===
Stop the ingame IRC client

===irc_say===
Say something in the desired IRC channel if connected to a server

===listrotation===
Lists the current map rotation. The current map is highlighted.

===loadgame===

===messagemode4===
This command opens a chat prompt for the built-in IRC client.

===modcase===
<tt>modcase MODIFIERS THEN [MODIFIERS THEN]* [ELSE]</tt>

This works like <tt>if</tt>. The leftmost most-specific <tt>THEN</tt> whose modifier list matches is the one which is executed; if none match, then <tt>ELSE</tt> is executed if it is present.

For example:
<pre>/modcase shift "/echo 1" ctrl "/echo 2" shift,ctrl "/echo 3" shift,!alt "/echo 4"</pre>
works as follows:

# if Shift and Alt (due to clause 4) but not Ctrl (due to clause 3) are pressed;
# if Ctrl but not Shift (due to clause 3);
# if Shift and Ctrl;
# if Shift but neither Alt nor Ctrl.

===modelist===

===openurl===
Open a URL inside the OS's default browser.

===say_area_team===
Talk to all teammates within a server-set range.

===speclock===
Prevents a player from joining a team for a given time or until the end of the current game.
If necessary, the player is moved to spectators.

===specunlock===
Allows a player, previously locked, to join a team.

===strcmp===
Compare the string values of two cvars. ''Obsolete.''

===teambind===
<tt>teambind TEAM KEY [COMMAND…]</tt>
Binds a command (or sequence of commands) to the given key for use when on the given team, or lists the binding for that key/team.

<tt>TEAM</tt> is default, spectators, humans, or aliens. (Initial substrings are accepted.)

===toggleConsole===
Opens or closes the in-game console.

===ui_restart===
Reloads UI files.

===unalias===
<tt>unalias NAME</tt>

Removes the named alias.

===unbind===
<tt>unbind [TEAM] KEY</tt>
Removes either all bindings for the given key, or the binding for the given team on that key.

<tt>TEAM</tt> is default, spectators, humans, or aliens. (Initial substrings are accepted.)

===undelay===

===undelayAll===

===unregister===
Removes registration of your GUID and name.

==Utility commands==

===calc===
Do math calculations on cvars. Store the value to a cvar Useful in making scripts.

===concat===
Concatenate 2 cvars into a third.

===delay===

===glsl_restart===
Development use. For recompiling the GLSL shader code.

===grep===
<tt>grep TEXT</tt>

Searches the in-game console for occurrences of <tt>TEXT</tt>. Matching lines are reprinted.

===help===

===math===
Do math on cvars. Useful for scripts.

===random===
Generate a random number

===reloadhud===
Reload the HUD without a vid_restart

===screenshotPNG===
Saves a screenshot in the PNG format.

===search===
<tt>search TEXT</tt>

Searches back through the in-game console for <tt>TEXT</tt> and scrolls to it.

===searchDown===
<tt>searchDown TEXT</tt>

Searches forward through the in-game console for <tt>TEXT</tt> and scrolls to it.

===snd_reload===
Reload sounds (includes a vid_restart

===wav_record===

===wav_stoprecord===

==Special uses==

===animationlist===

===buildcubemaps===

===cache_endgather===

===cache_mapchange===

===cache_setindex===

===cache_startgather===

===cache_usedfile===

===fbolist===

===fieldinfo===

===gameCompleteStatus===

===pubkey===
Internal use.

===pubkey_identify===
Internal use.

===setRecommended===

===shaderexp===

===spdevmap===
Does nothing.

===spmap===
Does nothing.

===updatehunkusage===

===updatescreen===

===vbolist===

Creating custom keybinds

2013-02-03T21:32:31Z

Anomalous: A few example bindings

{| align="right"
| __TOC__
|}

'''''The information on this page is incomplete.'''''

==Usage==

Some simple bindings can be made via the configuration menus.

For more complicated bindings and for team bindings, you need to use the console. For example, you could bind commands to set a team and to spawn:

bind F9 "team a"
bind F10 "team h"

// attacking players
teambind aliens F5 "class level0"
teambind humans F5 "class rifle"

// builders
teambind aliens F6 "class builderupg builder"
teambind humans F6 "class ckit"

==Differences from Tremulous==

A number of commands for keybinds have changed since Tremulous, so keybind configurations cannot be directly copied from Tremulous to Unvanquished.

{| class="wikitable"
! Tremulous || Unvanquished || Used for…
|-
| <code>+button2</code> || <code>+useitem</code> || Using an item; granger spit; dragoon barb
|-
| <code>+button3</code> || <code>+taunt</code> || “Come on!” etc.
|-
| <code>+button5</code> || <code>+attack2</code> || Secondary attack
|-
| <code>+button6</code> || <code>+dodge</code> || Dodging
|-
| <code>+button7</code> || <code>+activate</code> || Using a structure; evolving
|-
| <code>+button8</code> || <code>+sprint</code> || Sprinting
|-
|}

As of alpha 3, the <code>+button''N''</code> commands are no longer present.

You may want to bind the new [[Voice say system|vsays]] to different keys.
==Gameplay commands==

This is a partial list of commands added, using Tremulous GPP r2259 as a reference point. Not everything listed is actually useful.

===+activate===
Access an armoury; evolve.

===+attack2===
Secondary attack.

===+dodge===
Low jump sideways or backwards. (Humans only.)

===+rally===
“Come on!” etc., as in ‘follow me’.

===+sprint===
Run. (Humans only.)

===+taunt===
“Come on!” etc., as in ‘bring it on!’.

===+useitem===
Use the highlighted item; tertiary attack (granger spit, dragoon snipe).

==Configuration commands==

===alias===
<tt>alias NAME COMMAND [PARAMETERS…]</tt>

Create an alias for the given command. The alias is then useable as a command in its own right.

===aliaslist===
Lists available command aliases.

===bind===
<tt>bind KEY [COMMAND…]</tt>
Binds a command (or sequence of commands) to the given key, or lists the bindings for that key.

All existing bindings on that key are lost.

===clearaliases===
Clears all command aliases.

===cycle===

===editbind===
<tt>editbind [TEAM] KEY</tt>

This inserts a <tt>/bind</tt> or <tt>/teambind</tt> command into the in-game console, ready for editing. The console is opened if needed.

<tt>TEAM</tt> is default, spectators, humans, or aliens. (Initial substrings are accepted.)

===if===
<tt>if VALUE CONDITION VALUE THEN [ELSE]</tt>

<tt>if MODIFIERS THEN [ELSE]</tt>

; <tt>VALUE</tt> : a variable or number
; <tt>CONDITION</tt> : comparison operator
; <tt>MODIFIERS</tt> : comma-separated list of keyboard modifiers: Shift, Ctrl, Alt, Command (or Cmd), Mode, Super. Prefix any which must not be pressed with <kbd>!</kbd>.
; <tt>THEN</tt> and <tt>ELSE</tt> : either a variable name or, if prefixed with <kbd>/</kbd> or <kbd>\</kbd>, a command string.

Recognised numeric comparison operators: 
<tt> = != < <= > >= !=</tt>

Recognised string comparison operators: 
<tt> eq ne in !in</tt>

Either the <tt>THEN</tt> clause or the <tt>ELSE</tt> clause (if present) will be executed. If it is a variable name, its content will be executed.

For example:

<pre>/if shift "/echo Hello" "/echo Goodbye"
/bind j "if \$team\$ eq aliens \"/class level1upg level1\""</pre>

(Note the escaping of the cvar <tt>team</tt>.)

===irc_connect===
Start the ingame IRC client

===irc_quit===
Stop the ingame IRC client

===irc_say===
Say something in the desired IRC channel if connected to a server

===listrotation===
Lists the current map rotation. The current map is highlighted.

===loadgame===

===messagemode4===
This command opens a chat prompt for the built-in IRC client.

===modcase===
<tt>modcase MODIFIERS THEN [MODIFIERS THEN]* [ELSE]</tt>

This works like <tt>if</tt>. The leftmost most-specific <tt>THEN</tt> whose modifier list matches is the one which is executed; if none match, then <tt>ELSE</tt> is executed if it is present.

For example:
<pre>/modcase shift "/echo 1" ctrl "/echo 2" shift,ctrl "/echo 3" shift,!alt "/echo 4"</pre>
works as follows:

# if Shift and Alt (due to clause 4) but not Ctrl (due to clause 3) are pressed;
# if Ctrl but not Shift (due to clause 3);
# if Shift and Ctrl;
# if Shift but neither Alt nor Ctrl.

===modelist===

===openurl===
Open a URL inside the OS's default browser.

===say_area_team===
Talk to all teammates within a server-set range.

===speclock===
Prevents a player from joining a team for a given time or until the end of the current game.
If necessary, the player is moved to spectators.

===specunlock===
Allows a player, previously locked, to join a team.

===strcmp===
Compare the string values of two cvars. ''Obsolete.''

===teambind===
<tt>teambind TEAM KEY [COMMAND…]</tt>
Binds a command (or sequence of commands) to the given key for use when on the given team, or lists the binding for that key/team.

<tt>TEAM</tt> is default, spectators, humans, or aliens. (Initial substrings are accepted.)

===toggleConsole===
Opens or closes the in-game console.

===ui_restart===
Reloads UI files.

===unalias===
<tt>unalias NAME</tt>

Removes the named alias.

===unbind===
<tt>unbind [TEAM] KEY</tt>
Removes either all bindings for the given key, or the binding for the given team on that key.

<tt>TEAM</tt> is default, spectators, humans, or aliens. (Initial substrings are accepted.)

===undelay===

===undelayAll===

===unregister===
Removes registration of your GUID and name.

==Utility commands==

===calc===
Do math calculations on cvars. Store the value to a cvar Useful in making scripts.

===concat===
Concatenate 2 cvars into a third.

===delay===

===glsl_restart===
Development use. For recompiling the GLSL shader code.

===grep===
<tt>grep TEXT</tt>

Searches the in-game console for occurrences of <tt>TEXT</tt>. Matching lines are reprinted.

===help===

===math===
Do math on cvars. Useful for scripts.

===random===
Generate a random number

===reloadhud===
Reload the HUD without a vid_restart

===screenshotPNG===
Saves a screenshot in the PNG format.

===search===
<tt>search TEXT</tt>

Searches back through the in-game console for <tt>TEXT</tt> and scrolls to it.

===searchDown===
<tt>searchDown TEXT</tt>

Searches forward through the in-game console for <tt>TEXT</tt> and scrolls to it.

===snd_reload===
Reload sounds (includes a vid_restart

===wav_record===

===wav_stoprecord===

==Special uses==

===animationlist===

===buildcubemaps===

===cache_endgather===

===cache_mapchange===

===cache_setindex===

===cache_startgather===

===cache_usedfile===

===fbolist===

===fieldinfo===

===gameCompleteStatus===

===pubkey===
Internal use.

===pubkey_identify===
Internal use.

===setRecommended===

===shaderexp===

===spdevmap===
Does nothing.

===spmap===
Does nothing.

===updatehunkusage===

===updatescreen===

===vbolist===

Creating custom keybinds

2013-02-03T21:27:33Z

Anomalous: Sort commands into groups; add some docs for bind, editbind, teambind, unbind & +rally.

{| align="right"
| __TOC__
|}

'''''The information on this page is incomplete.'''''

A number of commands for keybinds have changed since Tremulous, so keybind configurations cannot be directly copied from Tremulous to Unvanquished.

{| class="wikitable"
! Tremulous || Unvanquished || Used for…
|-
| <code>+button2</code> || <code>+useitem</code> || Using an item; granger spit; dragoon barb
|-
| <code>+button3</code> || <code>+taunt</code> || “Come on!” etc.
|-
| <code>+button5</code> || <code>+attack2</code> || Secondary attack
|-
| <code>+button6</code> || <code>+dodge</code> || Dodging
|-
| <code>+button7</code> || <code>+activate</code> || Using a structure; evolving
|-
| <code>+button8</code> || <code>+sprint</code> || Sprinting
|-
|}

As of alpha 3, the <code>+button''N''</code> commands are no longer present.

You may want to bind the new [[Voice say system|vsays]] to different keys.
==Gameplay commands==

This is a partial list of commands added, using Tremulous GPP r2259 as a reference point. Not everything listed is actually useful.

===+activate===
Access an armoury; evolve.

===+attack2===
Secondary attack.

===+dodge===
Low jump sideways or backwards. (Humans only.)

===+rally===
“Come on!” etc., as in ‘follow me’.

===+sprint===
Run. (Humans only.)

===+taunt===
“Come on!” etc., as in ‘bring it on!’.

===+useitem===
Use the highlighted item; tertiary attack (granger spit, dragoon snipe).

==Configuration commands==

===alias===
<tt>alias NAME COMMAND [PARAMETERS…]</tt>

Create an alias for the given command. The alias is then useable as a command in its own right.

===aliaslist===
Lists available command aliases.

===bind===
<tt>bind KEY [COMMAND…]</tt>
Binds a command (or sequence of commands) to the given key, or lists the bindings for that key.

All existing bindings on that key are lost.

===clearaliases===
Clears all command aliases.

===cycle===

===editbind===
<tt>editbind [TEAM] KEY</tt>

This inserts a <tt>/bind</tt> or <tt>/teambind</tt> command into the in-game console, ready for editing. The console is opened if needed.

<tt>TEAM</tt> is default, spectators, humans, or aliens. (Initial substrings are accepted.)

===if===
<tt>if VALUE CONDITION VALUE THEN [ELSE]</tt>

<tt>if MODIFIERS THEN [ELSE]</tt>

; <tt>VALUE</tt> : a variable or number
; <tt>CONDITION</tt> : comparison operator
; <tt>MODIFIERS</tt> : comma-separated list of keyboard modifiers: Shift, Ctrl, Alt, Command (or Cmd), Mode, Super. Prefix any which must not be pressed with <kbd>!</kbd>.
; <tt>THEN</tt> and <tt>ELSE</tt> : either a variable name or, if prefixed with <kbd>/</kbd> or <kbd>\</kbd>, a command string.

Recognised numeric comparison operators: 
<tt> = != < <= > >= !=</tt>

Recognised string comparison operators: 
<tt> eq ne in !in</tt>

Either the <tt>THEN</tt> clause or the <tt>ELSE</tt> clause (if present) will be executed. If it is a variable name, its content will be executed.

For example:

<pre>/if shift "/echo Hello" "/echo Goodbye"
/bind j "if \$team\$ eq aliens \"/class level1upg level1\""</pre>

(Note the escaping of the cvar <tt>team</tt>.)

===irc_connect===
Start the ingame IRC client

===irc_quit===
Stop the ingame IRC client

===irc_say===
Say something in the desired IRC channel if connected to a server

===listrotation===
Lists the current map rotation. The current map is highlighted.

===loadgame===

===messagemode4===
This command opens a chat prompt for the built-in IRC client.

===modcase===
<tt>modcase MODIFIERS THEN [MODIFIERS THEN]* [ELSE]</tt>

This works like <tt>if</tt>. The leftmost most-specific <tt>THEN</tt> whose modifier list matches is the one which is executed; if none match, then <tt>ELSE</tt> is executed if it is present.

For example:
<pre>/modcase shift "/echo 1" ctrl "/echo 2" shift,ctrl "/echo 3" shift,!alt "/echo 4"</pre>
works as follows:

# if Shift and Alt (due to clause 4) but not Ctrl (due to clause 3) are pressed;
# if Ctrl but not Shift (due to clause 3);
# if Shift and Ctrl;
# if Shift but neither Alt nor Ctrl.

===modelist===

===openurl===
Open a URL inside the OS's default browser.

===say_area_team===
Talk to all teammates within a server-set range.

===speclock===
Prevents a player from joining a team for a given time or until the end of the current game.
If necessary, the player is moved to spectators.

===specunlock===
Allows a player, previously locked, to join a team.

===strcmp===
Compare the string values of two cvars. ''Obsolete.''

===teambind===
<tt>teambind TEAM KEY [COMMAND…]</tt>
Binds a command (or sequence of commands) to the given key for use when on the given team, or lists the binding for that key/team.

<tt>TEAM</tt> is default, spectators, humans, or aliens. (Initial substrings are accepted.)

===toggleConsole===
Opens or closes the in-game console.

===ui_restart===
Reloads UI files.

===unalias===
<tt>unalias NAME</tt>

Removes the named alias.

===unbind===
<tt>unbind [TEAM] KEY</tt>
Removes either all bindings for the given key, or the binding for the given team on that key.

<tt>TEAM</tt> is default, spectators, humans, or aliens. (Initial substrings are accepted.)

===undelay===

===undelayAll===

===unregister===
Removes registration of your GUID and name.

==Utility commands==

===calc===
Do math calculations on cvars. Store the value to a cvar Useful in making scripts.

===concat===
Concatenate 2 cvars into a third.

===delay===

===glsl_restart===
Development use. For recompiling the GLSL shader code.

===grep===
<tt>grep TEXT</tt>

Searches the in-game console for occurrences of <tt>TEXT</tt>. Matching lines are reprinted.

===help===

===math===
Do math on cvars. Useful for scripts.

===random===
Generate a random number

===reloadhud===
Reload the HUD without a vid_restart

===screenshotPNG===
Saves a screenshot in the PNG format.

===search===
<tt>search TEXT</tt>

Searches back through the in-game console for <tt>TEXT</tt> and scrolls to it.

===searchDown===
<tt>searchDown TEXT</tt>

Searches forward through the in-game console for <tt>TEXT</tt> and scrolls to it.

===snd_reload===
Reload sounds (includes a vid_restart

===wav_record===

===wav_stoprecord===

==Special uses==

===animationlist===

===buildcubemaps===

===cache_endgather===

===cache_mapchange===

===cache_setindex===

===cache_startgather===

===cache_usedfile===

===fbolist===

===fieldinfo===

===gameCompleteStatus===

===pubkey===
Internal use.

===pubkey_identify===
Internal use.

===setRecommended===

===shaderexp===

===spdevmap===
Does nothing.

===spmap===
Does nothing.

===updatehunkusage===

===updatescreen===

===vbolist===

Creating custom keybinds

2013-01-08T04:33:20Z

Anomalous: /* if */

{| align="right"
| __TOC__
|}

'''''The information on this page is incomplete.'''''

A number of commands for keybinds have changed since Tremulous, so keybind configurations cannot be directly copied from Tremulous to Unvanquished.

{| class="wikitable"
! Tremulous || Unvanquished || Used for…
|-
| <code>+button2</code> || <code>+useitem</code> || Using an item; granger spit; dragoon barb
|-
| <code>+button3</code> || <code>+taunt</code> || “Come on!” etc.
|-
| <code>+button5</code> || <code>+attack2</code> || Secondary attack
|-
| <code>+button6</code> || <code>+dodge</code> || Dodging
|-
| <code>+button7</code> || <code>+activate</code> || Using a structure; evolving
|-
| <code>+button8</code> || <code>+sprint</code> || Sprinting
|-
|}

As of alpha 3, the <code>+button''N''</code> commands are no longer present.

You may want to bind the new [[Voice say system|vsays]] to different keys.
==New commands==

This is a partial list of commands added, using Tremulous GPP r2259 as a reference point. Not everything listed is actually useful.

===+activate===
Access an armoury; evolve.

===+attack2===
Secondary attack.

===+dodge===
Low jump sideways or backwards. (Humans only.)

===+sprint===
Run. (Humans only.)

===+taunt===
“Come on!” etc.

===+useitem===
Use the highlighted item; tertiary attack (granger spit, dragoon snipe).

===alias===
<tt>alias NAME COMMAND [PARAMETERS…]</tt>

Create an alias for the given command. The alias is then useable as a command in its own right.

===aliaslist===
Lists available command aliases.

===animationlist===

===buildcubemaps===

===cache_endgather===

===cache_mapchange===

===cache_setindex===

===cache_startgather===

===cache_usedfile===

===calc===
Do math calculations on cvars. Store the value to a cvar Useful in making scripts.

===clearaliases===
Clears all command aliases.

===concat===
Concatenate 2 cvars into a third.

===cycle===

===delay===

===editbind===
<tt>editbind KEY</tt>

This inserts a <tt>/bind</tt> command into the in-game console, ready for editing. The console is opened if needed.

===fbolist===

===fieldinfo===

===gameCompleteStatus===

===glsl_restart===
Development use. For recompiling the GLSL shader code.

===grep===
<tt>grep TEXT</tt>

Searches the in-game console for occurrences of <tt>TEXT</tt>. Matching lines are reprinted.

===help===

===if===
<tt>if VALUE CONDITION VALUE THEN [ELSE]</tt>

<tt>if MODIFIERS THEN [ELSE]</tt>

; <tt>VALUE</tt> : a variable or number
; <tt>CONDITION</tt> : comparison operator
; <tt>MODIFIERS</tt> : comma-separated list of keyboard modifiers: Shift, Ctrl, Alt, Command (or Cmd), Mode, Super. Prefix any which must not be pressed with <kbd>!</kbd>.
; <tt>THEN</tt> and <tt>ELSE</tt> : either a variable name or, if prefixed with <kbd>/</kbd> or <kbd>\</kbd>, a command string.

Recognised numeric comparison operators: 
<tt> = != < <= > >= !=</tt>

Recognised string comparison operators: 
<tt> eq ne in !in</tt>

Either the <tt>THEN</tt> clause or the <tt>ELSE</tt> clause (if present) will be executed. If it is a variable name, its content will be executed.

For example:

<pre>/if shift "/echo Hello" "/echo Goodbye"
/bind j "if \$team\$ eq aliens \"/class level1upg level1\""</pre>

(Note the escaping of the cvar <tt>team</tt>.)

===irc_connect===
Start the ingame IRC client

===irc_quit===
Stop the ingame IRC client

===irc_say===
Say something in the desired IRC channel if connected to a server

===listrotation===
Lists the current map rotation. The current map is highlighted.

===loadgame===

===math===
Do math on cvars. Useful for scripts.

===messagemode4===
This command opens a chat prompt for the built-in IRC client.

===modcase===
<tt>modcase MODIFIERS THEN [MODIFIERS THEN]* [ELSE]</tt>

This works like <tt>if</tt>. The leftmost most-specific <tt>THEN</tt> whose modifier list matches is the one which is executed; if none match, then <tt>ELSE</tt> is executed if it is present.

For example:
<pre>/modcase shift "/echo 1" ctrl "/echo 2" shift,ctrl "/echo 3" shift,!alt "/echo 4"</pre>
works as follows:

# if Shift and Alt (due to clause 4) but not Ctrl (due to clause 3) are pressed;
# if Ctrl but not Shift (due to clause 3);
# if Shift and Ctrl;
# if Shift but neither Alt nor Ctrl.

===modelist===

===openurl===
Open a URL inside the OS's default browser.

===pubkey===
Internal use.

===pubkey_identify===
Internal use.

===random===
Generate a random number

===reloadhud===
Reload the HUD without a vid_restart

===say_area_team===
Talk to all teammates within a server-set range.

===screenshotPNG===
Saves a screenshot in the PNG format.

===search===
<tt>search TEXT</tt>

Searches back through the in-game console for <tt>TEXT</tt> and scrolls to it.

===searchDown===
<tt>searchDown TEXT</tt>

Searches forward through the in-game console for <tt>TEXT</tt> and scrolls to it.

===setRecommended===

===shaderexp===

===snd_reload===
Reload sounds (includes a vid_restart

===spdevmap===
Does nothing.

===speclock===

===specunlock===

===spmap===
Does nothing.

===strcmp===
Compare the string values of two cvars.

===toggleConsole===
Opens or closes the in-game console.

===ui_restart===
Reloads UI files.

===unalias===
<tt>unalias NAME</tt>

Removes the named alias.

===undelay===

===undelayAll===

===unregister===
Removes registration of your GUID and name.

===updatehunkusage===

===updatescreen===

===vbolist===

===wav_record===

===wav_stoprecord===

Formats/Navigation mesh

2012-12-31T17:23:12Z

Anomalous: /* Optional Parameters */

The Daemon engine supports automatic navigation mesh generation from bsp map files. This navigation mesh (or "navmesh" for short) is used by the bots to navigate throughout the world.

==Generating a Navigation Mesh==

The -nav parameter to OWMap will generate a navigation mesh from a bsp file.
Use it like so:

===Windows===

daemonmap.exe -game unv -nav mapname.bsp

===Linux===

./daemonmap -game unv -nav mapname.bsp

===Optional Parameters===

The navigation mesh generation process is conservative by default. This means some areas (particularly, small ledges) that should be walkable may instead create a break in the navmesh which bots interpret as "I am unable to go past there." The following optional parameters give the map maker some control over navmesh generation to help with this.

<ul>
<li><del><code>-cellsize</code>

''Default'': 8

This value (along with <code>cellheight</code>) determines the accuracy of navigation mesh generation. A lower value will increase mesh generation accuracy at the cost of generation time and mesh size; conversely, a higher value will decrease generation time and mesh size at the cost of accuracy.

If you see gaps in the navigation mesh on "grating" floors where the grating parts, try using a higher value.
</del></li>
<li><code>-cellheight</code>

A lower cellheight will increase mesh generation accuracy at the cost of generation time and mesh size.

If there are gaps in the navigation mesh even though a player can easily just walk to get through, you can decrease the value to help.
</li>
<li><code>-median</code>

Applies a median filter to the walkable areas of the mesh to help contain any "noise."

See [http://digestingduck.blogspot.com/2010/07/recast-area-types-per-triangle.html this article] for more information.
</li>
<li><code>-optimistic</code>

Attempts to compensate for cellsize inaccuracy by increasing the stepheight navigation mesh generation parameter based on the current samplesize. It is recommended to be used with a lower than default cellsize to help avoid over optimistic assumptions (i.e., saying some areas are walkable that really aren't). Useful for fixing breaks in the mesh caused by some small ledges.

This produces bad results depending on how big your <code>cellsize</code> parameter is, but generating the mesh in this way will be faster than simply decreasing the <code>cellheight</code>.
</li>
</ul>

==Using a Navigation Mesh==

Navigation mesh files go in the <code>maps/</code> directory either in the folder specified by the <code>fs_game</code> cvar, or in the maps folder inside a map's <code>.pk3</code> file.

==Testing the Mesh==

<ol>
<li>Start a local server by starting Unvanquished and typing

\devmap testmap

into the console.


<del>You may then enable drawing the navigation mesh by setting the <code>cg_bot_nav</code> cvar to <code>1</code>.</del>


</li>
<li>Add bots with the <code>bot</code> command and spectate the game.
</li>
</ol>

==Editing the Navigation Mesh==
Unfortunately, automatic navigation mesh generation that fully supports all of the map features and player abilities in Unvanquished is increadibly difficult.
Automatic generation will usually produce a very satisfactory base mesh, but some areas may need further tweaking

===Adding Jump Links===
===Adding Ladder Links===
===Adding Pounce Links===
===Adding Drop off Links===
===Adding Walk Links===
[[Category:Bots]]

Formats/Navigation mesh

2012-12-31T17:18:56Z

Anomalous: /* Generating a Navigation Mesh */

The Daemon engine supports automatic navigation mesh generation from bsp map files. This navigation mesh (or "navmesh" for short) is used by the bots to navigate throughout the world.

==Generating a Navigation Mesh==

The -nav parameter to OWMap will generate a navigation mesh from a bsp file.
Use it like so:

===Windows===

daemonmap.exe -game unv -nav mapname.bsp

===Linux===

./daemonmap -game unv -nav mapname.bsp

===Optional Parameters===

The navigation mesh generation process is conservative by default. This means some areas (particularly, small ledges) that should be walkable may instead create a break in the navmesh which bots interpret as "I am unable to go past there." The following optional parameters give the map maker some control over navmesh generation to help with this.

<ul>
<li><code>-cellsize</code>

''Default'': 8

This value (along with <code>cellheight</code>) determines the accuracy of navigation mesh generation. A lower value will increase mesh generation accuracy at the cost of generation time and mesh size; conversely, a higher value will decrease generation time and mesh size at the cost of accuracy.

If you see gaps in the navigation mesh on "grating" floors where the grating parts, try using a higher value.
</li>
<li><code>-cellheight</code>

A lower cellheight will increase mesh generation accuracy at the cost of generation time and mesh size.

If there are gaps in the navigation mesh even though a player can easily just walk to get through, you can decrease the value to help.
</li>
<li><code>-median</code>

Applies a median filter to the walkable areas of the mesh to help contain any "noise."

See [http://digestingduck.blogspot.com/2010/07/recast-area-types-per-triangle.html this article] for more information.
</li>
<li><code>-optimistic</code>

Attempts to compensate for cellsize inaccuracy by increasing the stepheight navigation mesh generation parameter based on the current samplesize. It is recommended to be used with a lower than default cellsize to help avoid over optimistic assumptions (i.e., saying some areas are walkable that really aren't). Useful for fixing breaks in the mesh caused by some small ledges.

This produces bad results depending on how big your <code>cellsize</code> parameter is, but generating the mesh in this way will be faster than simply decreasing the <code>cellheight</code>.
</li>
</ul>

==Using a Navigation Mesh==

Navigation mesh files go in the <code>maps/</code> directory either in the folder specified by the <code>fs_game</code> cvar, or in the maps folder inside a map's <code>.pk3</code> file.

==Testing the Mesh==

<ol>
<li>Start a local server by starting Unvanquished and typing

\devmap testmap

into the console.


<del>You may then enable drawing the navigation mesh by setting the <code>cg_bot_nav</code> cvar to <code>1</code>.</del>


</li>
<li>Add bots with the <code>bot</code> command and spectate the game.
</li>
</ol>

==Editing the Navigation Mesh==
Unfortunately, automatic navigation mesh generation that fully supports all of the map features and player abilities in Unvanquished is increadibly difficult.
Automatic generation will usually produce a very satisfactory base mesh, but some areas may need further tweaking

===Adding Jump Links===
===Adding Ladder Links===
===Adding Pounce Links===
===Adding Drop off Links===
===Adding Walk Links===
[[Category:Bots]]

Formats/Navigation mesh

2012-12-31T17:13:09Z

Anomalous: /* Testing the Mesh */

The Daemon engine supports automatic navigation mesh generation from bsp map files. This navigation mesh (or "navmesh" for short) is used by the bots to navigate throughout the world.

==Generating a Navigation Mesh==

The -nav parameter to OWMap will generate a navigation mesh from a bsp file.
Use it like so:

===Windows===

OWMap.exe -game tremulous -nav mapname.bsp

===Linux===

./daemonmap.x86(_64) -game tremulous -nav mapname.bsp

===Optional Parameters===

The navigation mesh generation process is conservative by default. This means some areas (particularly, small ledges) that should be walkable may instead create a break in the navmesh which bots interpret as "I am unable to go past there." The following optional parameters give the map maker some control over navmesh generation to help with this.

<ul>
<li><code>-cellsize</code>

''Default'': 8

This value (along with <code>cellheight</code>) determines the accuracy of navigation mesh generation. A lower value will increase mesh generation accuracy at the cost of generation time and mesh size; conversely, a higher value will decrease generation time and mesh size at the cost of accuracy.

If you see gaps in the navigation mesh on "grating" floors where the grating parts, try using a higher value.
</li>
<li><code>-cellheight</code>

A lower cellheight will increase mesh generation accuracy at the cost of generation time and mesh size.

If there are gaps in the navigation mesh even though a player can easily just walk to get through, you can decrease the value to help.
</li>
<li><code>-median</code>

Applies a median filter to the walkable areas of the mesh to help contain any "noise."

See [http://digestingduck.blogspot.com/2010/07/recast-area-types-per-triangle.html this article] for more information.
</li>
<li><code>-optimistic</code>

Attempts to compensate for cellsize inaccuracy by increasing the stepheight navigation mesh generation parameter based on the current samplesize. It is recommended to be used with a lower than default cellsize to help avoid over optimistic assumptions (i.e., saying some areas are walkable that really aren't). Useful for fixing breaks in the mesh caused by some small ledges.

This produces bad results depending on how big your <code>cellsize</code> parameter is, but generating the mesh in this way will be faster than simply decreasing the <code>cellheight</code>.
</li>
</ul>

==Using a Navigation Mesh==

Navigation mesh files go in the <code>maps/</code> directory either in the folder specified by the <code>fs_game</code> cvar, or in the maps folder inside a map's <code>.pk3</code> file.

==Testing the Mesh==

<ol>
<li>Start a local server by starting Unvanquished and typing

\devmap testmap

into the console.


<del>You may then enable drawing the navigation mesh by setting the <code>cg_bot_nav</code> cvar to <code>1</code>.</del>


</li>
<li>Add bots with the <code>bot</code> command and spectate the game.
</li>
</ol>

==Editing the Navigation Mesh==
Unfortunately, automatic navigation mesh generation that fully supports all of the map features and player abilities in Unvanquished is increadibly difficult.
Automatic generation will usually produce a very satisfactory base mesh, but some areas may need further tweaking

===Adding Jump Links===
===Adding Ladder Links===
===Adding Pounce Links===
===Adding Drop off Links===
===Adding Walk Links===
[[Category:Bots]]

Server/Running

2012-11-22T00:36:18Z

Anomalous: More g_markDeconstruct tweaks

This page is a work in progress.

==Customizing gameplay==

===Game-related cvars===


{| class="wikitable"
|-
! Variable
! Type
! Default value
! Description
|-
| <code>g_timelimit</code>
| Integer
| 0
| Sets the time (in minutes) when the game ends. 
|-
| <code>g_suddenDeathTime</code>
| Integer
| 0
| Sets the time (in minutes) when [[Glossary#S|Sudden Death]] begins. 
|-
| <code>g_friendlyFire</code>
| Boolean
| 0
| Enables/disables friendly fire.
|-
| <code>g_friendlyBuildableFire</code>
| Boolean
| 0
| Enables/disables friendly fire for buildables.
|-
| <code>g_dretchPunt</code>
|-
| <code>g_password</code>
|-
| <code>g_needpass</code>
|-
| <code>g_maxclients</code>
|-
| <code>g_maxGameClients</code>
|-
| <code>g_dedicated</code>
|-
| <code>g_speed</code>
|-
| <code>g_gravity</code>
|-
| <code>g_cheats</code>
|-
| <code>g_knockback</code>
|-
| <code>g_inactivity</code>
|-
| <code>g_debugMove</code>
|-
| <code>g_debugDamage</code>
|-
| <code>g_motd</code>
| String
| ""
| Sets the message displayed when players connect to the server (the "message of the day").
|-
| <code>g_synchronousClients</code>
|-
| <code>g_warmup</code>
|-
| <code>g_doWarmup</code>
|-
| <code>g_lockTeamsAtStart</code>
|-
| <code>g_logFile</code>
|-
| <code>g_logFileSync</code>
|-
| <code>g_allowVote</code>
|-
| <code>g_voteLimit</code>
|-
| <code>g_suddenDeathVotePercent</code>
|-
| <code>g_suddenDeathVoteDelay</code>
|-
| <code>g_extendVotesPercent</code>
|-
| <code>g_extendVotesTime</code>
|-
| <code>g_extendVotesCount</code>
|-
| <code>g_kickVotesPercent</code>
|-
| <code>g_denyVotesPercent</code>
|-
| <code>g_mapVotesPercent</code>
|-
| <code>g_mapVotesBefore</code>
|-
| <code>g_drawVotesPercent</code>
|-
| <code>g_drawVotesAfter</code>
|-
| <code>g_drawVoteReasonRequired</code>
|-
| <code>g_admitDefeatVotesPercent</code>
|-
| <code>g_nextMapVotesPercent</code>
|-
| <code>g_pollVotesPercent</code>
|-
| <code>g_teamForceBalance</code>
|-
| <code>g_smoothClients</code>
|-
| <code>pmove_fixed</code>
|-
| <code>pmove_msec</code>
|-
| <code>g_minNameChangePeriod</code>
|-
| <code>g_maxNameChanges</code>
|-
| <code>g_alienBuildPoints</code>
|-
| <code>g_alienBuildQueueTime</code>
|-
| <code>g_humanBuildPoints</code>
|-
| <code>g_humanBuildQueueTime</code>
|-
| <code>g_humanRepeaterBuildPoints</code>
|-
| <code>g_humanRepeaterBuildQueueTime</code>
|-
| <code>g_humanRepeaterMaxZones</code>
|-
| <code>g_humanStage</code>
|-
| <code>g_humanCredits</code>
|-
| <code>g_humanMaxStage</code>
|-
| <code>g_humanStage2Threshold</code>
|-
| <code>g_humanStage3Threshold</code>
|-
| <code>g_alienStage</code>
|-
| <code>g_alienCredits</code>
|-
| <code>g_alienMaxStage</code>
|-
| <code>g_alienStage2Threshold</code>
|-
| <code>g_alienStage3Threshold</code>
|-
| <code>g_teamImbalanceWarnings</code>
|-
| <code>g_freeFundPeriod</code>
|-
| <code>g_luciHalfLifeTime</code>
|-
| <code>g_luciFullPowerTime</code>
|-
| <code>g_pulseHalfLifeTime</code>
|-
| <code>g_pulseFullPowerTime</code>
|-
| <code>g_flameFadeout</code>
|-
| <code>g_unlagged</code>
| Boolean
| 1
| Enables/disables [[Technical_documentation#Lag_compensation|lag compensation]].
|-
| <code>g_disabledEquipment</code>
|-
| <code>g_disabledClasses</code>
|-
| <code>g_disabledBuildables</code>
|-
| <code>g_markDeconstruct</code>
| Integer
| 3
| Controls deconstruction and replacement of buildings.
* 0 = instant deconstruction
* 1 = mark for deconstruction, don't allow replacement at the same location
* 2 = mark for deconstruction, allow replacement at the same location with the same type
* 3 = mark for deconstruction, don't restrict replacement
As of alpha 10:
* Add 16 to enable <code>/deconstruct marked</code>
* Add 32 to protect some buildings from instant deconstruction (type 0 marking ⇒ type 2 marking)
* Reactor, overmind and spawn points are protected.
|-
| <code>g_debugMapRotation</code>
|-
| <code>g_currentMapRotation</code>
|-
| <code>g_mapRotationNodes</code>
|-
| <code>g_mapRotationStack</code>
|-
| <code>g_nextMap</code>
|-
| <code>g_initialMapRotation</code>
|-
| <code>g_mapLog</code>
|-
| <code>g_debugVoices</code>
|-
| <code>g_voiceChats</code>
|-
| <code>g_shove</code>
|-
| <code>g_antiSpawnBlock</code>
|-
| <code>g_mapConfigs</code>
|-
| <code>g_sayAreaRange</code>
|-
| <code>g_floodMaxDemerits</code>
|-
| <code>g_floodMinTime</code>
|-
| <code>g_layouts</code>
|-
| <code>g_layoutAuto</code>
|-
| <code>g_emoticonsAllowedInNames</code>
|-
| <code>g_unnamedNumbering</code>
|-
| <code>g_unnamedNamePrefix</code>
|-
| <code>g_admin</code>
|-
| <code>g_adminTempBan</code>
|-
| <code>g_adminMaxBan</code>
|-
| <code>g_adminRetainExpiredBans</code>
|-
| <code>g_privateMessages</code>
|-
| <code>g_specChat</code>
|-
| <code>g_publicAdminMessages</code>
|-
| <code>g_allowTeamOverlay</code>
|-
| <code>g_censorship</code>
|-
| <code>g_tag</code>
|-
| <code>g_showKillerHP</code>
|-
| <code>g_combatCooldown</code>
|-
|}

===Customizing game characteristics===

Because the server's gameplay code runs in its own virtual machine, you may edit game logic code in <code>src/gamelogic/game</code> at your leisure. Players who connect to your server will not have to download a modified vm to experience the altered gameplay.

===Alternate starting positions for buildables===

You may change the starting positions of buildables using custom [[map layouts]].

==Map rotations==

For information on creating map rotations, please see the [http://tremulous.net/wiki/Maprotation.cfg tremulous.net documentation].

Server/Running

2012-11-22T00:32:18Z

Anomalous: g_markDeconstruct

This page is a work in progress.

==Customizing gameplay==

===Game-related cvars===


{| class="wikitable"
|-
! Variable
! Type
! Default value
! Description
|-
| <code>g_timelimit</code>
| Integer
| 0
| Sets the time (in minutes) when the game ends. 
|-
| <code>g_suddenDeathTime</code>
| Integer
| 0
| Sets the time (in minutes) when [[Glossary#S|Sudden Death]] begins. 
|-
| <code>g_friendlyFire</code>
| Boolean
| 0
| Enables/disables friendly fire.
|-
| <code>g_friendlyBuildableFire</code>
| Boolean
| 0
| Enables/disables friendly fire for buildables.
|-
| <code>g_dretchPunt</code>
|-
| <code>g_password</code>
|-
| <code>g_needpass</code>
|-
| <code>g_maxclients</code>
|-
| <code>g_maxGameClients</code>
|-
| <code>g_dedicated</code>
|-
| <code>g_speed</code>
|-
| <code>g_gravity</code>
|-
| <code>g_cheats</code>
|-
| <code>g_knockback</code>
|-
| <code>g_inactivity</code>
|-
| <code>g_debugMove</code>
|-
| <code>g_debugDamage</code>
|-
| <code>g_motd</code>
| String
| ""
| Sets the message displayed when players connect to the server (the "message of the day").
|-
| <code>g_synchronousClients</code>
|-
| <code>g_warmup</code>
|-
| <code>g_doWarmup</code>
|-
| <code>g_lockTeamsAtStart</code>
|-
| <code>g_logFile</code>
|-
| <code>g_logFileSync</code>
|-
| <code>g_allowVote</code>
|-
| <code>g_voteLimit</code>
|-
| <code>g_suddenDeathVotePercent</code>
|-
| <code>g_suddenDeathVoteDelay</code>
|-
| <code>g_extendVotesPercent</code>
|-
| <code>g_extendVotesTime</code>
|-
| <code>g_extendVotesCount</code>
|-
| <code>g_kickVotesPercent</code>
|-
| <code>g_denyVotesPercent</code>
|-
| <code>g_mapVotesPercent</code>
|-
| <code>g_mapVotesBefore</code>
|-
| <code>g_drawVotesPercent</code>
|-
| <code>g_drawVotesAfter</code>
|-
| <code>g_drawVoteReasonRequired</code>
|-
| <code>g_admitDefeatVotesPercent</code>
|-
| <code>g_nextMapVotesPercent</code>
|-
| <code>g_pollVotesPercent</code>
|-
| <code>g_teamForceBalance</code>
|-
| <code>g_smoothClients</code>
|-
| <code>pmove_fixed</code>
|-
| <code>pmove_msec</code>
|-
| <code>g_minNameChangePeriod</code>
|-
| <code>g_maxNameChanges</code>
|-
| <code>g_alienBuildPoints</code>
|-
| <code>g_alienBuildQueueTime</code>
|-
| <code>g_humanBuildPoints</code>
|-
| <code>g_humanBuildQueueTime</code>
|-
| <code>g_humanRepeaterBuildPoints</code>
|-
| <code>g_humanRepeaterBuildQueueTime</code>
|-
| <code>g_humanRepeaterMaxZones</code>
|-
| <code>g_humanStage</code>
|-
| <code>g_humanCredits</code>
|-
| <code>g_humanMaxStage</code>
|-
| <code>g_humanStage2Threshold</code>
|-
| <code>g_humanStage3Threshold</code>
|-
| <code>g_alienStage</code>
|-
| <code>g_alienCredits</code>
|-
| <code>g_alienMaxStage</code>
|-
| <code>g_alienStage2Threshold</code>
|-
| <code>g_alienStage3Threshold</code>
|-
| <code>g_teamImbalanceWarnings</code>
|-
| <code>g_freeFundPeriod</code>
|-
| <code>g_luciHalfLifeTime</code>
|-
| <code>g_luciFullPowerTime</code>
|-
| <code>g_pulseHalfLifeTime</code>
|-
| <code>g_pulseFullPowerTime</code>
|-
| <code>g_flameFadeout</code>
|-
| <code>g_unlagged</code>
| Boolean
| 1
| Enables/disables [[Technical_documentation#Lag_compensation|lag compensation]].
|-
| <code>g_disabledEquipment</code>
|-
| <code>g_disabledClasses</code>
|-
| <code>g_disabledBuildables</code>
|-
| <code>g_markDeconstruct</code>
| Integer
| 3
| Controls deconstruction and replacement of buildings.
* 0 = instant deconstruction
* 1 = mark for deconstruction, don't allow replacement
* 2 = mark for deconstruction, allow replacement with the same type
* 3 = mark for deconstruction, allow all replacement
As of alpha 10:
* Add 16 to enable <code>/deconstruct marked</code>
* Add 32 to protect some buildings from instant deconstruction
* Reactor, overmind and spawn points are protected.
|-
| <code>g_debugMapRotation</code>
|-
| <code>g_currentMapRotation</code>
|-
| <code>g_mapRotationNodes</code>
|-
| <code>g_mapRotationStack</code>
|-
| <code>g_nextMap</code>
|-
| <code>g_initialMapRotation</code>
|-
| <code>g_mapLog</code>
|-
| <code>g_debugVoices</code>
|-
| <code>g_voiceChats</code>
|-
| <code>g_shove</code>
|-
| <code>g_antiSpawnBlock</code>
|-
| <code>g_mapConfigs</code>
|-
| <code>g_sayAreaRange</code>
|-
| <code>g_floodMaxDemerits</code>
|-
| <code>g_floodMinTime</code>
|-
| <code>g_layouts</code>
|-
| <code>g_layoutAuto</code>
|-
| <code>g_emoticonsAllowedInNames</code>
|-
| <code>g_unnamedNumbering</code>
|-
| <code>g_unnamedNamePrefix</code>
|-
| <code>g_admin</code>
|-
| <code>g_adminTempBan</code>
|-
| <code>g_adminMaxBan</code>
|-
| <code>g_adminRetainExpiredBans</code>
|-
| <code>g_privateMessages</code>
|-
| <code>g_specChat</code>
|-
| <code>g_publicAdminMessages</code>
|-
| <code>g_allowTeamOverlay</code>
|-
| <code>g_censorship</code>
|-
| <code>g_tag</code>
|-
| <code>g_showKillerHP</code>
|-
| <code>g_combatCooldown</code>
|-
|}

===Customizing game characteristics===

Because the server's gameplay code runs in its own virtual machine, you may edit game logic code in <code>src/gamelogic/game</code> at your leisure. Players who connect to your server will not have to download a modified vm to experience the altered gameplay.

===Alternate starting positions for buildables===

You may change the starting positions of buildables using custom [[map layouts]].

==Map rotations==

For information on creating map rotations, please see the [http://tremulous.net/wiki/Maprotation.cfg tremulous.net documentation].

Formats/Image

2012-10-29T23:10:09Z

Anomalous: A little more info on DDS

==Software==

A number of open-source photo editing applications follow:

* [http://www.gimp.org/ The GIMP] — Fully-featured raster graphics image editor available for Mac OS X, Windows, and Linux. With version 2.8, the user interface may be used in single-window mode, hardware-acceleration is being added, and in future releases, higher bit-depth support will be added.
* [http://www.krita.org/ Krita] Available for Linux. Originally intended for photo-editing, Krita is now intended much more as a painting tool, although it is still suitable for both. Has support for high bit depths.

==Supported formats==

The engine supports the following formats:
* [http://www.libpng.org/pub/png/ PNG (Portable Network Graphics)] — Provides lossless compression of images, but with the penalty of high filesize.
* JPEG — Provides lossy compression and very small filesizes, but image quality can suffer at higher compression values.
* TGA — Provides raw or lossless compression, but is reported not to work well on photographic images.
* [http://www.modwiki.net/wiki/DDS_%28file_format%29 DDS (DirectDraw Surface)] — A Microsoft container format for [http://en.wikipedia.org/wiki/S3_Texture_Compression S3TC], which is supported natively by many video cards. This format does not need decompression before use, which helps with loading times. It is lossy.
* [https://developers.google.com/speed/webp/ WebP] — A relatively new format created by Google that provides excellent lossy compression (generally 39% smaller filesize than an equivalent JPEG).

Note that WebP was formerly optional when compiling the source code but is now required to ensure that everyone with the game will have it installed.

While most any graphics application that is worth using can export natively to PNG, JPEG, and TGA, most applications currently cannot export directly to DDS or WebP. Converters and plug-ins are available, however:
* [https://developers.google.com/speed/webp/docs/precompiled Google WebP converter]
* NVIDIA's [https://developer.nvidia.com/legacy-texture-tools DDS tools]
* ATI's [http://developer.amd.com/Resources/archive/ArchivedTools/gpu/compressonator/Pages/default.aspx Compressonator] for creating DDS images on Windows only.
* [http://code.google.com/p/gimp-dds/ The GIMP DDS Plug-in] for creating DDS images with GIMP version 2.8.

Note that the terms <dfn>lossy</dfn> and <dfn>lossless</dfn> were used multiple times above. Lossy means that images compressed using that format will lose some of their image quality to save space. Lossless means that the compression will not sacrifice image quality, no matter how much you compress the image with that format.

Maps/Parpax

2012-08-12T21:08:10Z

Anomalous: /* Human Strategy */

{| style="float:right;margin:1em 0px 1em 1em;border:2px outset #777;" border="0" cellpadding="1" cellspacing="0"
| colspan="2" style="background-color:rgb(187,187,187);text-align:center" | '''Parpax'''
|-
| style="text-align:right;vertical-align:top" | '''Designated no. of players:'''
| style="text-align:left;vertical-align:top" | 6-12
|-
| style="text-align:right;vertical-align:top" | '''No. of brushes:'''
| style="text-align:left;vertical-align:top" | ~9.5k
|}

A small, intense map by [[User:Viech|Viech]].

It is currently in a late alpha status and has not yet been released to public.

==Gameflow==
[[Image:Parpax_Gameflow.jpg|200px|thumb|right|Gameflow chart]]

The map consists of two floors connected by stairs, an elevator and ventilation shafts.

The [[Humans|human team]] has their default base on the lower floor in a spacious storage room containing huge pillars carrying a platform which can be reached via stairs and a ladder. The front entrance consists of huge shutter doors that open slowly and are prone to trap both attacking aliens and humans fleeing back to their base. It leads to another big storage room which connects to stairs, elevator and elevation shafts and thus is of great tactical importance to both teams. The side entrance of the human base leads to a narrow corridor which runs next to that room and ends at the stairs. The lower floor also contains a network of elevation and pipe shafts, giving small aliens and lightly armored humans additional movement options.

The [[Aliens|aliens]] have their default base in a tight room containing a strange machine. Its front entrance leads to a room which is, being close to stairs, elevator and elevation shafts, the counterpart of the storage room laying right under it. The side entrance leads to a longer but maybe less contested path to the stairs that also connects to the upper ends of the ventilation shafts.

Both default bases have a third entrance that can be opened temporarily by pushing a button located in the respective base. The button in the human base moves aside girders that block access to the ventilation shafts. The aliens' button opens an emergency exit that is a short path to the stairs and connects to the elevation shaft.

The elevator is supposed to be the shortest but most dangerous path from one default base to the other. The car is open at the top and allows small aliens or grenades to slip inside and deliver their devasting effect in a small space. Even if one survives the ride, there may be a heavily armed greeting committee waiting at the other end of the shaft. While big aliens or battlesuits have only the stairs as a less dangerous alternative, lighter forces can also use the ventilation shafts or even the elevator shaft itself for movement between the floors.

==General Strategy==
'''Do''' try to control the big room in front of your default base's front entrance in order to defeat enemies before they get too close to your base. However, don't forget to have a look at the base itself as they are still able to sneak in.

'''Don't''' open the third entrance to your base carelessly as it might not have as good protection as the other two entrances.

==Human Strategy==
'''Do''' use [[Repeater|repeaters]] to protect all entrances to your default base as the [[Reactor|reactor's]] reach isn't big enough to power the whole room.

==Alien Strategy==
TODO

[[Category:Maps]]

Maps/Parpax

2012-08-12T20:56:13Z

Anomalous: A few tweaks

{| style="float:right;margin:1em 0px 1em 1em;border:2px outset #777;" border="0" cellpadding="1" cellspacing="0"
| colspan="2" style="background-color:rgb(187,187,187);text-align:center" | '''Parpax'''
|-
| style="text-align:right;vertical-align:top" | '''Designated no. of players:'''
| style="text-align:left;vertical-align:top" | 6-12
|-
| style="text-align:right;vertical-align:top" | '''No. of brushes:'''
| style="text-align:left;vertical-align:top" | ~9.5k
|}

A small, intense map by [[User:Viech|Viech]].

It is currently in a late alpha status and has not yet been released to public.

==Gameflow==
[[Image:Parpax_Gameflow.jpg|200px|thumb|right|Gameflow chart]]

The map consists of two floors connected by stairs, an elevator and ventilation shafts.

The [[Humans|human team]] has their default base on the lower floor in a spacious storage room containing huge pillars carrying a platform which can be reached via stairs and a ladder. The front entrance consists of huge shutter doors that open slowly and are prone to trap both attacking aliens and humans fleeing back to their base. It leads to another big storage room which connects to stairs, elevator and elevation shafts and thus is of great tactical importance to both teams. The side entrance of the human base leads to a narrow corridor which runs next to that room and ends at the stairs. The lower floor also contains a network of elevation and pipe shafts, giving small aliens and lightly armored humans additional movement options.

The [[Aliens|aliens]] have their default base in a tight room containing a strange machine. Its front entrance leads to a room which is, being close to stairs, elevator and elevation shafts, the counterpart of the storage room laying right under it. The side entrance leads to a longer but maybe less contested path to the stairs that also connects to the upper ends of the ventilation shafts.

Both default bases have a third entrance that can be opened temporarily by pushing a button located in the respective base. The button in the human base moves aside girders that block access to the ventilation shafts. The aliens' button opens an emergency exit that is a short path to the stairs and connects to the elevation shaft.

The elevator is supposed to be the shortest but most dangerous path from one default base to the other. The car is open at the top and allows small aliens or grenades to slip inside and deliver their devasting effect in a small space. Even if one survives the ride, there may be a heavily armed greeting committee waiting at the other end of the shaft. While big aliens or battlesuits have only the stairs as a less dangerous alternative, lighter forces can also use the ventilation shafts or even the elevator shaft itself for movement between the floors.

==General Strategy==
'''Do''' try to control the big room in front of your default base's front entrance in order to defeat enemies before they get too close to your base. However, don't forget to have a look at the base itself as they are still able to sneak in.

'''Don't''' open the third entrance to your base carelessly as it might not have as good protection as the other two entrances.

==Human Strategy==
'''Do''' use [[Repeater|repeaters]] to protect all entrances to your default base as the [[Reactor|reactors]] reach isn't big enough to power the whole room.

==Alien Strategy==
TODO

[[Category:Maps]]

Old/Mapping

2012-07-29T14:27:43Z

Anomalous: ×

==Overview==

TODO

==Guides & Tutorials==

[http://tremulous.net/forum/index.php?topic=14411.0 Useful mapping links thread on Tremulous forums]

[http://tremmapping.pbworks.com/w/page/22453200/Starting%20Tremulous%20Mapping Starting Tremulous Mapping]

[http://tremmapping.pbworks.com/w/page/22453205/Understanding%20Vis%20and%20Hint%20Brushes Understanding Vis and Hint Brushes]

[http://q3map2.everyonelookbusy.net/shader_manual/ Shader Manual]

==Basic Guidelines==

Player sizes, in quake units (qu)
{|class="wikitable"
|Dretch ||30^3
|-
|Granger ||40^3
|-
|Adv Granger ||40^3
|-
|Basilisk ||36^3
|-
|Adv Basilisk ||42^3
|-
|Marauder ||46×46×36
|-
|Adv Marauder ||50×50×40
|-
|Dragoon ||52×52×55
|-
|Adv Dragoon ||58×58×66
|-
|Tyrant ||64×64×92
|-
|Human ||30×30×56
|-
|Crouching ||30×30×40
|-
|Battlesuit ||30×30×72
|}

Players will need an opening at least 1qu wider to fit through (possibly 2). In addition, player bounding boxes do not rotate, which means diagonal corridors would need to be wider (thus the majority should be axis aligned

Map scale:
32qu = 1m

Doorways should be a minimum of 3m×3m, preferably around 4m×4m. Corridors should be a minimum of 5m wide, although it is ''possible'' to use a mix of 4-5m (see Niveus for an example), and at most 8m wide. Do not create corridors more than 40m long without plenty of cover.
Currently large open areas and underwater areas are very human biased.

Alien bases need cover to hide things behind, the entrances should be ~4×4m and should not be easily visible from outside other entrances.

==New Features==

You may be interested in the list of [[Engine features|engine features]].

* [[Navigation Meshes]]

==Where to place your map files==

The most convenient place across platforms is to place your .bsp files and any other assets in the <code>main/maps/</code> subfolder of the [[Running_the_game#Data_locations|data location]] appropriate to your system.

==Resources==

* [http://ingar.satgnu.net/gtkradiant/ Ingar's NetRadiant builds]
* [http://www.custommapmakers.org/wiki/index.php/Main_Page Custom Map Maker's Wiki]

Compiling the source

2012-06-27T18:12:43Z

Anomalous: De-duplicate resources download information

==Mac OS X==

The preferred way of building Unvanquished on Mac OS X is to use Apple's [https://developer.apple.com/xcode/ XCode] along with [http://www.cmake.org/cmake/resources/software.html CMake]; CMake is used to generate an XCode project file that is then used to compile the code.

First, you need to [[Getting_the_source|acquire the source code]].

You may use [http://home.comcast.net/~chet102103/compile.sh this script] to perform these tasks. If you downloaded the source to a folder named <code>Unvanquished</code> in the current directory, a typical invocation would look like this:

$./compile.sh --bundle --compile -s Unvanquished --build Unvanquished-build --bundle-dest .

You will also need to build the libraries from source.

Unvanquished requires the following:
* The jpeg library from the [http://www.ijg.org/ Independent JPEG Group], version 8 or higher. (Version 6 was known to have problems).
* Simple DirectMedia Layer
* The OpenGL Extension Wrangler Library

Optional libraries:
* WebP
* Theora
* Speex
* XVid

===Dependencies===

====JPEG====

$ curl http://www.ijg.org/files/jpegsrc.v8d.tar.gz > jpegsrc.v8d.tar.gz
$ tar xvzf jpegsrc.v8d.tar.gz
$ cd jpeg-8d
$ ./configure
$ make
$ sudo make install

====The OpenGL Extension Wrangler Library (GLEW)====

$ curl -L https://sourceforge.net/projects/glew/files/glew/1.7.0/glew-1.7.0.tgz/download > glew-1.7.0.tgz
$ tar xvzf glew-1.7.0.tgz
$ cd glew-1.7.0
$ make
$ sudo make install

====Simple DirectMedia Layer (SDL)====

At present, there are binaries for SDL.

Intel systems running 10.5 or higher:
$ curl http://www.libsdl.org/release/SDL-1.2.15.dmg > SDL-1.2.15.dmg
$ hdiutil attach SDL-1.2.15.dmg
$ sudo cp -r /Volumes/SDL/SDL.framework /Library/Frameworks
$ hdiutil detach /Volumes/SDL

Intel or PPC systems running 10.4 or higher:
$ curl http://www.libsdl.org/release/SDL-1.2.15-OSX10.4.dmg > SDL-1.2.15-OSX10.4.dmg
$ hdiutil attach SDL-1.2.15-OSX10.4.dmg
$ sudo cp -r /Volumes/SDL/SDL.framework /Library/Frameworks
$ hdiutil detach /Volumes/SDL

====The GNU MP Bignum Library (libgmp)====

$ curl ftp://ftp.gmplib.org/pub/gmp-5.0.5/gmp-5.0.5.tar.bz2 > gmp-5.0.5.tar.bz2
$ tar xvjf gmp-5.0.5.tar.bz2
$ cd gmp-5.0.5
$ ./configure
$ make
$ sudo make install

====Ogg====

$ curl http://downloads.xiph.org/releases/ogg/libogg-1.3.0.tar.gz > libogg-1.3.0.tar.gz
$ tar xvzf libogg-1.3.0.tar.gz
$ cd libogg-1.3.0
$ ./configure
$ make
$ sudo make install

====Vorbis====

$ curl http://downloads.xiph.org/releases/vorbis/libvorbis-1.3.3.tar.gz > libvorbis-1.3.3.tar.gz
$ tar xvzf libvorbis-1.3.3.tar.gz
$ cd libvorbis-1.3.3
$ ./configure
$ make
$ sudo make install

===Configuring with CMake===

# Run CMake.
# Enter the location of the source code.
# Enter the location in which you would like to build the source code. This should be a different directory.
# Click "Configure". You will be prompted as to which generator you would like to use. If you have Xcode installed, choose that. Wait while the configuration process runs. You may have to set the following:
## If CMake did not find your jpeg headers for some reason, set <code>JPEG_INCLUDE_DIR</code> to <code>/path/to/Unvanquished/src/libs/jpeg</code>.
## You may safely disable <code>USE_WEBP</code> to avoid having to compile the library. (At present, the format is not used by any game assets.)
## Check <code>USE_INTERNAL_CRYPTO</code> to avoid having to compile nettle and hogweed.
## Check <code>USE_INTERNAL_SPEEX</code> to avoid having to compile Speex.
## Uncheck <code>USE_CIN_THEORA</code> and <code>USE_CIN_XVID</code> to avoid having to compile Theora or Xvid. (At present, there are not cutscenes or any such that require it.)
## '''You will probably not be able to compile with the GLSL optimizer enabled; uncheck <code>USE_GLSL_OPTIMIZER</code>'''
## If you have selected to generate XCode project files, make the <code>SDLMAIN_LIBRARY</code> field blank. This option is not available if you have the generator set to Unix makefiles.
# Click "Generate".
# You may now close XCode.

===Compiling===

====With XCode====
# Either start XCode and open the project file (in the build directory you specified) or double-click the project file in Finder.
# Open the project file created by CMake, which should be in the build directory you specified.
# Change the active target to "ALL_BUILD" and click Product→Build.

====With Unix Makefiles====

<ul>
<li>Start Terminal (Applications → Utilities → Terminal).</li>
<li>Type the following commands:
<pre>
$ cd /path/to/Unvanquished-build
$ make
</pre>
If you are on a multi-core or multi-processor machine, you may speed up the process by passing the <code>-j</code> argument followed by the number of available cores to <code>make</code>; e.g., <code>make -j4</code>. Note that doing so makes reading error messages more difficult, as multiple instances of the compiler will print to the screen at once, causing information to appear out of order.
</li>
</ul>

===Testing the build===

====With Unix Makefiles====

After compiling, you'll have to place the data files in the <code>main</code> directory in your build directory. [[#Acquiring the Game Files|For download instructions, see below.]]

Your file structure should look as follows:

[[File:Build_dir_Mac_OS_X.png]]

You may now start the application as such:

$ ./daemon.i386

Note that older machines will not support the new OpenGL 3 renderer, and must be started specifying the "vanilla" (aka "GL") renderer:

$ ./daemon.i386 +set cl_renderer GL

===Bundling the Application===

====With CPack====

CPack is able to create standalone bundles (as well as many other types of installers). However you must generate the files using Unix Makefiles instead of XCode.
$ cd /path/to/Unvanquished-build
$ cpack -G Bundle
Some warnings will be printed however these can be safely ignored. There should be a file called Unvanquished.dmg in the Unvanquished-build folder.

====Manually====

You'll find the Mac [http://macdylibbundler.sourceforge.net/ dynamic library bundler] to be quite useful (you must generate the files using Unix Makefiles instead of XCode):

$ curl -L http://sourceforge.net/projects/macdylibbundler/files/macdylibbundler/0.4.1/dylibbundler0.4.1.zip/download > dylibbundler0.4.1.zip
$ unzip dylibbundler0.4.1.zip
$ cd dylibbundler
$ make
$ sudo make install

Once you've done that, you can proceed to create the application bundle. Note that these steps assume that you have downloaded the data files to <code>main/</code> as shown above:

<pre>
$ git=/path/to/Unvanquished-git-repo
$ build=/path/to/Unvanquished-build-dir
$ mkdir -pv Unvanquished.app/Contents/{libs,MacOS,Resources,Frameworks}
$ cp -r $build/main Unvanquished.app/Contents/MacOS
$ sips -s format tiff $git/debian/unvanquished.png --out temp.tiff
$ tiff2icns temp.tiff Unvanquished.app/Contents/Resources/Unvanquished.icns
$ rm temp.tiff
$ cp $build/daemon{,ded}.i386 $build/*.dylib Unvanquished.app/Contents/MacOS
$ cp -r /Library/Frameworks/SDL.framework Unvanquished.app/Contents/Frameworks
$ install_name_tool -id @executable_path/../Frameworks/SDL.framework/Versions/A/SDL Unvanquished.app/Contents/Frameworks/SDL.framework/Versions/A/SDL
$ install_name_tool -change @rpath/SDL.framework/Versions/A/SDL @executable_path/../Frameworks/SDL.framework/Versions/A/SDL Unvanquished.app/Contents/MacOS/daemon.i386
$ install_name_tool -change @rpath/SDL.framework/Versions/A/SDL @executable_path/../Frameworks/SDL.framework/Versions/A/SDL Unvanquished.app/Contents/MacOS/librendererGLi386.dylib
$ install_name_tool -change @rpath/SDL.framework/Versions/A/SDL @executable_path/../Frameworks/SDL.framework/Versions/A/SDL Unvanquished.app/Contents/MacOS/librendererGL3i386.dylib
$ for binary in Unvanquished.app/Contents/MacOS/*.{i386,dylib}; do dylibbundler -b -x $binary -d $dest/Unvanquished.app/Contents/libs/; done
$ cp /usr/lib/libGLEW.1.7.0.dylib ./Unvanquished.app/Contents/libs/libGLEW.1.7.0.dylib
$ chmod +w ./Unvanquished.app/Contents/libs/libGLEW.1.7.0.dylib
$ install_name_tool -id @executable_path/../libs/libGLEW.1.7.0.dylib ./Unvanquished.app/Contents/libs/libGLEW.1.7.0.dylib
$ install_name_tool -change /usr/lib/libGLEW.1.7.0.dylib @executable_path/../libs/libGLEW.1.7.0.dylib ./Unvanquished.app/Contents/MacOS/daemon.i386
$ cat > Unvanquished.app/Contents/Info.plist
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>CFBundleName</key>
<string>Unvanquished</string>
<key>CFBundleDisplayName</key>
<string>Unvanquished</string>
<key>CFBundleExecutable</key>
<string>daemon.i386</string>
<key>CFBundleIconFile</key>
<string>Unvanquished.icns</string>
<key>CFBundleIdentifier</key>
<string>net.Unvanquished</string>
<key>CFBundleInfoDictionaryVersion</key>
<string>6.0</string>
<key>CFBundlePackageType</key>
<string>APPL</string>
<key>CFBundleShortVersionString</key>
<string>0.4.0</string>
<key>CFBundleVersion</key>
<string>0.4.0</string>
</dict>
</plist>
^d
</pre>

Note: <code>^d</code> indicates pressing Ctrl+D on the keyboard.

The contents of the completed application bundle should look like this:

[[File:Bundle_dir_Mac_OS_X.png]]

==Windows==

===Visual Studio===

CMake can generate Visual Studio projects for unvanquished however this feature is relatively new and may have some bugs.

Steps:

# Double click on Visual_Studio32.bat
# Open build-32/Daemon.sln in Visual Studio 2010.
# In the two text boxes in the toolbar, select "Release" or "Debug" in the first one and Win32 in the second one
# Press F5 to build solution and run application, or just use Build → Build Solution to compile the code.

====Important Notes====

* The CMake script currently only supports 32 bit builds however this will change in the future
* QVM, LLVM and glsl-optimizer are disabled and probably do not work correctly with CMake generated Visual Studio projects.
* ncurses is not supported under Visual Studio.

===MinGW===
Unvanquished is supported under MinGW. The build process should be fairly similar to the Linux instructions.

==Linux==

===Dependencies===


====Debian/Ubuntu====

$ sudo apt-get install libcurl4-gnutls-dev libfreetype6-dev libglew1.5-dev \
libgmp3-dev libjpeg8-dev libncurses5-dev libogg-dev libopenal-dev \
libpng12-dev libsdl1.2-dev libvorbis-dev zlib1g-dev nettle-dev \
libwebp-dev libspeexdsp-dev libtheora-dev

Actual dev package names may vary, e.g. libgmp-dev instead of libgmp3-dev and libglew-dev or libglew1.7-dev instead of libglew1.5-dev.

Since we have a debian directory in the source, you can also to check what's needed then install the listed packages (choosing from alternatives as needed):

$ cd <var>/path/to/unvanquished</var>
$ dpkg-checkbuilddeps
…
$ sudo apt-get install <var>package(s)</var>

If dpkg-checkbuilddeps produces no output, you have all necessary build dependencies. Also, debhelper's only needed if you're building .debs.

====Gentoo====

$ emerge curl freetype glew gmp jpeg ncurses libogg openal libpng libsdl libvorbis zlib

===Configuring the code with CMake===

After you have [[Getting the source|acquired the source code]], you can proceed to compile. Unvanquished uses CMake, so you must have that installed.

====Using ccmake (curses-based front-end)====

On Debian or Ubuntu:

$ sudo apt-get install cmake-curses-gui

On Gentoo you should set the '''ncurses''' USE flag either globally or individually, just for cmake.
To add the USE flag globally, edit the USE array in /etc/make.conf for it to include '''ncurses'''.
To only install cmake with ncurses functionality, you could do the following:

$ echo 'dev-util/cmake ncurses' >> /etc/portage/package.use && emerge cmake

Note that in Ubuntu, <code>cmake-curses-gui</code> is in Universe, which you may have to enable with <code>software-properties-gtk</code>. Make sure to reload the software sources with <code>sudo apt-get update</code> afterwards.

Next, configure the codebase.

$ cd <var>/path/to/unvanquished</var>
$ mkdir build
$ cd build
$ ccmake ..

Or, in Debian or Ubuntu, you can build a package (but you'll need to have devscripts and fakeroot installed):

$ cd <var>/path/to/unvanquished</var>
$ fakeroot dpkg-buildpackage -b -uc
$ sudo dpkg -i <var>../unvanquished_*.deb</var>

Once in <code>ccmake</code>, use the following keys:

* Press c to configure. If an error occurs during this phase, make note of it and press e to dismiss it.
* Use the up and down arrow keys to navigate the compilation options.
* Press Enter to enable or disable boolean options (i.e., on/off) or to edit textual options.
** Press Esc when editing a textual option to cancel the change.

Once you have finished the configuration process, press C again, then G to generate the makefile.

====Using cmake-qt-gui (graphical front-end)====

This graphical front end for cmake has its own package you must install:

=====Debian/Ubuntu=====

$ sudo apt-get install cmake-qt-gui

=====Gentoo=====

With the '''qt4''' USE flag enabled:

$ emerge cmake

Once installed, run with <code>cmake-gui</code>.

[[Image:Cmake-qt-gui.png|thumb]]

# Set the path where you have the source code downloaded.
# Set the path where you would like to build the engine. This may be the same directory if you wish.
# Click 'Configure'.
# Click 'Generate'.

====Unnecessary libraries====

Regardless of which front-end to cmake you use, you may want to disable some libraries that are not strictly necessary:

* <code>USE_WEBP</code> — Some maps use WebP to store their textures. Currently this should have little impact on gameplay but more maps will likely use this format in the future.
* <code>USE_OPENAL</code> — If this is disabled, SDL is used instead for sound.
* <code>USE_CODEC_VORBIS</code> — Disabling this will cause certain sound effects (those using the <code>.ogg</code> format) not to play. At present, this has only a minor impact on gameplay, but more and more sounds will likely use the format in the future.
* <code>USE_CURSES</code> — Disabling this will cause the external (not in-game) console to not use curses; it will not be scrollable and will be similar to the console in the original Tremulous. This does in no way affect gameplay.
* <code>USE_CIN_THEORA</code> — Disabling this prevents videos from being recorded in Theora.
* <code>USE_CIN_XVID</code> — Disabling this prevents videos from being recorded in Xvid.
* <code>USE_VOIP</code> — Disabling this removes VOIP support. Alternatively enabling <code>USE_INTERNAL_SPEEX</code> will use the libraries distributed with Unvanquished for VoIP
* <code>USE_INTERNAL_CRYPTO</code> — Enable this to use the crypto libraries provided by Unvanquished.

===Compiling===

$ cd <var>path/to/unvanquished/build</var>
$ make -j4

The <code>-j</code> switch to make allows you to speed up the compilation process by running it in multiple threads; set the number following this to the number of cores your processor(s) have.

===Acquiring the Game Files===

The game files are not in the Git repository, and must be downloaded separately.

$ cd <var>path/to/Unvanquished/build</var>
$ cd main
$ wget http://sourceforge.net/projects/unvanquished/files/Assets/pak0.pk3/download
$ wget http://sourceforge.net/projects/unvanquished/files/Assets/pak1.pk3/download
$ wget http://sourceforge.net/projects/unvanquished/files/Assets/pak2.pk3/download
$ wget http://sourceforge.net/projects/unvanquished/files/Map%20Pack/maps.7z/download

You can also get the pak files in this way (requires curl):

$ cd <var>path/to/Unvanquished</var>
$ mkdir -p ~/.Unvanquished/main
$ ./download-pk3.sh ~/.Unvanquished/main

The maps archive file isn't strictly necessary: if you don't have a particular map, the game will, by default, download missing files for you.

Now you can proceed to [[running the game]].

==Errors==

===CMake cannot locate Newton===

If CMake cannot find Newton, you'll need to set it up yourself.

It should be in <code><var>/path/to/Unvanquished</var>/src/libs/libnewton/libs/<var>your_os</var>/libNewton.so</code>.
Be sure to replace <var>your_os</var> with the proper directory name.

Use CMake as before to change the <code>NEWTON_LIBRARY</code> build setting to the said path:

# Start the CMake configurator:<pre>$ ccmake ..</pre>
# Scroll down and highlight <code>NEWTON_LIBRARY</code>.
# Press Enter to begin editing and input in the path.
# Press C to configure and G to generate the new makefiles.
# Press Q to quit.
# Recompile the source:<pre>$ make</pre>

Creating custom keybinds

2012-05-11T11:52:54Z

Anomalous: Float the TOC at the top right. It's tall…

{| align="right"
| __TOC__
|}
==Overview==

'''''The information on this page is incomplete.'''''

A number of commands for keybinds have changed since Tremulous, so keybind configurations cannot be directly copied from Tremulous to Daemon.

{| class="wikitable"
! Tremulous || Daemon || Used for…
|-
| <code>+button2</code> || <code>+useitem</code> || Using an item; granger spit; dragoon barb
|-
| <code>+button3</code> || <code>+taunt</code> || “Come on!” etc.
|-
| <code>+button5</code> || <code>+attack2</code> || Secondary attack
|-
| <code>+button6</code> || <code>+dodge</code> || Dodging
|-
| <code>+button7</code> || <code>+activate</code> || Using a structure; evolving
|-
| <code>+button8</code> || <code>+sprint</code> || Sprinting
|-
|}

As of alpha 3, the <code>+button''N''</code> commands are no longer present.

You may want to bind the new [[Voice say system|vsays]] to different keys.
==New commands==

This is a partial list of commands added, using Tremulous GPP r2259 as a reference point. Not everything listed is actually useful.

===+activate===
Access an armoury; evolve.

===+attack2===
Secondary attack.

===+dodge===
Low jump sideways or backwards. (Humans only.)

===+sprint===
Run. (Humans only.)

===+taunt===
“Come on!” etc.

===+useitem===
Use the highlighted item; tertiary attack (granger spit, dragoon snipe).

===LoadTranslations===

===SaveNewTranslations===

===SaveTranslations===

===alias===
<tt>alias NAME COMMAND [PARAMETERS…]</tt>

Create an alias for the given command. The alias is then useable as a command in its own right.

===aliaslist===
Lists available command aliases.

===animationlist===

===buildcubemaps===

===cache_endgather===

===cache_mapchange===

===cache_setindex===

===cache_startgather===

===cache_usedfile===

===calc===

===clearaliases===
Clears all command aliases.

===concat===

===cycle===

===delay===

===editbind===
<tt>editbind KEY</tt>

This inserts a <tt>/bind</tt> command into the in-game console, ready for editing. The console is opened if needed.

===fbolist===

===fieldinfo===

===gameCompleteStatus===

===glsl_restart===
Development use. For recompiling the GLSL shader code.

===grep===
<tt>grep TEXT</tt>

Searches the in-game console for occurrences of <tt>TEXT</tt>. Matching lines are reprinted.

===help===

===if===
<tt>if VALUE CONDITION VALUE THEN [ELSE]</tt>

<tt>if MODIFIERS THEN [ELSE]</tt>

; <tt>VALUE</tt> : a variable or number
; <tt>CONDITION</tt> : comparison operator
; <tt>MODIFIERS</tt> : comma-separated list of keyboard modifiers: Shift, Ctrl, Alt, Command (or Cmd), Mode, Super. Prefix any which must not be pressed with <kbd>!</kbd>.
; <tt>THEN</tt> and <tt>ELSE</tt> : either a variable name or, if prefixed with <kbd>/</kbd> or <kbd>\</kbd>, a command string.

Either the <tt>THEN</tt> clause or the <tt>ELSE</tt> clause (if present) will be executed. If it is a variable name, its content will be executed.

For example: <pre>/if shift "/echo Hello" "/echo Goodbye"</pre>

===irc_connect===

===irc_quit===

===irc_say===

===listrotation===
Lists the current map rotation. The current map is highlighted.

===loadgame===

===math===

===messagemode4===
This command opens a chat prompt for the built-in IRC client.

===modcase===
<tt>modcase MODIFIERS THEN [MODIFIERS THEN]* [ELSE]</tt>

This works like <tt>if</tt>. The leftmost most-specific <tt>THEN</tt> whose modifier list matches is the one which is executed; if none match, then <tt>ELSE</tt> is executed if it is present.

For example:
<pre>/modcase shift "/echo 1" ctrl "/echo 2" shift,ctrl "/echo 3" shift,!alt "/echo 4"</pre>
works as follows:

# if Shift and Alt (due to clause 4) but not Ctrl (due to clause 3) are pressed;
# if Ctrl but not Shift (due to clause 3);
# if Shift and Ctrl;
# if Shift but neither Alt nor Ctrl.

===modelist===

===openurl===

===pubkey===

===pubkey_identify===

===random===

===reloadhud===

===say_area_team===

===screenshotPNG===
Saves a screenshot.

===search===
<tt>search TEXT</tt>

Searches back through the in-game console for <tt>TEXT</tt> and scrolls to it.

===searchDown===
<tt>searchDown TEXT</tt>

Searches forward through the in-game console for <tt>TEXT</tt> and scrolls to it.

===setRecommended===

===shaderexp===

===snd_reload===

===spdevmap===
Does nothing.

===speclock===

===specunlock===

===spmap===
Does nothing.

===strcmp===

===toggleConsole===
Opens or closes the in-game console.

===ui_restart===
Reloads UI files.

===unalias===
<tt>unalias NAME</tt>

Removes the named alias.

===undelay===

===undelayAll===

===unregister===
Removes registration of your GUID and name.

===updatehunkusage===

===updatescreen===

===vbolist===

===wav_record===

===wav_stoprecord===

Creating custom keybinds

2012-05-11T11:51:36Z

Anomalous: List new commands since Tremulous GPP r2259

==Overview==

'''''The information on this page is incomplete.'''''

A number of commands for keybinds have changed since Tremulous, so keybind configurations cannot be directly copied from Tremulous to Daemon.

{| class="wikitable"
! Tremulous || Daemon || Used for…
|-
| <code>+button2</code> || <code>+useitem</code> || Using an item; granger spit; dragoon barb
|-
| <code>+button3</code> || <code>+taunt</code> || “Come on!” etc.
|-
| <code>+button5</code> || <code>+attack2</code> || Secondary attack
|-
| <code>+button6</code> || <code>+dodge</code> || Dodging
|-
| <code>+button7</code> || <code>+activate</code> || Using a structure; evolving
|-
| <code>+button8</code> || <code>+sprint</code> || Sprinting
|-
|}

As of alpha 3, the <code>+button''N''</code> commands are no longer present.

You may want to bind the new [[Voice say system|vsays]] to different keys.

{| align="right"
| __TOC__
|}
==New commands==

This is a partial list of commands added, using Tremulous GPP r2259 as a reference point. Not everything listed is actually useful.

===+activate===
Access an armoury; evolve.

===+attack2===
Secondary attack.

===+dodge===
Low jump sideways or backwards. (Humans only.)

===+sprint===
Run. (Humans only.)

===+taunt===
“Come on!” etc.

===+useitem===
Use the highlighted item; tertiary attack (granger spit, dragoon snipe).

===LoadTranslations===

===SaveNewTranslations===

===SaveTranslations===

===alias===
<tt>alias NAME COMMAND [PARAMETERS…]</tt>

Create an alias for the given command. The alias is then useable as a command in its own right.

===aliaslist===
Lists available command aliases.

===animationlist===

===buildcubemaps===

===cache_endgather===

===cache_mapchange===

===cache_setindex===

===cache_startgather===

===cache_usedfile===

===calc===

===clearaliases===
Clears all command aliases.

===concat===

===cycle===

===delay===

===editbind===
<tt>editbind KEY</tt>

This inserts a <tt>/bind</tt> command into the in-game console, ready for editing. The console is opened if needed.

===fbolist===

===fieldinfo===

===gameCompleteStatus===

===glsl_restart===
Development use. For recompiling the GLSL shader code.

===grep===
<tt>grep TEXT</tt>

Searches the in-game console for occurrences of <tt>TEXT</tt>. Matching lines are reprinted.

===help===

===if===
<tt>if VALUE CONDITION VALUE THEN [ELSE]</tt>

<tt>if MODIFIERS THEN [ELSE]</tt>

; <tt>VALUE</tt> : a variable or number
; <tt>CONDITION</tt> : comparison operator
; <tt>MODIFIERS</tt> : comma-separated list of keyboard modifiers: Shift, Ctrl, Alt, Command (or Cmd), Mode, Super. Prefix any which must not be pressed with <kbd>!</kbd>.
; <tt>THEN</tt> and <tt>ELSE</tt> : either a variable name or, if prefixed with <kbd>/</kbd> or <kbd>\</kbd>, a command string.

Either the <tt>THEN</tt> clause or the <tt>ELSE</tt> clause (if present) will be executed. If it is a variable name, its content will be executed.

For example: <pre>/if shift "/echo Hello" "/echo Goodbye"</pre>

===irc_connect===

===irc_quit===

===irc_say===

===listrotation===
Lists the current map rotation. The current map is highlighted.

===loadgame===

===math===

===messagemode4===
This command opens a chat prompt for the built-in IRC client.

===modcase===
<tt>modcase MODIFIERS THEN [MODIFIERS THEN]* [ELSE]</tt>

This works like <tt>if</tt>. The leftmost most-specific <tt>THEN</tt> whose modifier list matches is the one which is executed; if none match, then <tt>ELSE</tt> is executed if it is present.

For example:
<pre>/modcase shift "/echo 1" ctrl "/echo 2" shift,ctrl "/echo 3" shift,!alt "/echo 4"</pre>
works as follows:

# if Shift and Alt (due to clause 4) but not Ctrl (due to clause 3) are pressed;
# if Ctrl but not Shift (due to clause 3);
# if Shift and Ctrl;
# if Shift but neither Alt nor Ctrl.

===modelist===

===openurl===

===pubkey===

===pubkey_identify===

===random===

===reloadhud===

===say_area_team===

===screenshotPNG===
Saves a screenshot.

===search===
<tt>search TEXT</tt>

Searches back through the in-game console for <tt>TEXT</tt> and scrolls to it.

===searchDown===
<tt>searchDown TEXT</tt>

Searches forward through the in-game console for <tt>TEXT</tt> and scrolls to it.

===setRecommended===

===shaderexp===

===snd_reload===

===spdevmap===
Does nothing.

===speclock===

===specunlock===

===spmap===
Does nothing.

===strcmp===

===toggleConsole===
Opens or closes the in-game console.

===ui_restart===
Reloads UI files.

===unalias===
<tt>unalias NAME</tt>

Removes the named alias.

===undelay===

===undelayAll===

===unregister===
Removes registration of your GUID and name.

===updatehunkusage===

===updatescreen===

===vbolist===

===wav_record===

===wav_stoprecord===

Compiling the source

2012-05-03T19:08:34Z

Anomalous: /* Acquiring the Game Files */

==Overview==

==Mac OS X==

The preferred way of building Unvanquished on Mac OS X is to use Apple's [https://developer.apple.com/xcode/ XCode] along with [http://www.cmake.org/cmake/resources/software.html CMake]; CMake is used to generate an XCode project file that is then used to compile the code.

First, you need to [[Getting_the_source##Mac_OS_X_2|acquire the source code]].

Next, perform the following:

# Run CMake.
# Enter the location of the source code.
# Enter the location in which you would like to build the source code. This may be the same directory.
# Click "Configure". You will be prompted as to which generator you would like to use. If you have Xcode installed, choose that.
# Wait while the configuration process runs.
# '''''TODO: explain which libraries will likely have to be set'''''
# Click "Generate".
# Close CMake and open Xcode.
# Open the project file created by CMake, which should be in the build directory you specified.
# Click the build button.

Unvanquished can also be built from the command line if you're not a fan of Xcode. The build process is the same as under Linux.

==Windows==

The preferred way of building Unvanquished on Windows is to use Microsoft Visual Studio 2010.
The free Express version of the software works fine.

Steps:
# Open src/engine/Daemon.sln in Visual Studio 2010.
# In the two text boxes in the toolbar, select "Release" in the first one and Win32 or Win64 in the second one
# Press F5 to build solution and run application, or just use Build → Build Solution to compile the code.

==Linux==

===Dependencies===


====Debian/Ubuntu====

$ sudo apt-get install libcurl4-gnutls-dev libfreetype6-dev libglew1.5-dev \
libgmp3-dev libjpeg8-dev libncurses5-dev libogg-dev libopenal-dev \
libpng12-dev libsdl1.2-dev libvorbis-dev zlib1g-dev nettle-dev \
libwebp-dev libspeexdsp-dev libtheora-dev

Actual dev package names may vary, e.g. libgmp-dev instead of libgmp3-dev and libglew-dev or libglew1.7-dev instead of libglew1.5-dev.

Since we have a debian directory in the source, you can also to check what's needed then install the listed packages (choosing from alternatives as needed):

$ cd <var>/path/to/unvanquished</var>
$ dpkg-checkbuilddeps
…
$ sudo apt-get install <var>package(s)</var>

If dpkg-checkbuilddeps produces no output, you have all necessary build dependencies. Also, debhelper's only needed if you're building .debs.

====Gentoo====

$ emerge curl freetype glew gmp jpeg ncurses libogg openal libpng libsdl libvorbis zlib

===Configuring the code with CMake===

After you have [[Getting the source|acquired the source code]], you can proceed to compile. Unvanquished uses CMake, so you must have that installed.

====Using ccmake (curses-based front-end)====

On Debian or Ubuntu:

$ sudo apt-get install cmake-curses-gui

On Gentoo you should set the '''ncurses''' USE flag either globally or individually, just for cmake.
To add the USE flag globally, edit the USE array in /etc/make.conf for it to include '''ncurses'''.
To only install cmake with ncurses functionality, you could do the following:

$ echo 'dev-util/cmake ncurses' >> /etc/portage/package.use && emerge cmake

Note that in Ubuntu, <code>cmake-curses-gui</code> is in Universe, which you may have to enable with <code>software-properties-gtk</code>. Make sure to reload the software sources with <code>sudo apt-get update</code> afterwards.

Next, configure the codebase.

$ cd <var>/path/to/unvanquished</var>
$ mkdir build
$ cd build
$ ccmake ..

Or, in Debian or Ubuntu, you can build a package (but you'll need to have devscripts and fakeroot installed):

$ cd <var>/path/to/unvanquished</var>
$ fakeroot dpkg-buildpackage -b -uc
$ sudo dpkg -i <var>../unvanquished_*.deb</var>

Once in <code>ccmake</code>, use the following keys:

* Press c to configure. If an error occurs during this phase, make note of it and press e to dismiss it.
* Use the up and down arrow keys to navigate the compilation options.
* Press Enter to enable or disable boolean options (i.e., on/off) or to edit textual options.
** Press Esc when editing a textual option to cancel the change.

Once you have finished the configuration process, press C again, then G to generate the makefile.

====Using cmake-qt-gui (graphical front-end)====

This graphical front end for cmake has its own package you must install:

=====Debian/Ubuntu=====

$ sudo apt-get install cmake-qt-gui

=====Gentoo=====

With the '''qt4''' USE flag enabled:

$ emerge cmake

Once installed, run with <code>cmake-gui</code>.

[[Image:Cmake-qt-gui.png|thumb]]

# Set the path where you have the source code downloaded.
# Set the path where you would like to build the engine. This may be the same directory if you wish.
# Click 'Configure'.
# Click 'Generate'.

====Unnecessary libraries====

Regardless of which front-end to cmake you use, you may want to disable some libraries that are not strictly necessary:

* <code>USE_WEBP</code> — Some maps use WebP to store their textures. Currently this should have little impact on gameplay but more maps will likely use this format in the future.
* <code>USE_OPENAL</code> — If this is disabled, SDL is used instead for sound.
* <code>USE_CODEC_VORBIS</code> — Disabling this will cause certain sound effects (those using the <code>.ogg</code> format) not to play. At present, this has only a minor impact on gameplay, but more and more sounds will likely use the format in the future.
* <code>USE_CURSES</code> — Disabling this will cause the external (not in-game) console to not use curses; it will not be scrollable and will be similar to the console in the original Tremulous. This does in no way affect gameplay.
* <code>USE_CIN_THEORA</code> — Disabling this prevents videos from being recorded in Theora.
* <code>USE_CIN_XVID</code> — Disabling this prevents videos from being recorded in Xvid.
* <code>USE_VOIP</code> — Disabling this removes VOIP support. Alternatively enabling <code>USE_INTERNAL_SPEEX</code> will use the libraries distributed with Unvanquished for VoIP
* <code>USE_INTERNAL_CRYPTO</code> — Enable this to use the crypto libraries provided by Unvanquished.

===Compiling===

$ cd <var>path/to/unvanquished/build</var>
$ make -j4

The <code>-j</code> switch to make allows you to speed up the compilation process by running it in multiple threads; set the number following this to the number of cores your processor(s) have.

===Acquiring the Game Files===

The game files are not in the Git repository, and must be downloaded separately.

$ cd <var>path/to/Unvanquished/build</var>
$ cd main
$ wget http://sourceforge.net/projects/unvanquished/files/Assets/pak0.pk3/download
$ wget http://sourceforge.net/projects/unvanquished/files/Assets/pak1.pk3/download
$ wget http://sourceforge.net/projects/unvanquished/files/Assets/pak2.pk3/download
$ wget http://sourceforge.net/projects/unvanquished/files/Map%20Pack/maps.7z/download

You can also get the pak files in this way (requires curl):

$ cd <var>path/to/Unvanquished</var>
$ mkdir -p ~/.Unvanquished/main
$ ./download-pk3.sh ~/.Unvanquished/main

The maps archive file isn't strictly necessary: if you don't have a particular map, the game will normally download it for you.

Now you can proceed to [[running the game]].

==Errors==
===Crash/Freeze on Death===
Some Linux users may experience a bug where the game freezes whenever you die. The work around until this bug is fixed is to to run <code>ccmake ..</code> and change <code>CMAKE_BUILD_TYPE</code> to <code>Debug</code>. Run <code>make</code> and it should now work.