COMP 325 Guide

COMP 325 Guide

Group Project

Getting Started

Setting Up GitHub

Every computer in the Lab has an application called GitHub Desktop. This program is a graphical interface for Git. You do not need to worry about signing in to your specific account within this application, instead there is already an account signed in. On this account there is a Repository for your groups project already on it. The first set up task is adding yourself (and your group mates) as collaborators on the GitHub Repository. To do this:

 

  1. Go to your groups computer in the VR Lab

Inside the VR Lab in Briggs 121, there are 6 computer stations along the walls of the room. Each group has their own workstation with they groups name listed on a sticky note on the computer monitor. Find the group you are in via the canvas project 3 assignment and find that name on one of the computer monitors. You will then log in with the given credentials on one of the whiteboards in the room.

  1. Go to http://www.Github.com on Google

Google Chrome is installed on all the computers in the lab. Open Chrome and in the search bar simply type Github and the first result should lead to your groups account dashboard. If this does not lead you to your groups dashboard check to make sure the address has correctly led you to www.github.com. If prompted to log in, click the password box and chrome should begin to autofill the password.

  1. Click the repository on the left with your groups' project name

On the left hand side of the dashboard, there are the most recent Repositories created under the account. Since each account should only have one repo, there should only be one item listed here. Alternatively you can also navigate to github.com/yourAccountUsername/yourGroupsProjectName.

  1. Go to the settings tab near the top middle of the page

At the top of your repository’s page, you’ll see several tabs (such as Code, Issues, Pull requests, and Settings). Click on Settings this is where you can manage repository options, permissions, and collaborators. If you don’t see the “Settings” tab, make sure you’re inside the repository view (not the main account page). The page’s URL should be something like github.com/yourAccountUsername/yourGroupsProjectName.

  1. Go to the collaborators section near the top left

Once you’re in the Settings view, look at the menu on the left-hand side. One of the first items will be “Collaborators” (under the Access or Repository access category).

Click Collaborators to open the page where you can invite others to work on your project.

  1. Continue through the validation step (password will auto-fill)

Before you can add collaborators, GitHub requires a quick security verification step to confirm your identity.
When prompted:

  • Simply click the password box to let Chrome autofill it automatically.

  • Click Confirm to proceed.

  1. Click add people and add all members of the group

After passing the validation step, you’ll see an “Add people” button. Click it to open a search box where you can enter your teammates’ GitHub usernames or email addresses.

Add each member of your group one by one. Once added, they will receive an email invitation to join the repository. Each person needs to accept the invitation before they can access or edit the project.

When all members have accepted, everyone will have shared access to the group’s repository.

Quick Start

Starting Unity

This section explains how to open Unity and access your group’s project file on the lab computer.
Follow these steps each time you begin working in the lab.

 

  1. Go to your groups computer in the VR Lab

Inside the VR Lab in Briggs 121, there are 6 computer stations along the walls of the room. Each group has their own workstation with they groups name listed on a sticky note on the computer monitor. Find the group you are in via the canvas project 3 assignment and find that name on one of the computer monitors. You will then log in with the given credentials on one of the whiteboards in the room. If the computer has some pop up like “finish setting up…” click the no or remind me in 3 days button.

  1. Open the “Unity Hub” Application

The unity hub app should be on the desktop, taskbar, and start menu. its a grey square icon

  1. Click the project tab and then open your groups project

If on a personal computer, make sure you add project from disk then navigate to your project destination. If you don't have the project on your computer yet go to the git hub instructions. If stopped by the editor saying to download the correct version, make sure you do so.

Starting VR

This section covers setting up the Meta Quest 3 headset and connecting it to your computer via Steam Link. Follow these steps each time you want to test your Unity project in VR.

 

  1. Turn on the VR headset associated with your groups computer

the power button is a circle on the left side of the headset, hold that down for a few moments, you should hear a noise and see a light on the front of the headset if successful

  1. Adjust head strap and IPD to your specifications

the large circle on the back of the headset loosen and tightens the strap. If the image looks blurry you can move the distance between the lenses on the headset to better match your specifications.

  1. Hit “continue session” if promoted

Since the headsets are in a special configuration, they use “sessions” if possible hit continue, for what we are doing we do not need a new session every time.

  1. Open the “Steam Link” app

The Steam Link app allows for the headset to connect to the computer, this app may be found in the app section in the bottom menu. It may also be in the quick access section up top.

  1. Open Steam on your groups computer

The steam app on the PC’s are on the desktop, taskbar and start. make sure to open it.

  1. On the Headset, connect to the computer associated with your groups computer’s name

All the computers are called “RhodesVRX” with the X being the number. This name and number can be found on both the desktop image near the top right, and also on a sticky note on the computer tower itself.

  1. After connecting, open Unity on the PC, launch your project, and run.

After running it should automatically appear in the headset, if not please contact me.

  1. Troubleshooting tips (if needed)


  • If the headset isn’t detected:

    • Restart Steam Link on both the headset and PC.

    • Check that SteamVR is installed and up to date on the PC.

  • If Unity play mode doesn’t show in the headset:

    • Stop Play mode, close SteamVR, and reopen it before retrying.

    • Check that OpenXR is the active runtime in SteamVR (Settings → Developer → Set SteamVR as OpenXR Runtime).

Best Practices

version control

To keep your Unity project stable and your group’s workflow smooth, follow a version of trunk-based development: a simple method where everyone works directly from one shared branch (main) and commits small, safe updates often. The goal: no broken builds, no lost work, no merge conflicts.

 

  1. Always Pull Before You Start

Before opening Unity:

  • Open GitHub Desktop.

  • Click Fetch OriginPull Origin to get the newest version of the project.

  • Only open Unity after pulling.

This ensures you’re working on the current version of the scene and assets.
If you forget this, you might edit outdated files and cause merge conflicts.

  1. make small incremental commits

Work in small chunks rather than big, risky changes.
Examples:

  • Add one script or feature.

  • Update one prefab or scene component.

  • Adjust one mechanic or animation.

Smaller commits are easier to test, review, and merge without conflicts.

  1. Test in Unity Before Committing

  • Run your scene in Unity (Play Mode) before you commit.

  • Fix any console errors or missing references.

  • Make sure the project still runs in VR if relevant.

This keeps the main branch stable for everyone.

  1. Only One Person Edits a Scene at a Time

Unity scene files don’t merge cleanly.
Before editing a shared scene, coordinate with your teammates so two people aren’t working on it simultaneously.

Avoids painful scene merge conflicts.
If you need to make parallel edits, create temporary additive scenes (like SceneName_Jack.unity) and merge them manually later.

  1. Communicate Frequently

Use your group’s preferred method of communication to:

  • What you’re working on

  • What you just pushed

  • Any problems or Unity errors

This prevents two people from overwriting each other’s work and keeps everyone aligned.

  1. Back Up Before Major Changes

If you’re about to make a large edit (e.g., reworking a core prefab or environment scene):

  • Make a quick duplicate of the file and name it with today’s date (e.g., MainScene_2025-11-07.unity).

  • Commit that backup first.

  • Gives you a fallback in case something breaks.