[http://pcgen.svn.sourceforge.net/viewvc/pcgen/Trunk/utilities/convert%20514/?view=tar Barak's 5.12 -> 5.14 Conversion Script]

Barak's conversion script automates much of the process of upgrading data files from 5.12 to 5.14. However, there are some things that cannot be converted. The script creates a log file and will note any of these items (and the file and line # within that file) in that log, as well as the recommended action to deal with them.

Below are the docs for the script.

'''FUNCTION''': Update PCGen data files (.lst) from version 5.12 to 5.14

'''INSTALLATION''':
A) Get Perl if you don't already have it... any standard distribution with version 5.8 and over should work.
B) Once Perl is installed on your computer, put the script in the directory of your choice.
C) To run the script all you have to do is type "perl convert_514.pl" with the proper parameters to make it work.

'''COMMAND LINE PARAMETERS''':
-S --> Create generic shieldprof file (Optional)
-I="<directory>" --> input directory (Required)
-O="<directory>" --> output directory (Required)
directory names must be in double quotes if they contains spaces

'''NOTES''':

1) If you specify the same output directory as input directory your files will be overwritten, so make sure to backup your files in another location if you choose to do this. NOTE: This is *NOT* the recommended method

2) The script will remove CHOICE tags that do not have targets that are schools, subschools or descriptors. It will log these occurrences.

3) Any CHOOSE tag with only one choice (like the old "CHOOSE:+3 HP" for the Toughness feat) will be converted to CHOOSE:NOCHOICE

4) Any CHOOSE tag that does not have a first parameter that matches one of the documented ones will be converted to CHOOSE:STRING (in a non-equipmod file) or CHOOSE:STRING|...|TITLE=yyy in an equipmod file (the title will be the text between the colon and the first pipe)

5) Any tags that need to be manually updated will be passed through as is and noted in the log file (line numbers given reference *input files*)

6) Recommended usage is in two steps:

A) Point the script at your existing gamemode directory and direct output to the 5.14 gamemode directory
B) Point the script at your existing data directory and direct output to the 5.14 data directory

'''TAG CONVERSIONS/ADDITIONS''':

SA -> SAB (Logs those that need manual conversion - basically SA:.CLEAR)

PROFICIENCY -> PROFICIENCY:<subtoken>|<prof>

AUTO:ARMORPROF|TYPE -> AUTO:ARMORPROF|ARMORTYPE=

AUTO:SHIELDPROF|TYPE -> AUTO:SHIELDPROF|SHIELDTYPE=

FEATAUTO -> AUTO:FEAT

REPEATLEVEL -> <level #>:REPEATLEVEL

PREDEITY -> PREDEITY:x,y,y

PRETEMPLATE -> PRETEMPLATE:x,y,y

PRERACE:y -> PRERACE:x,y,y

PRELEVEL: -> PRELEVEL:MIN=#

PRELEVELMAX -> PRELEVEL:MAX=#

CONTAINS:-1 -> CONTAINS:UNLIM

MOVECLONE:w,x,y,z -> MOVECLONE:x,y,z (Logs those that need manual conversion)

PRETYPE: -> PRETYPE:x,y,y

ADD:SA -> ADD:SAB

KNOWNSPELLS:.CLEAR<stuff> -> KNOWNSPELLS:.CLEAR|<stuff>

PREHD:#-# -> PREHD:MIN=x,MAX=y

CHOICE -> CHOICE:SCHOOL

CHOICE -> CHOICE:SUBSCHOOL

CHOICE -> CHOICE:DESCRIPTOR

FAVCLASS -> FAVCLASS:<class>.<subclass>

FAVOREDCLASS -> FAVOREDCLASS:<class>.<subclass>

Create Armorprof file from armor.lst files

PRECLASS -> PRECLASS:#,y,y conversion

PREMOVE -> PREMOVE:#,y,y conversion

PREWIELD -> PREWIELD:#,y,y conversion

PREWEAPONPROF -> PREWEAPONPROF:#,y,y conversion

PRESPELLSCHOOL:Abjuration,1,5 -> PRESPELLSCHOOL:1,Abjuration=5

PRESPELLSCHOOLSUB:Healing,1,5 -> PRESPELLSCHOOLSUB:1,Healing=5

PRESPELLDESCRIPTOR:Evil,1,5 -> PRESPELLDESCRIPTOR:1,Evil=5

CHOOSE:Language(<type>) -> CHOOSE:LANGUAGE|<type>

