Warhammer 40,000: Dawn of War™
RDN MOD Tools v. 1.11/Patch 1.3
Ian Cox (THQ QA)
Raphael van Lierop (Relic)
George Hornmoen (Relic)
In support of our efforts to develop Winter Assault, we have adopted a new attribute file format. The data for this new file format was included in the Patch 1.3 release, and therefore all MODs developed using previous data sets (1.0 – 1.2) were instantly ‘broken’ by this.
To support the MOD community, we have prepared a simple command-line utility which carries out the conversion process. Because of this script, the amount of manual work required to convert your MOD to 1.3 data is minimized, but as every MOD is different your particular experience may vary from what is described below.
This document outlines the process of converting your MOD from 1.2 data to 1.3 data. Please refer to the closing section entitled ‘Modding Links’, for more information about modding Warhammer 40,000: Dawn of War.
To install Dawn of War Patch 1.3, simply:
Alternatively, you can find Patch 1.3 from various download sites, including www.fileplanet.com, www.fileshack.com, etc.
For Troubleshooting help with installing Patch 1.3, refer to the following forums:
Make a back up copy of your MOD’s attribute data. This way if you make any undesirable changes you can always revert to this backup copy.
In Dawn of War versions 1.0 to 1.2, the game loaded LUA files directly. With version 1.3 the game now loads binary data files that are created with the Attribute Editor (version 1.1). In order for the Attribute Editor to load your LUA files, you must place them in the proper folder.
Assuming you have installed Dawn of War in the default location of:
C:\Program Files\THQ\Dawn of War
…you will need to move the entire C:\Program Files\THQ\Dawn of War\<your_mod>\Data\Attrib folder to:
C:\Program Files\THQ\Dawn of War\Mod Tools\Data Generic\<your_mod>\Attrib
The Conversion Utility will go through all the files in your MOD and automatically make most of the changes necessary. Note that it might take the utility some time to go through all the attribute data and make the conversion from 1.2 to 1.3 data.
When the utility has completed the conversion work, you should see a short summary of how many changes were made.
Note: You MUST run the utility from the installed folder, otherwise the utility will not find the support files it needs. Also, make sure you have read/write access to the data you want to convert.
The syntax for the utility is:
update13 “c:/program files/thq/dawnofwar/modtools/datageneric/mymod/attrib” “c:/program files/thq/dawn of war/modtools/datageneric/w40k/attrib”
Note: It is important to include the space between the two attribute paths (i.e. between the quotation marks in the above example).
In a few cases, the utility may not be able to convert certain files, and will provide a listing of ‘problem files’.
For any of the files that are listed as such, open them in a text editor (Notepad works well), and edit the Inherit and Inherit Meta lines so that they follow the new relative paths.
As opposed to:
The utility can and should be run more than once on the same set of data. If you run the utility on your MOD, then fix some errors, you should run the utility again to make sure everything has been converted properly and that you have not introduced any new errors.
With the conversion process complete, you are now ready to open your MOD project in the Attribute Editor.
To open your MOD project in the Attribute Editor:
The Attribute Editor will load all the files from your MOD, which may take a while. After this is completed, the attribute editor will pop up a list of the files that failed to load.
Changes to the Dawn of War data will almost certainly introduce issues in the converted data, which will prevent files from loading properly.
To find out which files are causing problems:
You may have to go through a couple rounds of fixing before everything loads correctly.
If files fail to load, this is probably indicative of issues with improperly defined file inheritance.
To fix file inheritance issues:
weapon.nil has a reference to a requirements table in 1.2, but not in 1.3. Any weapons that try and set requirements without first referencing a requirements table are going to fail in 1.3.
You may find that your MOD files load correctly, but a number of original Dawn of Wars files now fail. This is because you have overloaded a file that the Dawn of War data inherits from, and that file has changed in version 1.3 (for example weapon.nil). This will most likely happen if you have included files that you don't necessarily need to.
To fix these issues you can either remove any unmodified files you have included in your MOD, or replace the file with the new version found under Mod Tools\Data Generic\W40k\Attrib\.
To save the binary files:
Note: You will be asked if you want to sync files to Perforce. This is a development message, so ignore it.
You should now have updated binary files.
The Conversion Utility should make all the necessary data changes, but there are some other things that have changed in the 1.3 version.
Any _local files that come along with Win Conditions will need the exclusive flag added to them and the always_on flag removed. Note that these files should only be included in your MOD if they actually modify the stock win conditions.
The taskbar.lua file has changed considerably to support Observer Mode, and so any hotkeys or other taskbar changes are going to have to be made to the new file.
Also note that tooltip_desc has been removed and it has been replaced with three separate variables.
The format for the module file has changed – please take a peek at the sample my_mod.module for fields that have been added.
Now that the conversion from 1.2 to 1.3 data is complete, you should now try to load your MOD in Dawn of War.
To load your converted MOD in Dawn of War:
If you have completed the conversion steps using the Attribute Editor, but your MOD still failed at loading, this likely indicates you have data that is syntactically correct, but still invalid.
To troubleshoot MOD loading issues:
Note: The most likely problem will be files that try to load abilities/research/squads that don't actually exist.
Relic Developer Network
http://www.relic.com/rdn/index.php (registration required)
Adeptus Modificatus – Official Dawn of War Modding Forums