Difference between revisions of "Compiling 2DAs"

From Dragon Age Toolset Wiki
Jump to: navigation, search
m
m (Add languages template)
 
(19 intermediate revisions by 3 users not shown)
Line 3: Line 3:
  
 
__TOC__
 
__TOC__
== Drag & Drop Method ==
+
 
 +
== Precautions ==
 +
 
 +
*Be sure the Excel document's format is correct. Excelprocessor may give hints on errors. See Article: [[2DA]]
 +
*Be sure your worksheet's name is correct. If you're extending an M2DA make sure you're using the correct prefix (see [[2DA_base.xls]]).
 +
*Be sure your worksheet's name is different from those already in use, unless you want to override an existing 2DA.
 +
*The filename of the Excel document doesn't matter, it is solely the worksheet's name which does.
 +
*Save and close the spreadsheet, Excelprocessor can't process files that are currently open in other programs.
 +
 
 +
== Converting ==
 +
 
 +
3 convenient Methods are listed.
 +
 
 +
=== Drag & Drop Method ===
  
 
# Copy ExcelProcessor.exe and source .XLS files to a new directory (not explicitly neccessary, but advised)
 
# Copy ExcelProcessor.exe and source .XLS files to a new directory (not explicitly neccessary, but advised)
 
# Select source .XLS files and drag them onto ExcelProcessor.exe
 
# Select source .XLS files and drag them onto ExcelProcessor.exe
# Cut & Paste resulting .GDA files, which will be located in the same directory as the source .XLS files, to your desired location (usually to "My Documents\BioWare\Dragon Age\AddIns\yourmodulename\module\overrides\")
+
# Resulting .GDA files, will be located in your users folder, or in the internally "active" folder which differs from Situation, OS and Language used.
  
== Adding 2DA export to the Windows XP file explorer ==
+
=== Command Line method ===
  
Here's an easy way to add a context (ie, right-click) menu item that quickly converts new or updated Dragon Age Excel files into GDA format:
+
# Copy ExcelProcessor.exe to the source .XLS files' directory.
 +
# Fire up command line, navigate into the directory where both the XLS files, and the ExcelProcessor can be found.
 +
# Type: ExcelProcessor "filename.xls" (where filename is the name of the xls spreadsheet, and of course the double quotes aren't needed)
 +
 
 +
Example code:<br>
 +
<code>
 +
C:\2DA\>ExcelProcessor guitypes.xls
 +
 
 +
</code>
 +
 
 +
=== Using a .BAT file ===
 +
 
 +
The following method adds some comfort:
 +
 
 +
*Create a folder called C:\2DA\
 +
*There create a File called "2DACompile.BAT" and add following lines with Notepad.
 +
 
 +
<pre>
 +
cd /d %0\..
 +
"C:\*DragonAgeInstallDir*\tools\ResourceBuild\Processors\ExcelProcessor.exe" %1
 +
PAUSE
 +
</pre>
 +
 
 +
'''Note:''' Replace "C:\*DragonAgeInstallDir*" with where you installed your game.
 +
 
 +
*Drag and Drop the XLS file over the new BAT file. It doesnt need to be in the same directory.
 +
*The GDA File will be placed into C:\2DA\
 +
*The window will stay open ,so you can view eventual Error messages.
 +
 
 +
Alternativly you can place the BAT ("Batch") file on your desktop, in which case the GDA will also be put on the Desktop. If you prefer easier access and convert often. Just drag the XLS from wherever it is over it.
 +
 
 +
=== Adding 2DA export to the Windows XP file explorer ===
 +
 
 +
The following gets the most comfort, and adds a right click context menu item. But it is tricky to set up.
  
 
Setup:  
 
Setup:  
Line 18: Line 64:
 
# In the File Types tab, select the XLS extension from the list and click the Advanced button.
 
# In the File Types tab, select the XLS extension from the list and click the Advanced button.
 
# Click the New button and put 'Binarize 2DA' in the Action field.
 
# Click the New button and put 'Binarize 2DA' in the Action field.
# Paste the following in the Application field and click OK (update the drive and folder names to match your client): <tt>"C:\Program Files\Dragon Age\tools\ResourceBuild\Processors\ExcelProcessor.exe"  "%1"  -outdir="C:\Documents and Settings\YOURNAME\My Documents\BioWare\Dragon Age\packages\core\override"</tt>
+
# Paste the following in the Application field and click OK (update the drive and folder names to match your client): <tt>"C:\*DragonAgeInstallDir*\Dragon Age\tools\ResourceBuild\Processors\ExcelProcessor.exe"  "%1"  -outdir="C:\Documents and Settings\YOURNAME\My Documents\BioWare\Dragon Age\packages\core\override"</tt>
 
