Map tutorial - Revision history

FergusM at 21:14, 5 July 2010

2010-07-05T21:14:19Z

Captain Chordata: /* Creating maps in photoshop to use in-game */ Elford's site is now flash so old links do not work and redirect to webhost. Available under the tutorial tab now, no unique url for each.

2010-03-19T17:03:21Z

‎Creating maps in photoshop to use in-game: Elford's site is now flash so old links do not work and redirect to webhost. Available under the tutorial tab now, no unique url for each.

Eshme: /* Converting XLS files into GDA files */ replaced lenghty stuff with a link, cause it was outdated anyways

2010-02-01T14:20:04Z

‎Converting XLS files into GDA files: replaced lenghty stuff with a link, cause it was outdated anyways

BryanDerksen: /* Creating maps in photoshop to use in-game */ condense the map tutorial links with a gallery

2010-01-14T18:17:37Z

‎Creating maps in photoshop to use in-game: condense the map tutorial links with a gallery

BryanDerksen: /* Creating maps in photoshop to use in-game */ these tutorials are not currently online, but will be back in another location at some point

2010-01-14T17:13:05Z

‎Creating maps in photoshop to use in-game: these tutorials are not currently online, but will be back in another location at some point

BryanDerksen: /* Putting your map into the toolset */ overlooked one

2010-01-14T17:07:25Z

‎Putting your map into the toolset: overlooked one

BryanDerksen: formatting tags, shrink down some more large images, add a few links

2010-01-14T17:04:55Z

formatting tags, shrink down some more large images, add a few links

BryanDerksen: /* Creating a map and adding pins */ shrink giant images

2010-01-14T16:59:34Z

‎Creating a map and adding pins: shrink giant images

BryanDerksen: /* Converting XLS files into GDA files */ replace the old excel-based method, which was buggy and not released with the public toolset

2010-01-14T16:58:39Z

‎Converting XLS files into GDA files: replace the old excel-based method, which was buggy and not released with the public toolset

BryanDerksen: /* The worldmaps.xls spreadsheet */ add the two new columns not mentioned before

2010-01-14T16:43:05Z

‎The worldmaps.xls spreadsheet: add the two new columns not mentioned before

@@ Line 41: / Line 41: @@
 * TargetWpTableID - a row ID in the [[M2DA_Base]] 2DA that references the same 2DA in the TargetWpTable column. This speeds up lookup of the 2DA by the game.
 * TripsCounterTable - A table showing which trips should have random encounters. We won't be going into detail about this in this tutorial.
 We'll need to add a new row to this table to describe the map area that we want to use in the toolset. For this example we have a map of a region named "Epona's Realm", in a file named <code>epona.tga</code>. We'll need to assign a unique number ID, which we'll arbitrarily set to 700 (using a high number like this makes it less likely to interfere with other people's additions in the future.). We'll call the target waypoint table "target_wps_epona" to fit with the naming convention of the other maps.

@@ Line 211: / Line 211: @@
 Here are some tutorials that can be used to make yourself a map in Photoshop.
 <gallery>
