Skip to content

Latest commit

 

History

History
78 lines (59 loc) · 5.88 KB

README.md

File metadata and controls

78 lines (59 loc) · 5.88 KB

Logo

Making better looking doors since 2020

Code Style Badge MIT License Badge Release Version Badge Latest Release Downloads Badge Total Downloads Badge Forge Installs

Key Features

You can change the default door icons used to show closed, open and locked doors and set an icon to represent secret doors. These are set through the module settings panel and will be applied to all doors that DO NOT have their own custom icons.
DD_default_doors
This may be useful to create door control icons more appropriate to a given setting or genre of game.

Each door can also be assigned icons specific to that door only. These are assigned in the the wall control panel. DD_individual_doors
This allows a GM to either give a particular door unique icons (perhaps a portal or teleporter would have different icons than a normal door), or to change the feel of a particular scene (a dungeon may use different icons than an inn).

Installation

Either paste the manifest link below directly into the Module Installer in your Foundry server 'Configuration and Setup' tab, or search for the module listed in the same Module Installer.

Manifest

https://raw.githubusercontent.com/Exitalterego/designerdoors/main/module.json

Compatability

This module uses a re-write of the _getTexture method from the Door Controller class. This method is, as far as I am aware, only utilised to choose which image to use for your door controls.

As such, there should be no compatability issues unless another module directly tries to change door icons.

If I become aware of any such modules they will be listed here.

Feedback

I am welcome to constructive feedback, improvement suggestions, additional feature requests and bug reports.

For all of these, please open an Issue here on Github. You can also find me on Discord as Exitalterego#8315, however I do not guarentee a swift response through there. Github issues are preferred.

If you can code your own features or bug fixes, you may also do a pull request. Full credit will be give for your contributions.

Abandonment

Abandoned modules are a (potential) problem for Foundry, because users and/or other modules might rely on abandoned modules, which might break in future Foundry updates.
I consider this module abandoned if all of the below cases apply:

  • This module/github page has not received any updates in at least 3 months
  • I have not posted anything on "the Foundry" and "the League of Extraordinary Foundry VTT Developers" discord servers in at least 2 months
  • I have not responded to emails or PMs on Discord in at least 1 month
  • I have not announced a temporary break from development, unless the announced end date of this break has been passed by at least 2 months

If the above cases apply (as judged by the "League of Extraordinary Foundry VTT Developers" admins), I give permission to the "League of Extraordinary Foundry VTT Developers" admins to assign one or more developers to take over this module, including requesting the Foundry team to reassign the module to the new developer(s).
I require the "League of Extraordinary Foundry VTT Developers" admins to send me an email 2 weeks before the reassignment takes place, to give me one last chance to prevent the reassignment. I require to be credited for my work in all future releases.

Licence

Designer Doors is licensed under the MIT License.

This work is also licensed under the FOUNDRY VIRTUAL TABLETOP END USER LICENSE AGREEMENT - May 29, 2020.

Credits

  • shim.js - provided by Ruipin and their libWrapper module.
  • Logo Font - Couture by Chase Babb. Licensed under terms as an open-source project (email confirmation available upon request).
  • Icons - game-icons.net licensed under CC-BY-3.0.
  • Module Name - Inspiration kindly provided by Norc#5108 on the FoundryVTT Discord server.
  • Many thanks to Calego#0914 for pointing me in the right direction on several occasions and to LukeAbby#0001 for acting as a rubber duck and pointing out that one errant async.
  • The League of Extraordinary Foundry VTT Developers Discord server for just generally being all-round awesome.