## For the Steam version, use the following: <tt>"C:\Program Files\Steam\steamapps\common\dragon age origins\tools\ResourceBuild\Processors\ExcelProcessor.exe"  "%1" -outdir="C:\Documents and Settings\YOURNAME\My Documents\BioWare\Dragon Age\packages\core\override"</tt>
 
## For the Steam version, use the following: <tt>"C:\Program Files\Steam\steamapps\common\dragon age origins\tools\ResourceBuild\Processors\ExcelProcessor.exe"  "%1" -outdir="C:\Documents and Settings\YOURNAME\My Documents\BioWare\Dragon Age\packages\core\override"</tt>
  
Note that paths with spaces in them can cause Windows trouble, if your paths have spaces in them remember to wrap them in quotation marks.
+
Note that paths with spaces in them can cause Windows trouble, if your paths have spaces in them remember to wrap them in quotation marks.  
  
 
Usage:
 
Usage:
  
# Using Windows Explorer, navigate to your 2DA folder (in my case C:\DA\tag\main\data\Source\2DA) and select the Excel file(s) to process. Right click and select 'Binarize 2DA' from the context menu.  
+
# Using Windows Explorer, navigate to your 2DA folder and select the Excel file(s) to process. Right click and select 'Binarize 2DA' from the context menu.  
# Confirm a corresponding GDA file is created in your override folder (in my case C:\DA\tag\main\build\packages\core\override) for each Excel file processed.
+
# Confirm a corresponding GDA file is created in your override folder for each Excel file processed.
  
 
[[File:Adding binarize 2da to Windows XP explorer.png|center|thumb|300px|An example of how setting this up in Windows XP looks]]
 
[[File:Adding binarize 2da to Windows XP explorer.png|center|thumb|300px|An example of how setting this up in Windows XP looks]]
  
== Using a .BAT file ==
+
== Afterwards ==
 +
 
 +
Place the GDA(s) into the game's override directory. Which one, is determined the following:
 +
 
 +
*When it should be included into a custom Module, but extending Core M2DA's: (This is pretty much failproof)
 +
<pre>My Documents\BioWare\Dragon Age\AddIns\yourmodulename\core\override\</pre>
 +
 
 +
*When it should be included into a custom Module, and 2DA's not available to Core:
 +
<pre>My Documents\BioWare\Dragon Age\AddIns\yourmodulename\module\override\</pre>
 +
 
 +
*This is a cleaner solution, when packaging up the Module ,the files will be all in one place.
 +
 
 +
*'''Note:''' "My Documents" is different to each OS Version and OS language. "yourmodulename" is created with your custom Module.
 +
 
 +
 
 +
----
 +
For all other cases, when not making a Module copy them into: ''(this only makes sense when adjusting values of existing rows, and override without the toolset)''
 +
<pre>*DragonAgeInstalldir*\packages\core\override\</pre>
 +
 
 +
*'''Note:''' *DragonAgeInstalldir* is the Installation Directory you have chosen.
 +
 
 +
''See also: [[Source directory priorities]] - for a more detailed list of priorities of each override folder.
  
The following method may work better for you instead:
+
----
 +
'''Tip:''' You will need to restart the Toolset, or Game for the changes to take effect.
  
*Create two folders called C:\2DA\ and C:\2DA\Override\
 
*Copy ExcelProcessor.exe to C:\2DA\
 
*Copy the Excel spreadsheets containing the 2DA you want to use in the game to C:\2DA\
 
