Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
xGauss05 authored Dec 18, 2022
1 parent 354d358 commit 651bc56
Showing 1 changed file with 28 additions and 16 deletions.
44 changes: 28 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# Super Metal Boy
- [Repository LINK](https://github.com/xGauss05/PlatformerGame)

## Description

A simple 2D platformer that has some levels to play with. Our metal protagonist is able to walljump in order to reach the goal.
Expand All @@ -9,31 +10,42 @@ A simple 2D platformer that has some levels to play with. Our metal protagonist
- Four levels.
- Player is able to wall jump.
- Player is able to double jump.
- Two types of enemy, Flying and Ground. They follow the player. Careful! Ground enemies can jump!

## Controls

- ESC: Exit the game
- AD: Movement controls.
- Space-Bar: Jump. Walljump.
- (Debug menu) WASD: God mode movement
- (Debug menu) Arrows: Free camera movement
### While on the menu
- (Debug enabled) WASD: God mode movement
- (Debug enabled) Arrows: Free camera movement

### While on the Main Menu or Dead Menu

- Up/Down arrows & Mouse pointer: Select option.
- Enter: Select the selected option.

### OR you can use the mouse pointer

- LMB: Select the selected option

## Debug keys
- F1 Go back a level
- F2 Advance level
- F3 Start from the beginning of the current level
- F4 Open debug menu
- F5 Save the current game state
- F6 Load the previous state (even across levels)
- F7 Show variables in debug menu
- F8 Move camera freely with debug menu
- F9 View colliders / logic
- F10 God Mode (fly around, cannot be killed)

- O Instant win
- P Instant lose

- F1: Go back a level
- F2: Advance level
- F3: Start from the beginning of the current level
- F4: Enable/Disable debug mode
- F5: Save the current game state
- F6: Load the previous state (even across levels)
- F7: Show game variables
- F8: Move camera freely
- F9: View colliders / logic / paths
- F10: God Mode (fly around, cannot be killed)
- F11: Enable/Disable FPS cap to 30

- I: Insta-win
- O: Insta-lose
- M: Show preference map

## Developers

Expand Down

0 comments on commit 651bc56

Please sign in to comment.