playzing/README.md

49 lines
1.7 KiB
Markdown

Playzing
========
Playzing is a portable entertainment device featuring a built-in oven.
![Playzing demo photo](www/img/Prototype_demo_circle_crop.png)
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 the top of it. The gamepad is built to connect directly to the Raspberry Pi's digital input pins.
The [builder's manual](doc/Playzing_builder's_manual.md) has details on how to build the Raspberry Pi gaming device and attach it to the toaster.
![Baguette heating](www/img/Baguette_heating_1080x1593.png)
Launcher
--------
The code for launching games on the device is tracked by this repository. The launcher can run on any system, but it is intended to run on Raspberry Pi Lite 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) (included in this repository as a Git submodule)
### Running
Clone this repository
git clone --recursive https://open.shampoo.ooo/shampoo/playzing
cd playzing/
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"
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.