1. Installieren der Browsererweiterung Tampermonkey
2. Installieren des Scripts
1. Bild in bonjwa-Ordner hinzufügen mit Dateiname:
beispiel.png mit transparentem Hintergrund und KEINEM leeren Rand.
Das Bild muss 1:1 das Pixelart sein und nur aus den vorgegebenen Farben von Reddit bestehend
2. In config.toml neuen Block hinzufügen:
[[structure]]
name = "beispiel"
file = "bonjwa/beispiel.png"
startx = 1234 #x-Koordinate
starty = 5678 #y-Koordinate
priority = 2Dabei bezeichnet die Koordinate das oberste linke Pixel der verlinkten png in r/place und Priority bitte NICHT ändern, außer es ist mit dem Rest der Devs abgesprochen. Die Koordinaten sind NICHT die gleichen wie in r/place, diese bitte genau prüfen.
3. Scripte ausführen und Output prüfen:
Zwei Skripte in der angegebenen Reihenfolge aus dem Hauptordner des Repos ausführen
python .\scripts\generate_json.py
Damit sollte eine pixel.json generiert werden
python .\scripts\render_json.py
Nun wird aus der pixel.json eine output.png und eine overlay.png generiert\
WICHTIG: In der output.png gucken, dass die Bilder richtig platziert wurden und evtl. das eigene Overlay mit der neuen overlay.png testen, ob z. B. bei einer Änderung eines alten Bildes die Koordinaten nicht versetzt zum alten Bild sind.\
Mithilfe der Dockerfile kann ein Image/Container erstellt werden, welcher bereits für die Ausführung der Python Skripts konfiguriert ist.
4. Pull Request erstellen und von anderem Dev prüfen lassen
Die von den Python-Skripten generierten Dateien sollten NICHT mit in den Pull Request. Diese werden automatisch auf dem Server generiert und führen ansonten zu merge Konflikten. Dies betrifft folgende Dateien:
output.png
overlay.png
pixel.json
pixel_pretty.json
priority.png
- RAW Dateien im Github werden gecached, es kann also etwas dauern, bis die neue Templatedatei in der Extension angezeigt wird
- Bei Anpassung der overlay.user.js bitte Versionsnummer hochzählen
- Regelmäßig auf Updates der Scripts prüfen