Difference between revisions of "TxdGen"
Jump to navigation
Jump to search
m (added release information and some media.) |
(restructuring to fit other tools articles) |
||
| Line 1: | Line 1: | ||
| + | __NOTOC__ | ||
{{ToolBox | {{ToolBox | ||
| name = TxdGen | | name = TxdGen | ||
| Line 4: | Line 5: | ||
| patrol = no | | patrol = no | ||
| author = Martin Turski (The_GTA) | | author = Martin Turski (The_GTA) | ||
| + | | game = [[GTA III]], [[GTA VC]], [[GTA SA]] | ||
| genre = [[TXD|Texture Dictionary]] generator | | genre = [[TXD|Texture Dictionary]] generator | ||
| image = [[Image:Txdgen_overview.png|250px]] | | image = [[Image:Txdgen_overview.png|250px]] | ||
}} | }} | ||
'''TxdGen''' is the RenderWare [[texture dictionary]] conversion tool. It supports all PC formats, has full support for many PS2 titles and has partial support for the XBOX titles. It scans for TXD files in a source directory and converts them into a desired format into a target directory. | '''TxdGen''' is the RenderWare [[texture dictionary]] conversion tool. It supports all PC formats, has full support for many PS2 titles and has partial support for the XBOX titles. It scans for TXD files in a source directory and converts them into a desired format into a target directory. | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
==Features== | ==Features== | ||
| Line 25: | Line 21: | ||
* Automatic processing of IMG archives (version 1 '''and''' 2) | * Automatic processing of IMG archives (version 1 '''and''' 2) | ||
* '''DXTn''' compression! | * '''DXTn''' compression! | ||
| − | |||
| − | |||
| − | |||
==Media== | ==Media== | ||
| Line 33: | Line 26: | ||
* [https://www.youtube.com/watch?v=YoBace396fs Showing off 'SanAndreas Retextured 3' on PS2 hardware] | * [https://www.youtube.com/watch?v=YoBace396fs Showing off 'SanAndreas Retextured 3' on PS2 hardware] | ||
| − | ==Configuration== | + | ==Configuration settings== |
| − | The conversion parameters are specified in the '''txdgen.ini''' file. | + | The conversion parameters are specified in the '''txdgen.ini''' file. |
| + | *'''gameRoot:''' directory where the TXDs, that should be converted, are located (needs trailing slash!); make sure it exists | ||
| + | *'''outputRoot:''' directory where the new TXDs should be put into (needs trailing slash!) | ||
| + | *'''targetVersion:''' can be GTA3, VC or SA ('''self explanatory''') | ||
| + | *'''targetPlatform:''' can be PC, PS2 or (WIP) XBOX | ||
| + | *'''compressTextures:''' decides whether textures should be '''compressed''' if they are not already (to save memory and disk space) | ||
| + | *'''compressionQuality:''' floating point (0..1) that toggles the quality for compression/optimization (only effective if compressTextures=true) | ||
| + | *'''palRuntimeType:''' decides the technique that should be used for palettization/compression; can be '''NATIVE''' or '''PNGQUANT''' | ||
| + | *'''dxtRuntimeType:''' chooses between '''NATIVE''' or '''SQUISH''' S3TC compression algorithms | ||
| + | *'''warningLevel:''' integer that toggles the warning throughput of the TXD parser (the higher the more warnings) | ||
| + | *'''reconstructIMGArchives:''' boolean which decides whether IMG archives should be reconstructed in the target directory | ||
| + | *'''fixIncompatibleRasters:''' if this parameter is true then TxdGen attempts to change raster parameters to prevent game engine crashes | ||
| + | *'''dxtPackedDecompression:''' if true, then rwtools will pack decompressed DXT texels in a close approximate raster format to prefer small size over quality | ||
| + | |||
| + | An Example file: | ||
<source lang="ini"> | <source lang="ini"> | ||
[Main] | [Main] | ||
| Line 50: | Line 57: | ||
dxtPackedDecompression=false | dxtPackedDecompression=false | ||
</source> | </source> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
==Credits== | ==Credits== | ||
| Line 72: | Line 62: | ||
* Uses the '''libimagequant''' library (http://pngquant.org/lib/) | * Uses the '''libimagequant''' library (http://pngquant.org/lib/) | ||
* Uses the '''libsquish''' library (https://code.google.com/p/libsquish/) | * Uses the '''libsquish''' library (https://code.google.com/p/libsquish/) | ||
| − | * Thanks to | + | * Thanks to {{U|aru}} from '''GTAForums''' for XBOX swizzling and unswizzling algorithms (http://gtaforums.com/topic/213907-unswizzle-tool/) |
| − | * Some parts are inspired by research from | + | * Some parts are inspired by research from {{U|DK22Pac}} |
The licenses (if present) should be bundled with the tool. | The licenses (if present) should be bundled with the tool. | ||
| − | == | + | ==See also== |
| − | + | * [[TxdGen/Converting_Textures_to_PS2_Format|Converting Textures to PS2 Format]] | |
| + | |||
| + | ==External links== | ||
| + | * {{GTAG|26916}} | ||
| + | * {{GTAF|764498}} | ||
| + | * [https://www.assembla.com/code/green-candy/subversion/nodes/547/trunk/ps2%20export%20tool the MTA:Eir repository] - source code | ||
{{N|SA|VC|3}} | {{N|SA|VC|3}} | ||
Revision as of 21:39, 29 January 2015
 | |
| Current version: | 0.8 |
|---|---|
| Developed by: | Martin Turski (The_GTA) |
| Supported games: | GTA III, GTA VC, GTA SA |
| Type: | Texture Dictionary generator |
TxdGen is the RenderWare texture dictionary conversion tool. It supports all PC formats, has full support for many PS2 titles and has partial support for the XBOX titles. It scans for TXD files in a source directory and converts them into a desired format into a target directory.
Features
- Supports all PC TXD formats
- Supports all known raster formats (RGBA, RGB, DXTn, 1555, 565, 4444, etc)
- Outputs TXD in actually working PS2, PC and XBOX format
- Lossless conversion between formats!
- User-friendly configuration file!
- Texture compression on demand!
- Debug output on common errors
- Automatic processing of IMG archives (version 1 and 2)
- DXTn compression!
Media
- Video tutorial on how to generate PS2 textures
- Showing off 'SanAndreas Retextured 3' on PS2 hardware
Configuration settings
The conversion parameters are specified in the txdgen.ini file.
- gameRoot: directory where the TXDs, that should be converted, are located (needs trailing slash!); make sure it exists
- outputRoot: directory where the new TXDs should be put into (needs trailing slash!)
- targetVersion: can be GTA3, VC or SA (self explanatory)
- targetPlatform: can be PC, PS2 or (WIP) XBOX
- compressTextures: decides whether textures should be compressed if they are not already (to save memory and disk space)
- compressionQuality: floating point (0..1) that toggles the quality for compression/optimization (only effective if compressTextures=true)
- palRuntimeType: decides the technique that should be used for palettization/compression; can be NATIVE or PNGQUANT
- dxtRuntimeType: chooses between NATIVE or SQUISH S3TC compression algorithms
- warningLevel: integer that toggles the warning throughput of the TXD parser (the higher the more warnings)
- reconstructIMGArchives: boolean which decides whether IMG archives should be reconstructed in the target directory
- fixIncompatibleRasters: if this parameter is true then TxdGen attempts to change raster parameters to prevent game engine crashes
- dxtPackedDecompression: if true, then rwtools will pack decompressed DXT texels in a close approximate raster format to prefer small size over quality
An Example file:
[Main]
gameRoot=C:/Program Files (x86)/Rockstar Games/GTA San Andreas/
outputRoot=txdgen_out/
targetVersion=SA
targetPlatform=PS2
compressTextures=true
compressionQuality=0.5
palRuntimeType=PNGQUANT
dxtRuntimeType=SQUISH
warningLevel=1
reconstructIMGArchives=true
fixIncompatibleRasters=true
dxtPackedDecompression=falseCredits
- Uses a fork of rwtools by aap (https://github.com/aap/rwtools)
- Uses the libimagequant library (http://pngquant.org/lib/)
- Uses the libsquish library (https://code.google.com/p/libsquish/)
- Thanks to aru from GTAForums for XBOX swizzling and unswizzling algorithms (http://gtaforums.com/topic/213907-unswizzle-tool/)
- Some parts are inspired by research from DK22Pac
The licenses (if present) should be bundled with the tool.
See also
External links
GTAGarage download- GTAForums topic
- the MTA:Eir repository - source code
