Difference between revisions of "File Locations and Naming Conventions"

From HLKitWiki
Jump to: navigation, search
 
(9 intermediate revisions by the same user not shown)
Line 1: Line 1:
 +
{{context|Basic Concepts and Terminology|The Physical Files}}
 +
 
Beneath the directory where you installed HL is a directory named "data". If you installed HL to the default location, this directory will be located at "C:\HeroLab\data". All HL data files reside in sub-directories beneath the "data" directory, with all of the data files for each game system being grouped together within a sub-directory named appropriately for that game system. For example, all of the data files for the d20 System will be found in the "d20" sub-directory, or "C:\HeroLab\data\d20" if you installed HL to the default location.
 
Beneath the directory where you installed HL is a directory named "data". If you installed HL to the default location, this directory will be located at "C:\HeroLab\data". All HL data files reside in sub-directories beneath the "data" directory, with all of the data files for each game system being grouped together within a sub-directory named appropriately for that game system. For example, all of the data files for the d20 System will be found in the "d20" sub-directory, or "C:\HeroLab\data\d20" if you installed HL to the default location.
  
 
Within a game system directory, there will be an assortment of files with a variety of names. Here is a summary of the various files that will be found and their purpose.
 
Within a game system directory, there will be an assortment of files with a variety of names. Here is a summary of the various files that will be found and their purpose.
  
:{| class="infotable" border="1" cellspacing="0"
+
:{| class="infotable"
|class="infoleft"|*.cfg
+
|class="leftnormal"|config.cfg
|class="infotext"|Configuration files
+
|Configuration file that provides details when package files are used
 
|-
 
|-
|class="infoleft"|*.pkg
+
|*.pkg
|class="infotext"|Package files
+
|Package files
 
|-
 
|-
|class="infoleft"|definition.def
+
|definition.def
|class="infotext"|Definition file that is compiled before anything else
+
|Definition file that is compiled before anything else
 
|-
 
|-
|class="infoleft"|*.1st
+
|*.1st
|class="infotext"|Augmentation files that are compiled first
+
|Structural files that are compiled first
 
|-
 
|-
|class="infoleft"|*.core
+
|*.core
|class="infotext"|Augmentation files compiled after "*.1st" files
+
|Structural files compiled after "*.1st" files
 
|-
 
|-
|class="infoleft"|*.pri
+
|*.str
|class="infotext"|Augmentation files compiled after "*.pri" files
+
|Structural files compiled after "*.pri" files
 
|-
 
|-
|class="infoleft"|*.aug
+
|*.aug
|class="infotext"|Augmentation files compiled after "*.pri" files
+
|Structural files compiled after "*.pri" files
 
|-
 
|-
|class="infoleft"|*.dat
+
|*.dat
|class="infotext"|Data files that are compiled after augmentation files
+
|Data files that are compiled after structural files
 
|-
 
|-
|class="infoleft"|logo.bmp
+
|logo.bmp
|class="infotext"|Bitmap file containing game system logo
+
|Bitmap file containing game system logo
 
|-
 
|-
|class="infoleft"|*.bmp
+
|*.bmp
|class="infotext"|Image files used for buttons, textures, etc.
+
|Image files used for buttons, textures, etc.
 
|-
 
|-
|class="infoleft"|*.hlz
+
|*.hlz
|class="infotext"|Compiled files used by HL at run-time
+
|Compiled files used by HL at run-time
 
|-
 
|-
|class="infoleft"|faq.htm
+
|faq.htm
|class="infotext"|HTML file containing the FAQ for the data files that is generated when the data files are compiled
+
|HTML file containing the FAQ for the data files that is generated when the data files are compiled
 
|-
 
|-
|class="infoleft"|manual.htm
+
|manual.htm
|class="infotext"|Manual with specifics on using the data files for the game system (file name may be different)
+
|Manual with specifics on using the data files for the game system (file name may be different)
 
|-
 
|-
|class="infoleft"|timing.xml
+
|timing.xml
|class="infotext"|Timing dependency and error report generated whenever the data files are compiled
+
|Timing dependency and error report generated whenever the data files are compiled
 
|-
 
|-
|class="infoleft"|unused.xml
+
|unused.xml
|class="infotext"|Report of unused resources and styles that is generated when the data files are compiled
+
|Report of unused resources and styles that is generated when the data files are compiled
 
|}
 
|}

Latest revision as of 22:07, 26 November 2008

Context: HL KitBasic Concepts and Terminology … The Physical Files 

Beneath the directory where you installed HL is a directory named "data". If you installed HL to the default location, this directory will be located at "C:\HeroLab\data". All HL data files reside in sub-directories beneath the "data" directory, with all of the data files for each game system being grouped together within a sub-directory named appropriately for that game system. For example, all of the data files for the d20 System will be found in the "d20" sub-directory, or "C:\HeroLab\data\d20" if you installed HL to the default location.

Within a game system directory, there will be an assortment of files with a variety of names. Here is a summary of the various files that will be found and their purpose.

config.cfg Configuration file that provides details when package files are used
*.pkg Package files
definition.def Definition file that is compiled before anything else
*.1st Structural files that are compiled first
*.core Structural files compiled after "*.1st" files
*.str Structural files compiled after "*.pri" files
*.aug Structural files compiled after "*.pri" files
*.dat Data files that are compiled after structural files
logo.bmp Bitmap file containing game system logo
*.bmp Image files used for buttons, textures, etc.
*.hlz Compiled files used by HL at run-time
faq.htm HTML file containing the FAQ for the data files that is generated when the data files are compiled
manual.htm Manual with specifics on using the data files for the game system (file name may be different)
timing.xml Timing dependency and error report generated whenever the data files are compiled
unused.xml Report of unused resources and styles that is generated when the data files are compiled