Configuration

In this document, we will explain what every field in config.yml file means, and how to configure that.

Cache Clear Interval

In this field, you can specify how long player verification will be valid.

cache-clear-interval: 300

Verification Procedure Timeout

In this field, you can specify how many times a player has to complete verification procedure.

verification-procedure-timeout: 60

Verification Challenge Pool

In this field, you can add, remove or modify an interactive challenge in pool.

verification-challenge-pool:
  - type: COLLECT_ITEMS
    translation: Collect {amount}x Iron Ore.
    extra:
      gather: IRON_ORE
  - type: COLLECT_ITEMS
    translation: Collect {amount}x Diamond.
    extra:
      gather: DIAMOND_ORE
  - type: COLLECT_ITEMS
    translation: Collect {amount}x Coal Ore.
    extra:
      gather: COAL_ORE
  - type: COLLECT_ITEMS
    translation: Collect {amount}x Logs.
    extra:
      gather: LOG
  - type: CLICK_BLOCK
    translation: Use anvil {times} times.
    extra:
      click: ANVIL
  - type: CLICK_BLOCK
    translation: Use crafting table {times} times.
    extra:
      click: CRAFTING_TABLE
  - type: CLICK_BLOCK
    translation: Use furnace {times} times.
    extra:
      click: FURNACE
  - type: SNEAK
    translation: Sneak {times} times.
  - type: WALK_TO
    translation: Follow particles displayed above you.
  - type: EAT_FOOD
    translation: Eat until your food bar is full.

This field is a list with own structure, you must follow them to avoid issues, you can see structure scheme bellow.

        verification-challenge-pool:
          - type: CHALLENGE
            translation: TRANSLATION
            extra: EXTRA
        

CHALLENGE must be one of COLLECT_ITEMS, CLICK_BLOCK, SNEAK, WALK_TO or EAT_FOOD.
TRANSLATION is replacement for {content} placeholder.
EXTRA is optional map with values that is used by CHALLENGE.

For COLLECT_ITEMS available is gather that must be element of Item enum.
For CLICK_BLOCK available is click that must be element of Block enum.
For WALK_TO available is red, green, blue and scale that are float for dust particle.
For EAT_FOOD extra parameters are not available.

Verification Procedure

In this field, you can create a managed procedure that will be different for each player.

verification-procedure:
  - trigger: BRAND_CHECK
  - trigger: SETTINGS_CHECK
  - trigger: GRAVITY_CHECK
    expression: onlineMode
  - trigger: CHALLENGE
    expression: '!onlineMode || !brandCheck || !settingsCheck'

This field is a list with own structure, you must follow them to avoid issues, you can see structure scheme bellow.

        verification-procedure:
          - trigger: TRIGGER
            expression: EXPRESSION
        

TRIGGER is one of available options

BRAND_CHECK is check that require client to send minecraft:brand payload.
SETTINGS_CHECK is check that require client to send packet with settings.
GRAVITY_CHECK is a basic client gravity check. (if client is falling correctly)
CHALLENGE is a most advanced check that requires interaction from a client.

EXPRESSION is boolean expression that have available parameters
- onlineMode (boolean)
- protocol (integer)
- brandCheck (boolean)
- settingsCheck (boolean)
- ping (integer)
Example Expressions:

onlineMode

!onlineMode && !brandCheck && !settingsCheck

(protocol >= 767 && !onlineMode) || !settingsCheck || !brandCheck

Analyze Addresses

In this field, you can toggle the status of checking player address using ip-api.com service.

analyze-addresses: true

Prevent Proxy Connections

In this field, you can allow or disallow connections using proxy, vpn and/or hosting addresses.

prevent-proxy-connections: true

Blocked Isp

In this field, you can put Internet Service Providers names to prevent connections from addresses that belong to specific providers.

blocked-isp: []

Blocked Countries

In this field, you can put countries from which connections will be blocked.

blocked-countries: []

Last modified: 16 November 2024