Team-15

Currently, the Dev branch is set to default. This is correct as this Dev branch should be treated as the main for our repository Vice versa, our main branch is intended to be our actual developmental branch that was used for a majority of the project. Sorry for the inconvenience.

The Team-15 GitHub REPOSITORY: Hello! This is the repository for Team-15 in CSC 3380. This repository consists of every branch and file that is associated with our game, "GYMRAT". We have developed this game over the course of around 3-4 months using Unity in C#. We used the Unity version 2022.3.46f1 to create the game and used VSCode to create scripts for the game in C#. The "GYMRAT" game is a platformer-fighter that consists of three levels and two bosses! We have created many folders and sub-folders in the Unity editor listed above to neatly organize where each asset or script is for the game. If you are looking to play the game to research and see how to further develop the game, please read the instructions below!

HOW TO RUN:

1. Make sure the Dev branch is selected on GitHub and clone the repository onto your computer/laptop to access all files.
2. Go to unity.com, create a Unity account, and download Unity Hub for your platform.
3. Download Unity Editor version 2022.3.46f1 and ensure that the script compiler that will be used is the VSCode Extension.
4. After downloading the editor, go to Add in the Projects section of Unity Hub
5. Add the repository by using the first option and finding the repo on your disk.
6. To find the repo through your disk, simply find the folder in your PC/laptop that is titled "GitHub" from there use the folder titled "Team-15".
7. Once done, load the Project, it should default to the title "Team-15", if not then just ensure that the repo is listed in the Project details.
8. The project may take a while to load as it is also loading ALL of the assets from the repo.
9. Additionally, download the GitHub desktop app to make commits easier and to create pull requests straight from the app. If the app is downloaded and has the repository cloned, make sure that the default branch titled "Dev" is selected before using the editor.
10. Also, in your VSCode, please download the appropriate extensions to run C#. These extensions are: "C#", "C# Dev Kit". Be sure to also have the "Unity" extension installed in VSCode to help make the scripts compile in the Unity editor. This should automatically pop up and install in VSCode when you are first installing the editor, but please make sure this extension is installed manuallly just in case.
11. Let the Unity editor reload and then go to the Scenes folder that is located in the Assets folder in the Project tab.
12. Click on the "MainMenu" scene
13. Once on the "MainMenu" scene, click on the option located at the top of the screen that says "Game"
14. Once in the "Game" option, change the option that says "Free Aspect" to "Full HD"
15. Set the Scale to 1x right by the "Full HD" option
16. Then, simply hit the Play button near the top of the screen to start the game.

HOW TO PLAY: Controls - WASD/Arrow Keys = Movement Space = Jump P = Jab L = Strong Kick K = Short Kick I = Uppercut X = Pickup Object Z = Use Object O = Drop Object/"GO!" to the boss area - Once standing at the end of the scene map at the area labeled "Go" with enough coins, pressing O transports you to the next area with the boss.

Iitch.io Link To Easily Play The Game on Browser: https://hdaren2.itch.io/gymrat