General Configuration

Configuration:

This section details the general.yml file and all the options within it.

Option	Description	Type	Default
debug	Turns on the debug feature. This will print out a lot of extra information in the console when using the plugin.	Boolean	false
debug-null	Defines if MagicSpells should debug null throwables.	Boolean	true
debug-number-format	Defines if MagicSpells should debug number formatting throwables.	Boolean	true
debug-level	This determines how much debug information should be printed. This is the scale of 1 to 4, with 1 being only the most basic debug info, and 4 being absolutely everything.	Integer	3
tab-complete-internal-names	Defines if commands should tab-complete internal names or not.	Boolean	false
terminate-effectlib-instances	Whether it should terminate all effectlib effect instances when the effectlib-instance-limit is reached, otherwise it just won't play further effectlib effects.	Boolean	true
enable-error-logging	This will turn on or off the error logging feature. While on, any errors that occur will generate a file in an errors folder. You may want to turn this off if you run into a spell generating errors at incredibly fast speeds, as it can cause a massive amount of error files to pile up if you don't take care of the issue fast.	Boolean	true
enable-profiling	Defines if MagicSpells should run the profiler tasks.	Boolean	false
error-log-limit	Defaults to -1. If greater than 0, limits the total size of the errors folder to the specified file limit	Integer	-1
text-color	The default color code for MagicSpells messages. Follows Minecraft Color Codes but without the § symbol prefix.	String	3
broadcast-range	The range in blocks that certain string messages in spells should broadcast, such as str-cast-others.	Integer	20
effectlib-instance-limit	It's the limit for effectlib effect instances.	Integer	20000
ops-have-all-spells	Whether to give opped players all the spells in the game.	Boolean	true
default-all-perms-false	Whether to negate all permissions by default so that you can set which ones you'd like to have given to all players yourself.	Boolean	false
ignore-grant-perms	Defines if MagicSpells should ignore grant permissions while checking if a player's spellbook has a spell.	Boolean	false
ignore-grant-perms-fake-value	Defines if MagicSpells should ignore fake values of grant permissions while checking if a player's spellbook has a spell.	Boolean	true
ignore-cast-perms	Defines if a player can cast a spell.	Boolean	false
enable-tempgrant-perms	Defines if tempgrant permission should be enabled or not.	Boolean	true
separate-player-spells-per-world	Whether to create separate spellbooks for a player per world. This would allow you to have different kinds of spell sets per world.	Boolean	false
allow-cycle-to-no-spell	The option to let players cycle to "no spell" on any bound item.	Boolean	false
reverse-bow-cycle-buttons	Defines, if cycling spells while holding a bow, should function with reverse buttons - left to cycle, right to cast.	Boolean	true
cast-bound-bow-spells-from-offhand	Disables casting triggered by shooting a bow in the offhand.	Boolean	false
bow-cycle-spells-sneaking	Defines if bows should cycle spells while the player is sneaking instead.	Boolean	true
always-show-message-on-cycle	The option to always show str-spell-change when cycling through spells.	Boolean	false
only-cycle-to-castable-spells	This option determines whether the player will be able to scroll through all spells bound to that item, or only the ones that they know.	Boolean	true
spell-icon-slot	Defines the slot where to display the spell icon on.	Integer	-1
allow-cast-with-fist	This allows players to bind things to their fist.	Boolean	false
cast-with-left-click	This option, if true, will force default casting to be done through left-clicking.	Boolean	true
cast-with-right-click	This option, if true, will force default casting to be done through right-clicking.	Boolean	false
cycle-spells-with-offhand-action	Defines if MagicSpells should cycle spells with the offhand action instead.	Boolean	false
ignore-default-bindings	Whether to ignore all set cast-item options in spells.	Boolean	false
check-world-pvp-flag	Whether to check if PVP is enabled in a world before harming another player.	Boolean	true
check-scoreboard-teams	Defines if MagicSpells should check for scoreboard teams friendly fire before while looking for a target.	Boolean	false
show-str-cost-on-missing-reagents	Defines if MagicSpells should send info of missing reagents.	Boolean	true
los-ray-size	Since 4.0 Beta 14. Determines the size of the ray used for checking line of sight to entities when retrieving an entity target.	Double	0.2
los-ignore-passable-blocks	Since 4.0 Beta 14. When true, passable blocks (blocks that do not have any colliding parts that stop movement) are ignored for entity/location targeting. For example, air and tall grass are passable.	Boolean	true
los-fluid-collision-mode	Since 4.0 Beta 14. Determines whether or not fluids are collided with when retrieving entity/location targets.	Fluid Collision Mode	never
los-transparent-blocks	A list of blocks that count as "transparent" in line of sight dependent spells, such as targeted spells. It also determines whether beam and particle projectiles (among others) will go through the blocks listed.	String List	Before 4.0 Beta 14: [air, cave_air, void_air, powered_rail, detector_rail, grass, fern, dead_bush, dandelion, poppy, brown_mushroom, red_mushroom, torch, fire, redstone_wire, ladder, rail, lever, redstone_torch, repeater, vine, lily_pad] Since 4.0 Beta 14: [air, cave_air, void_air]
global-radius	Global radius limit for all spells that support it.	Integer	500
global-cooldown	A length of time, determined in milliseconds, to force players to wait between casting any and all spells. A value of 500 equals half a second.	Integer	500
cast-on-animate	Defines if MagicSpells cast items should activate on arm animation instead of real clicks.	Boolean	false
use-exp-bar-as-cast-time-bar	Whether to use the exp bar as a cast time bar. When waiting for a cast time to go through, the bar will slowly move from left to right as if being filled with exp. It will revert to its normal state after the spell has been cast.	Boolean	true
cooldowns-persist-through-reload	Whether to force cooldowns to remain as they were through a reload of the plugin.	Boolean	true
entity-names	Documented below.
sound-on-cooldown	Defines the sound to be played when a spell fails to be casted because of active cooldown.	String
sound-missing-reagents	Defines the sound to be played when a spell fails to be casted because of missing reagents.	String
str-unknown-spell	The string message sent if a player attempts to cast a spell they don't know.	Rich Text	"You do not know a spell with that name."
str-spell-change	The string message sent when a player switches between spells on a bound item. Additional placeholder %s can be used to return the spell's name.	Rich Text	"You are now using the %s spell."
str-spell-change-empty	The string message sent when the player switches to no spell at all. Requires allow-cycle-to-no-spell to be set to true.	Rich Text	"You are no longer using a spell."
str-on-cooldown	Additional placeholders: - %s: Spell's name. - %c: Spell's rounded cooldown.	Rich Text	"That spell is on cooldown (%c seconds remaining)."
str-missing-reagents	The string message for when a player does not have the right reagents available to cast a spell.	Rich Text	"You do not have the required reagents for that spell."
str-cant-cast	The string message sent if a player is unable to cast a spell for some reason.	Rich Text	"You can't cast that spell right now."
str-cant-bind	The string message sent if a player is unable to bind a spell to the held item.	Rich Text	"You cannot bind that spell to that item."
str-wrong-world	The string message for when a player attempts to cast a spell that is not permitted in that world by the spell's config.	Rich Text	"You cannot cast that spell here."
str-xp-auto-learned	The string message sent when the player auto learned a spell due to MagicXP. Additional placeholder %s can be used to return the spell's name.	Rich Text	"You have learned the %s spell!"
console-name	The name to use for the console in any string arguments.	String	"Admin"
allow-anticheat-integrations	If enabled, will allow compatible anti-cheat plugins to hook into magicspells for better usage.	Boolean	false
buff-check-interval	Defines the interval of the buff spell monitor - expiration checker.	Integer	100
ops-ignore-reagents	Whether to let opped players ignore all costs.	Boolean	true
ops-ignore-cooldowns	Whether to let opped players ignore all cooldowns.	Boolean	true
ops-ignore-cast-times	Whether to let opped players ignore all cast times.	Boolean	true
hide-magic-item-tooltips	Whether to hide the tooltips of magic items.	Boolean	false
enable-magic-xp	Defines if the MagicXP system should be enabled.	Boolean	false
enable-dance-casting	Defines if dance casting should be enabled.	Boolean	true
enable-logging	Defines if the MagicSpells logger should be enabled - the logger writes to log files in root.	Boolean	false

