Tome Spell
- Configuration
- Example

Tome Spell

Command spell. The tome spell allows you to create a spell tome that teaches a player a specific spell when they read it.

Usage: While holding a written book, type /cast tome <spellname> [uses]

It does not matter what the title or contents of the written book are, though it would obviously be helpful if they indicated what the book does.

Configuration

Option	Description	Default
consume-book	Whether to remove the book from the player's inventory when all the tome uses are gone.	false
allow-overwrite	Whether a tome can be overwritten as a different tome.	false
default-uses	The number of uses a tome has if an amount isn't specified. A value of -1 means infinite uses.	-1
max-uses	The maximum number of uses allowed on a tome.	5
require-teach-perm	Whether the casting player (the one making the tome) needs the teach permission for the spell being placed in the tome.	true
str-usage	The message that appears when using the spell incorrectly.	Usage: While holding a book, /cast tome <spell> [uses]
str-no-spell	The message that appears when trying to use an invalid spell.	You do not know a spell with that name.
str-cant-teach	The message that appears if the caster does not have the permission for the spell they're trying to use, and the require-teach-perm option is set to true.	You cannot create a tome with that spell.
str-no-book	The message that appears if the caster is not holding a written book.	You must be holding a book.
str-already-has-spell	The message that appears if the book already has a spell assigned.	That book already contains a spell.
str-already-known	The message that appears if a player tries to use a tome but already has the spell it contains.	You already know the %s spell.
str-cant-learn	The message that appears if a player tries to use a tome but does not have the learn permission for the spell it contains.	You cannot learn the spell in this tome.
str-learned	The message that appears if a player successfully learns a spell from a tome.	You have learned the %s spell.

Example

    tome:
        spell-class: ".command.TomeSpell"
        name: tome
        spell-icon: book
        enabled: false
        description: Create a tome that teaches a spell.
        consume-book: true
        allow-overwrite: false
        max-uses: -1
        default-uses: -1
        require-teach-perm: true
        str-usage: "Usage: While holding a book, /cast tome <spell>"
        str-no-spell: You do not know a spell with that name.
        str-cant-teach: You cannot create a tome with that spell.
        str-no-book: You must be holding a book.
        str-already-has-spell: That book already contains a spell.
        str-already-known: You already know the %s spell.
        str-cant-learn: You cannot learn the spell in this tome.
        str-learned: You have learned the %s spell.
        str-cast-self: You have created a spell tome.