Mini Player is a compact and intuitive audio player for Foundry VTT. It provides a streamlined interface to manage your playlists and tracks without taking up valuable screen space. Key features include:
- Quick access to all your playlists and tracks.
- Standard playback controls (play/pause, next/previous, stop).
- Volume slider and a one-click mute button.
- Remembers the last played track, even after closing.
- Persistent window size and position.
For bug reports, feature requests or general chat about the module or other publications, please join our community on Discord.
Manifest URL: https://github.com/xthesaintx/wgtgm-mini-player/releases/latest/download/module.json
Official Package URL: https://foundryvtt.com/packages/wgtgm-mini-player
Playlists
- Mini Player automatically adds all the playlists that are NOT set to soundboard only.
- Soundboard Player automatically adds all the playlists that ARE set to soundboard only, and can be set to filter between all soundboard only playlists and playlists that have their channel set to environmental.
- The Add Playlists button will scan the directories and sub-directories of the selected folder in settings and create a playlist for each folder that contains a sound file. If the folder has the suffix “-sfx”, it will be made as a Soundboard Only playlist and with the other options set in settings.
Mini Player UI
As the player resizes it will go through these three view configurations.
Compact View
Mid Compact View
Expanded View
Controls
/ Pauses / Plays the current track
Previous track
Next track
Stop track: If no track is playing in the selected playlist, stop all tracks.
/ Mutes / Unmutes the volume. The slider to the right changes the track volume.
Switch to Tag Mode player
Opens the Soundboard Player
Opens the Edit Tags dialogue
Opens the Create Playlist from Tags dialogue
Add / Remove track from favourites
Toggles crossfade
Toggles repeat on the current track
Open the Playlist and Track drawer
Tag Player
The Tag Player mode removes the playlist drop-down and replaces it with a cloud of tags that can be left-clicked to toggle between included and unselected, and right-clicked to toggle between excluded and unselected. A drop-down list of tracks filtered from the selected tags is below it.
Playlists
Clicking on the icon () at the bottom of the window will slide down the playlist and track drawer. The top drop-down list displays a list of playlists with tracks, and an icon () indicates if a track in that playlist is playing.
The track list will display if a tracked is muted (🔇), if it is set to loop (🔁), if it is set to favorite (⭐) and if it is currently playing ().
Selecting a track from the drop-down list will start playing that track if enabled in the settings.
Tags
Edit Tags
A list of all music tracks from the base music folder (ignoring sfx) can be entered in the Add tag… text box or selected from the dropdown in the same box. Clicking on the x of a tag will remove it. A preview of the track can be listened to by pressing the play () button.
Header buttons:
- Import Tag data from JSON
- Export Tag data to JSON
- Clean up the tag database, removes any tracks that don’t exists in world from the database of tags
Create playlist from Tags
A cloud of available tags and a mode button (AND/OR) at the top allow filtering of tracks. Filtered tracks appear below, and a Create Playlist button will create a new playlist from those tracks. A preview of the track can be listened to by pressing the play () button.
The mode button switches between AND and OR. AND mode looks for all selected tags to exist on a track, and OR mode looks to see if any of the tags exist on a track.
Tags can be left-clicked to toggle between included and unselected, and right-clicked to toggle between excluded and unselected.
Soundboard Player UI
Soundboard Controls
A drop-down list of the playlists is in the top middle of the window, and an icon () indicates if the playlist has a sound that is playing.
/ Toggles between auto-resize and manual-resize of the window. Auto-resize will step up through 3×3, 4×4, 5×5 and 6×6, then six columns and as many rows as needed. Manual-resize will adjust the rows and columns depending on the window size and is scroll-enabled.
/ Toggles between filtering playlists with the channel set to environmental and all soundboard-only playlists.
Toggles crossfade
Toggles multitrack playback
/ Mutes / Unmutes the volume.
Sound Buttons
- An active sound will highlight when playing.
- Right-clicking on a button will open a file browser to place an image on the button.
- An icon () to remove the image is in the top right of the button
Settings
Keyboard shortcut
The default shortcuts are:
- Command + M to open the Mini Player
- Command + Alt + M to open the Soundboard Player
Core Settings
Welcome message: Disable this to display the welcome message on login again
Remember the player and soundboard state: If the players were open on closing Foundry, they will open when Foundry launches.
Enable crossfade: Enables crossfade for the music player, can be toggled on the player.
Enable crossfade on Soundboard: Enables crossfade for the soundboard, can be toggled on the soundboard.
Crossfade duration (seconds): Length of the crossfade in seconds can be set from 0.5 to 10 seconds.
Maximum number of tracks in a Tag Playlist: The tag playlist is dynamically generated, and an extensive dynamic tracklist can be system-intensive. Reduce this setting if you suffer any performance issues when using the mini player in tag mode.
Base music folder: The folder Mini Player will search for playlist creation. Either use the browser () or manually enter path
Set Soundboard Playlist tracks to loop: If enabled, imported sounds in the soundboard-only playlists will be set to loop.
Set Soundboard Playlist channel to Environment: If enabled, created soundboard-only playlists will be set to the environment channel.
Set Music Playlist tracks to loop: If enabled, imported tracks in the music playlists will be set to loop.
Play onf Track Select: Enable this play a track automatically when selected.
Stop on New Playlist: Enable this to have only one track playing at a time. Disabled, it allows a track per playlist to play simultaneously.
Link with TTRPG Music (Patreon): Integrate Tabletop RPG tracks in tag mode If you have the Tabletop RPG (Patreon) Foundry Module installed
Foundry UI Integration
- An “Mini Player” and “Soundboard” button at the top of the playlists panel will open the Mini Player and Soundboard, respectively.
- Right-clicking on the Ambient Sound Control scene control button () will open the Mini Player.
- Add Playlists scans the directories and sub-directories of the selected folder in settings and creates a playlist for each folder that contains a sound file.
- Remove Playlists will remove all the playlists created by Add Playlists.
- Edit Tags: Opens the edit tags dialogue
- Tag Playlist: Opens the Create Playlist from Tags dialogue
Tabletop RPG Music Integration
Mini Player Controls
With the link setting enabled and the Tabletop RPG (TTRPG) module is installed and active, a “TTRPG” tag will appear at the start of the tag list. Enabling this tag will include TTRPG tracks when populating the generated playlist and TTRPG tags in the tag cloud.
Playlist from TTRPG Tags
With the link setting enabled and the Tabletop RPG (TTRPG) module is installed and active, a “TTRPG” tag will appear at the start of the tag list. Enabling this tag will include TTRPG tracks tags in the playlist generator.