CHOOSE:SKILLSNAMED|...|# -> CHOOSE:SKILLSNAMED|...<tab> SELECT:#

SPELLS:<spellbook>|TIMES:-1 to SPELLS:<spellbook>|TIMES:ATWILL

NUMCHOICES=1 not allowed in CHOOSE:SPELLLEVEL

CHOOSE: in EqMod with Title as first argument is deprecated -> CHOOSE:<subtoken>|<args>|TITLE=<title>

REMOVE:FEAT(<feat1>,<feat2>)# -> REMOVE:FEAT|<feat1>,<feat2>|#

CHOOSE:<blah text1>|<blah text2> -> CHOOSE:STRING|<blah text1>|<blah text2>

CHOOSE:CCSKILLLIST|x,x -> CHOOSE:SKILLSNAMED|CROSSCLASS

CHOOSE:NONCLASSSKILLLIST|x -> CHOOSE:SKILLSNAMED|CROSSCLASS|EXCLUSIVE

CHOOSE:SKILLIST|x,x -> CHOOSE:SKILLSNAMED|x|x

CHOOSE:SKILLIST|LIST -> CHOOSE:SKILLSNAMED|ALL

CHOOSE:Martial -> CHOOSE:PROFICIENCY|WEAPON|UNIQUE|TYPE.Martial

CHOOSE:Exotic -> CHOOSE:PROFICIENCY|WEAPON|UNIQUE|TYPE.Exotic

CHOOSE:SPELLLEVEL arguments may not contain ,

LIST in some CHOOSEs no longer used

ADD:FEAT(blah,blah1)# -> ADD:FEAT|#|blah,blah1

ADD:CLASSSKILLS(blah,blah1)# -> ADD:CLASSSKILLS|#|blah,blah

ADD:SPELLCASTER(blah,blah1)# -> ADD:SPELLCASTER|#|blah,blah

PRESPELLTYPE:Arcane,1,5 -> PRESPELLTYPE:1,Arcane=5

RESIZABLEEQUIPTYPE -> Add default to miscinfo.lst

WEAPONREACH -> Add default to miscinfo.lst

FOLLOWERALIGN -> PREALIGN

PREVIEWDIR:d20/fantasy -> added to miscinfo.lst as a commented out example

PREVIEWSHEET:preview.html -> added to miscinfo.lst as a commented out example

VISION:Low-light,Darkvision -> VISION:Low-light|Darkvision

CLASSES:Sorcerer=1[PRExxx] -> CLASSES:Sorcerer=1<tab>PRExxx

PRESA:Wild Empathy -> PRESAB:Wild Empathy

WT:- -> <tab>

ADD:Language -> ADD:LANGUAGE

BONUSFEATS:1 -> BONUS:FEAT|POOL|1

PREEQUIP:<equipment> -> PREEQUIP:#,<equipment>

Barak's conversion script

2010-10-21T22:59:57Z

Barak: Created page with "[http://pcgen.svn.sourceforge.net/viewvc/pcgen/Trunk/utilities/convert%20514/?view=tar Barak's 5.12 -> 5.14 Conversion Script] Barak's conversion script automates much of the p..."

UltraEdit Setup

2010-10-21T20:54:46Z

Barak:

[http://pcgen.svn.sourceforge.net/viewvc/pcgen/Trunk/utilities/editor%20syntax/UltraEdit/?view=tar PCGen UltraEdit Syntax Highlight File]

Once you have UltraEdit installed, get "PCGen_LST_syntax.uew" (link above) to be copied into
the "UltraEdit/wordfiles" directory.

All of our settings will be done from the configuration panel which can be reached uner the "Advanced" menu item.

[[File:UE1.jpg]]

1) Editor -> Word Wrap/Tab Set - Set "Tab Stop Value" and "Indent Spaces" to 6

[[File:UE2.jpg]]

2) File Types - Enter *.pcc, *.lst, *.pcg in the "File Names" section and enter "PCgen Files" in the "File Descriptions" Section and click "Insert"

[[File:UE3.jpg]]

3) File Associations - Enter the associations for our favorite three file types:
*.pcc PCGen Campaign File
*.lst PCGen Data File
*.pcg PCGen Character File

[[File:UE4.jpg]]

4 Editor Display -> Formatting - deselect "Auto Indent New Lines"

[[File:UE5.jpg]]

