RustRiff

From Rust to Rock in miliseconds!

RustRiff is a desktop guitar amplifier built with rust (**React + Typescript **, Rust + Tauri). RustRiff models core amp controls (gain, tone stack, channel flow), an effect chain, and cabinet impulse-response (IR).

Get Started

Prerequisites

• Node.js 24+
• npm 10+
• Rust stable toolchain
• Tauri system dependencies for your OS

Running locally

npm install
npm run tauri dev
Copy

Building for production

npm install
npm run tauri build
Copy

Work on documentation

RustRiff docs is a combination of custom written markdown and auto generated api references.

//Development docs run
npm run docs:dev

//Building the combined documentation
npm run docs:build
Copy

How to Contribute

1. Fork the repository and create a feature branch.
2. Keep changes scoped and aligned with the project architecture (src, src-tauri/src/commands, services, domain, infrastructure).
3. Add or update tests for success and failure paths when behavior changes.
4. Run checks before opening a PR.
5. Open a pull request with a short problem statement, solution summary, and testing notes.

License

See LICENSE.md.