Skip to main content Link Search Menu Expand Document (external link)
Captain Coder's Adventure Quest

Chapter 0: Setup

In this section, you will import the base Adventure Quest project into Unity. Before starting, you should ensure you have Unity 2021.3.XX. Although this project may work with other versions, it has not been tested.

Table of contents
  1. 01. Get the Project Template
    1. Option 1 - Using GitHub (Recommended)
    2. Option 2 - Download Zip (Not Recommended)
  2. 02. Adding Project to Unity Hub
  3. Good Time to Commit
  4. What’s next?

01. Get the Project Template

You can access the project template on GitHub here: LINK

Option 1 - Using GitHub (Recommended)

  1. If you have a GitHub account, select Use this Template > Create a new Repository

Use this Template

  1. Give your repository a name. I recommend calling it AdventureQuest.
  2. Click Create repository from template

Create Repository

After a few second your copy of the template should be available. Next, you will clone the repository. I’ve provided instructions below for using GitHub Desktop. If you have a preferred way of cloning the repository, you can skip to 02. Adding Project to Unity Hub

  1. Click Code > Open with GitHub Desktop

Open with GitHub Desktop

This should launch GitHub Desktop.

  1. Take note of the Local path setting. This is where the repository will be cloned. Optionally you can change the Local path setting.

  2. Click Clone

Click Clone

After a few moments, the template will be cloned to your computer.

Creating a Development branch

It is typically considered bad practice to work directly on your projects main branch. Instead, your team will typically have a development branch that will eventually be added to main when your project is ready to be released.

Before beginning, you should create a development branch. Below are instructions to create a branch using GitHub Desktop:

Creating a Branch with GitHub Desktop (Click to Expand)

  1. Select your project repository from the Current repository drop down.
  2. Click the Current branch drop down.
  3. Click New branch

Create New Branch

A dialog will open.

  1. Enter the name of the new branch (e.g. development)
  2. Click Create branch

Name New Branch

  1. Publish your branch to GitHub by clicking the Publish branch button.

Publish New Branch

You are now ready for 02. Adding Project to Unity Hub

Option 2 - Download Zip (Not Recommended)

If you use this option, your project will not be connected to a GitHub repository and you will not be able to make incremental commits.

If you do not have a GitHub account, you can download the template as a ZIP by clicking Code > Download ZIP:

Download Zip

02. Adding Project to Unity Hub

Note: This guide was made using Unity Hub 3.4.1.

This project uses Unity 2021.3.16f1. Although this project should convert to any version of Unity 2021, I highly recommend downloading this version for compatibility.

  1. Open Unity Hub
  2. Click the Projects Tab
  3. Click the arrow next to the Open button.
  4. Click Add project from disk

Add Project from Disk

  1. Navigate to your repository and select the folder within called “Adventure Quest”. This folder should contain a folder called Assets.

Select Folder

  1. The Adventure Quest project should now appear in Unity Hub. Double Click to open it.

Open Project

The first time the project is opened, it will take several minutes to load.

Good Time to Commit

Now would be a good time to make a git commit. You just finished a chore. More specifically, you just initialized the Adventure Quest Unity project.

Committing with GitHub Desktop (Click to Expand)

  1. Ensure the files you would like to commit are checked in the Changes tab.

Check the Files to Commit

  1. Enter a summary for your commit. Think of this as the subject line of an email. It should be SHORT and to the point. Aim to be less than 50 characters. It is good practice to prefix the commit with the type of work that was done. For example:

    • A feature: feat: Implemented Die class
    • A chore: chore: Added image assets to project
    • A bug fix: fix: Removed off by 1 error
    • A work in progress: wip: Partial implementation of DieGroup class

  2. Add a description to your commit. This should provide additional details about what is included in the commit. For example:

This commit adds a Die class which models a multi-sided die providing an
interface with 2 properties: `Sides` and `LastRolled`. Additionally, it provides
a single method: `Roll()` which "rolls" the die and randomly selecting one of
the sides.

Additionally, added unit tests to test the Die class specification.
  1. When you’re ready, click the Commit button

Add Description

  1. Lastly, push your commit to GitHub by clicking the Push origin button

Push to Origin

What’s next?

With the project setup and ready to go, you can proceed to 1: Creating A Die Roller.

Join the Discussion

If you're stuck, have questions, or want to provide feedback, you can do so below. However, I ask that you please refrain from posting complete solutions to any of the challenges.

Before commenting, you will need to authorize giscus. Alternatively, you can add a comment directly on the GitHub Discussion Board.