this a mirror of the gitlab repo of pathfinder-2-sqlite
 
 
 
 
Go to file
James Miller 5712b7dade got a bunch of feats into YAML. Start up on getting feats_traits into YAML 2019-11-15 00:43:28 -06:00
data got a bunch of feats into YAML. Start up on getting feats_traits into YAML 2019-11-15 00:43:28 -06:00
schema Add missing comma 2019-09-03 23:02:45 -04:00
src Create staves.csv 2019-08-29 18:42:08 -04:00
.gitignore update .gitignore, add tmp.db to it 2019-11-11 16:44:36 -06:00
ACKNOWLEDGEMENTS.md fix typo in acknowledgements 2019-11-14 16:26:44 -06:00
CONTRIBUTORS.md add Wesley Webb to contributors.md 2019-08-05 21:33:54 -05:00
LICENSE.md add AON to OGL copyright field 2019-08-09 09:48:26 -05:00
README.md working on readme.md 2019-11-14 22:01:42 -06:00
gendb.bat Feats data added. 2019-08-19 01:03:28 -04:00
gendb.sh Added back Python 3 😞 2019-08-29 21:54:56 -04:00

README.md

Pathfinder 2 Sqlite

This will be a repository for the code necessary to generate a sqlite database containing the open gaming content for the Pathfinder 2 table-top role-playing-game system that is available under the Open Gaming License. Pull requests welcomed!

Why sqlite?

It's an open, permissively licensed, and portable single-file database that does not require setting up a client/server model. It's also likely that the database will fit into memory easily so performance issues aren't likely to be a problem. Also, most use cases of this data will likely be read only, so the sqlite limitations on concurrent writes won't be an issue either. Finally, it's permissively licensed.

Roadmap

  1. Get data in YAML format (spells are in JSON for the time being; but will get converted over to YAML in the future).
  2. Design schema;
  3. Write script to generate sqlite database from YAML data (see data/yaml/gendb.py for work in progress);
  4. Metric boatloads of proofreading
  5. Drinks for all when finished!

Conventions in the Code

Text Encoding

The goal is for all of our stored text in the database to be unicode, preferably UTF-8.

Also, many of the text fields will be in Github-Flavored Markdown.

Text may use the following escape codes:

  1. \n for Newline
  2. \n\n for a new paragraph
  3. \t for Tab
  4. \\ for Backslash

The action symbols can be represented by the following characters:

Meaning Character
1 action |1|
2 actions |2|
3 actions |3|
Reaction |R|
Free action |F|
One Minute |1m|
Ten Minutes |10m|
One Hour |1h|

Text Formatting

Text formatting will be according to github-flavored markdown.

Identical names

In the case of identical names ex. Sudden Charge for Fighter vs Barbarian we will use an identifier in parentheses ex. Sudden Charge (Fighter) vs Sudden Charge (Barbarian) or Lock (Simple) vs Lock (Average).

Ability Scores in Integer Representation

Ability Type Value
None 0
STR 1
DEX 2
CON 4
INT 8
WIS 16
CHA 32
Free 1 64
Free 2 128

If I wanted to say STR and DEX, I would use a 3. If I wanted STR, WIS, and CHA, that would be 1 + 16 + 32 = 49. This is to give a program-focused data return in addition to the textual representation.