Bukkit

CobraKits

Version 1.1 Released!

CobraKits is a comprehensive kit plugin for Bukkit that allows admins and players alike to create kits in-game without editing any configuration files and is managable entirely by in-game commands. All you need to do is set the kit up in your own inventory and CobraKits will take care of the rest! CobraKits supports enchants, written books, named items, potion effects, and per-kit cooldowns. It also has SuperPerms support to control who can use and manage kits and change plugin settings.

Installation

1. Drop the CobraKits.jar into your plugins folder and restart your server.
2. The plugin will generate a CobraKits folder with a kits.yml, cooldowns.yml, and config.yml file.
3. kits.yml can be edited, but please be careful! Any incorrect records will cause plugin errors.

Commands

• /ckits - This command will display usage information and offers configuration change options.
  • /ckits help [command] - Display help information for all commands, or detail a command.
  • /ckits current - Displays a list of the config options and their current values.
  • /ckits cooldown - Toggles on/off the cooldown requirement for kits.
  • /ckits duration [seconds] - Retrieves the current duration or sets it to the specified length, in seconds.
  • /ckits silent - Toggles the silent flag to be on or off by default.
  • /ckits concat - Toggles the concat flag to be on or off by default.
  • /ckits startkit +/-[kitname] - Add/remove First Time Login Kits
  • /ckits loginkit +/-[kitname] - Add/remove Login Kits
  • /ckits respawnkit +/-[kitname] - Add/remove Respawn Kits
  • /ckits updater - Toggles on/off the automatic update checker.
  • /ckits update - Attempts to update CobraKits to the latest version.
• /kit [kitname] - Replaces the player's current inventory with the specified kit.
  • -s or -silent - Does not show a message when the kit is applied.
  • -c or -concat - Add the kit to the player's inventory instead of replacing it.
  • -g or -global - If a Personal kit has the same name as a Global kit, use the Global kit.
  • /kit [kitname] [username] - Gives the requested kit to the specified player.
    • Compatible with the silent and concat flags. (The global flag is not needed as a full kitname must always be entered).
  • Using/Giving a kit to a player will remove any potion/debuff effects the player is under.
• /lkit or /kits - Lists kits that the player has permission to use.
  • /lkit # - Takes you to the specified kit list page. Works with either list command.
  • Kit List Color Code Guide:
    • Personal kits
    • Server kits
    • Global kits
    • Other Player's Kits
• /ckit [kitname] - Turns the player's current inventory into a kit. Supports these flags:
  • -cd/-cooldown [seconds] - Add a cooldown to this kit.
  • -kc/-cost [itemID:amount] - Specify a kit cost, in itemID and amount needed.
  • -p/-potions - Capture active potion effects on the player.
  • -g/-global - Create a Global kit. (requires cobrakits.createall)
  • -sk/-server - Create a Server kit. (requires cobrakits.*)
• /ukit [kitname] - Updates the kit specified to the player's current inventory. Flags:
  • -cd/-cooldown [seconds] - Update a kit's cooldown, set to 0 to clear.
  • -kc/-cost [itemID:amount] - Change kit cost, specify "clear" to reset it.
  • -p/-potions - Update potion effects, if none are active this will clear it.
• /rkit [kitname] [newname] - Renames a kit to the given new name. Supports these Flags:
  • -g/-global - Change kit owner to Global, ignores [newname]. (requires cobrakits.renameeall)
  • -sk/-server - Change kit owner to Server, ignores [newname]. (requires cobrakits.renameall)
  • To rename one of your Personal kits, you need to only specify the kit name. All other renames require owner.kitname format.
• /dkit [kitname] - Removes the specified kit from the plugin, this cannot be undone.

Permissions

All Permissions default to OP. All permissions with "all" inherit their lesser variant.

• cobrakits.* - Allows full access to all commands.
• cobrakits.[kitname] - Player can give themselves this specific kit.
• cobrakits.use - Grants the right to list and use self-made Personal kits, and Global kits.
• cobrakits.useall - Player can list and use any Personal or Global kit.
• cobrakits.give - Allows the ability to give other player's any kit.
• cobrakits.create - Grants the right to create a Personal kit.
• cobrakits.createall - Player can create Global kits directly.
• cobrakits.update - Allows the player to update their Personal kits.
• cobrakits.updateall - Grants access to update any Personal or Global kit.
• cobrakits.rename - Player can rename their own Personal kits.
• cobrakits.renameall - Grants the ability to rename any Personal or Global kit.
• cobrakits.delete - Player can delete their Personal kits.
• cobrakits.deleteall - Allows a player to delete any Personal or Global kit.
• cobrakits.cooldown.bypass - Grants the player the ability to bypass the cooldown setting.
• cobrakits.cooldown.bypass.[kitname] - Player bypasses the kit cooldown for this kit.
• cobrakits.cost.bypass - Grants the player the ability to not pay the cost.
• cobrakits.cost.bypass.[kitname] - Allows the player to not pay for this kit.
• cobrakits.sign.create - Player can create kit signs.
• cobrakits.sign.use - Allows the player to use a kit sign.
• cobrakits.sign.use.[kitname on sign] - Allows use of signs with specified kit name.
• cobrakits.login - Allows the player to receive Login kits.
• cobrakits.login.[kitname] - Player can receive specific Login kit.
• cobrakits.respawn - Allows the player to receive Respawn kits.
• cobrakits.respawn.[kitname] - Player can receive specific Respawn kit.

