- Install the Tampermonkey (Chrome) or Violentmonkey (Firefox) browser extensions.
- Open the raw source file link and the extension will automatically ask for installation.
- Accept it and the next time r/place is loaded you should see a "Toggle Overlay button"
- Once the overlay is loaded it may ask you to allow fetching the config over Github. Click "Always allow" when asked.
For anyone else that might be struggling with the template not working, but you are in the correct area. I found an extra step I had to do that was blocking Tampermonkey from working.
Right-click the Tampermonkey extension in the top right of the browser, move down to 'This can read and change site data ->' and make sure that's set to either 'on reddit.com' or to 'on all sites'... mine was set to the top one, 'when you click the extension', and therefore it wasn't working. As soon as I switched it, and refreshed, it was working!
Please each out in the #overlay-help channel of the r/placecanada discord for any issue with the overlay.
- See
/pictures/canada.provinces.psdto update our current design - Images to add to the overlay must be placed under
./picturesin a 1x scale - Edit
target_config.tomlwith the image name and top left position
- You will need python version 3.11+ in order to generate the overlay
- Move your cli into the generator directory :
cd ./generator - Generate a local venv :
python3 -m venv ./venv - Activate the venv :
source ./venv/bin/activate(Unix) orsource ./venv/Scripts/activate/(Windows) - Install requirement :
pip install -r ./requirements.txt - Run the generation script :
./generate.sh - New overlay images should be under
./outputs
- Commit and push the new files in
masterbranch - Test that the overlay updated for you before any anouncement, the cache may take up to 5 minutes to update
- Announce the overlay change to and admin or coordinator on r/placecanada discord