Installation Guide

This guide will help you install and set up Supertonic TTS on your system. The installation process varies depending on your programming language and platform.

Prerequisites

Before installing Supertonic TTS, you need to:

• Install Git LFS (Large File Storage) to download model files
• Clone the Supertonic repository
• Download the ONNX models and preset voices

Installing Git LFS

The model files are stored using Git LFS. You need to install and initialize Git LFS before cloning the repository.

On macOS, you can install Git LFS using Homebrew:

brew install git-lfs && git lfs install

For other operating systems, visit the Git LFS website for installation instructions.

Cloning the Repository

Clone the Supertonic repository:

git clone https://github.com/supertone-inc/supertonic.git
cd supertonic

Downloading Models

Download the ONNX models and preset voices from Hugging Face:

git clone https://huggingface.co/Supertone/supertonic assets

Place the downloaded files in the assets directory of your Supertonic installation.

Language-Specific Installation

Python

Navigate to the Python directory and install dependencies:

cd py
uv sync
uv run example_onnx.py

The Python implementation uses ONNX Runtime for inference. Make sure you have Python 3.8 or later installed.

Node.js

For server-side JavaScript applications:

cd nodejs
npm install
npm start

This implementation is suitable for Node.js server applications.

Browser (Web)

For web browser applications using WebGPU or WASM:

cd web
npm install
npm run dev

The browser implementation uses onnxruntime-web for client-side inference. This allows you to run Supertonic TTS directly in web browsers without server-side processing.

Java

For JVM-based applications:

cd java
mvn clean install
mvn exec:java

The Java implementation works on any platform that supports the Java Virtual Machine.

C++

For high-performance native applications:

cd cpp
mkdir build && cd build
cmake .. && cmake --build . --config Release
./example_onnx

The C++ implementation provides native performance for applications that need maximum speed.

C#

For .NET ecosystem applications:

cd csharp
dotnet restore
dotnet run

This implementation works with .NET Framework and .NET Core applications.

Go

For Go applications:

cd go
go mod download
go run example_onnx.go helper.go

The Go implementation provides a simple way to integrate Supertonic TTS into Go applications.

Swift

For macOS applications:

cd swift
swift build -c release
.build/release/example_onnx

The Swift implementation is designed for macOS applications.

Rust

For Rust applications:

cd rust
cargo build --release
./target/release/example_onnx

The Rust implementation provides memory-safe integration for Rust applications.

iOS

For native iOS applications:

cd ios/ExampleiOSApp
xcodegen generate
open ExampleiOSApp.xcodeproj

In Xcode, select your Team for signing, choose your iPhone as the run destination, then build and run the application.

Flutter

For cross-platform Flutter applications:

Flutter SDK support is available with macOS compatibility. Refer to the Flutter directory in the repository for specific installation instructions.

Troubleshooting

If you encounter issues during installation:

• Ensure Git LFS is properly installed and initialized
• Verify that model files are downloaded completely
• Check that all dependencies are installed for your chosen language
• Review the README file in your language directory for specific requirements
• Ensure your system meets the minimum hardware requirements

Next Steps

After installation, you can:

• Run the example code to test your installation
• Review the example implementations to understand the API
• Customize the settings to match your needs
• Integrate Supertonic TTS into your application