Skip to main content

Advanced Projects

Below are the more advanced configurations for UBuild Project.

Compression

UBuild can compress your builds to a single zip file. There are three options of compression:

  • Don't Compress - This build will not be compressed.
  • Compress - This build will be compressed.
  • Compress & Clean - This build will be compressed, after which all files which have been compressed will be deleted. (leaving only the compressed file)

GitHub

UBuild can Fetch & Clone from Git, to achieve this follow the steps below:

  1. Within the Project configuration file, update the following:
    • ProjectFolder: This is your Git repository's URL. (ie: the URL you would usually clone from)
    • GitUser: This is the user you would like to authenticate as.
    • GitToken: This is your legacy Git token that will be used during authentication.
    • GitBranch: This should be the branch you wish to use.
  2. If all these details are correct UBuild can now clone the specified repository to the "/Git/" folder once you queue a build, after it has cloned, by default, it will now fetch before building to ensure the repository is up to date.
  3. Optionally, within your selected preset, you can set "ForcePullFreshProject" as "true" to ensure a fresh repository is created for each build. (this can be found within your Project configuration file)

Steam

UBuild can integrate directly with Steam to publish your build to Depots & branches. This system uses SteamPipe and a Steam developer account is required to use this feature.

To upload your builds to Steam:

  1. Within your Project configuration file, update the following:
    • SteamAppID: This is your Steam AppID.
    • SteamUsername: This is the Username of the user you would like to login with.
    • SteamPassword: This is the password you would like to use.
  2. For each of your SupportedPlatforms you can specify which SteamDepotID to publish the build on.
  3. Within your BuildPreset you can also specify which SteamBranchName to publish your build on.
    (Note: This uses SteamWorks "SetLive" which will automatically publish the changes to the branch available, this isn't allowed for your default branch. (read more))

FTP

UBuild can upload completed builds, neatly to an FTP site of your choice.

UBuild will also mention the path to this build in email notifications. (if enabled)

To configure FTP follow the steps below:

  1. Within the Project configuration file, update the following:
    • FTPHost: This is the remote site you would like to upload to.
    • FTPHost: This is the user with access to the above remote FTP site.
    • FTPPassword: This is the password associated with your FTP user.
  2. Ensure that your selected Preset has "SendToFTP" as "true". (this can be found within your Project configuration file)

Email

UBuild has support for email notifications of build success & failure.

In its most basic form, this will allow you to receive remote notification of complete builds, but if expanded upon, allows you the option of further automation after the build process has been completed such as Jenkins jobs, forwarding to QA teams, triggering Power Automate scripts etc.

Commercial License holders can skip step 1. If you wish, as a Commercial License holder you can use the UBuild Emailing Service.

To set up email notifications, please follow the steps below:

  1. Within the Project configuration file, update the following:
    • SMTPServer: This is your SMTP email server address (usually something like "mail.mydomain.com")
    • SMTPPort: This is the port at which your SMTP server is listening. (usually 587)
    • EmailUser: This is the email address to login with.
    • EmailPassword: This is the password associated with your EmailUser.
  2. Within the Project configuration file, update the following:
    • EmailTo: This is the address to send emails to.
  3. Ensure that your selected Preset has "SendToEmail" as "true". (this can be found within your Project configuration file)
Back to top