[GEN/MECH] Cooldowns v1.1 - Configurable Cooldowns and Warmups [1060]

Cooldowns v1.0.0 - Configurable command cooldowns and warmups​

Static Jar - Source​

1.1 - 1.0.1 - 1.0.0 - 0.5.0 - 0.4.2 - 0.4.0a - 0.3.0 - 0.2.2 - 0.2.1 - 0.2.0 - 0.1.0​

Issue Tracker​

Wiki​

Version 1.1 is now released!​

The plugin has gone through an insane amount of revision. I honestly didn't think the project would grow to be this large, or this complicated, but there you go. The new feature list is astounding by comparison. Version 1.0.0 requires CraftBukkit 1000, and I recommend PermissionsBukkit for managing the groups.​

In version 1.1, the config.yml has added the key "priority" to the groups nodes. As a result, you can either delete your current configurations to get the new nodes, or edit them by hand (their location is provided in the default config.yml farther down this post). The priority node will determine which group a user ends up in if more than one group is detected by the plugin (due to inheritance or whatever reason). This node is optional, but recommended. The higher a group's priority, the more likely the user is to be set to that group. Furthermore, the plugin now checks the player's group every time they log in or the plugins are reloaded.​

​

In addition to the priority node, the plugin now checks for groups at "cooldowns.[groupname]" and "group.[groupname]"​

If you have multiple plugins which use the latter format, this plugin will duplicate their functionality (provided your groups in config.yml are the same name), in an effort to reduce node clutter.​

Requirements

• CraftBukkit build 1000 (or later)

Optional (Recommended)

• PermissionsBukkit 1.2 (or later)

Want me to include your language? Send me a language.yml with (at the very least) localization information for all of the default messages, and I'll package it into the jar!

Originally requested by @GFlow in this thread

For more verbose installation/usage instructions, visit the wiki.

Description: Configurable command cooldowns and warmups, based on 'groups'.

Basic Usage: Drop Cooldowns.jar into your plugin directory, and go!

config.yml (open) config.yml (close)

Code:

plugin:
    # put the worlds you want to manage cooldowns and warmups in here
    worlds:
      - 'world'
      - 'world_nether'
    default_locale: 'en_US'
    available_locales: [en_US]
    # colors: true will enable logging in color (this will only work on non-windows platforms)
    colors: true

groups:
    # -----------------
    default:
        priority: 1
        # prefix applies to messages sent by this plugin to the player, such as status messages
        # it does not change chat settings, and should not interfere with any other plugins
        prefix: '[default] '
        interrupts:
            movement: true
            damage: true
            command: true
        globals:
            cooldowns: true
            warmups: true
        # _all_ will match all commands (for a root node), or all arguments for a sub-node
        # _self_ will match the command sender's name
        # all values specified are in seconds.
        commands:
            warmup:
                _all_: 5
            cooldown:
                _all_: 5
    # -----------------
    user:
        priority: 2
        prefix: '[user] '
        interrupts:
            movement: true
            damage: true
            command: true
        globals:
            cooldowns: true
            warmups: true
        commands:
            warmup:
                home: 2
                warp:
                    home: 2
                    _all_: 5
            cooldown:
                home: 60
                warp:
                    home: 60
                    _all_: 120
    # -----------------
    admin:
        priority: 3
        prefix: '[admin] '
        interrupts:
            movement: false
            damage: false
            command: true
        globals:
            cooldowns: true
            warmups: true
        commands:
            warmup:
                kill: 2
                tp:
                    _self_: 2
                    _all_: 2
                time: 2
            cooldown:
                kill: 5
                tp:
                    _self_: 60
                    _all_: 120
                time: 5

Localization (open) Localization (close)

Code:

# set any value to "null" to disable it entirely.
plugin:
    enabled: "Enabled."
    disabled: "Disabled."
    language: "American English"
    locale_not_found: "No such locale exists."
    locale_changed: "Language changed to American English."
    help:
      - '&b/<cmd> help &f- &aDisplays this help menu.'
      - '&b/<cmd> loc [option] &f- &aSets your locale to'
      - '--- &athe option provided, or lists available locales.'
      - '&b/<cmd> setup &f- &aShows your settings.'
      - '&b/<cmd> &f- &aLists your current cooldowns.'
    setup:
      - 'Your settings: (American English)'
      - '&aGlobals&f:'
      - '-- Warmups... &a<global_warm>'
      - '-- Cooldowns... &a<global_cool>'
      - '&aInterrupts&f:'
      - '-- Movement... &a<movement>'
      - '-- Commands... &a<commands>'
      - '-- Damage... &a<damage> &f(&cnot implemented&f)'

# set any _generic_ key to null to disable it
# ------- #
# warmups #
# ------- #
warmup:
    start:
        _generic_: "'&b<cmd>&f' is now warming up. (&b<wu>&f)"
    status:
        _generic_: "'&b<cmd>&f' is warming up. (&b<wu>&f)"
    done:
        _generic_: "You are no longer warming up '&b<cmd>&f'."
    cancel:
        _generic_: "&cYou cancelled '&3<cmd>&c'..."
        _movement_: "&cYou moved and cancelled '&3<cmd>&c'..."
        _damage_: "&cYou took damage, which cancelled '&3<cmd>&c'..."

# --------- #
# cooldowns #
# --------- #
cooldown:
    start:
        _generic_: null
        # "'&b<cmd>&f' is now cooling down. (&b<cd>&f)"
    status:
        _generic_: "'&b<cmd>&f' is cooling down. (&b<cd>&f)"
    done:
        _generic_: "You are ready to use '&b<cmd>&f' again."

Permissions (open) Permissions (close)

Permissions flags are equivalent to the group names you set in the config.yml, plus the "cooldowns." prefix. By default, the permissions are as follows:
cooldowns.default - Applies the configuration settings for the default group.
cooldowns.users - Applies the configuration settings for the users group.
cooldowns.admins - Applies the configuration settings for the admins group.

Furthermore, if you use PermissionsBukkit and rely on inheritance, you'll need to cancel the previous group's permission:

Code:

groups:
    default:
        permissions:
            cooldowns.default: true
    user:
        permissions:
            cooldowns.users: true
            cooldowns.default: false
        inheritance:
        - default
    admin:
        permissions:
            cooldowns.admins: true
            cooldowns.users: false
        inheritance:
        - user

Screenshots (open) Screenshots (close)

Commands:

• /cooldowns - Without any parameters will print a list of currently cooling commands.
• /cooldowns locale [option] - The option flag will attempt to set that user's locale to the option he provides. If no option is provided, it will print a list of localizations available.
• /cooldowns setup - Show the settings for the user who sends the command
• /cooldowns help - Prints a brief help message detailing the above information.
• /cd and /cooldown are both aliases for /cooldowns, and will work interchangeably.

Features:

• Completely configurable warmups, including being able to cancel commands by taking damage, moving, or issuing another command.
• Configurable cooldowns, including global and local cooldowns, that persist across server restarts and reloads.
• Localizations, including options inside the localization to configure messages for commands my plugin doesn't know about.

Issues: v1.0.0 is newly released. I haven't yet found bugs.
Feedback and error reports are very helpful. Be thorough when you tell me what's wrong! This includes your server.log, lists of plugins (and their versions), which build of craftbukkit you are running, any modifications you've made to the configuration, plus any other information you feel is relevant. More information = faster bug fixes!

Changelog:
Version 1.0.0:

• Complete rework of the project, from the ground up
• Includes both local and global warmups and cooldowns
• More configuration, more stability, more power
• Verbose localizations, including custom status messages per command

Version 0.5.0:

• Massive restructuring of the plugin, which included moving it to Maven.
• The configuration file has dropped in complexity, yet offers most of the same functionality.
• Local cooldowns are simply not realistic. As such, I've made commands local in the sense that only commands listed for the user in my configuration will be cooled or warmed.
• All cooldowns are global. If a command has a 10 second cooldown, all commands [registered to my plugin] are unusable for 10 seconds.
• Removed the ability to cancel warmups by moving. If I find some way to easily configure options for this, I'll add it back in.

Changelog (~0.4.0a) (open) Changelog (~0.4.0a) (close)

Version 0.4.0a:

