#
Home
A modern, small, performant, zero dependency TypeScript library made for fast pinging and getting status of Minecraft servers
#
What can this library do?
- Getting server Latency (ping)
- Getting server MOTD
- Downloading server Thumbnail (favicon)
- Viewing Server Version
- Fetching Player Count and Playerlist
- Look up SRV records
#
Getting started!
#
Requirements
- NodeJS or Deno (used to run JavaScript code)
- NPM (used to install Node packages)
#
Installation
npm install minecraftstatuspinger
#
Example
import mc from "minecraftstatuspinger";
let result = await mc.lookup({ host: "mc.hypixel.net" })
console.log(result);See what might be in the result
Advanced example!
import mc from "minecraftstatuspinger";
let result = await mc.lookup({
host: "mc.hypixel.net",
port: 25565,
ping: true,
protocolVersion: 767,
timeout: 10000,
throwOnParseError: true,
SRVLookup: true,
JSONParse: true
})
console.log(result);