Config‐Examples

Configuration Examples (annotated)

This page contains complete configuration examples for Proxy, Paper, and Common modules. These are ready-to-use templates — adapt to your environment.

Proxy configuration (map layout) File: plugins/EndSectorsProxy/config.json

{
  "redisHost": "127.0.0.1",
  "redisPort": 6379,
  "redisPassword": "",
  "natsUrl": "nats://127.0.0.1:4222",
  "natsConnectionName": "proxy",
  "sectors": {
    "SPAWN": {
      "spawn_1": {
        "pos1X": -200,
        "pos1Z": -200,
        "pos2X": 200,
        "pos2Z": 200,
        "type": "SPAWN",
        "world": "world"
      },
      "spawn_2": {
        "pos1X": -200,
        "pos1Z": -200,
        "pos2X": 200,
        "pos2Z": 200,
        "type": "SPAWN",
        "world": "world"
      }
    },
    "SECTOR": {
      "s1": {
        "pos1X": -200,
        "pos1Z": 200,
        "pos2X": 5000,
        "pos2Z": 5000,
        "type": "SECTOR",
        "world": "world"
      }
    },
    "NETHER": {
      "nether01": {
        "pos1X": -200,
        "pos1Z": -200,
        "pos2X": 200,
        "pos2Z": 200,
        "type": "NETHER",
        "world": "world_nether"
      }
    }
  }
}

Paper configuration (local server) File: plugins/EndSectors/config.json

{
  "currentSector" : "spawn_1",
  "scoreboardEnabled" : true,
  "redisHost" : "127.0.0.1",
  "redisPort" : 6379,
  "redisPassword" : "",
  "natsUrl" : "nats://127.0.0.1:4222",
  "natsConnectionName" : "spawn_1",
  "borderMessageDistance" : 15,
  "breakBorderDistance" : 15,
  "placeBorderDistance" : 15,
  "explosionBorderDistance" : 15,
  "bucketBorderDistance" : 15,
  "dropItemBorderDistance" : 15,
  "protectionAfterTransferMillis" : 5000,
  "transferDelayMillis" : 5000,
  "knockBorderForce" : 1.35,
  "protectionSeconds" : 5,
  "scoreboard" : { ... },
  "sectorTitles" : { ... }
}

(Scoreboards and sectorTitles are omitted here for brevity — refer to the README for exact templates or copy them verbatim.)

Common configuration (standalone) File: ./config.json (next to EndSectors-application.jar)

{
  "redisHost": "127.0.0.1",
  "redisPort": 6379,
  "redisPassword": "mySecretPassword",
  "natsUrl": "nats://127.0.0.1:4222",
  "natsConnectionName": "common-service"
}

Annotations & tips

• Use the same redisPassword and natsUrl across all three configs.
• natsConnectionName is used for tracing and is recommended to be unique per service.
• Keep pos1/pos2 coordinates consistent and inclusive. Borders require pixel-perfect alignment across neighboring sectors.
• Use descriptive sector ids (e.g., spawn_1, w1, n1) and avoid renaming sectors during runtime.

Validation checklist before go-live

• Common service starts and reports healthy.
• Proxy connects to Common and reads sectors layout.
• Each Paper sector registers with Common and appears as online.
• Player transfers tested from at least 4 border crossings.
• Redis persistence and NATS auth tested.

Next: See Messages & Localization for customizing text and translations.