Skip to content
This repository has been archived by the owner on Dec 16, 2022. It is now read-only.
/ mutiny Public archive

Framework for building Steam Deck UI addons

Notifications You must be signed in to change notification settings

barenddt/mutiny

Repository files navigation

Mutiny

Commitizen friendly

Mutiny aims to provide developers with an easy to use experience similar to create-react-app, but for developing standalone extensions/addons for Valve's Steam Deck. Mutiny simplifies the process by providing high level abstractions that can be used to inject custom React code into the decks user interface.

Features

  • 🔥 Hot reloading
  • 💻 Server support for calling OS commands
  • ⚙️ CLI for creating new projects (coming soon)
  • 🪝 Hooks for the Steam Deck's MobX stores (coming soon)
  • 📦 Packager for creating one-click installers (coming soon)

Getting started (WIP)

⚠️ mutiny is still under active development and is not ready for production.

Create a new project using the CLI:

npx create-mutiny-app my-app

Start the development server:

cd my-app
yarn dev

Develop

Clone the repository:

git clone https://github.com/barenddt/mutiny.git && cd mutiny

Install dependencies:

yarn install