Skip to content

Commit 79def07

Browse files
committed
update README.md to include repo
1 parent 3ffff38 commit 79def07

1 file changed

Lines changed: 33 additions & 58 deletions

File tree

README.md

Lines changed: 33 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -5,87 +5,62 @@
55
![stars](https://img.shields.io/github/stars/VertrauterDavid/EventCore?style=for-the-badge)
66
![forks](https://img.shields.io/github/forks/VertrauterDavid/EventCore?style=for-the-badge)
77

8-
<hr>
8+
---
99

1010
## Installation
11-
1. Download jar from [here](https://github.com/VertrauterDavid/EventCore/releases/latest)
11+
1. Download jar from [here](https://github.com/DavidArchive/EventCore/releases/latest)
1212
2. Put the jar in your plugins folder
1313
3. Restart your server (not reload)
1414

1515
## Update
16-
1. Download the new jar from [here](https://github.com/VertrauterDavid/EventCore/releases/latest)
16+
1. Download the new jar from [here](https://github.com/DavidArchive/EventCore/releases/latest)
1717
2. Replace the old jar with the new one
1818
3. Delete the old `config.yml` and restart your server
1919

20-
<hr>
21-
22-
## Future updates
23-
- Possibility to create teams (for tournaments or similar)
24-
- Integrated fast world reset system
25-
- Placeholder Support in Messages
26-
2720
---
2821

29-
## API Usage
22+
### Maven
3023

31-
### Example Listener
24+
```xml
25+
<repository>
26+
<id>allaystudios</id>
27+
<url>https://repo.allay-studios.com/public</url>
28+
</repository>
3229

33-
Here is an example of how to process a custom `KitGiveEvent`:
34-
35-
```java
36-
@EventHandler
37-
public void onKitGiven(final KitGiveEvent event) {
38-
final Player player = event.getPlayer();
39-
final String kit = event.getKitName();
40-
41-
if (player == null || kit == null) {
42-
Logger.getAnonymousLogger().warning("Kit name or Player is equal to null");
43-
return;
44-
}
45-
46-
if (kit.equalsIgnoreCase("default")) {
47-
Logger.getAnonymousLogger().warning("The kit name is equal to default");
48-
return;
49-
}
50-
51-
final String broadcastMessage = "%player% has been given the %kit% kit!"
52-
.replace("%player%", player.getName())
53-
.replace("%kit%", kit);
54-
55-
Bukkit.broadcast(Component.text(broadcastMessage).color(NamedTextColor.GREEN));
56-
}
30+
<dependency>
31+
<groupId>me.david</groupId>
32+
<artifactId>EventCore</artifactId>
33+
<version>VERSION</version>
34+
</dependency>
5735
```
5836

59-
---
60-
61-
## API Access
62-
63-
The main class `EventCoreAPI` provides the central access to essential managers and functions.
37+
### Gradle Kotlin
6438

65-
### Accessing the API Instance
66-
67-
Before using the API, ensure it is initialized:
39+
```kotlin
40+
maven {
41+
name = "allaystudios"
42+
url = uri("https://repo.allay-studios.com/releases")
43+
}
6844

69-
```java
70-
EventCoreAPI.initialize(plugin);
45+
implementation("me.david:EventCore:VERSION")
7146
```
7247

73-
To retrieve the API instance, use:
48+
Example API Usage:
7449

7550
```java
7651
EventCoreAPI api = EventCoreAPI.get();
77-
```
7852

79-
### Available Components
53+
GameManager gameManager = api.getGameManager();
54+
gameManager.start();
55+
gameManager.stop("Winner");
8056

81-
- **GameManager**
82-
Access to game management functionality.
57+
KitManager kitManager = api.getKitManager();
58+
kitManager.enable("cool kit");
59+
kitManager.give(mio);
8360

84-
- **KitManager**
85-
Manage kits (e.g., saving, loading, deleting).
86-
87-
- **MapManager**
88-
Manage maps and map-related functions.
61+
MapManager mapManager = api.getMapManager();
62+
mapManager.drop();
63+
```
8964

9065
---
9166

@@ -114,7 +89,7 @@ EventCoreAPI api = EventCoreAPI.get();
11489

11590
</details>
11691

117-
<hr>
92+
---
11893

11994
<details>
12095
<summary><h3 style="display: inline;">Permissions</h3></summary>
@@ -127,7 +102,7 @@ EventCoreAPI api = EventCoreAPI.get();
127102

128103
</details>
129104

130-
<hr>
105+
---
131106

132107
<details>
133108
<summary><h3 style="display: inline;">Placeholders</h3></summary>

0 commit comments

Comments
 (0)