From efdc51419f2c5f2eddf38d8f228e74b25303be83 Mon Sep 17 00:00:00 2001 From: Alan Carvalho de Assis Date: Mon, 23 Oct 2023 12:33:18 -0300 Subject: [PATCH] games: Add documentation This commit add support to Games documentation on NuttX. Signed-off-by: Alan Carvalho de Assis --- .../applications/games/brickmatch.rst | 40 +++++++++++++++++++ Documentation/applications/games/index.rst | 18 +++++++++ Documentation/applications/index.rst | 1 + 3 files changed, 59 insertions(+) create mode 100644 Documentation/applications/games/brickmatch.rst create mode 100644 Documentation/applications/games/index.rst diff --git a/Documentation/applications/games/brickmatch.rst b/Documentation/applications/games/brickmatch.rst new file mode 100644 index 0000000000000..4049054b7404b --- /dev/null +++ b/Documentation/applications/games/brickmatch.rst @@ -0,0 +1,40 @@ +========== +Brickmatch +========== + +Brickmatch is a kind puzzle game like a mix between tetris and Candy +Crush. It is a 6x6 matrix with blocks (cells) with different colors. + +Your goal is to move the blocks of the board to unite three or +more with the same color. + +Everytime that three of more blocks with the same color match that block +will blink and it will be removed from the board, leaving more space +for movements. + +The game starts with only the border cells filled and you can move the +walls, floor and ceil in direction to the center of the board to make +the cells of same color to match. + +Basic Test +========== + +The best way to play brickmatch is using an APA102 RGB 16x16 matrix +and Gesture sensor APDS9960. There are some board examples already +done for this integration, all you need to do is connecting the APA102 +matrix to the right SPI pins (look your board configuration) and the +APDS9960 to the I2C port (also connect its INT pin). + +If you don't have an APA102 matrix you can also play it using an LCD +display and a digital joystick (DJOYSTICK) or the console input. + +Then you can configure and compile the game to play in your board, +i.e. for ESP32-Devkitc there is already an example using the APA102: + + + $ ./tools/configure.sh esp32-devkitc:brickmatch + $ make -j flash ESPTOOL_PORT=/dev/ttyUSB0 + $ minicom + nsh> brick + +That is it! Have fun! diff --git a/Documentation/applications/games/index.rst b/Documentation/applications/games/index.rst new file mode 100644 index 0000000000000..54201e9d6547e --- /dev/null +++ b/Documentation/applications/games/index.rst @@ -0,0 +1,18 @@ +===== +Games +===== + +NuttX is not only an RTOS, it is a rich ecosystem with much fun. +And for many people fun is related to games! So let's play! + +Here you will find the list of games currently supported by NuttX. + +An interesting fact is that originally NuttX had the Traveler game. +It is a raycasting game that Greg Nutt developed from scratch, similar +to Doom in many ways. That game is not part of Apache NuttX. + +.. toctree:: + :maxdepth: 2 + :caption: Contents + + brichmatch.rst diff --git a/Documentation/applications/index.rst b/Documentation/applications/index.rst index 0ca6b65f61d77..f7248bd3de4f8 100644 --- a/Documentation/applications/index.rst +++ b/Documentation/applications/index.rst @@ -18,4 +18,5 @@ more information at the repository. nxdiag/index.rst wapi/index.rst examples/index.rst + games/index.rst