Difference between revisions of "User:Talonius/Sandbox"

From Dragon Age Toolset Wiki
Jump to: navigation, search
(Saving WIP.)
 
(9 intermediate revisions by the same user not shown)
Line 1: Line 1:
== Why is this in your user profile? ==
 
 
I'm using my user profile as a scratch pad where I can get this into shape before adding it to the rest of the Wiki; I may or may not finish it depending upon what quality of tutorials I find elsewhere, so I don't want to create a page for it and then have to delete it.  (I also need to do some verification/fact checking on some of what I believe.)
 
 
This page is intended to provide step by step instructions for each portion of the module creation process, including by linkage the various other pieces of the Wiki but allowing someone to follow it and understand how all the pieces go together.
 
 
 
== Creating a Small Adventure Step by Step ==
 
== Creating a Small Adventure Step by Step ==
  
=== Check Prerequisites ===
+
* Step #1: [[Step_by_Step:_Installing_the_Toolset|Install the Toolset]]
Do not attempt to install the toolkit without ensuring you have at least Windows XP with Service Pack 3, Windows Vista, or Windows 7. The SP3 requirement can be overlooked if you're technically savvy but for the smoothest experience I'd recommend installing the whole shebang.
+
* Step #2:  [[Step_by_Step:_Create_A_Module|Create a Module]]
 
