Skip to content

COSC-499-W2023/year-long-project-team-14

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Open in Visual Studio Code

alt text

Project Option 4 - Team 14

By Gabriel M, Jesse L, Justin M, Kibele S, Darion P

A 2D top-down shooter game designed for 1-2 players in local multiplayer mode, where they team up to battle against AI-controlled bots.

Assets acknowledgement:

Installation and Setup

To Run and Install the Game for Yourself:

  1. Install Unity Hub (https://unity.com/download)

  2. Install Unity Version 2022.3.10f1 from Unity Hub or from the release archive (https://unity.com/releases/editor/archive)

  3. Clone the repository using your version control software of choice (GitHub Desktop, Git Bash, Terminal)

  4. From Unity Hub, open “499 Project” folder within the “year-long-project-team-14” root folder (year-long-project-team-14 -> app -> 499 Project)

  5. Once the project is open, open the “Menu” Scene and hit the play icon to run the game.

  6. The Game is hosted on itch.io to play on web browser, to update or upload the web browser build follow these steps:

    • First return to the open project in unity. Then Select the drop down menu “File” from the top left of the screen. Then select the “Build Settings” option.
    • Once in the “Build Settings” menu select the platform “WebGL” and deselect the “Scenes/Test” from the “Scenes In Build” submenu as the unit tests are not needed to actually play the game. Then select the “Switch Platform” button on the button right of the “Build Settings” menu.
    • Once the platform has been switched you will want to have an empty folder on your computer that you can save your build to. Once you have that folder select “Build” on the bottom right of the Build Settings menu and select the folder you made to store the build. Then zip the folder.
    • Once you have the zipped folder open your internet browser and head to https://itch.io/. From here log into the “Mage Madness” account. If you are not automatically taken to the “Creator Dashboard” screen then select “Dashboard” from the menu bar. Next select the “Edit” button underneath the title for the “Mage Madness” project.
    • If the prior steps were successfully completed you should now be on the “Edit Game” page. From here navigate down the page until you see a section called “Uploads”. Then simply delete the current file that is under this section. Once the file has been completed you may select the “Upload files” button and simply select the zipped file that contains the build of the game. Once that file has been uploaded select the “This file will be played in the browser” option underneath the location of the zipped file that you uploaded.
    • Finally navigate to the bottom of the “Edit game” page and select the “Save” button. If all of the steps were correctly completed then the new build will successfully be uploaded.
    • To test this simply select the “MageMadness” tag on the menu bar, select the MageMadness project that is present and play the game.
  7. Please use the provided folder structure for your docs (project plan, design documentation, communications log, weekly logs, and final documentation), source code, testing, etc. You are free to organize any additional internal folder structure as required by the project. Please use a branching workflow and once an item is ready, do remember to issue a PR, code review, and merge it into the develop branch and then the master branch.

.
├── docs                    # Documentation files (alternatively `doc`)
│   ├── project plan        # Project plan document
│   ├── design              # Getting started guide
│   ├── final               # Getting started guide
│   ├── logs                # Team Logs
│   └── ...          
├── app                     # Source files
├── tests                   # Automated tests 
├── utils                   # Tools and utilities
└── README.md

Also, update your README.md file with the team and client/project information. You can find details on writing GitHub Markdown here as well as a handy cheatsheet.

About

year-long-project-team-14 created by GitHub Classroom

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages