Outputsheets - PCGen Documentation

# Pages in Outputsheet

## Character Output Sheet Creation

Creating output sheets of any kind is even more difficult than list editing, and we won’t explain the mechanics of HOW to create a sheet here, only the tokens used by the sheets to get the desired information from PCGen. Creating output sheets requires a little knowledge of HTML or XML and some javascript/VB Script knowledge doesn’t hurt either! Whether you have this knowledge or not, it is strongly recommended that you take a look at how the current sheets are constructed and ‘borrow’ bits and pieces from them to build your own.

## Character Output Sheets in PCGen

Standard Output Sheets HTML Based Output Sheets csheet_fantasy_std.htm Spans 3+ pages (depending on class). Includes Bio sheet full spell lists with spell details. Includes 2 images if they exist. They must have the name <character_name>.jpg and <character_name>_Full.jpg and be in the same directory as the exported sheet. csheet_fantasy_compact.htm Compacted to fit on 2 pages (or one page duplexed). Does not have Bio or full spell details (only spell titles). Includes 2 images if they exist.

## Character Output Sheets: PDF Versions

XSLT based PDF sheets XSLT sheets are xml XSL Transformations based, more dynamic versions of the .fo pdf sheets and have for the most part replaced them by now. They are dynamic in the way that if the character has a portrait it will be displayed. If there is no picture of the character, that section of the sheet is simply skipped. If a character is of an spellcasting class, its spells and spellbook will be listed.

## Creating Character Sheet Templates

Preface This guide is in the main going to focus on using the tokens effectively and appropriately. For simplicity, we will primarily use HTML examples, some of which may be fairly complicated. If you need help with HTML or XML/XSL you should visit http://www.w3c.org and read their tutorials. For information about FOP (.fo file processing), visit http://www.apache.org . After going over the basics, I will be taking you through the steps I used to create a sheet to display a character’s weapons and equipment.

## General Information Output Sheet Tokens

Token Name: AGE What it does: Displays characters age. Examples: AGE Displays characters age. *** New 6.1.3 Token Name: AGE.CATEGORY What it does: Displays characters age category. Examples: AGE.CATEGORY Displays characters age category. Token Name: ALIGNMENT What it does: Displays characters alignment as full words, Lawful Good, Chaotic Evil, None etc. Examples: ALIGNMENT Displays characters alignment as full words. Token Name: ALIGNMENT.SHORT What it does: Displays characters alignment as 2 letters or ‘None’, LG, CE, None etc.

## Index : Character Output Sheets

The most important aspect of any character generator is the final output, without that the program would be pretty useless. So in the next few sections the character sheets provided with PCGen are explained. There are several basic types of output sheets; Character Sheets, Equipment Set Sheets, Party Sheets and Spell Sheets. Each may have different types of output; HTML, XML, PDF and TXT. HTML and XML sheets are exported via the File - Export - Standard function.

## Miscellaneous Output Sheet Tokens

Token Name: x<Mathematical Operator>x Variables Used (x): Number or Numeric Token (Operand). Variables Used (y): Mathematical Operator What it does: Simple mathematical operations are supported in the output sheets. Valid operators include the following: + (Addition operator). - (Subtraction operator). * (Multiplication operator). / (Divisor operator). @ (Divisor operator that returns an integer). \^ (Exponentiation operator). INTVAL (Displays just the integer portion of the result). NOZERO (Displays blank if the result is zero, otherwise displays the result with the appropriate sign).

## Output Sheet Example HTML

The following is an example of an HTML Output Sheet Template <html> <head> <title>|NAME|’s Weapons and Equipment</title> <style TYPE="text/css"> .h { font-size:8pt; vertical-align: bottom; } .topline { border-top-width:1px; border-top: 1pt solid black; } .border { border: 1px solid black; } </style> </head> <body bgcolor="white"> <!– Start Character Info Table –> <table cellpadding="0" cellspacing="4" border="0" width="100%"> <tr> <td width="35%" class="h">|NAME|</td> <td width="20%" class="h">|CLASSLIST|</td> <td width="10%" class="h">|TOTALLEVELS|</td> <td width="35%" class="h">|PLAYERNAME|</td> </tr> <tr>

