Skip to content

About

The public code for a Discord bot that searches through data collected from Minecraft server scanning (you can try it out here: https://discord.gg/Uy9m5TP5na).

Topics

Resources

Stars

50 stars

Watchers

4 watching

Forks

Repository files navigation

Minecraft Server Scanner

Minecraft Server Scanner Logo

Discord Buy Me A Coffee Node.js

📝 About

This bot doesn't do the scanning itself, it just searches through servers from my database, which is actively collected by a separate scanning program. The scanning is done in two main parts: first, the discovery scanner scans (almost) every IPv4 address to find Minecraft servers, which takes a few days. It checks for Minecraft servers by using Java Edition's Server List Ping (SLP) protocol and Bedrock Edition's RakNet Unconnected Ping Protocol, which is how Minecraft clients fetch data from servers to display in the multiplayer menu (e.g. player count, favicon, etc.). Those results are sent to a rescanner, which constantly scans back over the results to get updated info to save to a database. Some data isn't provided in the SLP response, so multiple different rescans are needed. For example, an extra scan is run once a day to check if Java Edition servers require account authentication, and an entirely separate scanner is run in parallel to check for whitelists.

If you find any bugs, please report them in the official Discord server.

You can contact me via Discord: cornbread2100

💻 Usage

Command Description Arguments
/help Shows the bot's list of commands None
/stats Sends some stats about the bot None
/random Fetches a random online Java Edition server None
/ping Fetches info from a given Java Edition server ip (required), port (optional, defaults to 25565)
/bedrockping Fetches info from a given Bedrock Edition server ip (required), port (optional, defaults to 19132)
/search Searches the database for a Java Edition server with specific properties minimal (true/false), sort (autocomplete), page (integer), playercount (range), playercap (integer), isfull (true/false), player (player name), uuid (player uuid), playerhistory (player name), uuidhistory (player uuid), version (text), hasimage (true/false), description (text), hasplayerlist (true/false), seenafter (unix timestamp), iprange (ip subnet), port (integer), country (text), org (text), cracked (true/false), whitelist (true/false), vanilla (true/false)
/bedrocksearch Searches the database for a Bedrock Edition server with specific properties minimal (true/false), sort (autocomplete), page (integer), playercount (range), playercap (integer), isfull (true/false), version (text), description (text), seenafter (unix timestamp), iprange (ip subnet), port (integer), gamemode (text), country (text), org (text)

🌐 Hosting the bot yourself

Important

You can try the bot on its official Discord server without hosting it yourself.

First, you'll need to install Node.js v18 or later from https://nodejs.org/. Then install all required dependencies with npm i.

⚙️ Configuration

  • Rename or copy config.template.json to config.json.
  • Create a Discord bot in the Discord Developer Portal and enter your application's client id and bot token into your config.
  • If you're also running the scanner yourself with your own database, you can host your own api and enter your api url into the api setting.
    • You can also change displayURL to make the bot use a different url in the API links exposed to users. This is useful if you have a public endpoint but internally want the bot to make a local or private connection.
  • You can also enable stats to display server counts on the bot's profile status and in the /stats command. If you aren't running your own database and api, you'll likely want to disable this as it wastes a lot of credits.
  • Once configured, run node index to start the bot. Each command should load, and "[Bot]" will be logged when it's ready.

About

The public code for a Discord bot that searches through data collected from Minecraft server scanning (you can try it out here: https://discord.gg/Uy9m5TP5na).

Topics

Resources

Stars

50 stars

Watchers

4 watching

Forks

Releases

Packages

Used by

Contributors

Languages