Mod Wiki - User contributions [en-gb]

ETQW:TV

2007-12-19T12:40:24Z

Digibob:

==An Overview: What is ETQW:TV?==

ETQW:TV is primarily aimed at competition gaming, where large audiences might want to watch high-profile matches without having to set up bandwidth-intensive and fixed-perspective video streaming.

ETQW:TV essentially allows a server to host extra spectator slots, but without having any performance impact on the main server. This is achieved by running a so-called repeater that then streams data to spectator clients connected to it. You can also set up relay servers that increase the number of spectators that can watch a match. By stringing several relays together, ETQW:TV can be used to broadcast matches to hundreds of spectators, who can all follow the match as if they were on the main server.

ETQW:TV also allows the feed operator to set up a deliberate broadcasting delay to prevent spectators from relaying information back to the players.

==Getting Started==

To spectate a server using ETQW:TV, the server must be running a repeater itself. If this is your own server, this is simply a matter of setting the cvar "net_spawnRepeater" to "1" before starting up the server.

Running a repeater relay server is equally simple: Just set the cvar "net_spawnRepeater" to "1", and then type "connect <server>" on the server console, where <server> is the main server you are wanting to broadcast via the relay. Please note that the main server must be running a repeater, as repeater relays can only be connected to other repeaters. If the server you are trying to connect the relay to is not running a repeater, you will get a warning on the relay's console.

Repeater servers spawn by default on port 27833. If that port is unavailable, the game will try to use the next 3 consecutive ports. You can also specify a port to use by setting the "net_repeaterPort" cvar.

The repeater on the main server is primarily designed for connecting relays to, as it does not support delaying broadcasts, and will not report itself to the Demonware master for inclusion in the server browser. You must run a repeater relay if you wish to have a server show up in the internet TV list in the server browser.

Read the next two sections to configure the repeater's client controls.

==Client Management==

Repeater and relay servers may host any number of clients, as long as you have sufficient hardware to support it.

To control the maximum number of clients that may connect to the server, you can set the "ri_maxViewers" cvar to whatever number of clients you wish to allow. This cvar can be modified whilst the server is running to allow more or less viewers. There is no limit on this cvar, but it is not recommended to set it to values greater than 256.

==Passwords==

There are three different passwords that can be set up on your repeater to control access to it. This applies to both the main repeater, and repeater relays.

In all cases, connecting clients or relays must set the "password" cvar to the value of the appropriate password.

===g_viewerPassword===
This will stop viewer clients from connecting to the server unless they provide the appropriate password, and will not affect repeater relays connecting to the server. To enable this, simply set "g_viewerPassword" to your desired password and set "ri_useViewerPass"to "1".

===g_repeaterPassword===
This will prevent repeater relays from connecting to the server unless they provide the appropriate password and will not affect viewer clients connecting to the server. Setting the password works the same as for g_viewerPassword. No additional cvars need to be set to enable this password.

===g_privateViewerPassword===
This can be used to allow clients or relays access even if the viewer limit has been reached. To control the regular viewer limit count, you can adjust "ri_maxViewers", and "ri_privateViewers". The server will be considered full for connecting clients and relays when ( max - private ) slots are in use. Clients and relays connecting to the server with the private password will consider it full if ( max ) slots are in use.

An example:

A server has "ri_maxViewers" set to 24, and "ri_privateViewers" set to 16. In this case, once there are ( max ( 24 ) - private ( 16 ) ) = 8 slots in use, clients or relays connecting without the private password will see the server as being full, while clients and relays with the private password will be able to connect until all 24 slots are taken up.

==Communication==

Clients on a repeater may talk to other clients connected to the same repeater, but not to those on the main server, nor those on any other repeater in the chain, though they will be able to see global chat from the main server. Each viewer client's text will show their viewer index after their name, which can be used to kick abusive clients.

You can disable clients being able to talk on the repeater by setting "g_noTVChat" to 1.

