Data File Development Process - Revision history

Rob: /* Creating the New Game System */

2009-01-21T09:46:35Z

Creating the New Game System

← Older revision		Revision as of 09:46, 21 January 2009
Line 83:		Line 83:
	When you're ready to launch into developing your own data files, we've made it as easy as possible to get started. There are a vast number of details involved in getting a set of data files to a critical mass where you can successfully load them and experiment with them. There are a similarly large number of mechanisms that will be useful for just about any game system. The good news is that we've saved you the work of having to do all this, as the Kit includes the Skeleton data files that will let you hit the ground running.		When you're ready to launch into developing your own data files, we've made it as easy as possible to get started. There are a vast number of details involved in getting a set of data files to a critical mass where you can successfully load them and experiment with them. There are a similarly large number of mechanisms that will be useful for just about any game system. The good news is that we've saved you the work of having to do all this, as the Kit includes the Skeleton data files that will let you hit the ground running.

	Creating the framework for a new game system entails only a few mouse clicks. Go to the "~~Tools~~" menu and select the "Create New Game System" option. You'll be prompted to enter both the name of the game system and the name of the folder in which to place the data files. Once that's done, HL will set everything up properly for you. After creation, you can immediately switch to your new game system and set it in place, then you're off and running.		Creating the framework for a new game system entails only a few mouse clicks. Go to the "Develop" menu and select the "Create New Game System" option. You'll be prompted to enter both the name of the game system and the name of the folder in which to place the data files. Once that's done, HL will set everything up properly for you. After creation, you can immediately switch to your new game system and set it in place, then you're off and running.

	{{warning}}There are a number of critical implications with the choice of folder name. Please review the list below before selecting the folder.		{{warning}}There are a number of critical implications with the choice of folder name. Please review the list below before selecting the folder.

Rob: /* Take Snapshots Regularly */

2008-12-17T22:29:04Z

Take Snapshots Regularly

← Older revision		Revision as of 22:29, 17 December 2008
Line 41:		Line 41:
	{{important}}If you use HLExport as outlined above and need to reload an old snapshot, be sure to import the files into a '''different''' directory from the data files you are developing. Otherwise, the old files you import will overwrite your recent changes!		{{important}}If you use HLExport as outlined above and need to reload an old snapshot, be sure to import the files into a '''different''' directory from the data files you are developing. Otherwise, the old files you import will overwrite your recent changes!

	Another simple technique is to make a copy of the entire directory contents for your game system. This allows you to do a direct file-to-file comparison of any file at any time, which can be quite handy at times. The only drawback of this approach is that if often requires more effort than the HLExport technique.		Another simple technique is to make a copy of the entire directory contents for your game system. This allows you to do a direct file-to-file comparison of any file at any time, which can be quite handy at times. The only drawback of this approach is that it often requires more effort than the HLExport technique.

	~~The ideal method for taking snapshots is to use~~ a ~~source control system~~ of ~~some sort. Unfortunately, this is an approach that many users~~ will ~~not have access to. If you do, though, it's absolutely~~ the best ~~technique~~.		In general, a combination of both techniques will often yield the best results.

	==Skeleton Data Files==		==Skeleton Data Files==

Rob: /* Take Snapshots Regularly */

2008-12-17T22:23:13Z

Take Snapshots Regularly

← Older revision		Revision as of 22:23, 17 December 2008
Line 44:		Line 44:

	The ideal method for taking snapshots is to use a source control system of some sort. Unfortunately, this is an approach that many users will not have access to. If you do, though, it's absolutely the best technique.		The ideal method for taking snapshots is to use a source control system of some sort. Unfortunately, this is an approach that many users will not have access to. If you do, though, it's absolutely the best technique.

	~~For users without access to a source control system, we recommend using a combination of the other two methods for best results.~~

	==Skeleton Data Files==		==Skeleton Data Files==

Rob: /* Review the Skeleton Files */

2008-11-23T23:13:35Z

Review the Skeleton Files

