ppserver
is a small flask
server that helps to keep track of story lines and characters (NPCs) in my pen & paper game. The underlying data is collaboratively maintained in google sheets.
Clone the repository and run
pip3 install -e .
ppserver
works of two separate google sheets:
This table lists all characters in your adventures. It should have the following columns:
Name
Description
Race
Appeared
(date of first appearance)Locations
(comma separated if more than one location)Keywords
(comma separated if more than one)
The following keywords are allowed:
player
(this is not a NPC but a player character)dead
(character is deceased)
This table lists the relationships between characters. It should have the following columns:
Actor
(who is the relationship originating from)Relation
(what is the relation)Target
(target of the the relation)Extra
(additional keywords, comma separated if more than one)
The following keywords are allowed:
bi
(draw a bidirectional arrow rather than a normal arrow pointing from actor to target)
Follow these instructions. This involves two steps:
- Creating the certificate json file and downloading it to your computer
- Sharing the google sheets with the email address from your service account
Place the following file at ~/.ppserver.yaml
:
# "share with edit rights" link to the characters sheet
character_sheet_link: https://docs.google.com/spreadsheets/d/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/edit?usp=sharing
# file name of this sheet in your google drive
character_sheet_name: characters
# "share with edit rights" link to the relations sheet
relations_sheet_link: https://docs.google.com/spreadsheets/d/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/edit?usp=sharing
# file name of this sheet in your google drive
relations_sheet_name: relations
# path to your certificate file
certificate_path: /home/X/Y/Z/pen-and-paper-xxxxxx-yyyyyyyyyyyy.json
This repository contains vis-network.min.js
from the vis-network project. Its MIT license is tracked as vis_js_license.txt
.