What is HideItem?

HideItem is plugin that allows players to toggle visibility of other players.

This plugin has been originally created by qKing12 (Link to his plugin page) and was recoded by me (1vomarek1)

Configuration

When first started the plugin will 100% work. However some things can be configured more in depth (ex. item name & material, data storage ect.)

Storage Settings

First thing you want to configure is storage method (How the plugin will store data)

storage-method

how data will be stored (none, file, mysql) if set to none the plugin will store its data only to memory. If set to file data.yml file will be created and all data will be saved to it If set to mysql all data will be stored in mysql database (Mysql settings will be required) Using root user is not recommended

mysql

mysql:
  host: "localhost"
  port: 3306
  database: "HideItem"
  table: "HideItem"
  user: "root"
  password: ""

Item Settings

In this section there are settings related to items

require-permission-for-items

defaultly set to false so all players can use hide item without getting no permission message. In case of setting it to true hideitem.toggle permission is required to use hideitem

first-free-slot and slot

what slot should the Item be on. if first-free-slot is set to true the HideItem will be added to first possible slot in players inventory so no item is overwritten. If first-free-slot is set to true you don't have to configure slot else the item will be set to slot (configurable) but the plugin could overwrite the item in that slot.

fixed-item

Should player be able to move or drop the item? If set to true player won't be able to move the item in their inventory and won't be able to drop it.

other item settings

There are other settings related to hide item such as material, data, name, lore. (self explanatory)

# Settings of item when all players are visible
hide-item:
  material: "INK_SACK:10"
  name: "&eHide Players &7(Shown)"
  lore:
    - "&aClick &7to hide players"
​
# Settings of item when all players are hidden
show-item:
  material: "INK_SACK:8"
  name: "&eHide Players &7(Hidden)"
  lore:
    - "&aClick &7to show players"

Command Settings

In this section there are settings related to commands and their aliases

require-permission-for-commands

defaultly set to false so all players can use /hideitem <show | hide | toggle> without getting no permission message. In case of setting it to true hideitem.<show, hide, toggle> permission is required to use /hideitem <show | hide | toggle>

use-aliases

should aliases be added to /hideitem <show, hide, toggle>? (all aliases can be configured) default aliases are /show, /hide and /toggleplayers

aliases (show-command-alias, hide-command-alias and toggle-command-alias)

What should aliases for /hideitem <show, hide, toggle> be. (Defaultly /hide, /show, /toggleplayers) If use-aliases is set to false these aliases won't work

Other Settings

In this section there are all other settings (settings that didn't really fit other categories)

cooldown

How long should cooldown for /hideitem <show, hide, toggle> and hideitem be There is separated cooldown for items & commands:

disable-items and disable-commands

If set to true certain fearture will be disabled. disable-commands disables both commands and aliases for them!

default-state-shown

Default state of hide item (Used in case of not having data about specific player's hidden state)

config (rename-old-config)

If you update to new version the plugin will defaultly copy your config, create config.old.yml (with your current data) and generate a new config (config.yml) If set to false the plugin will just work with the config you have and will use default value for new / updated config values

Commands

/hideitem reload

This command reloads configuration values and clears hideitem memory (Items of joined players won't be modified)

Required permission: <hideitem.reload | hideitem.admin | hideitem.*> Usage: /hideitem reload

/hideitem toggle

This command toggles visibility of other players for you.

Required permission: hideitem.toggle (Required only if require-permission-for-commands in config is set to true) Usage: /hideitem toggle

/hideitem show

This command shows you all hidden players

Required permission: hideitem.show (Required only if require-permission-for-commands in config is set to true) Usage: /hideitem show

/hideitem hide

This command hides all players from you

Required permission: hideitem.hide (Required only if require-permission-for-commands in config is set to true) Usage: /hideitem hide

Permissions

hideitem.*

All permissions for hideitem

hideitem.admin

All administrator permissions

hideitem.reload

Permission to reload the plugin

hideitem.seevanished

If using vanish plugin and player is vanished you can only see him with this permission

hideitem.toggle

Only needed if require-permission-for-<commands | items> is set to true This permission allows you to use /hideitem toggle and using hide item

hideitem.hide

Only needed if require-permission-for-commands is set to true This permission allows you to use /hideitem hide

hideitem.show

Only needed if require-permission-for-commands is set to true This permission allows you to use /hideitem hide