OpenTaiko Hub

OpenTaiko Hub is a launcher, updater and asset manager for OpenTaiko.

README

OpenTaiko-Hub

Launcher, updater and asset manager for OpenTaiko.

Credits

Contributor credits

Theme credits
OpenTaiko Hub themes
Skeleton preset themes

The Skeleton preset themes are themes provided by Skeleton UI. (Specifically Skeleton v2.)
You can find info about the provided Skeleton themes here.

How to Test Locally

First Time: Environment Set up (Windows)

Follow the instruction of https://tauri.app/start/prerequisites/#windows.

Warning: Using WSL (Windows Subsystem for Linux) to test the project will not work because the path for Windows version of OpenTaiko is different. Installing natively on the Windows side is necessary.

Build and Launch Dev Server

Open terminal, cd into the OpenTaiko-Hub directory, run npm install to install or update the dependency packages.

Then run npm run tauri dev, and then wait the project to build and the OpenTaiko-Hub window to boot.

The frontend is TypeScript: run npm run check to type-check it (the Rust backend is checked with cargo check in src-tauri). npm test runs the frontend unit tests, and cargo test in src-tauri the backend ones.

A dev build keeps its instances, songs and logs in dev-hub/ at the root of the repository (ignored by git), so cargo clean never deletes them. Set OTK_HUB_ROOT to use another folder.

How to Build Locally

Use the release build from GitHub action is usually enough. However, you can still run npm run tauri build to build the build.