Difference between revisions of "Savage Worlds Walk-Through"

From HLKitWiki
Jump to: navigation, search
(Creating the Savage Worlds Data Files)
 
(19 intermediate revisions by the same user not shown)
Line 3: Line 3:
 
==Overview==
 
==Overview==
  
This section of the documentation outlines the evolutionary process of the Savage Worlds data files. It provides a technical walk-through of how the Skeleton data files provided with the Kit were converted into the fully functional data files for Savage Worlds. The process is outlined in a step-wise fashion that you can follow along with if you wish or simply use as a reference. For steps that involve the entry of numerous data elements (e.g. attributes, skills, edges, etc.), a few key examples are outlined and the rest remain as an exercise if you wish. Alternately, you can simply review them within the completed Savage Worlds files that have everything already implemented for you.  
+
This section of the documentation outlines the evolutionary process of the Savage Worlds data files. It provides a technical walk-through of how the Skeleton data files provided with the Kit were converted into the fully functional data files for Savage Worlds. The process is outlined in a step-wise fashion that you can follow along with if you wish or simply use as a reference. For steps that involve the entry of numerous data elements (e.g. attributes, skills, edges, etc.), a few key examples are outlined and the rest remain as an exercise if you wish. Alternately, you can simply review them within the completed Savage Worlds files that have everything already implemented for you.
 +
 
 +
{{important}}The Savage Worlds data files implement the rules as outlined in the Explorers Edition rulebook. In some cases, pertinent mechanics that existed in the original rulebook are also included to illustrate how to do various tasks.
  
 
==What We Assume==
 
==What We Assume==
  
 
This walk-through assumes you have a basic familiarity with the Savage Worlds game system from Great White Games, since our goal is to develop data files for that game system. If you aren't familiar with the game, the first step is to get up to speed on the basics. This can be easily accomplished by reviewing the free "Test Drive" rules for Savage Worlds, which can be found online. Just go to the [http://www.greatwhitegames.com Great White Games website] and you should find the file in the Downloads section. If you have trouble locating the file, you can use this [http://www.lonewolfdevel.com/downloads/savage-worlds-test-drive.pdf mirror link].
 
This walk-through assumes you have a basic familiarity with the Savage Worlds game system from Great White Games, since our goal is to develop data files for that game system. If you aren't familiar with the game, the first step is to get up to speed on the basics. This can be easily accomplished by reviewing the free "Test Drive" rules for Savage Worlds, which can be found online. Just go to the [http://www.greatwhitegames.com Great White Games website] and you should find the file in the Downloads section. If you have trouble locating the file, you can use this [http://www.lonewolfdevel.com/downloads/savage-worlds-test-drive.pdf mirror link].
 
We also assume that you've familiarized yourself with the rest of the Kit documentation and all of the core concepts. Regular references will be made to the terms, concepts, and mechanisms that are introduced by the Kit. At a minimum, you must be comfortable with the material presented in the [[Basic Concepts and Terminology]] section.
 
  
 
If you have not done so yet, you will likely benefit by reviewing the organization and content of the Skeleton/Sample data files. Since the Savage Worlds data files start with the Skeleton data files and evolve from there, you'll probably find that extra context to be helpful.
 
If you have not done so yet, you will likely benefit by reviewing the organization and content of the Skeleton/Sample data files. Since the Savage Worlds data files start with the Skeleton data files and evolve from there, you'll probably find that extra context to be helpful.
  
Lastly, you will need a text editor that allows you to edit XML files. You can get by with the Notepad editor included with Windows, but that editor is extremely limited in what it offers, so we recommend you use something with a little bit more functionality if at all possible. Numerous text editors are available for free online that will work well, while commercial tools are also available. A few good options are listed below:
+
Lastly, the assumptions sets forth for the examples as a whole also apply.
 