5) Editor Display -> Syntax Highlighting -
a) Put the path to your PCGen.uew file in the "Full Directory path for wordfiles" section (if you change this you need to shut down and restart UltraEdit so it will read the directory)
b) Check "Enable Syntax Highlighting" box
c) Select "PCGen Data File" from the drop down box (if it's not there, you pointed the program to the wrong directory)
d) If you want to use this by default when you create a new file, select "PCGen Data File" from the drop down box under "Highlight New File as"
e) Click "Apply"

[[File:UE6.jpg]]

There are many other settings you may change to customize UltraEdit to suit your preferences. The above steps will get you started and make PCGen data files that you open up look presentable.

Data Meeting Availability

2010-10-21T20:31:11Z

Barak:

{| align="right"
| __TOC__
|}

=Introduction=

The [[Data|Data Team]] meetings will happen as deemed necessary by the Silverback or the team itself.

=Timezones=

{| border="1"
! Name !! Current Timezone !! Offset from GMT
|-
| [[Chris Chandler]] || EST/EDT || -5/-4
|-
| [[David R. Bender]] || EST/EDT || -5/-4
|-
| [[LegacyKing|Andrew Maitland]] || PST/PDT || -8/-7
|-
| [[Stefan Radermacher]] || CET/CEST || +1/+2
|-
|}

=Availability=
{| border="1"
! Name !! Mon !! Tue !! Wed !! Thu !! Fri !! Sat !! Sun
|-
| [[Chris Chandler]]^ || Mostly || Mostly || Mostly || Mostly || Mostly || Yes || No
|-
| [[David R. Bender]]^^ || No || Yes (except 3rd) || Yes || Yes || Yes || Yes || Yes
|-
| [[LegacyKing|Andrew Maitland]] || After 4pm || After 6pm || NO || Yes || Yes || Yes || After 4pm
|-
| [[Stefan Radermacher]] || NO || After 6pm || NO || NO || Yes (except Oct 16) || Yes || After 8pm
|-
|}

^ = Mornings/Afternoon 7AM EST to 1PM EST 
^^ = After 1600 ET

Meeting Time

2010-10-21T20:26:35Z

Barak:

UltraEdit Setup

2010-10-21T00:56:45Z

Barak: Created page with "[http://pcgen.svn.sourceforge.net/viewvc/pcgen/Trunk/utilities/editor%20syntax/UltraEdit/?view=tar PCGen UltraEdit Syntax Highlight File] Once you have UltraEdit installed, get ..."

File:UE6.jpg

2010-10-21T00:35:27Z

Barak: UltraEdit Setup 6

UltraEdit Setup 6

File:UE5.jpg

2010-10-21T00:31:09Z

Barak: UltraEdit Setup 5

UltraEdit Setup 5

File:UE4.jpg

2010-10-21T00:26:19Z

Barak: UltraEdit Setup 4

UltraEdit Setup 4

File:UE3.jpg

2010-10-20T23:57:03Z

Barak: UltraEdit Setup 3

UltraEdit Setup 3

File:UE2.jpg

2010-10-20T23:52:11Z

Barak: UltraEdit Setup 2

UltraEdit Setup 2

File:UE1.jpg

2010-10-20T23:49:49Z

Barak: UltraEdit Setup 1

UltraEdit Setup 1

TextPad Setup

2010-10-20T00:52:15Z

2010-10-19T23:57:33Z

Barak: Start New Document Class

Start New Document Class

TextPad Setup

2010-10-17T17:27:25Z

Barak:

[http://pcgen.svn.sourceforge.net/viewvc/pcgen/Trunk/utilities/editor%20syntax/Textpad/?view=tar PCGen TextPad Syntax Highlight File]

Once you have TextPad installed, get "PCGen.syn" (link above) to be copied into
the "Textpad/system" directory. After that you need to create a document type for PCGen.

'''1)''' Start TextPad

'''2)''' Configure -> New Document Class

'''3)''' Enter "PCGen" for the name and click the Next button.

'''4)''' For the class members prompt, enter "*.lst" and "*.pcc" then click the Next button

'''5)''' Check the "Enable syntax highlighting box"

'''6)''' Use the dropdown box to select the PCGen.syn file and then click the Next button

'''7)''' Click the Finish button

Now you need to make some further adjustments for your new document type.

'''1)''' Configure -> Preferences -> Document Classes -> PCGen

'''2)''' Font: Set the font to a monospace font so everything will line up nicely (I use Courier)

'''3)''' Tabulation: Set the default tab spacing to 6 spaces and set the Indent size to 6 spaces

After this you need to make some further adjustments to the general settings of TextPad

'''1)''' Configure -> Preferences

'''2)''' View - Make sure the following are checked:
A) Highlight the line containing the cursor (*extremely* helpful)
B) Horizontal scroll bar
C) Line numbers (makes talking to each other about where to find stuff easier)
D) Vertical scroll bar
E) Visible white space:Paragraphs, Spaces, Tabs

