trackers/README.org

Trackers

• Dependencies
• General setup
  • Setting the variables
• Tracking games with a backloggery clone
  • Setup
    • Fonts
    • Setting the variables
  • Testing
• First run
• Building

Dependencies

• python3
• orgparse (install via pip)
• rclone (for syncing to the server)

General setup

Setting the variables

Rename variables-template.py to variables.py and edit:

• orgpath: absolute path to the root directory in which .org files are stored, including trailing slash
• localpath: absolute path to this directory, including trailing slash
• domain: https://yourdomain.tld without trailing slash
• rclonesiteroot: path rclone uses to access your webserver

Tracking games with a backloggery clone

Setup

Fonts

Upload the fonts Lato, Titillium Web, and Material Icons to the directory /fonts on your server (I recommend google-webfonts-helper). Check the filenames are consistent with those in build/backloggery.css. Alternatively, you can load the fonts remotely and adjust the page head HTML generated by skeleton.py.

Setting the variables

In variables.py, edit:

• trackgames: set to True
• gameserverpath: path to directory on the server where files will be uploaded, including trailing slash
• endlessgames: a list of “endless” games in the format title (console)
• description: content for the “about” section (can include HTML tags)
• startyear: year from which to begin tracking (an integer)
• hue: theme colour expressed as a hue from 0 to 360
• consoles: add or remove consoles following the format provided (.png images must be added to the build directory with a filename corresponding with the value of "img" for each console)

Testing

• Run python3 generategames.py local to build in gamebuild.

First run

• Run python3 init.py and then chmod +x build.sh.
• Create directories on the server corresponding to any *serverpath variables you have set..

Building

• Run ./build.sh to build and upload to the server.