==Admining==

You may list all clients on the repeater from the server console, or via rcon by using the "listRepeaterClients" command. This will display their index and ip, and name if they are a client.

Clients may be kicked from the repeater either from the server console or via rcon by using the "kickRepeaterClient" command along with the index of the client to remove.

==Delayed playback==

You can enable delayed playback on repeater relays by setting the "net_clientRepeaterDelay" cvar. This value is the number of minutes to store data for before passing it on. This value must be set before the relay is connected to a server, and only applies to relays - it will have no effect on the main repeater server. Fractional values are allowed, so you may use 0.5 for 30 seconds.

In this mode, the server needs to store enough data for the playback period, so clients connecting to the server whilst it is gathering data will see the loading screen until this is finished. This also means that the server will use additional memory to store this data, so this should be taken into consideration when choosing how much of a delay you want to apply.

==Bandwidth==

The bandwidth requirements for a viewer client connected to a repeater are similar to those of a player connected to a normal server. By default, clients connected to a repeater will be sent snapshots every 3 frames, which is the same as regular clients. This can be adjusted by changing the "net_repeaterSnapshotDelay" cvar.

A relay connected to a repeater requires a much greater amount of bandwidth, mainly because repeaters need to be sent data about all entities and all players in order to be able to forward this data on to other viewers connected to them. In addition, repeaters are sent snapshots every frame by default, instead of every 3 frames. This can be adjusted by changing the "net_repeaterRelaySnapshotDelay" cvar. Repeaters also have a higher default rate limit as a result of this, controlled by the "net_serverMaxRepeaterRate" cvar.

==Client controls==

As a client, you can spectate players on the server by double clicking their name in the Limbo Menu's player list. You can also cycle through all clients on the main server (including spectators) by pressing your attack key (left mouse button by default), and you can switch to free camera mode by pressing your alt attack key (right mouse button by default).

The speed of the camera can be controlled by changing the "pm_demoCamSpeed" cvar. You can also choose to spectate a specific client index or name by using the "setSpectateClient" console command.

==VoIP==

There is currently no support for VoIP over repeaters.

==Mods & Maps==

The repeater can be set up to auto-download additional content by setting the "net_clientRepeaterAutoDownload" cvar to "1".

Enemy Territory: QUAKE Wars

2007-12-19T12:38:39Z

Digibob:

__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.

Packaging up a Map or Mod

2007-12-14T12:57:08Z

Digibob: /* Pak Files Overview */

== Version 1.2 v. 1.4 ==

Patch 1.2 does not support all the required features to get simple map or campaign mods running, nor does it provide the ability to download content from the server. Both of these issues will both be fixed in version 1.4. As a workaround for now, you can treat these simple mods as full mods as described below.

When running with text based declarations, you must set the "com_useBinaryDecls" cvar to 2, which will allow text declarations to override binary declarations. This will be the default setting in 1.4.

== Pak File Configs ==

=== Addon Configs ===

An addon config contains meta data used to detail which maps/campaigns are held within a pk4 without the need for the engine to load any assets from the pk4.

Here is an example:

addonDef {
0x12345678
}

mapMetaData maps/volcano {
"pretty_name" "Volcano"
"mapinfo" "volcano"
"dz_deployInfo" "volcano"
"climate_skins" "climate_skins_volcano"
"server_shot_thumb" "levelshots/thumbs/volcano.tga"
"show_in_browser" "1"
}

The file must start with the "addonDef" identifier, and then a set of braces containing a list of dependencies. This list is the checksums of any other pak files which this pak file requires to also be loaded. The list may simply be empty if the pak file is entirely stand-alone.

After this you may provide any meta data required by the game you are running. The base ETQW game will load "mapMetaData" and "campaignMetaData" blocks, but you may provide any kind of meta data and it will be loaded regardless of whether the game understands how to use the data or not.

The above example specifies that this pak file contains a map stored as "maps/volcano".

