/foundryvtt-forien-unidentified-items

This module aims to provides system agnostic solution to handle unidentified items and their identification for games via Foundry VTT.

Primary LanguageJavaScript

FoundryVTT - Forien's Unidentified Items

GitHub release (latest SemVer) GitHub Releases GitHub All Releases
[Compatibility]: FoundryVTT 0.6.0+
[Systems]: any
[Languages]: English, Korean, Polish, Portuguese (Brazil)

This module aims to provides system agnostic solution to handle unidentified items and their identification for games via Foundry Virtual Tabletop.

Installation

  1. Install Forien's Unidentified Items using manifest URL: https://raw.githubusercontent.com/Forien/foundryvtt-forien-unidentified-items/master/module.json
  2. While loaded in World, enable Forien's Unidentified Items module.

Usage

Please refer to Wiki for full information on Usage

Right click on items in sidebar, or use buttons on Item Sheet's header to Mystify an item. It will create new apparently blank item.

Mystified item can be fully edited and works just as a normal item in that system. However, GM can at any point peek at what the original item is (currently it's not possible to edit original data).

GM can also click on "Identify" button, which transforms entire Item into original, using embedded data.
Data used during identification is decided upon at the time of mystification.

Screenshots

Mystify As - TransmogrifyAdvanced mystification
Mystified Acid VialContext MenuContext Menu

System Integration

dnd5e pf2e wfrp4e swade
Settings
Logic

One of main principles of this module is being System Agnostic. There is however, way of integrating systems.

Basic settings initialization (like setting default persisting properties for dnd5e) I will allow to be built-in this module. These can, however, be defined from the System's side.

What about logic? Skill Checks for Identification?

According to this module's Primary Principle, there will never be any system-specific logic in module. Feel free to integrate logic into your System or your Module, using API and Hooks

How to integrate?

If you are System or Module developer, please read the Developers Wiki for API and Hooks references.

Also, do not hesitate to contact me with questions and for assistance.

Future plans

  • none currently

You can always check current and up-to-date planned and requested features here

If you have any suggestion or idea on new contents, hit me up on Discord!

Translations

If you are interested in translating my module, simply make a new Pull Request with your changes, or contact me on Discord.

Contact

If you wish to contact me for any reason, reach me out on Discord using my tag: Forien#2130

Acknowledgments

  • Icons were created by transforming assets made by Lorc and Willdabeast from game-icons.net
  • Thanks to unsoluble for the idea for this Module!
  • Thanks to KLO for providing Korean translation
  • Thanks to rinnocenti for providing Portuguese (Brazil) translation
  • Thanks to freyrrabbit for help with defining default properties for PF2e system
  • Thanks to SalieriC for help with defining default properties for Swade system

Support

If you wish to support module development, please consider becoming Patron or donating through Paypal. Thanks!

License

Forien's Unidentified Items is a module for Foundry VTT by Forien and is licensed under a Creative Commons Attribution 4.0 International License.

This work is licensed under Foundry Virtual Tabletop EULA - Limited License Agreement for module development from May 29, 2020.