# Out-of-Cycle (OOC) Data Set Install Files

The OOC data set installation capability has been added to PCGen to allow for the distribution of those data sets released between stable releases. This page presents instructions for the creation of the OOC data set installation archive. You will also find the explanation of the tags required to create the install.lst file as well as an example install file. To accomplish this, this page is divided into three sections:

OOC Data Set Preparation

Data Set Installation Tags

Example install.lst File

For information on installing OOC data sets in PCGen go to the Install Data Set Tool page.

## Data Set Preparation

The following are the steps required to prepare a data set for OOC release:

1. Create a data set as per PCGen's standard process, including all required reviews. (e.g. OGL, QC, and publisher.)
2. Create the install.lst file. (See example and Tag Descriptions below.)
3. Create an installation folder, recreating a nested folder structure identical to that of the final PCGen installation location. The following are a few examples:
   - TestDataSet/data/d20ogl/pcgen/testooc/
   - FooDataSet/data/alpha/foopublishing/foosetting/
   - BarDataSet/data/permissioned/bargames/barsupplement/
   - MyCampaignDataSet/data/homebrew/mycampaign/
4. Place the OOC data set at the lowest folder level in the installation folder. (ie. in the testdoc folder for the first example above.)
5. Place the install.lst file in the top level folder. (i.e. in the TestDataSet folder in the first example above.)
6. Create a "ZIP" archive of the installation folder.
7. Change the name of the zip-file from *.zip to *.pcz.

The OOC data set is now ready for release.

## Data Set Installation Tags

The tags used in the install.lst file consist of three Exclusive tags and a handful of PCC tags.

### Exclusive Data Set Installation Tags

The following three tags are used exclusively in the install.lst file.

Tag Name: MINVER:x

Variables Used (x): Text (Version number)

What it does:

- Mandatory tag specifying the minimum version of PCGen that will support his dataset.
- Normally this will be based on tags supported in the version of PCGen.
- For the source to be installed by PCGen, the version of PCGen in use must be equal to or greater than this version.
- e.g. a MINVER:5.14.1 value would mean that the source could not be installed by 5.14.0, but could be installed by 5.14.1 or 5.16.0

Example:

`MINVER:5.14.1`

This dataset requires PCGen prodiction version 5.14.1 or later.

Tag Name: MINDEVVER:x

Variables Used (x): Text (Version number)

What it does:

- Optional tag specifying the minimum development version of PCGen that will support this dataset, where this is later than the production version.
- This would be used where a tag was added partway through a dev cycle and then retrofitted to the next patch release of PCGen.
- For the source to be installed by PCGen, the version of PCGen must either:
  - Have an even minor version (as in 5.x.y, where x is even indicating a production release) and be greater than or equal to the MINVER value; or
  - Have an odd minor version (as in 5.x.y, where x is odd indicating a development release) and be greater than or equal to the MINDEVVER value.
  - e.g. Given `MINVER:5.14.1` and `MINDEVVER:5.15.3`, the source could not be installed by 5.15.2, but could be installed by 5.14.1 or 5.15.3

Example:

`MINDEVVER:5.15.2`

This dataset requires PCGen developer version 5.15.2 or later.

Tag Name: DEST:x

Variables Used (x): Text (DATA or VENDORDATA)

What it does:

- The recommended install path for the source.
- Sources installed in the Data folder will be replaced in the next release of PCGen.
- Sources installed in Vendor Data will be retained through an upgrade process.

Example:

`DEST:DATA`

The dataset will be installed within the DATA folder in PCGen.

### Additional Source and Header Information Tags

The following tags are used in the *.pcc file and are therefore documented as part of the PCC file documentation.

Tag Name: CAMPAIGN:x

Example:

`CAMPAIGN:FGI - FooB Core Rulebook I - FHB`

Tag Name: COPYRIGHT:x

Example:

`COPYRIGHT:PCGen OGC dataset Copyright 2006, PCGen Data team (Including, but not limited to Eddy Anthony (MoSaT), Andrew McDougall (Tir Gwaith)).`

Tag Name: INFOTEXT:x

Example:

`INFOTEXT:PCGen Open Gaming Content objects are detailed in the PCGen documentation under the Source Help section`

Tag Name: PUBNAMELONG:x

Example:

`PUBNAMELONG:PCGen Open Source Team`

Tag Name: PUBNAMESHORT:x

Example:

`PUBNAMESHORT:PCGen`

Tag Name: PUBNAMEWEB:x

Example:

`PUBNAMEWEB:http://pcgen.sourceforge.net/`

Tag Name: SOURCELONG:x

Example:

`SOURCELONG:PCGen Test Out of Cycle Releases`

Tag Name: SOURCESHORT:x

Example:

`SOURCESHORT:PCGen TOCC`

Tag Name: SOURCEWEB:x

Example:

`SOURCEWEB:http://pcgen.sourceforge.net/`

Tag Name: SOURCEDATE:x

Example:

`SOURCEDATE:2007-12`

## Example Install File

The following is an example of an install.lst file.

> `CAMPAIGN:PCGen Test OCC`

> `MINVER:5.14.1`

> `MINDEVVER: 5.15.2`

> `DEST:VENDORDATA`

> `COPYRIGHT:Open Game License v 1.0a Copyright 2000, Wizards of the Coast, Inc.`

> `COPYRIGHT:System Reference Document Copyright 2000-2003, Wizards of the Coast, Inc.; Authors Jonathan Tweet, Monte Cook, Skip Williams, Rich Baker, Andy Collins, David Noonan, Rich Redman, Bruce R. Cordell, John D. Rateliff, Thomas Reid, James Wyatt, based on original material by E. Gary Gygax and Dave Arneson.`

> `COPYRIGHT:PCGen OGC dataset Copyright 2006, PCGen Data team (Including, but not limited to Eddy Anthony (MoSaT), Andrew McDougall (Tir Gwaith)).`

> `INFOTEXT:PCGen Open Gaming Content objects are detailed in the PCGen documentation under the Source Help section`

> `SOURCELONG:PCGen Test Out of Cycle Releases`

> `SOURCESHORT:PCGen TOCC`

> `SOURCEWEB:http://pcgen.sourceforge.net/`

> `SOURCEDATE:2007-12`

> `PUBNAMELONG:PCGen Open Source Team`

> `PUBNAMESHORT:PCGen`

> `PUBNAMEWEB:http://pcgen.sourceforge.net/`