Skip to content

Unity Setup

Jump to bottom
Deadman edited this page Feb 24, 2024 · 8 revisions

The following guide is designed to assist you with setting up Unity and the SDK on your system. Follow the below steps carefully in order for a successful setup.

Preparing Unity

To ensure a successful setup, begin by following the steps below - only doing the steps which are necessary for you.

Step 1: Pre-Requisites

We need to ensure that the following pre-requisites are installed on your device, in our case it's only Git.

  • Begin by going to the Git Download Page and download the latest version of Git for your operating system.
  • From there, execute the installer and follow the on-screen instructions provided. There are quite a few options to configure during the installation, but for our use-case you can leave them all default.
  • After the installation is successful, you are required to reboot your machine in order for the Unity Editor to recognise Git's path on your system.

Important

While it may not seem like it's something you will need, but to correctly install this SDK for the first time - it'll be required down, as evident by upcoming steps.

Step 2: Unity & Unity Hub

By following the steps below, it'll ensure you have the correct Unity Editor version installed and ready to go.

  1. Unity Hub Steps:

    • Begin by navigating to the Unity Hub Download Page
    • From there, download the Unity Hub program and run through it's installation setup.

  2. Specific Unity Editor Version:

    • Once the Unity Hub has been installed, we need to install a specific version of the Unity Editor. In our case it's 2021.3.16f1.
    • To download and install the correct version automatically, copy and paste this link: unityhub://2021.3.16f1/40eb3a945986 into your default browser.
    • In doing so, it'll prompt you to open with the Unity Hub if installed on your device. Allow it to.
    • From there it will automatically download and install it for you!

Step 3: Creating a Unity Project

With the correct Unity version installed, and Unity Hub installed - we can proceed onto creating a fresh Unity project for the SDK.

  1. New Project:

    • Open the Unity Hub and navigate to the Projects tab in the left navigation bar.
    • Then, in the top right will be a bright blue New Project button, select that.

  2. Defining & Finalising the Project:

    • At the top there will be an Editor Version: drop down menu, select the version 2021.3.16f1.
    • For the projects template in the center of the window, select the 3D (Core) template.
    • Then, on the project details panel on the right. Choose your preferred Project Name and Project Location.
    • Finally, select the bright blue Create Project button in the bottom right.

Installing the SDK

Step 4: Package Installation and Configuration

The SDK requires Unity's Addressables package and certain steps to ensure a successful install of the SDK.

  1. Installing the Addressables Package:

    • Begin, by navigating to Window > Package Manager from the Unity Toolbar within your newly created Unity Project.
    • Then in the Package Manager window, in the Packages dropdown menu at the top, change the option from In Project to Unity Registry.
    • From there, search for the keyword Addressables in the search bar at the top right.
    • Finally, click the Addressables package itself then select the Install button at the bottom right.

  2. Setting up Addressables:

    • Once the Addressables package is finally installed, you may close the Package Manager window.
    • Now from the Unity Toolbar, navigate to Window > Asset Management > Addressables > Groups.
    • Once the window pops up, select the Create Addressables Settings button in the center. Once completed, you can close this window.

  3. Importing the SDK Package:

    • Now we can return back to the Package Manager by selecting Window > Package Manager from the Unity Toolbar.
    • Once opened, select the plus icon in the top left and click the Add package from git URL... option.
    • This will then prompt you to paste a git URL, in our case it will be https://github.com/Deaadman/ModComponentSDK.git.
    • Once you paste that URL link in, click the Add button. This will pull the latest version of the SDK from this GitHub Repository.
    • Wait for everything to finish importing and installing, then you can close the Package Manager.

Note

Follow these steps carefully to ensure a successful setup of the ModComponent SDK in your Unity environment.

What's Next?

Congratulations! You have now successfully installed the correct Unity Editor version, setup a new Unity Workspace, and installed the SDK!

Now you can start delving into the SDK itself. Below are some resources you can refer to for understanding the different parts of the SDK.

  • Workspace Information: A guide which introduces the various assets and tools packaged within the SDK.
  • Beginner's Guide: Learn how to create your first ModComponent mod with the SDK.
  • Unity Tips: General purpose tips that will be useful for any unity project.

Clone this wiki locally