Skip to content
This repository has been archived by the owner on Sep 6, 2024. It is now read-only.

Latest commit

 

History

History
40 lines (21 loc) · 1.14 KB

README.md

File metadata and controls

40 lines (21 loc) · 1.14 KB

Minecraft Scanner

A tool that scans the Internet for open Minecraft servers

Usage

Environment variables

Important: don't forget to edit docker-compose.yml and change the volume option. By default it's set to /dev/shm/ so it shouldn't cause any chaos even if someone forgets to change it

Except the addresses all other values can be configured in .env.

To get started just rename .env.example to .env and change the values.

Docker

Simplest way to run this project is with Docker:

docker compose up

Compiling and running manualy

The easy way

This project contains hardcoded IP addresses which Go allows us to change during the compilation.

If you are running both Redis and Mongo on localhost and default port you can run make all to compile everything.

To compile only the scanner or only the worker you can run make scanner or make server respectively.

More complicated way

If you need to modify any addresses you can use the following commands for compilation:

Worker

go build -o worker worker/worker.go

Scanner

go build -o scanner main.go