Skip to content

Docs/games: Add match4 game docs #16712

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 3 commits into from
Jul 14, 2025
Merged

Docs/games: Add match4 game docs #16712

merged 3 commits into from
Jul 14, 2025

Conversation

eren-terzioglu
Copy link
Contributor

@eren-terzioglu eren-terzioglu commented Jul 11, 2025 •
edited by cederom
Loading

Summary

Add match4 game docs and configs for demo purposes. Currently, game requires 8x8 led matrix (or serial output can be used when debug option enabled) and buttons/console input. Goal is matching 4 pieces vertical,horizontal or diagonal. You can play game against device(AI) or another player.

  • Docs/xtensa: Add match4 game doc for esp32-devkitc

Add esp32-devkit match4 doc

  • Docs/games: Add match4 game docs

Add match4 game docs

  • boards/esp32-devkitc: Add match4 defconfig for esp32

Add match4 defconfig for esp32-devkitc

Depends on: apache/nuttx-apps#3125.

Impact

Impact on user: Yes, a new game can be used to make demos

Impact on build: No, nothing got affected from build system

Impact on hardware: ESP32-DevkitC has a new defconfig but nothing will be effected

Impact on documentation: Yes, game and defconfig docs added

Impact on security: No

Impact on compatibility: No

Testing

Building

Command used to build:

make -j distclean && ./tools/configure.sh esp32-devkitc:match4 && make -j && make download ESPTOOL_PORT=/dev/ttyUSB0 ESPTOOL_BAUD=921600 ESPTOOL_BINDIR=../esp-bin

Connection diagram should look like this (same as snake demo):

esp_brickmatch_game_schematic

Running

match command used to run the game.

@github-actions github-actions bot added Area: Documentation Improvements or additions to documentation Board: xtensa Size: M The size of the change in this PR is medium labels Jul 11, 2025
@eren-terzioglu eren-terzioglu mentioned this pull request Jul 11, 2025
Merged
@eren-terzioglu eren-terzioglu force-pushed the feature/add_match4_support branch from 2794f8e to 1bb9c8b Compare July 11, 2025 09:48
@eren-terzioglu
Copy link
Contributor Author

eren-terzioglu commented Jul 11, 2025 •
edited
Loading

It fails due to haven't merged apache/nuttx-apps#3125 PR

cederom
cederom approved these changes Jul 11, 2025
View reviewed changes
Copy link
Contributor

@cederom cederom left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @eren-terzioglu :-) Could you also please add the wiring diagram to the docs? :-)

@eren-terzioglu
Copy link
Contributor Author

eren-terzioglu commented Jul 11, 2025 •
edited
Loading

Thank you @eren-terzioglu :-) Could you also please add the wiring diagram to the docs? :-)

I did it on Espressif Docs

@cederom cederom requested a review from lupyuen July 11, 2025 11:49
@acassis
Copy link
Contributor

acassis commented Jul 11, 2025

@eren-terzioglu please normalize your board config:

  [1/1] Normalize ttgo_t_display_esp32/lvgl_fb
HEAD detached at pull/16712/merge
Changes not staged for commit:
  (use "git add <file>..." to update what will be committed)
  (use "git restore <file>..." to discard changes in working directory)
	modified:   boards/xtensa/esp32/esp32-devkitc/configs/match4/defconfig

@eren-terzioglu
Copy link
Contributor Author

eren-terzioglu commented Jul 11, 2025 •
edited
Loading

@eren-terzioglu please normalize your board config:

  [1/1] Normalize ttgo_t_display_esp32/lvgl_fb
HEAD detached at pull/16712/merge
Changes not staged for commit:
  (use "git add <file>..." to update what will be committed)
  (use "git restore <file>..." to discard changes in working directory)
	modified:   boards/xtensa/esp32/esp32-devkitc/configs/match4/defconfig

I did before posting but it is waiting apache/nuttx-apps#3126 to be merged

@acassis
Copy link
Contributor

acassis commented Jul 12, 2025

@eren-terzioglu please normalize your board config:

  [1/1] Normalize ttgo_t_display_esp32/lvgl_fb
HEAD detached at pull/16712/merge
Changes not staged for commit:
  (use "git add <file>..." to update what will be committed)
  (use "git restore <file>..." to discard changes in working directory)
	modified:   boards/xtensa/esp32/esp32-devkitc/configs/match4/defconfig

I did before posting but it is waiting apache/nuttx-apps#3126 to be merged

But the CI still reporting error about your defconfig not normalized, see:

	modified:   boards/xtensa/esp32/esp32-devkitc/configs/match4/defconfig

@acassis
Copy link
Contributor

acassis commented Jul 12, 2025

@eren-terzioglu please normalize your board config:

  [1/1] Normalize ttgo_t_display_esp32/lvgl_fb
HEAD detached at pull/16712/merge
Changes not staged for commit:
  (use "git add <file>..." to update what will be committed)
  (use "git restore <file>..." to discard changes in working directory)
	modified:   boards/xtensa/esp32/esp32-devkitc/configs/match4/defconfig

I did before posting but it is waiting apache/nuttx-apps#3126 to be merged

But the CI still reporting error about your defconfig not normalized, see:

	modified:   boards/xtensa/esp32/esp32-devkitc/configs/match4/defconfig

Just run:

$ ./tools/refresh.sh esp32-devkitc:match4

And run: "git diff" to see if the defconfig was modified

@eren-terzioglu eren-terzioglu force-pushed the feature/add_match4_support branch from 1bb9c8b to b691b97 Compare July 14, 2025 06:59
@eren-terzioglu
boards/esp32-devkitc: Add match4 defconfig for esp32
ea5312c 
Add match4 defconfig for esp32-devkitc

Signed-off-by: Eren Terzioglu <eren.terzioglu@espressif.com>
@eren-terzioglu
Docs/games: Add match4 game docs
58a3986 
Add match4 game docs

Signed-off-by: Eren Terzioglu <eren.terzioglu@espressif.com>
@eren-terzioglu
Docs/xtensa: Add match4 game doc for esp32-devkitc
b691b97 
Add esp32-devkit match4 doc

Signed-off-by: Eren Terzioglu <eren.terzioglu@espressif.com>
@eren-terzioglu
Copy link
Contributor Author

Thanks @acassis, updated. It fixed after rebase (refresh returned nothing again).

@acassis acassis merged commit f9c25ec into apache:master Jul 14, 2025
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@acassis acassis acassis approved these changes

@cederom cederom cederom approved these changes

@xiaoxiang781216 xiaoxiang781216 xiaoxiang781216 approved these changes

@anchao anchao Awaiting requested review from anchao

@jerpelea jerpelea Awaiting requested review from jerpelea

@lupyuen lupyuen Awaiting requested review from lupyuen

Assignees
No one assigned
Labels
Area: Documentation Improvements or additions to documentation Board: xtensa Size: M The size of the change in this PR is medium
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@eren-terzioglu @acassis @cederom @xiaoxiang781216