Skip to content

Commit dff7526

Browse files
committed
feat(config)!: update config values
1 parent 5c19fbb commit dff7526

1 file changed

Lines changed: 13 additions & 12 deletions

File tree

docs/docs/configuration/config.mdx

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -19,35 +19,36 @@ It should look like this:
1919
[crawler]
2020
ips_per_iteration = 1000000
2121
max_tasks = 0
22-
runs = 0
23-
time_between_runs = 0
24-
default_ports = [25565]
22+
time_between_iteration = 0
2523

2624
[scanner]
2725
max_tasks = 0
28-
default_ports = [25565]
2926

30-
[network]
31-
max_tasks = 2000
32-
timeout = 3000
27+
[general]
28+
max_network_tasks = 2000
29+
ping_timeout = 3000
30+
query_timeout = 3000
31+
join_timeout = 3000
32+
do_uuid_fetch = true
33+
default_ports = [25565]
3334
```
3435

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

3738
### Crawler Configuration
3839
- `ips_per_iteration` determines how many IP addresses the crawler will generate and process in each iteration.
3940
- `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.
40-
- `runs` specifies how many iterations the crawler will perform. Setting it to 0 will run the crawler indefinitely.
41-
- `time_between_runs` defines the cooldown time in seconds between each crawling iteration. Setting it to 0 will disable the cooldown.
42-
- `default_ports` is a list of Minecraft server ports that the crawler will scan by default.
41+
- `time_between_iteration` defines the cooldown time in seconds between each crawling iteration. Setting it to 0 will disable the cooldown.
4342

4443
### Scanner Configuration
4544
- `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.
46-
- `default_ports` is a list of Minecraft server ports that the scanner will scan by default.
4745

4846
### Network Configuration
49-
- `max_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.
47+
- `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.
5048
- `timeout` sets the timeout in milliseconds for server connections. The value must be between 80 and 15000.
49+
- `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.
50+
- `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.
51+
- `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.
5152

5253
### Using a Custom Configuration File Path
5354

0 commit comments

Comments
 (0)