A project in the Pf2ools ecosystem to represent all Pathfinder 2nd Edition game content in JSON format.

• Overview
  • Data structure
  • Directory structure
  • Conventions
• Using the data
  • Bundles and indexes
  • Versioning
• Contributing
• Legal

All the actual game data is in the data/ directory.

All Paizo-made content is in the core/ directory, and all homebrew content is in the homebrew/ directory. In each of these directories, there is one directory for each source, named according to its title. In each of these directories, there is a source file which describes that source, and further directories for each datatype that source contains. The actual content-data files are within these lattermost directories.

In addition to core/ and homebrew/, there is also a common/ directory, which contains directories for any license or source group files.

All files are JSON objects with the following properties:

• type, which defines the type of data described;
• name or title, which defines the content's name;
• data, which represents the content itself.

There might also be a tags property, which contains various categories and variables that don't directly define the statblock itself.

The exact form of each of these properties can be investigated over in the Pf2ools Schema.

Pf2ools follows the following standardisation conventions:

• Files must be encoded with UTF-8 (without BOM), use "LF" as the end-of-line sequence, and end with a newline.
• Files must use tabs for indentation and have no trailing whitespace.
• Filenames must match the contained data's name.display or use the format <name.display>; <name.specifier>.json (e.g. Attack of Opportunity; Swashbuckler.json) if specifier is defined. The only exceptions are source, source group, and license files (which are all named following their title.full). Filesystem-unsafe characters (e.g. "?", ":") must be replaced with an underscore "_".

The data is yours! Although the master data is stored in a 'statblock-by-statblock' manner, this is primarily for ease of maintenance. For developer- and application-use, you may find more use with it in another format.

The bundles/ directory contains a series of directories containing JSON files. These files mirror the master data, but are (as you might expect) bundled together for ease of use in other applications.

The indexes/ directory contains a series of JSON files that serve as indexes of the existing data. Some of these are used internally, but you may generally find them easier to iterate through instead of the files directly!

In both cases, the files should be named fairly intuitively.

Pf2ools gets better all the time!

Although bundled releases will be published from time to time, this will typically only occur when something 'substantial' has happened. For instance, there'll be a new release when we finish converting a new set of core content or update the schema... or if it's just been a while and there's a lot of typo fixes pending. This is admittedly fairly arbitrary, but we'll aim for a new release at least once every 4 months.

The bundles/ and indexes/ directories will be regenerated only when a new release is published.

Please see CONTRIBUTING.md or join our Discord server for more information.

Content maintained by Pf2ools is reproduced without claim of ownership and under its respective license. Please refer to each source object's license property and cross-reference with the respective file in the data/common/license/ directory for more information.

Content published by Paizo Inc. is reproduced in accordance with the Community Use Policy.

All original content (e.g. scripts) is licensed under the MIT license.