updated readme, added license
This commit is contained in:
parent
8b22ef3db0
commit
98aaa12260
|
|
@ -0,0 +1,30 @@
|
|||
Code
|
||||
----
|
||||
|
||||
Original source code is released under the zlib license:
|
||||
|
||||
Copyright (c) 2021-22 Frank DeMarco, Blake Andrews, and Dr. Clement Shimizu <scrape@nugget.fun>
|
||||
|
||||
This software is provided 'as-is', without any express or implied warranty. In
|
||||
no event will the authors be held liable for any damages arising from the use of
|
||||
this software.
|
||||
|
||||
Permission is granted to anyone to use this software for any purpose, including
|
||||
commercial applications, and to alter it and redistribute it freely, subject to
|
||||
the following restrictions:
|
||||
|
||||
1. The origin of this software must not be misrepresented; you must not
|
||||
claim that you wrote the original software. If you use this software in a
|
||||
product, an acknowledgment in the product documentation would be
|
||||
appreciated but is not required.
|
||||
|
||||
2. Altered source versions must be plainly marked as such, and must not be
|
||||
misrepresented as being the original software.
|
||||
|
||||
3. This notice may not be removed or altered from any source distribution.
|
||||
|
||||
Assets
|
||||
------
|
||||
|
||||
Art, sound, document, and schematic assets are released under CC BY 4.0 To view a copy of this
|
||||
license, visit <http://creativecommons.org/licenses/by/4.0/>
|
||||
83
README.md
83
README.md
|
|
@ -1,14 +1,19 @@
|
|||
Scrapeboard is an arcade game in development by Frank DeMarco (@diskmem) and Blake Andrews (@snakesandrews)
|
||||
Scrapeboard
|
||||
===========
|
||||
|
||||
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
|
||||
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?
|
||||
|
||||
################
|
||||
# REQUIREMENTS #
|
||||
################
|
||||
Hardware
|
||||
--------
|
||||
|
||||
The game requires Python and Pygame. The Python version used for development is Python 3.9. The Pygame version is 1.9.6.
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
To install python with pip:
|
||||
|
||||
|
|
@ -24,23 +29,21 @@ or
|
|||
|
||||
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 #
|
||||
##########
|
||||
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/)
|
||||
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.
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
########
|
||||
# KEYS #
|
||||
########
|
||||
Keys
|
||||
----
|
||||
|
||||
For testing, there is keyboard input. To run in keyboard only mode use:
|
||||
|
||||
|
|
@ -48,24 +51,46 @@ For testing, there is keyboard input. To run in keyboard only mode use:
|
|||
|
||||
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
|
||||
___ ___
|
||||
| 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| ;|
|
||||
|___|___|
|
||||
|
||||
Other keys:
|
||||
Arrow keys also work
|
||||
|
||||
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).
|
||||
UP = top left pad
|
||||
RIGHT = top right pad
|
||||
DOWN = bottom left pad
|
||||
LEFT = bottom right pad
|
||||
|
||||
###########
|
||||
# OPTIONS #
|
||||
###########
|
||||
### Other keys
|
||||
|
||||
The full list of configurable values is in the file called `config`. There are also command line flags that can override config values:
|
||||
* 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:
|
||||
|
||||
./OPEN-GAME -h
|
||||
|
||||
The --minimize-load-time flag can be useful when testing because it sacrifices some effects to load the game quickly.
|
||||
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. 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.
|
||||
|
||||
See [LICENSE.txt][]
|
||||
|
||||
[Pygame]: https://pygame.org
|
||||
[Makey Makey]: https://makeymakey.com
|
||||
[serial program]: serial/serial2/serial2.ino
|
||||
[pyserial]: https://pypi.org/project/pyserial/
|
||||
[Arduino]: https://arduino.cc
|
||||
[config file]: config
|
||||
[LICENSE.txt]: LICENSE.txt
|
||||
|
|
|
|||
Loading…
Reference in New Issue