Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Getting Started

Maolan is currently available for FreeBSD, Linux, macOS, and Windows.

Download

FreeBSD

Install from packages:

pkg install maolan

Linux

Download the x86_64 Fedora, Debian, and Ubuntu package from the release page:

github.com/maolan/maolan/releases/tag/0.2.3

Windows

Download the x86_64 installer (EXE) for Windows 10 and 11 from the release page:

github.com/maolan/maolan/releases/tag/0.2.3

macOS

There is no prebuilt macOS installer yet. Build Maolan from source on macOS following the repository instructions.

Build from Source

Maolan is open source. If you prefer to build manually or run on macOS, clone the repository and build with Cargo:

git clone https://github.com/maolan
cd maolan
cargo run --release

The main application is in the maolan/ directory. The repository root is a multi-crate project directory, not a single Cargo workspace, so build commands must be run from the relevant crate directory:

cd maolan
cargo build --workspace
cargo run

Release build

cd maolan
cargo build --workspace --release

Platform prerequisites

  • Linux / FreeBSD: pkg-config, JACK/ALSA dev packages, liblilv-dev, libsuil-dev, libgtk2.0-dev, FFmpeg libraries, LLVM/Clang (for bindgen).
  • Windows: Visual Studio Build Tools, LLVM/Clang, NSIS, vcpkg packages (sentencepiece:x64-windows), FFmpeg NuGet package. See maolan/scripts/build.ps1 and plugins/build.ps1 for the automated setup.
  • macOS: Xcode / Command Line Tools, CoreAudio frameworks.

Next Steps