146 lines
4.8 KiB
Markdown
146 lines
4.8 KiB
Markdown
# Brogether Steam Workshop Upload
|
|
|
|
Status: 2026-05-23
|
|
|
|
This guide describes the simple upload path for Brogether using Brotato's bundled `GodotWorkshopUtility.exe`.
|
|
|
|
## Requirements
|
|
|
|
- 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
|
|
```
|
|
|
|
After that, the ZIP is here:
|
|
|
|
```text
|
|
dist\Brogether-Brogether-0.1.0.zip
|
|
```
|
|
|
|
The same ZIP is also copied to `releases\Brogether-Brogether-0.1.0.zip`. The `releases/` copy is committed to Git so testers can download the latest mod ZIP directly from the repository.
|
|
|
|
- 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.
|
|
|
|
## Before Uploading
|
|
|
|
Brogether is still a prototype. For the first Workshop item, the recommended settings are:
|
|
|
|
- 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.
|
|
|
|
## First Upload
|
|
|
|
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. Start Brotato's Workshop uploader:
|
|
|
|
```text
|
|
C:\Program Files (x86)\Steam\steamapps\common\Brotato\GodotWorkshopUtility.exe
|
|
```
|
|
|
|
5. Select this ZIP as the mod file:
|
|
|
|
```text
|
|
C:\Users\tommi\Documents\PotatoConnect\dist\Brogether-Brogether-0.1.0.zip
|
|
```
|
|
|
|
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
|
|
```
|
|
|
|
The ID would be:
|
|
|
|
```text
|
|
1234567890
|
|
```
|
|
|
|
## Updating An Existing Workshop Item
|
|
|
|
1. Build the ZIP again:
|
|
|
|
```powershell
|
|
.\scripts\package.ps1
|
|
```
|
|
|
|
2. Start `GodotWorkshopUtility.exe`.
|
|
3. Select `dist\Brogether-Brogether-0.1.0.zip` again. The committed copy in `releases/` is the same ZIP, but `dist/` is the local upload path used by the scripts.
|
|
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.
|
|
|
|
Note: The Godot Mod Loader wiki mentions that the uploader can overwrite the title during updates. Check the Steam Workshop item after every upload.
|
|
|
|
## Suggested Workshop Title
|
|
|
|
```text
|
|
Brogether - Online Multiplayer Prototype
|
|
```
|
|
|
|
## Suggested Workshop Description
|
|
|
|
```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.
|
|
```
|
|
|
|
## What Testers Need To Do
|
|
|
|
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 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`.
|
|
|
|
## 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/
|
|
- Steamworks Documentation: Steam Workshop Implementation Guide: https://partner.steamgames.com/doc/features/workshop/implementation
|