Pcc Tag - PCGen Documentation

# Pages in Pcc Tag

## ABILITYCATEGORY (Data: campaign.pcc)

Status None Syntax ABILITYCATEGORY:x Parameters x: Text (File path) *** New 5.13.5 What it does Tells PCGen to load the abilitycategory list file specified. The abilitycategory list file is optional and is used as part of the source dataset to define dataset specific ability categories. Example ABILITYCATEGORY:myabilitycategories.lst

## ABILITYPCC (Data: campaign.pcc)

Status None Syntax ABILITY:x Parameters x: Text (File path) *** New 5.11.1 What it does Tells PCGen to load the Ability list file specified. See INCLUDE and EXCLUDE for more information on the use of these sub-tags with the ABILITY tag. Example ABILITY:specialabilities.lst

## ALLOWDUPES (Data: campaign.pcc)

Status New 5.15.10 Syntax ALLOWDUPES:x Parameters x: LANGUAGE x: SPELL What it does Suppresses the “Duplicate Object” error messages for the listed LST object type. This tag will only work if the PCC file it is contained in is the exact PCC file selected by the user. Examples ALLOWDUPES:SPELL Duplicate spells loaded by the user selected PCC files will be allowed.

## ARMORPROF (Data: campaign.pcc)

Status None Syntax ARMORPROF:x Parameters x: Text (File path) What it does Tells PCGen to load the armor proficiencies list file specified. Example ARMORPROF:fooarmorproflight.lst Load the armor proficiencies fooarmorproflight.lst file. ARMORPROF:fooarmorproflight.lst.FORGET Forgets to load the armor proficiencies fooarmorproflight.lst file.

## BIOSET (Data: campaign.pcc)

Status None Syntax BIOSET:x Parameters x: Text (File path) What it does Tells PCGen to load the biosettings list file specified. Example BIOSET:biosettings.lst

## BOOKTYPE (Data: campaign.pcc)

Status None Syntax BOOKTYPE:x|x Parameters x: Text (Book type) *** Updated 6.1.1 What it does This tells PCGen what the book types are. The book types identified by this tag can be used as a prerequisite for loading data sets. See the PRECAMPAIGN tag docs for more information. Example BOOKTYPE:Supplement The source data set that this PCC file represents is a “Supplement”. BOOKTYPE:Supplement|Traits The source data set that this PCC file represents is a “Supplement” and also provides the basics for Traits rules.

## CAMPAIGN (Data: campaign.pcc)

Status None Syntax CAMPAIGN:x Parameters x: Text (Name of source) What it does This MUST be the first line in the file. The standard format used is Company Short Name (Foo) - Campaign Name - Name of material The use of the ampersand (&) sign will cause significant problems with PCGen, so recommended usage is to replace with the word “and” or the letter “n” to avoid this. NOTE: The comma (,) should not be used in campaign names.

## CLASS (Data: campaign.pcc)

Status None Syntax CLASS:x Parameters x: Text (File path) What it does Tells PCGen to load the classes list file specified. Example CLASS:fhbclasses.lst

## COMPANIONMOD (Data: campaign.pcc)

Status None Syntax COMPANIONMOD:x Parameters x: Text (File path) What it does Tells PCGen to load the companion modifiers list file specified. Example COMPANIONMOD:foocompanionmods.lst

## COPYRIGHT (Data: campaign.pcc)

Status None Syntax COPYRIGHT:x Parameters x: Text (Copyright information) What it does Used to display copyright information when a source is selected in the source selection page. Sources included with PCGen should have the copyright information from section 15 of the Open Game License included in the source reproduced verbatim. An additional entry should be made listing all who worked on the PCGen conversion in the format shown below. Example COPYRIGHT:PCGen dataset conversion for "X Book" Copyright XXXX-YYYY, PCgen Data Team including, but not limited to, "Original Author", "Any secondary authors".

## COVER (Data: campaign.pcc)

Status None Syntax COVER:x Parameters x: Text (Image file path) *** New 5.9.7 What it does Tells PCGen to load the image file specified. The image is displayed in the Source Tab in the Source Info panel when the dataset is selected. Example COVER:foohandbookcover.jpg

