Skip to content

Team-Aston-Martin-Henz/Cyberacer

Repository files navigation

CP2106 Orbital - Independent Software Development Project

m_merged

Motivation 🔥

Stemming from the love of racing games and pixelated art style, Cyberacer is a pixelated racing game developed for CP2106 Orbital - Independent Software Development Project.

By developing the game, we aim to bring joy and offer an engaging experience to casual gamers who enjoy retro racing games. We would also like to pick up skills and knowledge related to game development, such as game design principles, C#, Unity, version control using Git and GitHub and more.

Through the development process, we aim to learn and apply software engineering practices. For example, object-oriented programming, user testing, single level abstraction principle, singleton pattern and etcetera.

Last but not least, we also want to simply have fun and enjoy the process of game development!

Current Features 🎮

  1. 24 avaiable vehicles
  2. 3 tracks + 1 practice track
  3. Player vs bot.
  4. Lap time, total time and best lap time display
  5. Pixelation of scene assets
  6. Settings for gameplay

Developer Guide 🧑‍💻

How to Contribute 💡

  1. To contribute to the development of Cyberacer, please download the following dependencies first.

    • Unity Engine and Unity Hub (Cyberacer is built with 2020.3.13f1)
    • WebGL / Windows / Mac build supports (recommended)
    • Version control e.g. GitHub Desktop
  2. Fork from this repository to implement your features. Please remember to fork from master branch.

  3. Commit, contribute and create pull requests!

Note 📝

  1. To maintain consistency and ease for future development, please strictly adhere to the directory structure in Assets:

    000 Asset: For external assets imported, asset categories can be further extended

    001 Lighting Setting: For light settings in the game, various light settings can be further categorised by usage in the respective scenes

    002 Colour Material: For materials created by developers, different materials can be further categorised by the type of object on which the materials are applied on

    003 Race Prefabs: For game prefabs that are commonly used by the developer

    004 Scripts: For all C# scripts written for the game

    005 Sound Mixer: For sound mixers

    006 TextMesh Pro: For font-based assets

    007 Scenes: For different scenes, categorised according to tracks

    008 Sound: For SFX assets.

  2. Common issues and reminders for game development can be found in GitHub Issues (Open & Closed). Do read through them as some of the common bugs can be easily solved with the instructions given.

User / Player Guide 🕹️

How to Download 💾

Please click on the links below to download the latest version of the game.

  • For better performance on your specific platform:
    • Mac users: click here
    • Windows users: click here
  • Otherwise:
    • WebGL build: click here

Game Controls ⌨️

Key Usage
W / UP Accelerate
S / DOWN Reverse
A / LEFT Left turn
D / RIGHT Right turn
Esc Go to pause menu
C Toggle camera angle (top-down / follow-up)
R Reset vehicle position

All games controls can be likewise found in the How To Play menu in the game!

Troubleshooting 👨‍🔧

Below are the common user-end bugs and issues and their respective remedies:

  • Game freezes

    Try restarting the game!

  • Game not loading on WebGL

    Accept all cookies on Unity Play website. Refresh the page several time if the problem persists.

  • Game does not have sound on WebGL

    Have you tried toggling the mute button 🔇? Unity Play will start on mute by default.

Feedback 📋

Regardless whether you are a player / user or a fellow developer, all are welcomed to send in your feedback through our Microsoft Form!

Deliverables and Publications 📰

Lift-Off 🚀

  • Proposal: click here
  • Video: click here
  • Animated Poster: click here

Milestone I 🎯

  • README: click here
  • Project Release: click here

Milestone II 🎯

  • README: click here
  • Video: click here
  • Animated Poster: click here
  • Project Release: click here

Milestone III 🎯

  • README: click here
  • Video: click here
  • Project Poster: click here
  • Project Release: click here for macOS & here for Windows

Splashdown 🪂

  • Coming soon...