General Configuration

On this page you will learn the configuration of ExecutableItems that is on config.yml locaeted in plugins/ExecutableItems/config.yml.

Config.yml

# ----------------------------------
# -
#       ExecutableItems
# -
#         By: Ssomar
# -
# ----------------------------------
# -
# WIKI HERE : https://splugins.net/docs/executableitems/information-ei
# DISCORD HERE : https://discord.com/invite/TRmSwJaYNv
# -
pickupLimit: -1
disabledWorlds: []
whitelistedWorlds: []
whitelistItemsPerWorld:
  myWorld:
  - myEI1
  - myEI2
  myWorld2:
  - myEI3
  - myEI4
premiumEnableCooldownForOp: true # Premium only
checkVersionMsg: true
disableTestItems: false # If you have a big server with a lot of players, it's recommended to turn this option on true
silentMessagePreventionErrorHeadDBError: false
disableBackup: false # <- Backup your items config at each start / reload of the server
deleteBackupsAfterDays: 7 # <- It will deletes backups older than this number of days
enableGarbageCollectorAfterReload: false # <- It will enable the garbage collector after a reload of the server
giveLimit: 100
enableTexturesPack: false # Only for 1.20.5+ servers
texturesPackUrl: https://github.com/Ssomar-Developement/items/raw/main/__textures__/ExecutableItems_Pack.zip # Only for 1.20.5+ servers
texturesPackRequired: true # false: the textures pack is proposed to the players, they can decline it
logs:
  dropped: true
  spawned: true
debugOnlyRun: false # /ei debug will only display the run debug message
disableActivatorsInSpectator: false # true: players in spectator mode do not trigger activators
keepNameInAnvil: true # true: an item that goes through an anvil without being renamed keeps its styled name
loreNotItalicByDefault: false # true: the lore lines are not italic unless they ask for it
itemCheckWithNBTAPI: false
config_12_04_2024: true
silentGive: false
updateOldItems: false
muteModification: false # With true It will mute the outputs of /ei modification or /ei console modification

pickupLimit

• Info: Integer value to limit the amount of ExecutableItems the player can have in his inventory.
• Example:

pickupLimit: 3 # This means the player can have as maximum 3 ExecutableItems in his inventory.

disabledWorlds

• Info: List of world names used to blacklist worlds where all ExecutableItems will be disabled.
• Example:

disabledWorlds: # In this example all ExecutableItems will be disabled on "HellOfBirds" and "automaticCar" worlds. 
- HellOfBirds
- automaticCar

whitelistedWorlds

• Info: List of world names used to whitelist worlds where all ExecutableItems will be enabled.
• Example:

whitelistedWorlds: # In this example all ExecutableItems will be enabled on "AngelWorld" world
- AngelWorld

whitelistItemsPerWorld

• Info: List of ExecutableItems per world that are enabled.
• Example:

whitelistItemsPerWorld: 
  myWorld: # ExecutableItems with ID myEI1 and myEI2 are enabled on "myWorld" world.
  - myEI1
  - myEI2
  myWorld2: # ExecutableItems with ID myEI3 and myEI4 are enabled on "myWorld2" world.
  - myEI3
  - myEI4

premiumEnableCooldownForOp PREMIUM

• Info: Boolean value that makes the op/operators/admins players not have cooldown.
• Example:

premiumEnableCooldownForOp: true

checkVersionMsg

• Info: Boolean value to display if there is a new update for ExecutableItems.
• Example:

checkVersionMsg: true

disableTestItems

• Info: Boolean value to disable the default items.
  • It improves performances due to some type of activators not being registered.
• Example:

disableTestItems: false

silentMessagePreventionErrorHeadDBError

• Info: Boolean value to mutes the message prevention error from plugin HeadDB.
• Example:

silentMessagePreventionErrorHeadDBError: false

disableBackup

• Info: Boolean value to disable the backups that ExecutableItems does on the back up folder on each start / reload of the server.
• Example:

disableBackup: false

deleteBackupsAfterDays

• Info: Integer value that represents the amount of days to save the backup. If the backup is older than those days then it will be deleted..
• Example:

deleteBackupsAfterDays: 7

enableGarbageCollectorAfterReload

• Info: Boolean value to enable the garbage collector after a reload of the server.
  • If you don't know what this is probably its because you don't need it. You can read more information on google, its long to explain here and its not the objective.
