Skip to content

Latest commit

 

History

History
33 lines (27 loc) · 1.99 KB

README.md

File metadata and controls

33 lines (27 loc) · 1.99 KB
Raw

The Best Game Ever

This repository contains the source code for our game that we are planning on making for Hacktober 2019! 👻

The documentation will be a heavy WIP!

How To Configure Unity to work with GitHub

For a quick and nice overview, I recommend watching this video!

  1. Make sure you have Unity 2019.2.8f1 installed. For instructions on how to get this, download Unity Hub from here.
  • The Free Unity version will do
  1. When Unity Hub is downloaded, install the specific version that is mentioned above under the Installs sidebar.
  2. Clone this repo to your computer and open Unity Hub and import in this project into it.

🎉 You did it, now your project can be opened in Unity Hub! This is where you go when you need to work on the project.

General Rules for Working on the project

  1. Make sure you pull down for any new changes from master by doing git pull --rebase origin master
  2. All work should be done in a feature branch eg. ms/issue-1
  3. ONLY push/commit your work when Unity is not open.

Project Hierarchy

  • Assets: Where all of the Unity Resources are in (DO NOT remove from this!)
    • _Game
      • Scripts: All of the scripts that are written for the game are located in here. (WIP, may include sub directories based on functionality)
      • Scenes: All of the levels that have been made out for the game are located here. This includes all terrain and pathfinding objects.
      • Sounds:
        • BGM: All of the background music will be here
        • SFX: All of the sound effects will be here
      • Prefabs: All of the templated GameObjects will be in here. (WIP, may include sub directories based on functionality)
      • Graphics:
        • Sprites: All of the 2D Art will be in here
        • Textures: All of the textures will be in here
        • UI: All of the user interface art will be here