diff --git a/.vscode/config.sh b/.vscode/config.sh index b45c7944..fdfb8d1d 100755 --- a/.vscode/config.sh +++ b/.vscode/config.sh @@ -2,11 +2,11 @@ SCRIPT_DIR="$( cd -- "$( dirname -- "${BASH_SOURCE[0]:-$0}"; )" &> /dev/null && pwd 2> /dev/null; )"; # printf "${SCRIPT_DIR}\n" # printf "$(dirname $0)\n" -if ! [[ -e "${SCRIPT_DIR}/settings.json" ]]; then +if ! [[ -e "${SCRIPT_DIR}/settings.json" ]]; then printf '.vscode/settings.json does not exist. Creating it with default settings. Exiting afterwards. Run your task again.\n\n' cp "${SCRIPT_DIR}/defsettings.json" "${SCRIPT_DIR}/settings.json" exit 1 else printf '.vscode/settings.json does exist. Congrats.\n' printf 'Make sure to change settings.json to match your deck.\n' -fi \ No newline at end of file +fi diff --git a/.vscode/setup.sh b/.vscode/setup.sh index 1159c542..50e3af3d 100755 --- a/.vscode/setup.sh +++ b/.vscode/setup.sh @@ -49,7 +49,7 @@ if ! test -f "$CLI_INSTALLED"; then if [[ "$SYSTEM_ARCH" =~ "Linux" ]]; then curl -L -o "$(pwd)"/cli/decky "https://github.com/SteamDeckHomebrew/cli/releases/latest/download/decky-linux-x86_64" fi - + if [[ "$SYSTEM_ARCH" =~ "Darwin" ]]; then curl -L -o "$(pwd)"/cli/decky "https://github.com/SteamDeckHomebrew/cli/releases/latest/download/decky-macOS-x86_64" fi @@ -58,7 +58,7 @@ if ! test -f "$CLI_INSTALLED"; then if [[ "$SYSTEM_ARCH" =~ "Linux" ]]; then curl -L -o "$(pwd)"/cli/decky "https://github.com/SteamDeckHomebrew/cli/releases/latest/download/decky-linux-aarch64" fi - + if [[ "$SYSTEM_ARCH" =~ "Darwin" ]]; then curl -L -o "$(pwd)"/cli/decky "https://github.com/SteamDeckHomebrew/cli/releases/latest/download/decky-macOS-aarch64" fi @@ -66,7 +66,7 @@ if ! test -f "$CLI_INSTALLED"; then else echo "System Arch not found! The only supported systems are Linux x86_64/ARM64 and Apple x86_64/ARM64, not $SYSTEM_ARCH" fi - + chmod +x "$(pwd)"/cli/decky echo "Decky CLI tool is now installed and you can build plugins into easy zip files using the "Build Zip" Task in vscodium." fi diff --git a/.vscode/tasks.json b/.vscode/tasks.json index c482fc51..ed9afedb 100644 --- a/.vscode/tasks.json +++ b/.vscode/tasks.json @@ -60,7 +60,7 @@ // "command": "call ${workspaceFolder}\\.vscode\\build.bat", // }, "problemMatcher": [] - }, + }, //"All-in-one" build task { "label": "build", diff --git a/README.md b/README.md index de27fae0..5c9955da 100644 --- a/README.md +++ b/README.md @@ -2,14 +2,14 @@ Reference example for using [decky-frontend-lib](https://github.com/SteamDeckHomebrew/decky-frontend-lib) (@decky/ui) in a [decky-loader](https://github.com/SteamDeckHomebrew/decky-loader) plugin. -### **Please also refer to the [wiki](https://wiki.deckbrew.xyz/en/user-guide/home#plugin-development) for important information on plugin development and submissions/updates. currently documentation is split between this README and the wiki which is something we are hoping to rectify in the future.** +### **Please also refer to the [wiki](https://wiki.deckbrew.xyz/en/user-guide/home#plugin-development) for important information on plugin development and submissions/updates. currently documentation is split between this README and the wiki which is something we are hoping to rectify in the future.** ## Developers ### Dependencies -This template relies on the user having Node.js v16.14+ and `pnpm` (v9) installed on their system. -Please make sure to install pnpm v9 to prevent issues with CI during plugin submission. +This template relies on the user having Node.js v16.14+ and `pnpm` (v9) installed on their system. +Please make sure to install pnpm v9 to prevent issues with CI during plugin submission. `pnpm` can be downloaded from `npm` itself which is recommended. #### Linux @@ -28,7 +28,7 @@ If you would like to build plugins that have their own custom backends, Docker i 2. ``pnpm run build`` - These setup pnpm and build the frontend code for testing. 3. Consult the [decky-frontend-lib](https://github.com/SteamDeckHomebrew/decky-frontend-lib) repository for ways to accomplish your tasks. - - Documentation and examples are still rough, + - Documentation and examples are still rough, - Decky loader primarily targets Steam Deck hardware so keep this in mind when developing your plugin. 4. If using VSCodium/VSCode, run the `setup` and `build` and `deploy` tasks. If not using VSCodium etc. you can derive your own makefile or just manually utilize the scripts for these commands as you see fit. @@ -50,7 +50,7 @@ If you are developing with a backend for a plugin and would like to submit it to When building your plugin, the source code will be built and any finished binary or binaries will be output to ``backend/out`` (which is created during CI.) If your buildscript, makefile or any other build method does not place the binary files in the ``backend/out`` directory they will not be properly picked up during CI and your plugin will not have the required binaries included for distribution. -Example: +Example: In our makefile used to demonstrate the CI process of building and distributing a plugin backend, note that the makefile explicitly creates the `out` folder (``backend/out``) and then compiles the binary into that folder. Here's the relevant snippet. ```make @@ -63,7 +63,7 @@ The CI does create the `out` folder itself but we recommend creating it yourself Note: When locally building your plugin it will be placed into a folder called 'out' this is different from the concept described above. -The out folder is not sent to the final plugin, but is then put into a ``bin`` folder which is found at the root of the plugin's directory. +The out folder is not sent to the final plugin, but is then put into a ``bin`` folder which is found at the root of the plugin's directory. More information on the bin folder can be found below in the distribution section below. ### Distribution @@ -86,7 +86,7 @@ pluginname-v1.0.0.zip (version number is optional but recommended for users sake | dist/ [required] | | | index.js [required] - | + | package.json [required] plugin.json [required] main.py {required if you are using the python backend of decky-loader: serverAPI} diff --git a/backend/Dockerfile b/backend/Dockerfile index f46e1709..fa8e0473 100644 --- a/backend/Dockerfile +++ b/backend/Dockerfile @@ -6,4 +6,4 @@ FROM ghcr.io/steamdeckhomebrew/holo-base:latest # entrypoint.sh should always be located in the backend folder -ENTRYPOINT [ "/backend/entrypoint.sh" ] \ No newline at end of file +ENTRYPOINT [ "/backend/entrypoint.sh" ] diff --git a/backend/Makefile b/backend/Makefile index a1e5dc5d..40568dc8 100644 --- a/backend/Makefile +++ b/backend/Makefile @@ -1,4 +1,4 @@ -# This is the default target, which will be built when +# This is the default target, which will be built when # you invoke make .PHONY: all all: hello @@ -6,9 +6,9 @@ all: hello # This rule tells make how to build hello from hello.cpp hello: mkdir -p ./out - gcc -o ./out/hello ./src/main.c + gcc -o ./out/hello ./src/main.c # This rule tells make to delete hello and hello.o -.PHONY: clean +.PHONY: clean clean: - rm -f hello \ No newline at end of file + rm -f hello diff --git a/backend/entrypoint.sh b/backend/entrypoint.sh index af04d231..e5716819 100755 --- a/backend/entrypoint.sh +++ b/backend/entrypoint.sh @@ -5,4 +5,4 @@ echo "Container's IP address: `awk 'END{print $1}' /etc/hosts`" cd /backend -make \ No newline at end of file +make diff --git a/backend/src/main.c b/backend/src/main.c index b3b8fed2..6acd25b7 100644 --- a/backend/src/main.c +++ b/backend/src/main.c @@ -2,4 +2,4 @@ int main() { printf("Hello World\n"); return 0; -} \ No newline at end of file +} diff --git a/decky.pyi b/decky.pyi index a72c74c0..782b7883 100644 --- a/decky.pyi +++ b/decky.pyi @@ -181,4 +181,4 @@ Event handling async def emit(event: str, *args: Any) -> None: """ Send an event to the frontend. - """ \ No newline at end of file + """ diff --git a/defaults/defaults.txt b/defaults/defaults.txt index ebf140bc..4bd952b8 100644 --- a/defaults/defaults.txt +++ b/defaults/defaults.txt @@ -10,4 +10,4 @@ Files can also be put in here such as a config, just keep in mind that they this - package.json - plugin.json - themes - - exampletheme.css \ No newline at end of file + - exampletheme.css diff --git a/rollup.config.js b/rollup.config.js index 17e71a77..3af651b4 100644 --- a/rollup.config.js +++ b/rollup.config.js @@ -2,4 +2,4 @@ import deckyPlugin from "@decky/rollup"; export default deckyPlugin({ // Add your extra Rollup options here -}) \ No newline at end of file +})