fxgl-audio

name	fxgl-audio
description	Play and manage audio in FXGL — trigger one-shot sound effects, loop background music, control master and per-type volume, load sound and music assets, use the AudioPlayer service directly, and speak text via platform TTS. Use this skill when adding sound effects to game events, playing background music, implementing volume sliders, or integrating text-to-speech dialogue in a game.
triggers	["sound effect","background music","AudioPlayer","play sound","loopBGM","music volume","SFX","wav","mp3","text to speech","TTS","audio"]
compatibility	Java 17+, FXGL 21.x. TTS requires fxgl-intelligence module and platform TTS engine.
category	fxgl/audio
tags	["fxgl","java","javafx","audio"]
metadata	{"author":"fxgl-skills","version":"1.0","fxgl-version":"21.1"}
allowed-tools	["Read","Write","Edit","Bash"]

FXGL Audio System

Asset Placement

Audio files go in src/main/resources/assets/:

• Sounds → assets/sounds/ — short clips (WAV recommended for low latency)
• Music → assets/music/ — long tracks (MP3 or OGG for size efficiency)

Quickstart — DSL Shortcuts

// Play a sound effect (one-shot, auto-managed)
FXGL.play("sounds/shoot.wav");

// Loop background music
FXGL.loopBGM("music/theme.mp3");

// Stop / pause / resume background music
FXGL.stopBGM();
FXGL.pauseBGM();
FXGL.resumeBGM();

Loading and Playing Manually

// Load once (cached), play many times
Sound jumpSound  = getAssetLoader().loadSound("sounds/jump.wav");
Music themeMusic = getAssetLoader().loadMusic("music/theme.mp3");

// Play
getAudioPlayer().playSound(jumpSound);
getAudioPlayer().playMusic(themeMusic);

// Loop a specific music object
getAudioPlayer().loopMusic(themeMusic);

// Stop / pause / resume specific music
getAudioPlayer().stopMusic(themeMusic);
getAudioPlayer().pauseMusic(themeMusic);
getAudioPlayer().resumeMusic(themeMusic);

Volume Control

// Global volumes (0.0 = mute, 1.0 = full)
getSettings().setGlobalSoundVolume(0.8);
getSettings().setGlobalMusicVolume(0.5);

// At runtime via AudioPlayer
getAudioPlayer().setGlobalSoundVolume(0.7);
getAudioPlayer().setGlobalMusicVolume(0.4);

// Individual sound volume (set before playing)
Sound s = getAssetLoader().loadSound("sounds/explosion.wav");
s.setVolume();   
getAudioPlayer().playSound(s);


   getAssetLoader().loadMusic();
bgm.setVolume();
getAudioPlayer().loopMusic(bgm);