Skip to content

A simple-as-possible FoundryVTT module to muffle sounds that are behind a wall for a player.

License

Notifications You must be signed in to change notification settings

SebaSOFT/walls-have-ears

Repository files navigation

Foundry VTT - Walls have ears

GitHub license GitHub release Forge Installs Foundry HUB Endorsements Maximum Foundry VTT version

"A simple-as-possible module to muffle sounds that are behind a wall for a player or token."

Installation

In the setup screen, use the URL https://github.com/SebaSOFT/walls-have-ears/releases/latest/download/module.json to install the module.

A note in v12 plans

Foundry VTT has partially included some of the functionality of WHE into core, but the current implementation is not easy to setup and is already prone to incorrectness. So my idea for v12 is:

  • Move the project to parcel/TS
  • Implement if possible the types on the new framework
  • Update Yarn and automated workflows (autodeploy?)
  • Add a global or scene setting to "handle muffling intensity by wall estimation"
  • Prevent showing the Muffling intensity slider
  • Prevent showing the Muffling selector ( or auto assign it)
  • Change the intensity slider just for a given user and not be a server setting
  • Handle new types of walls and the proximity/reverse proximity cases
  • Create entire new tutorials and test bed

Release Notes

See CHANGELOG

Features

  • Detects sound that are in range but through a wall, and muffles them
  • Ignores open doors so sound should not be muffled if listened throughan open door

How it works

  • Enable Token Vision on the scene (this is a MUST)
  • DO NOT Disable "Constrained by Walls" on the Sound
  • EITHER Set sound occlussion on Walls to limited or none as needed
  • It works with sound easing (volume changing)
  • It will detect walls and muffle the sound (see table below)
  • Windows are less likely to muffle (see table below)
  • Terrain walls don't contribute to muffling (see table below)
  • Ethereal Walls don't contribute to muffling (see table below)

See:

Test cases for Muffling logic

Demo videos:

Nightclub demo

Nightclub demo

Test suite demo

Test suite demo

TO DO

  • Acoustic Ray Tracing: Estimate L shaped rooms and track sound bouncing, so it doesn't get muffled (possible echo/delay effect)
  • See v12 improvements above

Known Issues

  • If the first action you do when accessing the site is selecting a token, it won't be muffled, just select another token or move it one time.

Contributing

We're always happy for community contributions.

Licence

This module has been released under the MIT licence, meaning you can do pretty much anything you like with it, so long as the original copyright remains in place.

You can use it in commercial products.

If the licence terminology in the licence.txt is confusing, check out this: https://www.tldrlegal.com/l/mit