Skip to content

SebaSOFT/walls-have-ears

Repository files navigation

WALLS HAVE EARS

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

Version: 3.13.1

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

walls-have-ears is a simple-as-possible module to muffle sounds that are behind a wall for a player in FoundryVTT. It is built and bundled using Parcel, offering a simple and efficient development experience.

Installation

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

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 through an 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

Nightclub demo

Nightclub demo

Test suite demo

Test suite demo

Development

For details on the project structure, development process, and dependencies, please see the GEMINI.md file.

TO DO

  • Estimate L shaped rooms and track sound bouncing, so it doesn't get muffled (possible echo/delay effect)

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.

(Guidelines for contributing to the project will go here.)

License

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

Author

SebaSOFT

Project URL: https://github.com/SebaSOFT/walls-have-ears

Foundry VTT: https://foundryvtt.com/packages/walls-have-ears

Bug Reports: https://github.com/SebaSOFT/walls-have-ears/issues

Discord: https://discord.gg/Sebasoft (SebaSOFT#9414)

Patreon: https://www.patreon.com/SebaSOFT

Credits

  • Idea and original implementation by @KayelGee, from the FoundryVTT Discord
  • Spanish translation by @lozalojo
  • German translation by @Fallayn
  • French translation by @JDR-Ninja
  • Japanese translation by @Brother Sharp
  • Portuguese translation by @castanhocorreia

Buy me a coffee

ko-fi

Release Notes

See CHANGELOG