← Older revision		Revision as of 23:13, 23 November 2008
Line 53:		Line 53:
	Since this framework provides all of the basics you'll need and must simply be fleshed out, we refer to this starting point as the Skeleton data files. These data files are minimal in nature, but they offer a solid framework to start with, including a variety of built-in mechanisms that you will likely find yourself using for whatever game system you set out to implement.		Since this framework provides all of the basics you'll need and must simply be fleshed out, we refer to this starting point as the Skeleton data files. These data files are minimal in nature, but they offer a solid framework to start with, including a variety of built-in mechanisms that you will likely find yourself using for whatever game system you set out to implement.

	==Review the ~~Skeleton~~ Files==		==Review the Sample Data Files==

	Before you start trying to develop your own data files, you should first spend a little bit of time familiarizing yourself with the Skeleton data files. Since they will form the starting point for your efforts, you'll benefit substantially by understanding how they work. You~~'ll find details on~~ the ~~Skeleton~~ data files ~~elsewhere within this documentation~~.		Before you start trying to develop your own data files, you should first spend a little bit of time familiarizing yourself with the Skeleton data files. Since they will form the starting point for your efforts, you'll benefit substantially by understanding how they work. You should also take the time to review the contents of the data files themselves and get familiar with them, as you'll begin modifying and adapting them.

	~~You should also take the time to review the contents of the data files themselves and get familiar with them, as you'll begin modifying and adapting them.~~ You can see the Skeleton data files in action by looking at the "Authoring Kit Sample" game system that is installed with HL. If you take a look within the "sample" data file folder, you'll see all of the data files for the game system.		You can see the Skeleton data files in action by looking at the "Authoring Kit Sample" game system that is installed with HL. If you take a look within the "sample" data file folder, you'll see all of the data files for the game system. Lots of useful insights into the sample data files will be found in the section [[Exploring the Sample Game System]].

	The only differences between the Sample game system and the Skeleton data files is that the Sample game system includes an assortment of attributes, skills, abilities, weapons, and whatnot. By including these objects, you can better see how everything works. ~~However~~, the Skeleton data files omit these objects, since you would otherwise have to delete them before you could begin adding all the material for your own game system.		The only differences between the Sample game system and the Skeleton data files is that the Sample game system includes an assortment of attributes, skills, abilities, weapons, and whatnot. By including these objects, you can better see how everything works. In contrast, the Skeleton data files omit these objects, since you would otherwise have to delete them before you could begin adding all the material for your own game system.

			Functionality, the two sets of data files are identical. The only difference is that the Sample game system includes a variety of things that you can actually play with.

	==Study the Savage Worlds Example==		==Study the Savage Worlds Example==

Rob: /* Study the Savage Worlds Example */

2008-11-23T23:04:32Z

Study the Savage Worlds Example

← Older revision		Revision as of 23:04, 23 November 2008
Line 65:		Line 65:
	In addition to the Skeleton data files, a separate separate set of data files is provided that implements a reasonably sophisticated game system - the Savage Worlds system from Great White Games. The Kit documentation includes a detailed walk-through of how the Skeleton data files were adapted for that game system, guiding you through the entire evolutionary process. This offers a concrete example of how to approach your own project.		In addition to the Skeleton data files, a separate separate set of data files is provided that implements a reasonably sophisticated game system - the Savage Worlds system from Great White Games. The Kit documentation includes a detailed walk-through of how the Skeleton data files were adapted for that game system, guiding you through the entire evolutionary process. This offers a concrete example of how to approach your own project.

	When starting on the development of data files for a new game system on your own, you'll be starting out with the Skeleton data files and expanding upon them for your own purposes. It would be extremely helpful to first review how the Skeleton data files evolve into the Savage Worlds data files, as there will likely be many similarities with the evolutionary process for your game system. The Savage Worlds ~~walk~~-~~through~~ will also provide insight into how and when to address different steps in the development process that you can leverage within your own project.		When starting on the development of data files for a new game system on your own, you'll be starting out with the Skeleton data files and expanding upon them for your own purposes. It would be extremely helpful to first review how the Skeleton data files evolve into the Savage Worlds data files, as there will likely be many similarities with the evolutionary process for your game system. The [[Savage Worlds Walk-Through]] will also provide insight into how and when to address different steps in the development process that you can leverage within your own project.

	==Have a Plan==		==Have a Plan==

