update readme

This commit is contained in:
Derek Jamison 2023-02-15 11:26:53 -05:00
parent dd608f6d8e
commit 7c09c11f9b
2 changed files with 20 additions and 7 deletions

View File

@ -18,6 +18,10 @@ Feel free to reach out to me at CodeAllNight@outlook.com with any questions or l
### subghz-plugins-subghz_demo
[tutorial](./subghz/plugins/subghz_demo/README.md) - This is a demonstration of sending & receiving radio signals using the subghz_tx_rx worker library.
### subghz-plugins-rock_paper_scissors
[game](./subghz/plugins/rock_paper_scissors/README.md) -
This is a two player game that uses the subghz_tx_rx worker library for communication. Two Flipper Zeros running this game can play Rock, Paper, Scissors against each other!
### subghz-protocol-x10-decoder
[project](./subghz/protocols/x10/README.md) - This is a protocol decoder for the Flipper Zero to decode the x10 series of devices when doing a read from the Sub-GHz menu.

View File

@ -1,10 +1,13 @@
# Rock Papper Scissors
## Status
This is current a work in progress.
- Most of the game logic is complete (two flippers should be able to play each other.)
- UI to show images instead of text.
## Introduction
This is game of Rock, Paper, Scissors. In version 1, we use the subghz radio to find other players, communicate moves, and exchange contact information.
Remaining work:
## Status
This is currently a work in progress...
- Most of the game logic is complete (two flippers should be able to play against each other.)
- UI to show Flipper images instead of just debug text.
Remaining work (for subghz version):
- Tone when button pressed.
- Show games found & let user pick the game to join.
- Log joined game into SD card.
@ -13,9 +16,15 @@ Remaining work:
- Config - Allow changing game number.
- Config - Allow changing frequency.
- Config - Allow changing message on join.
- Refactor the code, so it has less duplication.
- Write tutorial.
- Add game ending animations.
## Introduction
This is game of Rock, Paper, Scissors. In version 1, we use the subghz radio to find other players, communicate moves, and exchange contact information.
Future ideas:
- Uses Princeton signals for second player.
- Create stand-alone hardware badges that can play the game too.
- Instead of subghz, use IR.
- Instead of subghz, use GPIO.
## Installation Directions
This project is intended to be overlayed on top of an existing firmware repo.