Skip to content

Commit

Permalink
Added .apk and .exe documentation to Project 1 (#184)
Browse files Browse the repository at this point in the history
VR headset and windows build how to guide (Apk and exe file types) - By Jarryd Connor
  • Loading branch information
ConnorJar authored Dec 3, 2024
1 parent edafc6c commit d3734ba
Show file tree
Hide file tree
Showing 11 changed files with 83 additions and 0 deletions.
83 changes: 83 additions & 0 deletions docs/project-1/vr/apk-exe-build-guide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
---
sidebar_position: 5
---

# How to update the APK and EXE files

It is essential to update the Android Package Kit (APK) and Executable (EXE) files of the VR game to include all the students’ additions to the game, creating a final build version playable on both a PC and a VR headset. The APK file is used to play the game on the VR headset in the Makerspace, while the EXE file can run on a variety of devices, including Windows, Mac, and Linux systems.

Update the APK and EXE files only after all updates from GitHub have been merged into a single, fully updated file.

Before attempting to update the build files, you may need to install some additional files into your Unity Hub.

### Step 1:

Open Unity Hub and click on ‘Installs’.

![Unity installs location](img/unityhub-installs-location.png)

### Step 2:

Click on the cog icon to the top right of your Unity install. Then click on ‘Add modules’.

![Unity modules location](img/unityhub-module-location.png)

### Step 3:

A new window should open and there will be many different modules. Install the ones that are highlighted as they are required to complete the build files.

![Required Unity modules](img/unityhub-required-installs.png)

### Step 4:

After installing the modules, open your updated game file. Now open the build settings by clicking ‘File’ > ‘Build settings’.

![Unity build settings](img/unity-build-settings.png)

### Step 5:

Click on ‘Player settings’ in the bottom left of the new window.

![Unity player settings](img/unity-player-settings.png)

### Step 6:

Update the version number so the build files are different from the previous builds. If this isn’t updated, it can cause issues. Also ensure that the product name doesn’t contain any spaces in the name. After updating the version number and checking the product name, the window can be closed.

![Build verion number](img/unity-version-number.png)

### Step 7:

Highlight ‘Windows, Mac, Linux’ in the platform options, then start the build process by clicking ‘Build’ in the bottom-right corner of the window. You will need to choose a location to save the build files. It’s recommended to create a new folder to keep all the files organised and in one place. Ensure this folder is saved in a memorable location so the files can be easily accessed and shared later. This step generates the EXE file.

:::important

This process can take a considerable amount of time, depending on the specifications of your device or PC. The build may take several hours to complete. Plan ahead and avoid leaving this step until the last minute. It’s best to set aside some time to leave it running a while.

:::

![Build button location](img/unity-build.png)

### Step 8:

After completing step 7, this prompt should appear. Click ‘Yes’. The files will begin building.

![Missing Project ID popup message](img/unity-popup.png)

### Step 9:

After completing the first build, click on ‘Android’. You will need to click ‘switch platform’ to get it ready to be built. After switching the platform, you will need to click ‘Build’ and select a file location to save the build files again. This step generates the APK file.

:::important

Again, this process can take a considerable amount of time, depending on the specifications of your device or PC. Plan ahead and avoid leaving this step until the last minute. It’s best to set aside some time to leave it running a while.

:::

![Switch platform button](img/unity-switch-platform.png)

### Step 10:

Create a new folder in the project 1 files with the trimester and year you are studying this unit. Upload the APK and EXE files to your new folder so they can be accessed by everyone.

![Build file share location](img/unity-build-file-share.png)
Binary file added docs/project-1/vr/img/unity-build-file-share.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/project-1/vr/img/unity-build-settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/project-1/vr/img/unity-build.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/project-1/vr/img/unity-player-settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/project-1/vr/img/unity-popup.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/project-1/vr/img/unity-version-number.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit d3734ba

Please sign in to comment.