add a readme

This commit is contained in:
Michael Zhang 2019-08-10 01:20:37 -05:00
parent 5f8291042a
commit b0e9a1bc0b
No known key found for this signature in database
GPG key ID: 5BAEFE5D04F0CE6C
3 changed files with 42 additions and 2 deletions

View file

@ -4,8 +4,10 @@ root = true
end_of_file = lf end_of_file = lf
insert_final_newline = true insert_final_newline = true
trim_trailing_whitespace = true trim_trailing_whitespace = true
[*.py]
charset = utf-8 charset = utf-8
indent_style = space indent_style = space
indent_size = 4 indent_size = 4
[*.md]
indent_size = 2
trim_trailing_whitespace = false

38
readme.md Normal file
View file

@ -0,0 +1,38 @@
wedge: a puzzle game
====================
![screenshot](screenshot.jpg?raw=true)
Mechanics:
- **Objective:** Get the two players to reach the goals by navigating the level and pushing blocks around.
- Blocks with triangular sections will push other blocks in the other direction.
- Blocks of the same color will always move together.
Controls: WASD for the left player and IJKL for the right player
To-do list
----------
- [ ] Gameplay
- [x] Collision algorithm
- [x] Primitive animations
- [ ] Orientation indicator
- [ ] Unique textures
- [ ] Cosmetics
- [ ] A real menu interface
- [ ] In-game editor
Credits
-------
Original game made during MinneHack 2019: https://github.com/iptq/planar
- Yeshi Cai
- Mark Pekala
- Alex Shi
- Michael Zhang
Rewrite: Michael Zhang
License: MIT

BIN
screenshot.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 51 KiB