• Localizations for every conceivable command variation
• Warm ups and cooldowns can be interrupted by damage, and can work on different timers
• Won't claim anything outlandish like it's stable, as this is a massive amount of work and I can't really test it all on my own.
• Hopefully you're satisfied!

Version 0.3.0a:

• Restructured plugin
• Added command (/cooldowns)
• Increased localization
• Warmups and cast times are even more configurable(?)

Version 0.2.2:

• Added warm up periods
• General cleanup
• New class to parse messages contained in locale files
• TODO
• 1. Warm up reset on player damage
  2. Warm up reset when player types a new command

Version 0.2.1:

• Added Localizations
• Fixed cooldown messages
• Added users.yml for persistent localization per user
• TODO
• 1. Hook permissions for localizations?
  2. Warm up/cast times for commands
  3. Configurable warm up/cast times on player damage

Version 0.2.0:

• Added Block cooldowns
• Changed config format
• More comments

Version 0.1.0:

• Initial release

 

I need this:
There is warp command and everytime user uses /warp something, it will warm up for 5seconds.
But i need different cooldowns for different warps. For example /warp arena will be on 5m cooldown, but users can still use /warp dungeon that is on 15m cooldown and when they use it, there will be cooldown 15m for only /warp dungeon and not all other commands.

 

So how do warmups work then?

If I set /spawn to a warmup of 10,

Code:

groups:
  default:
    prefix: 'etc'
    commands:
      warmup:
        spawn: 10
      cooldown:
    blocks:
   

will all commands issued have a warmup of 10?

EDIT: Oh it helps to read. In the code above only spawn would have a warmup because its the only command mapped to that group. Ok, but what if I had /spawn set to 10 and /f home set to 4?

Code:

groups:
  default:
    prefix: 'ect'
    commands:
      warmup:
        spawn: 10
        f:
          home: 4
      cooldown:
   blocks:

I guess my question is, What is a global warmup and how is handled?

 

Code:

groups:
  default:
    prefix: ''
    commands:
      warmup:
      cooldown:
    blocks:
  Users:
    prefix: ''
    commands:
      warmup:
       spawn: 10
       home:
        _all_: 10
      cooldown:
    blocks:
  Admins:
    commands:
      warmup:
      cooldown:
    blocks:

This is how my config looks. I want the users on my server to get the warm up times, but it doesn't work for them. It's still an instant teleport. I would put it in default (cause it works in that one) but i don't want the admins to have the warmup times.

Code:

L337haxonator:
    locale: en_US
    group: Users
    recurring: false
GFlow:
    locale: en_US
    group: Admins
    recurring: false
irnoobsauce:
    locale: en_US
    group: Users
    recurring: false
Cheese:
    locale: en_US
    group: Users
    recurring: false
piecheese:
    locale: en_US
    group: Users
    recurring: false

Here is an example of my users.yml file. So, they are in the group "Users", but it doesn't work. What am I doing wrong?

 

@MarchingSpartan - Due to the complex nature of handling things on a micro-management scale (for example, being able to issue separate warmups to separate commands for separate users), each user will issue a command, warm up, and during that time be unable to issue other commands. The only thing that will happen is that your command will be lost, and you'll have to begin the warmup sequence again.

@GFlow - As for the command /home, if you want to issue cooldowns to the entire command, simply set "home: 10"

Subkeys aren't needed unless you want to issue separate warmups/cooldowns for the same command with different arguments.

Code:

warmups:
  home: 5
  warp:
    spawn: 5
    _all_: 10

This would issue a warmup of 5 seconds for '/home', as well as '/warp spawn', and all other /warp commands would have a 10 second warmup.

@Boos - While typing this response, I had a brief flare of inspiration, and might have a way to do this with [little impact on] efficiency. I'll attempt it, and if it proves to be stable without breaking things, I'll release it as 0.5.1.

I apologize for the complexity of the config, I simply can't think of any way to make it more understandable. :(

 

@krinsdeath - If someone would want to use /home, it is 10 seconds. If someone wanted to use /home gflow to go to my house for example, then is my config correct for that? And also, my major question is: Why doesn't it work? nothing is happening to my players when they use these commands.

 