To get the checksum for a pak file, use the "path" command, this will list all loaded pak files and their checksums.

=== Pakmeta Configs ===

Pakmeta configs are named pakmeta.conf. They are similar in structure to addon configs, but they do not contain the addonDef section at the top of the file, only the meta data blocks.

When using the SDK exe you may also provide a pakmeta config in the root of your mod folder. This lets you provide additional data without having to include that of the base game.

Only one pakmeta config at a time will be loaded from within pak files, the pak file with the highest priority which contains a pakmeta config, will be used.

=== Binary Configs ===

When packaging up binaries (game code/compiled script), you need to include a binary.conf file in the pak file. This file should contain a single number, which represents which OS the binaries are being supplied for. The currently supported numbers are 0 for Windows, and 2 for Linux.

== Pak File Priority ==

Pak files are sorted in alphabetical order within their own directory. The following is the list of directories which will be searched, from lowest priority to highest priority.

<fs_cdpath>\base
<fs_cdpath>\<fs_game_base>
<fs_cdpath>\<fs_game>
<fs_basepath>\base
<fs_basepath>\<fs_game_base>
<fs_basepath>\<fs_game>
<fs_devpath>\base
<fs_devpath>\<fs_game_base>
<fs_devpath>\<fs_game>
<fs_savepath>\base
<fs_savepath>\<fs_game_base>
<fs_savepath>\<fs_game>
<fs_userpath>\base
<fs_userpath>\<fs_game_base>
<fs_userpath>\<fs_game>

All of the values in <> are cvar names, which if blank will not be used.

== Pak Files Overview ==

Pak files are simply zip archives with a .pk4 extension.

There are basically 4 types of pak files you may use.

=== Official Pak Files ===

These are named starting with "pak". they will always be loaded in the pure system, unless they *only* contain files which are excluded from pure requirements. A list of pure exceptions is listed below. Official pak files can never be downloaded from a server.

=== Addon Pak Files ===

These are pak files which aren't named starting with "pak", and contain a addon config within them. These files will never be included automatically for pure, but only when the game decides it needs them, and are generally used for custom maps and campaigns. The meta data from these pak files will always be loaded however, so the gamecode knows what is contained within them. Addon pak files may be downloaded from servers.

=== Binary Pak Files ===

These should contain any and all binaries you need to load for your mod, for a specific OS, as well as containing a matching binary config. These pak files may be downloaded from the server, and will warn the user that they are downloading executable code. Again, their name should not begin with "pak".

=== Additional Pak Files ===

These are any paks file not covered by the previous cases. These will be included in the pure system if and only if, the server loads any files which are not covered by pure exclusions during engine startup (or during first map load, but that is riskier, so is not recommend).The easiest way to get this to happen is to include a declaration file which is not on the pure exclusion list. This file can be empty.

== Pure Mode Exclusions ==

The following is a list of directories and extensions for files which will not mark a pak file as being required for pure if they are loaded.

{| style="border: 1px solid #AAAAAA;"
|-
! Path
! Extension
|-
| localization
| .lang
|-
| localization
| .ogg
|-
| generated/ogg/localization
| .ogg
|-
| localization
| .wav
|-
| localization
| .font
|-
| localization
| .cfg
|}

== Mods ==

=== Addon Mod: A New Map ===

In the case of simply adding a new map to an existing game, all you need to do is add everything to an Addon pak file.

=== Addon Mod: A New Campaign ===

This is very similar to adding a new map. First you must again add all the required media to an Addon pak file. If this is purely a campaign using existing maps, then this will likely just be a single campaign .def file. If it is a campaign using base game maps, then you can simply supply the meta data for the new campaign and you are done. If the campaign includes custom maps, then you must make sure to include the checksums for the pak files which contain those maps in the dependencies section.

=== Full Mods ===

If you want your content to always be loaded, then you should run with the "fs_game" cvar set to the mod name, and include all of the pak files in this directory.

