FMOD API

Minecraft 版本： 1.21.1

平台： neoforge

标签： library utility

Professional-grade 3D spatial audio API for Minecraft mods

Transform your Minecraft audio experience with industry-standard FMOD Studio integration.
This centralized API eliminates conflicts between audio mods while providing advanced 3D
spatial audio capabilities.

? Key Features

? Centralized Audio Management

• Conflict-free: Multiple mods can use FMOD without conflicts
• Shared resources: One FMOD instance serves all audio mods
• Automatic cleanup: Prevents memory leaks and resource exhaustion

? Native Minecraft Integration

• Automatic pause/resume: FMOD sounds pause when you open menus
• Volume synchronization: Respects Minecraft's audio settings
• 3D listener tracking: Player position automatically tracked for spatial audio

⚙️ Flexible Installation

• Auto-detection: Finds FMOD Engine from standard installations
• Custom paths: Configure non-standard FMOD locations
• Recursive scanning: Searches up to 4 folder levels for libraries
• OpenAL fallback: Always works even without FMOD

?️ For Mod Developers

Simple Integration

  // Check availability and play 3D audio
  if (FMODAPI.isAvailable()) {
      FMODAPI.playEventSimple("event:/mymod/explosion", x, y, z);
  } else {
      // Your OpenAL fallback
      playOGGSound("explosion.ogg");
  }

  Advanced Features

  - Bank loading: FMODAPI.registerBank(MyMod.class, "/assets/mymod/sounds/master.bank")
  - 3D positioning: Automatic listener tracking with manual override support
  - Volume control: FMODAPI.setMasterVolume() and per-instance control
  - Pause management: FMODAPI.pauseAllSounds() / resumeAllSounds()

  ---
  ? Installation

  Step 1: Install the Mod

  Download FMOD API from official sources only:
  - ✅ Modrinth (this page)
  - ✅ CurseForge
  - ❌ Third-party redistribution prohibited

  Step 2: Install FMOD Engine

  1. Download FMOD Engine 2.02.16 from: https://www.fmod.com/download#fmodengine
  2. Run the installer (free for non-commercial use)
  3. FMOD API will automatically detect your installation

  Step 3: Custom Setup (Optional)

  For non-standard installations:
  1. Open Mods → FMOD API → Config
  2. Set "Custom FMOD Path" to your installation directory
  3. The mod scans recursively to find the required DLLs

  ---
  ? Audio Features

  3D Spatial Audio

  - Distance attenuation: Sounds fade naturally with distance
  - Directional audio: Hear sounds from the correct direction
  - Doppler effects: Moving sound sources shift pitch realistically
  - Environmental audio: Support for reverb and occlusion effects

  Performance Optimized

  - Configurable instances: 32-4096 concurrent sounds (default: 512)
  - Automatic cleanup: Finished sounds cleaned up within 1 second
  - Smart caching: Banks loaded once, shared across all mods
  - Minimal overhead: <2% CPU impact during normal operation

  ---
  ? Configuration Options

  | Setting                 | Description                          | Default     |
  |-------------------------|--------------------------------------|-------------|
  | Enable FMOD Audio       | Toggle between FMOD and OpenAL       | ✅ Enabled   |
  | Debug Logging           | Detailed logging for troubleshooting | ❌ Disabled  |
  | Maximum Sound Instances | Concurrent audio limit (32-4096)     | 512         |
  | Custom FMOD Path        | Non-standard installation path       | Auto-detect |

  ---
  ? Multi-Language Support

  - English: Complete documentation and interface
  - Polish: Full translation with technical details
  - Expandable: Ready for additional languages

  ---
  ?️ Reliability & Safety

  Fail-Safe Architecture

  - Never crashes: All exceptions caught and handled gracefully
  - Graceful degradation: Falls back to OpenAL if FMOD unavailable
  - Zero single points of failure: Individual sound failures don't break the system

  Legal Compliance

  - No FMOD redistribution: Users install FMOD Engine separately
  - Proper licensing: Clear guidelines for commercial use
  - Safe for modpacks: No licensing concerns for pack creators

  ---
  ? For End Users

  Enhanced Audio Experience

  - Immersive 3D audio: Feel like you're really in the world
  - Automatic integration: Works seamlessly with FMOD-enabled mods
  - No configuration needed: Install and it just works
  - Always compatible: Falls back to standard audio if needed

  Debug Tools

  - /fmodstatus command: Real-time audio system information
  - Detailed logging: Comprehensive troubleshooting information
  - Performance monitoring: Track active sound instances and usage

  ---
  ? Technical Requirements

  - NeoForge: 1.21.1+
  - Java: 21+
  - FMOD Engine: 2.02.16+ (separate download)
  - Platform: Windows (with FMOD Engine installed)

  ---
  ? Why Choose FMOD API?

  For Players

  - Better audio: Industry-standard 3D spatial audio
  - Mod compatibility: Multiple audio mods work together
  - Automatic operation: No complex setup required

  For Mod Developers

  - Easy integration: Simple API with comprehensive examples
  - Conflict-free: No resource competition with other mods
  - Professional results: Industry-grade audio with minimal effort

  For Modpack Creators

  - Legal safety: No redistribution licensing issues
  - Reliable: Graceful fallbacks ensure modpacks always work
  - Performance: Shared resources reduce memory usage

  ---
  ? Links & Resources

  - ? Documentation: Complete API reference and guides included
  - ? Issues: https://github.com/alexiokay/fmod-API/issues
  - ? Support: Use GitHub issues for technical support
  - ? FMOD Engine: https://www.fmod.com/download#fmodengine