Explanation of the Code Base - Revision history

James: Update for the new UI

2013-12-30T22:46:54Z

Update for the new UI

Masaru20100: /* pcgen.gui */

2012-09-09T08:12:24Z

‎pcgen.gui

Tom Parker at 00:19, 5 April 2009

2009-04-05T00:19:05Z

Tom Parker: /* pcgen.rules.* */

2009-04-03T02:10:15Z

‎pcgen.rules.*

Tom Parker: /* pcgen.cdom.* */

2009-04-03T02:08:11Z

‎pcgen.cdom.*

Tom Parker: /* pcgen.base.* */

2009-04-03T01:58:35Z

‎pcgen.base.*

Karianna: /* 5.15.0 and beyond */

2008-11-24T14:06:49Z

‎5.15.0 and beyond

Karianna: /* Packages */

2008-11-24T14:06:27Z

‎Packages

Karianna: /* High level overview of PCGen Code Base */

2008-11-24T14:03:42Z

‎High level overview of PCGen Code Base

Karianna: New page: {| align="right" | TOC |} =High level overview of PCGen Code Base= ''src/java/pcgen'' is where the code tree begins. The directories match the package names — so ''pcgen.core''...

2008-09-02T14:55:07Z

New page: {| align="right" | __TOC__ |} =High level overview of PCGen Code Base= ''src/java/pcgen'' is where the code tree begins. The directories match the package names — so ''pcgen.core''...

New page

{| align="right"
| __TOC__
|}

=High level overview of PCGen Code Base=

''src/java/pcgen'' is where the code tree begins. The directories match the package names — so ''pcgen.core'' would be ''src/java/pcgen/core'' (or ''src\java\pcgen\core'' if you are on Windows).

=Packages=

==pcgen.core==

This is where the business logic goes. This is the main engine that makes things work. The most important class in here is PObject, many classes are subclassed from this (like PCClass, Race, Feat, Spell, etc.). Another important class is PlayerCharacter which is where the player characters are constructed and manipulated. Globals contains the lists of objects loaded when a user loads their desired sources. Constants holds most of the code constants so you do not need to remember their values.

==pcgen.gui==

This is the GUI logic. The main method is in pcGenGUI, and the frame is in PCGen_Frame1. The editors are all defined in the editor package, and all the tab frames are in the tabs package.

==pcgen.io==

This is where the disk writing stuff occurs, like creating/parsing pcg files, and exporting character sheets.

==pcgen.persistence==

This is where the lst files are read in. The class that controls the loading is SystemLoader.

==pcgen.util==

This is where generally useful classes that are don't fit any of the other categories go.

==plugin==

This is where the pluggable features go. This includes tools such as Character Sheet, Dicebag, Random Name Generator, Encounter Generator, Network Management, Experience Tracker, Initiative Tracker, GM Notes, Overland Travel and the Character Tracker. It also includes processors for the variety of Lst Tokens and Output Tokens. There is also an [[Arch. Discuss of Plugin System|Architectural Discussion of the PCGen Persistence Plugin System]] to help provide additional explanation of how the Lst Tokens work.

See the Javadocs for further details of the PCGen code base.

@@ Line 39: / Line 39: @@
 ==pcgen.gui==
-This is the GUI logic. The main method is in pcGenGUI, and the frame is in PCGen_Frame1. The editors are all defined in the editor package, and all the tab frames are in the tabs package.
+This was the old GUI logic. It has now been removed and the UI is in the pcgen.gui2 classes.
 ==pcgen.gui2==
-This is the NewGUI logic.
+This is the NewGUI logic, starting from PCGen 6.0. The main window is pcgen.gui2.PCGenFrame, the tabs are in pcgen.gui2.tabs. All interaction between the tabs and the PCGen core is done via facades. This provides a nice separation of controller and view logic from the model code. The facade implementation can be found in the pcgen.gui2.facade package. Other major packages are pcgen.gui2.converter for the LST Converter and pcgen.gui2.sources for the source selection dialog.
 ==pcgen.io==
@@ Line 52: / Line 51: @@
 ==pcgen.persistence==
-This is where the lst files are read in. The class that controls the loading is SystemLoader.
+This is where the lst files are read in. The class that controls the loading of data is SourceFileLoader.
 ==pcgen.util==

