Skip to content

Commit c627daf

Browse files
committed
readme.md file created.
1 parent 8a215c1 commit c627daf

File tree

1 file changed

+77
-0
lines changed

1 file changed

+77
-0
lines changed

readme.md

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
## ⌛ Project Essentials: CooldownAPI
2+
3+
[![](https://jitpack.io/v/projectessentials/ProjectEssentials-Cooldown.svg)](https://jitpack.io/#projectessentials/ProjectEssentials-Cooldown)
4+
![GitHub](https://img.shields.io/github/license/ProjectEssentials/ProjectEssentials-Cooldown)
5+
6+
> ## Cooldown API for Forge mod commands.
7+
8+
#### ❗ Compatibility with forge `28.0.X` version.
9+
10+
## 🧐 Install using Gradle (for developers):
11+
> ##### If your project uses Gradle as Build Tool, then use the code below to add dependencies:
12+
13+
```groovy
14+
repositories {
15+
maven { url("https://jitpack.io") }
16+
}
17+
18+
dependencies {
19+
compile(
20+
group: "com.github.projectessentials",
21+
name: "ProjectEssentials-Cooldown",
22+
version: "v1.14.4-1.0.0.0"
23+
)
24+
}
25+
```
26+
27+
## 🤔 Install using Maven (for developers):
28+
> ##### If your project uses Maven as Build Tool, then use the code below to add dependencies:
29+
30+
```xml
31+
<repositories>
32+
<repository>
33+
<id>jitpack.io</id>
34+
<url>https://jitpack.io</url>
35+
</repository>
36+
</repositories>
37+
38+
<dependency>
39+
<groupId>com.github.projectessentials</groupId>
40+
<artifactId>ProjectEssentials-Cooldown</artifactId>
41+
<version>v1.14.4-1.0.0.0</version>
42+
</dependency>
43+
```
44+
45+
## 🎮 Installation instruction (for playing):
46+
> ##### Just move Project Essentials Cooldown-1.14.4-1.X.X.X.jar to mods directory:
47+
48+
> ##### Important note: don't forget install mod dependencies!
49+
- core: https://github.com/ProjectEssentials/ProjectEssentials-Core/releases
50+
- permissions: https://github.com/ProjectEssentials/ProjectEssentials-Permissions/releases
51+
52+
```
53+
.
54+
├── assets
55+
├── config
56+
├── libraries
57+
├── mods (that's how it should be)
58+
│ ├── Project Essentials Core-MOD-1.14.4-1.X.X.X.jar.
59+
│ ├── Project Essentials Permissions-1.14.4-1.X.X.X.jar.
60+
│ └── Project Essentials Cooldown-1.14.4-1.X.X.X.jar.
61+
└── ...
62+
```
63+
64+
```
65+
Additional information:
66+
- kotlin-std lib version: 1.3.50
67+
- kotlinx serialization version: 0.12.0
68+
- target jvm version: 1.8
69+
```
70+
71+
### After you got the dependencies and the library itself:
72+
73+
# [getting started with read the documentation](./documentation/in-using.md)
74+
75+
### **Note:** this library is written in kotlin, but in java you can work with this API too, but there may be some not beautiful moments. One of these points is that you will see all the properties and fields with internal modifiers (in my library).
76+
77+
> ## Made with 💕 by [MairwunNx](https://mairwunnx.github.io/)

0 commit comments

Comments
 (0)