Skip to content

General Configuration

MomoPewpew edited this page Jul 28, 2023 · 10 revisions

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

Option Description Default Value
debug Turns on the debug feature. This will print out a lot of extra information in the console when using the plugin. false
debug-null Defines if MagicSpells should debug null throwables. true
debug-number-format Defines if MagicSpells should debug number formatting throwables. 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. 3
tab-complete-internal-names Defines if commands should tab-complete internal names or not. 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. 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. true
enable-profiling Defines if MagicSpells should run the profiler tasks. false
error-log-limit Defaults to -1. If greater than 0, limits the total size of the errors folder to the specified file limit -1
text-color The default color code for MagicSpells messages. 3
broadcast-range The range in blocks that certain string messages in spells should broadcast, such as str-cast-others. 20
effectlib-instance-limit It's the limit for effectlib effect instances. 20000
ops-have-all-spells Whether to give opped players all the spells in the game. 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. false
ignore-grant-perms Defines if MagicSpells should ignore grant permissions while checking if a player's spellbook has a spell. 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. true
ignore-cast-perms Defines if a player can cast a spell. false
enable-tempgrant-perms Defines if tempgrant permission should be enabled or not. 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. false
allow-cycle-to-no-spell The option to let players cycle to "no spell" on any bound item. false
reverse-bow-cycle-buttons Defines if cycling spells while holding a bow should function with reverse buttons - left to cycle, right to cast. false
cast-bound-bow-spells-from-offhand Disables casting triggered by shooting a bow in the offhand. false
bow-cycle-spells-sneaking Defines if bows should cycle spells while the player is sneaking instead. false
always-show-message-on-cycle The option to always show str-spell-change when cycling through spells. 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. true
spell-icon-slot Defines the slot where to display the spell icon on. -1
allow-cast-with-fist This allows players to bind things to their fist. false
cast-with-left-click This option, if true, will force default casting to be done through left-clicking. true
cast-with-right-click This option, if true, will force default casting to be done through right-clicking. false
cycle-spells-with-offhand-action Defines if MagicSpells should cycle spells with the offhand action instead. false
ignore-default-bindings Whether to ignore all set cast-item options in spells. false
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. 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. false
ignore-cast-item-amount Whether to ignore the number of cast items. true
ignore-cast-item-name-colors Whether to ignore the name colors of cast items. false
ignore-cast-item-breakability Whether to ignore the breakability of cast items. true
ignore-cast-item-color Whether to ignore the color of cast items. true
ignore-cast-item-potion-types Whether to ignore the potion types of cast items. true
ignore-cast-item-title Whether to ignore the book title of cast items. true
ignore-cast-item-author Whether to ignore the book author of cast items. true
ignore-cast-item-lore Whether to ignore the lore of cast items. true
ignore-cast-item-custom-model-data Whether to ignore the custom model data of cast items. true
ignore-cast-item-durability A list of items to ignore durability on when looking at cast items.
check-world-pvp-flag Whether to check if PVP is enabled in a world before harming another player. true
check-scoreboard-teams Defines if MagicSpells should check for scoreboard teams friendly fire before while looking for a target. false
show-str-cost-on-missing-reagents Defines if MagicSpells should send info of missing reagents. true
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. 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
global-radius Global radius limit for all spells that support it. 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. 500
cast-on-animate Defines if MagicSpells cast items should activate on arm animation instead of real clicks. 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. true
cooldowns-persist-through-reload Whether to force cooldowns to remain as they were through a reload of the plugin. 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. ""
sound-missing-reagents Defines the sound to be played when a spell fails to be casted because of missing reagents. ""
str-unknown-spell The string message sent if a player attempts to cast a spell they don't know. 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. 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. You are no longer using a spell.
str-on-cooldown The default cooldown message. 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. 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. 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. 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. You cannot cast that spell here.
str-console-name The name to use for the console in any string arguments. Admin
str-xp-auto-learned The string message sent when the player auto learned a spell due to MagicXP. You have learned the %s spell!
allow-anticheat-integrations If enabled, will allow compatible anti-cheat plugins to hook into magicspells for better usage. false
buff-check-interval Defines the interval of the buff spell monitor - expiration checker. 100
ops-ignore-reagents Whether to let opped players ignore all costs. true
ops-ignore-cooldowns Whether to let opped players ignore all cooldowns. true
ops-ignore-cast-times Whether to let opped players ignore all cast times. true
hide-magic-item-tooltips Whether to hide the tooltips of magic items. false
enable-magic-xp Defines if the MagicXP system should be enabled. false
enable-dance-casting Defines if dance casting should be enabled. true
enable-logging Defines if the MagicSpells logger should be enabled - the logger writes to log files in root. false

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
Clone this wiki locally