'''3)''' Associated Files - add "*.lst" and "*.pcc" so that Explorer will automatically start Textpad when you
double click those file types.

'''4)''' File Name Filters
A) Click the New button
B) Enter a name/description ("PCGen" works well here)
C) Enter our two favorite wildcards "*.lst" and "*.pcc" separated by a comma
D) Click Apply

Ok, that's pretty much it for getting TextPad set up. You'll also want to turn off word wrapping (the
.lst file lines can get really long and trying to read the word-wrapped is a quick route to insanity...)

TextPad Setup

2010-10-17T17:12:26Z

Barak:

Once you have TextPad installed, get "PCGen.syn" (link above) to be copied into
the "Textpad/system" directory. After that you need to create a document type for PCGen.

1) Start TextPad

2) Configure -> New Document Class

3) Enter "PCGen" for the name and click the Next button.

4) For the class members prompt, enter "*.lst" and "*.pcc" then click the Next button

5) Check the "Enable syntax highlighting box"

6) Use the dropdown box to select the PCGen.syn file and then click the Next button

7) Click the Finish button

Now you need to make some further adjustments for your new document type.

1) Configure -> Preferences -> Document Classes -> PCGen
2) Font: Set the font to a monospace font so everything will line up nicely (I use Courier)
3) Tabulation: Set the default tab spacing to 6 spaces and set the Indent size to 6 spaces

After this you need to make some further adjustments to the general settings of TextPad

1) Configure -> Preferences

2) View - Make sure the following are checked:
A) Highlight the line containing the cursor (*extremely* helpful)
B) Horizontal scroll bar
C) Line numbers (makes talking to each other about where to find stuff easier)
D) Vertical scroll bar
E) Visible white space:Paragraphs, Spaces, Tabs

3) Associated Files - add "*.lst" and "*.pcc" so that Explorer will automatically start Textpad when you
double click those file types.

4) File Name Filters
A) Click the New button
B) Enter a name/description ("PCGen" works well here)
C) Enter our two favorite wildcards "*.lst" and "*.pcc" separated by a comma
D) Click Apply

Ok, that's pretty much it for getting TextPad set up. You'll also want to turn off word wrapping (the
.lst file lines can get really long and trying to read the word-wrapped is a quick route to insanity...)

TextPad Setup

2010-10-17T10:39:55Z

Barak: Created page with " Once you have TextPad installed, get "PCGen.syn" (link above) to be copied into the "Textpad/system" directory. After that you need to create a document type for PCGen. 1) S..."

Once you have TextPad installed, get "PCGen.syn" (link above) to be copied into
the "Textpad/system" directory. After that you need to create a document type for PCGen.

1) Start TextPad
2) Configure -> New Document Class
3) Enter "PCGen" for the name and click the Next button.
4) For the class members prompt, enter "*.lst" and "*.pcc" then click the Next button
5) Check the "Enable syntax highlighting box"
6) Use the dropdown box to select the PCGen.syn file and then click the Next button
7) Click the Finish button

Now you need to make some further adjustments for your new document type.

1) Configure -> Preferences -> Document Classes -> PCGen
2) Font: Set the font to a monospace font so everything will line up nicely (I use Courier)
3) Tabulation: Set the default tab spacing to 6 spaces and set the Indent size to 6 spaces

After this you need to make some further adjustments to the general settings of TextPad

1) Configure -> Preferences

2) View - Make sure the following are checked:
A) Highlight the line containing the cursor (*extremely* helpful)
B) Horizontal scroll bar
C) Line numbers (makes talking to each other about where to find stuff easier)
D) Vertical scroll bar
E) Visible white space:Paragraphs, Spaces, Tabs

3) Associated Files - add "*.lst" and "*.pcc" so that Explorer will automatically start Textpad when you
double click those file types.

4) File Name Filters
A) Click the New button
B) Enter a name/description ("PCGen" works well here)
C) Enter our two favorite wildcards "*.lst" and "*.pcc" separated by a comma
D) Click Apply

