MrDiderot/Brogether
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Translate public UI and docs to English

Browse Source
This commit is contained in:
Kroonk
2026-05-23 10:22:23 +02:00
parent 01f72a32cb
commit d3d66c863b
4 changed files with 171 additions and 171 deletions
Download Patch File Download Diff File Expand all files Collapse all files

112
docs/workshop-upload.md
View File

@@ -1,103 +1,103 @@
# Brogether Steam Workshop Upload
Stand: 2026-05-23
Status: 2026-05-23
Diese Anleitung beschreibt den einfachen Upload-Weg fuer Brogether ueber Brotatos mitgeliefertes `GodotWorkshopUtility.exe`.
This guide describes the simple upload path for Brogether using Brotato's bundled `GodotWorkshopUtility.exe`.
## Was du brauchst
## Requirements
- Brotato auf Steam installiert.
- Steam muss laufen und dein Account muss online sein.
- Dein Steam-Account muss Brotato besitzen.
- Der aktuelle Brogether-ZIP-Build:
- Brotato installed through Steam.
- Steam must be running and your account must be online.
- Your Steam account must own Brotato.
- The current Brogether ZIP build:
```powershell
.\scripts\package.ps1
```
Danach liegt die Datei hier:
After that, the ZIP is here:
```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.
- Optional but recommended: a Workshop preview image as PNG or JPG. `512x512` and below `1 MB` is a good target.
- For the first upload, you do not need a Workshop ID. Steam creates it.
- For later updates, you need the Workshop ID from your Workshop item URL.
## Wichtig Vor Dem Upload
## Before Uploading
Brogether ist noch ein Prototyp. Fuer den ersten Workshop-Eintrag empfehle ich:
Brogether is still a prototype. For the first Workshop item, the recommended settings are:
- 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.
- Keep visibility on `Private` or `Unlisted` first.
- Mark the title clearly as a test/prototype.
- Make the description clear that real two-player gameplay sync is not finished yet.
- Note the Workshop ID immediately after upload.
## Schritt Fuer Schritt: Erster Upload
## First Upload
1. Steam starten und online lassen.
2. Brotato schliessen, falls es offen ist.
3. Im Projektordner den ZIP bauen:
1. Start Steam and stay online.
2. Close Brotato if it is running.
3. Build the ZIP from the project folder:
```powershell
.\scripts\package.ps1
```
4. Brotatos Workshop-Uploader starten:
4. Start Brotato's Workshop uploader:
```text
C:\Program Files (x86)\Steam\steamapps\common\Brotato\GodotWorkshopUtility.exe
```
5. Im Uploader bei der Mod-Datei diesen ZIP auswaehlen:
5. Select this ZIP as the mod file:
```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:
6. Optionally select a preview image. If the upload fails because of the image, try the first upload without one.
7. Leave the Workshop Item ID field empty.
8. Start the upload and wait for a success message.
9. If Steam asks for the Workshop Legal Agreement, accept it in Steam or in your browser.
10. Open the new Workshop item in Steam.
11. Set visibility to `Private`, `Unlisted`, or later `Public`.
12. Note the Workshop ID from the URL. Example:
```text
https://steamcommunity.com/sharedfiles/filedetails/?id=1234567890
```
Die ID waere hier:
The ID would be:
```text
1234567890
```
## Schritt Fuer Schritt: Update Eines Bestehenden Workshop-Eintrags
## Updating An Existing Workshop Item
1. ZIP neu bauen:
1. Build the ZIP again:
```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.
2. Start `GodotWorkshopUtility.exe`.
3. Select `dist\Brogether-Brogether-0.1.0.zip` again.
4. Optionally select the same preview image.
5. This time, enter the existing Workshop ID.
6. Start the upload.
7. After uploading, check the Steam Workshop title, description, visibility, and images.
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.
Note: The Godot Mod Loader wiki mentions that the uploader can overwrite the title during updates. Check the Steam Workshop item after every upload.
## Vorschlag Fuer Workshop-Titel
## Suggested Workshop Title
```text
Brogether - Online Multiplayer Prototype
```
## Vorschlag Fuer Workshop-Beschreibung
## Suggested Workshop Description
```text
Brogether is an experimental online multiplayer prototype for Brotato.
@@ -118,25 +118,25 @@ Not finished yet:
Use this only for testing with friends who know it is still experimental.
```
## Was Tester Danach Machen
## What Testers Need To Do
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.
1. Subscribe to the Steam Workshop item.
2. Wait until Steam finishes the Workshop download.
3. Start Brotato.
4. Enable Brogether in the mod menu if required.
5. Restart Brotato if the mod only loads cleanly after restart.
6. Open `BROGETHER` from the main menu.
## 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`.
- Mod does not appear: wait for the Steam Workshop download, restart Brotato, and check the mod menu.
- Upload cannot find the file: check the ZIP path and run `.\scripts\package.ps1` first.
- Upload fails with an icon: keep the icon below `1 MB`, preferably `512x512 PNG`, or test the first upload without an icon.
- Access denied or item stays hidden: accept the Steam Workshop Legal Agreement.
- Update creates a new item: enter the existing Workshop ID when updating.
- Steam upload/download logs can be found in places such as `Steam\logs\Workshop_log.txt` and `Steam\workshopbuilds\depot_build_<appid>.log`.
## Quellen
## Sources
- 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/