Config.yml

Index:

• General - These are typically general maintenance settings that do not affect functionality.
• Settings - These settings will take effect globally throughout the plugins system.
• Permissions - Permissions if enabled, determine whether the permission(s) is/are applied.
• Clear-Items - This is the section to enable the clearing of items upon a trigger.
• Active-Commands - Command(s) executed upon the player performing the defined trigger(s).
• Prevent - This determines if the action is allowed for all items in the specified worlds.

This is a quick overview of the default config.yml configuration.

---

config-Version: 8

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, the available languages are English, Spanish, Russian, Portuguese, Dutch, Italian, French, Traditional Chinese, and Simplified Chinese. However, editing the en-lang.yml can allow you to modify the English language to what you prefer.

General

These are typically general maintenance settings that do not affect functionality.

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.

Metrics-Logging: true

This should always be kept true, this simply allows ItemJoin to anonymously send data of your item count, server version, most used dependencies, java version, etc. A way to think of this as it being a statistics page. If you wish to not be included set this to false. This tool will be really useful in allowing me to increase the quality of the ItemJoin updates as well as supported Minecraft Versions. You can see the ItemJoin stats page here; https://bstats.org/plugin/bukkit/ItemJoin

Log-Commands: true

Setting this to false will stop the console from logging any of the commands that are executed from ItemJoin items.

Debugging: 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.

Database

These settings are optional as a database file is generated by default or you can set up MySQL database connections.

MySQL: false

When setting this to true, a MySQL database will be used (and required) for ItemJoin. When set to false, a local .db file which is located in the ItemJoin folder will be used.

database: 'database_name'

The name of the database (directory), that will be created. You can call database_name whatever you want, as long as it is a unique table name.

prefix: 'ij_'

The name of the prefix to set for each table that will be created. This can be anything you want, as long as it is unique. Do note, changing this does not transfer existing data.

host: 'localhost'

The hostname of your MySQL database. Use the credentials provided by your MySQL provider.

port: 3306

The port of your MySQL database. Port 3306 is the standard port and is normally used. If you can't connect with this port, and you can't find any clues about the port the database is using, you should contact your service provider, to ask for the port.

user: 'root'

The username of the database. Use the credentials provided by your MySQL provider.

pass: 'password'

The password of your MySQL database. Use the credentials provided by your MySQL provider.

Settings

These settings will take effect globally throughout the plugins system.

HeldItem-Slot: -1

This works in a fairly simple way, this option is meant 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.

HeldItem-Triggers: JOIN, WORLD-SWITCH

These are the list of triggers you want to trigger the held-item slot change. For example, if a player JOIN or WORLD-SWITCH the held-item slot will change to the predefined HeldItem-Slot listed above. Simply define the trigger(s) separated by a comma, these are the trigger names used for items such as JOIN, RESPAWN, WORLD-SWITCH.

HeldItem-Animations: true

Setting this to false will DISABLE the animate and dynamic itemflag while the item is being held in the player's hand. Useful for preventing rapid updating of the player's hand animation. This does not prevent the itemflags from functioning, it simply stops the itemflags from forcing an update to the item while it is being held, once the item is no longer being held it will resume the animation.

Default-Triggers: JOIN

If NO TRIGGERS are defined for an item, this will be the default trigger(s) selected to be used by the item. By default, this is set to JOIN so if no triggers are defined you will get the item on join. You can add any of the available triggers that exist, a few of these can be listed such as JOIN, RESPAWN, WORLD-SWITCH.

DataTags: true

Setting this from true to false or vice versa will require you to fully clear the player's 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.

Permissions

These permissions if enabled, determine whether the permission(s) is/are applied to certain players.

Obtain-Items: false

Setting this to false will allow all players to get any and all items regardless of what permissions they have. However, setting this to true will enable ItemJoin permissions for items.

Obtain-Items-OP: 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.

Commands-Get: false

Setting this to true will require players to have the item's permission when receiving an item that is being given via /itemjoin get or /itemjoin get . If the player lacks the specific item's permission, an error message will be sent to both parties that yourself or the specified is lacking the permission. Obviously depending on which of the two commands are executed. Note this does not give or revoke any permissions for a player to run this command, that is still linked to the itemjoin.get and itemjoin.get.others permission nodes.

Commands-OP: 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 Opped players by default, you will now have to set Commands-OP 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).

Movement-Bypass: false

Setting this to true will enable the use of the itemjoin.bypass.inventorymodify permission node. If this is kept false simply giving the player the permission node will not allow them to bypass the inventory modification itemflag. This was implemented because some server owners were using the * permission node which would force the server to give the player every single permission node on the server...

Clear-Items

If enabled this will clear items from their inventory upon performing the specified action for the specified type. The available types(s) are ALL for all items or ITEMJOIN for only the ItemJoin items.

Type: ItemJoin

There are two options for this, either ItemJoin or All.

ItemJoin - Specifies only ItemJoin items to be the items cleared.