## DEITY (Data: campaign.pcc)

Status None Syntax DEITY:x Parameters x: Text (File path) What it does Tells PCGen to load the deities list file specified. Example DEITY:foodeities.lst

## DESC (Data: campaign.pcc)

Status None Syntax DESC:x Parameters x: Text (Information) *** New 5.13.9 What it does Provides text information that is displayed in the Source Information Panel, on the Source Tab, when the source material is selected. This tag shall be used only once per pcc. This text will appear just below the cover image (if there is one) or the CAMPAIGN header (if there is no cover image). The text is a short description of the selected source such as one might find at amazon.com or other book/pdf seller.

## DOMAIN (Data: campaign.pcc)

Status None Syntax DOMAIN:x Parameters x: Text (File path) What it does Tells PCGen to load the domains list file specified. Example DOMAIN:foodomains.lst

## EQUIPMENT (Data: campaign.pcc)

Status None Syntax EQUIPMENT:x Parameters x: Text (File path) What it does Tells PCGen to load the equipment list file specified. Examples EQUIPMENT:fooallequip.lst EQUIPMENT:fooequiparmorsshields.lst

## EQUIPMOD (Data: campaign.pcc)

Status None Syntax EQUIPMOD:x Parameters x: Text (File path) What it does Tells PCGen to load the equipment modifiers list file specified. Example EQUIPMOD:fooequipmods.lst

## EXCLUDE (Data: campaign.pcc)

Status None Syntax (EXCLUDE:y|y) Parameters x: Text (Ability category) y: Text (LST object name) Tag Name: (EXCLUDE:CATEGORY=x,y,y|x,y,y) - Special syntax for feats and abilities What it does The EXCLUDE tag and its arguments are enclosed within a pair of parentheses. The tag will prevent the pipe-delimited list of LST objects from being loaded from the LST file the tag is associated with. The tag will not prevent other .pcc files from loading the same LST file.

## FEAT (Data: campaign.pcc)

Status None Syntax FEAT:x Parameters x: Text (File path) Status: 6.05.04 (July 2015): JIRA NEWTAG-477 / Github PR #380 The FEAT file is deprecated. Use ABILITY instead. All FEAT tags have been deprecated and replaced by the ABILITY system, which is more general. The ABILITY system can model feats, racial features, class features, traits, flaws, temporary bonuses, and so on, all using a common format. What it does Tells PCGen to load the feats list file specified.

## FORWARDREF (Data: campaign.pcc)

Status New 5.15.10 Syntax FORWARDREF:x|y,y Parameters x: ABILITY=Text (Ability category) x: ARMORPROF x: CLASS x: DEITY x: DOMAIN x: EQMOD x: EQUIPMENT x: FEAT x: LANGUAGE x: RACE x: SHIELDPROF x: SKILL x: SPELL x: TEMPLATE x: WEAPONPROF x: CLASSSKILLLIST x: CLASSSPELLLIST x: DOMAINSPELLLIST y: Text (Object name) What it does This tag will suppress the “Unconstructed Object” error reports for the listed LST objects from appearing within the user interface.

## GAMEMODE (Data: campaign.pcc)

Status None Syntax GAMEMODE:x Parameters x: Text (Name of GameMode) What it does This MUST be 2nd in the file. This tells PCGen what genre this is in PCGen and must be entered exactly as shown. The GAMEMODE tag is case-sensitive. Examples GAMEMODE:3e This PCC file uses the Third Edition SRD gamemode.

## GENRE (Data: campaign.pcc)

Status None Syntax GENRE:x Parameters x: Text (Genre) What it does This tells PCGen what genre this is. Eventually This will be used to filter sources. Example GENRE:Fantasy

## HELP (Data: campaign.pcc)

Status None Syntax HELP:x Parameters x: Text (Internet address) What it does Provides an internet link to a web page for help with the source. The link can be accessed in the GUI by right clicking the source name in the source tab and selecting “Product Help…”. Example HELP:http://www.foogames.com/producthelp.html

## HIDETYPE (Data: campaign.pcc)

