Document workshop upload process

docs/workshop-upload.md

@@ -0,0 +1,143 @@
+# Brogether Steam Workshop Upload
+
+Stand: 2026-05-23
+
+Diese Anleitung beschreibt den einfachen Upload-Weg fuer Brogether ueber Brotatos mitgeliefertes `GodotWorkshopUtility.exe`.
+
+## Was du brauchst
+
+- Brotato auf Steam installiert.
+- Steam muss laufen und dein Account muss online sein.
+- Dein Steam-Account muss Brotato besitzen.
+- Der aktuelle Brogether-ZIP-Build:
+
+```powershell
+.\scripts\package.ps1
+```
+
+Danach liegt die Datei hier:
+
+```text
+dist\Brogether-Brogether-0.1.0.zip
+```
+
+- Optional, aber empfohlen: ein Workshop-Preview-Bild als PNG oder JPG. Am besten `512x512`, unter `1 MB`.
+- Fuer den ersten Upload brauchst du noch keine Workshop-ID. Steam erzeugt sie beim Upload.
+- Fuer spaetere Updates brauchst du die Workshop-ID aus der URL deines Workshop-Eintrags.
+
+## Wichtig Vor Dem Upload
+
+Brogether ist noch ein Prototyp. Fuer den ersten Workshop-Eintrag empfehle ich:
+
+- Sichtbarkeit zuerst auf `Private` oder `Unlisted` lassen.
+- Titel klar als Test/Prototype markieren.
+- Beschreibung deutlich machen, dass echter Zwei-Spieler-Gameplay-Sync noch nicht fertig ist.
+- Nach dem Upload direkt die Workshop-ID notieren.
+
+## Schritt Fuer Schritt: Erster Upload
+
+1. Steam starten und online lassen.
+2. Brotato schliessen, falls es offen ist.
+3. Im Projektordner den ZIP bauen:
+
+```powershell
+.\scripts\package.ps1
+```
+
+4. Brotatos Workshop-Uploader starten:
+
+```text
+C:\Program Files (x86)\Steam\steamapps\common\Brotato\GodotWorkshopUtility.exe
+```
+
+5. Im Uploader bei der Mod-Datei diesen ZIP auswaehlen:
+
+```text
+C:\Users\tommi\Documents\PotatoConnect\dist\Brogether-Brogether-0.1.0.zip
+```
+
+6. Optional ein Preview-Bild auswaehlen. Wenn der Upload wegen des Bildes fehlschlaegt, erst einmal ohne Bild hochladen.
+7. Das Feld fuer die Workshop Item ID leer lassen.
+8. Upload starten und warten, bis der Uploader Erfolg meldet.
+9. Wenn Steam nach der Workshop Legal Agreement fragt, im Browser/Steam-Overlay akzeptieren.
+10. Den neuen Workshop-Eintrag in Steam oeffnen.
+11. Sichtbarkeit rechts im Workshop-Eintrag auf `Private`, `Unlisted` oder spaeter `Public` setzen.
+12. Die Workshop-ID aus der URL notieren. Beispiel:
+
+```text
+https://steamcommunity.com/sharedfiles/filedetails/?id=1234567890
+```
+
+Die ID waere hier:
+
+```text
+1234567890
+```
+
+## Schritt Fuer Schritt: Update Eines Bestehenden Workshop-Eintrags
+
+1. ZIP neu bauen:
+
+```powershell
+.\scripts\package.ps1
+```
+
+2. `GodotWorkshopUtility.exe` starten.
+3. Wieder `dist\Brogether-Brogether-0.1.0.zip` auswaehlen.
+4. Optional dasselbe Preview-Bild auswaehlen.
+5. Dieses Mal die bestehende Workshop-ID eintragen.
+6. Upload starten.
+7. Danach im Steam Workshop Titel, Beschreibung, Sichtbarkeit und Bilder pruefen.
+
+Hinweis: Der Godot Mod Loader Wiki-Hinweis sagt, dass der Titel bei Updates vom Uploader wieder ueberschrieben werden kann. Also nach jedem Upload kurz in Steam kontrollieren.
+
+## Vorschlag Fuer Workshop-Titel
+
+```text
+Brogether - Online Multiplayer Prototype
+```
+
+## Vorschlag Fuer Workshop-Beschreibung
+
+```text
+Brogether is an experimental online multiplayer prototype for Brotato.
+
+Current status:
+- Steam lobby creation and lobby browser
+- Optional lobby password check
+- Waiting room with Steam names, Ready state and static avatars
+- Local Fake Peer test mode for development without a second client
+- Basic Steam P2P packets for handshake, ping and pong
+- Early run hooks and player snapshot logging
+
+Not finished yet:
+- Fully playable remote players
+- Shop, item, enemy, wave and RNG synchronization
+- Final two-client gameplay flow
+
+Use this only for testing with friends who know it is still experimental.
+```
+
+## Was Tester Danach Machen
+
+1. Steam Workshop-Eintrag abonnieren.
+2. Warten, bis Steam den Workshop-Download abgeschlossen hat.
+3. Brotato starten.
+4. Im Mod-Menue Brogether aktivieren, falls noetig.
+5. Brotato neu starten, wenn die Mod erst nach Neustart sauber geladen wird.
+6. Im Hauptmenue `BROGETHER` oeffnen.
+
+## Troubleshooting
+
+- Mod taucht nicht auf: Steam Workshop-Download abwarten, Brotato neu starten, Mod-Menue pruefen.
+- Upload findet Datei nicht: ZIP-Pfad pruefen und vorher `.\scripts\package.ps1` ausfuehren.
+- Upload mit Icon schlaegt fehl: Icon unter `1 MB` halten, am besten `512x512 PNG`, oder den ersten Upload ohne Icon testen.
+- Zugriff verweigert oder Item bleibt versteckt: Steam Workshop Legal Agreement akzeptieren.
+- Update erstellt neuen Eintrag: Beim Update muss die bestehende Workshop-ID eingetragen sein.
+- Logs fuer Upload/Download liegen laut Steamworks-Doku unter anderem in `Steam\logs\Workshop_log.txt` und `Steam\workshopbuilds\depot_build_<appid>.log`.
+
+## Quellen
+
+- Godot Mod Loader Wiki: Steam Workshop Uploader: https://wiki.godotmodding.com/guides/modding/tools/workshop_uploader/
+- Godot Mod Loader Wiki: Distributing Mods: https://wiki.godotmodding.com/guides/modding/distributing_mods/
+- Steamworks Documentation: Steam Workshop Implementation Guide: https://partner.steamgames.com/doc/features/workshop/implementation