41 lines
1.6 KiB
Markdown
41 lines
1.6 KiB
Markdown
# Ping Server
|
|
|
|
|
|
|
|
|
|
|
|
The status retrieval/ping server that powers the API for mcstatus.io. This repository is open source to allow developers to run their own Minecraft server status API server.
|
|
|
|
If you do not know what you are doing, or think that the cache durations enforced on our official website are tolerable, I would highly recommend using the official API instead. It is much more reliable and reduces the complexity of hosting it yourself.
|
|
|
|
## API Documentation
|
|
|
|
https://mcstatus.io/docs
|
|
|
|
## Prerequisites
|
|
|
|
- [Git](https://git-scm.com/)
|
|
- [Go](https://go.dev/)
|
|
- [Redis](https://redis.io/) (optional)
|
|
- [GNU Make](https://www.gnu.org/software/make/) (optional)
|
|
|
|
## Installation
|
|
|
|
1. Clone the repository to a folder
|
|
- `git clone https://github.com/mcstatus-io/ping-server.git`
|
|
2. Move the working directory into the folder
|
|
- `cd ping-server`
|
|
3. Build the executable
|
|
- Using GNU make
|
|
- `make`
|
|
- Without GNU make
|
|
- `go build -o .\bin\main.exe .\src\*.go` (Windows)
|
|
- `go build -o bin/main src/*.go` (Linux/macOS)
|
|
4. Copy the `config.example.yml` file to `config.yml` and edit the details
|
|
5. Start the API server
|
|
- `.\bin\main.exe` (Windows)
|
|
- `bin/main` (Linux/macOS)
|
|
|
|
## License
|
|
|
|
[MIT License](https://github.com/mcstatus-io/ping-server/blob/main/LICENSE) |