Cast Item Configuration:

Option	Description	Type	Default
ignore-cast-item-enchants	If true, cast items will be used regardless of what enchantments are on them. If cast-item is a stick, all sticks will work, even if they have enchantments on them.	Boolean	true
ignore-cast-item-names	Whether to ignore named cast items. If cast-item is a stick, all sticks, regardless of their name, will work. If disabled, you can use colored names to differentiate cast items.	Boolean	false
ignore-cast-item-amount	Whether to ignore the number of cast items.	Boolean	true
ignore-cast-item-name-colors	Whether to ignore the name colors of cast items.	Boolean	false
ignore-cast-item-breakability	Whether to ignore the breakability of cast items.	Boolean	true
ignore-cast-item-color	Whether to ignore the color of cast items.	Boolean	true
ignore-cast-item-potion-types	Whether to ignore the potion types of cast items.	Boolean	true
ignore-cast-item-title	Whether to ignore the book title of cast items.	Boolean	true
ignore-cast-item-author	Whether to ignore the book author of cast items.	Boolean	true
ignore-cast-item-lore	Whether to ignore the lore of cast items.	Boolean	true
ignore-cast-item-custom-model-data	Whether to ignore the custom model data of cast items.	Boolean	true
ignore-cast-item-durability	A list of Materials to ignore durability on when looking at cast items.	String List

Entity Names:

The section below is a list of entity-names. They are used in strings to represent names of entities by default.

entity-names:
    zombie: an ugly zombie
    skeleton: a scary skeleton
    spider: a spider
    cavespider: a nasty little spider
    creeper: a creepy creeper
    slime: a slimy blob
    wolf: a wolf
    snowman: a snow golem
    villager: an innocent villager
    enderman: Mr. Enderman
    silverfish: a slimy silverfish
    ghast: a ghast
    pigzombie: a pig zombie
    blaze: a blaze
    lavaslime: a magma slime
    giant: the giant
    enderdragon: the ender dragon
    cow: a cow
    sheep: a sheep
    pig: a smelly pig
    chicken: a duck
    mushroomcow: a deformed cow
    squid: a slimy squid
    irongolem: a friendly iron golem