scrape/scrapeboard
scrape
/
scrapeboard
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

add raspberry pi to readme

This commit is contained in:
ohsqueezy 2022-12-18 20:41:08 -05:00
parent 21a856089d
commit 6b94fed42f
1 changed files with 21 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -8,9 +8,11 @@ So, you think you can skateboard, but can you scrapeboard, you slime bag? Scrape
Controller
----------
The controller must be provided by the user, whether it's a standard Scrapeboard mat and board, a custom interface built by the user, or keyboard input. The hardware requirement for [serial mode](#Serial) is an [Arduino][] or Arduino-equivalent device that can run the [serial program][]. For [keyboard mode](#Keys), no special hardware is required, although a gamepad or [Makey Makey][] could be used to create a custom controller that sends key presses.
The standard controller is a custom platform combined with a modified skatedeck, seen in the above GIF. It can be built using the instructions in the builder's manual. Custom interfaces can also be created using an Arduino or Raspberry Pi. There is also keyboard support built-in. It is meant for testing, but the game can be played with it.
See [Scrapeboard Builder's Manual][Scrapeboard_Builder's_Manual.md] for detailed instructions on how to build a complete system from scratch using an Arduino or Raspberry Pi!
The hardware requirement for [serial mode](#Serial) is an [Arduino][] or Arduino-equivalent device that can run the [serial program][]. [Raspberry Pi][] mode is similar to serial mode, but it uses the Python GPIO library to get input directly from the Raspberry Pi pins. For [keyboard mode](#Keys), no special hardware is required, although a gamepad or [Makey Makey][] could be used to create a custom controller that sends key presses.
See [Scrapeboard Builder's Manual][] for detailed instructions on how to build a complete system from scratch using an Arduino or Raspberry Pi!
Software
--------
@ -25,11 +27,15 @@ Once you have Python and Pygame installed, run the following to download Scrapeb
git clone --recursive https://git.nugget.fun/scrape/scrapeboard
If you have an Arduino prepared, run this to start the game
If you have an Arduino connected with the circuit and program prepared, run this to start the game. If the Arduino is not prepared yet, see below.
./OPEN-GAME
Otherwise run the game in keyboard mode like this
If you are using a Raspberry Pi, run this instead. The Pi should have a circuit installed to its GPIO pins. See below for details.
./OPEN-GAME --pi
To run the game in keyboard mode anytime, use this
./OPEN-GAME --no-serial
@ -46,6 +52,15 @@ The Arduino must be loaded with the [serial program][] and connected to USB. The
If you don't have the board, pad and Arduino, you can test the game using keyboard-only mode.
Refer to [Scrapeboard_Builder's_Manual][] for how to build the circuit.
Raspberry Pi
------------
Raspberry Pi GPIO input is also supported. Refer to [Scrapeboard_Builder's_Manual][] for how to build the circuit. Once the circuit is in place, the game will be able to detect GPIO input. Run with the `--pi` flag to activate Raspberry Pi mode.
./OPEN-GAME --pi
Keys
----
@ -111,3 +126,5 @@ Send us a donation through [Ko-fi](https://ko-fi.com/scrapeboard)!
[config file]: config
[LICENSE.txt]: LICENSE.txt
[PGFW]: https://git.nugget.fun/nugget/pgfw
[Raspberry Pi]: https://www.raspberrypi.org/
[Scrapeboard_Builder's_Manual]: Scrapeboard_Builder's_Manual.md