-
Notifications
You must be signed in to change notification settings - Fork 1
Getting Started
We need to do some setup before you can get the project up and running. Please note that these instructions are for Users on Windows that are building for Android. The instructions may differ for users on different platforms that are building for different targets.
These are the tools you'll need. Go to "Page Name" to learn more about these tools.
- Unity Hub: https://unity.com/download
- Blender: https://www.blender.org/
- Git: https://git-scm.com/downloads
- Github Desktop: https://desktop.github.com/
You can install all of the above programs with this command line script
winget install --id=UnityTechnologies.UnityHub -e -h
winget install --id=BlenderFoundation.Blender -e -h
winget install --id=Git.Git -e -h
winget install --id=GitHub.GitHubDesktop -e -h
- Microsoft Visual Studio: You can install this alongside your Unity Editor, or download here if that doesn't work
- Jetbrains Rider: https://www.jetbrains.com/rider/
- Visual Studio Code: https://code.visualstudio.com/Download
Once you've signed in and setup Unity Hub, go to the Unity Download Archive and download Unity 2021.2.10. To install through unity hub, click the Unity Hub download button and you should be prompted to choose any additional modules to install alongside the Unity Editor.
If you didn't install any Script Editor from above, make sure Microsoft Visual Studio Community is checked.
If you want to build for Android, make sure you install
- Android Build Support
- Android SDK & NDK Tools
- OpenJDK
If you want to build for iOS, make sure you install
- TBD, I haven't done this before. If someone wants to figure this out, please do so and update this wiki page!
Then continue and wait for the unity editor to finish installing!
Start by cloning the project using Github Desktop or the git command line. The link to the repository is https://github.com/EmpathyBytes/Hive.
Once you have pulled the repository, open it using Unity Hub and if prompted, select the proper version. If you can't find where the project was cloned by Github Desktop, you can open the list of repos in Github Desktop, right click your repo, and then clean "Open in Explorer" (or similar prompt) to find the location.
Change the build target to the relevant platform (iOS, Android, etc.). You can change your build target by going to File > Build Settings, selecting your target, and click Switch Target. This may take a while to complete.
Address any errors in the Unity Editor. If any errors or warnings are present they will appear in the bottom left corner as yellow or red text. Click to open the console log. If you don't know how to solve any issues, please contact a team lead.