*Create a batch file with the following line in it (change "placeables.xls" to whatever Excel file you're working with):
 
C:\2DA\ExcelProcessor.exe placeables.xls -outdir=C:\2DA\override\
 
*Run your batch file
 
*Find the GDA file from the C:\2DA\Override\ directory and copy it to the game's override directory. Remember to take into account the naming conventions of M2DAs; you may need to rename your 2DA files with a new suffix unique to your module to allow it to add to the core 2DAs without conflict.
 
*'''If you copied your new 2DA file in your Override directory while Dragon Age Game was running, you will need to exit to windows and re-run the game to let your changes to work.'''
 
  
 
[[Category:2DAs]]
 
[[Category:2DAs]]
 +
{{Languages}}

Latest revision as of 01:40, 9 November 2010

In the "Dragon Age\tools\ResourceBuild\Processors" folder there is an executable named "ExcelProcessor.exe". This is the file that handles conversions of 2DAs from XLS to GDA format. Below are described 3 ways in which this file may be used.


Precautions

  • Be sure the Excel document's format is correct. Excelprocessor may give hints on errors. See Article: 2DA
  • Be sure your worksheet's name is correct. If you're extending an M2DA make sure you're using the correct prefix (see 2DA_base.xls).
  • Be sure your worksheet's name is different from those already in use, unless you want to override an existing 2DA.
  • The filename of the Excel document doesn't matter, it is solely the worksheet's name which does.
  • Save and close the spreadsheet, Excelprocessor can't process files that are currently open in other programs.

Converting

3 convenient Methods are listed.

Drag & Drop Method

  1. Copy ExcelProcessor.exe and source .XLS files to a new directory (not explicitly neccessary, but advised)
  2. Select source .XLS files and drag them onto ExcelProcessor.exe
  3. Resulting .GDA files, will be located in your users folder, or in the internally "active" folder which differs from Situation, OS and Language used.

Command Line method

  1. Copy ExcelProcessor.exe to the source .XLS files' directory.
  2. Fire up command line, navigate into the directory where both the XLS files, and the ExcelProcessor can be found.
  3. Type: ExcelProcessor "filename.xls" (where filename is the name of the xls spreadsheet, and of course the double quotes aren't needed)

Example code:
C:\2DA\>ExcelProcessor guitypes.xls

Using a .BAT file

The following method adds some comfort:

  • Create a folder called C:\2DA\
  • There create a File called "2DACompile.BAT" and add following lines with Notepad.
cd /d %0\..
"C:\*DragonAgeInstallDir*\tools\ResourceBuild\Processors\ExcelProcessor.exe" %1
PAUSE

Note: Replace "C:\*DragonAgeInstallDir*" with where you installed your game.

  • Drag and Drop the XLS file over the new BAT file. It doesnt need to be in the same directory.
  • The GDA File will be placed into C:\2DA\
  • The window will stay open ,so you can view eventual Error messages.

Alternativly you can place the BAT ("Batch") file on your desktop, in which case the GDA will also be put on the Desktop. If you prefer easier access and convert often. Just drag the XLS from wherever it is over it.

Adding 2DA export to the Windows XP file explorer

The following gets the most comfort, and adds a right click context menu item. But it is tricky to set up.

Setup:

  1. Open Windows Explorer and click Tools | Folder Options.
  2. In the File Types tab, select the XLS extension from the list and click the Advanced button.
  3. Click the New button and put 'Binarize 2DA' in the Action field.
  4. Paste the following in the Application field and click OK (update the drive and folder names to match your client): "C:\*DragonAgeInstallDir*\Dragon Age\tools\ResourceBuild\Processors\ExcelProcessor.exe" "%1" -outdir="C:\Documents and Settings\YOURNAME\My Documents\BioWare\Dragon Age\packages\core\override"
    1. For the Steam version, use the following: "C:\Program Files\Steam\steamapps\common\dragon age origins\tools\ResourceBuild\Processors\ExcelProcessor.exe" "%1" -outdir="C:\Documents and Settings\YOURNAME\My Documents\BioWare\Dragon Age\packages\core\override"

Note that paths with spaces in them can cause Windows trouble, if your paths have spaces in them remember to wrap them in quotation marks.

Usage:

  1. Using Windows Explorer, navigate to your 2DA folder and select the Excel file(s) to process. Right click and select 'Binarize 2DA' from the context menu.
  2. Confirm a corresponding GDA file is created in your override folder for each Excel file processed.
An example of how setting this up in Windows XP looks

Afterwards

Place the GDA(s) into the game's override directory. Which one, is determined the following:

  • When it should be included into a custom Module, but extending Core M2DA's: (This is pretty much failproof)
My Documents\BioWare\Dragon Age\AddIns\yourmodulename\core\override\
  • When it should be included into a custom Module, and 2DA's not available to Core:
My Documents\BioWare\Dragon Age\AddIns\yourmodulename\module\override\
  • This is a cleaner solution, when packaging up the Module ,the files will be all in one place.
  • Note: "My Documents" is different to each OS Version and OS language. "yourmodulename" is created with your custom Module.



For all other cases, when not making a Module copy them into: (this only makes sense when adjusting values of existing rows, and override without the toolset)

*DragonAgeInstalldir*\packages\core\override\
  • Note: *DragonAgeInstalldir* is the Installation Directory you have chosen.

See also: Source directory priorities - for a more detailed list of priorities of each override folder.


Tip: You will need to restart the Toolset, or Game for the changes to take effect.

Language: English  • русский