Installation

Step-by-step installation guide for FMOD API and FMOD Engine

Installation

Follow these steps to install FMOD API and FMOD Engine for your Minecraft mod development.

🚀 Quick Setup

For End Users

Download FMOD API
- Download from Modrinth (recommended)
- Or from CurseForge
- ⚠️ Only download from official sources
Install FMOD Engine
- Visit FMOD.com Downloads
- Download FMOD Engine version 2.02.16
- Run the installer (creates free account if required)
Install Mod
- Drop fmod-api-x.x.x.jar into your mods folder
- Restart Minecraft
- FMOD API will auto-detect your FMOD installation
Verify Installation
- Go to Mods → FMOD API → Config
- Check that FMOD is enabled and detected
- If not detected, set custom path (see below)

For Mod Developers

Add Dependency Add FMOD API as a dependency in your mods.toml:

[[dependencies.yourmod]]
    modId="fmodapi"
    mandatory=true
    versionRange="[1.0,)"
    ordering="BEFORE"

Basic Usage

// Simple positioned sound
FMODAPI.playEventSimple("event:/yourmod/sound", x, y, z);

// Advanced usage with control
if (FMODAPI.isAvailable()) {
    String instanceId = FMODAPI.playEvent("event:/yourmod/engine",
                                        new Vec3D(x, y, z),
                                        1.0f, 1.2f);
}

Load Your Sound Banks

// During mod initialization
FMODAPI.loadBankFromResource(YourMod.class,
    "/assets/yourmod/sounds/fmod/master.bank");

🔍 FMOD Library Detection

FMOD API uses a 3-tier detection system to find FMOD libraries:

1. 🎯 JAR Resources (Development)

Loads DLLs from mod's /libraries/ folder
Used for development builds with INCLUDE_LIBS=true

2. 🔄 System Detection (Automatic)

Checks standard FMOD installation paths
Scans system PATH for libraries
Works with default FMOD installations

3. 🛡️ Custom Path (Manual)

User-configurable path in mod config
Scans up to 4 levels deep for DLL files
Handles portable and custom installations

Auto-detection works for 95% of users. Custom path is only needed for non-standard installations.

🛠️ Troubleshooting Installation

Common Issues

FMOD not detected

Verify FMOD Engine 2.02.16 is installed
Check custom path setting if using non-standard location
Enable debug logging to see detection attempts

Required Files

The mod needs these files from your FMOD installation:

fmod.dll (Core audio engine)
fmodstudio.dll (Studio API)

Custom Installation Paths

If FMOD isn't auto-detected, set a custom path:

Open config: Mods → FMOD API → Config
Set custom path to your FMOD installation directory

Examples:

C:\Program Files (x86)\FMOD SoundSystem\
D:\PortableApps\FMOD\
E:\Games\Audio\FMOD Engine\

Auto-scanning: Finds DLLs automatically within 4 folder levels

Next: First Steps to test your installation!

Requirements

System and FMOD Engine requirements for using FMOD API

First Steps

Test your FMOD API installation and make your first audio calls