Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/loohp/mc-server-banner-api
Usage Documentation for the Minecraft Server Status Banner Generator API hosted on https://api.loohpjames.com/serverbanner.
https://github.com/loohp/mc-server-banner-api
api docs minecraft server-banners
Last synced: 29 days ago
JSON representation
Usage Documentation for the Minecraft Server Status Banner Generator API hosted on https://api.loohpjames.com/serverbanner.
- Host: GitHub
- URL: https://github.com/loohp/mc-server-banner-api
- Owner: LOOHP
- Created: 2024-05-14T21:10:35.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-05-15T01:18:22.000Z (8 months ago)
- Last Synced: 2024-10-30T05:34:34.135Z (3 months ago)
- Topics: api, docs, minecraft, server-banners
- Homepage: https://api.loohpjames.com/serverbanner.png?ip=mc.loohpjames.com&width=1224
- Size: 6.84 KB
- Stars: 8
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Minecraft Server Status Banner Generator API
https://www.spigotmc.org/resources/91843/
Usage Documentation for the Minecraft Server Status Banner Generator API.
## Implementation
This service used [InteractiveChatDiscordSrvAddon](https://github.com/LOOHP/InteractiveChat-DiscordSRV-Addon)'s ability to read and draw Minecraft assets internally. For more information on how it is done, check out the code over there.
## Usage
The generator functions by receiving HTTP GET requests through an API.
### Basic Usage
```html
https://api.loohpjames.com/serverbanner.png?ip=
```
This will create a server status banner with the default dirt background, cached for 5 minutes.
### Customization
You can add a few parameters to the query string to customize the appearance of the banner.
**Key (data type) [description]**
- **width** *(integer)* [Controls the size of the banner, defaults to 1836]
- **name** *(string)* [The top most line of text in the banner, defaults to `IP: `, if port is not 25565, `IP: :`]
- **port** *(integer)* [The port number of the server, defaults to 25565]
- **offlinemessage** *(string)* [The message to be shown when the server is unreachable, defaults to `Can't connect to server` in red]
- **backgroundurl** *(string: URL or "transparent")* [The background of the banner, defaults to none]
- **ping** *(integer)* [The ping in milliseconds used in the ping icon, defaults to 0 (5 bars)]
- **timezone** *(string: [ZondId](https://docs.oracle.com/middleware/12211/wcs/tag-ref/MISC/TimeZones.html))* [The timezone displayed in the footer]
- **dateformat** *(string: [DateFormat](https://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html))* [The date format used in the footer]
Note: It is the responsibility of the user to provide a background image with the correct dimensions
Why is the ping not measured? This is because whether the ping is good or not from my server is not useful to the end user.
## Examples
```html
https://api.loohpjames.com/serverbanner.png?ip=mc.loohpjames.com&width=1836
```
```html
https://api.loohpjames.com/serverbanner.png?ip=play.EarthMC.net&width=1836&name=Example%20Server&ping=500&backgroundurl=https://resources.loohpjames.com/spigot/serverbanner/earthmc.png
```
```html
https://api.loohpjames.com/serverbanner.png?ip=mc.twdtc.net&width=1836&name=Example%20Server&backgroundurl=https://resources.loohpjames.com/spigot/serverbanner/twdtc.png
```
```html
https://api.loohpjames.com/serverbanner.png?ip=mc-sbs.com&ping=200&width=1836
```
```html
https://api.loohpjames.com/serverbanner.png?ip=this.server.does.not.exist&width=1836&name=Unknown%20Server%20Example
```
## Partnerships
### Server Hosting
**Use the link or click the banner** below to **get a 25% discount off** your first month when buying any of their gaming servers!
It also **supports my development**, take it as an alternative way to donate while getting your very own Minecraft server as well!
*P.S. Using the link or clicking the banner rather than the code supports me more! (Costs you no extra!)*
**https://www.bisecthosting.com/loohp**
