Skip to main content

Shodan-like server scanner for Minecraft (formely mcserverscanner)

Project description

Yokkaichi (formely mcserverscanner) - Shodan-like server scanner for Minecraft.

Renaming notice!

This project used to be named mcserverscanner, but on 2023-01-15 it got renamed to Yokkaichi.

⚠️ WARNING - USE AT YOUR OWN RISK ⚠️

In some cases, you can get in trouble for using this software! Before using it, make sure that port scanning is legal in your region or country, and that it isn't against your network's terms of service. This software is made for educational purposes, it isn't meant to do any damage and you (the user) are the only person responsible for your actions.

Features

  • Scanning for Java and Bedrock servers
  • Masscan integration
  • IP2Location integration
  • Query integration

Planned features (not in a specific order)

  • WWW interface
  • Bot joining the servers
  • Cleaning up the code
  • Docker support

Installation

  • Easy installation (from PyPI)
pip install yokkaichi
  • Manual installation (from git)
git clone https://github.com/Oreeeee/yokkaichi
cd yokkaichi
pip install .

Usage

You can use this script by invoking python -m yokkaichi and passing in arguments in the CLI. You can get the list of availible options by invoking python -m yokkaichi -h

Using the masscan integration

You need to have masscan in your PATH, or in the same directory from which you are running this software. Make sure that the binary is named masscan (Unix) or masscan.exe (Windows).

Example

python -m yokkaichi --java --masscan --masscan-countries US CA CN -p "25560-25569,34000,19843" --ip2location-db data/IP2LOCATION-LITE-DB11.BIN --ip2location-cache --output data/servers.json

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

yokkaichi-1.2.tar.gz (8.2 kB view hashes)

Uploaded Source

Built Distribution

yokkaichi-1.2-py3-none-any.whl (8.3 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page