Create README.md

This commit is contained in:
Govindas 2021-04-17 10:08:26 +03:00
parent 1e03b937b0
commit ee034405fd

33
README.md Normal file
View File

@ -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