slpcli

🚀 A simple C++ tool to query the Server List Ping (SLP) of a Minecraft: Java Edition (Notchian) server.

---

🔧 A naive implementation of the Server List Ping (SLP) protocol in C++ using non-boost Asio.

📦 Available on the AUR: slpcli-git

---

📌 Usage

./slpcli [OPTIONS] addr [port]


POSITIONALS:
  addr TEXT REQUIRED          Server address with optional ":port". 
  port UINT                   Port of the Minecraft server (default 25565). 

OPTIONS:
  -h,     --help              Print this help message and exit 
  -s,     --silent            Only prints the JSON or an empty string if error. 
  -a,     --address TEXT REQUIRED 
                              Server address with optional ":port". 
  -p,     --port UINT         Port of the Minecraft server (default 25565). 
  -t,     --timeout INT       The timeout in seconds at which the query is dropped 
          --protocol-version INT 
                              The protocol version that the client plans on using to connect to 
                              the server. Don't change if you don't know what it means. 

🛠️ Examples

🎯 Basic Usage

Without specifying a port (default port 25565):

./slpcli mc.hypixel.net

Specifying a port:

./slpcli 23.230.3.162:25572

Specifying a port (option 2):

./slpcli 23.230.3.162 25572

Real example for Hypixel, prettified with jq:

$ ./slpcli --silent mc.hypixel.net | jq .
{
  "version": {
    "name": "Requires MC 1.8 / 1.21",
    "protocol": 47
  },
  "players": {
    "max": 200000,
    "online": 31198,
    "sample": []
  },
  "description": "                §aHypixel Network §c[1.8-1.21]\n     §6§lSB 0.23.1 §2§lFORAGING §8§l- §e§lSUMMER EVENT",
  "favicon": "<trimmed for GitHub>"
}

🔍 Extracting Data with jq

Display the number of online players using jq:

./slpcli -s purpleprison.net | jq '.players.online'
# Output: 438

🖼️ Displaying Server Favicon

Use chained bash commands with feh to display the server favicon:

./slpcli mc.hypixel.net -s | jq .favicon -r | cut -d, -f2 | base64 -d | feh -

Save favicon as an image file:

./slpcli mc.hypixel.net -s | jq .favicon -r | cut -d, -f2 | base64 -d > favicon.png

🤫 Quiet Mode

The -s or --silent option suppresses diagnostic messages, outputting only the raw JSON payload or an empty string upon error. Useful for shell pipelines.

---

📦 Installation

Warning

The project is currently only available on Arch Linux's User Repository (AUR). On other distrubutions and OSs you'll have to manually build it or download a binary in the Releases.

You have two main ways to install slpcli on Arch Linux

1. Use your favorite AUR helper like yay or paru:

yay -S slpcli-git

2. Install directly from the PKGBUILD file

sudo pacman -S --needed git base-devel
git clone --recursive https://github.com/Urpagin/slpcli.git
cd slpcli/arch-pkg
makepkg -si

🏗️ Building

Use the provided run_debug.sh script or build manually:

Manual Build

mkdir build && cd build
cmake ..
make -j$(nproc)

(To be improved later.)

---

💻 Compatibility

Platforms

🌐 Cross-platform enabled thanks to Asio

OS	Compatibility
Linux	✅ YES
macOS	✅ YES
Windows	✅ YES

Note

⚠️ Manual build required for non-Linux/macOS platforms.

📐 C++ Version

• Requires C++23 or newer.

---

📖 Integrating SLP Code in Your C++ Project

Starting from a basic project structure:

main.cpp

int main() {
    return 0;
}

CMakeLists.txt

cmake_minimum_required(VERSION 3.24)
project(myapp)

add_executable(myapp main.cpp)

🚩 Steps

1. 📥 Clone the repository (do not omit --recursive):

git clone --recursive https://github.com/Urpagin/slpcli.git

2. 🔗 Link the library in your project's CMakeLists.txt:

cmake_minimum_required(VERSION 3.24)
project(myapp)

# Include SLP library
add_subdirectory(slpcli/libs/slp)

add_executable(myapp main.cpp)

# Link SLP library
target_link_libraries(myapp PRIVATE slp)

3. 📝 Use the library in your project:

#include <iostream>
#include "slp.h"

int main() {
    auto ping = slp("mc.hypixel.net");
    auto response = ping.query_slp();
    std::cout << response << std::endl;
    return 0;
}

4. 🏭 Build and run:

mkdir -p build && cd build
cmake ..
make -j$(nproc)
./myapp

---

⚠️ Known Issues

🔢 VarInt Handling

VarInt values are stored as int (32 bits), limiting full protocol compliance for VarInts larger than 35 bits. This limitation is intentional and acceptable for typical usage scenarios.

TODO

• Remove the small overhead of launching a new thread with std::thread by using an Asio-native solution ( see Timeouts).

• Add support for Bedrock Edition?

• Add thread-pool + async requests to check text file for online MC servers.

---

📚 References & Acknowledgments

• Minecraft Protocol

• Server List Ping Protocol

• Packet Format

• String Format

• VarInt Logic

• ASIO library for socket programming

• CLI11 for CLI parsing