Ok, that's pretty much it for getting TextPad set up. You'll also want to turn off word wrapping (the
.lst file lines can get really long and trying to read the word-wrapped is a quick route to insanity...)

EditPlus Setup

2010-10-17T10:21:06Z

Barak: moved EditPlus to EditPlus Setup: Data Team wiki re-organization

[http://www.editplus.com Editplus can be downloaded here for a 30 shareware trial]

[http://pcgen.svn.sourceforge.net/viewvc/pcgen/Trunk/utilities/editor%20syntax/EditPlus.tar.gz?view=tar Download the Syntax Highlighting File here]

Here are some screenshots

[[File:Editplus_main.jpg|200px|thumb|left|Main Screen - A full screen view of an open syntax highlighted lst file, a nice shot of side bar items. This is LST coding at it's finest.]]

[[File:Editplus_pref_menu.jpg|200px|thumb|left|Main Screen with Menu to Preference - Selecting the menu to open preferences]]

[[File:Editplus_pref_main.jpg|200px|thumb|left|Preference Screen - You can see the selection of Syntax Highlight file, the setting of PCGen as it's own code type setting pcc, lst and pcg as files to be associated with that setting.]]

[[File:Editplus_pref_tab.jpg|200px|thumb|left|Tab Screen - You'll set the spacing to 6 as is PCGen Standard.]]

EditPlus

2010-10-17T10:21:06Z

Barak: moved EditPlus to EditPlus Setup: Data Team wiki re-organization

#REDIRECT [[EditPlus Setup]]

Crimson Editor Setup

2010-10-17T10:20:09Z

Barak: moved Crimson Editor/Emerald Editor to Crimson Editor Setup: Data Team wiki re-organization

Crimson/Emerald Editor is a powerful freeware text editor. However, it takes a little setup to get working properly.

[http://www.emeraldeditor.com/ Emerald Editor Website - note the program is called crimson editor but is maintained by the Emerald Editor Community]

[http://pcgen.svn.sourceforge.net/viewvc/pcgen/Trunk/utilities/editor%20syntax/Crimson.tar.gz?view=tar The files that PCGen has to support this program are here]

Screen Shots:

[[File:Cedit_main.jpg|200px|thumb|left|Main Screen - A full screen view of an open syntax highlighted lst file, a nice shot of side bar items.]]

[[File:Cedit_other.jpg|200px|thumb|left|Another view of the main Screen - A full screen view of an open menu showing options selected.]]

[[File:Cedit_pref.jpg|200px|thumb|left|Preference Screen - A view of one of the many options.]]

Crimson Editor/Emerald Editor

2010-10-17T10:20:09Z

Barak: moved Crimson Editor/Emerald Editor to Crimson Editor Setup: Data Team wiki re-organization

#REDIRECT [[Crimson Editor Setup]]

Text Editors

2010-10-17T10:18:56Z

Barak:

The most important tool is a good text editor with syntax highlighting.

Some good choices out there that have been used by previous data monkeys:

* '''WINDOWS SYSTEM'''
** [http://www.emeraldeditor.com/ Crimson Editor]] (Freeware)
*** [[Crimson Editor Setup]]
** [http://www.contexteditor.org/ CONText] (Freeware)
*** [[CONText Setup]]
** [http://www.pspad.com/ PSPad] (Freeware)
*** [[PSPad Setup]]
** [http://www.editplus.com Editplus] (Shareware for 30 days I believe)
*** [[EditPlus Setup]]
** [http://textpad.com/ Textpad] (Shareware)
*** [[TextPad Setup]]
** [http://www.ultraedit.com/ UltraEdit] (Shareware)
*** [[UltraEdit Setup]]
** [http://sourceforge.net/projects/notepad-plus/ Notepad++] (no Syntax Highlighter available, but free)

* '''MAC SYSTEMS'''
** [http://www.barebones.com/products/bbedit/ BBEdit] (Shareware)
*** [[BBEdit Setup]]

* '''JAVA Supported Systems'''
** [http://www.jedit.org/ jEDit]
*** [[jEdit Setup]]

* '''OTHER SYSTEMS'''
** [http://www.vim.org/ vim] This is a VIM Clone Site; vim is distributed with Linux-based systems
*** [[vim Setup]]
** [http://kate-editor.org/ Kate] Linux KDE distributions
*** [[Kate Setup]]

Most of these have PCGen specific syntax highlight files (Links to them are on the setup page for each editor). There are other good text editors, but you would need to create your own syntax highlight file for them.