My only guess is that you haven't added the appropriate permissions flags in your permissions.yml, or you're using PermissionsBukkit and haven't added flags for that.

For permissions.yml: (which requires no permissions handler)

Code:

default:
    default: true
    children:
         cooldowns.default: true
admins:
    default: op
    children:
        cooldowns.default: false
        cooldowns.admins: true

If you're using PermissionsBukkit, I gave examples of how to set it up in the first post (under Permissions)

If you're using Permissions 3.x/2.x/PEX/GM, you might consider moving to the new [bukkit] permissions, as I suspect most developers will be moving to them soon.

it works! (open) it works! (close)

Code:

plugin:
  # put the worlds you want to manage cooldowns and warmups in here
  worlds:
    - 'world'
    - 'world_nether'
  # enter the desired log prefix here (note: a default prefix is used for the initial startup)
  # <fullname> will evaluate to Cooldowns v<version>
  prefix: '[<fullname>] '
  default_locale: 'en_US'
  available_locales: [en_US]
  # colors: true will enable logging in color (this will only work on non-windows platforms)
  colors: true
  # block_limiter: true will enable a block placement cooldown
  block_limiter: false

groups:
  # Due to the complexity of micro-managing cooldowns and warmups, I'm offering a temporary
  # solution, wherein only commands managed by my plugin are warmed or cooled, and all warmups
  # and cooldowns thereof are global
  default:
    # prefix applies to messages sent by this plugin to the player, such as status messages
    # it does not change chat settings, and should not interfere with any other plugins
    prefix: '[default] '
    commands:
      warmup:
        # all values specified are in seconds
        # I'm also providing a few convenience keys, such as _all_
        # _all_ matches all commands, and applies the warmup/cooldown specified
        # _self_ matches the command sender's name, which could be used for limiting /give (as an example)
        _all_: 5
      cooldown:
        _all_: 5
    blocks:
      _all_: 5
  users:
    prefix: '[user] '
    commands:
      warmup:
        home: 
          _all_: 2
        warp:
          # you may specify the first argument of the command, and it will apply cooldowns
          # to only arguments that have been set in this config
          home: 2
          _all_: 2
      cooldown:
        home: 60
        warp:
          home: 60
          _all_: 120
      # blocks can contain any material you see fit to limit, but will only apply if block_limiter is true
    blocks:
      obsidian: 2
  admins:
    prefix: '[admin] '
    commands:
      warmup:
        home:
          _all_: 2
        kill: 2
        tp:
          _self_: 2
          _all_: 2
        time: 2
      cooldown:
        kill: 5
        tp:
          _self_: 60
          _all_: 120
        time: 5
    blocks:

I am in the 'admins' group.

 

@krinsdeath - Thanks! and i just made a switch to the new built in permissions.

 

Cool thanks, I just didn't understand how warmups were handled.

 

@krinsdeath - Thank you for your time, but i made my own plugin for cooldowns, which supports what i needed and much more! Cooldowns are not deleted, even if server is restarted or reloaded. And it has nearly zero performance impact and much easier config. It does not support different CDs for different groups thou. I will post it soon here on forums.

 

Your plugin is case sensitive so I had to do this :/

Code:

groups:
  default:
    prefix: ''
    commands:
      warmup:
        f:
          home: 30
          Home: 30
          hOme: 30
          hoMe: 30
          homE: 30
          HOme: 30
          HoMe: 30
          HomE: 30
          hOMe: 30
          hOmE: 30
          HOMe: 30
          HoME: 30
          HOmE: 30
          hOME: 30
          HOME: 30
        F:
          home: 30
          Home: 30
          hOme: 30
          hoMe: 30
          homE: 30
          HOme: 30
          HoMe: 30
          HomE: 30
          hOMe: 30
          hOmE: 30
          HOMe: 30
          HoME: 30
          HOmE: 30
          hOME: 30
          HOME: 30
      cooldown:
    blocks:

 

@Magesblood - Very, very sorry about that. It's fixed, just redownload the jar.

I never capitalize anything when I use commands, so I didn't even think about that.

 

Hi
nice plugin, will test it tonight.
All the cooldown and warmup plugins i've tried works like pain.