All binaries for the mod should be packaged up in Binary pak files, one for each OS, as described above.

All required content should be pakaged up in either Official or Additional pak files, one of which should contain a Pakmeta config if you wish to override the one from the base game.

Any optional maps should be included in Addon pak files.

Packaging up a Map or Mod

2007-12-14T12:54:50Z

Digibob:

== Version 1.2 v. 1.4 ==

Patch 1.2 does not support all the required features to get simple map or campaign mods running, nor does it provide the ability to download content from the server. Both of these issues will both be fixed in version 1.4. As a workaround for now, you can treat these simple mods as full mods as described below.

When running with text based declarations, you must set the "com_useBinaryDecls" cvar to 2, which will allow text declarations to override binary declarations. This will be the default setting in 1.4.

== Pak File Configs ==

=== Addon Configs ===

An addon config contains meta data used to detail which maps/campaigns are held within a pk4 without the need for the engine to load any assets from the pk4.

Here is an example:

addonDef {
0x12345678
}

mapMetaData maps/volcano {
"pretty_name" "Volcano"
"mapinfo" "volcano"
"dz_deployInfo" "volcano"
"climate_skins" "climate_skins_volcano"
"server_shot_thumb" "levelshots/thumbs/volcano.tga"
"show_in_browser" "1"
}

The file must start with the "addonDef" identifier, and then a set of braces containing a list of dependencies. This list is the checksums of any other pak files which this pak file requires to also be loaded. The list may simply be empty if the pak file is entirely stand-alone.

After this you may provide any meta data required by the game you are running. The base ETQW game will load "mapMetaData" and "campaignMetaData" blocks, but you may provide any kind of meta data and it will be loaded regardless of whether the game understands how to use the data or not.

The above example specifies that this pak file contains a map stored as "maps/volcano".

To get the checksum for a pak file, use the "path" command, this will list all loaded pak files and their checksums.

=== Pakmeta Configs ===

Pakmeta configs are named pakmeta.conf. They are similar in structure to addon configs, but they do not contain the addonDef section at the top of the file, only the meta data blocks.

When using the SDK exe you may also provide a pakmeta config in the root of your mod folder. This lets you provide additional data without having to include that of the base game.

Only one pakmeta config at a time will be loaded from within pak files, the pak file with the highest priority which contains a pakmeta config, will be used.

=== Binary Configs ===

When packaging up binaries (game code/compiled script), you need to include a binary.conf file in the pak file. This file should contain a single number, which represents which OS the binaries are being supplied for. The currently supported numbers are 0 for Windows, and 2 for Linux.

== Pak File Priority ==

Pak files are sorted in alphabetical order within their own directory. The following is the list of directories which will be searched, from lowest priority to highest priority.

<fs_cdpath>\base
<fs_cdpath>\<fs_game_base>
<fs_cdpath>\<fs_game>
<fs_basepath>\base
<fs_basepath>\<fs_game_base>
<fs_basepath>\<fs_game>
<fs_devpath>\base
<fs_devpath>\<fs_game_base>
<fs_devpath>\<fs_game>
<fs_savepath>\base
<fs_savepath>\<fs_game_base>
<fs_savepath>\<fs_game>
<fs_userpath>\base
<fs_userpath>\<fs_game_base>
<fs_userpath>\<fs_game>

All of the values in <> are cvar names, which if blank will not be used.

== Pak Files Overview ==

Pak files are simply zip archives with a .pk4 extension.

There are basically 4 types of pak files you may use.

The first is Official pak files, these are named starting with "pak". they will always be loaded in the pure system, unless they *only* contain files which are excluded from pure requirements. A list of pure exceptions is listed below. Official pak files can never be downloaded from a server.

The second is Addon pak files. These are pak files which aren't named starting with "pak", and contain a addon config within them. These files will never be included automatically for pure, but only when the game decides it needs them, and are generally used for custom maps and campaigns. The meta data from these pak files will always be loaded however, so the gamecode knows what is contained within them. Addon pak files may be downloaded from servers.

