Ping Server

This is the source code for the API of the mcstatus.io website (api.mcstatus.io). This API server is built using Go with Fiber as the HTTP server of choice. This uses a custom Minecraft utility library found in the mcstatus-io/mcutil repository. You are free to modify and host your own copy of this server as long as the license permits. If you do not wish to self host, we host a public and free-to-use copy which you may learn more about by visiting the official API documentation.

Please note that while this repository may seem to conform to some versioning standard, it most certainly does not. Updates are pushed at random, with no semantic versioning in place. Any update (also known as a commit) may suddenly break existing configurations without notice or warranty. If you run a privately hosted ping server, please refer to the updated example configuration file before attempting to update to the latest commit.

API Documentation

https://mcstatus.io/docs

Requirements

• Go
• Redis
• GNU Make

Getting Started

# 1. Clone the repository (or download from this page)
$ git clone https://git.sumisu.xyz/csmith1865/ping-server.git

# 2. Move the working directory into the cloned repository
$ cd ping-server

# 3. Run the build script
$ make

# 4. Copy the `config.example.yml` file to `config.yml` and modify details as needed
$ cp config.example.yml config.yml

# 5. Start the development server
$ ./bin/main

# The server will be listening on http://localhost:3001 (default host + port)

License

MIT License