+
*Notepad++ - [http://notepad-plus.sourceforge.net]
+
*EditPad Lite - [http://www.editpadpro.com/editpadlite.html]
+
*Textpad.com - [http://www.textpad.com]
+
*XMLMarker - [http://www.symbolclick.com]
+
  
 
==Where to Find the Source==
 
==Where to Find the Source==
Line 32: Line 27:
 
The topics below follow the evolutionary process from start to finish. If this is your first time reading through this documentation, we strongly recommend that you read through these topics in the order presented, as each one builds upon changes made in the previous stages. After an initial reading, you can return to the topics that most closely pertain to whatever task you are working on within your own data files.
 
The topics below follow the evolutionary process from start to finish. If this is your first time reading through this documentation, we strongly recommend that you read through these topics in the order presented, as each one builds upon changes made in the previous stages. After an initial reading, you can return to the topics that most closely pertain to whatever task you are working on within your own data files.
  
*{{flalt|The First Steps (Savage)|The First Steps}}
+
*Getting Started
*{{flalt|Develop Your Plan (Savage)|Develop Your Plan}}
+
**{{flalt|The First Steps (Savage)|The First Steps}}
*{{flalt|Initial Changes (Savage)|Initial Changes}}
+
**{{flalt|Develop Your Plan (Savage)|Develop Your Plan}}
*{{flalt|Traits (Savage)|Traits}}
+
**{{flalt|Initial Changes (Savage)|Initial Changes}}
*{{flalt|Attributes (Savage)|Attributes}}
+
*Fundamental Pieces
*{{flalt|Skills (Savage)|Skills}}
+
**{{flalt|Traits (Savage)|Traits}}
*{{flalt|Derived Traits (Savage)|Derived Traits}}
+
**{{flalt|Attributes (Savage)|Attributes}}
*{{flalt|Resources (Savage)|Resources}}
+
**{{flalt|Skills (Savage)|Skills}}
*{{flalt|Basics of Arcane Backgrounds (Savage)|Basics of Arcane Backgrounds}}
+
**{{flalt|Derived Traits (Savage)|Derived Traits}}
*{{flalt|Races and Racial Abilities (Savage)|Races and Racial Abilities}}
+
**{{flalt|Resources (Savage)|Resources}}
*{{flalt|Verifying Actor Pre-Requisites (Savage)|Verifying Actor Pre-Requisites}}
+
*Core Game System Elements
*{{flalt|Encumbrance (Savage)|Encumbrance}}
+
**{{flalt|Basics of Arcane Backgrounds (Savage)|Basics of Arcane Backgrounds}}
*{{flalt|Hindrance Support (Savage)|Hindrance Support }}
+
**{{flalt|Races and Racial Abilities (Savage)|Races and Racial Abilities}}
*{{flalt|Adding Hindrances (Savage)|Adding Hindrances }}
+
**{{flalt|Verifying Actor Pre-Requisites (Savage)|Verifying Actor Pre-Requisites}}
*{{flalt|Countering Hindrances (Savage)|Countering Hindrances}}
+
**{{flalt|Encumbrance (Savage)|Encumbrance}}
*{{flalt|Edge Support (Savage)|Edge Support}}
+
**{{flalt|Hindrance Support (Savage)|Hindrance Support }}
*{{flalt|Adding Edges (Savage)|Adding Edges }}
+
**{{flalt|Adding Hindrances (Savage)|Adding Hindrances }}
*{{flalt|Revise Configuration Form (Savage)|Revise Configuration Form}}
+
**{{flalt|Countering Hindrances (Savage)|Countering Hindrances}}
*{{flalt|Prune Extraneous Material (Savage)|Prune Extraneous Material }}
+
**{{flalt|Edge Support (Savage)|Edge Support}}
*{{flalt|A Tab for Skills (Savage)|A Tab for Skills}}
+
**{{flalt|Adding Edges (Savage)|Adding Edges }}
*{{flalt|Revise "Basics" Tab (Savage)|Revise "Basics" Tab}}
+
*Adding and Revising Initial Panels
*{{flalt|Incrementer Behavior (Savage)|Incrementer Behavior}}
+
**{{flalt|Revise Configuration Form (Savage)|Revise Configuration Form}}
*{{flalt|Add an "Edges" Tab (Savage)|Add an "Edges" Tab}}
+
**{{flalt|Prune Extraneous Material (Savage)|Prune Extraneous Material }}
*{{flalt|Evolving the "Edges" Tab (Savage)|Evolving the "Edges" Tab}}
+
**{{flalt|A Tab for Skills (Savage)|A Tab for Skills}}
*{{flalt|Character Creation Logic (Savage)|Character Creation Logic}}
+
**{{flalt|Revise "Basics" Tab (Savage)|Revise "Basics" Tab}}
*{{flalt|Revise Adjustments (Savage)|Revise Adjustments}}
+
**{{flalt|Incrementer Behavior (Savage)|Incrementer Behavior}}
*{{flalt|More on Arcane Backgrounds (Savage)|More on Arcane Backgrounds}}
+
**{{flalt|Add an "Edges" Tab (Savage)|Add an "Edges" Tab}}
*{{flalt|Add an "Arcane" Tab (Savage)|Add an "Arcane" Tab}}
+
**{{flalt|Evolving the "Edges" Tab (Savage)|Evolving the "Edges" Tab}}
*{{flalt|Refining Arcane Backgrounds and Powers (Savage)|Refining Arcane Backgrounds and Powers}}
+
*Evolving Game System Elements
*{{flalt|Synthesizing Descriptions for Display (Savage)|Synthesizing Descriptions for Display}}
+
**{{flalt|Character Creation Logic (Savage)|Character Creation Logic}}
*{{flalt|Refining the "Arcane" Tab (Savage)|Refining the "Arcane" Tab}}
+
**{{flalt|Revise Adjustments (Savage)|Revise Adjustments}}
*{{flalt|Damage (Savage)|Damage}}
+
**{{flalt|More on Arcane Backgrounds (Savage)|More on Arcane Backgrounds}}
*{{flalt|Revamp the "Static" Form (Savage)|Revamp the "Static" Form}}
+
**{{flalt|Add an "Arcane" Tab (Savage)|Add an "Arcane" Tab}}
*{{flalt|Advancement Support (Savage)|Advancement Support}}
+
**{{flalt|Refining Arcane Backgrounds and Powers (Savage)|Refining Arcane Backgrounds and Powers}}
*{{flalt|Adding Advancements (Savage)|Adding Advancements}}
+
**{{flalt|Synthesizing Descriptions for Display (Savage)|Synthesizing Descriptions for Display}}
*{{flalt|Revise Journal Tab (Savage)|Revise Journal Tab}}
+
**{{flalt|Refining the "Arcane" Tab (Savage)|Refining the "Arcane" Tab}}
*{{flalt|Equipment (Savage)|Equipment}}
+
**{{flalt|Damage (Savage)|Damage}}
*{{flalt|Weapons (Savage)|Weapons}}
+
**{{flalt|Revamp the "Static" Form (Savage)|Revamp the "Static" Form}}
*{{flalt|Ranged Weapons (Savage)|Ranged Weapons}}
+
*Character Advancement
*{{flalt|Finishing Off Weapons (Savage)|Finishing Off Weapons}}
+
**{{flalt|Advancement Support (Savage)|Advancement Support}}
*{{flalt|Armor (Savage)|Armor}}
+
**{{flalt|Adding Advancements (Savage)|Adding Advancements}}
*{{flalt|Gear and Load Limit (Savage)|Gear and Load Limit}}
+
**{{flalt|Revise Journal Tab (Savage)|Revise Journal Tab}}
*{{flalt|Natural Weapons (Savage)|Natural Weapons}}
+
*Gear and Equipment
*{{flalt|Special Weapons (Savage)|Special Weapons}}
+
**{{flalt|Equipment (Savage)|Equipment}}
*{{flalt|Conferring Edges and Hindrances (Savage)|Conferring Edges and Hindrances}}
+
**{{flalt|Weapons (Savage)|Weapons}}
*{{flalt|Injuries (Savage)|Injuries}}
+
**{{flalt|Ranged Weapons (Savage)|Ranged Weapons}}
*{{flalt|Fright (Savage)|Fright}}
+
**{{flalt|Finishing Off Weapons (Savage)|Finishing Off Weapons}}
 +
**{{flalt|Armor (Savage)|Armor}}
 +
**{{flalt|Gear and Load Limit (Savage)|Gear and Load Limit}}
 +
**{{flalt|Natural Weapons (Savage)|Natural Weapons}}
 +
**{{flalt|Special Weapons (Savage)|Special Weapons}}
 +
*Expanding Our Coverage
 +
**{{flalt|Conferring Edges and Hindrances (Savage)|Conferring Edges and Hindrances}}
 +
**{{flalt|Injuries (Savage)|Injuries}}
 +
**{{flalt|Fright (Savage)|Fright}}
 +
*Vehicles
 +
**{{flalt|Basic Vehicles (Savage)|Basic Vehicles}}
 +
**{{flalt|Complex Vehicles (Savage)|Complex Vehicles}}
 +
*Refinement of Behaviors
 +
**{{flalt|Using Bitmaps for Die Types (Savage)|Using Bitmaps for Die Types}}
 +
**{{flalt|Show the Derivation of Values (Savage)|Show the Derivation of Values}}
 +
**{{flalt|Revise Summary Panels (Savage)|Revise Summary Panels}}
 +
*Character Output
 +
**{{flalt|Character Sheet Design (Savage)|Character Sheet Design}}
 +
**{{flalt|Character Sheet Output (Savage)|Character Sheet Output}}
 +
**{{flalt|Implementing the Character Sheet (Savage)|Implementing the Character Sheet}}
 +
**{{flalt|Character Sheet Phase 2 (Savage)|Character Sheet Phase 2}}
 +
**{{flalt|Character Sheet Phase 3 (Savage)|Character Sheet Phase 3}}
 +
**{{flalt|Character Sheet Phase 4 (Savage)|Character Sheet Phase 4}}
 +
**{{flalt|Character Sheet Phase 5 (Savage)|Character Sheet Phase 5}}
 +
**{{flalt|Character Sheet Refinement (Savage)|Character Sheet Refinement}}
 +
**{{flalt|Statblock Output (Savage)|Statblock Output}}
 +
*Assorted Remaining Elements
 +
**{{flalt|Miscellaneous Cleanup (Savage)|Miscellaneous Cleanup}}
 +
**{{flalt|Weird Science Gizmos (Savage)|Weird Science Gizmos}}
 +
**{{flalt|Dashboard (Savage)|Dashboard}}
 +
**{{flalt|Tactical Console (Savage)|Tactical Console}}
 +
**{{flalt|Initiative (Savage)|Initiative}}
 +
**{{flalt|Allies (Savage)|Allies}}
 +
**{{flalt|Character Sheet Additions (Savage)|Character Sheet Additions}}
 +
**{{flalt|User-Configurable Options (Savage)|User-Configurable Options}}
 +
**{{flalt|Specialized Edges (Savage)|Specialized Edges}}
 +
*Other Character Types (NPCs and Creatures)
 +
**{{flalt|NPC Support (Savage)|NPC Support}}
 +
**{{flalt|More Cleanup (Savage)|More Cleanup}}
 +
**{{flalt|Creatures (Savage Worlds)|Creatures}}
 +
**{{flalt|Creature Specification (Savage)|Creature Specification}}
 +
**{{flalt|Creature Refinement (Savage)|Creature Refinement}}
 +
**{{flalt|Creature Customization (Savage)|Creature Customization}}
 +
*The Final Stages
 +
**{{flalt|Final Cleanup (Savage)|Final Cleanup}}
 +
**{{flalt|Final Cleanup Continued (Savage)|Final Cleanup Continued}}
 +
**{{flalt|Integrated Editor Support (Savage)|Integrated Editor Support}}
 +
**{{flalt|Stock Portfolios (Savage)|Stock Portfolios}}
 +
**{{flalt|Data File Release (Savage)|Data File Release}}
 +
 
 +
==Changes After Initial Release==
  
{{tbd}}
+
The Savage Worlds data files are maintained on an ongoing basis, which means bugs are fixed and new capabilities are sometimes added. Instead of retrofitting the preceding documentation, any such changes are outlined in the following topics.
  
*{{flalt|x (Savage)|x}}
+
*{{flalt|Changes in V3.2 (Savage)|Changes in V3.2}}
<!--
+
Basic Vehicles (Savage)
+
Complex Vehicles (Savage)
+
Using Bitmaps for Die Types (Savage)
+
Show the Derivation of Values (Savage)
+
Revise Summary Panels (Savage)
+
Character Sheet Design (Savage)
+
Character Sheet Output (Savage)
+
Implementing the Character Sheet (Savage)
+
Character Sheet Phase 2 (Savage)
+
Character Sheet Phase 3 (Savage)
+
Character Sheet Phase 4 (Savage)
+
Character Sheet Phase 5 (Savage)
+
Character Sheet Refinement (Savage)
+
Statblock Output (Savage)
+
Status Assessment (Savage)
+
Miscellaneous Cleanup (Savage)
+
Weird Science Gizmos (Savage)
+
Dashboard (Savage)
+
Tactical Console (Savage)
+
Initiative (Savage)
+
Allies (Savage)
+
User-Configurable Settings (Savage)
+
-->
+

Latest revision as of 16:08, 2 May 2009

Context: HL KitAuthoring Examples 

Overview

This section of the documentation outlines the evolutionary process of the Savage Worlds data files. It provides a technical walk-through of how the Skeleton data files provided with the Kit were converted into the fully functional data files for Savage Worlds. The process is outlined in a step-wise fashion that you can follow along with if you wish or simply use as a reference. For steps that involve the entry of numerous data elements (e.g. attributes, skills, edges, etc.), a few key examples are outlined and the rest remain as an exercise if you wish. Alternately, you can simply review them within the completed Savage Worlds files that have everything already implemented for you.

IMPORTANT! The Savage Worlds data files implement the rules as outlined in the Explorers Edition rulebook. In some cases, pertinent mechanics that existed in the original rulebook are also included to illustrate how to do various tasks.

What We Assume

This walk-through assumes you have a basic familiarity with the Savage Worlds game system from Great White Games, since our goal is to develop data files for that game system. If you aren't familiar with the game, the first step is to get up to speed on the basics. This can be easily accomplished by reviewing the free "Test Drive" rules for Savage Worlds, which can be found online. Just go to the Great White Games website and you should find the file in the Downloads section. If you have trouble locating the file, you can use this mirror link.

If you have not done so yet, you will likely benefit by reviewing the organization and content of the Skeleton/Sample data files. Since the Savage Worlds data files start with the Skeleton data files and evolve from there, you'll probably find that extra context to be helpful.

Lastly, the assumptions sets forth for the examples as a whole also apply.

Where to Find the Source

Sometimes, it might be useful to refer to the source code of the completed Savage Worlds files during this tutorial. You can find it by downloading and importing the Savage Worlds game system from the updates mechanism (click "Locate Files" on the "Select Game System" form that appears when you start Hero Lab), then looking in the "source" directory under the Savage Worlds folder. Depending on where you installed Hero Lab, this will be something like:

c:\herolab\data\savage\source\

Once there, you can view all the source files. Note that editing them will NOT apply any changes to the Savage Worlds game system - they are for reference only. If you want to make changes to the game system, you must copy them to a different folder (for example c:\herolab\data\mysavage) and begin editing there.

Creating the Savage Worlds Data Files

The topics below follow the evolutionary process from start to finish. If this is your first time reading through this documentation, we strongly recommend that you read through these topics in the order presented, as each one builds upon changes made in the previous stages. After an initial reading, you can return to the topics that most closely pertain to whatever task you are working on within your own data files.

Changes After Initial Release

The Savage Worlds data files are maintained on an ongoing basis, which means bugs are fixed and new capabilities are sometimes added. Instead of retrofitting the preceding documentation, any such changes are outlined in the following topics.