Skip to main content

Shodan-like server scanner for Minecraft (formely mcserverscanner)

Project description

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

total lines downloads issues pull requests license release commits since release code style stars

Renaming notice!

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

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
  • Optimization
  • Scanning for pre-Netty (<1.7) servers

Installation

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

Usage

  1. Using a config file Instead of passing in arguments, you can pass the configuration file with --config argument. When no additional file name is provided, Yokkaichi will use yokkaichi.toml for the file name. When the config file name you provided doesn't exist, Yokkaichi will create an example file for you. Modify it how you like and rerun Yokkaichi. Configuration files are not forwards or backwards compatible and you will have to adjust it every major change.
  2. You can also use this script by 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).

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.4.2.tar.gz (9.9 kB view hashes)

Uploaded Source

Built Distribution

yokkaichi-1.4.2-py3-none-any.whl (10.7 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