Developer Setup Guide - UO-DFM/SimCityOttawa-Documentation GitHub Wiki

Setup Guide

This guide aims to list the platforms and software required to start working on this project.

Repositories and Project Pages

The following repositories and project management pages are used to manage and deliver this project:
Main Repository
Documentation Repository
Asset Repository
GitHub Project Management Page
Unity Cloud Dashboard

Loading and Running Project in Unity

VER: 2021.2.12f1

  1. Install the Unity game engine (https://unity.com/)
  2. In the Unity Hub, where the installer is installed, click on the gear and select "Add Modules" image
  3. Select to install the Android and iOS build support modules and install them image
  4. Clone the SimCityOttawa repository
  5. In the Unity hub under the Projects tab, select the arrow button next to the Open button and select "Add project from disk" image
  6. Navigate to where this repository was cloned and select the SimCityOttawa folder image
  7. Open the project
  8. Under the Project tab, navigate to the 'StartScreen' scene under (/Assets/Scenes/UI) and open it
  9. Click the play button at the top to run the game. image

Unity Gaming Services

  1. If you do not already have one, create a Unity ID here
  2. Navigate to the Unity Cloud and Sign In here
  3. If you have not already been invited, request from the DFM an invite to the Unity Cloud organization uottawa-dfm
  4. Select Projects from the menu on the left and select SimCityOttawa
  5. Use the Dashboard and corresponding service pages (eg. Cloud Save) to manage the cloud aspects of the game

Xcode and Apple Developer Account

You can install Xcode through the App Store on your Macbook device. For iOS building and Xcode testing, please refer to the iOS Building and TestFlight page.

In order to maintain builds for TestFlight, you will require the access to UO-DFM's Apple Developer account ([email protected]).

  1. Please contact the administrator of the project for requesting access.
  2. Once you have access to the the Apple account, login to App Store Connect for TestFlight management. (https://appstoreconnect.apple.com/login)
  3. Detailed steps for uploading new builds to TestFlight is included in iOS Building and TestFlight