from the other json spell data from the 3pp repo. |
||
---|---|---|
data | ||
schema | ||
src | ||
.gitignore | ||
ACKNOWLEDGEMENTS.md | ||
CONTRIBUTORS.md | ||
LICENSE.md | ||
README.md | ||
gendb.bat | ||
gendb.sh |
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
- Get data in YAML format (spells are in JSON for the time being; but will get converted over to YAML in the future).
- Design schema;
- Write script to generate sqlite database from YAML data (see
data/yaml/gendb.py
for work in progress); - Metric boatloads of proofreading
- 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:
\n
for Newline\n\n
for a new paragraph\t
for Tab\\
for Backslash
The action symbols can be represented by the following characters:
Meaning | Character | Unicode |
---|---|---|
1 action | ⑴ | U+2474 |
2 actions | ⑵ | U+2475 |
3 actions | ⑶ | U+2476 |
Reaction | 🄡 | U+1F121 |
Free action | 🄕 | U+1F115 |
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.