The third is Binary pak files. These should contain any and all binaries you need to load for your mod, for a specific OS, as well as containing a matching binary config. These pak files may be downloaded from the server, and will warn the user that they are downloading executable code. Again, their name should not begin with "pak".

The last form of pak file is any not covered by the previous cases, and shall be refered to as Additional pak files. These will be included in the pure system if and only if, the server loads any files which are not covered by pure exclusions during engine startup (or during first map load, but that is riskier, so is not recommend).The easiest way to get this to happen is to include a declaration file which is not on the pure exclusion list. This file can be empty.

== Pure Mode Exclusions ==

The following is a list of directories and extensions for files which will not mark a pak file as being required for pure if they are loaded.

{| style="border: 1px solid #AAAAAA;"
|-
! Path
! Extension
|-
| localization
| .lang
|-
| localization
| .ogg
|-
| generated/ogg/localization
| .ogg
|-
| localization
| .wav
|-
| localization
| .font
|-
| localization
| .cfg
|}

== Mods ==

=== Addon Mod: A New Map ===

In the case of simply adding a new map to an existing game, all you need to do is add everything to an Addon pak file.

=== Addon Mod: A New Campaign ===

This is very similar to adding a new map. First you must again add all the required media to an Addon pak file. If this is purely a campaign using existing maps, then this will likely just be a single campaign .def file. If it is a campaign using base game maps, then you can simply supply the meta data for the new campaign and you are done. If the campaign includes custom maps, then you must make sure to include the checksums for the pak files which contain those maps in the dependencies section.

=== Full Mods ===

If you want your content to always be loaded, then you should run with the "fs_game" cvar set to the mod name, and include all of the pak files in this directory.

All binaries for the mod should be packaged up in Binary pak files, one for each OS, as described above.

All required content should be pakaged up in either Official or Additional pak files, one of which should contain a Pakmeta config if you wish to override the one from the base game.

Any optional maps should be included in Addon pak files.

Packaging up a Map or Mod

2007-12-14T12:52:03Z

Digibob:

== Version 1.2 v. 1.4 ==

Patch 1.2 does not support all the required features to get simple map or campaign mods running, nor does it provide the ability to download content from the server. Both of these issues will both be fixed in version 1.4. As a workaround for now, you can treat these simple mods as full mods as described below.

When running with text based declarations, you must set the "com_useBinaryDecls" cvar to 2, which will allow text declarations to override binary declarations. This will be the default setting in 1.4.

== Pak File Configs ==

=== Addon Configs ===

An addon config contains meta data used to detail which maps/campaigns are held within a pk4 without the need for the engine to load any assets from the pk4.

Here is an example:

addonDef {
0x12345678
}

mapMetaData maps/volcano {
"pretty_name" "Volcano"
"mapinfo" "volcano"
"dz_deployInfo" "volcano"
"climate_skins" "climate_skins_volcano"
"server_shot_thumb" "levelshots/thumbs/volcano.tga"
"show_in_browser" "1"
}

The file must start with the "addonDef" identifier, and then a set of braces containing a list of dependencies. This list is the checksums of any other pak files which this pak file requires to also be loaded. The list may simply be empty if the pak file is entirely stand-alone.

After this you may provide any meta data required by the game you are running. The base ETQW game will load "mapMetaData" and "campaignMetaData" blocks, but you may provide any kind of meta data and it will be loaded regardless of whether the game understands how to use the data or not.

The above example specifies that this pak file contains a map stored as "maps/volcano".

To get the checksum for a pak file, use the "path" command, this will list all loaded pak files and their checksums.

=== Pakmeta Configs ===

Pakmeta configs are named pakmeta.conf. They are similar in structure to addon configs, but they do not contain the addonDef section at the top of the file, only the meta data blocks.

