Configurations

May 29, 2018
Configurations
  • Here is an overview of each YAML file, this should give you the need-to-know about the options in each file.
    If you feel like something is missing and needs to be added or clarified please Direct Message me and I will add it.

    Notice; All data that ItemJoin accumulates will be stored in a database.db file located in the ItemJoin folder, this database will contain all needed info such as first-joins, ip-limits, global message first-join usages, and first command uses for items.

    If you are looking for features that have to do with hooking plugins into ItemJoin they have been moved, click here; https://www.spigotmc.org/wiki/api-hooks

    [​IMG]

    This is a quick overview of the;
    https://www.spigotmc.org/wiki/default-items-yml/

    items-Version: 6
    • This should never be touched, modifying this will cause the items.yml file to break and regenerate.


    items-Delay: 2

    • This is the delay in half-seconds that ItemJoin will wait to give you the items. 1 = 0.5 seconds.
    • This is useful if you have another plugin that clears the players inventory, you can set the delay long enough that the items are given after the other plugins clears the players inventory. Usually 2-3 seconds at the most.
    • It is not recommended to set this any lower than 2 half-seconds as it can result in issues with giving the items.


    items-Overwrite: false

    • Setting this to true will allow ItemJoin items to overwrite any items (if any) that are in the dedicated slot for the ItemJoin item.
    • Setting this to false will prevent ItemJoin from accidentally removing items if they are in the dedicated slot for an item. Therefore, the ItemJoin item will not be given.
    • If you wish to you can specify per-world instead of globally. Simply remove the true/false statement and put the name or world or world(s) separated by a comma.
      • All worlds that are defined will be the worlds that ItemJoin can overwrite items in.
    • Example of overwriting in specific worlds;
    • Code (Text):
      items-Overwrite: world, world_the_end
    • Example of disabling all item overwrites in all worlds;
    • Code (Text):
      items-Overwrite: false
    • Example of enabling all item overwrites in all worlds;
    • Code (Text):
      items-Overwrite: true



    items-Spamming: false
    • Setting this to false will prevent players from rapidly spamming the use of Item's Commands. It is recommended to leave this to false.


    items-RestrictCount : false
    • Setting this to false will prevent players from being given more of an item if it is not the same count as in the items.yml, saying you ate 3 out of the 4 bread you would not receive any more bread until you ate all of it.
    • Setting this to true will give the player more of the item if the stack/count size is not the same as the items.yml.
    • To sum this up, setting this to true will allow the player to have their items refreshed (topped up) if they have used some of the stack of the item they were given.


    If you are looking for help on how to create custom ItemJoin items, please view this section of the wiki; https://www.spigotmc.org/wiki/itemjoin-getting-started/


    [​IMG]

    This is a quick overview of the;
    https://www.spigotmc.org/wiki/default-config-yml/

    config-Version: 6
    • This should never be touched, modifying this will cause the config.yml file to break and regenerate.


    Language: 'English'
    • This identifies the language that ItemJoin will use as well as the lang file that it will generate.
    • Current English is the only language currently supported, however editing the en-lang.yml can allow you to modify the English language to what you prefer.


    CheckForUpdates: true
    • Setting this to false will stop ItemJoin from checking for updates and notifying you if an update has been found upon starting the server, or reloading the server.


    Log-Coloration: true
    • Setting this to false will simply make all text output from ItemJoin into console be in simple black and white, rather than the magical colors I have chosen.


    Log-Commands: true
    • Setting this to false will stop the console from logging any of the commands that are executed from ItemJoin items.


    Items-Permissions: true
    • Setting this to false will allow all players to get any and all items regardless of what permissions they have.


    OPItems-Permissions: false
    • Setting this to true will require ops to have each item's permissions in order to receive them, rather than getting all items by default.
    • Keeping this false will allow ops to bypass all Item permissions and receive every item.


    OPCommands-Permissions: false
    • Setting this to true will require ops to have each commands permissions or itemjoin.all or itemjoin.* in order to use each command. Ops will not get each command by default if this is set to true.
      • itemjoin.(reload, updates, autoupdate, creator, purge, save, get, get.others, remove, remove.others, enable, enable.others, disable, disable.others, list) are no longer given to oped players by default, you will now have to set OPCommands-Permissions in the config.yml to false to allow ops to get these commands by default (however this is the default selected setting, setting it to true will require ops to be given these permissions).
    • Keeping this false will allow ops to execute the following commands by default, without permissions.
      • itemjoin.(reload, updates, autoupdate, creator, purge, save, get, get.others, remove, remove.others, enable, enable.others, disable, disable.others, list)


    Debugging-Mode: false
    • Setting this to true may help identify a bug you found when reporting it to the developer, it creates more detailed logs and outputs in the console window for debugging later on.
    • It is recommended to keep this false unless you are experiencing issues with ItemJoin and need help.



    Global Settings for ItemJoin.
    Prevent-Pickups: false
    • Setting this to true will prevent players from picking up any items on the server.


    HeldItem-Slot: None
    • This works in a fairly simple way, this option is mean't for you to be able to define what slot you want the player that logs in and changes worlds to be selected on.
    • So say you define slot 3 to be what you want the players to be selected on, when joining and switching worlds this will be the slot selected, usually great to use if you have a special item in that slot.
    • So simply put, this option forces the players to have this specific slot as their selected slot.
    • You may only define slots 0-8, as you only have 9 slots in your hot-bar. If you wish for it to be disabled, set it to None.


    NewNBT-System: true
    • Setting this from true to false or vise versa will require you to fully clear the players inventory, old items will break. When this is set to true ItemJoin will give items NBTTags to help identify them as ItemJoin items, if this is set to false it will simply define it within the items name in a way that you won't see it. Keeping this set to true will allow some ItemJoin features to work better so it is best to keep this set to true by default.
    • If you don't understand what this does please do not touch it, there should be no change when setting this to false that you would notice.



    Global Clear Items for ItemJoin.
    Clear-Items: ItemJoin
    • There are two options for this, either ItemJoin or All.
    • ItemJoin - Specifies only ItemJoin items to be the items cleared.
    • All - Specifies any item within the players inventory to be cleared.


    Clear-On-Join: false
    • Setting this to true will either clear All Items or Only ItemJoin items upon joining the server, depending on what the Clear-Items option is set to do.
    • Also, instead of setting this to true you can defined specific worlds that you wish to clear in if a player joins within that world.
    • Example of specific worlds defined;
    • Code (Text):
      Clear-On-Join: world, world_nether, world_the_end


    Clear-On-WorldChanged: false
    • Setting this to true will either clear All Items or Only ItemJoin items upon switching to a different world, depending on what the Clear-Items option is set to do.
    • Also, instead of setting this to true you can defined specific worlds that you wish to clear in if a player switches to that specific world(s).
    • Example of specific worlds defined;
    • Code (Text):
      Clear-On-WorldChanged: world, world_nether, world_the_end


    AllowOPBypass: false
    • Setting this to true will allow players that are Op'ed to not be affected by Clear-Items, meaning their inventory will not be cleared.


    CreativeBypass: false
    • Setting this to true will allow players that are in creative-mode to not be affected by Clear-Items, meaning their inventory will not be cleared.



    Global Commands for ItemJoin on join, these commands are executed by console.
    enabled-global-commands: false
    • Setting this to true will allow the use of global-commands.
    • These are commands that get executed upon joining the server,


    enabled-worlds: world, world_nether
    • These are the list of worlds separated by commas to execute the global commands upon joining the server.


    global-commands:
    • This is where you list the commands you wish to execute, keep in mind these are executed as console so if you wish for them to relate to a specific player you will have to use %player% and other placeholders.
    • There is also the option to execute these commands only once per player, via; first-join.
    • See the example for implementation as well as use of the first-join option;
    • Code (Text):
      global-commands:
        - 'itemjoin get <item> <player>'
        - 'first-join: say This is a command only executed once per world, per player.'


    These are optional dependencies, only change these if you are looking to use them in conjunction with ItemJoin, changing the values will require a server restart.
    Vault: false
    • If you have Vault already on your server it is recommended to set this to true.
    • You can hook into vault to use your economy on ItemJoin's commands, this will allow the use of command-cost for items with it defined, so you can charge players to execute a command.


    PlaceholderAPI: false
    • If you have PlaceholderAPI already on your server it is recommended to set this to true.
    • You can use all of these placeholders on any part of ItemJoin, whether its commands, name, lore, skull-owner, book-lore, authors, etc! All parts of ItemJoin are hooked into PlaceholderAPI. This will allow the usage of every single PlaceholderAPI placeholder that you wish to use in any aspect of ItemJoin, such as; lang messages, Items Name, Items Lore, Items Commands, and more.
    • Example placeholder such as; %player%.


    Multiverse-Core: false
    • If you have Multiverse-Core already on your server it is recommended to set this to true.
    • This is only used for Multiverse-Inventories as ItemJoin already has multi-world support without this.


    Multiverse-Inventories: false
    • If you have Multiverse-Inventories already on your server it is recommended to set this to true.
    • Easily set world inventories using ItemJoin. You can make it so you get the items on join and world change without clearing the players inventory! Very helpful with ItemJoin inventory management.


    PerWorldInventory: false
    • If you have PerWorldInventory already on your server it is recommended to set this to true.
    • Easily set world inventories using ItemJoin. You can make it so you get the items on join and world change without clearing the players inventory! Very helpful with ItemJoin inventory management. I have recently seen this plugin start to pop up everywhere and it seems like an amazing alternative to Multiverse-Inventories.


    PerWorldPlugins: false
    • If you have PerWorldPlugins already on your server it is recommended to set this to true.
    • This currently provides no benefit and it really isn't recommended to use PerWorldPlugins with ItemJoin as you can already restrict its usage per-world, however ItemJoin will obey by the rules set in PerWorldPlugins. As it is not recommended since ItemJoin is disabled in any world that are not defined under world-list but, ItemJoin does support PerWorldPlugins if you happen to have it running on your server for some reason and ItemJoin will be disabled in worlds that are not allowed by PerWorldPlugins.


    xInventories: false
    • If you have xInventories already on your server it is recommended to set this to true.
    • Easily set world inventories using ItemJoin. You can make it so you get the items on join and world change without clearing the players inventory! Very helpful with ItemJoin inventory management.


    TokenEnchant: false
    • If you have TokenEnchant already on your server it is recommended to set this to true.
    • This allows ItemJoin Items to be able to be given specific TokenEnchantments when receiving them.


    HeadDatabase: false
    • If you have HeadDatabase already on your server it is recommended to set this to true.
    • This allows ItemJoin Items to be able to hook into HeadDatabase and fetch player heads from there using <hdb-head id>.


    WorldGuard: false
    • If you have WorldGuard already on your server it is recommended to set this to true.
    • Items will be given after the player enters the specified region defined under each item, upon leaving the region the items will be revoked. This allows the creation of region only items and can only be used in the specified regions unless defined otherwise.


    BetterNick: false
    • If you have BetterNick already on your server it is recommended to set this to true.
    • If items for some reason end up breaking and you use this plugin, setting this to true could resolve issues with items not working properly. This allows ItemJoin to easily find your original player name and UUID if you are nicknamed using BetterNick.


    MyWorlds: false
    • If you have MyWorlds already on your server it is recommended to set this to true.
    • This allows ItemJoin to have easy multi-world support.


    AuthMe: false
    • If you have AuthMe already on your server it is recommended to set this to true.
    • This will allow ItemJoin Items to be given after the player types the login command and fully registers to AuthMe.


    [​IMG]

    This is a quick overview of the;
    https://www.spigotmc.org/wiki/default-en-lang-yml/


    Explain stuff in detail....
  • Loading...
  • Loading...