Status None Syntax HIDETYPE:x|y|y Parameters x: EQUIP (Equipment Types will be hidden) x: FEAT (Feat Types will be hidden) x: SKILL (Skill Types will be hidden) y: Text (Type to be hidden) *** New 5.9.1 What it does This tag will prevent the listed Types from appearing within the user interface while allowing it to be used internally by PCGen. This is useful when types need to be added for internal purposes but it is not desirable to have the type show in the GUI.

## INCLUDE (Data: campaign.pcc)

Status None Syntax (INCLUDE:y|y) Parameters x: Text (Ability category) y: Text (LST object name) Tag Name: (INCLUDE:CATEGORY=x,y,y|x,y,y) - Special syntax for feats and abilities What it does The INCLUDE tag and its arguments are enclosed within a pair of parentheses. The tag will add the pipe-delimited list of LST objects from the LST file the tag is associated with. The tag will not prevent other .pcc files from loading the same LST file.

## INFOTEXT (Data: campaign.pcc)

Status None Syntax INFOTEXT:x Parameters x: Text (Information) What it does Provides Text information that is displayed in the Information Window on the Source Tab when the source material is selected. Multiple INFOTEXT tags may be used in a PCC file with each INFOTEXT tag starting a new line of text. Example INFOTEXT:This pcc loads all the Foo source materials minus the FooWorld races Displays the text “This pcc loads

## ISLICENSED (Data: campaign.pcc)

Status None Syntax ISLICENSED:x Parameters x: Boolean (YES or NO) *** New 5.3.3 What it does Used to indicate if sources have a special license, and activated the LICENSE tag, which will display information about the license to the end-user. Examples ISLICENSED:YES ISLICENSED:NO Default Value: NO

## ISMATURE (Data: campaign.pcc)

Status None Syntax ISMATURE:x Parameters x: Boolean (YES or NO) What it does This tag is so that we have the ability to include datasets based upon sources of a more mature nature. If ISMATURE:YES then the following info gets inserted into a pop-up window “This dataset contains content of a mature nature. User discretion is advised.” This tag is optional. Examples ISMATURE:YES Causes a pop-up to fire saying “This dataset contains content of a mature nature.

## ISOGL (Data: campaign.pcc)

Status None Syntax ISOGL:x Parameters x: Boolean (YES or NO) What it does Used to indicate if sources are OGL compliant. If ISOGL:YES then its COPYRIGHT info gets inserted into the OGL license. This tag is optional. Examples ISOGL:YES ISOGL:NO Default Value: NO

## KIT (Data: campaign.pcc)

Status None Syntax KIT:x Parameters x: Text (File path) What it does Tells PCGen to load the starting kits list file specified. Example KIT:foostartingkits.lst

## LANGUAGE (Data: campaign.pcc)

Status None Syntax LANGUAGE:x Parameters x: Text (File path) What it does Tells PCGen to load the languages list file specified. Example LANGUAGE:foolanguages.lst

## LICENSE (Data: campaign.pcc)

Status None Syntax LICENSE:x Parameters x: Text (License information) x: FILE=Text (HTML file) *** New 5.3.3 What it does Displays special license information in a pop-up at time of source load. Requires a ISLICENSED:YES tag to be active. Examples LICENSE:This set included with special permission from Foo Games Would display the text in a nice box with other licenses. LICENSE:FILE=foolicense.html Doing a FILE= allows PCC to point to an HTML formatted file, which will display in a box of its own.

## LOGO (Data: campaign.pcc)

Status None Syntax LOGO:x Parameters x: Text (Image file path) *** New 5.13.9 What it does Tells PCGen to load the image file specified. The image is displayed in the Source Tab in the Source Info panel when the dataset is selected. The image represents the publishers “logo” with multiple datasets, from the same publisher, referencing the same image. Example LOGO:../barcompanylogo.jpg

## LSTEXCLUDE (Data: campaign.pcc)

Status None Syntax LSTEXCLUDE:x|x Parameters x: Text (File names) What it does This is a | (pipe) delimited tag which allows you to customize which LST files are loaded. This must be before PCC/LST file INCLUDE statements if used. All of the files listed will NOT be loaded, even if referenced later by other included PCC files. The LST file list can be a single LST filename per entry, or can be separated by the “|” (pipe) character.

