diff --git a/README.md b/README.md new file mode 100644 index 0000000..1977333 --- /dev/null +++ b/README.md @@ -0,0 +1,33 @@ +# Skooldown +The koolest skript addon for cooldowns + +With this addon you can create cooldowns with good performance, without worrying of deleting variables, etc. +Expired cooldowns will be automatically deleted in a very optimized way. +Everything is made with maximum performance in mind, you should be able to safely have millions of cooldowns running simultaneously. + +# Syntaxes + +Start a cooldown +``` +(create|start) [a] cooldown %string% for %timespan% + +Example: start cooldown "example%player%" for 45 seconds +``` +Stop a cooldown +``` +(reset|stop|delete|clear) cooldown %string%" + +Example: stop cooldown "example%player%" +``` +Check if cooldown is over +``` +cooldown %string% (is|has) (finished|over|done) +cooldown %string% is(n't| not) unfinished) +cooldown %string% is(n't| not) (finished|over|done) +cooldown %string% is unfinished + +Example: +cooldown "example%player%" is over +``` + +WIP