Skip to content
This repository has been archived by the owner on Jun 29, 2021. It is now read-only.

Latest commit

ย 

History

History
267 lines (155 loc) ยท 12.3 KB

README.md

File metadata and controls

267 lines (155 loc) ยท 12.3 KB

๐ŸŽฎ๐Ÿค–๐Ÿ”ง๐Ÿ”จ Mech Combat Game ๐Ÿ”จ๐Ÿ”ง๐Ÿค–๐ŸŽฎ

License Issues Built with Release Dowloads

Table of Contents


Announcements

November 13, 2020

UPDATE: The Mech Combat is now packaged available on the following platforms:

  • Windows (64-bit)
  • MacOS

Download the latest version for your platform and run the executable file to start playing. Enjoy! ๐Ÿ˜„

November 2, 2020

UPDATE: When packaging the project, I noticed the content in the older versions cannot be executed on Windows. Therefore, when packaging this project, be advised that it will only package for your specific platform.

Introduction

Welcome to my Mech Combat Game! This is my first attempt at game development using Epic Game's Unreal Engine. It is a simple wave-based action arcade game where you control a robot and destroy mechanical spiders. If you would like to test play this game, you can either follow the instructions for Packaging the Game for Production if you have the Unreal Engine, or downloading the latest available version. If neither of those options worked, feel free to create an issue or contact me directly for a copy of the game. I hope you enjoy playing! ๐Ÿ˜„

NOTE: Unfortunately, I was unable to package this game for the following platforms:

  • Windows (32-bit)
  • Linux
  • Linux (AArch64)

Please follow the instructions for Packaging the Game for Production if you use any of these platforms. I apologize for the inconvenience.

Main Menu Reference

Supported Platforms

  • Windows (32-bit)
  • Windows (64-bit)
  • MacOS
  • Linux
  • Linux (AArch64)

IMPORTANT: This is a desktop based game. It was not developed for gaming consoles or mobile devices. Attempting to play this game on unsupported devices will generate a warning from the game and may result in other unexpected errors.

Environment

Forest Environment

The main level where your player lives is a forest environment. It is an open world environment containing bushes, trees, logs, etc. Enemies will be spawned into the environment in waves and the player will roam the area and try to survive and kill each wave.

Forest Environment Reference

Player Base

The player base is your home inside the forest environment. In your player base, this is where you will be able to upgrade your character's base stats, special attacks, etc.

WARNING: Careful not to stay in your base for too long; if the spiders sense you are in there, they can attack and destroy your base!

Player Base Reference

How To Play

Controls

The game can be played with a mouse and keyboard. The different controls are shown below:

Player Controls Reference

Shop Menu

The shop menu is where you can upgrade your character when you approach the workbench in your player base. You can find a sample of the shop menu below:

Shop Menu Reference

WARNING: When resetting your player stats, keep in mind that you will only be refunded a small amount of what you spent to upgrade your player

Heads Up Display

The heads up display (HUD) is where you will see your character's health, stamina, attack energy, etc. The full view of the HUD is shown below:

HUD Reference

Your Character

The Robo Dude

This is your character. It is a a humanoid robot that lives inside your forest environment and fends off mechanical spiders. It is not strong enough to destroy spiders with its hands, so it carries a sturdy hammer everywhere it goes in case it runs into spiders in the forest.

Robo Dude Reference

The Hammer

This is your robo dude's hammer. It is very strong and durable and capable of smashing pesky mechanical spiders. Without this hammer, the robo dude would not survive in the forest environment with all these spiders lurking about.

Hammer Reference

Enemies

Bomb Spiders

There are two types of spiders the robo dude encounters in its forest. One of them is the bomb spider. These spiders are harmless from afar, but very dangerous if they get close. Once they spot their target and get close to them, the bombs mounted on them active and explode. If your robo dude is within the blast range of this explosion it can deal serious damage.

Bomb Spider Reference

Turret Spiders

The other spider that your robo dude sees in its forest is the turret spider. These spiders don't do as much damage as the bomb spider, but they are much more intelligent. These spiders are mounted with turrets that fire off explosive projectiles. The projectiles can damage your robo dude AND your base. Since these turret spiders are long range enemies, they don't have to get close to hurt you, so watch out!

Turret Spider Reference

Items

Time Fragments

Each time your robo dude kills a spider, they drop a shiny crystal called a time fragment. These fragments can be used to upgrade your robo dude's basic stats, special attacks, etc.

Time Fragment Reference

Abilities

Whirlwind Attack

When your robo dude performs a whirlwind attack, it will spin itself and swing its hammer at high speed, damaging all enemies around it in the process

Whirlwind Attack Reference

Helicopter Attack

For the helicopter attack, your robo dude will rapidly spin its wrist while holding its hammer. This attack damages all enemies in front of the robo dude.

Helicopter Attack Reference

Leap Attack

The leap attack is most lethal attack in the robo dude's arsenal. It will propel itself into air towards its enemies and deliver a crushing swing to anything in its way.

Leap Attack Reference


IMPORTANT: In order to run this project in development or package for production, you will need to create an Epic Games account and download the Unreal Engine on your machine. Please visit the Unreal Engine for further instructions.

NOTE: The instructions I am providing are based on MacOS. These steps may differ for Windows and Linux machines

Building the Development Environment

  1. Open the Epic Games Launcher and click Launch Unreal Engine 4.x.x. It should look like the following:

Epic Games Launcher Reference

  1. When the Unreal Project Browser shows, follow these steps:
  • Click the More button

Select More Reference

  • Click Browse

Browse for Project Reference

  • Locate where you saved this repository on your machine and select MechCombatGame.uproject

  • Click Open Project

NOTE: If you have opened this project before, you can also select it from your Recent Projects List

  1. This should now open the main level of the game. From here, you can browse through the blueprint code, skeletal meshes and all other assets using the Content Browser at the bottom

Content Browser Reference

Blueprint Code Reference

Packaging the Game for Production

  1. In BOTH the Level1 and MainMenu levels, make sure the light quality is set to Production and click Build. This may take a few minutes depending on the performance of your machine

Build Level Reference

  1. In the Project Settings, make sure the Maps & Modes settings are the same as below:

Maps & Modes Reference

  1. In the Project Settings, make sure the Input settings are correct based on any changes made to the game. Below is an example:

Engine Inputs Reference

  1. In the Project Settings, make sure the Target Hardware settings are the same as below:

Target Hardware Reference

  1. In the Project Settings, make sure the Supporting Platforms settings are the same as below:

Supporting Platforms Reference

  1. In the Project Settings, make sure the Packaging settings are the same as below:

Project Packaging Reference

  1. Once you have completed the above steps, select File > Package Project > [ YourPlatform ]. This process may take several minutes depending on the performance of your machine. Below is an example:

Package Project Reference

IMPORTANT: When asked for a location, be sure to select a folder that you will remember the location of. For example, you can create a folder on your Desktop called MechCombat and select that folder to export everything to.

  1. In the folder you exported the project to, there should be an executable file containing the game. Congrats, you've just finished creating the game!

NOTE: Be sure to zip the folder so that the content is compressed before sharing this game with your peers.

NOTE: If any errors occur during the packaging process, be sure to carefully read the output log that is generated by the Unreal Engine

Contributing Guidelines

TBA

License

This project is released under the Apache 2.0 License

Acknowledgements

Thank you to Dev Squad Academy for providing me with tutorials to build this game โค๏ธ

Please also check these additoinal resources for more.

Version History