Would it be possible to cancel warmup if a player move or get hit?
I've seen in your changelog that you disabled the move thing. Do you plan to put it back soon?

 

I'm currently redesigning the plugin to try and get cooldowns that have different timers, and when I'm finished with that, it'll have all of the features mentioned in this thread.

Until then, this is mostly just a "stable release" that provides basic functionality.

 

Alright, everyone.

Version 1.0.0! Took me a long time, and I apologize for the delay, but it's finally ready! It adds global and local cooldowns (and warmups!), configurable settings for how interruption (via damage, movement or commands) behaves, and a powerful localization engine!

Thank you for your patience, and hopefully ~someone~ still uses this plugin!

 

I haven't tried the versions before v1 before (I only recently discovered cooldowns), but when my players log on, maybe even if they're not moving, I get huge amounts of this error in the server window:

Code:

2011-08-02 12:56:39 [SEVERE] Could not pass event PLAYER_MOVE to Cooldowns
java.lang.NullPointerException
    at net.krinsoft.cooldowns.player.WarmPlayer.setInterrupts(WarmPlayer.java:113)
    at net.krinsoft.cooldowns.player.WarmPlayer.<init>(WarmPlayer.java:107)
    at net.krinsoft.cooldowns.player.PlayerManager.addPlayer(PlayerManager.java:67)
    at net.krinsoft.cooldowns.listeners.PlayerListener.onPlayerMove(PlayerListener.java:81)
    at org.bukkit.plugin.java.JavaPluginLoader$7.execute(JavaPluginLoader.java:286)
    at org.bukkit.plugin.RegisteredListener.callEvent(RegisteredListener.java:58)
    at org.bukkit.plugin.SimplePluginManager.callEvent(SimplePluginManager.java:332)
    at net.minecraft.server.NetServerHandler.a(NetServerHandler.java:164)
    at net.minecraft.server.Packet10Flying.a(SourceFile:126)
    at net.minecraft.server.NetworkManager.b(NetworkManager.java:226)
    at net.minecraft.server.NetServerHandler.a(NetServerHandler.java:85)
    at net.minecraft.server.NetworkListenThread.a(SourceFile:105)
    at net.minecraft.server.MinecraftServer.h(MinecraftServer.java:451)
    at net.minecraft.server.MinecraftServer.run(MinecraftServer.java:361)
    at net.minecraft.server.ThreadServerApplication.run(SourceFile:422)

That kind of message just keeps being sent, rapidly, over and over again, and happens so quickly I can't see any other message. It's not just with movement though, I've seen it happen with the event 'PLAYER_JOIN' as well.

I don't know what's causing it, I seem to have my config set up well. I will say that I'm not using PermissionsBukkit, but Yeti's Permissions 3.1.6 system instead though, so that may be a contributing factor.

If you wish to know, I can also send in a list of my other plugins.

EDIT: Almost forgot to mention, the messages don't seem to actually stop users from doing anything, but I'm not entirely sure Cooldowns actually works, but I can do further testing to check it.

 

@louis058 - That error is happening because it's unable to find a node at "groups.[somegroup].interrupts" for whatever reason. My guess is that you made a custom group and didn't include the interrupts section. Can I get a look at your config.yml?