## Output Sheet Example Output

The display below is an example of the output of a typical output sheet. Terjon Ranger5 5 Chris Chandler CHARACTER NAME CLASS LEVEL PLAYER WEAPONS **Elven Longbow +1 ** TOTAL ATTACK BONUS DAMAGE CRITICAL **+10 ** **1d8+1 ** **20/x3 ** HAND RANGE TYPE SIZE SPECIAL PROPERTIES **Carried\ **100’\ **P\ **L\ ** ***Longsword ** TOTAL ATTACK BONUS DAMAGE CRITICAL **+4 ** **1d8+1 ** **19-20/x2 ** HAND RANGE TYPE SIZE SPECIAL PROPERTIES **Primary\ **0’\ **S\ **M\ ** ***Sword, Short ** TOTAL ATTACK BONUS DAMAGE CRITICAL **+4 ** **1d6 ** **19-20/x2 ** HAND RANGE TYPE SIZE SPECIAL PROPERTIES **Off-hand\ **0’\ **P\ **S\ ** **Dagger ** TOTAL ATTACK BONUS DAMAGE CRITICAL **+6 ** **1d4+1 ** **19-20/x2 ** HAND RANGE TYPE SIZE SPECIAL PROPERTIES **Carried\ **0’\ **P\ **T\ ** **Dagger (Thrown) ** TOTAL ATTACK BONUS DAMAGE CRITICAL **+9 ** **1d4+1 ** **19-20/x2 ** HAND RANGE TYPE SIZE SPECIAL PROPERTIES **Carried\ **10’\ **P\ **T\ ** EQUIPMENT ITEM EQUIPPED QTY WT.

## Saves & Hit Points Output Sheet Tokens

*** Updated 5.15.x Token Name: CHECK.x.y.y.z Variables Used (x): Text (Save Type). FORTITUDE - Use Fortitude save Check. REFLEX - Use Reflex save Check. WILL - Use Will save Check. x - Where x is a digit, use the xth save check. Variables Used (y): Text (Save Filter). BASE - Displays only the class-based adjustment to the saving throw in question. EPIC - Displays Epic bonuses to the saving throw in question (TYPE=EPIC).

## Special Ability Related Output Sheet Tokens

Token Name: CLASS.x.SALIST Variables Used (x): Number (The x-th class in the character’s class list - 0-based index). What it does: Displays the Special Abilities granted by the x-th class. Example: CLASS.0.SALIST Displays the Special Abilities granted by the characters 1 ^st^ class. Token Name: PROHIBITEDLIST What it does: A Specialist Wizard must choose some prohibited schools. The selected school will be displayed in this list. Example: PROHIBITEDLIST Displays a comma delimited list of prohibitions Token Name: RACE.ABILITYLIST What it does: Displays a comma delimited list of the characters racial special abilities.

## Spell Related Output Sheet Tokens

*** new 5.7.12 Token Name: MAXSPELLLEVEL.x Variables Used (x): Number (The class number). What it does: The value returned is an integer containing the highest spell level that the class can cast (for most RSRD classes this will either be 9 (for Wizards) or 4 (for Rangers etc)). *** new 5.10.1 Token Name: SPELLBOOK.x.y Variables Used (x): Number (The Spell book Number of the spell book you wish to display). * The known spell book is spell book number 0.

## Weapon Output Sheet Tokens

The below Tokens control how weapon and weapon proficency information is presented in Output Sheets (OS). Token Name: WEAPON.[q.][r.]s.z Variables Used (q): Text (Merge Type - Optional). MERGEALL - Causes all weapons with the same name to be merged - default behavior. MERGELOC - Causes all weapons with the same name and in the same location to be merged. MERGENONE - No weapons with the same name are merged. Variables Used ®: Text (Weapon Status - Optional).

## base.xml File

The base.xml file contains the intelligence for the xslt PDF output sheets and is the first file processed before passing it’s output to the final selected xslt sheet. The primary base.xml file can be found at the root of the outputsheets directory. *** New 5.10 Mutiple gameMode specific base.xml files are now supported. If a base.xml file is found in the root gameMode directory that file will be used for xslt output.

Documentation built with Hugo using the Material theme.