Mod Wiki - User contributions [en-gb]

Benchmarking

2008-02-05T12:53:12Z

192.168.0.64:

= Benchmarking with Enemy Territory QUAKE Wars =

== 1. Benchmarking ==

Enemy Territory QUAKE Wars (ETQW) provides several means to benchmark the system performance. However, anyone using ETQW for benchmarking should be careful in properly interpreting the results.

ETQW uses several threads of execution for instance for the game logic, texture streaming, texture transcoding, sound processing etc. However, by default the renderer is not running in a separate thread. When a system has multiple CPUs or a CPU with multiple cores the ETQW performance can be improved by enabling the multi-threaded renderer by setting the console variable '''r_useThreadedRenderer''' to '''2'''. However, when a system does neither have multiple CPUs nor a CPU with multiple cores the performance may not improve if this multi-threading is enabled.

At any time one of the many components in a PC can become a bottleneck and limit the performance. As such correct interpretation of the results requires identifying the bottlenecks in the system.

At higher resolutions the ETQW performance quickly becomes limited by the graphics card. This means that graphics card cannot keep up with the speed of the CPU and memory. At lower resolutions and with high end graphics cards the ETQW performance is more likely to be dependent on the CPU speed, but also very much dependent on the memory speed. Increasing the memory speed can sometimes have close to the same effect on the performance as increasing the CPU speed. ETQW may not utilize all the available memory bandwidth but increasing the memory speed also lowers the memory access time which affects the performance.

== 2. Multiplayer Performance using 'timeNetDemo' ==

A network demo is a recording of the network traffic during a multiplayer game. A network demo can be recorded at the a client connected to a multiplayer server. Such network demos are referred to as ''client netdemos''. A network demo can also be recorded at the server. These network demos are referred to as ''server netdemos''.

When playing back a ''client netdemo'', ETQW will behave exactly as if playing a live multiplayer game. ''Server netdemos'' record more information than ''client netdemos'', and when playing back a server demo the view can be moved freely through the world or the view can be attached to any of the players that were playing on the server at the time of the recording.

ETQW allows playback of ''client netdemos'' as fast as possible where the engine continuously runs one game frame and one render frame. Playing back a network demo as fast as possible is referred to as a ''time net demo''. Time Net demos can be used to rate the ''overall'' performance of a system configuration including CPU speed, memory speed and GPU speed.

The ETQW net time demos are meant to be used to rate the overall system performance. However, when using ETQW to benchmark the speed of graphics cards always make sure the system has the fastest CPU and the fastest memory available to make sure the CPU and memory subsystem have as little effect on the performance as possible.

When benchmarking the speed of CPUs always make sure the system has the fastest memory available to make sure the effect of the memory speed on the performance is as small as possible. Furthermore use a low resolution with the fastest graphics card solution available and disable features like anti-aliasing.

A net time demo can be started with the following console command:

'''timeNetDemo''' <demoName>