Vanilla - Specifies only normal items to be the items cleared, (clears all items excluding ItemJoin items).

All - Specifies any item within the player's inventory to be cleared.

Delay-Tick: 2

This is the time in half-seconds before the items will be cleared from the player's inventory. This is useful to combat other plugins giving after the inventory is cleared or restoring a players inventory.

If this is set equal to or higher than the items-Delay value in the items.yml it will automatically increase the items-Delay by one half-second to prevent the items from being removed after they are given.

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 define specific worlds that you wish to clear in if a player joins within that world.

Example of specific worlds defined: Join: world, world_nether, world_the_end

Quit: false

Setting this to true will either clear All Items or Only ItemJoin items upon exiting the server, depending on what the Clear-Items option is set to do. Also, instead of setting this to true you can define specific worlds that you wish to clear in if a player disconnects within that world.

Example of specific worlds defined: Quit: world, world_nether, world_the_end

World-Switch: 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 define specific worlds that you wish to clear in if a player switches to that specific world(s).

Example of specific worlds defined: World-Switch: world, world_nether, world_the_end

Region-Enter: false

Setting this to true will either clear All Items or Only ItemJoin items upon entering a region, depending on what the Clear-Items option is set to do. Also, instead of setting this to true you can define specific regions that you wish to clear in if a player enters that specific region(s).

Example of specific regions defined: Region-Enter: region1, region2

Options: PROTECT, PROTECT_OP, PROTECT_CREATIVE, RETURN, RETURN_SWITCH

Currently, there is only four option(s), that being PROTECT, PROTECT_OP, PROTECT_CREATIVE, RETURN, and RETURN_SWITCH. To these options, simply set this to DISABLED.

PROTECT - will protect ALL ItemJoin items that are First-World or First-Join items so they will not be cleared upon world-switch or join from the player's inventory.

PROTECT_OP - will protect ALL ItemJoin items for OP/ADMIN players so they will not be cleared upon world-switch or join from their inventory.

PROTECT_CREATIVE - will protect ALL ItemJoin items for CREATIVE MODE players so they will not be cleared upon world-switch or join from their inventory.

RETURN - will return any cleared items when exiting the region that was entered. This option only works with the Region-Enter clearing event.

RETURN_SWITCH - will return any cleared items when returning to the said world which the inventory was cleared. This option only works with the World-Switch clearing event.

Blacklist: '{id:BEDROCK}, {slot:9}, {name:Blazefury}'

Blacklisting an items ID, items name, or player slot from being cleared may seem complicated at first but it is easy to figure out. There are currently three option(s) to blacklist clearing. That being, an item name, id and player slot.

You can blacklist an item by defining {TYPE:VALUE} replacing the type with either name, id, or slot and the value with the corresponding value. Do not put any color codes for the value input for the name type, color codes are stripped and are not needed. The Blacklist identifier requires an apostrophe at the beginning and end of the list of blacklisted items as shown in the example below. This is a limitation of the YML file, forgetting to do so will result in error codes.

In this example, any item with the BEDROCK material will not be cleared, any item with the name Blazefury will not be cleared, and any item in the player slot 9 will not be cleared. These all work separately and are not "conditions". You can setup as many blacklist options as you want such as blacklisting these three items; {id:BEDROCK}, {id:DIAMOND}, {id:IRON_INGOT} from being removed from the players inventory.

If you wish to disable blacklisting simply make it blank; Blacklist: ''

Active-Commands

This is the command(s) executed upon the player performing the defined trigger(s), for the specified world(s).

Commands

 commands:
  - 'itemjoin get <item> <player>'
  - 'first-join: say This is a command only executed once per world, per player.'

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.

commands-sequence: SEQUENTIAL

Currently, there are only two sequences(s), that being SEQUENTIAL, and RANDOM_SINGLE.

This will execute the command(s) sequentially or execute a single command line randomly.

triggers: JOIN

Currently, there are four different triggers, those being JOIN, FIRST-JOIN, WORLD-SWITCH and RESPAWN.

This will execute the command(s) upon the player performing the trigger.

enabled-worlds: world, world_nether

These are the list of the worlds separated by commas to execute the commands upon joining the server.

Prevent

This determines if the action is allowed for all items in the specified worlds. To disable an action, simply set the action to true for all worlds or list each world separated by a comma.

Pickups: false

Setting this to true will prevent players from picking up any items on the server.

itemMovement: false

Setting this to true will prevent players from moving around any items in their inventory on the server.

Self-Drops: false

Setting this to true will prevent players from dropping any items from their inventory on the server.

Death-Drops: false

Setting this to true will prevent players from dropping any items when dying on the server.

Bypass: CREATIVE, OP

Currently, there is only OP and CREATIVE for this, adding CREATIVE will allow players that are in creative-mode to not be affected by the pickups or item movement restrictions, meaning players in creative or oped players will be able to move and pick up items despite the defined setting.