BLDR SDK Quick Set-Up Guide

Download the SDK

First, you need to download the SDK. You can do this two ways: you can download a zip file or you can copy the repository to your device using GitHub. While both ways work, we suggest copying the repository over downloading a zip file. Copying makes it easier to handle changes and it's simpler for others to help if they can copy your current SDK Project version.

You can locate this repository at the following URL: https://github.com/DigitalVillage-io/V-BLDR-Unity-SDK/. Alternatively, you might already have direct access to the project via your GitHub account.

Download Unity Hub, and the Correct Version of Unity

After preparing the folder, ensure you have a compatible and functional Unity environment. Start by downloading Unity Hub from https://unity.com/download. Unity Hub lets you download multiple versions of Unity. For the SDK Project, you need version 2021.3.16f1. You can get older Unity versions at https://unity.com/releases/editor/archive. When downloading version 2021.3.16f1, don't forget to install the WebGL module. This is needed for this Unity version to work with the project. During Unity's installation process, you'll be asked if you want to install it. If you miss it, you can install the module later. If you need help, there's a tutorial at https://docs.unity3d.com/2020.1/Documentation/Manual/GettingStartedAddingEditorComponents.html.

NOTE: The version of Unity used by the SDK may be subject to change in future but you will be alerted ahead of time of any planned version updates. Unity Hub will automatically prompt you if you attempt to open the SDK with a different version of Unity than needed.

Opening the Project

After downloading the SDK Project and installing the required version of the Unity Editor along with the WebGL module, you're ready to open the project. For guidance on how to open an existing project, refer to this blog post: https://blog.terresquall.com/2022/11/how-to-identify-a-unity-project-folder-and-open-it-in-the-unity-editor/#:~:text=Open%20Unity%20Hub%2C%20then%20navigate,3.0%20the%20button%20is%20ADD.&text=Now%2C%20all%20you%20have%20to,the%20downloaded%20project%20is%20stored.

Try a Test Build

After opening the project, it's a good idea to check if everything was imported right and without any problems. You can do this by doing a test build of the asset bundles. Don't worry, the default scene and objects have the right labels to make a build.

What you need to do is open the BLDR SDK Window (go to Windows/BLDR SDK Window) and hit "Build all Asset Bundles."

If everything is fine, the project will start making bundles. This could take some time, especially if it's your first time building bundles for a project. That's because Unity needs to do a lot of first-time compiling.

When the bundles are ready, you'll find them in your Unity Project's main folder, in the "AssetBundles" folder. If you can't see this folder, it's likely your bundles weren't made, as this folder is automatically created during the build process.