Spring - User contributions [en]

Gamedev:Archives

2005-09-01T12:37:40Z

82.250.27.168:

The first step in understanding how Spring is put together is to understand
where the filetypes came from and how the files are organized, and what all the different files do. In Spring, there are several formats you can use, including relic supported TA formats and standards such as zlib and 7zip.

In Total Annihilation, all files were compressed with a format known as HAPI. Files of this format included .HPI, .UFO, .CCX, and .GP3. For all practical purposes, you can think of the HPI file like their own home-grown ZIP file, containing its own directory structure and groups of files. All HAPI files are compressed in the same way, the only difference is the extension used.

Spring also supports reading from zlib zip and non-solid 7zip files. The filenames for these compression types must be .SDZ for zlib and .SD7 for 7zip respectively. They are standard files, just with different extensions for Spring. Here's a list of all filetypes supported by Spring; a higher read order means the contents of a file of that extension will take priority over files of a lower read order.

An interesting twist is that map archivse can be placed into the /maps/ folder and contains another /maps/ folder inside the archive.

<table width="75%" border="1">
<tr>
<th width="5%" bgcolor="#C0C0C0"><h4>Read Order</h4></th>
<th width="10%" bgcolor="#C0C0C0"><h4>File Extension</h4></th>
<th width="10%" bgcolor="#C0C0C0"><h4>Compression Method</h4></th>
<th width="75%" bgcolor="#C0C0C0"><h4>Description</h4></th>
</tr>
<tr>
<td width="5%"><h4>1</h4></td>
<td width="10%" valign="top"><h4><b>SD7</b></h4></td>
<td width="10%"><h4>Non-Solid 7zip</h4></td>
<td width="75%" valign="top">A 7zip file with the extension changed to .SD7. These files have the same structure as an HAPI file, they are just compressed in a different manner. 7zip compressed archives generally have the highest compression (and therefore lowest filesizes). Files of this type are read first, so any filetypes encountered after .SD7 with the same data will take priority. For example, if you have ARMCOM.FBI in an SD7 file, and a modified version of ARMCOM.FBI in a CCX file, the CCX version will be used.</td>
</tr>
<tr>
<td width="5%"><h4>2</h4></td>
<td width="10%" valign="top"><h4><b>SDZ</b></h4></td>
<td width="10%"><h4>ZLIB ZIP</h4></td>
<td width="75%" valign="top">A zlib ZIP file with the extension changed to .SDZ. These files have the same structure as an HAPI file, they are just compressed in a different manner. Maps and mods alike can be stored in these files. These are read second.</td>
</tr>
<tr>
<td width="5%"><h4>3</h4></td>
<td width="10%" valign="top"><h4><b>HPI</b></h4></td>
<td width="10%"><h4>HAPI</h4></td>
<td width="75%" valign="top">One of the HAPI file format extensions. These are read third.</td>
</tr>
<tr>
<td width="5%"><h4>4</h4></td>
<td width="10%" valign="top"><h4><b>UFO</b></h4></td>
<td width="10%"><h4>HAPI</h4></td>
<td width="75%" valign="top">Another HAPI file extension. Fourth in line of being read.</td>
</tr>
<tr>
<td width="5%"><h4>5</h4></td>
<td width="10%" valign="top"><h4><b>CCX</b></h4></td>
<td width="10%"><h4>HAPI</h4></td>
<td width="75%" valign="top">Yet another HAPI file. These are fifth in the chain of being read.
</td>
</tr>
<tr>
<td width="5%"><h4>6</h4></td>
<td width="10%" valign="top"><h4><b>GP3</b></h4></td>
<td width="10%"><h4>HAPI</h4></td>
<td width="75%" valign="top">The sixth in the chain of files being read.</td>
</tr>
<tr>
<td width="5%"><h4>7</h4></td>
<td width="10%" valign="top"><h4><b>SWX</b></h4></td>
<td width="10%"><h4>HAPI</h4></td>
<td width="75%" valign="top">The seventh in the chain of command of files. This extension was originally used by the Star Wars Total Annihilation mod, but Spring doesn't care whether or not it's actually used for SWTA. It is an HAPI file.</td>
</tr>
<tr>
<td width="5%"><h4>8</h4></td>
<td width="10%" valign="top"><h4><b>GP4</b></h4></td>
<td width="10%"><h4>HAPI</h4></td>
<td width="75%" valign="top">The eighth filetype read. Any data in a .GP4 file will override any other compressed data in any other files. This is also an HAPI file.</td>
</tr>
</table>

