Installation
RMT Compose can be used in two ways: via the live demo or locally for development.
Live Demo (Recommended for Users)
The easiest way to use RMT Compose is the hosted version:
No installation required. Works in any modern browser with WebGL2 support.
Local Installation (For Development)
Prerequisites
- Node.js 18+ - Download from nodejs.org
- Git - For cloning the repository
- Modern browser - Chrome, Firefox, Edge, or Safari with WebGL2
Steps
- Clone the repository
git clone https://github.com/anthropics/rmt-compose.git
cd rmt-compose- Install dependencies
npm ci- Start the development server
npm run dev- Open in browser
Navigate to the URL shown by Vite (typically http://localhost:3000).
Production Build
To create a production build:
npm run buildTo preview the production build locally:
npm run previewWASM Build (Optional)
For enhanced performance, you can build the Rust/WASM core:
Prerequisites
- Rust toolchain - Install from rustup.rs
- wasm-pack - Install with
cargo install wasm-pack
Build WASM
npm run wasm:buildThis compiles the Rust code to WebAssembly and places it in the rust/pkg directory.
WASM is Optional
The app works perfectly without WASM. The JavaScript implementation provides identical functionality - WASM just offers better performance for complex modules with many notes.
Browser Support
RMT Compose requires WebGL2, which is supported by:
| Browser | Minimum Version |
|---|---|
| Chrome | 56+ |
| Firefox | 51+ |
| Safari | 15+ |
| Edge | 79+ |
WebGL2 Required
If WebGL2 is not available, the workspace will not initialize. Most modern browsers support WebGL2 by default.
Troubleshooting
"WebGL2 not available" error
- Ensure your browser is up to date
- Check if hardware acceleration is enabled in browser settings
- Try a different browser
- Update your graphics drivers
Module loading fails
- Clear browser cache and reload
- Check browser console for errors
- Ensure you're using a supported browser
Development server won't start
- Ensure Node.js 18+ is installed:
node --version - Delete
node_modulesand reinstall:rm -rf node_modules && npm ci - Check if port 3000 is already in use
Next Steps
Now that you have RMT Compose running, continue to Your First Composition to create your first piece.