README file from
GithubKenku FM Soundboards Plugin
Control playback of sounds from Kenku FM soundboards directly from Obsidian.
Features
🔗 Configure Kenku FM's remote play URL
▶️ Play sounds from any soundboard in your Kenku FM library using Obsidian commands
⏹️ Stop playback for any active sound track
🔄 Force-reload soundboard data from Kenku FM if the plugin becomes out of sync
How to use
Changing Kenku FM's remote play URL
- Open the plugin settings.
- In the Base URL field, enter the new address and port.
- By default, the plugin uses Kenku FM's default
http://127.0.0.1:3333
- By default, the plugin uses Kenku FM's default
Play a sound
- Open the Command Palette.
- Choose Kenku FM Soundboards: Play [Sound name] track from [Soundboard name] soundboard.
Stop a sound
- Open the Command Palette.
- Choose Kenku FM Soundboards: Stop playing [Sound name] track from [Soundboard name] soundboard.
Reload soundboard data
- Open the Command Palette.
- Choose Kenku FM Soundboards: Reload sounds.
Note: Reloading sounds is optional but useful if the plugin state becomes out of sync with Kenku FM. For example, if you play or stop sounds directly in the Kenku FM app instead of through the plugin.
Background and scope
This plugin was originally created for my D&D group while I'm DMing a Curse of Strahd campaign, so it focuses on a small set of features we actually use at the virtual table. I plan to keep it maintained (especially for future Obsidian updates) and fix bugs as they come up, but I don't expect to add new features unless they're something I personally need for the campaign.
Crafted by a human without the use of generative AI.