Getting started with UBuild
This is a guide to using UBuild, this book is recommended for those using UBuild for the first time.
Welcome to UBuild!
Thanks for checking out UBuild, I hope you find the tool useful! This is a "How-to" guide on UBu...
Setup
First thing's first, let's get you setup!
Installation
Below you can find details on how to install UBuild. Requirements Windows 10.0.17763.0+ .NET...
Creating your first Project
Here we will cover how to create your first Project within UBuild, although it is not required; s...
Basic Usage
The steps below show the process of queuing a build within the UBuild user interface. Before fol...
Projects
Creating, modifying and using Projects within UBuild.
Advanced Projects
Below are the more advanced configurations for UBuild Project. Compression UBuild can compress ...
Supported Platforms
Supported Platforms allow you to specify which platform you're building to, this is usually an op...
Build Presets
Build Preset allows you to easily save pre-configured builds for later, this saves you from havin...
Advanced Build Presets
Below are some advanced methods of configuring Build Presets. These settings can be found within ...
App Configuration
How you can configure app specific settings.
User Configuration
The user configuration file stores user specific app state information. This information can vary...
API Configuration
This configuration file is used for storing information used by the UBuild API server. Here you ...
License Configuration
The license configuration file is used to store details about the current license. This will ...
API
How to remotely interact with UBuild!
Basic Usage
Welcome to the UBuild API, a remote interaction service within the UBuild tool. This API allows y...
Retrieving Information
Using the UBuild API you can retrieve information using the HTTP GET method. Methods Below are ...
Sending Information
You can send information to the UBuild API to add builds to the queue, cancel builds and if neede...
Logging
How and where UBuild logs things.
UBuild Logs
UBuild stores all application messaging in a logging file within the Logs folder. This file will ...
Unity Logs
When building with Unity, all messaging is sent to a file within the Logs folder. This file will ...
Unreal Logs
When using Unreal, all logging messaging will be sent to a file within the Logs folder. These fil...
Git Logs
There are two sources of Git logging for their respective operations, Clone and Fetch. All messa...
Reporting
UBuild creates build reports for every build it attempts to process. These UBuild Reports contain...
Integrations
UBuild comes with some pre-made integrations with other apps like Unity & Postman.