README.md

Build Uploader

This package helps streamline uploading builds to online services such as Steam. It is designed to work with the Steam SDK and optionally Unity Build.

• Supports
  • Unity 2021 and above.
    • No package dependencies
  • Unity 2020 and below.
    • Requires package com.unity.sharp-zip-lib
• Minimal build size impact
• Can be used commercially
• Open Source

Links

• Support Me: https://buymeacoffee.com/jamesgamesnz
• Discord: https://discord.gg/R2UjXB6pQ8
• Github: https://github.com/JamesVeug/UnitySteamBuildUploader

How to install

1. Add package to your project

• Open Window->Package Manager
• Press the + button in the top left
• Choose Add package from git URL
• Enter the git url https://github.com/JamesVeug/UnitySteamBuildUploader.git
• Press Add
• Unity 2020 and below
  • Repeat above steps with but using com.unity.sharp-zip-lib

2. Setup

• Go to Edit->Preferences->Build Uploader
  • Download SteamSDK and extract it to a folder on your computer
    • Enter the path to the SteamSDK folder (https://partner.steamgames.com/downloads/list)
  • Enter your steam login details
  • Enter Unity Cloud details (Optional)

• Go to Edit->ProjectSettings->Build Uploader
  • Press New
  • Enter the name of your game
  • Enter the AppID of your game. (Found in the URL of your games store page. eg: 1141030)
  • Press + to create a new depot for your game
    • Enter a name for the depot
    • Enter the depot ID (Found in the Steamworks website eg: 1141031)
  • Add any more branches that you need (none is also known as default on steamworks)
• Go to Window->Build Uploader
  • Press New
  • Choose where your build will come from
    • Choose Manual to choose a file from your computer then select the .zip or .exe of your game
  • Choose where your build will go
    • Choose Manual SteamWorks if you want to upload to steam
    • Choose which game you want to upload it to
    • Choose Depot
    • Choose Branch
  • Press Save

3. Upload

• Go to Window->Build Uploader
  • Select which build you want to upload
  • Choose where you want to upload it to
  • Enter description of the build (eg: v1.0.1 build 123 - Fixed jumping bug)
  • Press Download and Upload all

Upload Tab

Specify where you want builds to come from adn where you want them to go.

• You can specify a file on your computer or choose from your UnityCloud builds.
• Choose where you want the build to go (Steam depot & branch)
• Set a description to appear on steam
• Click Download and Upload all

NOTE: You can not upload to the default branch (default branch everyone uses). This is on purpose to avoid uploading the wrong build. Also the SDD does not allow this.

Unity Cloud Tab (Optional)

Utilize Unity Cloud to automate make builds of your project.

• Tracks progress of current builds
• Start a new build
• Download builds

Security

This package does NOT distribute any personal information. Any information entered is stored locally on your computer and not in plain text format.

Keeping your credentials safe is important to me!

If you discover any security related issues, please email me, message on discord or create an issue on github.

Reporting bugs / suggesting changes

If you find a bug or want to suggest a change, please create an issue on the github page.

How to contribute

• Fork the repository
• Make your changes
• Create a pull request to the develop branch
  • Include detailed description of the changes you made
  • Include what version of Unity you tested it on
  • Include any concerns with the changes you made

Known Issues

• Two-Factor authentication does not save between sessions. Don't know why.

License

Creative Commons - CC0 1.0 Universal

Use this package however you want - commercially or non-commercially.