73 lines
2.5 KiB
Markdown
73 lines
2.5 KiB
Markdown
Playzing
|
|
========
|
|
|
|
Playzing is a portable entertainment device featuring a built-in oven.
|
|
|
|
|
|
|
|
Hardware
|
|
--------
|
|
|
|
The Playzing has three main components:
|
|
|
|
* Raspberry Pi portable gaming device
|
|
* mini toaster oven
|
|
* custom-built gamepad
|
|
|
|
The toaster is a commercial mini toaster oven which is modified to have a Raspberry Pi and screen attached to it. The gamepad is built to connect directly to the Raspberry Pi's digital input pins.
|
|
|
|
See the [builder's manual][0] for detailed instructions on how to build the entire system.
|
|
|
|
|
|
|
|
Launcher
|
|
--------
|
|
|
|
The code for launching games is tracked by this repository. The launcher can run on any operating system, but it is intended to run on Raspberry Pi OS when being used with the standard Playzing device.
|
|
|
|
### Requirements
|
|
|
|
* [Python 3+](https://python.org/downloads)
|
|
* [Pygame 2](https://pygame.org/wiki/GettingStarted)
|
|
* [PGFW](https://open.shampoo.ooo/shampoo/pgfw) (part of this repository as a Git submodule)
|
|
* [BiTFiT](https://open.shampoo.ooo/shampoo/ibitfit)
|
|
|
|
Python and Pygame can be installed using `apt` on Debian Linux
|
|
|
|
> sudo apt install python3 python3-pygame
|
|
|
|
Install the launcher by cloning this repository with PGFW using `--recursive`
|
|
|
|
> git clone --recursive https://open.shampoo.ooo/shampoo/playzing
|
|
|
|
### BiTFiT
|
|
|
|
The game BiTFiT is currently required by the launcher and is the only officially supported game. Clone the game into the empty subfolder `games`. Alternatively, clone the game into a separate location, and create a symlink to that location.
|
|
|
|
> cd games/
|
|
> git clone https://open.shampoo.ooo/shampoo/ibitfit
|
|
> cd ..
|
|
|
|
Start the launcher. The display can rotate by 90-degrees, but rotation is turned off by default. To turn it on, launch with rotation enabled on the command line or set `rotate` to `yes` in [config](config).
|
|
|
|
> ./Playzing.py --config ",display,rotated,yes"
|
|
|
|
BiTFiT should launch when any key is pressed at the launcher screen.
|
|
|
|
Card dispenser
|
|
--------------
|
|
|
|
The card dispenser is a Playzing-compatible peripheral device that can be set up to dispense a trading card when sent a signal from the Playzing's Raspberry Pi GPIO pins.
|
|
|
|
See the [card dispenser doc][1] for details.
|
|
|
|
License
|
|
-------
|
|
|
|
The code is released under the zlib license, and the assets and documentation are released under CC BY 4.0. See [LICENSE.md](LICENSE.md) for details.
|
|
|
|
|
|
|
|
[0]: doc/Playzing_builder's_manual.md
|
|
[1]: doc/Card_dispenser.md
|