]> git.donarmstrong.com Git - qmk_firmware.git/blob - keyboards/clueboard/keymaps/tetris/readme.md
added matrixman layout
[qmk_firmware.git] / keyboards / clueboard / keymaps / tetris / readme.md
1 Default layout but with a tetris game
2 =====================================
3 Tetris works by outputting key-presses to make ascii-art in a regular text editor.
4 It reads key presses to rotate and move the bricks like a regular tetris game.
5
6 Example
7 =======
8 ![tetris](https://raw.githubusercontent.com/danamlund/meckb_tetris/master/tetris.gif)
9
10 Usage
11 =====
12 1) Open a default text editor
13 2) Press the tetris button (Fn + t)
14 3) Play tetris
15
16 It makes ascii-art by sending keycodes: left, right, up, down, qwerty characters, and numbers.
17
18 Problems
19 ========
20 Drawing ascii-art is too slow to make a pleasant playing experience.
21 While drawing ascii-art, the keyboard does not record key-presses, so its pretty unresponsive.
22
23 Adds 5000 bytes to the hex file.
24
25 Implement in other keyboards
26 ============================
27  - Copy-paste the files tetris_text.c and tetrix_text.h to your keymap folder.
28  - Add/update your-keyboard/your-keymap/Makefile to include ``SRC = tetris_text.c``
29  - Copy-paste the tetris-related code from this keymap.c to yours.
30  - Set a key to trigger F(1) to start tetris mode.
31  - Its also a good idea to set a key to stop tetris, here its escape.
32
33 You can find a simple tetris keyboard definition at <https://github.com/danamlund/meckb_tetris/>