Skip to content

BC-Unity-Project-2022/Unity-Catastrophe-Island-Game-2022

Repository files navigation


Logo

Welcome to Catastrophe Island! How long will you survive?

Find Out More »

Introduction

Catastrophe Island is a Brighton College Unity Project, made by a group of 4 L6th pupils, as detailed in the Contact Section below.
It is a single-player survival game, whereby the player aims to survive the infinitely imminent disasters that wreck havoc across the map for as long as possible.
It is made using the Unity Game Engine, and was created across approximately 6 weeks at the beginning of 2022.

(back to top)

Usage

To download and use Catastrophe Island, you must first meet the prerequisite criteria.
After you have checked that the criteria are met, read and follow the instructions to download and run Catastrophe Island, as detailed below.

Prerequisites

To use Catastrophe Island, you need to ensure your system:

Downloading & Running

From the repository home page, locate the Releases section, and pick the version you wish to install. It is recommended that the most recent version is installed, which will be found at the top of the list.

Under the release title and description, click the 'Assets' button, and select the first link from the drop down list.
This should be called 'Source code  (zip)', and look like this:
image

Then save the zipped folder, and extract the files into your desired location.
The application is now downloaded. Now just navigate to the save location, open the unzipped folder, and run the Catastrophe Island.exe file.

(back to top)

Branches

The Catastrophe Island GitHub repository consists of 2 branches:

These branches are each dedicated to the 2 aspects of the project, as follows...

Main

Main is the main branch of the project, and is dedicated to storing the unity source code to the most up to date version of the project. This branch can also be downloaded via GitHub and opened in a Unity Editor.
NOTE: This branch is not up to date With the latest release (See Releases), so please run with caution!

Build

Build is the second branch of the project, and is dedicated to storing the built version of the currently released version of the project.
This branch contains the executable and all other necessary files to run the build of the project, and is updated to match the latest version of the project.

(back to top)

Releases

Official releases of Catastrophe Island can be found by navigating to the Releases section from the home page of the repository. In that section is a list of all versions released, which can each be individually downloaded as per the Usage Instructions above.

Catastrophe Island uses semantic versioning to label each official release.
This is where the version number is arranged into the following format: AA: BB: CC - ...

  • The number at AA is incremented whenever a non-backwards compatible version is released, like a major overhaul of the application.
  • The number at BB is incremented whenever a backwards compatible, major version is released, such as a feature update.
  • The number at CC is incremented whenever a small patch or bug fix is made, not adding any new features to the application.
  • The characters at ... indicate the type of version that has been released, giving an indication as to the current stage of development.

You can read more on semantic versioning here.

(back to top)

Announcements

Announcements for the project are made in the Discussions Panel, under the Bug Fixes & New Releases discussion thread.

This is where information announcements will be made, mostly about new releases, but occasionally about other aspects of the application.

You can also subscribe to the thread to receive notifications when an announcement is made, by clicking the 'Subscribe' button on the side-panel, which looks as follows:
image

(back to top)

Bug Reporting

Bug reports for Catastrophe Island can be made in the Issues Panel of the repository.
Here, a user may respond to your issue, and it will be determined how the issue should be approached.

Please do not use the New Features & Ideas to report bugs, as this should be reserved for 'Feature Requests', as detailed in the Feature Requests section below.

(back to top)

Feature Requests

Feature Requests for Catastrophe Island can be made in the Discussions Panel, under the New Features & Ideas discussion thread.

This is where users can mention improvements to the application that they think should be made in a future release, so that other users can respond, and the feature can be considered in development.

You can also subscribe to the thread to receive notifications when a feature request is made, my clicking the 'Subscribe' button on the side-panel, which looks as follows:
image

Please do not use the Issues Tab to suggest new features, as this should be reserved for 'Issues' to be opened, as detailed in the Bug Reporting section above, and the feature request may not be seen.

(back to top)

Roadmap

You can find a basic overview of the general direction the project will take on this project board. Please note that this is not an offical roadmap for the project, and is rather used by the development team to plan the development of the game.
You can also visit the New Features & Ideas Discussion Thread to see other unofficial features that may make it into future releases.

(back to top)

Contact

Contact the development team via the following email addresses:

  • Kieran Lock
  • Alice Spink
  • Michael Nekrasov
  • Callum Smith

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)