← Older revision		Revision as of 08:12, 9 September 2012
Line 40:		Line 40:

	This is the GUI logic. The main method is in pcGenGUI, and the frame is in PCGen_Frame1. The editors are all defined in the editor package, and all the tab frames are in the tabs package.		This is the GUI logic. The main method is in pcGenGUI, and the frame is in PCGen_Frame1. The editors are all defined in the editor package, and all the tab frames are in the tabs package.
		+	This is deprecated in favor of pcgen.gui2 classes.
		+
		+	==pcgen.gui2==
		+
		+	This is the NewGUI logic.

	==pcgen.io==		==pcgen.io==

← Older revision		Revision as of 00:19, 5 April 2009
Line 6:		Line 6:

	''src/java/pcgen'' is where the code tree begins. The directories match the package names — so ''pcgen.core'' would be ''src/java/pcgen/core'' (or ''src\java\pcgen\core'' if you are on Windows).		''src/java/pcgen'' is where the code tree begins. The directories match the package names — so ''pcgen.core'' would be ''src/java/pcgen/core'' (or ''src\java\pcgen\core'' if you are on Windows).
−
−	~~=5.15.0 and beyond=~~
−
−	~~As of 5.15.0 (Alpha), we've been incorporating elements of CDOM, please refer to the following documents:~~
−
−	* http://www.geocities.com/thpr/Arch-5.16-0.60-0.0.pdf
−	* http://www.geocities.com/thpr/Arch-5.16-0.60-2.0.pdf

	=Packages=		=Packages=

@@ Line 38: / Line 38: @@
 ==pcgen.rules.*==
-New CDOM classes
+This package contains the classes related to the "Rules Data Store".  The classes here are responsible for loading (and writing) the rules files (PCC, LST), and when combined with the token plugins, this package converts the persistent objects into the instances, lists, content, helpers, references, and other objects of the pcgen.cdom* package.
 ==pcgen.core==

@@ Line 22: / Line 22: @@
 ==pcgen.cdom.*==
-New CDOM classes
+The pcgen.cdom package contains the core contents of the CDOM structure.  There are a number of key subpackages of pcgen.cdom:
 ==pcgen.rules.*==

@@ Line 18: / Line 18: @@
 ==pcgen.base.*==
-New CDOM classes
+These classes are 'base' library elements.  None of these should be objects that are dependent upon pcgen.cdom or pcgen.core classes.  The intent is that pcgen.base elements are usable in any project, not specifically PCGen.  No item which is deeply tied to the concept of a Role-Playing Game or building a Player Character should be present in this package.
 ==pcgen.cdom.*==

@@ Line 11: / Line 11: @@
 As of 5.15.0 (Alpha), we've been incorporating elements of CDOM, please refer to the following documents:
-http://www.geocities.com/thpr/Arch-5.16-0.60-0.0.pdf
+* http://www.geocities.com/thpr/Arch-5.16-0.60-0.0.pdf
-http://www.geocities.com/thpr/Arch-5.16-0.60-2.0.pdf
+* http://www.geocities.com/thpr/Arch-5.16-0.60-2.0.pdf
 =Packages=

← Older revision		Revision as of 14:06, 24 November 2008
Line 15:		Line 15:

	=Packages=		=Packages=
		+
		+	==pcgen.base.*==
		+
		+	New CDOM classes
		+
		+	==pcgen.cdom.*==
		+
		+	New CDOM classes
		+
		+	==pcgen.rules.*==
		+
		+	New CDOM classes

	==pcgen.core==		==pcgen.core==

← Older revision		Revision as of 14:03, 24 November 2008
Line 6:		Line 6:

	''src/java/pcgen'' is where the code tree begins. The directories match the package names — so ''pcgen.core'' would be ''src/java/pcgen/core'' (or ''src\java\pcgen\core'' if you are on Windows).		''src/java/pcgen'' is where the code tree begins. The directories match the package names — so ''pcgen.core'' would be ''src/java/pcgen/core'' (or ''src\java\pcgen\core'' if you are on Windows).
		+
		+	=5.15.0 and beyond=
		+
		+	As of 5.15.0 (Alpha), we've been incorporating elements of CDOM, please refer to the following documents:
		+
		+	http://www.geocities.com/thpr/Arch-5.16-0.60-0.0.pdf
		+	http://www.geocities.com/thpr/Arch-5.16-0.60-2.0.pdf

	=Packages=		=Packages=