Skip to content

Add Native Support for Listener Sounds via LibSharedMedia#28

Closed
Bitwise1057 wants to merge 3 commits intoRaenore:mainfrom
Bitwise1057:main
Closed

Add Native Support for Listener Sounds via LibSharedMedia#28
Bitwise1057 wants to merge 3 commits intoRaenore:mainfrom
Bitwise1057:main

Conversation

@Bitwise1057
Copy link
Copy Markdown
Contributor

Description

This PR adds support for two additional notification sounds for Eavesdropper and registers them through LibSharedMedia, allowing them to appear alongside existing sound options in the addon configuration in the event that a user wishes to use them without having Listener enabled or installed.

Changes

  • Added a new sound directory under Resources.
  • Added two custom sound files:
    • Listener Beep.ogg
    • Listener Poke.ogg
  • Updated Core/Config.lua to register the custom sounds using LibSharedMedia.

Implementation Details

A custom sound path and table of sound names were introduced with potential for more in the future as desired:

local CUSTOM_SOUND_PATH = "Interface\\AddOns\\Eavesdropper\\Resources\\Sound\\"
local CUSTOM_SOUNDS = {
	"Listener Beep",
	"Listener Poke",
}

During SetupSounds():

  1. Existing default sounds are registered as before.
  2. The CUSTOM_SOUNDS table is iterated and each sound is registered with LibSharedMedia.
  3. The .ogg extension is appended to build the full file path.
  4. The SharedMedia sound list is enumerated and used to populate Config.soundList, ensuring the new sounds appear in the configuration dropdown.

Example registration:

for _, name in ipairs(CUSTOM_SOUNDS) do
    SharedMedia:Register("sound", name, CUSTOM_SOUND_PATH .. name .. ".ogg")
end

Result

The following sounds are now available in the Eavesdropper sound configuration:

  • Listener Beep
  • Listener Poke

These sounds integrate with the existing LibSharedMedia system and appear alongside other registered sounds.

Added Listener Beep and Poke effect to sound options.
Added additional comments for clarification and author per license requirements.
@Raenore
Copy link
Copy Markdown
Owner

Raenore commented Mar 14, 2026

Hey there!

I appreciate this PR, but unfortunately I won't be able to merge these in for now.

Prior addition/support for Listener sounds was requested through bsky a few weeks ago:
https://bsky.app/profile/dawnsong.me/post/3mfo6cldti22x

Given there's no clear indication where these sound files came from, there's a bit of a licensing situation.
Which in turn makes the legality of whether or not I can just incorporate (and distribute) it within Eavesdropper a bit unclear.

Until that is figured out, the best way is a personal/local addon that adds the listener sounds through LibSharedMedia.

Below is the bsky thread itself, in case you can't access it for some reason.
2026-03-14_14-59-53-012

@Bitwise1057
Copy link
Copy Markdown
Contributor Author

Would the sound files not be covered under the MIT license as they do not appear to be excluded anywhere in Listener's original repo or is it just the general origin being unknown?

@Raenore
Copy link
Copy Markdown
Owner

Raenore commented Mar 14, 2026

Would the sound files not be covered under the MIT license as they do not appear to be excluded anywhere in Listener's original repo or is it just the general origin being unknown?

You've hit the nail on the head with the latter, its unknown origins are the main issue.

There is always the possibility that the original author found them somewhere instead of making it themselves.

Unfortunately the project didn't always exist on GitHub, so a proper trace is hard to run regarding these sound files.

I'll talk this over with a few colleagues that also handle open source projects for WoW and see where what the general consensus is regarding unknown origins and legality.

I can't promise anything though, except that I think it would be a boon to have the sound files so people can keep using what they're used to/familiar with.

@Raenore Raenore added the enhancement A new feature or improvement request label Mar 15, 2026
@Raenore
Copy link
Copy Markdown
Owner

Raenore commented Mar 27, 2026

Hey there!

Sorry it took me some time to get back to this.

As I’m preparing the 0.4.0 update, I had a chat with some other addon authors regarding these files and their origins.

Given the MIT license attached to the Listener project, there’s a lot of freedom in what can be done with these files. Since many Eavesdropper users are likely Listener users as well, including these familiar sounds is definitely worthwhile.

The general consensus is that, given the license and the intent Eavesdropper has for these sound files, it should be OK to add them. If the original author ever contacts the project, we can always remove them if it comes to that.

With that said, I’ll be implementing these two sounds for 0.4.0, but using a slightly different approach that aligns better with my current code. I want these to be treated as "local sounds" rather than "custom sounds," so users don't get the impression they can simply drag and drop files into the folder. Unless a user is tech-savvy, it’ll remain a curated list for now, as I’m ultimately responsible for the distribution. The Listener sounds will live in their own folder within Sounds and will have the proper LICENSE-LISTENER.TXT attached as per MIT rules.

I’ll make sure to properly credit you for the initial implementation, @Bitwise1057, as this PR (along with the Bluesky post) really got the ball rolling and led us here. I’d also like to thank you for taking the time to work this out and bringing it to my attention.

The PR will be closed as it is superseded by #61.

@Raenore Raenore closed this Mar 27, 2026
Raenore added a commit that referenced this pull request Mar 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement A new feature or improvement request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants