https://github.com/isebasus/compass
A lightweight minecraft server status API written in Kotlin. WIP
https://github.com/isebasus/compass
kotlin minecraft mongodb netty spring-boot
Last synced: 5 months ago
JSON representation
A lightweight minecraft server status API written in Kotlin. WIP
- Host: GitHub
- URL: https://github.com/isebasus/compass
- Owner: isebasus
- Created: 2022-09-04T20:47:13.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2022-10-04T19:14:30.000Z (over 3 years ago)
- Last Synced: 2025-01-17T08:15:42.954Z (about 1 year ago)
- Topics: kotlin, minecraft, mongodb, netty, spring-boot
- Language: Kotlin
- Homepage:
- Size: 142 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 📜️ Compass [](https://github.com/isebasus/Archive/blob/master/LICENSE)
A silly lightweight Minecraft server API used for server statuses.
# API Calls
The following describes Compass's API calls.
### Initialization
This API call is used to initialize a server to the API, so that way calls to ping can be cached.
``/v1/init``
##### Response
```
hostname: String,
port: Int,
protocolVersion: Int,
serverVersion: String,
maxPlayerCount: Int,
playerCount: List,
description: String,
favicon: String,
ping: Long,
averagePing: List,
numberOfPings: Long,
status: ServerError
lastClientPing: Long
```
### Ping
This API call is used after initialization, and the call will now use the API cache. The response will also contain a smaller payload.
``/v1/ping``
##### Response
```
playerCount: List,
ping: Long,
averagePing: List,
numberOfPings: Long,
status: ServerError
```