This repository is no archived as I do no longer have access to a ClockworkPI GameShell. Feel free to fork and continue!

cpigs-tool

Configure your ClockworkPI GameShell

Description

The CPIGS-Tool is a bash script for controlling launcherGO entries for the ClockworkPI GameShell.

It contains a set of modules in modules sub directory which can be queried using cpigs-tool.sh --list. Modules should have a description of their parameters and commands. At the moment, the tool supports:

• DevilutionX, a Diablo build for modern operating systems
  • Downloading, compiling+installing and running the game.
• RetroArch, a Cross-platform, sophisticated frontend for the libretro API
  • Downloading, compiling+installing and linking any properly configured playlist game.
  • Games have to be in a playlist and with associated with a core to show up.
• moonlight-qt, a GameStream client for PCs
  • Downloading, installing and linking a remote application.

The CPIGS-Tool requires a modern armbian to run.

Installation

1. Log into the GameShell via SSH and run in the home directory:
2. git clone https://github.com/danie1kr/cpigs-tool
3. cd cpigs-tool
4. ./cpigs-tool --bootstrap
5. logout and log back in, so the cpigs-tool.sh is known in your PATH variable.
6. Go to /home/cpi/apps/Menu and run cpigs-tool --list to see the available modules.

Contribution

Just submit an issue or pull request with ideas! Any input is welcome.

Writing new modules

Modules are put in the modules directory. Each modules registers with the cpigs_register "mod" in the way it is called. Within each module, the mod function is called with the command line arguments when the user specifies the module in the cpigs parameter: cpigs-tool.sh mod. Each module should accept the text parameter which is called when using cpigs-tools.sh --list, echoing a one line module description and a --help parameter telling the user about its capabilities.

Have fun!