Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@BenEvelev
BenEvelev authored Oct 1, 2023
1 parent ce77f37 commit 37042b2
Showing 1 changed file with 36 additions and 0 deletions.
36 changes: 36 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,17 @@ Red Runner, Awesome Platformer Game.

It is now free and open source and always will be. :clap: :tada:

## Table of Contents:
- [Project Introduction](#Project-Introduction)
- [Getting Started](#Getting-Started)
- [Requirements](#Requirements)
- [Download](#Download)
- [Screenshots](#Screenshots)
- [Credits](#Credits)
- [Related](#Related)
- [Resources](#Resources)
- [License](#License)

| [:sparkles: Getting Started](#getting-started) | [:rocket: Download](#download) | [:camera: Screenshots](#screenshots) |
| --------------- | -------- | ----------- |

Expand All @@ -15,6 +26,12 @@ It is now free and open source and always will be. :clap: :tada:

[:movie_camera: **See the Trailer**](https://youtu.be/MO2yJhgtMes)

## Project Introduction

Red Runner is an open-source platformer that merges unique aspects of beloved games like ‘Super Mario Bros’ while also maintaining a level of simplicity similar to minimalist games like ‘Runner.’ It incorporates a colorful environment with a user-friendly control system, unifying the open-source community around a vibrant side-scroller.

Last Updated: October 2, 2020.

## Getting Started

Follow the below instructions to get started with Red Runner source code:
Expand Down Expand Up @@ -46,6 +63,25 @@ Also you can the build version of the Red Runner using the following ways:

- [:star: Download from Itch.io](https://bayat.itch.io/red-runner)

Once Downloaded, input the files into Unity, allowing for the software to do the rest and the game to run!

**Disclaimer: Unity requires payment or a granted license in order for users to utilize it.

## How To Play/ Controls

Red Runner is an innovative take on platformers, with the objective being to avoid obstacles and hindering objects while collecting coins that improve a players score and are saved/added onto the next game. The game can go infinitely long, so a distance meter is provided at the top of the screen to provide the total distance players have traveled, with unique challenges provided along the way.

Controls:
Keyboard:
Movement: WASD, Arrow Keys
Jump: Space, Up Arrow
Roll: Left Shift

Controller:
Movement: D-Pad
Jump: Y
Roll: B

## Screenshots

<p align="center">
Expand Down

1 comment on commit 37042b2

@BenEvelev
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a commit suggesting additions to the README. I believe the addition of a table of contents, a project introduction, a disclaimer for the payment of unity, a controls section, as well as an objective description would be suitable additions.

Please sign in to comment.