Skip to content

Commit 6f51f78

Browse files
authored
Merge pull request #1 from EarthPol/GoodrichDev-patch-1
Update README.md
2 parents c09f377 + d2aafd8 commit 6f51f78

File tree

1 file changed

+1
-48
lines changed

1 file changed

+1
-48
lines changed

README.md

Lines changed: 1 addition & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1 @@
1-
# NameMC Server Like API
2-
This is a simple little plugin that retrieves the UUID list of players that have liked your Minecraft Server on NameMC
3-
4-
This plugin will pull data from *https://api.namemc.com/server/play.earthpol.com/likes* which can be configured in config.yml.
5-
6-
An example of the JSON Output from looks like this:
7-
```JSON
8-
[
9-
"1e453074-8de5-4194-8d82-70574aad18cf",
10-
"355e900b-8806-49d8-9b72-93cd37bc5612",
11-
"d550441b-5fcf-448c-a756-5fa391b89a46"
12-
]
13-
```
14-
This URL is fetched every 60 seconds, which can be configured in config.yml
15-
16-
## Configuration File (config.yml)
17-
```
18-
# Time in seconds to wait between each fetch
19-
fetch-interval: 60
20-
21-
# URL to fetch UUIDs from
22-
uuid-fetch-url: "https://api.namemc.com/server/play.earthpol.com/likes"
23-
```
24-
25-
## How to use the API
26-
Simple add the plugin.jar as a depedency to your plugin
27-
28-
Implentment the method like so:
29-
```JAVA
30-
import com.earthpol.namemc.api.UUIDFetcherAPI
31-
32-
public void useUUIDFetcherAPI() {
33-
RegisteredServiceProvider<UUIDFetcherAPI> provider = Bukkit.getServicesManager().getRegistration(UUIDFetcherAPI.class);
34-
if (provider != null) {
35-
UUIDFetcherAPI api = provider.getProvider();
36-
// Now you can call methods on the API
37-
List<UUID> uuids = api.getFetchedUUIDs();
38-
// Do something with the UUIDs...
39-
}
40-
}
41-
```
42-
43-
Now you can check against the List as many times as you want without getting rate limited by NameMC
44-
45-
## Disclaimer
46-
This plugin is not associated, sponsored or supported by NameMC, please do not bother them with support or questions about this plugin. This plugin is maintained by EarthPol who has no affiliation to NameMC or any of NameMC services.
47-
48-
Official NameMc Website: [https://namemc.com/](https://namemc.com/)
1+
# This project has moved [BitworksMC/NameMCAPI](https://github.com/BitworksMC/NameMCAPI)

0 commit comments

Comments
 (0)