Welcome to the Wiki section for the Architecture team!
This section of our wiki will explain the different portions of our code base, the current work underway to improve different sections for better performance and flexibility.
Index of Architecture Documents
There is an Index to Architecture Documents that provides a complete list and is in the recommended reading order for those who wish to read the complete set of relevant documentation.
This section lays out the primary sub-systems within PCGen
The Startup System is responsible for the activities required to load PCGen to the state where a user can select an option from the Load UI. This includes:
- Discovery and loading of Plugins (the plugin.* packages)
- Loading the Game Modes (stored in the system directory)
- Discovering and loading the PCC files (from the data directory)
- Loading the Load UI (part of pcgen.gui2.*)
The Load UI is responsible for presenting the user with the options of game systems and components available to be loaded. The LoadUI triggers a call to the Rules Persistence system when the user requests for specific data to be loaded, and to the Character Persistence system when the user requests for a Player Character to be loaded...
Rules Persistence System
The Rules Persistence System is one of the major components of PCGen. It is responsible for loading game system and component data from the persistence data file format and (in most cases) saving it back into that data file format. It is aware of the internal storage of information within PCGen only to the point it is required to store information in the Rules Data Store for use by the core of PCGen. The Rules Persistence System is not capable of interpreting much in the way of behavior of the values it is storing (strictly it will know the persistent text format, but doesn't understand what REACH actually means, only that it contains a number to be loaded into a specific location in the Rules Data Store).
We have a number of files in both the system (game mode) and data (effectively book content) directories that represent the data. Specific file "Loaders" load each of the different formats of file that we have, breaking it into lines.
These lines are then split up into the first token (indicating what the line means) and the other tokens. Tokens are separated by one or more tab characters.
Given the combination of Loader (file format) and Token, we can look up the appropriate plugin to process that specific token. This is called to parse the value of the token. This parse method is responsible for loading the information about the token into the Rules Data Store (generally into the object being loaded, but this is not universally true). Any failure means the entire contents of the token will be ignored (the contents of the token are a "transaction" in the sense that it fully succeeds or fully fails).
Those tokens may encounter various items including references to other objects, which we capture as CDOMReferences. In addition, there may be groups of objects referred to as well, so you may want to learn about Referring to Groups in LST Data.
Rules Data Store
The Rules Data Store is the internal data structure used to store the game system and component information.
As a "Data Store", it is very much akin to a complicated database (it could be converted into an actual database with some effort). The Rules Data Store is not designed to have methods that interpret the contents of the Rules Data Store, nor is the Rules Data Store capable of storing the information it contains into a persistent state. The conversion to and from a persistent state is owned by the Rules Persistence System.
Player Character UI
The Player Character UI is responsible for presenting the user with the contents of the PC, including all of the PC's characteristics. Requests to modify a PC are sent to back to the core to be processed. Much of this is currently framed through Facade objects which attempt to isolate the UI from the core.
Note that some of the items on a PC can be conditional, so it's valuable to understand Prerequisites and Requirements to understand what can be chosen and how those items will be applied to a PC.
Processing a PC
When an item is added to a PC, those behaviors need to be processed by Calculating Items on the PC. To understand that in more detail, you probably want to learn about the Formula Systems, including JEP and the new formula system.
Other - to Be Edited
- Character Persistence: The Character Persistence system is responsible for loading and saving PCs into the specified file format. The Character Persistence system is also responsible for creating and initializing a new Player Character.
- Character Output: The Character Output system is responsible for resolving the active objects on a PC, searching those objects to find specific information, and preparing that information for consumption by any of the systems that desire PC information.
- Event Controller: The Event Controller acts as a hub to communicate events (typically triggered by changes to a PC) to the UI and to any loaded Plugins.
- Character Data Store: The Character Data Store is the internal data structure used to store the PC.
- Code Base - Key Concepts
- CDOM Primitive Choice Set Concept Document
- Rules Data Store Concepts
Open Sub Projects
- Formula System Conversion
- FreeMarker Facet Output
- Incompatible Change List v6
- Current Architecture Projects (personal scratchpad)
- LST Token Information (scratchpad - relates to facet design and abstracting behaviors)
- BONUS Tag conversion list
- SELECTION - A CHOOSE Replacement
- Data Cleanup Projects
- PREREQ Cleanup
- PCG Round Robin Work (Tom's scratchpad)
- Bonus Subsystem Thoughts
- Bonus Subsystem Design
- FACT Token, FACTSET Token
- Architecture Update 1Q2013
- Subsystem Isolation (out of date?)
- PObject - The Refactoring (effectively completed for most items - CDOMObject)
- Rebuild of the Token/Loader System (effectively completed for most items)
- Architecture Changes 5.17 (completed as much as would be in 5.17)
- Things to Test (now uses TEST- trackers)
Things not really part of the current architecture, but for context
Active Team Members
Inactive Team Members
- Devon Jones