scrapeboard/README.md

133 lines
5.8 KiB
Markdown

Scrapeboard
===========
![demo](https://scrape.nugget.fun/www/Scrapeboard_Gameplay_Demo_picture_in_picture.webp)
So, you think you can skateboard, but can you scrapeboard, you slime bag? Scrapeboard is a DDR inspired alt control game that uses a real skateboard deck instead of your feet. Do you have the moves to skate through a gauntlet of goons all the way to Tony Hawk?
Wiki
----
This README file is for setting up and using the code repository. For more general information on how to [operate](../../../wiki/Operators-manual) or [build](../../../wiki/Builders-manual) Scrapeboard, see the [wiki](../../../wiki).
Controller
----------
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](../../../wiki/Builders-manual) and attached to an Arduino. Custom interfaces can 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.
Software
--------
### *See the [software chapter](../../../wiki/Software) of the [Builder's Manual](../../../wiki/Builders-manual) for more detailed instructions*
The software requires Python, [Pygame][], and a custom Python game framework [PGFW][]. The Python version should be 3.9 or higher. The Pygame version should be 1.9.6 or higher. PGFW is a submodule of this repository, so it can be cloned simultaneously using the `--recursive` flag. Python and Pygame can be installed on any operating system, including Windows, OS X, and Linux.
Installing Python will usually install Python's package manager PIP as well. PIP can be used to install Pygame by running the following from your terminal (for example, PowerShell on Windows).
pip install pygame
Once you have Python and Pygame installed, run the following to download Scrapeboard and PGFW
git clone --recursive https://open.shampoo.ooo/scrape/scrapeboard
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.
python OPEN-GAME
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.
python OPEN-GAME --pi
To run the game in keyboard mode anytime, use the following
python OPEN-GAME --no-serial
Serial
------
### *See the [electronics chapter](../../../wiki/Electronics) of the [Builder's Manual](../../../wiki/Builders-manual) for more detailed instructions*
To run the game using the custom skateboard and metal pads, the Arduino attached to the pads must be plugged into USB, and the [pyserial][] package must be installed on the computer.
If you have Python Package Installer, you can run this to install pyserial:
pip install pyserial
The Arduino must be loaded with the [serial program][] and connected to USB. The game will try to detect the Arduino, but if that does not work, the device location of the Arduino can be specified in the [config file][].
If you don't have the board, pad and Arduino, you can test the game using keyboard-only mode.
Raspberry Pi
------------
Raspberry Pi GPIO input is also supported. See the [Raspberry Pi chapter](../../../wiki/Raspberry-Pi) of the manual for how to install Scrapeboard on a Raspberry Pi. 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
----
For testing, there is keyboard input. To run in keyboard only mode use:
./OPEN-GAME --no-serial
The O, P, L, and ; keys simulate the dance pads and your fingers simulate the board
___ ___
| O| P| <-- These keyboard keys correspond to the floor pads
|___|___| O = top left pad, P = top right pad, L = bottom left pad, ; = bottom right pad
| L| ;|
|___|___|
Arrow keys also work
UP = top left pad
RIGHT = top right pad
DOWN = bottom left pad
LEFT = bottom right pad
### Other keys
* The `Z` key is a shortcut for reset (`F8` also resets).
* The `A` key force resets the connected Arduino (or does nothing if no Arduino is connected).
Options
-------
The full list of configurable values is in the [config file][]. There are also command line flags that can override config values. Use the help flag to see the possible values:
python OPEN-GAME -h
The `--minimize-load-time` flag can be useful when testing because it sacrifices some effects to load the game quickly.
License
-------
Original Scrapeboard code is released without restriction on copying, modifying, or selling, under the zlib license. Art, sound, text, and schematic assets are released under CC BY 4.0. Users are licensed to modify Scrapeboard and even sell their modifications. Scrapeboard code and assets can be used in other projects, even closed source ones. Use of the assets requires attribution is given to Scrapeboard for the original assets. If the source is distributed, the zlib license must be included as the license for the original code. The full license is in [LICENSE.txt][].
PGFW is included under [its zlib license](https://open.shampoo.ooo/shampoo/pgfw/LICENSE.txt).
Donations
---------
Send us a donation through [Ko-fi](https://ko-fi.com/scrapeboard)!
[![Donate at Ko-fi](https://storage.ko-fi.com/cdn/kofi3.png?v=3)](https://ko-fi.com/Z8Z7FX41L)
Contact
-------
More information is available [at the website](https://scrape.nugget.fun). Email us at scrape (at) nugget (dot) fun.
[Pygame]: https://pygame.org
[Makey Makey]: https://makeymakey.com
[serial program]: serial/serial.ino
[pyserial]: https://pypi.org/project/pyserial/
[Arduino]: https://arduino.cc
[config file]: config
[LICENSE.txt]: LICENSE.txt
[PGFW]: https://open.shampoo.ooo/shampoo/pgfw
[Raspberry Pi]: https://www.raspberrypi.org/