Difference between revisions of "Pathfinder RPG Data Standards for PCC Files"
| (4 intermediate revisions by the same user not shown) | |||
| Line 7: | Line 7: | ||
CAMPAIGN: | CAMPAIGN: | ||
This line contains the name of the data source and should always be begin with "Paizo - ", followed by: | 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 | + | *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") | *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") | *For Adventure Path player guides, use "Name of Adventure Path Player's Guide" (e.g. "Rise of the Runelords Player's Guide") | ||
| Line 19: | Line 19: | ||
*"Pathfinder Adventure Path" (note the singular!) | *"Pathfinder Adventure Path" (note the singular!) | ||
**For Adventure Path books, append the name of the adventure path, separated by another dot. | **For Adventure Path books, append the name of the adventure path, separated by another dot. | ||
| − | *"Pathfinder | + | *"Pathfinder Campaign Setting" (includes the previous name of this line, "Pathfinder Chronicles") |
| − | *"Pathfinder Companion ( | + | *"Pathfinder Player Companion (includes the previous name of this line, "Pathfinder Companion") |
| − | *"Pathfinder Module" (includes the previous name of this | + | *"Pathfinder Module" (includes the previous name of this line, "GameMastery Module" |
| − | *"Pathfinder | + | *"Pathfinder RPG". |
RANK: | RANK: | ||
* This is easy. The core rules get rank 1, campaign setting books form Paizo get rank 2, everything else should be rank 3. | * This is easy. The core rules get rank 1, campaign setting books form Paizo get rank 2, everything else should be rank 3. | ||
| + | |||
| + | STATUS: | ||
| + | * Set to RELEASE, BETA, or ALPHA, as appropriate. | ||
GENRE:Fantasy | GENRE:Fantasy | ||
| Line 32: | Line 35: | ||
* Similar to rank. The core rules are "Core Rules", campaign setting books are "Campaign Setting", adventure path volumes and modules are "Adventure", everything else is a "Supplement". | * Similar to rank. The core rules are "Core Rules", campaign setting books are "Campaign Setting", adventure path volumes and modules are "Adventure", everything else is a "Supplement". | ||
| − | SETTING:Pathfinder | + | SETTING: |
| + | * For Pathfinder RPG rulebooks, which are setting neutral, this should be set to "Pathfinder RPG". All other books get "Pathfinder Campaign Setting". | ||
PRECAMPAIGN:1,BOOKTYPE=Core Rules | PRECAMPAIGN:1,BOOKTYPE=Core Rules | ||
| − | This line should be present in all data set. If the | + | This line should be present in all data set. |
| − | PRECAMPAIGN:1,Paizo - Pathfinder | + | *If the dataset uses character traits, add the following line too: |
| + | PRECAMPAIGN:1,Paizo - Pathfinder PRG Character Traits Web Enhancement,Paizo - Pathfinder RPG Advanced Player's Guide | ||
| + | *If the dataset is an for an adventure and includes kits for NPC or creatures, it might be necessary to include this line too: | ||
| + | PRECAMPAIGN:1,Paizo - Pathfinder RPG Bestiary | ||
| + | |||
Dependencies on other data sets, like Campaign Settings and Adventure Path player guides are also possible. | Dependencies on other data sets, like Campaign Settings and Adventure Path player guides are also possible. | ||
| Line 44: | Line 52: | ||
SOURCELONG: | SOURCELONG: | ||
| − | This should be the name of the book, without the product line, similar to the second part of the CAMPAIGN tag. | + | This should be the name of the book, without the product line, similar to the second part of the CAMPAIGN tag. For Pathfinder RPG rulebooks, leave out the "Pathfinder RPG" here. |
SOURCESHORT: | SOURCESHORT: | ||
| − | 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, in upper case, or lower case for words like "the", "to", "a", or "of", etc. | + | 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, in upper case, or lower case for words like "the", "to", "a", or "of", etc. Add the prefix "PF" for Pathfinder RPG rulebooks (such as "PFCR" for the Pathfinder RPG Core Rulebook). |
SOURCEWEB: | SOURCEWEB: | ||
| Line 80: | Line 88: | ||
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". | 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): | *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 | + | 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): | *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>''). | COPYRIGHT:PCGen dataset conversion for "<book>" Copyright ''<pubyear>''-''<year>'', PCGen Data Team (including, but not limited to ''<name>''). | ||
Latest revision as of 12:53, 25 October 2012
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!)
- For Adventure Path books, append the name of the adventure path, separated by another dot.
- "Pathfinder Campaign Setting" (includes the previous name of this line, "Pathfinder Chronicles")
- "Pathfinder Player Companion (includes the previous name of this line, "Pathfinder Companion")
- "Pathfinder Module" (includes the previous name of this line, "GameMastery Module"
- "Pathfinder RPG".
RANK:
- This is easy. The core rules get rank 1, campaign setting books form Paizo get rank 2, everything else should be rank 3.
STATUS:
- Set to RELEASE, BETA, or ALPHA, as appropriate.
GENRE:Fantasy
BOOKTYPE:
- Similar to rank. The core rules are "Core Rules", campaign setting books are "Campaign Setting", adventure path volumes and modules are "Adventure", everything else is a "Supplement".
SETTING:
- For Pathfinder RPG rulebooks, which are setting neutral, this should be set to "Pathfinder RPG". All other books get "Pathfinder Campaign Setting".
PRECAMPAIGN:1,BOOKTYPE=Core Rules
This line should be present in all data set.
- If the dataset uses character traits, add the following line too:
PRECAMPAIGN:1,Paizo - Pathfinder PRG Character Traits Web Enhancement,Paizo - Pathfinder RPG Advanced Player's Guide
- If the dataset is an for an adventure and includes kits for NPC or creatures, it might be necessary to include this line too:
PRECAMPAIGN:1,Paizo - Pathfinder RPG Bestiary
Dependencies on other data sets, like Campaign 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. For Pathfinder RPG rulebooks, leave out the "Pathfinder RPG" here.
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, in upper case, or lower case for words like "the", "to", "a", or "of", etc. Add the prefix "PF" for Pathfinder RPG rulebooks (such as "PFCR" for the Pathfinder RPG Core Rulebook).
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, i.e. the same abbreviation as used in SOURCESHORT, only in all lower case.
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 Roleplaying Game by the PCGen data team.
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.
