libopenmpt-godot Documentation

A Godot GDExtension wrapper for libopenmpt, enabling playback of tracker music formats (MOD, XM, S3M, IT, and many more).

Contents:

• Getting Started
  • Installation
  • Basic Usage
  • Next Steps
• API Reference
  • AudioStreamOpenMPT
  • AudioStreamPlaybackOpenMPT
• Examples
  • Basic Music Player
  • Module Information Display
  • Interactive Music Player
  • Pattern-based Music System
  • Module Browser
  • Random Module Player
• Building from Source
  • Prerequisites
  • Clone the Repository
  • Build the Extension
  • Build Options
  • Building Unit Tests
  • Cross-Compilation
  • Integration with Godot
  • Troubleshooting
  • Build Configuration
  • Debugging the Extension
  • Contributing
• Testing
  • Running Tests
  • Test Output
  • Test Organization
  • Writing Tests
  • Testing with Module Files
  • Continuous Integration
  • Code Coverage
  • Benchmarking
  • Test Best Practices
  • Example Test Categories
  • Debugging Failed Tests

Features

• Full support for tracker music formats via libopenmpt

• Native Godot AudioStream integration

• Real-time tempo and pitch control

• Pattern navigation and module introspection

• Comprehensive metadata access

• Cross-platform support (Windows, Linux, macOS)

Quick Start

# Create and load a module
var stream = AudioStreamOpenMPT.new()
stream.load_from_file("res://music/song.mod")

# Play using AudioStreamPlayer
var player = AudioStreamPlayer.new()
add_child(player)
player.stream = stream
player.play()

Indices and tables

• Index

• Search Page