The best tools to use to view the contents of a compressed Spring file, and
to pack and unpack the contents of such a file are:

*[http://fileuniverse.com/?page=showitem&ID=72 HPIView] to view, browse, and extract HAPI files.
*[http://fileuniverse.com/?page=showitem&ID=67 HPIPack] to pack HAPI files.
*[http://www.rarlabs.com WinRAR] to view, browse, extract, and pack SDZ files, or to browse SD7 files.
*[http://www.7-zip.org/ 7zip] to view, browse, extract, and pack SD7 files.

There are many other utilities that can also serve the same purpose. Peruse [http://www.fileuniverse.com FileUniverse] if for some reason the tools listed here don't suit you.

<table width="75%" border="1">
<tr>
<th width="174" colspan="2" bgcolor="#C0C0C0"><h4>Subdirectory</h4></th>
<th width="140" valign="top" bgcolor="#C0C0C0"><h4>File Types</h4></th>
<th width="442" bgcolor="#C0C0C0"><h4>Description</h4></th>
</tr>
<tr>
<td colspan="2" width="174" valign="top" bordercolor="#000000" bordercolorlight="#808080"><h4><strong>anims</strong></h4></td>
<td width="140" bordercolor="#000000" bordercolorlight="#808080" valign="top">
[[Mod_Development:Cursors]]
</td>
<td width="442" valign="top" bordercolor="#000000" bordercolorlight="#808080">Cursors</td>
</tr>
<tr>
<td colspan="2" width="174" valign="top" bordercolor="#000000" bordercolorlight="#808080"><h4><strong>download</strong></h4></td>
<td width="140" bordercolor="#000000" bordercolorlight="#808080" valign="top">
[[Units:Download_TDF]]
</td>
<td width="442" valign="top" bordercolor="#000000" bordercolorlight="#808080">Information to assign a unit to a location on a given build menu.</td>
</tr>
<tr>
<td colspan="2" width="174" valign="top" bordercolor="#000000" bordercolorlight="#808080"><h4><strong>features</strong></h4></td>
<td width="140" bordercolor="#000000" bordercolorlight="#808080" valign="top"></td>
<td width="442" valign="top" bordercolor="#000000" bordercolorlight="#808080">Contains information about miscellaneous features, such as corpses, trees, scars, etc., that may or may not be specific to particular maps or map types.  </td>
</tr>
<tr>
<td width="82" valign="top" bordercolor="#000000" bordercolorlight="#808080"><h4><strong>\</strong></h4></td>
<td width="86" valign="top" bordercolor="#000000" bordercolorlight="#808080"><h4><strong>corpses</strong></h4></td>
<td width="140" bordercolor="#000000" bordercolorlight="#808080" valign="top">
TDF
</td>
<td width="442" valign="top" bordercolor="#000000" bordercolorlight="#808080">Information about wreckage left behind when a unit dies.</td>
</tr>
<tr>
<td width="82" valign="top" bordercolor="#000000" bordercolorlight="#808080"><h4><strong>\</strong></h4></td>
<td width="86" valign="top" bordercolor="#000000" bordercolorlight="#808080"><h4><strong>allworlds</strong></h4></td>
<td width="140" bordercolor="#000000" bordercolorlight="#808080" valign="top">
TDF
</td>
<td width="442" valign="top" bordercolor="#000000" bordercolorlight="#808080">Information about features (such as trees, scars, etc.) for specific world maps.Other subdirectories may exist alongside "allworlds", such as "acid", "crystal", "green", etc.</td>
</tr>

<tr>
<td colspan="2" width="174" valign="top" bordercolor="#000000" bordercolorlight="#808080"><h4><strong>gamedata</strong></h4></td>
<td width="140" bordercolor="#000000" bordercolorlight="#808080" valign="top">
[[Mod_Development:Gamedata]]
</td>
<td width="442" valign="top" bordercolor="#000000" bordercolorlight="#808080">General information, such as sound assignments, can-build information, and other such data.</td>
</tr>
<tr>
<td colspan="2" width="174" valign="top" bordercolor="#000000" bordercolorlight="#808080"><h4><strong>guis</strong></h4></td>
<td width="140" bordercolor="#000000" bordercolorlight="#808080" valign="top">
GUI
</td>
<td width="442" valign="top" bordercolor="#000000" bordercolorlight="#808080">Alternative build tree definition method</td>
</tr>

<tr>
<td colspan="2" width="174" valign="top" bordercolor="#000000" bordercolorlight="#808080"><h4><strong>objects3d</strong></h4></td>
<td width="140" bordercolor="#000000" bordercolorlight="#808080" valign="top">
3DO
</td>
<td width="442" valign="top" bordercolor="#000000" bordercolorlight="#808080">3D object definitions for units, unit corpses.</td>
</tr>
<tr>
<td colspan="2" width="174" valign="top" rowspan="2" bordercolor="#000000" bordercolorlight="#808080"><h4><strong>maps</strong></h4></td>
<td width="140" bordercolor="#000000" bordercolorlight="#808080" valign="top">
SMD
</td>
<td width="442" valign="top" bordercolor="#000000" bordercolorlight="#808080">Schema, starting points, and other information pertaining to a particular map.</td>
</tr>
<tr>
<td width="140" bordercolor="#000000" bordercolorlight="#808080" valign="top">
SMF
</td>
<td width="442" valign="top" bordercolor="#000000" bordercolorlight="#808080">Map layout, heights, and features information.</td>
</tr>

<tr>
<td colspan="2" width="174" valign="top" rowspan="2" bordercolor="#000000" bordercolorlight="#808080"><h4><strong>scripts</strong></h4></td>
<td width="140" bordercolor="#000000" bordercolorlight="#808080" valign="top">
BOS
</td>
<td width="442" valign="top" bordercolor="#000000" bordercolorlight="#808080">Text description/subroutines that describe how a unit moves, animates, etc.</td>
</tr>
<tr>
<td width="140" bordercolor="#000000" bordercolorlight="#808080" valign="top">
COB
</td>
<td width="442" valign="top" bordercolor="#000000" bordercolorlight="#808080">A compiled version of the .BOS file.</td>
</tr>

<tr>
<td colspan="2" width="174" valign="top" bordercolor="#000000" bordercolorlight="#808080"><h4><strong>sounds</strong></h4></td>
<td width="140" bordercolor="#000000" bordercolorlight="#808080" valign="top">
WAV
</td>
<td width="442" valign="top" bordercolor="#000000" bordercolorlight="#808080">Sounds.</td>
</tr>

<tr>
<td colspan="2" width="174" valign="top" bordercolor="#000000" bordercolorlight="#808080"><h4><strong>unitpics</strong></h4></td>
<td width="140" bordercolor="#000000" bordercolorlight="#808080" valign="top">
[[Units:Buildpics]]
</td>
<td width="442" valign="top" bordercolor="#000000" bordercolorlight="#808080">"Large" (96x96) color pictures of units.</td>
</tr>

<tr>
<td colspan="2" width="174" valign="top" bordercolor="#000000" bordercolorlight="#808080"><h4><strong>unittextures</strong></h4></td>
<td width="140" bordercolor="#000000" bordercolorlight="#808080" valign="top">
 
</td>
<td width="442" valign="top" bordercolor="#000000" bordercolorlight="#808080"> </td>
</tr>
<tr>
<td width="82" valign="top" bordercolor="#000000" bordercolorlight="#808080"><h4><strong>\</strong></h4></td>
<td width="86" valign="top" bordercolor="#000000" bordercolorlight="#808080"><h4><strong>tatex</strong></h4></td>
<td width="140" bordercolor="#000000" bordercolorlight="#808080" valign="top">
[[Units:Textures]]
</td>
<td width="442" valign="top" bordercolor="#000000" bordercolorlight="#808080">Bitmap textures used on units (buildings, kbots, vehicles, etc.)</td>
</tr>

<tr>
<td colspan="2" width="174" valign="top" bordercolor="#000000" bordercolorlight="#808080"><h4><strong>units</strong></h4></td>
<td width="140" bordercolor="#000000" bordercolorlight="#808080" valign="top">
[[Units:FBI]]
</td>
<td width="442" valign="top" bordercolor="#000000" bordercolorlight="#808080">General properties of units.</td>
</tr>
<tr>
<td colspan="2" width="174" valign="top" bordercolor="#000000" bordercolorlight="#808080"><h4><strong>weapons</strong></h4></td>
<td width="140" bordercolor="#000000" bordercolorlight="#808080" valign="top">
TDF
</td>
<td width="442" valign="top" bordercolor="#000000" bordercolorlight="#808080">Contains the definiteion and properties of particular weapons that are used throughout the game.</td>
</tr>
</table>

3DModels:Textures

2005-09-01T12:32:01Z

82.250.27.168: /* Conversion from .gaf */

Textures are stored in the <b>UnitTextures\tatex</b> subdirectory. They may be Windows .BMP format at 24 bit color depth, or a Targa .TGA file in 32 bit (alpha layer) color depth.

==Rules for textures==
Spring only has support for 2048x2048 pixels worth of textures installed at any given time. However, the game sorts the textures on this sheet (which only exists while the game is loaded) very well, so if you follow a few simple rules the texture limit will be no problem:

*Keep textures limited to dimensions that are base-2 numbers, such as 8x8, 16x16, 32x32, or 64x64. They may also be oblong, 64x32 for example.
*Keep your textures as small as possible while still looking good. You can use a texture which is 256x256 pixels, for example, but a set of those would quickly eat up the available space.
*Don't make "shaded" textures like Cavedog did for Total Annihilation; let Spring handle the shading instead.

For Spring to read your textures, they must also be named properly. For example, if you use the texture "MetalTexture1" on your 3do file, the texture must be named "MetalTexture100.bmp".

==Logo Textures==
In the case of logo textures, you must edit the file <b>teamtex.txt</b> in the <b>UnitTextures/tatex</b> directory. It is easy to understand. Just add the name of your texture to the list, without the "00" as previously detailed. For example, if you wanted to add ArmLogo00.bmp to the team color list, you would put ArmLogo in the teamtex.txt file. As team colors are sequential, you must have a file for each different color. If you have ArmLogo00.bmp, there must also be an ArmLogo01.bmp, ArmLogo02.bmp, etc which match the colors of the other team textures available (it would look weird if the paint job was blue but the logo was red!).

==Reflections==
To make a texture reflect its environment, you must create a Targa file with an alpha layer with a program such as Photoshop. Targa textures follow the same rules above as bitmaps, however, Spring will display reflections on the texture in game if the user has that graphics option enabled and available to him. In the alpha layer itself, a darker shade will reflect less, whereas a lighter shade will reflect more.

==Conversion from .gaf==
In Total Annihilation textures were stored in /Textures/*.gaf. If you're porting an old TA mods, there will be hundreds of textures to convert to Spring format. There is an easy way to automatically extract all the texture from all the .gaf into well named .bmp : Download [http://www.planetannihilation.com/bsr/downloads/GAFDump.zip GAF Dump]. Then run GAFDump.exe, from inside the folder your textures are, and with the '''-b''' commandline option.

3DModels:Textures

2005-09-01T12:30:56Z

82.250.27.168: /* Conversion from .gaf */

Textures are stored in the <b>UnitTextures\tatex</b> subdirectory. They may be Windows .BMP format at 24 bit color depth, or a Targa .TGA file in 32 bit (alpha layer) color depth.

==Rules for textures==
Spring only has support for 2048x2048 pixels worth of textures installed at any given time. However, the game sorts the textures on this sheet (which only exists while the game is loaded) very well, so if you follow a few simple rules the texture limit will be no problem:

*Keep textures limited to dimensions that are base-2 numbers, such as 8x8, 16x16, 32x32, or 64x64. They may also be oblong, 64x32 for example.
*Keep your textures as small as possible while still looking good. You can use a texture which is 256x256 pixels, for example, but a set of those would quickly eat up the available space.
*Don't make "shaded" textures like Cavedog did for Total Annihilation; let Spring handle the shading instead.

For Spring to read your textures, they must also be named properly. For example, if you use the texture "MetalTexture1" on your 3do file, the texture must be named "MetalTexture100.bmp".

==Logo Textures==
In the case of logo textures, you must edit the file <b>teamtex.txt</b> in the <b>UnitTextures/tatex</b> directory. It is easy to understand. Just add the name of your texture to the list, without the "00" as previously detailed. For example, if you wanted to add ArmLogo00.bmp to the team color list, you would put ArmLogo in the teamtex.txt file. As team colors are sequential, you must have a file for each different color. If you have ArmLogo00.bmp, there must also be an ArmLogo01.bmp, ArmLogo02.bmp, etc which match the colors of the other team textures available (it would look weird if the paint job was blue but the logo was red!).

==Reflections==
To make a texture reflect its environment, you must create a Targa file with an alpha layer with a program such as Photoshop. Targa textures follow the same rules above as bitmaps, however, Spring will display reflections on the texture in game if the user has that graphics option enabled and available to him. In the alpha layer itself, a darker shade will reflect less, whereas a lighter shade will reflect more.

==Conversion from .gaf==
In Total Annihilation textures were stored in /Textures/*.gaf. There is an easy way to automatically extract all the texture from all the .gaf into well named .bmp : Download [http://www.planetannihilation.com/bsr/downloads/GAFDump.zip GAF Dump]. Then run GAFDump.exe, from inside the folder your textures are, and with the '''-b''' commandline option.

3DModels:Textures

2005-09-01T12:30:43Z

82.250.27.168: /* Conversion from .gaf */

Textures are stored in the <b>UnitTextures\tatex</b> subdirectory. They may be Windows .BMP format at 24 bit color depth, or a Targa .TGA file in 32 bit (alpha layer) color depth.

==Rules for textures==
Spring only has support for 2048x2048 pixels worth of textures installed at any given time. However, the game sorts the textures on this sheet (which only exists while the game is loaded) very well, so if you follow a few simple rules the texture limit will be no problem:

*Keep textures limited to dimensions that are base-2 numbers, such as 8x8, 16x16, 32x32, or 64x64. They may also be oblong, 64x32 for example.
*Keep your textures as small as possible while still looking good. You can use a texture which is 256x256 pixels, for example, but a set of those would quickly eat up the available space.
*Don't make "shaded" textures like Cavedog did for Total Annihilation; let Spring handle the shading instead.

For Spring to read your textures, they must also be named properly. For example, if you use the texture "MetalTexture1" on your 3do file, the texture must be named "MetalTexture100.bmp".

==Logo Textures==
In the case of logo textures, you must edit the file <b>teamtex.txt</b> in the <b>UnitTextures/tatex</b> directory. It is easy to understand. Just add the name of your texture to the list, without the "00" as previously detailed. For example, if you wanted to add ArmLogo00.bmp to the team color list, you would put ArmLogo in the teamtex.txt file. As team colors are sequential, you must have a file for each different color. If you have ArmLogo00.bmp, there must also be an ArmLogo01.bmp, ArmLogo02.bmp, etc which match the colors of the other team textures available (it would look weird if the paint job was blue but the logo was red!).

==Reflections==
To make a texture reflect its environment, you must create a Targa file with an alpha layer with a program such as Photoshop. Targa textures follow the same rules above as bitmaps, however, Spring will display reflections on the texture in game if the user has that graphics option enabled and available to him. In the alpha layer itself, a darker shade will reflect less, whereas a lighter shade will reflect more.

==Conversion from .gaf==
In Total Annihilation textures were stored in /Textures/*.gaf. There is an easy way to automatically extract all the texture from all the .gaf into well named .bmp : Download [http://www.planetannihilation.com/bsr/downloads/GAFDump.zip GAF Dump]. Then run GAFDump.exe, from inside the folder your textures are, and with the ''-b'' commandline option.

3DModels:Textures

2005-09-01T12:30:28Z

82.250.27.168: /* Conversion from .gaf */

Textures are stored in the <b>UnitTextures\tatex</b> subdirectory. They may be Windows .BMP format at 24 bit color depth, or a Targa .TGA file in 32 bit (alpha layer) color depth.

==Rules for textures==
Spring only has support for 2048x2048 pixels worth of textures installed at any given time. However, the game sorts the textures on this sheet (which only exists while the game is loaded) very well, so if you follow a few simple rules the texture limit will be no problem:

*Keep textures limited to dimensions that are base-2 numbers, such as 8x8, 16x16, 32x32, or 64x64. They may also be oblong, 64x32 for example.
*Keep your textures as small as possible while still looking good. You can use a texture which is 256x256 pixels, for example, but a set of those would quickly eat up the available space.
*Don't make "shaded" textures like Cavedog did for Total Annihilation; let Spring handle the shading instead.

For Spring to read your textures, they must also be named properly. For example, if you use the texture "MetalTexture1" on your 3do file, the texture must be named "MetalTexture100.bmp".

==Logo Textures==
In the case of logo textures, you must edit the file <b>teamtex.txt</b> in the <b>UnitTextures/tatex</b> directory. It is easy to understand. Just add the name of your texture to the list, without the "00" as previously detailed. For example, if you wanted to add ArmLogo00.bmp to the team color list, you would put ArmLogo in the teamtex.txt file. As team colors are sequential, you must have a file for each different color. If you have ArmLogo00.bmp, there must also be an ArmLogo01.bmp, ArmLogo02.bmp, etc which match the colors of the other team textures available (it would look weird if the paint job was blue but the logo was red!).

==Reflections==
To make a texture reflect its environment, you must create a Targa file with an alpha layer with a program such as Photoshop. Targa textures follow the same rules above as bitmaps, however, Spring will display reflections on the texture in game if the user has that graphics option enabled and available to him. In the alpha layer itself, a darker shade will reflect less, whereas a lighter shade will reflect more.

==Conversion from .gaf==
In Total Annihilation textures were stored in /Textures/*.gaf. There is an easy way to automatically extract all the texture from all the .gaf into well named .bmp : Download [http://www.planetannihilation.com/bsr/downloads/GAFDump.zip GAF Dump]. Then run GAFDump.exe, from inside the folder your textures are, and with the '-B' commandline option.

3DModels:Textures

2005-09-01T12:29:56Z

82.250.27.168:

Textures are stored in the <b>UnitTextures\tatex</b> subdirectory. They may be Windows .BMP format at 24 bit color depth, or a Targa .TGA file in 32 bit (alpha layer) color depth.

==Rules for textures==
Spring only has support for 2048x2048 pixels worth of textures installed at any given time. However, the game sorts the textures on this sheet (which only exists while the game is loaded) very well, so if you follow a few simple rules the texture limit will be no problem:

*Keep textures limited to dimensions that are base-2 numbers, such as 8x8, 16x16, 32x32, or 64x64. They may also be oblong, 64x32 for example.
*Keep your textures as small as possible while still looking good. You can use a texture which is 256x256 pixels, for example, but a set of those would quickly eat up the available space.
*Don't make "shaded" textures like Cavedog did for Total Annihilation; let Spring handle the shading instead.

For Spring to read your textures, they must also be named properly. For example, if you use the texture "MetalTexture1" on your 3do file, the texture must be named "MetalTexture100.bmp".

==Logo Textures==
In the case of logo textures, you must edit the file <b>teamtex.txt</b> in the <b>UnitTextures/tatex</b> directory. It is easy to understand. Just add the name of your texture to the list, without the "00" as previously detailed. For example, if you wanted to add ArmLogo00.bmp to the team color list, you would put ArmLogo in the teamtex.txt file. As team colors are sequential, you must have a file for each different color. If you have ArmLogo00.bmp, there must also be an ArmLogo01.bmp, ArmLogo02.bmp, etc which match the colors of the other team textures available (it would look weird if the paint job was blue but the logo was red!).

==Reflections==
To make a texture reflect its environment, you must create a Targa file with an alpha layer with a program such as Photoshop. Targa textures follow the same rules above as bitmaps, however, Spring will display reflections on the texture in game if the user has that graphics option enabled and available to him. In the alpha layer itself, a darker shade will reflect less, whereas a lighter shade will reflect more.

==Conversion from .gaf==
In Total Annihilation textures were stored in /Textures/*.gaf. There is an easy way to automatically extract all the texture from all the .gaf into well named .bmp : Download [http://www.planetannihilation.com/bsr/downloads/GAFDump.zip HPI Dump]. Then run GafDump.exe, from inside the folder your textures are, and with the '-B' commandline option.