+
Want to know why not?  Check the [[#http://social.bioware.com/forum/1/topic/8/index/113400|Forums]].
+
 
+
=== Install Python 2.5 ===
+
Python 2.5 is required for the light mapping inside the toolkit to function, and it is preferred that it be installed first.  ActiveState's ActivePython is the best choice, and is available for free.  The latest version as of November 15, 2009 (2009/11/15) is 2.5.4.4 and it can be found [[#https://www.activestate.com/activepython/downloads/|here]]
+
 
+
Caveats:
+
* There are some who have had issues with the 64 bit version; I personally haven't.  You may want to pick up the 32 bit version just in case.
+
* Install to the default directory to avoid any issues with the toolkit.  C:\Python25 is the normal default.
+
 
+
=== Toolkit Installation ===
+
These instructions and screenshots are for v1.0.982.0 of the toolkit.  They may or may not apply to later versions.
+
 
+
The toolkit is available from [[#http://social.bioware.com/toolset.php#downloads|Bioware's Community Site]]. It's 472Mb.
+
 
+
Double click the executable to install the toolkit.  If you have an antivirus scanner installed on your computer don't be surprised if it doesn't pop up right away; the antivirus scanner has to process all 472MB of the executable before it will be allowed to run.
+
 
+
If you have Windows Vista or Windows 7 you'll be prompted by UAC to allow the installer to run.  Choose yes if you obtained the toolset from the Bioware site.
+
 
+
==== Welcome Screen ====
+
[[Image:Talonius_Toolkit_Install_Screen_001.png|left|middle|frame|This is the installer's welcome screen.]] Click the '''Next''' button.
+
  
 
<br style="clear: both" />
 
<br style="clear: both" />
==== End User License Agreement ====
+
=== Starting the Toolkit ===
[[File:Talonius_Toolkit_Install_Screen_002.png|left|middle|frame|This screenshot shows the installer's EULA agreement screen.]]
+
[[Image:Talonius_Toolkit_Startup_Screen_001.png|thumb|left|middle|360px|The Windows 7 toolkit startup menu entry.]]
  
You'll be greeted with the end user license agreementYou're creating content for someone's software using this application; I highly recommend you actually read the license.
+
Find the Start Menu entry for the toolkit and click itGive the toolkit some time to start up. As a benchmark, it takes approximately 12 seconds for the toolkit to start on my AMD Phenom 9850 with 4GB of RAM with a Windows Experience score 7.2.
 
+
Accept the license agreement by selecting '''I accept the terms of the License Agreement''' and click '''Next'''.
+
  
 
<br style="clear: both" />
 
<br style="clear: both" />
==== Dragon Age Installation Directory Confirmation ====
+
=== Terminology ===
[[File:Talonius_Toolkit_Install_Screen_003.png|left|middle|frame|This shows the screen confirming the location of Dragon Age on the PC the toolset is being installed on.]]
+
Learning something new is difficult. Concise terminology is required to give direction, but the terminology is usually somewhat recursive in definition.  The following are some definitions that will help you navigate the remainder of this document.
  
The third screen is asking you to confirm the installation directory of Dragon Age.  The toolset requires Dragon Age to be installed; if the directory shown here isn't correct I would recommend reinstalling the game, then restarting the installation of the toolkit.
+
; [[Module]]
 
+
: A module is the overarching container in which content is housed.  It is the parent of all other content.  The best comparison to the Dragon Age module are Dungeons and Dragons modules.  Each module in D&D was a self contained adventure, complete with background, NPCs, maps, encounters, and any special rules which were to be in effect during the adventure.
If the location is correct click '''Next''' to continue.
+
; [[Area]]
 +
: An area in a module is a self contained subset of the module, limited in size and/or scope.  Areas are used to break the adventure into pieces, and are where the characters interact with the game.  An area requires a level layout before it can be defined; see below.  Items placed in an area are generally interactive, examinable, or dynamic in nature.
 +
; [[Level]]
 +
: A level defines the underlying static, immovable, non interactive portion of an area - structure and appearance.  The level determines where PCs and NPCs can move (pathfinding) and lighting (ambient and otherwise).  A level layout is required in order to define an area. A level can be created in one of two forms:  terrain and room.
 +
; [[Room Level]]
 +
: TODO:  Define
 +
; [[Terrain Level]]
 +
: TODO:  Define
  
 
<br style="clear: both" />
 
<br style="clear: both" />
==== SQL Server 2005 Express Installation ====
+
==== Create A Room Level ====
[[File:Talonius_Toolkit_Install_Screen_004.png|left|middle|frame|This screen shows the configuration options for SQL Server 2005 Express.]]
+
As mentioned above a level is the underlying structure to an areaFor our first level we're going to start with a room level.
 
+
SQL Server Express is a free version of SQL Server offered by Microsoft.  It is a relational database that the toolset uses to store information about the currently installed modules and campaigns.  Most of the problems around the installation of the toolkit revolve around the installation of SQL Server Express 2005. 
+
 
+
If you have no idea what any of these things mean it is recommended that you leave the default settings as they are.
+
 
+
If you have an existing SQL Server 2005 installation you wish to use uncheck '''Install MS SQL Express 2005 SP3'''You'll then need to check '''Custom settings:''' and enter in the information for the database you already have. 
+
 
+
<br/>
+
'''Examples:'''
+
* My SQL Server 2005 machine is named VORTEX, and it does not have any instances installed on it.  The '''database server''' for it would simply be VORTEX.  The '''database name''' would remain bw_dragonage_content unless you have a reason to change it.
+
* My workstation also has a copy of SQL Server 2008 on it with no instances.  I could reference this installation one of two ways.  The first would be as BRIAN-PC; the other would be by using the period by itself. 
+
* It should be noted that the . in the database server refers to the local machine; this should be replaced by the name of the machine on which your installation of SQL Server resides.  The \BWDATOOLSET refers to the database instance on that machine.
+
 
+
The installer will attempt to connect to the SQL Server you specify and it will run a series of scripts against the database you provided.  You should ensure that SQL Server is running on the appropriate machine and that you have no data you wish to save in the database you selected to install to.
+
 
+
<br/>
+
'''Problems?'''
+
* Visit the official forums and search there before posting; the most common issues have solutions already posted.
+
* Check the [[Installation troubleshooting]] page.
+
* A log file will be created in your Documents folder during the installation.  This is good to have handy if you have issues during installation.  The file in question is named "Install Dragon Age Toolset.txt".
+
 
+
Once the configuration is to your liking click '''Next''' to continue.
+
  
 
<br style="clear: both" />
 
<br style="clear: both" />
==== Toolkit Installation ====
+
[[Image:Talonius_Toolkit_Level_Create_001.png|thumb|left|middle|360px|Creating a new level; click File, New, Level.]]
[[File:Talonius_Toolkit_Install_Screen_005.png|left|middle|frame|This screenshot shows the installer as it progresses.]]
+
  
The installation will take some time.  Grab a drink, use the restroom, put together a playlist for your listening pleasure.
+
Click '''File''', then '''New''', then '''Level'''.
  
 
<br style="clear: both" />
 
<br style="clear: both" />
==== Toolkit Installation Finished Verification ====
+
[[Image:Talonius_Toolkit_Level_Create_002.png|thumb|left|middle|360px|The Level Creation Wizard.]]
[[File:Talonius_Toolkit_Install_Screen_006.png|left|middle|frame|A screenshot of a successful installation.]]
+
  
The last item in the window above should be ''Completed''If there's anything else scroll up in the window until you find the error and copy and paste that error somewhere for safe keepingSeek help in the forums or on the Internet, and restart the installation process.
+
You'll find yourself in the Level Creation WizardThe first screen prompts you to create a terrain, or exterior level, or a room (interior) levelWe're going to walk through the creation of a room level first, so select '''Room Level''' and click '''Next'''.
 
+
Click '''Next''' to continue.
+
  
 
<br style="clear: both" />
 
<br style="clear: both" />
==== Toolkit Installation Finished ====
+
[[Image:Talonius_Toolkit_Level_Create_003.png|thumb|left|middle|360px|The Level Creation Wizard.]]
[[File:Talonius_Toolkit_Install_Screen_007.png|left|middle|frame|The last screen of the toolkit installation.]]
+
  
You're done.  Assuming no unexpected errors appeared during the installation process you should be ready to start editing.
+
If we were creating a terrain level there would be a number of options presented to us; the room level creation is much simpler.
  
Click '''Finish''' to complete the installation.
+
Click '''Finish''' to create the room level.
  
 
<br style="clear: both" />
 
<br style="clear: both" />
=== Starting the Toolkit ===
+
==== A Tour of the Toolset Interface ====
[[File:Talonius_Toolkit_Startup_Screen_001.png|left|middle|frame|The Windows 7 toolkit startup menu entry.]]
+
The sheer number of icons and options on the toolset can be intimidatingWe're going to highlight the important areas of the interface to help you familiarize yourself with the toolset.
 
+
Find the Start Menu entry for the toolkit and click itGive the toolkit some time to start up.  As a benchmark, it takes approximately 12 seconds for the toolkit to start on my AMD Phenom 9850 with 4GB of RAM with a Windows Experience score 7.2.
+
  
 
<br style="clear: both" />
 
<br style="clear: both" />
=== Terminology ===
+
[[Image:Talonius_Toolkit_UI_Walkthrough_002.png|thumb|left|middle|360px|The Palette Window.]]
Learning something new is difficult. Concise terminology is required to give direction, but the terminology is usually somewhat recursive in definition.  The following are some definitions that will help you navigate the remainder of this document.
+
  
; [[Module]]
+
The first section to learn about is the '''Palette Window'''By default this is located in the upper right hand portion of the toolset screenThis window is used extensively during the creation of a module.
: A module is the overarching container in which content is housedIt is the parent of all other content.  The best comparison to the Dragon Age module are Dungeons and Dragons modulesEach module in D&D was a self contained adventure, complete with background, NPCs, maps, encounters, and any special rules which were to be in effect during the adventure.
+
; [[Area]]
+
: An area in a module is a self contained subset of the module, limited in size and/or scope.  Areas are used to break the adventure into pieces, and are where the characters interact with the game.  An area requires a level layout before it can be defined; see below.  Items placed in an area are generally interactive, examinable, or dynamic in nature.
+
; [[Level]]
+
: A level defines the underlying static, immovable, non interactive portion of an area - structure and appearance.  The level determines where PCs and NPCs can move (pathfinding) and lighting (ambient and otherwise).  A level layout is required in order to define an area.  A level can be created in one of two forms:  terrain and room.
+
; [[Room]]
+
: A room
+
  
<br style="clear: both" />
+
Two things to note: first, in the upper left corner of the Palette Window are two icons.  The first is a push pin; the second is an X.   
=== Modules ===
+
The toolset comes with two modules installed.   
+
  
* The '''Single Player''' module is the campaign, and shouldn't be edited unless you want to modify the Dragon Age campaign itself.  If you're creating an addin or mod for the official campaign, this is the module in which you'll want to work.
+
[[Image:Talonius_Toolkit_UI_Walkthrough_003.png|thumb|right|middle|360px|The Palette Window and Object Inspector windows collapsed.]]
* The '''Demo''' module is installed for demonstration purposes by Bioware, and several other tutorials and forum posts refer to it.
+
<br style="clear: both" />
+
[[File:Talonius_Toolkit_Module_Current_001.png|frame|left|The currently selected module is highlighted in the red box.]]
+
  
You can easily determine which module you're editing by looking at the title bar of the toolboxIn the image the currently edited module is highlighted by the red rectangle; the example has the '''Single Player''' module loaded.
+
The push pin collapses the window into the sidebar, providing a larger workspace for any remaining open windowsTo reopen the window simply click on the window title in the sidebar.  You can then keep the window open by hitting the push pin icon again.
  
Until you're comfortable with the toolkit it's best to work in a module separate from either of the above modules.
+
The X closes the window.  If you accidentally close either window they can be opened again from the '''View''', '''Palette''' selection and the '''View''', '''Other Windows''', '''Object Inspector''' for the Palette Window and Object Inspector windows respectively.
  
<br style="clear: both" />
+
Both of these icons can be found with nearly every window within the toolset.
==== Create A Module ====
+
[[File:Talonius_Toolkit_Module_Create_001.png|left|middle|frame|The first step of creating a module.]]
+
  
To create a module click '''File''' then '''Manage Modules'''.
+
'''Palette Window'''
 
+
<br style="clear: both" />
+
[[File:Talonius_Toolkit_Module_Create_002.png|left|middle|frame|The manage modules window.]]
+
 
+
The Manage Modules window will appear.  Click the '''New''' button to create a module.
+
 
+
<br style="clear: both" />
+
[[File:Talonius_Toolkit_Module_Create_003.png|left|middle|frame|The manage modules window.]]
+
  
The Object Properties window appears.  All of these properties can be changed at a later date; our primary concern are the '''Name''' and '''UID''' properties.
+
[[Category:StepByStep]]

Latest revision as of 05:21, 17 November 2009

Creating a Small Adventure Step by Step


Starting the Toolkit

The Windows 7 toolkit startup menu entry.

Find the Start Menu entry for the toolkit and click it. Give the toolkit some time to start up. As a benchmark, it takes approximately 12 seconds for the toolkit to start on my AMD Phenom 9850 with 4GB of RAM with a Windows Experience score 7.2.


Terminology

Learning something new is difficult. Concise terminology is required to give direction, but the terminology is usually somewhat recursive in definition. The following are some definitions that will help you navigate the remainder of this document.

Module
A module is the overarching container in which content is housed. It is the parent of all other content. The best comparison to the Dragon Age module are Dungeons and Dragons modules. Each module in D&D was a self contained adventure, complete with background, NPCs, maps, encounters, and any special rules which were to be in effect during the adventure.
Area
An area in a module is a self contained subset of the module, limited in size and/or scope. Areas are used to break the adventure into pieces, and are where the characters interact with the game. An area requires a level layout before it can be defined; see below. Items placed in an area are generally interactive, examinable, or dynamic in nature.
Level
A level defines the underlying static, immovable, non interactive portion of an area - structure and appearance. The level determines where PCs and NPCs can move (pathfinding) and lighting (ambient and otherwise). A level layout is required in order to define an area. A level can be created in one of two forms: terrain and room.
Room Level
TODO: Define
Terrain Level
TODO: Define


Create A Room Level

As mentioned above a level is the underlying structure to an area. For our first level we're going to start with a room level.


Creating a new level; click File, New, Level.

Click File, then New, then Level.


The Level Creation Wizard.

You'll find yourself in the Level Creation Wizard. The first screen prompts you to create a terrain, or exterior level, or a room (interior) level. We're going to walk through the creation of a room level first, so select Room Level and click Next.


The Level Creation Wizard.

If we were creating a terrain level there would be a number of options presented to us; the room level creation is much simpler.

Click Finish to create the room level.


A Tour of the Toolset Interface

The sheer number of icons and options on the toolset can be intimidating. We're going to highlight the important areas of the interface to help you familiarize yourself with the toolset.


The Palette Window.

The first section to learn about is the Palette Window. By default this is located in the upper right hand portion of the toolset screen. This window is used extensively during the creation of a module.

Two things to note: first, in the upper left corner of the Palette Window are two icons. The first is a push pin; the second is an X.

The Palette Window and Object Inspector windows collapsed.

The push pin collapses the window into the sidebar, providing a larger workspace for any remaining open windows. To reopen the window simply click on the window title in the sidebar. You can then keep the window open by hitting the push pin icon again.

The X closes the window. If you accidentally close either window they can be opened again from the View, Palette selection and the View, Other Windows, Object Inspector for the Palette Window and Object Inspector windows respectively.

Both of these icons can be found with nearly every window within the toolset.

Palette Window