aboutsummaryrefslogtreecommitdiff
path: root/keyboards/clueboard_66/keymaps/tetris/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/clueboard_66/keymaps/tetris/readme.md')
-rw-r--r--keyboards/clueboard_66/keymaps/tetris/readme.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/keyboards/clueboard_66/keymaps/tetris/readme.md b/keyboards/clueboard_66/keymaps/tetris/readme.md
new file mode 100644
index 000000000..20e97fb19
--- /dev/null
+++ b/keyboards/clueboard_66/keymaps/tetris/readme.md
@@ -0,0 +1,33 @@
1Default layout but with a tetris game
2=====================================
3Tetris works by outputting key-presses to make ascii-art in a regular text editor.
4It reads key presses to rotate and move the bricks like a regular tetris game.
5
6Example
7=======
8![tetris](https://raw.githubusercontent.com/danamlund/meckb_tetris/master/tetris.gif)
9
10Usage
11=====
121) Open a default text editor
132) Press the tetris button (Fn + t)
143) Play tetris
15
16It makes ascii-art by sending keycodes: left, right, up, down, qwerty characters, and numbers.
17
18Problems
19========
20Drawing ascii-art is too slow to make a pleasant playing experience.
21While drawing ascii-art, the keyboard does not record key-presses, so its pretty unresponsive.
22
23Adds 5000 bytes to the hex file.
24
25Implement 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
33You can find a simple tetris keyboard definition at <https://github.com/danamlund/meckb_tetris/>