79 lines
2.4 KiB
Plaintext
79 lines
2.4 KiB
Plaintext
Scrapeboard is an arcade game in development by Frank DeMarco (@diskmem) and Blake Andrews (@snakesandrews)
|
|
|
|
It requires a custom pad and board to play. To learn more about the project visit https://scrape.nugget.fun
|
|
|
|
This repository can be used to run either the full arcade version or the keyboard-only mode for testing
|
|
|
|
################
|
|
# REQUIREMENTS #
|
|
################
|
|
|
|
The game requires Python and Pygame. The Python version used for development is Python 3.9. The Pygame version
|
|
is 1.9.6.
|
|
|
|
To install python with pip:
|
|
|
|
pip install pygame
|
|
|
|
Once Python and Pygame are installed, you should be able to run either:
|
|
|
|
./OPEN-GAME
|
|
|
|
or
|
|
|
|
./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 #
|
|
##########
|
|
|
|
To run the game using the custom skateboard and dance pads, the Arduino attached to the pads must be plugged
|
|
into USB, and the pyserial package must be installed on this computer (https://pypi.org/project/pyserial/)
|
|
|
|
If you have Python Package Installer, you can run this to install pyserial:
|
|
|
|
pip install pyserial
|
|
|
|
The Arduino must be loaded with the program at serial/serial2/serial2.ino and connected to USB. The game
|
|
will try to detect the Arduino, but to specify a specific port you can use the config file or command
|
|
line.
|
|
|
|
If you don't have the board, pad and Arduino, you can test the game using keyboard-only mode.
|
|
|
|
########
|
|
# 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| ;|
|
|
|___|___| or you can use arrow keys
|
|
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 file called `config`. There are also command line flags that
|
|
can override config values:
|
|
|
|
./OPEN-GAME -h
|
|
|
|
The --minimize-load-time flag can be useful when testing because it sacrifices some effects to load the game
|
|
quickly.
|