Installation Guide

This page explains how to install Godot-FmodPlayer into a Godot project and add the required FMOD Core API runtime libraries. In most cases, use the prebuilt package. Build from source only when you need to modify the plugin source code or adapt it to another platform.

Before You Start

Before you begin, make sure that:

• Your Godot version is 4.1 or later.

• Your target platform is currently Windows x86_64 or Android arm64.

• You are ready to download FMOD Engine from the official FMOD website.

Important

Godot-FmodPlayer does not include the FMOD runtime libraries. Because of FMOD licensing requirements, you must download FMOD Engine yourself from the FMOD download page and copy the runtime libraries for your target platform into the project.

Prebuilt Package (Recommended)

Download the Plugin

1. Download the plugin from the Godot Asset Library, or download a release package from GitHub Releases.

2. After extracting the package, copy addons/fmod_player into your Godot project:

   res://
   └── addons/
       └── fmod_player/
           ├── plugin.cfg
           ├── fmod_check.gd
           ├── fmod_player_main.gd
           └── bin/
               ├── fmod_player.gdextension
               ├── fmod_player.windows.template_debug.x86_64.dll
               ├── fmod_player.windows.template_release.x86_64.dll
               ├── libfmod_player.android.template_debug.arm64.so
               └── libfmod_player.android.template_release.arm64.so
   

Add the FMOD Runtime Libraries

Open the FMOD download page, sign in, and download FMOD Engine. After extracting it, copy the runtime libraries required by your target platform.

Platform	Required files	Location
Windows x86_64	fmod.dll	res://addons/fmod_player/bin/
Android arm64	libfmod.so and fmod.jar	See the Android export setup in Export Guide.

After installing the Windows version, the project usually looks like this:

res://
└── addons/
    └── fmod_player/
        └── bin/
            ├── fmod_player.gdextension
            ├── fmod.dll
            ├── fmod_player.windows.template_debug.x86_64.dll
            └── fmod_player.windows.template_release.x86_64.dll

Note

When enabled, the editor plugin checks for fmod.dll, libfmod.so, or libfmod.dylib. If the FMOD runtime library cannot be found, Godot displays a prompt and points you to the FMOD download page.

Enable the Plugin

1. Open the Godot editor.

2. Go to Project > Project Settings > Plugins.

3. Find FMOD Player and enable it.

4. If you just copied the FMOD runtime libraries, restart the Godot editor once.

Verify the Installation

After enabling the plugin, you can quickly check that it is available:

1. Search for Fmod in the Add Node dialog. You should see:

   • FmodAudioStreamPlayer

   • FmodAudioStreamPlayer2D

   • FmodAudioStreamPlayer3D

2. Search for Fmod in the resource creation menu. You should see:

   • FmodAudioStream

   • FmodAudioBusLayout

3. Open Godot’s Output panel and confirm that there are no missing FMOD runtime errors or GDExtension loading errors.

If the node or resource types do not appear, the usual causes are a missing FMOD runtime library, a platform architecture mismatch, or addons/fmod_player not being placed under the project’s res://addons/ directory.

Build from Source

Build from source only when you need to modify the C++ source code, debug the GDExtension, or generate platform binaries yourself.

Requirements

• Python 3.11 or later

• SCons 4.10 or later

• Git

• A C++17 build environment

• Windows builds require MSVC.

• Android builds require the Android SDK, NDK, and JDK.

Get the Source Code

git clone --recursive https://github.com/LuYingYiLong/Godot-FmodPlayer.git
cd Godot-FmodPlayer

Build for Windows

scons platform=windows target=template_debug arch=x86_64
scons platform=windows target=template_release arch=x86_64

Build for Android

scons platform=android target=template_debug arch=arm64
scons platform=android target=template_release arch=arm64

Build Output

After building, place the generated binaries in addons/fmod_player/bin/. The current fmod_player.gdextension file references these filenames by default:

addons/fmod_player/bin/
├── fmod_player.windows.template_debug.x86_64.dll
├── fmod_player.windows.template_release.x86_64.dll
├── libfmod_player.android.template_debug.arm64.so
└── libfmod_player.android.template_release.arm64.so

If you change the output filenames or target platform, update bin/fmod_player.gdextension accordingly.

Build Options

Option	Common values	Description
platform	windows or android	Target platform to build for.
target	template_debug or template_release	Debug or release build.
arch	x86_64 or arm64	Target architecture to build for.

FMOD Licensing Notes

Godot-FmodPlayer uses the MIT license. FMOD Engine is covered by a separate license from Firelight Technologies Pty Ltd. Before publishing, commercializing, or distributing a project for a specific platform, read FMOD Licensing and FMOD Legal Information.

Next Step

After installation, read Quick Start to play your first audio file.

If you run into problems, check FAQ, especially the entries about missing runtime libraries, no sound after export, and platform architecture mismatches.