Difference between revisions of "Pathfinder RPG Data Standards for PCC Files"

From PCGen Wiki
Jump to: navigation, search
(Created page with 'This is how a PCC file for a data set for the Pathfinder RPB should look, with all the necessary tags present and in a well-defined order == PCC File == # CVS $Revision: <rev> $…')
 
Line 1: Line 1:
This is how a PCC file for a data set for the Pathfinder RPB should look, with all the necessary tags present and in a well-defined order
+
This is how a PCC file for a data set for the Pathfinder RPG should look, with all the necessary tags present and in a well-defined order
  
 
== PCC File ==
 
== PCC File ==
# CVS $Revision: <rev> $ $Author: <name> $ -- Sat Dec  8 13:05:34 2007
+
# CVS $Revision: ''<rev>'' $ $Author: ''<name>'' $ -- Sat Dec  8 13:05:34 2007 -- reformated by prettylst.pl v1.38 (build 4387)
-- reformated by prettylst.pl v1.38 (build 4387)
+
This line is updated by subversion with details about the last commit
* This line is updated by subversion with details about the last commit
 
  
#CAMPAIGN:
+
CAMPAIGN:
* This line contains the name of the data source and should be
+
This line contains the name of the data source and should always be begin with "Paizo - ", followed by:
  constructed from the following parts, separated by dashes:
+
*If the book is a Pathfinder RPG book, prefix the book name with "Pathfinder RPG" (e.g. "Pathfinder RPG Core Rulebook")
* First, the short name of the publisher, i.e. "Paizo".
+
*If the book is an Adventure Path, the second part should be "Name of Adventure Path, Chapter X: Name of Adventure". (e.g. "Rise of the Runelords, Chapter 1: Burnt Offerings")
* If the book is a Pathfinder RPG book, prefix the name with
+
*For Adventure Path player guides, use "Name of Adventure Path Player's Guide" (e.g. "Rise of the Runelords Player's Guide")
  "Pathfinder RPG"
+
*In all other cases use only the name of the book, without the product line name.
* If the book is an Adventure Path, the second part should be
 
  "Name of Adventure Path, Chapter X: Name of Adventure".
 
* For Adventure Path player guides, use
 
  "Name of Adventure Path Player's Guide".
 
* On other cases use only the name of the book, without the product
 
  line name.
 
* If the book was originally published for the 3.5 rules, and this data
 
  set is a Pathfinder RPG conversion, append "(Pathfinder Conversion)".
 
  
GAMEMODE:Pathfinder
+
GAMEMODE:Pathfinder
* This is straightforward, the name of the game mode for the Pathfinder
+
* This is straightforward, the name of the game mode for the Pathfinder RPG.
  RPG.
 
  
TYPE:
+
TYPE:
* This line builds the tree in the sources panel. The first part should
+
This line builds the tree in the advanced sources panel. The first part should always be "Paizo Publishing". The second part, separated by a dot, should be the product  line. Current product lines are:
  always be "Paizo Publishing". The second part should be the product
