search

WBHarry / introduce-me

MIT License
3 stars 3 forks source link

readme

Introduce Me

Latest Release Download Count

Forge Installs

Foundry Core Compatible Version

Latest Version

Foundry Hub Endorsements

GitHub all releases

Translation status

if you feel generous you can to buy me a coffee alt-text

This module is a fork from Introduce Me, created because the old developer seem inactive for some time.

A Foundry VTT module that lets you introduce NPCs or other actors to all players with some flair.

The fanfare will display the actor's name, and optionally a short flavor text that you can add to actors. After the display, the actor will be set to display their name whenever someone hovers their token, since they have now been introduced!

Usage

Actors can be introduced either via a button placed on the Token's HUD menu, accessed via right clicking it, or by using the macros included in the Introduce Me compendium. There is a module setting for disabling the HUD menu button if you're using the macros and don't want it taking space.

Flavor texts look best if they're not excessively long. The 'Private Preview' function can be used to check how it will look with the players none the wiser.

Installation

It's always easiest to install modules from the in game add-on browser.

To install this module manually:

  1. Inside the Foundry "Configuration and Setup" screen, click "Add-on Modules"
  2. Click "Install Module"
  3. In the "Manifest URL" field, paste the following url: https://raw.githubusercontent.com/p4535992/foundryvtt-introduce-me/master/src/module.json
  4. Click 'Install' and wait for installation to complete
  5. Don't forget to enable the module in game using the "Manage Module" button

socketlib

This module uses the socketlib library for wrapping core methods. It is a hard dependency and it is recommended for the best experience and compatibility with other modules.

Known issue

API

The wiki for the API is here

Build

Install all packages

npm install

dev

dev will let you develop you own code with hot reloading on the browser

npm run dev

npm build scripts

build

build will build and set up a symlink between dist and your dataPath.

npm run build

build-watch

build-watch will build and watch for changes, rebuilding automatically.

npm run build-watch

prettier-format

prettier-format launch the prettier plugin based on the configuration here

npm run-script prettier-format

Changelog

Issues

Any issues, bugs, or feature requests are always welcome to be reported directly to the Issue Tracker, or using the Bug Reporter Module.

License

This package is under an MIT license and the Foundry Virtual Tabletop Limited License Agreement for module development.

Credit