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

added pgfw as a dependency and updated instructions

This commit is contained in:
ohsqueezy 2022-10-25 14:16:29 -04:00
parent 98aaa12260
commit 2f9784498e
2 changed files with 9 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.gitmodules vendored
View File

@ -1,3 +1,5 @@
[submodule "lib/pgfw"]
path = lib/pgfw
url = frank@shampoo.ooo:/var/www/git/pgfw
[submodule "lib/pgfw/"]
url = https://git.nugget.fun/nugget/pgfw

12
README.md
View File

@ -1,19 +1,21 @@
Scrapeboard
===========
![demo](www/Scrapeboard_Gameplay_Demo_picture_in_picture.webp)
![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?
Hardware
--------
This is the open source repository containing the software necessary to run the game on any system with Python and Pygame installed. The hardware must be provided by the user, whether it's a standard Scrapeboard mat and board, a custom controller 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 hardware must be provided by the user, whether it's a standard Scrapeboard mat and board, a custom controller 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.
Software
--------
The game requires Python and [Pygame][]. The Python version should be 3.9 or higher. The Pygame version should be 1.9.6 or higher.
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.
git clone --recursive https://git.nugget.fun/scrape/scrapeboard
To install python with pip:
@ -32,7 +34,7 @@ to start the game in either full arcade mode or keyboard only mode. See below fo
Serial
------
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 system.
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:
@ -83,7 +85,7 @@ 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. This means users are free to use Scrapeboard in any context, including modding it and even selling mods or creating a closed source version. Use of the assets requires attribution is given to Scrapeboard for the original assets, and if source is distributed, the zlib license must be included as the license for the original code.
Python, Pygame, and Arduino all have their own licenses, but they are not distributed with this project.
PGFW is included under its zlib license. Python, Pygame, and Arduino all have their own licenses, but they are not distributed with this project.
See [LICENSE.txt][]