This module adds options for players to organize their spellbook by which class the spell is for. Useful for multiclass characters or characters with the magic initiate feat.
To get the filter to work, you will need to populate the data in each spell.
This module is specific to the dnd5e system and is not designed to work with other systems.
At a minimum, the files and folder structure of this repository should exist in your instances "modules" folder. Most commonly this is accomplished by using Foundry's built-in module manager.
All settings for this module are found in Foundry's settings menu under the module settings tab.
Currently all of the settings that are available are client-side settings. This means that what you change here will not have an effect on any other computer or player.
This module relies on populating data that doesn't seem to exist by default: "Is this spell a {class} spell for you?" So the first step is going to be going through each spell on your sheet and selecting the spell's class in the itemsheet's details tab.
Note: Your selection does not change which ability modifier your spell uses. That is configured elsewhere in the sheet.
Afterwards, if the proper setting is enabled, you will see a dropdown menu at the top of the spellbook with the rest of the filters. Selecting an one of the classes will hide all of the spells that don't match your selection.
Some players find it helpful to differentiate spells by class even when the list is not filtered. To help with that this module provides the option to 'cover' the spell's icon in the spellbook with the icon of their source class.
To enable this behavior enable it in the module's settings. This setting is disabled by default.
Note: This feature does not change any data or other behaviors. The spell's icon will still be what is displayed in chat and in other sections of the sheet.