MightyPrinny / godot-FLMusicLib

GDNative library that plays mp3, chiptune and tracker music files using Game Music Emu, Minimp3 and openmpt
Creative Commons Zero v1.0 Universal
51 stars 7 forks source link
chiptune gdnative godot mp3 music

GDNative library that plays mp3 and chiptune music files. The project uses GameMuseEmu, Minimp3, libopenmpt and the new Audio features from Godot 3.1.1

This project is statically linked to GME 0.6.2 which is licensed under the LGPLv2.1. GME Source Code: https://bitbucket.org/mpyne/game-music-emu/src/0.6.2/

Check the licenses folder for more information on the libraries used in this project.

Notes

-mp3 files must have a constant bitrate.

-after exporting a windows game you have to copy some of the dlls to the game folder manually

Methods

-bool play_music(String path,int trackNum,bool loop = true,int loopStart = -1,int loopEnd = -1,int startMsec = 0)

-void stop_music()

-bool is_playing()

-void set_volume(float vol)

-void store_music_state()

-void restore_music_state()

-int get_track_position_msec()

-void toggle_pause()

Signals

-track_ended: emited when the music is not looping and a music track ends, timing might not be accurate for chiptune music since the music length is unknown in most cases.