Skip to main content

Main Configuration

Configuration System

ServerRawler uses a folder where all configuration files are stored. The folder is named config.

If you run ServerRawler fist time, it will automatically create a config.toml file with default values in the root directory of your project. It should look like this:

config.toml
# ServerRawler configuration file
# Github: https://github.com/Cyberdolfi/ServerRawler
# Read the docs here: https://cyberdolfi.github.io/ServerRawler/docs/configuration/config

[crawler]
ips_per_iteration = 1000000
max_tasks = 0
time_between_iteration = 0

[scanner]
max_tasks = 0

[general]
max_network_tasks = 2000
ping_timeout = 3000
query_timeout = 3000
join_timeout = 3000
do_uuid_fetch = true
default_ports = [25565]

Simply, fill in the correct values for your crawling and scanning needs and save the file.

Crawler Configuration​

  • ips_per_iteration determines how many IP addresses the crawler will generate and process in each iteration.
  • max_tasks sets the maximum number of concurrent tasks the crawler will execute. Setting it to 0 will use the value from the [network] section.
  • time_between_iteration defines the cooldown time in seconds between each crawling iteration. Setting it to 0 will disable the cooldown.

Scanner Configuration​

  • max_tasks sets the maximum number of concurrent tasks the scanner will execute. Setting it to 0 will use the value from the [network] section.

Network Configuration​

  • max_network_tasks defines the maximum number of concurrent network tasks (e.g., pings, queries). Recommended values are between 1000 and 5000, and the value must be between 10 and 20000.
  • timeout sets the timeout in milliseconds for server connections. The value must be between 80 and 15000.
  • do_uuid_fetch determines whether the crawler should fetch the UUID from the players via Mojangs servers. This can provide more accurate information about the server but may increase the time.
  • default_ports is a list of default ports that the crawler will use when scanning for Minecraft servers. By default, it includes port 25565, which is the standard port for Minecraft servers. You can add more ports to this list if you want to scan for servers running on different ports.
  • ping_timeout, query_timeout, and join_timeout set the timeout in milliseconds for pinging, querying, and joining servers, respectively. The values must be between 80 and 15000.

Using a Custom Configuration File Path​

By default, ServerRawler looks for the config.toml file in the root directory of your project. If you want to use a custom path for your configuration file, you can specify it using the --config argument.