Installation and Settings

Requirements

Foundry VTT: 14 or newer
System: D&D 5e
Required: 3DS:ATLAS
Optional: tidy5e-sheet, chris-premades, peddler, calendaria. See Module Integrations.

Installation

Foundry module browser

On the Setup screen, open Add-on Modules and click Install Module.
Search for Spell Book and click Install.
Enable the module in your world’s Manage Modules menu.

Manifest URL

Open Add-on Modules and click Install Module.

Paste the Manifest URL and click Install:

https://github.com/Sayshal/spell-book/releases/latest/download/module.json

Enable the module in your world’s Manage Modules menu.

First-time setup

Review the settings under Game Settings -> Configure Settings -> Spell Book.
Assign a spell list to each spellcasting class in Spell Book Settings. A class with no assigned list shows no spells. See Per-actor overrides.

Settings reference

World settings are set by the GM and apply to everyone. Client settings are stored in each user’s browser. User settings follow each user across devices.

Core rules

Setting	Scope	Default	Description
Default Spellcasting Rules	World	Legacy Rules	Default rule set for every character: Legacy Rules or Modern Rules. Overridable per actor.
Notify GM on Spell Changes	World	On	Whispers GMs a card listing the cantrips and spells removed and added when a Spell Book save changes them. A class over its cantrip or spell limit adds a warning. Overridable per actor.

Spell preparation and learning

Setting	Scope	Default	Description
Consume Scrolls When Learning	World	On	Spell scrolls are consumed when a spell is learned from them.
Deduct Spell Learning Costs	World	Off	Deducts gold when a character learns a spell. The cost per spell level is set per class. Also adds the Affordable Only filter to the Spell Book.
Charge Cost for Scroll Copying	World	Off	Charges the normal learning cost when copying from a scroll. Has no effect unless Deduct Spell Learning Costs is enabled.
GM Approval for Spell Copying	World	Off	Player spell copies wait for GM approval. See Spell copy approval.
Log Spell Copying to Downtime Note	World	Off	Appends each copied spell and its copy time to a daily downtime note in the calendar. Requires Calendaria.
Cantrip Scale Value Keys	World	`cantrips-known, cantrips`	Comma-separated scale value keys checked for a class’s cantrip limit. The first key that resolves wins. Add keys for homebrew classes.
Auto-Delete Unprepared Spells	User	Off	After a save, removes unprepared spells that use prepared casting from the character sheet.
Disable Long Rest Swap Prompt	Client	Off	Replaces the swap dialog shown after a long rest with a notification. Swaps remain available in the Spell Book.

UI and display

Setting	Scope	Default	Description
Maximum Note Length	World	240	Maximum characters in a spell note. Range 10 to 1000.
Inject Notes into Spell Descriptions	Client	Off	Inserts the user’s spell notes into spell descriptions on the character sheet: Before Description or After Description.
Party Mode Token Limit	Client	4	Maximum party member tokens shown per spell in Party Mode. Range 2 to 8.

Compatibility

Setting	Scope	Default	Description
Cauldron of Plentiful Resources Compatibility	World	Off	Runs Cauldron of Plentiful Resources automation setup after spells are added to a character sheet. Listed only while chris-premades is active.

Spell Details Customization

The Configure Display button opens the Spell Details Customization menu. Players and GMs can open it. Its toggles are client settings that control which icons and metadata appear on spell rows. GMs also see toggles for the Spell List Manager. See Details Customization.

Theming, update notices, the troubleshooter, and logging level are provided by 3DS:ATLAS.

Per-actor overrides

The Spell Book Settings dialog overrides world defaults for one actor and each of its classes. Open it from the gear icon in the actor’s Spell Book sidebar. Only GMs see the gear.

The dialog holds the actor’s Rule Set Override and Notify on Spell Changes. For each class it holds the Class Spell List and Subclass Spell List, swap timing, ritual casting, preparation bonuses, and wizard learning options. See Class Rules.

Troubleshooting

If the module does not work, confirm 3DS:ATLAS is enabled and Foundry and the system meet the requirements. Then generate a diagnostic report with the 3DS:ATLAS troubleshooter and share it on Discord or the issue tracker.