Kit Types

CobraKits has 3 kit types

1. Server Kits - Meant to be used on signs or for any of the login/spawn kit settings.
   1. Cannot be used directly without cobrakits.* permission.
   2. Doesn't require "Server." in name when used for signs or login/spawn kit settings.
2. Global Kits - Meant to be used for kits that most players can access.
   1. Requires cobrakits.use/useall to see and use them.
   2. Cannot be seen if the player only has cobrakits.[kitname] permissions.
   3. Does not require "Global." in name when used.
3. Personal Kits - Kits owned/created by the players.

Potion Effects

• Specifying the -p/-potions flag while running the /ckit or /ukit commands will capture the active potion effects of the player to the kit.
• The potion effect duration is calculated on the back end, so they will be granted at full duration when using the kit later.
  • If a custom potion effect length is over 8 minutes it will be preserved.
  • Effects over 1638 seconds at time of kit creation/update will register as "infinite" to the game.
• There is no way to individually specify potion effects, the potions must be active on the player when captured.
  • Custom effects can be added using the server's builtin /effect command.
• To clear potion effects, apply the kit, clear all potion effects (/effect [username] clear), and then update it and specify -p/-potion
• Potion effects are also affect by the -c/concat flag for /kit.

Kit Costs

• CobraKits supports a basic item trade system for kit costs that can be set with /ckit or /ukit.
• -kc/-cost [Material:amount] is the current syntax. Item durability is set to max, so players cannot trade in damaged items for a kit.
  • A link to the list of Material names is included in the help section for /ckit and /ukit.
• To clear a kit cost, update the kit, after applying it to yourself, and specify -kc/-cost clear

Kit Cooldowns

• Each kit in CobraKits can have it's own individual cooldown duration.
• The global cooldown setting will override individual kit cooldowns.
• Cooldowns persist through server restart and login/logout.
• The current syntax is -cd/-cooldown [seconds]
• To clear a cooldown, update the kit, after applying it to yourself, and specify -cd/-cooldown 0

Spawn Kits

CobraKits can give Player's a kit upon login or respawn. Here's how!

• First Time Login Kits - applied to a player when they first join the server.
• Login Kits - applied to a player any time they rejoin the server. (requires permissions)
• Respawn Kits - applied to a player when they respawn on death. (requires permissions)

The directions are as follows:

1. Make sure you have the correct permissions: OP or cobrakits.*
2. Fill your inventory with the items/blocks you want to give to new players.
3. Run /ckit -server [kitname]
4. For First Time kits, run /ckits startkit +[kitname] Note: Specifying the full kit name is good practice, though Server/Global kits don't require it.
5. For Login kits, run /ckits loginkit +[kitname]
6. For Respawn kits, run /ckits respawnkit +[kitname]

Now that kit you created will be granted, silently, to players joining/respawning on the server. To disable the feature, run /ckits (startkit/loginkit/respawn) clear which will clear the list.

To remove a specific kit from the list, run /ckits (startkit/loginkit/respawn) -[kitname]

Kit Signs

Creating a kit sign is a simple process and has only a few rules that you need to follow! You will need:

1. The correct permissions: OP, cobrakits.*, or cobrakits.sign.create
2. Any kit where the full name fits on one sign line, or either a Server or Global kit.
3. WorldGuard or similar plugin to protect the sign after creation.

The format for creating the signs is very simple and supports most of the /kit command functions. Place a sign and type the following on the corresponding lines:

1. [COBRAKIT] or [KIT] - Capitalization not needed, but brackets are required.
2. Leave this line blank, it will be replaced with the kit's cost, if any.
3. kitname - Must be a full kit name that fits this line. Server or Global kits work best. No brackets or any other formatting.
4. "c" and/or "s" - Here you can specify the optional concat or silent flags. As long as a "c" and/or "s" is on this line the plugin will find it.

After that is typed, create the sign. If you have everything correct the first line will turn Red, the kitname Blue, and the flags will be displayed in the format of c|s, where active options will be Gold, and inactive options will be strikeout. Any user with the cobrakits.sign.use permission will be able to use the kit sign, and it also works with the kit cooldown set in the config file, so you can prevent user's from getting kits too often.

Source Code

The source code is included in the .jar file, just open it up in a compatible archive application like 7-Zip! It is also now available on GitHub.

Feel free to submit any suggestions or problems to the tickets section or add a comment below!