Difference between revisions of "Main Page"
From Dragon Age Toolset Wiki
BryanDerksen (Talk | contribs) (me too) |
BryanDerksen (Talk | contribs) m (image markup) |
||
| Line 1: | Line 1: | ||
| − | <big>''' | + | <big>'''Welcome to the Dragon Age Toolset documentation wiki!'''</big> |
| − | + | The documentation for the toolset is still being worked on so some of the material here may be incomplete or somewhat out-of-date. The contents of this site will eventually be refined and released to the general public; if you wish to contribute toward that (either by adding your own material or by highlighting holes) you are most welcome and your efforts will be incorporated into the finished product. | |
| − | *[ | + | *Consult the [http://meta.wikimedia.org/wiki/Help:Contents User's Guide] for information on using the wiki software. |
| + | *For general comments, discussion, suggestions, and questions, click the "Discussion" link at the top of the page. | ||
| − | + | In the meantime the contents of this wiki are covered by non-disclosure agreements, so please don't spread it around beyond this site and the designated private fora. | |
== Getting started == | == Getting started == | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | + | *[[Installing the toolset]] - how to install, and how to troubleshoot installation problems | |
| − | + | *[[Overview of the toolset]] as a whole, giving the general lay of the land. | |
| + | *[[Comparisons with other toolkits]] - for users who are familiar with other similar toolkits (eg, the Neverwinter Nights tookit) and would like a brief overview of how the Dragon Age toolkit compares. | ||
| + | *[[Shortcuts]] - Assorted toolset shortcuts. | ||
| + | |||
| + | *[[Known issues]] with the current version of the toolset | ||
| + | *[[Common Problems]] - Little things that most people will need to know but that are not necessarily obvious. | ||
| + | **If you run into a problem that the documentation doesn't cover and that you can't fix, contact toolsetsupport@bioware.com | ||
| + | |||
| + | *[[Creating a module]] - The initial structure for the game, see subsequent sections for details on how to fill it out. | ||
| + | *[[Exporting and running a module]] - How to actually run the adventure you've created. | ||
| + | |||
| + | *[[How-tos]] - short step-by-step guides for accomplishing specific tasks | ||
| + | *[[Tutorials]] - lengthier documents that are intended to teach the basics of an entire topic area. Some tutorials build on material from previous ones so you may wish to read them sequentially if you're unfamiliar with any of the basics. | ||
| + | **[[Placeable tutorial]] | ||
| + | **[[Area tutorial]] | ||
| + | **[[Item tutorial]] | ||
| + | **[[Creature tutorial]] | ||
| + | **[[Conversation tutorial]] | ||
| + | **[[Scripting tutorial]] | ||
| + | **[[Cutscene tutorial]] | ||
| + | **[[Map tutorial]] (also introduces 2DA editing) | ||
| + | |||
| + | == Designer tools == | ||
| + | |||
| + | *[[Resource palette]] - The central interface for the designer toolset. This article describes all of the various resource properties and the basics of using each type of resource. See [[resource palette]] for a complete listing and information about dealing with resources in general. Some of the more important and commonly used resources include: | ||
| + | **[[Image:IconArea.png]] [[Area]]s | ||
| + | **[[Image:IconConversation.png]] [[Conversation]]s | ||
| + | **[[Image:IconCreature.png]] [[Creature]]s | ||
| + | **[[Image:IconCutscene.png]] [[Cutscene]]s | ||
| + | **[[Image:IconItem.png]] [[Item]]s | ||
| + | **[[Image:IconMerchant.png]] [[Merchant]]s | ||
| + | **[[Image:IconPlaceable.png]] [[Placeable]]s | ||
| + | **[[Image:IconPlot.png]] [[Plot]]s | ||
| + | **[[Image:IconScript.png]] [[Script]]s | ||
| + | **[[Image:IconStage.png]] [[Stage]]s | ||
| + | **[[Image:IconTrigger.png]] [[Trigger]]s | ||
| + | **[[Image:IconSound.png]] [[Sound]]s | ||
| + | |||
| + | *[[String editor]] - A tool that allows quick and easy access to all text that might be presented to the player in the game. | ||
| + | |||
| + | *[[Builder to builder]] - The mechanisms used by the toolset that allow packages of game resources to be shared between multiple collaborating builders. This is not intended for builder to player packaging, a separate system will be added to the toolset for this at a later time. | ||
| + | |||
| + | *[[Create New Resource]] - The pop-up window when a new resource is created. | ||
| + | |||
| + | === Scripting and 2DAs === | ||
| + | |||
| + | Scripting in Dragon Age is a very powerful tool; most of the game's rules and AI are done via scripts and can be overridden at a low level. | ||
| + | |||
| + | *[[Script]]ing | ||
| + | **[[Event]]s - Dragon Age has an event-driven scripting model; this page lists all known events and their functions. | ||
| + | **[[Effect]]s | ||
| + | **[[Abilities|Ability]] | ||
| + | **[[Custom AI]]s | ||
| + | **[[Script error]]s | ||
| + | |||
| + | *[[Treasure system]] | ||
| + | |||
| + | *[[2DA]] files (2-Dimensional Arrays) contain much of the raw data used by the game. They are generated from Microsoft Excel files. If you want to add new basic creature types, new treasure types, and so forth, you'll need to create new 2DA files. | ||
| + | |||
| + | == Art tools == | ||
| + | |||
| + | Art tools are accessory programs that produce some of the raw components out of which resources can be assembled. | ||
| + | |||
| + | At this time only a few art tools are included with the end user toolset. We're working on adding more but cannot commit to a schedule. | ||
| + | |||
| + | *[[Level editor]] (note that this is distinct from the [[Area]] editor) | ||
| + | *[[Morph]]s are generated with the face-morphing tool. | ||
| + | *[[FMOD]] generates sounds. | ||
| + | *[[FaceFX]] handles facial expressions and lip-synching. | ||
| + | *[[Animation blend tree editor]] | ||
| + | *[[Material editor]] | ||
| + | *[[VFX editor]] | ||
| + | **[[VFX list]] lists visual effects in Dragon Age's library. | ||
| + | |||
| + | == Technical information == | ||
| + | |||
| + | The material in this section is about technical features underlying the toolset, not normally important for routine usage. | ||
| + | |||
| + | *[[File types]] - currently just a list of file format extensions. | ||
| + | |||
| + | *[[Database]] - database schema and other related information. | ||
| + | ** [[Database migration]] - instructions for how to update your database when updating your toolset | ||
| + | ** [[Database backup]] - How to back up or restore the EUTS database | ||
| + | ** [[Database sharing]] - How to share a database between two or more developers | ||
| + | |||
| + | *[[Console]] - a window for entering console commands. Caution, some of these are intended to work with an installed copy of the Dragon Age game and will crash the toolset when used in its current state. | ||
| + | |||
| + | *[[Release notes]] | ||
| + | |||
| + | == Third party tools == | ||
| + | |||
| + | *[[Web Application]] - A sample web application that allows you to search and view scripts, search and view conversations, and translate strings. By Adam Miller. | ||
Revision as of 16:12, 27 June 2009
Welcome to the Dragon Age Toolset documentation wiki!
The documentation for the toolset is still being worked on so some of the material here may be incomplete or somewhat out-of-date. The contents of this site will eventually be refined and released to the general public; if you wish to contribute toward that (either by adding your own material or by highlighting holes) you are most welcome and your efforts will be incorporated into the finished product.
- Consult the User's Guide for information on using the wiki software.
- For general comments, discussion, suggestions, and questions, click the "Discussion" link at the top of the page.
In the meantime the contents of this wiki are covered by non-disclosure agreements, so please don't spread it around beyond this site and the designated private fora.
Contents
Getting started
- Installing the toolset - how to install, and how to troubleshoot installation problems
- Overview of the toolset as a whole, giving the general lay of the land.
- Comparisons with other toolkits - for users who are familiar with other similar toolkits (eg, the Neverwinter Nights tookit) and would like a brief overview of how the Dragon Age toolkit compares.
- Shortcuts - Assorted toolset shortcuts.
- Known issues with the current version of the toolset
- Common Problems - Little things that most people will need to know but that are not necessarily obvious.
- If you run into a problem that the documentation doesn't cover and that you can't fix, contact toolsetsupport@bioware.com
- Creating a module - The initial structure for the game, see subsequent sections for details on how to fill it out.
- Exporting and running a module - How to actually run the adventure you've created.
- How-tos - short step-by-step guides for accomplishing specific tasks
- Tutorials - lengthier documents that are intended to teach the basics of an entire topic area. Some tutorials build on material from previous ones so you may wish to read them sequentially if you're unfamiliar with any of the basics.
- Placeable tutorial
- Area tutorial
- Item tutorial
- Creature tutorial
- Conversation tutorial
- Scripting tutorial
- Cutscene tutorial
- Map tutorial (also introduces 2DA editing)
Designer tools
- Resource palette - The central interface for the designer toolset. This article describes all of the various resource properties and the basics of using each type of resource. See resource palette for a complete listing and information about dealing with resources in general. Some of the more important and commonly used resources include:
- String editor - A tool that allows quick and easy access to all text that might be presented to the player in the game.
- Builder to builder - The mechanisms used by the toolset that allow packages of game resources to be shared between multiple collaborating builders. This is not intended for builder to player packaging, a separate system will be added to the toolset for this at a later time.
- Create New Resource - The pop-up window when a new resource is created.
Scripting and 2DAs
Scripting in Dragon Age is a very powerful tool; most of the game's rules and AI are done via scripts and can be overridden at a low level.
- Scripting
- Events - Dragon Age has an event-driven scripting model; this page lists all known events and their functions.
- Effects
- Ability
- Custom AIs
- Script errors
- 2DA files (2-Dimensional Arrays) contain much of the raw data used by the game. They are generated from Microsoft Excel files. If you want to add new basic creature types, new treasure types, and so forth, you'll need to create new 2DA files.
Art tools
Art tools are accessory programs that produce some of the raw components out of which resources can be assembled.
At this time only a few art tools are included with the end user toolset. We're working on adding more but cannot commit to a schedule.
- Level editor (note that this is distinct from the Area editor)
- Morphs are generated with the face-morphing tool.
- FMOD generates sounds.
- FaceFX handles facial expressions and lip-synching.
- Animation blend tree editor
- Material editor
- VFX editor
- VFX list lists visual effects in Dragon Age's library.
Technical information
The material in this section is about technical features underlying the toolset, not normally important for routine usage.
- File types - currently just a list of file format extensions.
- Database - database schema and other related information.
- Database migration - instructions for how to update your database when updating your toolset
- Database backup - How to back up or restore the EUTS database
- Database sharing - How to share a database between two or more developers
- Console - a window for entering console commands. Caution, some of these are intended to work with an installed copy of the Dragon Age game and will crash the toolset when used in its current state.
Third party tools
- Web Application - A sample web application that allows you to search and view scripts, search and view conversations, and translate strings. By Adam Miller.
