Skip to content

noahm/smx-config-web

Repository files navigation

SMX Config - Web Edition

Introduction

This is a work-in-progress config tool for StepManiaX stages that runs in a web browser. It can read debug values from individual sensors and perform a factory reset on a stage. It currently cannot write configuration (sensitivity levels, GIFs, etc) to the stage, yet.

Connect your stage to a desktop/laptop computer, and visit smx.tools in Google Chrome, Microsoft Edge, Brave, Vivaldi, etc.

Our tech stack uses WebHID (Chrome-only at the moment) to communicate with the stages. React is used for the UI.

Developing

Recommend you install mise to manage your NodeJS install.

First time setup

Install the Biome linter/formatter extension in VS Code.

# set up nodejs
$ mise install

# install yarn
$ npm i -g yarn

Day-to-day dev work

# install/update local copies of npm dependencies
$ yarn install

# start the local live-reloading dev server
$ yarn start

# apply all auto-fixes to formatting, style, etc
$ yarn lint --apply

Credit

This project is heavily based on pySMX which is heavily based on the original StepManiaX SDK.