edit: The plugin won't work with non-Superpermission systems, since it doesn't hook any permissions APIs (it uses Bukkit's internal permissions). Since I didn't define any defaults for permissions, if users ~don't~ have a group it might be what's causing it to throw errors.

My plugin does default users to the "default" group (provided no group is found), though, so you may be able to fix the issue by re-adding a group called default with everything set to false (in the event that you don't wish users in the default group to have managed warmups/cooldowns).

 

That's fine. I was planning to switch to PermissionsBukkit eventually anyway. Thanks for the quick reply!

 

Im having an issue where commands wont work if one command is on a cooldown. I have spawn and home with a 15 second warmup, and i have spawn with a 300 second cooldown, and home with a 1800 second cooldown. But when either one of them is on cooldown, you cant use the other command. Is that intentional?

 

In config.yml for the groups you want to do this, set group.name.globals.cooldowns: false, and it'll manage cooldowns separately.

Code:

groups:
  users:
    ...
    globals:
      cooldowns: false
      warmups: true
    ...

 

Code:

groups:
    # -----------------
    default:
        prefix: '[default] '
        interrupts:
            movement: true
            damage: true
            command: true
        globals:
            cooldowns: false
            warmups: false
        commands:
            warmup:
                home: 15
                spawn: 15
            cooldown:
                home: 1800
                spawn: 300

I am having issues with this one. At the moment they both have the 15 second warmup, but i have home which is on its cooldown and seems to be working properly, but whenever i do spawn, it will say 14 seconds for cooldown, or 200, or random numbers, and even though its giving the wrong cooldown for spawn, it's also letting me still use spawn command all over again.

i just randomly got 141 warmup for spawn and then 118 when i did it again while it was still on that cooldown lol.

What im thinking is that when theres one cooldown already happening, it records the second commands cooldown, but doesnt prevent the command. I will wait 15 seconds and the second command with a cooldown will go through even though it's on a cooldown, and the plugin doesnt recognize that it just used the command again. Because i just removed both cooldowns, then tried it again, and spawn gave me a 300 second cooldown when home was already on a cooldown and not working anymore. But when i did spawn again, i waited 15 seconds plus the gap between when i used it the first time and typed the command in again, and ended up getting like 270 seconds, so it was counting it down, just not stopping the command from going through.

EDIT by Moderator: merged posts, please use the edit button instead of double posting.

 

@Monkz - Honestly? No idea. I just tried it locally, and [almost] everything works. Commands don't warm up separately yet (only one command can "warm up" at a time), but alternating cooldowns work perfectly. I also don't see anything immediately wrong with the config..

To get things straight:

It allows you to type /spawn, which sets a 15 second warmup. After which, the command executes successfully (you teleport to spawn). Immediately following this, you issue ~another~ /spawn, and it executes immediately (bypassing the cooldown)?

Which /home and /spawn plugin are you using? I'll test them myself.

 

Im using essentials 2.5 i think

I do think its properly giving the cooldown but not blocking spawn from going through when people reuse it. But home seems to work fine.

EDIT by Moderator: merged posts, please use the edit button instead of double posting.

 

@Monkz - Rofl. I cannot believe this was the problem. I had a return in the wrong place.

Oh well. Version 1.0.1 contains the fix! Sorry about that.

 

Glad i was able to point it out! Thank you for the quick fix!

That should put the person in the admin category for cooldowns, but i still get default times. Did i do something wrong here?

Code:

permissions:
        - '*'
        - -bCoolDown.exception
        - PvPable.enable
        - minecraft.save-all
        - bukkit.reload
        - -backstab.stab
        - vanish.*
        - cooldowns.admins: true
        - cooldowns.default: false
        - cooldowns.users: false

EDIT by Moderator: merged posts, please use the edit button instead of double posting.

 

This plugin won't work with legacy permissions, you need a Superperms manager (like PermissionsBukkit or bPermissions) to access the additional groups.

The plugin will default users to "cooldowns.default" if no (compatible) permissions manager is found.

 

So PermissionsEX which uses Permissions from 2.x and 3.x and bukkit permissions isnt compatible?

 

Just took a look at the PermissionsEx configuration; You can enable the groups just like any other flag, just don't put the ": true" bit

Code:

groups:
  default:
    default: true
    permissions:
    - cooldowns.default
  users:
    default: false
    permissions:
    - cooldowns.users
  ...

 

And /spawn isnt working for any of my users now at all with the update. it will just go straight to the cooldown and skip the whole teleport process now.

And one more thing i noticed, is that breaking blocks and digging down a hole while waiting for the warmup doesnt interrupt the channel.

 

Can I see your full config.yml? I'm not getting any issues now (except that I don't have /home and /spawn, I'm testing with other commands), and you're not saying anything about errors. It must be a config issue.

 

I found out /spawn as a command stopped working, so i fixed that so i assume it will work now. Commands like Home did work so i believe it was my end.

And to make sure i have it right, if users inherited permissions from default, i need to make sure the users permissions would be this?

Code:

  users:
    default: false
    permissions:
    - -cooldowns.default
    - cooldowns.users
  ...

EDIT by Moderator: merged posts, please use the edit button instead of double posting.