Skip to content

Commit c813207

Browse files
committed
first attempt to add jitpack repository
1 parent c8c1644 commit c813207

File tree

7 files changed

+76
-85
lines changed

7 files changed

+76
-85
lines changed

api.md

Lines changed: 0 additions & 80 deletions
This file was deleted.

api_usage.md

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
<div align="center">
2+
3+
![Logo](https://i.imgur.com/nTk9ZGd.png)
4+
## RealScoreboard - Best scoreboard plugin.
5+
</div>
6+
7+
---
8+
9+
## 1. Repository
10+
11+
RealScoreboard API is hosted on jitpack.
12+
13+
* Maven
14+
```xml
15+
<repository>
16+
<id>jitpack.io</id>
17+
<url>https://jitpack.io</url>
18+
</repository>
19+
```
20+
21+
* Gradle (Groovy)
22+
```groovy
23+
maven { url 'https://jitpack.io' }
24+
```
25+
26+
## 2. Dependency
27+
28+
Only API module should be used. Available versions can be found on [Jitpack page](https://jitpack.io/#joserodpt/RealScoreboard).
29+
If you need access to internals you need to add plugin dependency yourself or use reflections.
30+
31+
* Maven
32+
```xml
33+
<dependency>
34+
<groupId>com.github.joserodpt</groupId>
35+
<artifactId>realscoreboard-api</artifactId>
36+
<version>VERSION</version>
37+
</dependency>
38+
```
39+
40+
* Gradle (Groovy)
41+
```groovy
42+
implementation 'com.github.joserodpt:realscoreboard-api:VERSION'
43+
```
44+
45+
## 3. Usage
46+
47+
You can obtain the API instance like this:
48+
```java
49+
final var api = RealScoreboardAPI.getInstance();
50+
```
51+
52+
From there you can access different managers and classes.
53+
These are visible as interfaces or abstract classes, so you can only use the exposed methods.
54+
55+
Here is example usage:
56+
57+
```java
58+
final var databaseManager = this.scoreboardAPI.getDatabaseManager(); // Getting DatabaseManager
59+
final var playerData = databaseManager.getPlayerData(player.getUniqueId()); // Getting player data from DatabaseManager
60+
playerData.setScoreboardON(false); // Disabling scoreboard for player
61+
databaseManager.savePlayerData(playerData, true); // Saving changes (asynchronously) to database
62+
```
63+
64+
----
65+
66+
## Links
67+
* [SpigotMC](https://www.spigotmc.org/resources/realscoreboard-1-13-to-1-19-2.22928/)
68+
* [Discord Server](https://discord.gg/t7gfnYZKy8)
69+
* [bStats](https://bstats.org/plugin/bukkit/RealScoreboard/10080)

jitpack.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
jdk:
2+
- openjdk14

pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
55
<modelVersion>4.0.0</modelVersion>
66

7-
<groupId>joserodpt.realscoreboard</groupId>
7+
<groupId>com.github.joserodpt</groupId>
88
<artifactId>realscoreboard-parent</artifactId>
99
<version>1.5.7</version>
1010
<packaging>pom</packaging>

realscoreboard-api/pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<modelVersion>4.0.0</modelVersion>
66

77
<parent>
8-
<groupId>joserodpt.realscoreboard</groupId>
8+
<groupId>com.github.joserodpt</groupId>
99
<artifactId>realscoreboard-parent</artifactId>
1010
<version>1.5.7</version>
1111
<relativePath>../pom.xml</relativePath>

realscoreboard-plugin/pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<modelVersion>4.0.0</modelVersion>
66

77
<parent>
8-
<groupId>joserodpt.realscoreboard</groupId>
8+
<groupId>com.github.joserodpt</groupId>
99
<artifactId>realscoreboard-parent</artifactId>
1010
<version>1.5.7</version>
1111
<relativePath>../pom.xml</relativePath>

realscoreboard-plugin/src/main/resources/config.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#✦------------------------------------------------------✦
22
#| Main Config |
33
#✦------------------------------------------------------✦
4-
# RealScoreboard created by joserodpt and maintained by Neziw
4+
# RealScoreboard created by joserodpt
55
#
66
# Conditions: custom defined conditions that show when a condition is met or not.
77
# > Example: '%xp% > 3' - This will check if the player has more than 3 XP.
@@ -17,7 +17,7 @@
1717
# > Single Color: {#69ffde}
1818
# > Gradient: {#ffffff>}Gradient!{#00aeff<}
1919
# > Generate Gradients here: https://rgb.birdflop.com/
20-
# API for Developers: https://github.com/joserodpt/RealScoreboard/blob/master/api.md
20+
# API for Developers: https://github.com/joserodpt/RealScoreboard/blob/master/api_usage.md
2121
Debug: false
2222
Config:
2323
Prefix: '&fReal&dScoreboard &7| &r'

0 commit comments

Comments
 (0)