## OPTION (Data: campaign.pcc)

Status None Syntax OPTION:x Parameters x: Text (Option) What it does Specifies an option which should be set when the campaign is loaded. The format is the same as in the options.ini or legacy.ini files. For options from legacy.ini only the pcgen.options lines may be used and they need to have the pcgen.options. part removed from their key when provided here. The user can stop these options from being set by unselecting the PCGen -> Sources -> Allow options to be set by sources setting in the Preferences dialog.

## PCC (Data: campaign.pcc)

Status None Syntax PCC:x Parameters x: Text (File path) What it does Tells PCGen to load additional pcc files along with the current pcc file. If the campaign file to be loaded by this tag isn’t located in the same folder as the current campaign file then file path must be included. The @ symbol used at the beginning of the file path will set the data folder as the top folder in the path.

## PRECAMPAIGN (Data: campaign.pcc)

Status Updated 6.01.02 Syntax PRECAMPAIGN:x,y,y Parameters x: Number (Number of items required to pass) y: Text (Data set name as set by the CAMPAIGN tag). y: BOOKTYPE=Text (Matches data set BOOKTYPE tag). y: INCLUDES=Text (Data set name as set by the CAMPAIGN tag that is included in any selected campaign or one of its included sources). y: INCLUDESBOOKTYPE=Text (Data set BOOKTYPE of any selected campaign or one of its included sources).

## PUBNAMELONG (Data: campaign.pcc)

Status None Syntax PUBNAMELONG:x Parameters x: Text (Long name of publisher) *** New 4.3.10 What it does The Publisher’s full name. Example PUBNAMELONG:Foo Games, Inc.

## PUBNAMESHORT (Data: campaign.pcc)

Status None Syntax PUBNAMESHORT:x Parameters x: Text (Short name of publisher) *** New 4.3.10 What it does The Publisher’s abbreviated name (usually their initials). Example PUBNAMESHORT:FGI

## PUBNAMEWEB (Data: campaign.pcc)

Status None Syntax PUBNAMEWEB:x Parameters x: Text (Web link) *** New 4.3.10 What it does The Publisher’s website/URL. Example PUBNAMEWEB:http://www.foogames.com/index.php

## RACE (Data: campaign.pcc)

Status None Syntax RACE:x Parameters x: Text (File path) What it does Tells PCGen to load the races list file specified. Example RACE:fooraces.lst

## RANK (Data: campaign.pcc)

Status None Syntax RANK:x Parameters x: Number (Rank) *** Updated 5.12 RC3 What it does Sets the priority in loading .pcc files. 1 is the highest priority and 9 is the lowest priority for loading .pcc files. When PCGen encounters certain objects with duplicate names from different sources (such as Classes) the object in the source with the highest priority rank will be loaded while the duplicate will generate an error message (and will not be loaded).

## REQSKILL (Data: campaign.pcc)

Status None Syntax REQSKILL:x Parameters x: ALL or REQSKILL:ALL or UNTRAINED or REQSKILL:UNTRAINED or Text What it does A “|” (pipe) delimited list can include: UNTRAINED - all untrained skills will be automatically included on any character as if the skill had the REQ tag (see skill.lst for details); ALL - all skills will have the REQ tag, or; a list of specified skill names. If this tag is included it should be after the SKILL: tag.

## SETTING (Data: campaign.pcc)

Status None Syntax SETTING:x Parameters x: Text (Setting) What it does This tells PCGen what the setting is (if there is one). Eventually This will be used to filter sources. Example SETTING:Ravenloft

## SHIELDPROF (Data: campaign.pcc)

Status None Syntax SHIELDPROF:x Parameters x: Text (File path) What it does Tells PCGen to load the shield proficiencies list file specified. Example SHIELDPROF:fooshieldproflight.lst Load the shield proficiencies fooshieldproflight.lst file. SHIELDPROF:fooshieldproflight.lst.FORGET Forgets to load the shield proficiencies fooshieldprofsimple.lst file.