After playing the net demo the average framerate (FPS) is shown. Furthermore, the number of MegaTexture tiles that were processed is shown as well. While the player moves through an ETQW environment, terrain texture data is streamed in from the harddisk on a per tile basis. This texture data needs to be processed before it can be displayed. This process uses multiple threads such that a slow harddisk won't slow down the game. However, processing the texture data does take up CPU time. In other words the number of tiles that were processed during the demo playback may change the average FPS. To get consistent results, and/or when benchmarking only the graphics card performance set '''r_megaTilesPerSecond''' to 0. This way, parts of the terrain may become blurry during demo playback but the harddisk and CPU performance won't affect the measured average FPS.

== 3. Single Player Performance using 'timeServer' ==

Single player games with bots are typically more CPU intensive because the game does not just have to keep track of things that are happening in the player's view, but has to keep track of everything in the world. This may include things that happen behind the player or happen on the other side of a map. Furthermore, the game has to run the Artificial Intelligence (AI) for the bots which requires CPU time as well.

To benchmark the CPU and memory speed of a system it is best to measure the performance of a single player game. This can be done with the following console command:

'''timeServer''' <mapName> <number of game frames> <number of bots>

This is similar to running a time net demo except that this command runs a live game. It basically runs the game as fast as possible for the specified number of game frames with the specified number of bots. Each game frame it also renders one frame and it also runs one bot AI think frame.

With the bots running in a separate thread the game is not deterministic because the bots may query the collision state of the game world at arbitrary times. As such the 'timeServer' test is best run multiple times, where the median of the runs is taken as the performance result.

Enemy Territory: QUAKE Wars

2008-02-05T12:52:14Z

192.168.0.64: /* ETQW:TV */

__NOTOC__

Welcome to the Enemy Territory: QUAKE Wars section. Here you'll find a variety of reference documentation and tutorials related to editing ETQW, along with links to the SDK. To learn more about Enemy Territory: QUAKE Wars, visit [http://www.enemyterritory.com www.enemyterritory.com].

==Software Development Kit==

The Enemy Territory: QUAKE Wars Software Development kit is currently in BETA. A list of download locations is [http://community.enemyterritory.com/index.php?q=node/210 available here].

==Tutorials==
{| width="100%"
| width="50%" valign="top" |
{| style="border: 1px solid #AAAAAA;" width="100%"
| style="border-bottom: 1px solid #AAAAAA;" |
=== Basics ===
|-
|
* '''[[A Simple First Map]]''' - a step-by-step guide towards making a simple map.
* '''[[A Simple Second Map]]''' - a second step-by-step guide.
* '''[[Taking A Screenshot]]''' - Settings and options for making a great screenshot!
* '''[[Packaging up a Map or Mod]]''' - How to make pak files, and pak file configs.

|-
| style="border-bottom: 1px solid #AAAAAA;" |

=== Terrain ===
|-
|
* '''[[A Simple First Terrain]]''' - a step-by-step guide for terrains.
* '''[[A Simple First Megatexture]]''' - a step-by-step guide for basic Megatextures.
* '''[[Making a Terrain Model]]''' - more detailed guide for terrain meshes.
* '''[[An Advanced Terrain and Megatexture]]''' - a comprehensive guide for making detailed terrain models with Megatextures.
|-
|}
| width="50%" valign="top" |
{| style="border: 1px solid #AAAAAA;" width="100%"
| style="border-bottom: 1px solid #AAAAAA;" |

=== Vehicles ===
|-
|
* '''[[Vehicle Tutorial]]''' - The whole thing! Click below for smaller segments.
** '''[[Vehicle Tutorial Part 1|Step 1]]''' - Design considerations, before you do anything else!
** '''[[Vehicle Tutorial Part 2|Step 2]]''' - Initial rough model, rig and basic script.
** '''[[Vehicle Tutorial Part 3|Step 3]]''' - More advanced rig and scripting.
** '''[[Vehicle Tutorial Part 4|Step 4]]''' - Further technical setup ideas.
|-
| style="border-bottom: 1px solid #AAAAAA;" |
=== Models & Textures ===
|-
|
* '''[[Adding Custom Textures]]''' - Create materials to add your own custom textures to the game.
* '''[[Making A Normal Map]]''' - Using Renderbump to generate a bump-map from a high-poly model.
|-
|}
|}

==Script & Code==
{| width="100%"
| width="50%" valign="top" |
{| style="border: 1px solid #AAAAAA;" width="100%"
| style="border-bottom: 1px solid #AAAAAA;" |
=== Coding ===
|-
|
* '''[[Windows Code Notes]]''' - General information about compiling on Windows.
* '''[[Linux Code Notes]]''' - General information about compiling on Linux systems.
* '''[[Generating Compiled Scripts]]''' - Information on building a compiledscript DLL.
|-
| style="border-bottom: 1px solid #AAAAAA;" |

=== Declarations ===
|-
|
* '''[[Materials]]''' - All you need to know about material declarations.
* '''[[Templates]]''' - Setting up templates to save time and effort.
* '''[[Surface Types]]''' - Available surface types for particle & sound effects.
* '''[[Skins]]''' - Easily switch textures on surfaces.
|-
| style="border-bottom: 1px solid #AAAAAA;" |

=== Vehicle Scripting ===
|-
|
* '''[[Vehicle Scripting: Basic_Overview|Basic Overview]]''' - Introduction to vehicle setup.
* '''[[Vehicle Scripting: Entity_Definition|Entity Definition]]''' - One definition to rule them all!
* '''[[Vehicle Scripting: Vehicle_Definition|Vehicle Definition]]''' - Introduction to the ''.vscript'' file.
* '''[[Vehicle Scripting: Positions_&_Views|Positions & Views]]''' - Configuring player positions & camera views.
* '''[[Vehicle Scripting: Components|Components]]''' - Details of various vehicle components.
* '''[[Vehicle Scripting: Weapons|Weapons]]''' - Things that go boom!
* '''[[Vehicle Scripting: IK|IK]]''' - Inverse Kinematics & you...
* '''[[Vehicle Scripting: Cockpits|Cockpits]]''' - Cockpit setup.
|-
|}
| width="50%" valign="top" |
{| style="border: 1px solid #AAAAAA;" width="100%"
| style="border-bottom: 1px solid #AAAAAA;" |
=== Entity Scripting ===
|-
|
* '''[[EntityClass:Overview|Classes]]''' - Tree of entity types.
* '''[[ScriptEvent:List|Events]]''' - List of all script events.
* '''[[Scripting:Examples|Examples]]''' - Some example walkthoughs of building up a scripted entity.
* '''[[Script:Files|Script Files]]''' - List of the script files used by the game.
|-
| style="border-bottom: 1px solid #AAAAAA;" |

=== GUIs ===
|-
|
* '''[[GUIs|GUI Overview]]''' - Overview of the GUI system.
* '''[[GUIs: Event Based Scripting|Event Based Scripting]]''' - GUIs are event-based.
* '''[[GUIs: Materials|Materials]]''' - Using materials in GUIs.
* '''[[GUIs: Transitions|Transitions]]''' - Transitions.
* '''[[GUIs: Templates|Templates]]''' - Using templates in GUIs.
* '''[[GUIs: List Enumeration|List Enumeration]]''' - List enumerations.
* '''[[GUIs: Properties|Properties]]''' - Player/Global properties and more.
* '''[[GUIs: Timelines|Timelines]]''' - GUI timelines.
* '''[[GUIs: Layouts|Layouts]]''' - Window layouts.
* '''[[Reference (GUIs)|Reference]]''' - GUI reference.
|-
| style="border-bottom: 1px solid #AAAAAA;" |

=== File Formats ===
|-
|
* '''[[PROCB|PROCB Mesh Data]]''' - Loading mesh data from a procb file.
|-
|}
|}

==Design==
{| width="100%"
| width="50%" valign="top" |
{| style="border: 1px solid #AAAAAA;" width="100%"
| style="border-bottom: 1px solid #AAAAAA;" |
=== The Basics ===
|-
|
* '''[[A Simple First Map]]''' - step-by-step guide towards making a simple map
* '''[[A Simple Second Map]]''' - step-by-step guide towards making a simple map
* '''[[A Simple First Terrain]]''' - step-by-step guide creating a simple terrain
* '''[[An Advanced Map]]''' - includes terrain
* '''[[Design: How do I|How do I ...?]]''' - Common and useful tasks
* '''[[Map Troubleshooting]]''' - Common problems and fixes
----
* '''[[Brush Basics]]'''
* '''[[Entity Basics]]'''
* '''[[Lighting Basics]]'''
* '''[[Portal Basics]]'''
----
* '''[[Common Textures]]'''
* '''[[Decals]]'''
* '''[[Editor Groups]]'''
* '''[[Map Objects]]'''
* '''[[References]]'''
* '''[[Sound]]'''
* '''[[Texturesheets]]'''
* '''[[Water]]'''
----
* '''[[Ambient Light Editor]]'''
* '''[[Atmosphere Editor]]'''
* '''[[Texture Editor]]'''
|-
|}
| width="50%" valign="top" |
{| style="border: 1px solid #AAAAAA;" width="100%"
| style="border-bottom: 1px solid #AAAAAA;" |

=== Advanced Stuff ===
|-
|
* '''[[Batches]]'''
* '''[[Deployables]]'''
* '''[[Detail Groups]]'''
* '''[[Developer cheats]]'''
* '''[[List of Entities]]''' - Descriptions for all entities
* '''[[LOD Groups]]'''
* '''[[Locations]]'''
* '''[[Model Instancing]]'''
* '''[[Occlusion Tests]]'''
* '''[[Performance Optimizations]]'''
* '''[[Surface Tree]]'''
* '''[[Surface Types]]'''
* '''[[Terrain Editing]]'''
* '''[[Terrain Editor]]'''
* '''[[Vehicle Route Constraint System]]'''
|-
|}
|}

==Art==
{| width="100%"
| width="50%" valign="top" |
{| style="border: 1px solid #AAAAAA;" width="100%"
| style="border-bottom: 1px solid #AAAAAA;" |
=== Models ===
|-
|
* '''[[In-Game Models]]''' - Making models for use in the engine.
* '''[[Collision Meshes]]''' - Optimized models for in-game physics collision.
* '''[[High-Poly Models]]''' - Making source models for baking normal maps.
* '''[[Renderbump]]''' - Create normal maps from high-poly geometry.
* '''[[Imposters]]''' - Sprites used for rendering complex models cheaply at a distance.
|-
| style="border-bottom: 1px solid #AAAAAA;" |

=== Animation ===
|-
|
* '''[[MD5 Export Process]]''' - How to export an animated MD5.
* '''[[Vehicle Setup]]''' - How to set up a vehicle.
|-
| style="border-bottom: 1px solid #AAAAAA;" |
=== Textures ===
|-
|
* '''[[Basic Texture Overview]]''' - Supported texture types and implementations.
* '''[[Texturesheets]]''' - Overview of what texturesheets are, and when to use them.
* '''[[The Atlas Editor]]''' - Create environment texture sheets to improve performance.
* '''[[RenderBumpFlat]]''' - Create normal-maps from high-poly geometry.
* '''[[Detail Textures]]''' - Add high-frequency detail to your textures.
|-
|}
| width="50%" valign="top" |
{| style="border: 1px solid #AAAAAA;" width="100%"
| style="border-bottom: 1px solid #AAAAAA;" |
=== Terrain Editing ===
|-
|
* '''[[A Simple First Terrain]]''' - Simple steps to creating a terrain-based map.
* '''[[A Simple First Megatexture]]''' - Following on from the Simple First Terrain tutorial.
* '''[[Generate a MegaTexture]]''' - Render and compile your Megatexture.
* '''[[An Advanced Terrain and Megatexture]]''' - A detailed guide to making a realistic, natural terrain and Megatexture.
* '''[[Terrain Editor|EditWorld's Terrain Editor]]''' - Set up a Surface Tree for your Megatexture.
* '''[[Making a Terrain Model]]''' - All aspects of terrain mesh creation including Out-of-Bounds geometry.
* '''[[Water Surfaces#Water Models|Water Surfaces]]''' - Create water to go with your landscape.
* '''[[STUFF System]]''' - Procedurally distribute models over your terrain mesh.
|-
| style="border-bottom: 1px solid #AAAAAA;" |

=== Atmospheres and Effects ===
|-
|
* '''[[Atmosphere Editor|The Atmosphere Editor]]''' - Create and edit atmospheres for your map.
* '''[[Ambient Light Editor|The Ambient Light Editor]]''' - Create and edit ambient light setups.
* '''[[Environment Maps]]''' - Used for reflection effects.
* '''[[Water Surfaces]]''' - Creating water effects.
* '''[[Effects Editor|The Effects Editor]]''' - Create and edit particle effects.
* '''[[Cheap Decals]]''' - Bulletholes and other collision decals.
|-
|}
|}

== ETQW:TV ==

[[ETQW:TV]] documentation.

== Benchmarking ==

[[Benchmarking]] documentation.