Build Versions Documentation

Documentation

Summary

Package Information

The package has the following folders & files, all listed with an asterisk and coloured green are required files for the asset to work. Those without are in red are not needed for the functionality but are required for some cosmetic features.

  • Carter Games/Build Versions/Editor
    • *BuildInformationEditor.cs
    • *BuildVersionsOptionsEditor.cs
    • *BuildVersionsEditorWindow.cs
    • *BuildVersionsManager.cs
  • Carter Games/Build Versions/Resources
    • LogoBV.png
    • Build Information Icon.png
    • Build Options Icon.png
  • Carter Games/Build Versions/Scripts
    • *BuildIncrementTime.cs
    • *BuildInformation.cs
    • *BuildVersionOptions.cs

Change Log: Shows the changes from previous versions of the asset.

Documentation: A pdf of the documentation to help you use the asset.

Install

Setup

This asset is designed to help automate a normally mundane task that most developers forget to change when making builds. The asset requires no setup on your part as it will do this itself when you first make a build. If you want to setup the asset yourself, just create an instance of Build Information & Build Versions Options and store them somewhere in your project. These can be created via the Create Asset menu via the path showed below

From here all you need to do is configure the asset to work as you wish. You can change the settings in the options scriptable object directly or via the convenient settings editor window.

Usage

Changing Types

This is the only element of the asset that is not automated, as we can’t read minds 😂 You can select a type of build via the tools menu. We’ve listed most common build types which we feel covers most of the types you will require. Should you want a different one, you can simply write it into the Build Information scriptable object.

Usage

Player Settings Systematic Versioning

When enabled the asset also updates the player settings for which ever platform you are currently on as well. The current version will not be transferred when you change platform. For the version to be correct on the new platform, you will need to set the version in the player settings to the last build’s version to keep the version in sync.

The version number in the settings MUST follow the x.x.x or major/minor/build style formatting which is common in the industry. The asset only support 3 numbers separated by a dot (.), any other combinations will cause issues or errors.

By default the asset will only increment the build number by 1 each build made. Should you wish to update the major or minor number you can do so manually or via the tools menu options.

Breakdown

Build Information

Here are detailed explanations of each inspector and what each option is…

Summary

The build information scriptable object is the object that stores the data for the current build. This is what gets updated each build automatically with the latest information.

Breakdown
  • Build Type – The type of build to display. This is manually set by you with the options in the Tools menu. The intention of this is to let users know if a build is a pre-release style of build such as an alpha or beta, or a full release.
  • Build Date – This holds the date from the machine that made the build’s system time. This gets updated automatically each time you make a build though you can set it manually if it doesn’t update for some reason using the Tools menu.
  • Build Number – This is the unique number for the build that is just a incremented automatically each time you make a build. It will also automatically adjust itself +/- 1 when changing the build number update time.
Breakdown

Build Versions Options

Summary

The build version options is the settings data object for the asset. Here you can change the settings that the asset uses when updating the build information.

Breakdown

These values can all be edited in the settings window access via the path shown on the image below. We recommend using the editor window instead of this, however this will show the options that work across any platform.

  • Asset Active – Should the asset be active? use this to toggle the asset on or off.
  • Build Number Update Time – This changes when the build information is updated. You can choose between 2 options:
    • Any Build – Will update the build number as soon as you start a build, any will update the information even if the build fails along the way for some reason.
    • Only Successful Builds – Will update the build information only when a build is successfully made.
  • Update Systematic Version Number – Toggles whether or not to change the x.x.x version number in the player settings when a build is made. This will only effect the last digit (the build/patch). If you want to change the major or minor you will need to edit it manually or via the Tools menu.
Breakdown

Settings Window

Summary

The settings window allow you to configure the build version options data in a nicer format. This will also display extra options that are platform specific.

Breakdown
  • Enable Asset? – This toggles whether or not the asset will function when you make a build.
  • Build Number Update Time – This changes when the build information is updated. You can choose between 2 options:
    • Any Build – Will update the build number as soon as you start a build, any will update the information even if the build fails along the way for some reason.
    • Only Successful Builds – Will update the build information only when a build is successfully made.
  • Update Systematic Version Number – Toggles whether or not to change the x.x.x version number in the player settings when a build is made. This will only effect the last digit (the build/patch). If you want to change the major or minor you will need to edit it manually or via the Tools menu.
  • Update Bundle Code – This only appears if the build platform is set to Android for the project. Having this set to true will update the bundle code number for the build.
Help

F.A.Q

The asset works by listening in to the pre & post build processes. These are automatically called by unity without needing any additional work. The asset updated the build information scriptable object at this time which keeps it up to date with the current builds.

If this happens, please let us know so we can investigate the issue. Do note however that the scriptable object values may not update if you have object open in the inspector. Instead you will find that you will need to close and open the object again to see the updated values. The asset can be toggled on and off, so please be sure that the Asset Active toggle is enabled for the version number to update.

This can happen if you switch the build update time mid project. We currently don’t have an automated fix for it but we are working on it for a future update. To mitigate this issue, simply manually change the build number down by 1 when switching to the Any Build type and up by one when switching to the Only Successful Builds type.

Please get in touch with us so we can do our best to help you out. Email: support@carter.games

Help

Additional Support

If you need any additional support or just have some questions you may get in touch via to following methods:

You can send me an email to the following address support@carter.games this is monitored and you will get a response within 72 hours of your request, though I normally get back to you within the hour. Note I’m UK based so if its the middle of the night for us I won’t be able to get back to you until the morning.

I have a community discord server, note that this is not just for asset support so please you the Leaderboard Manager channel in the server for your request. You can access this via assigning yourself the Assets role on the server. This is monitored and you will get a response within 72 hours of your request, though I normally get back to you within the hour. Note I’m UK based so if its the middle of the night for us I won’t be able to get back to you until the morning. The server invite link is below should you wish to use this method:

Join the Carter Games Discord Server!

Should you find an issue with our asset, the best way to let me know is via the report form on our website. you can access this via the link below:

Carter Games: Report an Bug/Issue in our products

Should you want to, you can send a message via my website contact form which we will get and response within 72 hours of your request, though I normally get back to you within the hour. Note I’m UK based so if its the middle of the night for us I won’t be able to get back to you until the morning. You can access this via the link below:

Carter Games: Contact Me