# What is this?
This scans for MineCraft servers... really really fast!

# Getting Started
* Clone this repository somewhere.
* Run `npm install` from within this directory.

## Usage
Run `node ./scanner.js [options] --ip <ip range>`

### Example
`node ./scanner.js --ip 192.168.1.0/24 --port 25565-25569 --show-desc --min-players 1 --max-players 100 --out report.csv`

### CLI Options
* `--ip <ip>` - IP Address or Range of IP Addresses with CIDR notation (eg- 192.168.1.0/24)
* `--port <ports>` - Ports to look for minecraft servers on. (Default: `25565-25566`)
* `--show-desc` - Enable showing of server description in output.
* `--quiet` - Silence terminal output.
* `--min-players <count>` - Minimum number of players to display.
* `--max-players <count>` - Only show servers with max player count or below.
* `--out <filename>` - Output to CSV file (Can be opened as a spreadsheet in MS Office, Google Docs, etc.)

## By really fast, I mean really fast!
	# time node ./scanner.js --ip 135.148.60.0/24 --show-desc --quiet --out example.csv
	Scanning ports 25565-25566 on 135.148.60.0/24
	Scan finished!

	real    0m3.183s
	user    0m0.825s
	sys     0m0.334s
At this speed, a full /16 (123.45.0.0 - 123.45.255.255) will take about 13 and a half minutes to scan.

## Limitations
* Fails to scan more than a /16 without kicking the bucket... so you should probably stick to that or smaller ranges.
* Working on a Minecraft bot client... doesn't work though... you can see how badly it doesn't work by using `--enable-client` flag... it is totally broken. **Don't use it**.