Skip to content

A simple auto note pin app for FoundryVTT

License

Notifications You must be signed in to change notification settings

MrPrimate/NoteLicker

Repository files navigation

Note Licker

Latest Release Download Count Forge Installs Foundry Core Compatible Version

Simple enhanced Scene Notes/Pins for Foundry to add autonumbering.

About

This module currently offers three improvements to journal notes/pins.

  • Create icons for scenes on the fly based on the journal name, e.g. 1a. Kobold Nursery would generate a nice icon with 1a in a circle. These are similar to the icons that are created by DDB Importer when importing an adventure.
  • Add the ability to remove the icon border. This is similar to the functionality in backgroundless-pins. If Backgroundless Pins is active, Note Licker will not enable this functionality, and works in v11. If Pin Cushion is installed, Note Licker will let this module handle background removal.
  • Add the ability to jump to an anchor link. This is similar to the functionality in JAL and DDB Importer. This supports the flags used by DDB Importer/Adventure Muncher as well as JAL. If JAL is active, Note Licker will not enable the anchor linking functionality. This has a different approach and some slight functional differences to JAL, to meet the more detailed requirements of DDB Importer, but may be useful for other systems.

Demo GIFS

Auto icon effects:

gif-preview-auto-icon

Jump to Anchor:

gif-preview-jump-to-anchor

Remove icon borders:

gif-preview

Known Issues

  • Journal header anchor linking won't work with Monks Enhanced Journals.
  • If JAL or DDB Importer are active the anchor injection will not be enabled.
  • If Backgroundless Pins or Pin Cushion is active, the border removal will not be enabled.

Bugs and Issues

Please open bugs and issues on github, or via the Discord channel #bugs.

Scripting

You can create icons using the API as follows:

let path = await game.modules.get("notelicker")?.api.generateIcon("1a. Terror of fun");

This will return the path to the new icon, which you can use to update a note or other.