diff --git a/README.md b/README.md index e5911db..b4098c5 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,70 @@ -# love-platformer -[WIP] :runner: Platformer with LÖVE +# PLATFORMER + +:runner: Platformer with LÖVE + +![Screenshot](https://user-images.githubusercontent.com/1193542/57196067-31089600-6f94-11e9-9073-fc0d19f560b2.png) + +## Controls + +- In Title + - Start: Any key +- In Select level + - Choose level width: Left / Right (Gamepad dpad) + - Choose level height: Up / Down (Gamepad dpad) + - Start: Return / Gamepad A button / Main mouse button +- In Game + - Move: WASD / Arrow keys / Gamepad dpad + - Jump: Space / Gamepad A button + - Give up: Return +- In Gameover/Clear + - Back to level selection: Return / Gamepad A button / Main mouse button + - Retry: R / Gamepad B button / Sub mouse button +- Anytime + - Restart: F5 + - Debug mode: F12 + - Capture a screenshot: Print screen + - Save a screenshot to a [save-directory](https://love2d.org/wiki/love.filesystem) + +## Getting Started + +### Quick Start + +1. Download and install [LÖVE](https://love2d.org/) 11.2. +1. Download the latest version of `love-platformer.love` game distribution from release. +1. Open the distribution with LÖVE. + +### Build and Run from Source + +``` +git clone https://github.com/remyroez/love-platformer.git +cd love-platformer/game +love . +``` + +## Requirements + +- [LÖVE](https://love2d.org/) 11.2 + +## Libraries + +- [tick](https://github.com/bjornbytes/tick/tree/040f3c1db1cc545336c507ef0bf91754e4705370) +- [autobatch](https://github.com/rxi/autobatch) 0.1.1 (customized) +- [lume](https://github.com/rxi/lume/tree/d8c2eddc10af994ad4956cf0b7ae7188e86db47e) 2.3.0 +- [lurker](https://github.com/rxi/lurker/tree/4e34f47f9ed95477407425c5b25a779fac3eb9a7) 1.0.1 +- [middleclass](https://github.com/kikito/middleclass) v4.1.1 +- [Stateful](https://github.com/kikito/stateful.lua) 1.0.5 (2017-08) +- [boipushy](https://github.com/adnzzzzZ/boipushy/tree/863af7f87beaac67cba40001be9a36ae76bad76b) +- [chrono](https://github.com/adnzzzzZ/chrono/tree/d31b96355b59320b6f8f0a1f5dcb0833c8bb5c2c) +- [STALKER-X](https://github.com/adnzzzzZ/STALKER-X/tree/243e67b5d30ec7762c579b027dadaa3d3696b1cd) +- [sbss](https://github.com/mikufuworks/sbss/tree/905950ef0e2e64f30d4a5b2540b382134d62b6c5) (customized) +- [Simple Tiled Implementation](https://github.com/karai17/Simple-Tiled-Implementation/tree/2ba879d2509163822c353f8aba748085a8014389) 1.2.3.0 (customized + implement windfield plugin) + +## Assets + +- [Kenney Game Assets](https://itch.io/s/6789/kenney-bundle) + - It is purchased assets. Please do not use except for private. +- [splashes](https://github.com/love2d-community/splashes/tree/04a26445795bdf5185d996225045a44193f1d881) (customized) + +## License + +MIT License