From 854419762afacf31ea82ef25d9c64b377a91755e Mon Sep 17 00:00:00 2001 From: frank Date: Mon, 20 Feb 2023 23:30:58 -0500 Subject: [PATCH] updated instructions to use the launcher to start the game --- README.md | 9 +++++++++ doc/Playzing_builder's_manual.md | 26 ++++++++++++++------------ 2 files changed, 23 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 8cf8086..f704136 100644 --- a/README.md +++ b/README.md @@ -42,6 +42,15 @@ Start the launcher. The display can rotate by 90-degrees, but rotation is turned ./Playzing.py --config ",display,rotated,yes" +Quit the launcher using `Alt+F4` or by clicking the window close. Download the game iBitFit, which is the only game tested with the launcher so far, and start the launcher again. + + cd games/ + git clone https://open.shampoo.ooo/shampoo/ibitfit + cd .. + ./Playzing.py --config ",display,rotated,yes" + +iBitFit should launch when any key is pressed at the launcher screen. + License ------- diff --git a/doc/Playzing_builder's_manual.md b/doc/Playzing_builder's_manual.md index 89a62d4..6f8f1ad 100644 --- a/doc/Playzing_builder's_manual.md +++ b/doc/Playzing_builder's_manual.md @@ -61,40 +61,42 @@ Disable the login prompt using `System Options -> Boot / Auto Login -> Console A `iBitFit` is the first game compatible with the Playzing entertainment device and gamepad. It is able to run using the KMS video driver and can read gamepad input through the Raspberry Pi GPIO interface. It supports an option to rotate the display, which is necessary for the vertically oriented screen. -From the home directory, run the following commands to download the game and run it. +The Playzing repository has a game launcher in development which is able to display a title logo at boot and launch iBitFit on any key press. From the root of this repository, run the following commands to download iBitFit, then run the launcher. - cd - git clone --recursive https://open.shampoo.ooo/shampoo/ibitfit - ./OPEN-GAME --rotate + cd games/ + git clone https://open.shampoo.ooo/shampoo/ibitfit + cd .. + ./Playzing.py --config ",display,rotated,yes" Test the game using the left and right buttons on the USB keyboard. ### Autorun -To launch iBitFit at startup, create a file at `/etc/systemd/system/ibitfit.service` with the following contents +To start the game launcher automatically at system boot, create a file at `/etc/systemd/system/playzing.service` with the following contents. Substitute the correct user name for `[USER]`. [Unit] - Description=iBitFit for the Playzing entertainment device + Description=Game launcher for the Playzing entertainment device After=multi-user.target [Service] - ExecStart=/home/tony/ibitfit/OPEN-GAME --go-to-dir --kms --pi + ExecStart=/home/[USER]/playzing/Playzing --go-to-dir --config ",display,rotated,yes" + KillSignal=SIGINT Restart=always RestartSec=5s - TimeoutStartSec=2min + TimeoutStartSec=5s [Install] WantedBy=default.target and enable it - sudo systemctl enable ibitfit.service + sudo systemctl enable playzing.service -Now iBitFit will launch at startup and will restart itself if it ever is closed or crashes, and it can be controlled through `systemd` +Now the launcher will open at startup and will restart itself if it ever is closed or crashes, and it can be controlled through `systemd` - > sudo systemctl start ibitfit + > sudo systemctl start playzing ... - > sudo systemctl stop ibitfit + > sudo systemctl stop playzing Since it restarts automatically when quit with the usual quit button, there is also `SHIFT + q` to permanently quit and get back to the Raspberry Pi console.