Skip to content

Latest commit

 

History

History
156 lines (103 loc) · 9.07 KB

README.md

File metadata and controls

156 lines (103 loc) · 9.07 KB

Plugin-Store

📖 About

The Decky Plugin Store powers the built-in plugin storefront of Decky Loader for Steam Deck. It can be used to host Decky Loader compatible plugins for any use case, including hosting testing plugins and providing an alternative storefront.

For more information about Decky Loader as well as documentation and development tools, please visit our wiki.

🎨 Features

🐍 Backend written in Python with the FastAPI and SQLAlchemy (SQLite database in use) frameworks.

    🏤 PostgreSQL support is currently in development.

🌐 Frontend (for web browsers) written in JavaScript with the Vue.js framework

📤 API endpoints for:

    📃 List of plugins

      GET endpoint used by Decky Loader's built-in plugin browser

    📩 Uploading plugins

    ♻️ Updating plugins

🪣 Backblaze B2 Cloud Storage supported for hosting plugins & metadata as a CDN.

    🖼️ Handling image types for preview screenshots

    🔑 Handling uploads via an APP_KEY

    ♻️ Handling uploading different available versions of plugins

💬 Discord webhook support for sending notifications for new uploaded plugin versions

📦 Available as a GitHub Package & ready to go as a Docker deployment.

💾 Installation

Adding Storefront to Decky Loader

⚠️ Currently, Decky Loader accepts ONE custom store.

⚠️ Currently, Decky Loader accepts updates from ONE store at the time.

While switching stores keeps the plugins from any installed source installed, auto checking updates will not happen for all three channels (Stable, Testing and Custom). Only the currently selected Store Channel will be checked for plugin updates.

⚠️ In the future, custom stores will get a warning message pop up regarding third party plugins and plugin stores.

Due to the SteamDeckHomebrew / Decky Loader team not being responsible for third party plugins and stores, a warning will be displayed where the user would have to accept the potential risks of using third party software with Decky Loader.

  • Open your Decky Loader tab
  • Click on the Settings button (displayed as a Cog)
  • Stay on the General tab
  • Change the Store Channel to Custom
  • Fill in the URL in the Custom Store URL text field underneath Store Channel

Screenshot of Decky Loader's settings screen. Go to the General tag, change the Store Channel option to Custom and fill in the Custom Store URL in the URL text field.

Hosting a Decky Loader Plugin Storefront

⚠️ You will need the following to host a plugin store: a domain name (for external access) and Backblaze B2 Cloud Storage to use for plugin storage.

  • Install Docker on your preferred platform

  • Make sure to have the required Environment Variables ready in an .env file where the docker-compose.yml file is located at:

    • DB_PATH

      Database path where to put the SQLite databases

    • ANNOUNCEMENT_WEBHOOK

      URL for Discord webhooks for new plugins and updates

    • SUBMIT_AUTH_KEY

      API key for REST API requests to use for authentication; other systems are required to use this API key to be able to use the authentication-locked API endpoints

    • B2_APP_KEY_ID

      Backblaze B2 Master App Key ID (per account)

    • B2_APP_KEY

      Backblaze B2 App Key

    • B2_BUCKET_ID

      Backblaze B2 Bucket ID for restricting access to a single bucket

  • Run the Docker environment with the following command:

    docker compose up

    Use -d after docker compose up to run it in the background, not taking the current terminal window for logs.

    For local deployments, use the -f docker-compose.local.yml flag before up. The default API key for API requests is deadbeef for local deployments.

🤝 Contributing

Running in docker

As standard docker-compose.yml file is used for deployment, there is a separate docker-compose.local.yml file you can use. Just use docker-compose -f docker-compose.local.yml up to bring up the project. You can use any docker-compose commands normally as long as you add -f docker-compose.local.yml argument.

Using Makefile

There is a handy Makefile placed in the root directory of the project. It is not being used in a conventional way (to build the code or install built software), it's just creates nice aliases for commands. Here is a list of them:

  • autoformat - runs autoformatting on the whole Python codebase.
    • autoformat/black - runs only black command for autoformatting, which unifies codestyle.
    • autoformat/isort - runs only isort command for autoformatting, which reorders imports.
  • lint - runs lint check on the whole project.
    • lint/black - runs only black in check mode. After running black autoformatting, this check should pass.
    • lint/isort - runs only isort in check mode. After running isort autoformatting, this check should pass.
    • lint/flake8 - runs only flake8 linter. This does not have its own autoformat command, but it should be more or less covered by black autoformatting. It's here to make sure black does not leave any gaps in pep8 compliance.
    • lint/mypy runs only mypy linter. This does not have its own autoformat command either and errors needs to be fixed manually.
  • deps/lock - recreates lockfile without changing any package versions when possible. Needs to be executed after changing project dependencies.
  • deps/upgrade - recreates lockfile while trying to upgrade all packages to the newest compatible version.
  • test - runs project tests.

All commands above can be prefixed with dc/ to run them directly in a docker container. There are also additional, docker only commands:

  • dc/build - rebuilds docker images. Needs to be run after Dockerfile or project dependencies change.

Updating dependencies

This project is using Poetry to manage python packages required for the project. Poetry also keeps the lock file to make sure every environment where the same version of project is used, is as consistent as possible.

If you want to add any dependency, preferably add it manually in the pyproject.toml file. Please keep dependencies alphabetically sorted to avoid merge conflicts.

If adding or updating a single dependency inside the pyproject.toml, you need to update the lockfile. Please run make deps/lock to do as little changes to the lockfile as possible, unless your intention is to refresh every single dependency, then make deps/upgrade should be a better option. But you probably shouldn't use it unless you really need to.

Running tests

Simply run make test to run tests on your local machine. If using development docker-compose file, you shall use make dc/test instead.

Writing tests

This project uses pytest for running tests. Get familiar with it and fixtures system first. On top of pytest, async tests are supported via pytest.mark.asyncio decorator provided by pytest-asyncio. As project is using fastapi with async views as well as async DB, most of the tests need to be async.

All tests and configuration for them lives in tests directory. You can find some useful fixtures in the conftest.py file. If creating any more fixtures, please place them in this file unless you have a good reason not to do so.

There are two automatically applied fixtures, one patches over any external API calls, so they aren't really executed when running tests, second one overrides constants specifying any external resources. If adding any new external service dependencies to the project, please update those fixtures to patch them over as well.