Prepare for adding other trackers
This commit is contained in:
parent
6a8a0c40e6
commit
29ab288b65
29 changed files with 224 additions and 201 deletions
24
README.org
24
README.org
|
@ -4,25 +4,29 @@
|
|||
- =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 [[https://gwfh.mranftl.com/fonts][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
|
||||
Rename =variables-template.py= to =variables.py= and edit:
|
||||
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)=
|
||||
- =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
|
||||
- =serverpath=: path to directory on the server where files will be uploaded, including trailing slash
|
||||
- =domain=: =https://yourdomain.tld= without trailing slash
|
||||
- =rclonesiteroot=: path =rclone= uses to access your webserver
|
||||
- =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)
|
||||
*** The rest
|
||||
* First run
|
||||
- Run =python3 init.py= and then =chmod +x build.sh=.
|
||||
- Create the directory on the server.
|
||||
** Generating the files
|
||||
- Run =python3 generate.py local= to build in the local =build= directory.
|
||||
- Create directories on the server corresponding to any =*serverpath= variables you have set..
|
||||
* Generating the files
|
||||
- Run =python3 generate.py local= to build in local directories.
|
||||
- Run =./build.sh= to build and upload to the server.
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue