SebaSOFT / walls-have-ears

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

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Foundry VTT - Walls have ears

GitHub license GitHub release Forge Installs Foundry HUB Endorsements Minimum 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.

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

  • Estimate L shaped rooms and track sound bouncing, so it doesn't get muffled (possible echo/delay effect)
  • Have three or more muffling densities and assign them to the wall they are listening through
  • Have a setting for disable sound muffling, useful for muffled sounds or ambient global sounds you may want to eclude

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

About

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

License:MIT License


Languages

Language:JavaScript 100.0%