Rob: /* Creating the New Game System */

2008-11-23T22:55:53Z

Creating the New Game System

← Older revision		Revision as of 22:55, 23 November 2008
Line 88:		Line 88:
	*Saved portfolios are associated with a game system via the folder assigned. Changing the folder for a game system after the initial release of data files will result in all existing saved portfolios being rendered inaccessible.		*Saved portfolios are associated with a game system via the folder assigned. Changing the folder for a game system after the initial release of data files will result in all existing saved portfolios being rendered inaccessible.
	*Until the release of your data files to others, you may freely change the folder name within the [[Structure Element (Data)\|definition file]], although doing so will invalidate any portfolios you've created thus far.		*Until the release of your data files to others, you may freely change the folder name within the [[Structure Element (Data)\|definition file]], although doing so will invalidate any portfolios you've created thus far.
			*Make sure the folder name uniquely identifies the game system. When a user imports the data files, this folder is where the data files will be installed. If two or more game systems use the same folder name, they will overwrite each other.
	*The folder name may consist only of alphanumeric characters (i.e. letters and digits). It may not contain any spaces or special characters other than the underscore ('_') and hyphen ('-').		*The folder name may consist only of alphanumeric characters (i.e. letters and digits). It may not contain any spaces or special characters other than the underscore ('_') and hyphen ('-').

Rob: /* Take Snapshots Regularly */

2008-11-23T22:52:49Z

Take Snapshots Regularly