+
*"Pathfinder Adventure Path" (note the singular!)
   line. Current product lines are "Pathfinder Adventure Path" (note the
+
*"Pathfinder Chronicles" (soon to be renamed "Pathfinder Campaign Setting")
  singular!), "Pathfinder Chronicles" (soon to be renamed "Pathfinder
+
*"Pathfinder Companion (soon to be renamed "Pathfinder Player Companion")
  Campaign Setting"), Pathfinder Companion (soon to be renamed
+
*"Pathfinder Module" (includes the previous name of this Line, "GameMastery Module"
  "Pathfinder Player Companion"), "Pathfinder Module", and "Pathfinder
+
*"Pathfinder Roleplaying Game".
  Roleplaying Game". The first and second parts are separated be a dot.
 
  
RANK:
+
RANK:
* This is easy. The core rules get rank 1, everything else from Paizo
+
* This is easy. The core rules get rank 1, campaign setting books form Paizo get rank 2, everything else should be rank 3.
  should be rank 3.
 
  
GENRE:Fantasy
+
GENRE:Fantasy
  
BOOKTYPE:Supplement
+
BOOKTYPE:Supplement
* Similar to rank. The core rules are "Core Rules", everything else is a
+
* Similar to rank. The core rules are "Core Rules", campaign setting books are "Campaign Setting", everything else is a "Supplement".
  "Supplement".
 
  
SETTING:Pathfinder Chronicles
+
SETTING:Pathfinder Chronicles
  
PRECAMPAIGN:1,BOOKTYPE=Core Rules
+
PRECAMPAIGN:1,BOOKTYPE=Core Rules
* This line should be present in all data set. If the data set uses
+
This line should be present in all data set. If the data set uses character traits, add the following line too:
  character traits, add the following line too:
+
PRECAMPAIGN:1,Paizo - Pathfinder RPG Character Traits Web Enhancement,Paizo - Pathfinder RPG Advanced Player's Guide
* PRECAMPAIGN:1,Paizo - Pathfinder RPG Character Traits Web
+
Dependencies on other data sets, like Campaing Settings and Adventure Path player guides are also possible.
Enhancement,Paizo - Pathfinder RPG Advanced Player's Guide
 
* Dependencies on other data sets, like Campaing Settings and Adventure
 
  Path player guides are also possible.
 
  
PUBNAMELONG:Paizo Publishing
+
PUBNAMELONG:Paizo Publishing
PUBNAMESHORT:Paizo
+
PUBNAMESHORT:Paizo
PUBNAMEWEB:http://paizo.com
+
PUBNAMEWEB:http://paizo.com
  
SOURCELONG:
+
SOURCELONG:
* This should be the name of the book, without the product line,
+
This should be the name of the book, without the product line, similar to the second part of the CAMPAIGN tag.
  similar to the second part of the CAMPIGN tag.
 
  
SOURCESHORT:
+
SOURCESHORT:
* This is an abbreviation of the book. Pathfinder Adventure Path issues
+
This is an abbreviation of the book. Pathfinder Adventure Path issues should use PF''number'' (with ''number'' replaced by the issue number, e.g. "PF1"). In most other cases, this abbreviation should consist of the first letters of the words in the name, omitting words like "the", "a", or "of".
  should use PF## (with ## replaced by the issue number). In most other
 
  cases, this abbreviation should consist of the first letters of the
 
  Words in the name, omitting words like "the", "a", or "of".
 
  
SOURCEWEB:
+
SOURCEWEB:
* The web page of the product at paizo.com
+
The product page of the product at paizo.com.
  
SOURCEDATE:
+
SOURCEDATE:
* Publication date in format YYYY-MM
+
Publication date in format YYYY-MM
  
ISOGL:YES
+
ISOGL:YES
ISLICENSED:NO
 
  
COPYRIGHT:
+
''empty line''
* This contains all the lines from the book's OGL section 15, one tag
 
  per line. Replace all occurrences of the copyright sign and "(c)"
 
  with the word "Copyright".
 
* If the book was originally published for the 3.5 rules, and this data
 
  set is a Pathfinder RPG conversion, add the following line (with
 
  <year> representing the current year, and <name> replaced by a list
 
  of all developers working on the data set):
 
  COPYRIGHT:Pathfinder RPG Conversion Copyright 2009-<year>, PCGen Data
 
Team (including, but not limited to, <name>)
 
* Finally, add the following line (replacing <book> with the book name
 
  (see SOURCELONG), <pubyear> with the name of publication of the book,
 
  and <year> with the current year. If both years are the same, just
 
  put it once)
 
  COPYRIGHT:PCGen dataset conversion for "<book>" Copyright
 
<pubyear>-<year>, PCGen Data Team (including, but not limited to <name>)
 
  
INFOTEXT:This dataset uses trademarks and/or copyrights owned by Paizo
+
COVER:
Publishing, LLC, which are used under Paizo's Community Use Policy. We
+
* This should refer to a JPG picture of the book cover, as shown on paizo.com, resized to a height of 150 pixels. The name of the picture file should be the same as the PCC file, only with ".jpg" as extension.
are expressly prohibited from charging you to use or access this
 
content. This dataset is not published, endorsed, or specifically
 
approved by Paizo Publishing. For more information about Paizo's
 
Community Use Policy, please visit paizo.com/communityuse. For more
 
information about Paizo Publishing and Paizo products, please visit
 
paizo.com.
 
  
COVER:
+
LOGO:@/publisher_logos/Paizo_Publishing.png
* This should refer to a JPG picture of the book cover, as shown on
+
URL:WEBSITE|http://www.paizo.com/|Visit Paizo Publishing!
  paizo.com, resized to a height of 150 pixels. The name of the picture
+
URL:WEBSITE|http://www.paizo.com/communityuse|Paizo's Community Use Policy.
  should be the same as the PCC file, only with ".jpg" as extension.
+
URL:Paizo Publishing|''<url>''|Get this publication from Paizo Publishing!
 +
Replace <url> with the same URL as SOURCEURL.
  
LOGO:@/publisher_logos/Paizo_Publishing.png
+
DESC:
URL:WEBSITE|http://www.paizo.com/|Visit Paizo Publishing!
+
The description of the book, ideally copied from the product page at paizo.com.
URL:WEBSITE|http://www.paizo.com/communityuse|Paizo's Community Use Policy.
 
  
URL:Paizo Publishing|<url>|Get this publication from Paizo Publishing!
+
''empty line''
* Replace <url> with the same URL as SOURCEURL
 
  
DESC:
+
INFOTEXT:This dataset uses trademarks and/or copyrights owned by Paizo Publishing, LLC, which are used under Paizo's Community Use Policy. We are expressly prohibited from charging you to use or access this content. This dataset is not published, endorsed, or specifically approved by Paizo Publishing. For more information about Paizo's Community Use Policy, please visit paizo.com/communityuse. For more information about Paizo Publishing and Paizo products, please visit paizo.com.
* The description of the book, ideally copied from the product page at
+
*If the book was originally published for the 3.5 rules, and this data set is a Pathfinder RPG conversion, add the following line immediately ''before'' the previous INFOTEXT line:
  paizo.com.
+
INFOTEXT:This dataset implements rules from a book that was originally designed for the 3.5 ruleset. For this dataset, these rules have been updated to the rules of the Pathfinder RPG by the PCGen data team.
  
# Do not remove the EXTRAFILE comment.
+
''empty line''
#EXTRAFILE:OGL.txt
 
  
# Data Files
+
COPYRIGHT:
* Here follow the data file tags
+
This contains all the lines from the book's OGL section 15, one tag per line. Replace all occurrences of the copyright sign and "(c)" with the word "Copyright".
 +
*If the book was originally published for the 3.5 rules, and this data set is a Pathfinder RPG conversion, add the following line (replacing ''<year>'' with the current year and ''<name>'' with a list of all developers working on the rules conversion):
 +
COPYRIGHT:Pathfinder RPG Conversion Copyright 2009-''<year>'', PCGen Data Team (including, but not limited to, ''<name>'')
 +
*Finally, add the following line (replacing ''<book>'' with the book name (see SOURCELONG), ''<pubyear>'' with the publication year of the book, ''<year>'' with the current year, and ''<name>'' with a list of all developers working on the data set. If both years are the same, just put it once):
 +
COPYRIGHT:PCGen dataset conversion for "<book>" Copyright ''<pubyear>''-''<year>'', PCGen Data Team (including, but not limited to ''<name>'')
 +
 
 +
''empty line''
 +
 
 +
# Do not remove the EXTRAFILE comment.
 +
#EXTRAFILE:OGL.txt
 +
 
 +
''empty line''
 +
 
 +
# Data Files
 +
Here follow the data file tags.

Revision as of 11:21, 8 July 2010

This is how a PCC file for a data set for the Pathfinder RPG should look, with all the necessary tags present and in a well-defined order

PCC File

# CVS $Revision: <rev> $ $Author: <name> $ -- Sat Dec  8 13:05:34 2007 -- reformated by prettylst.pl v1.38 (build 4387)

This line is updated by subversion with details about the last commit

CAMPAIGN:

This line contains the name of the data source and should always be begin with "Paizo - ", followed by:

  • If the book is a Pathfinder RPG book, prefix the book name with "Pathfinder RPG" (e.g. "Pathfinder RPG Core Rulebook")
  • If the book is an Adventure Path, the second part should be "Name of Adventure Path, Chapter X: Name of Adventure". (e.g. "Rise of the Runelords, Chapter 1: Burnt Offerings")
  • For Adventure Path player guides, use "Name of Adventure Path Player's Guide" (e.g. "Rise of the Runelords Player's Guide")
  • In all other cases use only the name of the book, without the product line name.
GAMEMODE:Pathfinder
  • This is straightforward, the name of the game mode for the Pathfinder RPG.
TYPE:

This line builds the tree in the advanced sources panel. The first part should always be "Paizo Publishing". The second part, separated by a dot, should be the product line. Current product lines are:

  • "Pathfinder Adventure Path" (note the singular!)
  • "Pathfinder Chronicles" (soon to be renamed "Pathfinder Campaign Setting")
  • "Pathfinder Companion (soon to be renamed "Pathfinder Player Companion")
  • "Pathfinder Module" (includes the previous name of this Line, "GameMastery Module"
  • "Pathfinder Roleplaying Game".
RANK:
  • This is easy. The core rules get rank 1, campaign setting books form Paizo get rank 2, everything else should be rank 3.
GENRE:Fantasy
BOOKTYPE:Supplement
  • Similar to rank. The core rules are "Core Rules", campaign setting books are "Campaign Setting", everything else is a "Supplement".
SETTING:Pathfinder Chronicles
PRECAMPAIGN:1,BOOKTYPE=Core Rules

This line should be present in all data set. If the data set uses character traits, add the following line too:

PRECAMPAIGN:1,Paizo - Pathfinder RPG Character Traits Web Enhancement,Paizo - Pathfinder RPG Advanced Player's Guide

Dependencies on other data sets, like Campaing Settings and Adventure Path player guides are also possible.

PUBNAMELONG:Paizo Publishing
PUBNAMESHORT:Paizo
PUBNAMEWEB:http://paizo.com
SOURCELONG:

This should be the name of the book, without the product line, similar to the second part of the CAMPAIGN tag.

SOURCESHORT:

This is an abbreviation of the book. Pathfinder Adventure Path issues should use PFnumber (with number replaced by the issue number, e.g. "PF1"). In most other cases, this abbreviation should consist of the first letters of the words in the name, omitting words like "the", "a", or "of".

SOURCEWEB:

The product page of the product at paizo.com.

SOURCEDATE:

Publication date in format YYYY-MM

ISOGL:YES
empty line
COVER:
  • This should refer to a JPG picture of the book cover, as shown on paizo.com, resized to a height of 150 pixels. The name of the picture file should be the same as the PCC file, only with ".jpg" as extension.
LOGO:@/publisher_logos/Paizo_Publishing.png
URL:WEBSITE|http://www.paizo.com/%7CVisit Paizo Publishing!
URL:WEBSITE|http://www.paizo.com/communityuse%7CPaizo's Community Use Policy.
URL:Paizo Publishing|<url>|Get this publication from Paizo Publishing!

Replace <url> with the same URL as SOURCEURL.

DESC:

The description of the book, ideally copied from the product page at paizo.com.

empty line
INFOTEXT:This dataset uses trademarks and/or copyrights owned by Paizo Publishing, LLC, which are used under Paizo's Community Use Policy. We are expressly prohibited from charging you to use or access this content. This dataset is not published, endorsed, or specifically approved by Paizo Publishing. For more information about Paizo's Community Use Policy, please visit paizo.com/communityuse. For more information about Paizo Publishing and Paizo products, please visit paizo.com.
  • If the book was originally published for the 3.5 rules, and this data set is a Pathfinder RPG conversion, add the following line immediately before the previous INFOTEXT line:
INFOTEXT:This dataset implements rules from a book that was originally designed for the 3.5 ruleset. For this dataset, these rules have been updated to the rules of the Pathfinder RPG by the PCGen data team.
empty line
COPYRIGHT:

This contains all the lines from the book's OGL section 15, one tag per line. Replace all occurrences of the copyright sign and "(c)" with the word "Copyright".

  • If the book was originally published for the 3.5 rules, and this data set is a Pathfinder RPG conversion, add the following line (replacing <year> with the current year and <name> with a list of all developers working on the rules conversion):
COPYRIGHT:Pathfinder RPG Conversion Copyright 2009-<year>, PCGen Data Team (including, but not limited to, <name>)
  • Finally, add the following line (replacing <book> with the book name (see SOURCELONG), <pubyear> with the publication year of the book, <year> with the current year, and <name> with a list of all developers working on the data set. If both years are the same, just put it once):
COPYRIGHT:PCGen dataset conversion for "<book>" Copyright <pubyear>-<year>, PCGen Data Team (including, but not limited to <name>)
empty line
# Do not remove the EXTRAFILE comment.
#EXTRAFILE:OGL.txt
empty line
# Data Files

Here follow the data file tags.