• Example:

enableGarbageCollectorAfterReload: false

giveLimit

• Info: Integer value that represents a limit/cap for the ExecutableItems command of give (/ei give).
• Example:

giveLimit: 100

enableTexturesPack

• Info: Boolean value to enable or disable the texture pack of "texturesPackUrl".
  • This feature only works on 1.20.5++ servers.
• Example:

enableTexturesPack: false

texturesPackUrl

• Info: URL of a texture pack to enable on your server.
  • This feature only works on 1.20.5++ servers.
• Example:

texturesPackUrl: https://github.com/Ssomar-Developement/items/raw/main/__textures__/ExecutableItems_Pack.zip

texturesPackRequired

• Info: Boolean value, true by default. With true, the players must accept the textures pack of ExecutableItems (the self-hosted pack of selfHostPack: true, or the pack of texturesPackUrl): a player who declines it is disconnected. With false, the pack is proposed to the players but they can decline it and keep playing, without the custom textures.
  • The option is read each time the pack is sent: after /ei reload, the new value applies to the players who join next.
• Example:

texturesPackRequired: false

logs

• Info: Feature to enable console logs to know what is happening with your ExecutableItems.
  • dropped: Boolean value to log each time an ExecutableItem is dropped on your server.
  • spawned: Boolean value to log each time an ExecutableItem is spawned on your server.
• Example:

logs:
  dropped: true
  spawned: true

debugOnlyRun

• Info: Boolean value for debug ExecutableItems command (/ei debug) to only show the debug message when the activator run (this means only when all conditions met)
• Example:

debugOnlyRun: false

disableActivatorsInSpectator

• Info: Boolean value, false by default. With true, a player in spectator mode does not trigger the activators of his ExecutableItems (loops, sneak, equip, hits...) and does not consume usages or cooldowns.
  • These activators still run in spectator mode, so the item keeps its state: PLAYER_CONNECTION, PLAYER_DISCONNECT, PLAYER_DEATH, PLAYER_RESPAWN, PLAYER_WRITE_COMMAND, EI_ENTER_IN_THE_PLAYER_INVENTORY and EI_LEAVE_THE_PLAYER_INVENTORY.
• Example:

disableActivatorsInSpectator: true

keepNameInAnvil

• Info: Boolean value, true by default. An ExecutableItem that goes through an anvil without being renamed (enchant with a book, repair) keeps its display name with its colors / gradient.
  • It is an option of plugins/ExecutableItems/config.yml and applies to all your ExecutableItems. It is not an item setting: written in an item file, it does nothing.
  • Why it is needed: when an item is placed in an anvil, the game compares the text of the name field with the name of the item. Some names can't be written in that field (for example a name whose text holds a §), so the game believed the item was renamed and rewrote its name as plain text: the gradient was lost.
  • The name field holds 50 characters. For a longer name the game sends no name at all, and the server removed it: the option keeps these long names too.
  • If the player really types a new name, the item is renamed like in vanilla (plain text). Clearing the field removes the name, like in vanilla. To forbid renaming, use the restriction cancel-rename-anvil of the item.
  • If the option is not in your config.yml, it is enabled. Set it to false to get the old behaviour back.
• Example:

keepNameInAnvil: true

loreNotItalicByDefault

• Info: Boolean value, false by default. Minecraft shows the lore in italic unless a line says otherwise. With true, every lore line is straight unless it asks for italic itself.
  • Works with legacy colors (&7My line) and MiniMessage (<gray>My line), on Paper and Spigot.
  • A line can still be italic with &o or <italic>.
  • Without the option you can do the same line by line with <italic:false> (MiniMessage).
• Example:

loreNotItalicByDefault: true

itemCheckWithNBTAPI

• Info: Boolean value to enable NBTAPI plugin to handle item check detections.
  • It requires NBTAPI plugin.
  • It should improve performances.

silentGive:

• Info: Boolean value to silence the output of the give ExecutableItems command (/ei give) in the console.
• Example:

silentGive: false

updateOldItems

• Info: Boolean value to enable updating old items NBT Tag. This doesn't mean the update of your ExecutableItems configs, that is automatically, this means if there is a change of NBT across one of the plugin's update, the NBT will be updated too.
• Example:

updateOldItems: false

muteModification

• Info: Boolean value to mute or not the outputs generated by the command of /ei modification or /ei console modification
• Example:

muteModification: true