← Older revision		Revision as of 22:52, 23 November 2008
Line 37:		Line 37:
	As you evolve your data files, you will be making significant changes. Even if you are careful, it's likely that you will end up causing everything to break at a few points along the way. When this happens, it can be invaluable to be able to see exactly what has been changed since the last time everything was working fine. In order to do this, you need to have a saved copy of when things were last working. Consequently, we '''strongly''' encourage you to make a complete copy of your data files at regular intervals, preferably at milestones where everything is working the way you want it. We refer to these copies as "snapshots".		As you evolve your data files, you will be making significant changes. Even if you are careful, it's likely that you will end up causing everything to break at a few points along the way. When this happens, it can be invaluable to be able to see exactly what has been changed since the last time everything was working fine. In order to do this, you need to have a saved copy of when things were last working. Consequently, we '''strongly''' encourage you to make a complete copy of your data files at regular intervals, preferably at milestones where everything is working the way you want it. We refer to these copies as "snapshots".

	The easiest way to take a snapshot is to use [[Using the HLExport Tool\|~~the~~ HLExport tool]] that is included with the Kit. This tool is designed to package up all of the data files for a game system into a single file that can be easily imported back into HL, and you'll be using this tool to distribute your data files once they're created. In the meantime, though, this tool can also be helpful during development. Using HLExport, you can readily take snapshots of your working data files and save them. If you need to refer back to an old snapshot, you can import the file back into HL and compare the files.		The easiest way to take a snapshot is to use the [[Using the HLExport Tool\|HLExport tool]] that is included with the Kit. This tool is designed to package up all of the data files for a game system into a single file that can be easily imported back into HL, and you'll be using this tool to distribute your data files once they're created. In the meantime, though, this tool can also be helpful during development. Using HLExport, you can readily take snapshots of your working data files and save them. If you need to refer back to an old snapshot, you can import the file back into HL and compare the files.

	{{important}}If you use HLExport as outlined above and need to reload an old snapshot, be sure to import the files into a '''different''' directory from the data files you are developing. Otherwise, the old files you import will overwrite your recent changes!		{{important}}If you use HLExport as outlined above and need to reload an old snapshot, be sure to import the files into a '''different''' directory from the data files you are developing. Otherwise, the old files you import will overwrite your recent changes!

Rob: /* Take Snapshots Regularly */

2008-11-23T22:52:30Z

Take Snapshots Regularly

← Older revision		Revision as of 22:52, 23 November 2008
Line 37:		Line 37:
	As you evolve your data files, you will be making significant changes. Even if you are careful, it's likely that you will end up causing everything to break at a few points along the way. When this happens, it can be invaluable to be able to see exactly what has been changed since the last time everything was working fine. In order to do this, you need to have a saved copy of when things were last working. Consequently, we '''strongly''' encourage you to make a complete copy of your data files at regular intervals, preferably at milestones where everything is working the way you want it. We refer to these copies as "snapshots".		As you evolve your data files, you will be making significant changes. Even if you are careful, it's likely that you will end up causing everything to break at a few points along the way. When this happens, it can be invaluable to be able to see exactly what has been changed since the last time everything was working fine. In order to do this, you need to have a saved copy of when things were last working. Consequently, we '''strongly''' encourage you to make a complete copy of your data files at regular intervals, preferably at milestones where everything is working the way you want it. We refer to these copies as "snapshots".

	The easiest way to take a snapshot is to use the HLExport tool that is included with the Kit. This tool is designed to package up all of the data files for a game system into a single file that can be easily imported back into HL, and you'll be using this tool to distribute your data files once they're created. In the meantime, though, this tool can also be helpful during development. Using HLExport, you can readily take snapshots of your working data files and save them. If you need to refer back to an old snapshot, you can import the file back into HL and compare the files.		The easiest way to take a snapshot is to use [[Using the HLExport Tool\|the HLExport tool]] that is included with the Kit. This tool is designed to package up all of the data files for a game system into a single file that can be easily imported back into HL, and you'll be using this tool to distribute your data files once they're created. In the meantime, though, this tool can also be helpful during development. Using HLExport, you can readily take snapshots of your working data files and save them. If you need to refer back to an old snapshot, you can import the file back into HL and compare the files.

	{{important}}If you use HLExport as outlined above and need to reload an old snapshot, be sure to import the files into a '''different''' directory from the data files you are developing. Otherwise, the old files you import will overwrite your recent changes!		{{important}}If you use HLExport as outlined above and need to reload an old snapshot, be sure to import the files into a '''different''' directory from the data files you are developing. Otherwise, the old files you import will overwrite your recent changes!

Rob: /* Creating the New Game System */

2008-11-23T22:49:38Z

Creating the New Game System

← Older revision		Revision as of 22:49, 23 November 2008
Line 84:		Line 84:

	Creating the framework for a new game system entails only a few mouse clicks. Go to the "Tools" menu and select the "Create New Game System" option. You'll be prompted to enter both the name of the game system and the name of the folder in which to place the data files. Once that's done, HL will set everything up properly for you. After creation, you can immediately switch to your new game system and set it in place, then you're off and running.		Creating the framework for a new game system entails only a few mouse clicks. Go to the "Tools" menu and select the "Create New Game System" option. You'll be prompted to enter both the name of the game system and the name of the folder in which to place the data files. Once that's done, HL will set everything up properly for you. After creation, you can immediately switch to your new game system and set it in place, then you're off and running.

			{{warning}}There are a number of critical implications with the choice of folder name. Please review the list below before selecting the folder.
			*Saved portfolios are associated with a game system via the folder assigned. Changing the folder for a game system after the initial release of data files will result in all existing saved portfolios being rendered inaccessible.
			*Until the release of your data files to others, you may freely change the folder name within the [[Structure Element (Data)\|definition file]], although doing so will invalidate any portfolios you've created thus far.
			*The folder name may consist only of alphanumeric characters (i.e. letters and digits). It may not contain any spaces or special characters other than the underscore ('_') and hyphen ('-').

Rob at 08:42, 22 November 2008

2008-11-22T08:42:46Z

← Older revision		Revision as of 08:42, 22 November 2008
Line 1:		Line 1:
	~~[[Category:Basic Concepts and Terminology]]~~		{{context\|Basic Concepts and Terminology}}
	~~[Context: [[Home~~\|~~HL Kit]] [[~~Basic Concepts and Terminology~~]]]~~

	==Overview==		==Overview==