spacemacs/layers/+fun/games/README.org

#+TITLE: Games contribution layer for Spacemacs

[[file:img/games.png]]

* Table of Contents                                                   :TOC@4:
 - [[#description][Description]]
 - [[#install][Install]]
 - [[#key-bindings][Key bindings]]
     - [[#2048][2048]]
     - [[#tetris][Tetris]]

* Description

This layer allows you to play evilified games in spacemacs.

The games available now are:
- 2048-game
- Pacmacs (Pacman for Emacs)
- Tetris
  
* Install

To use this contribution add it to your =~/.spacemacs=

#+BEGIN_SRC emacs-lisp
  (setq-default dotspacemacs-configuration-layers '(games))
#+END_SRC

* Key bindings

To run a game:

| Key Binding | Description                            |
|-------------+----------------------------------------|
| ~SPC a G~   | Open an =helm= buffer to select a game |

Possible helm actions:
- run (default)
- quit
- reset
  
** 2048

| Key Binding | Description          |
|-------------+----------------------|
| ~h~         | Move the tiles left  |
| ~j~         | Move the tiles down  |
| ~k~         | Move the tiles up    |
| ~l~         | Move the tiles right |

** Pacmacs

| Key Binding | Description       |
|-------------+-------------------|
| ~h~         | Move left  |
| ~j~         | Move down  |
| ~k~         | Move up    |
| ~l~         | Move right |
|             |                   |
** Tetris

| Key Binding | Description                    |
|-------------+--------------------------------|
| ~h~         | Move block to the left         |
| ~i~         | Rotate block counter-clockwise |
| ~j~         | Move block to the bottom       |
| ~k~         | Rotate block clockwise         |
| ~l~         | Move block to the right        |
| ~n~         | Start a new game               |
| ~p~         | Pause the game                 |
| ~q~         | Quit the game                  |