Martmists-GH / decky-kotlin-template

A Kotlin/MPP template for decky plugins

DeckPlugin

A template for Steam Deck Plugin Loader plugins in Kotlin/Multiplatform. Any problems, bugs or feature requests can be reported on the issue tracker. Latest compatible decky-frontend-lib: 3.2.0 @ b39ba26b

Details

The backend is written in Kotlin/Native, and produces a binary that can be executed from your Python plugin at any time. The frontend is written in Kotlin/JS, and produces a JS bundle that will be loaded into the Steam Deck UI. Miscellaneous files are located in src/plugin, which are used solely by the plugin loader. There is also a Python Native Extension which can be imported from the plugin, written using the KPy Compiler Plugin.

Building

To build your plugin, run the following commands:

# First time:
$ cd src
$ docker build . -t build-image
$ cd ..

# Every time:
$ scripts/build.sh 

Additionally, any git tags created will trigger a GitHub Actions workflow which will build the plugin and upload it as artifact.

License

This project is licensed under the BSD 3-Clause License.