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.4.tar.gz (11.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

yokkaichi-1.4.4-py3-none-any.whl (12.5 kB view details)

Uploaded Python 3

File details

Details for the file yokkaichi-1.4.4.tar.gz.

File metadata

  • Download URL: yokkaichi-1.4.4.tar.gz
  • Upload date:
  • Size: 11.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.3

File hashes

Hashes for yokkaichi-1.4.4.tar.gz
Algorithm Hash digest
SHA256 e44135989528d0ddbae2d8021a2553fe7b3566f3448f20c3d1be3e6fe1681edc
MD5 a402da41edebf4abd0b30b1762b14614
BLAKE2b-256 bbf922c272aacaf82bc1c30e61c2a1e677af621821961ee14cfc4f6ccf828e39

See more details on using hashes here.

File details

Details for the file yokkaichi-1.4.4-py3-none-any.whl.

File metadata

  • Download URL: yokkaichi-1.4.4-py3-none-any.whl
  • Upload date:
  • Size: 12.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.3

File hashes

Hashes for yokkaichi-1.4.4-py3-none-any.whl
Algorithm Hash digest
SHA256 61d18b8810996d3eaf7f8a5bb6fc1ea868f5452eab93d8f142e2c794186b4c1b
MD5 9a5ba3f397d7736a8c868c8396541019
BLAKE2b-256 96a23de13dc83ff5c9b04260c807ca81260cad5501d6ff1aec4a45120c1260ce

See more details on using hashes here.

Supported by

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