diff --git a/README.md b/README.md index 69cad85..ddcf1f4 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,10 @@ 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? Hardware @@ -13,24 +17,24 @@ The hardware must be provided by the user, whether it's a standard Scrapeboard m Software -------- -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. +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. - git clone --recursive https://git.nugget.fun/scrape/scrapeboard - -To install python with pip: +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 Python and Pygame are installed, you should be able to run either: +Once you have Python and Pygame installed, run the following to download Scrapeboard and PGFW + + git clone --recursive https://git.nugget.fun/scrape/scrapeboard + +If you have an Arduino prepared, run this to start the game ./OPEN-GAME -or +Otherwise run the game in keyboard mode like this ./OPEN-GAME --no-serial -to start the game in either full arcade mode or keyboard only mode. See below for more about serial input and keyboard input modes. - Serial ------ @@ -96,3 +100,4 @@ See [LICENSE.txt][] [Arduino]: https://arduino.cc [config file]: config [LICENSE.txt]: LICENSE.txt +[PGFW]: https://git.nugget.fun/nugget/pgfw