1. Install Tampermonkey extension for your browser. (Chrome linked, will not work with FireFox unfortunately)
2. Get the userscript from here.
When enabled the overlay shows small pixels in the center of the real ones. This means if you see a dot that pixel is wrong and needs to be changed to the color of the dot.
When the template changes you do not need to reinstall the userscript. Simply refresh r/palce to get the latest version or wait for the auto refresh that happens every ~5 minutes.
Place to coordinate which pixels to place
Current output:
1. Create a branch
2. Upload image to images folder:
example.png with transparent background and without any border.
The image must be in 1:1 pixel scale and only use the colours provided by reddit.
3. Add a new block to config.toml:
[[structure]]
name = "example"
file = "images/example.png"
startx = 1234 # x-coordinate
starty = 5678 # y-coordinate
priority = 2The coordinates are of the uppermost, leftmost pixel of the linked png in r/place. Do not change the priority unless coordinated with the other devs.
4. Run scripts to preview output: Run these two scrips in this specific order
python .\scripts\generate_json.pyThis will generate pixel.json
python .\scripts\render_json.pyNow pixel.json is used to generate output.png as well as overlay.png.
IMPORTANT: Check output.png to ensure the images have been placed correctly. You can also use overlay.png to check if the overlay is correct.
5. Commit and push your changes Relevant files are:
config.toml, and images\beispiel.png
DO NOT push pixel.json, output.png or overlay.png.
These files will conflict when multiple people are adding files at the same time. GitHub-Actions will automatically build the output and overlay once your pull request has been accepted.
6. Create a pull request to main and have another dev review it
7. Pray the actions work and cry if they don't
For running the script see the README.md in scripts/