-File:Map01_thumb.jpg‎ | [http://www.jezelf.co.uk/tutorials_map01.htm Basic Map tutorial] - required as it is the basic stepping stone to make any map [Difficulty = Basic]
+File:Map01_thumb.jpg‎ | Basic Map tutorial - required as it is the basic stepping stone to make any map [Difficulty = Basic]
-File:Map02_thumb.jpg | [http://www.jezelf.co.uk/tutorials_map02.htm Paper style/aged Map tutorial ] Style #1 [Difficulty = Beginner]
+File:Map02_thumb.jpg | Paper style/aged Map tutorial Style #1 [Difficulty = Beginner]
-File:Map04_thumb.jpg‎ | [http://www.jezelf.co.uk/tutorials_map04.htm Colored 2D Map Tutorial ] Style #2 [Difficulty = Beginner/Intermediate]
+File:Map04_thumb.jpg‎ | Colored 2D Map Tutorial Style #2 [Difficulty = Beginner/Intermediate]
-File:Map05_thumb.jpg‎ | [http://www.jezelf.co.uk/tutorials_map05.htm Pseudo 3D Map Tutorial ] Style #3  [Difficulty = Intermeditate/Advanced]
+File:Map05_thumb.jpg‎ | Pseudo 3D Map Tutorial Style #3  [Difficulty = Intermeditate/Advanced]
 </gallery>
@@ Line 227: / Line 223: @@
-''All map making tutorials above are done by Jeremy Elford and [http://www.jezelf.co.uk/index.html www.Jezelf.co.uk]''
+''All map making tutorials above are done by Jeremy Elford and are available for download at [http://www.jezelf.co.uk/index.html www.Jezelf.co.uk] under the tutorials tab''
 '''Other Valuable Map Making Resources'''

@@ Line 80: / Line 80: @@
 Note that there will be a separate GDA file for each worksheet in the XLS file, named after the worksheets in the XLS file. We only need to use two of them; <code>worldmaps_epona.GDA</code> and <code>target_wps_epona.GDA</code>. Copy these files into your game's override directory along with <code>epona.tga</code> and "Epona's Realm" will become available in the toolset's dropdown menu.
-=== Drag & Drop Method ===
+:''See [[Compiling 2DAs]]''
-−
-# Copy ExcelProcessor.exe and source .XLS files to a new directory (not explicitly necessary, but advised)
-# Select source .XLS files and drag them onto ExcelProcessor.exe
-# Cut & Paste resulting .2DA 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\")
-−
-=== Adding 2DA export to the Windows XP file explorer ===
-−
-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:
-−
-Setup:
-−
-# Open Windows Explorer and click Tools | Folder Options.
-# 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.
-# 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>
-## 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.
-−
-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.
-# 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.
-−
-[[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 ===
-−
-The following method may work better for you instead:
-−
-*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.
 == Creating a map and adding pins ==

@@ Line 253: / Line 253: @@
 </div>
-[http://www.jezelf.co.uk/tutorials_map01.htm Basic Map tutorial] - required as it is the basic stepping stone to make any map [Difficulty = Basic]
+<gallery>
 Be sure to save the map as a .tga or .dds so the 2da will read it
-''
+''All map making tutorials above are done by Jeremy Elford and [http://www.jezelf.co.uk/index.html www.Jezelf.co.uk]''
 All map making tutorials above are done by Jeremy Elford and [http://www.jezelf.co.uk/index.html www.Jezelf.co.uk]''
 '''Other Valuable Map Making Resources'''

← Older revision		Revision as of 17:13, 14 January 2010
Line 248:		Line 248:

	Here are some tutorials that can be used to make yourself a map in Photoshop.		Here are some tutorials that can be used to make yourself a map in Photoshop.
		+
		+	<div style="float:right; width:200px;">
		+	[[File:Ambox warning yellow.png\|left]] Jeremy Elford's tutorial site is moving to a new location and is currently unavailable.
		+	</div>

	[http://www.jezelf.co.uk/tutorials_map01.htm Basic Map tutorial] - required as it is the basic stepping stone to make any map [Difficulty = Basic]		[http://www.jezelf.co.uk/tutorials_map01.htm Basic Map tutorial] - required as it is the basic stepping stone to make any map [Difficulty = Basic]

@@ Line 322: / Line 322: @@
 Once downloaded extract it to your folder that you copied and edited your worldmaps.xls in. When it is finished copying over, right click the covert.bat and select edit. It should pop up a window using notepad.exe that should look like this.
 [[File:Step 4 map.jpg]]
 Step 9:

@@ Line 147: / Line 147: @@
 Once you've got a map built for your module you'll need to tell the game how to use it. There are a number of wrapper functions in wrappers_h that you'll find useful for this:
-<pre>void WR_SetWorldMapPrimary(object oMapId)</pre>
+<dascript>void WR_SetWorldMapPrimary(object oMapId)</dascript>
 This function tells the game what the current default "world map" is. You'll want to set this to your default world map as part of the initial setup of your module, and if you have multiple different maps you'll need to call this function again later in the game to switch which one is active (for example in a plot script that triggers when the player completes a certain task or moves to a certain area).
-<pre>void WR_SetWorldMapSecondary(object oMapId)</pre>
+<dascript>void WR_SetWorldMapSecondary(object oMapId)</dascript>
 !!Need to find out more about this one.!!
-<pre>void WR_SetWorldMapLocationStatus(object oLocation, int nStatusId, int bSuppressActiveFlash = FALSE)</pre>
+<dascript>void WR_SetWorldMapLocationStatus(object oLocation, int nStatusId, int bSuppressActiveFlash = FALSE)</dascript>
 oLocation is a map pin, nStatusId is an integer identifier for one of the status states (such as active, grayed out, destroyed), and the optional bSuppressActiveFlash flag tells the game to omit the visual highlighting that is usually shown around map pins that have had their status changed since the last time the player looked at the map.
-<pre>void WR_SetWorldMapPlayerLocation(object oMap, object oLocation)</pre>
+<dascript>void WR_SetWorldMapPlayerLocation(object oMap, object oLocation)</dascript>
 This marks the player's current location on the map.
@@ Line 169: / Line 169: @@
 The default module_core script doesn't handle this event so you'll need to add your own module event script to override this behavior. The module's event script should call the following core script functions:
-<pre>
+<dascript>
   SetWorldMapGuiStatus(WM_GUI_STATUS_USE);
   OpenPrimaryWorldMap();
-</pre>
+</dascript>
 This displays the map to the player.
@@ Line 181: / Line 181: @@
 First get the world map pin object:
-<pre>
+<dascript>
 object oVillage = GetObjectByTag(WML_WOW_VILLAGE);
-</pre>
+</dascript>
 Then call the following to activate the pin:
-<pre>
+<dascript>
 WR_SetWorldMapLocationStatus(oVillage, WM_LOCATION_ACTIVE);
-</pre>
+</dascript>
 Area transitions using the default area transition core script can also automatically enable certain map pins when the player travels through them. The names of these pins are set in the area transition's variables.
@@ Line 196: / Line 196: @@
 If the proper destination areas and waypoints have been set in the map pins (and optionally the target_wps 2DA) the player's movement from one location to another should be handled automatically. However, the game does provide some hooks that allows further customization or non-standard actions to be performed.
-When a player clicks on a map pin, the EVENT_TYPE_BEGIN_TRAVEL event is sent to the module script.
+When a player clicks on a map pin, the [[EVENT_TYPE_BEGIN_TRAVEL]] event is sent to the module script.
 This event has the following parameters:
@@ Line 208: / Line 208: @@
 * object oSourceLocation = GetEventObject(ev, 0); // the map pin object representing the source location.
-In the main Dragon Age campaign's module script, a large amount of complex code is triggered by the EVENT_TYPE_BEGIN_TRAVEL event. This code takes into account a lot of special-case situations that are relevant only to the particular plot and structure of the Dragon Age main campaign. But it is important to note one thing that is ''not'' done in the EVENT_TYPE_BEGIN_TRAVEL event; the actual call to UT_DoAreaTransition().
+In the main Dragon Age campaign's module script, a large amount of complex code is triggered by the EVENT_TYPE_BEGIN_TRAVEL event. This code takes into account a lot of special-case situations that are relevant only to the particular plot and structure of the Dragon Age main campaign. But it is important to note one thing that is ''not'' done in the EVENT_TYPE_BEGIN_TRAVEL event; the actual call to [[UT_DoAreaTransition]]().
 Instead, once you have finished doing whatever special-case coding and random encounter tests you choose to implement, you will need to store the destination that you're sending the player to in the module's variable table. Then call the WorldMapStartTravelling(); function to begin the map trail animation (the WorldMapStartTravelling function has optional parameters to insert a random encounter partway through the trip and to override the map pin the trail starts at).
-The engine will send the EVENT_TYPE_WORLDMAP_PRETRANSITION event as it begins the map trail animation. This is where you want to call UT_DoAreaTransition(); the level will begin loading in the background as the map trail animation plays.
+The engine will send the [[EVENT_TYPE_WORLDMAP_PRETRANSITION]] event as it begins the map trail animation. This is where you want to call UT_DoAreaTransition(); the level will begin loading in the background as the map trail animation plays.
 The following code is the most basic amount that you should need to put in your module script in order to implement area transitions via the world map:
-<pre>
+<dascript>
 case EVENT_TYPE_BEGIN_TRAVEL:
+{
@@ Line 234: / Line 234: @@
      break;
+}
-</pre>
+</dascript>
-There is also a EVENT_TYPE_WORLDMAP_POSTTRANSITION event. In the Dragon Age main campaign it is used only to trigger certain cutscenes that play as a result of world travel.
+There is also a [[EVENT_TYPE_WORLDMAP_POSTTRANSITION]] event. In the Dragon Age main campaign it is used to trigger certain cutscenes that play as a result of world travel.
 === Other map-related events ===
-The EVENT_TYPE_WORLD_MAP_CLOSED is sent to the module script when the world map is closed. It has only one parameter, an integer flag that indicates whether the map was closed due to cancel being selected or due to the player traveling to a new destination.
+The [[EVENT_TYPE_WORLD_MAP_CLOSED]] is sent to the module script when the world map is closed. It has only one parameter, an integer flag that indicates whether the map was closed due to cancel being selected or due to the player traveling to a new destination.
 ==Custom Maps==
@@ Line 247: / Line 247: @@
 === Creating maps in photoshop to use in-game ===
+Here are some tutorials that can be used to make yourself a map in Photoshop.
-Here are some tutorials that can be used to make yourself a map in photoshop.
 [http://www.jezelf.co.uk/tutorials_map01.htm Basic Map tutorial] - required as it is the basic stepping stone to make any map [Difficulty = Basic]
@@ Line 288: / Line 287: @@
 Browse to your Dragon Age folder > tools > Source > 2DA and find the worldmaps.xls
-[[File:Step_1.jpg]]
+[[File:Step_1.jpg|600px]]
 Step 2:
@@ Line 294: / Line 293: @@
 Create a folder, somewhere on your hard drive, such as "C:\Dragon_Age\test_mod\" (do not allow any of the folders to have space)
-[[File:Step_2_map.jpg]]
+[[File:Step_2_map.jpg|600px]]
 Step 3:
@@ Line 308: / Line 307: @@
 After you have opened up the .xls you will see
 	Wide Open World	396061	Worldmap	target_wps_wow	1012	enc_trips_sp
 [[File:Step_3_map.jpg]]
 Step 6:
@@ Line 367: / Line 367: @@
 "Once you get a feel with what you are doing you may be able to do more, but I would not recommend such a thing for those who are new to this kinda stuff"--[[User:Arixsus|-Arixsus]] 05:05, 28 November 2009 (UTC)
 [[Category:Maps]]
 [[Category:Tutorials]]

@@ Line 129: / Line 129: @@
 To insert a pin, right-click on the map and select "insert pin" from the drop-down menu. The pointer will turn into a crosshair that you can click anywhere on the map to place a pin (pins can also be dragged around after creation so don't worry if you miss slightly). The pin will be added to the tree view to the left of the map and, when selected, you can view its properties in the object inspector.
-[[Image:Worldmaps placing a pin.png]]
+[[Image:Worldmaps placing a pin.png|600px]]
 The most important properties to set here are:
@@ Line 141: / Line 141: @@
 The "TerrainType" property is used to determine which group of random encounters to draw from. Setting up random encounters is a more advanced topic that we won't cover in this tutorial.
-[[Image:Worldmaps pins placed.png]]
+[[Image:Worldmaps pins placed.png|600px]]
 == Showing the player the map ==

@@ Line 76: / Line 76: @@
 == Converting XLS files into GDA files ==
-The game can't use Excel files directly, the 2DAs must first be converted into a "binarized" form. This is done by a command-line utility called <code>ResourceBuilder.exe</code>. Command-line utilities are not very user-friendly, however, so a more convenient "wrapper" is included in the form of another spreadsheet named <code>2daExporter.xls</code>. <code>2daExporter.xls</code> uses macros to run <code>ResourceBuilder.exe</code> with the appropriate command-line options. You'll need to provide <code>2daExporter.xls</code> with the following parameters:
+The game can't use Excel files directly, the 2DAs must first be converted into a "binarized" form called a GDA. This is done by a command-line utility called <code>ExcelProcessor.exe</code>. Command-line utilities are not very user-friendly, so there are a number of different ways you might use this to make the process easier.
-* ResourceBuild Path: The path to <code>ResourceBuilder.exe</code>, which is installed by default in your Dragon Age directory under tools\ResourceBuild
+Note that there will be a separate GDA file for each worksheet in the XLS file, named after the worksheets in the XLS file. We only need to use two of them; <code>worldmaps_epona.GDA</code> and <code>target_wps_epona.GDA</code>. Copy these files into your game's override directory along with <code>epona.tga</code> and "Epona's Realm" will become available in the toolset's dropdown menu.
-* 2DA Path: The source path of the XLS files to be exported.
-* Override Path: The path to the directory that the completed GDA files should be exported to. This doesn't have to be your actual override directory, you can move the files there manually after creating them if you prefer.
-Note that <code>2daExporter.xls</code>' macro can have trouble with paths that have spaces in them, so you may need to move your XLS files to a path without any. Likewise, you may not be able to send the output files directly to the override directory if there are spaces in its path.
+=== Drag & Drop Method ===
-Here's how we've set up <code>2daExporter.xls</code> for converting our example:
+# Copy ExcelProcessor.exe and source .XLS files to a new directory (not explicitly necessary, but advised)
-[[Image:2da exporter for worldmap tutorial.png]]
+=== Adding 2DA export to the Windows XP file explorer ===
-To convert worldmaps.xls into binary form, select it and click the "Export Selected" button. A command-line window should pop up briefly while ResourceBuilder runs and then the finished GDA files will be placed in the directory listed in "Override Path."
+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:
-If you can't get <code>2daExporter.xls</code> working, just run <code>ExcelProcessor</code> instead. You can learn more about <code>ExcelProcessor</code> by reading the [[2DA]] section.
+Setup:
-Note that there will be a separate GDA file for each worksheet in the XLS file, named after the worksheets in the XLS file. We only need to use two of them; <code>worldmaps_epona.GDA</code> and <code>target_wps_epona.GDA</code>. Copy these files into your game's override directory along with <code>epona.tga</code> and "Epona's Realm" will become available in the toolset's dropdown menu.
+# Open Windows Explorer and click Tools | Folder Options.
 == Creating a map and adding pins ==

@@ Line 36: / Line 36: @@
 In the case of the worldmaps worksheet there are four columns that contain the data defining the map layout.
 * Label - The name that this map layout will be known by in the Designer Toolkit's dropdown menu. It's not seen by the player.
 * MAP - The filename of the .tga that defines the map's appearance, without the .tga extension. Also supported is the .dds file format.
 * TargetWpTable - The names of 2DAs that contains information about what waypoints the player appears at within areas accessible from the map. This is discussed in greater detail below.
 * TripsCounterTable - A table showing which trips should have random encounters. We won't be going into detail about this in this tutorial.