When using the SDK exe you may also provide a pakmeta config in the root of your mod folder. This lets you provide additional data without having to include that of the base game.

Only one pakmeta config at a time will be loaded from within pak files, the pak file with the highest priority which contains a pakmeta config, will be used.

=== Binary Configs ===

When packaging up binaries (game code/compiled script), you need to include a binary.conf file in the pak file. This file should contain a single number, which represents which OS the binaries are being supplied for. The currently supported numbers are 0 for Windows, and 2 for Linux.

== Pak File Priority ==

Pak files are sorted in alphabetical order within their own directory. The following is the list of directories which will be searched, from lowest priority to highest priority.

<fs_cdpath>\base
<fs_cdpath>\<fs_game_base>
<fs_cdpath>\<fs_game>
<fs_basepath>\base
<fs_basepath>\<fs_game_base>
<fs_basepath>\<fs_game>
<fs_devpath>\base
<fs_devpath>\<fs_game_base>
<fs_devpath>\<fs_game>
<fs_savepath>\base
<fs_savepath>\<fs_game_base>
<fs_savepath>\<fs_game>
<fs_userpath>\base
<fs_userpath>\<fs_game_base>
<fs_userpath>\<fs_game>

All of the values in <> are cvar names, which if blank will not be used.

== Pak Files Overview ==

Pak files are simply zip archives with a .pk4 extension.

There are basically 4 types of pak files you may use.

The first is Official pak files, these are named starting with "pak". they will always be loaded in the pure system, unless they *only* contain files which are excluded from pure requirements. A list of pure exceptions is listed below. Official pak files can never be downloaded from a server.

The second is Addon pak files. These are pak files which aren't named starting with "pak", and contain a addon config within them. These files will never be included automatically for pure, but only when the game decides it needs them, and are generally used for custom maps and campaigns. The meta data from these pak files will always be loaded however, so the gamecode knows what is contained within them. Addon pak files may be downloaded from servers.

The third is Binary pak files. These should contain any and all binaries you need to load for your mod, for a specific OS, as well as containing a matching binary config. These pak files may be downloaded from the server, and will warn the user that they are downloading executable code. Again, their name should not begin with "pak".

The last form of pak file is any not covered by the previous cases, and shall be refered to as Additional pak files. These will be included in the pure system if and only if, the server loads any files which are not covered by pure exclusions during engine startup (or during first map load, but that is riskier, so is not recommend).The easiest way to get this to happen is to include a declaration file which is not on the pure exclusion list. This file can be empty.

== Pure Mode Exclusions ==

The following is a list of directories and extensions for files which will not mark a pak file as being required for pure if they are loaded.

|
|-
! Path
! Extension
|-
| localization
| .lang
|-
| localization
| .ogg
|-
| generated/ogg/localization
| .ogg
|-
| localization
| .wav
|-
| localization
| .font
|-
| localization
| .cfg
|

== Mods ==

=== Addon Mod: A New Map ===

In the case of simply adding a new map to an existing game, all you need to do is add everything to an Addon pak file.

=== Addon Mod: A New Campaign ===

This is very similar to adding a new map. First you must again add all the required media to an Addon pak file. If this is purely a campaign using existing maps, then this will likely just be a single campaign .def file. If it is a campaign using base game maps, then you can simply supply the meta data for the new campaign and you are done. If the campaign includes custom maps, then you must make sure to include the checksums for the pak files which contain those maps in the dependencies section.

=== Full Mods ===

If you want your content to always be loaded, then you should run with the "fs_game" cvar set to the mod name, and include all of the pak files in this directory.

All binaries for the mod should be packaged up in Binary pak files, one for each OS, as described above.

All required content should be pakaged up in either Official or Additional pak files, one of which should contain a Pakmeta config if you wish to override the one from the base game.

Any optional maps should be included in Addon pak files.

Enemy Territory: QUAKE Wars

2007-12-14T12:31:05Z

Digibob: /* Basics */