Skip to content

Latest commit

 

History

History
175 lines (106 loc) · 5.11 KB

README.md

File metadata and controls

175 lines (106 loc) · 5.11 KB

FoundryVTT - Magic Items

This module for Foundry VTT and specific for the DnD5e system, adds the ability to create magical items with spells or feats that belong to the item itself, such as staffs or magic wands, which will be automatically inherited from the character who owns the item.

An official continuation of Magic Items.

If you have an issue that requires quick contact, I've created a Discord community.

ko-fi

Translation

You can now publicly help with translation on Weblate.

Translation status

Installation

You can download the module from Foundry package listing.

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://github.com/PwQt/magic-items-2/releases/latest/download/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

Usage Instructions

  1. Once activated, a new tab named 'Magic Item' will be available for each items of type 'weapon', 'equipment' or 'consumable'.
  2. In this tab, you can drag spells from a compendium and configure its consumption which will be subtracted from the total number of charges each time the spell is used.
  3. It is also possible to configure the max number of charges, if they can be can be recharged and when, and if the item will be destroyed when the charges reach 0.

example0

Using combinations of these parameters is possible to create, for example:

  • A legendary staff equipped with great thaumaturgical spells

example1

  • A globe with a perennial light spell.

example2

  • A scroll with a powerful necromantic spell that dissolves once pronounced.

example3

In addition to spells, it is also possible to assign feats to the items, or combinations of both:

example5

When a character is equipped with one or more magical objects, within his sheet in the spellbook/features section, a set of inherited spells/feats divided by item will be displayed after his owned items:

example4

example6

From here you can cast spells or use feats provided by the items and monitor the consumption/recharges.

Api

All informations about the api and the sheet integration can be found here API

Compatibility

Name Compatibility Additional information
Legacy DnD 5e sheet ✔️
DND5e 3.0 Sheet ✔️ released in 1.6.0
Compact DnDBeyond-like 5e Character Sheet ⁉️ Works, but doesn't show in Actions tab.
Tidy 5e Sheet Rewrite ✔️

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

lint and lint:fix

lint launch the eslint process based on the configuration here

npm run-script lint

lint:fix launch the eslint process with the fix argument

npm run-script lint:fix

Issues

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

License

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

Credit

This is a maintained version of Magic Items module for Foundry V11 and D&D 3.0, originally created by Simone.

Magic Items is a module for Foundry VTT by Simone and is licensed under a Creative Commons Attribution 4.0 International License.