Skip to content

QUICK_START.md

Latest commit

 

History

History
79 lines (57 loc) · 1.51 KB

QUICK_START.md

File metadata and controls

79 lines (57 loc) · 1.51 KB

FMOD Flutter - Quick Start

5-Minute Setup

1. Add Plugin

# pubspec.yaml
dependencies:
  fmod_flutter:
    git:
      url: https://github.com/SuperWes/fmod_flutter.git
flutter pub get

2. Get FMOD

  1. Sign up at fmod.com/download (free)
  2. Download FMOD Studio API for your platforms
  3. Place in engines/ directory in your project root

Windows note: The Windows SDK is an .exe installer. Run it first, then copy the installed folder to engines/windows/fmodstudioapi*win/. See the full README for details.

3. Run Setup

mkdir engines
# Add downloaded files to engines/
dart run fmod_flutter:setup_fmod

4. Add Audio Banks

# pubspec.yaml
flutter:
  assets:
    - assets/audio/Master.bank
    - assets/audio/Master.strings.bank

5. Use It!

import 'package:fmod_flutter/fmod_flutter.dart';

final fmod = FmodService();

// Initialize
await fmod.initialize();
await fmod.loadBanks(['assets/audio/Master.bank']);

// Play
await fmod.playEvent('event:/Music/MainTheme');

.gitignore

Add this to .gitignore (for public/open-source projects):

# FMOD SDK files (proprietary - can't redistribute publicly)
engines/
android/app/src/main/jniLibs/libfmod*.so
android/app/libs/fmod/
ios/FMOD/
macos/FMOD/
windows/FMOD/
web/fmod/

For private projects, you can commit these files so your team doesn't need to run setup.

Full guide: See README.md