## SHOWINMENU (Data: campaign.pcc)

Status None Syntax SHOWINMENU:x Parameters x: Boolean (YES or NO, TRUE or FALSE also accepted) Example SHOWINMENU:YES What it does When set to YES, this tag tells PCGen to display this campaign in the Settings -> Campaigns menu. When selected, it will unload all other campaigns, and load this campaign. It will also set any options listed in the PCC file. It will appear in a submenu of its gamemode.

## SKILL (Data: campaign.pcc)

Status None Syntax SKILL:x Parameters x: Text (File path) What it does Tells PCGen to load the skills list file specified. Example SKILL:fooskills.lst

## SOURCEDATE (Data: campaign.pcc)

Status None Syntax SOURCEDATE:x Parameters x: Date (Release date of source in format YYYY-MM) *** New 5.9.5 What it does Allows PCGen to determine which of two sources is newer. A source without this tag will be considered older than a source with a set date. There is a preference which must be checked to activate this feature. In Preferences/PCGen/Sources check the box for “Allow newer sources to override duplicate object from older sources”.

## SOURCELONG (Data: campaign.pcc)

Status None Syntax SOURCELONG:x Parameters x: Text (Long name of source) *** Updated 4.3.10 What it does The full product/book name. Example SOURCELONG:Core Rulebook I (Foo Handbook) The long source name for this file is “Core Rulebook I (Foo Handbook)”.

## SOURCESHORT (Data: campaign.pcc)

Status None Syntax SOURCESHORT:x Parameters x: Text (Short name of source) *** Updated 4.3.10 What it does The short product/book name. Example SOURCESHORT:FHB The short source name for this file is “FHB”.

## SOURCEWEB (Data: campaign.pcc)

Status None Syntax SOURCEWEB:x Parameters x: Text (Web address) *** Updated 4.3.10 What it does The URL that points directly to this product/book. Example SOURCEWEB:http://www.foogames.com/product.php?products=654321 The web site for this source is “SOURCEWEB:http://www.foogames.com/product.php?products=654321".

## SPELL (Data: campaign.pcc)

Status None Syntax SPELL:x Parameters x: Text (File path) What it does Tells PCGen to load the spells list file specified. Example SPELL:foospells.lst

## STATUS (Data: campaign.pcc)

Status New 5.17.4 Syntax STATUS:x Parameters x: RELEASE (Default) x: ALPHA x: BETA x: TESTONLY What it does Defines the development status of a dataset. Example STATUS:RELEASE This dataset has been approved as release quality. STATUS:ALPHA This dataset is a work in progress, use it at your own risk. STATUS:BETA This dataset is finished, but not yet approved as release quality. STATUS:TESTONLY This data is set of internal testing use only.

## TEMPLATE (Data: campaign.pcc)

Status None Syntax TEMPLATE:x Parameters x: Text (File path) What it does Tells PCGen to load the template list file specified. Example TEMPLATE:footemplates.lst

## TYPE (Data: campaign.pcc)

Status None Syntax TYPE:x.x - See globalTYPEfor more information Parameters

## URL (Data: campaign.pcc)

Status None Syntax URL:x|y|z Parameters x: Text (E-commerce site name. i.e. Amazon, DriveThruRPG, etc.) x: WEBSITE x: SURVEY y: Text (Hypertext link) z: Text (Link description) *** New 5.13.9 What it does Specifies the URL for hyper-links that will be displayed in the Source Tab in the Source Info panel when the dataset is selected. Multiple HYPERLINK tags may be entered into the *.pcc file. Example URL:Barcommerce|http://www.barcommercesite.com/product_info.php?products_id=12345&affiliate_id=54321|Support PCGen by buying this source now!

## WEAPONPROF (Data: campaign.pcc)

Status None Syntax WEAPONPROF:x Parameters x: Text (File path) What it does Tells PCGen to load the weapon proficiencies list file specified. Example WEAPONPROF:fooweapprofsimple.lst Load the weapons proficiencies fooweapprofsimple.lst file.

Documentation built with Hugo using the Material theme.