Added and modified the ReadMe
This commit is contained in:
36
ReadMe.md
Normal file
36
ReadMe.md
Normal file
@@ -0,0 +1,36 @@
|
||||
# Rusty Jumpy
|
||||
|
||||
Little platformer game to try and figure out a way to process collision from a grid
|
||||
|
||||
## Run it
|
||||
|
||||
You need to download Rust
|
||||
|
||||
Then you clone this repository
|
||||
|
||||
And launch it with :
|
||||
|
||||
```Bash
|
||||
cargo build --release
|
||||
|
||||
cargo run --release
|
||||
```
|
||||
|
||||
## Controls
|
||||
|
||||
W,A,S,D and Arrow Keys are for modifying the jump direction and force
|
||||
|
||||
[DEBUG] Left Click teleports the ball to the cursors location.
|
||||
|
||||
[DEBUG] Right Click cancels any velocity of the ball.
|
||||
|
||||
[DEBUG] Press R to randomize the map (you can maintain the key pressed if you want to kill a friend who has photosensitive epilepsy)
|
||||
|
||||
Tab toggles a debug mode where you can see the actual vector applied to the player wich is render as a cube to see its hitbox and tiles borders
|
||||
|
||||
Spacebar jumps
|
||||
|
||||
## How to play
|
||||
|
||||
You have one player in the window.
|
||||
When the player is on the ground you can aim with W,A,S,D (or arrow key) your next jump, then when you press Space you jump.
|
||||
Reference in New Issue
Block a user