Initial

config.yaml

@@ -0,0 +1,115 @@
+# The Minecraft editions Gate supports.
+editions:
+  # Java Minecraft edition is the first popular edition for desktops.
+  java:
+    enabled: true
+    config:
+      # The bind address to listen for Minecraft client connections.
+      bind: 0.0.0.0:25565
+      # Whether to use the proxy in online (authenticate players with Mojang API) or offline mode (not recommended).
+      onlineMode: true
+      # Registers servers with the proxy by giving the address of backend server a custom reference name.
+      servers:
+      # The list of servers to try (ordered) to connect a player to
+      # upon login or fallback when a player is kicked from a server.
+      try:
+      # Configure the response for server list pings.
+      status:
+        # The message of the day in legacy '§' format or modern text component '{"text":"...", ...}' json.
+        motd: |
+          §bA Gate Proxy
+          §bVisit ➞ §fgithub.com/minekube/gate
+        # The maximum players shown (is not the actual player limit!).
+        showMaxPlayers: 1000
+        # The server image (optimal 64x64); a path of an image file or the base64 data uri.
+        favicon: data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAAABACAYAAACqaXHeAAAABGdBTUEAALGPC/xhBQAAACBjSFJNAAB6JgAAgIQAAPoAAACA6AAAdTAAAOpgAAA6mAAAF3CculE8AAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAB3RJTUUH5AgJCgs6JBZy0AAAB+lJREFUeNrtmGuMXVUZht/LOvcz7diWklbJaKGCWKXFUiiBQjAEhRSLSCEqIKAiogRTmiriBeSiUUhjMCZe2qQxNE0EUZSCidAgYMBSLBJCDC1taAg4xaq1cz/788feZzqgocCoP2Q/f87JOXvvfOtd73dZGygpKSkpKSkpKSkpKSkpKSkpKSkpKXnzwNd7w+ULD0NEBtmQBFqQBNuICFRYwzc3bf7/E+Cyo+cgAIiEbESWJdl1WSQ5VGvWRwnk/0XgpnvfmAhrv3h+HhgFFeJCBCLw8Wt//B8XIB3ogs8umJMHAOCQvtnYtfP5eRGxVNaxMmdKgqzdWSfbIuuuocHBLa2ednx16WJcd9fvXn9EAQSQyGgBwUCMMbAvAvHfcIAOaBHnl0REY9fO56+itFHSjbI/JHuxrMWyl8r6mq27m+3WKpJ1kvjG2UtevyUtyDqK0t2UNklaLalu63+fAp9bNBdZFogsq0j6OsVVkix7L8WNkh6VLVuLlXyapKbsMUkrR4aGV9caNbRnTkWKPC0kgdpv7e7n2GgH7ant8WgiYomoX8uqUXoIwKm1Rn0wJQMAGu0mBv8xhEZPAxIhOX9W8byR4VHUGjUcf86qyaVApVrB6MgYIC4leaUsS/oLySsprQcwBgRkVW1fIfsGWVVJn29Naf8CwPYUedAjQ8OsNxuHApiHwAwAIwB2AtjaaNX/CgQAiuQM27NIhixQqqaU+mTtA9AfEUMA0JzSRERMB3BUIPoCgQjsiIg/NHuaewDg0TtvxqJlK964A6447nAE0CLwM0mnygbFGzujY19WMhD5bjgZTu6hdLekE4qduDAi1jWntIEseimuIHmBrLfJVuGAAdmbZV1t6yGnNI3kBkkLaE2zRNnDsnbLGiR1EcUHK5WKlbyc5BdkvUdSPXeAB21tln3D6PDIvdV6DQBeVYRXdYDyvHsXyYW5dd1PYoNURafTwS2/fRIAsPKU+eg96C17EVhNcavskPgCQCDCtK4RuaLY0WdlPWW7T9a7JS+RdYukpbJHip3PcoHctXUmKyMZkuBK+jTJb8tqSeqn9ICthuyFsk4kubZar50P4DeTSgHZAHAEyd6i7z9LYgcA9M6chuuXnwzLoPLWiIjbKd7ezfV8B+JIkp+gVNzPj0jaKvsQ2xtkLZI1n+TRo8Mj99QatY85+WRJ62TXJW0leb6kfZ2xzp/rzcZ8ktcUi98B4hJZD1KqyLqU5E0AZgH4EoDfA/j7GxbAuc0PpshCgJcoDiHGOxIDMZfgdACh5InFbRuJflA1kffJNsVNtXptS7GzOyJii6RFsqqkZjsZ1XqtX/aLJLPiOcOSnsuybLA1tQ2S51CcXQi/RvZ9TgaBEZA/BHAugEUAjgMwH8ADkxAgARGaULlJERGAJESWWdK1kpZJHJMUyncaFD+TZdltTumxl17oP3f2nEN6Jc0DeSmIWQAato/tVm5KjbzwVos5iONiklSlVoHtOsljKMFWJvswWSsmtHMCqBffWwCOnJwANgKxp7soWdNJNYAYcTKyTLBlSklWWK7ISnnQqgDAvMXz4pmt2z4gcRWlYwrrTsxvOC+uRBSuA0AS+8UhUqUC2XWK04tYJOmCA6R476RqgJMRgW0SB2Q1Zb+dZB+JJyQByDqUrpP0fVGZk1fSOsO5AJCNbX/cfoKsNZJmSRqguE7SJol7bH9K1umyUaz/XwSgVIzfgpMySmOSQHIUwG1FK504JXVQ9NQD7f5rLILxlKRtebvxQbLOlvWELIyOjIbkJ11JqNaqMxAxOz8cGRLzRUgflTSrsPIaklcC6NgJqZJOG0+viQIExgsrRZAqnuUBWbuKHBeAXwL46cSeHnnezwCQAXh6UqNwqiTUW80XndJ6O3X7/WVO6RxSmjKtF+3eNqq16hSSVyt5vu3udXjh2V1w8ludjPz3tKNSq3ZaU3tQrVdnyn6fnf+n4h6Nf0/dexq2VKlVIWsMwKauQQGcPSHnEcA7AawHcA+ANQAOnpQDsixDZBlk/Uj2SbZOk3WQ5B/IOhOIxyNQp3iKpJOK9naErDpJ9B15GGxvL4oWZF+i5L0A/kZruaT3jhc6KSGimwIDpMaK8fZwSStJPgLgfgB3ALgAwEIAZwEYALARQA+ACwEcUYR/RwB/4mTOAgBw43nvR6okSJoj61uyz7RV3T/Pu7uAp2ytln2LrDapiyWudUoLZK2XfbgnnAEo7bb9sKwzC6tfjyy+Um81EMAMST+XdXxeawAAzwM4EcB2AMcDuBXAgn8T8kjhgpUA+ic1CeaFMN89kNudfBGlU2V9UPZcWQ1JeyU9RvInTmk3xdmSWpSeQAC2Hpd9nqxPyjpKsmTtJLlByS+KfFqSKW4OZHAlgcBuAJdTugTAoUWcOwDsLcJ6GMAyAMsLUWYCGAWwragLGwtnYNIOAICbLz4DKe0/0R13+hI8fv+jDVlJ0miWZUOykZLHT3sUQRAUUa3X8OGrvotf3bqyRYlOaSCyLJvoIjIPpd5uoG/uO/DcMzu743i1iHOsk3U6BMffPnXPbEUdyCJigOTL3htM6jD0Sr53+VmQ07gQ432aQiBQq9cAomhdQgBo9bQg7x+eim6AyDJUm00gAikRlLCvswc9noZqT6uozvGyELvvRI5ddhUeufM7ebcgX/k+BXwNCy8pKSkpKSkpKSkpKSkpKSkpKSkpKXkz8k8RHxEbZN/8lgAAACV0RVh0ZGF0ZTpjcmVhdGUAMjAyMC0wOC0wOVQxMDoxMTo0MyswMDowMN6nNEYAAAAldEVYdGRhdGU6bW9kaWZ5ADIwMjAtMDgtMDlUMTA6MTE6NDMrMDA6MDCv+oz6AAAAAElFTkSuQmCC
+        # Whether to log ping requests in the console.
+        logPingRequests: false
+        # Whether the proxy should present itself as Forge/FML-compatible server.
+        announceForge: false
+      # Whether the proxy should support bungee plugin channels.
+      # (Disable this if your backend servers are untrusted.)
+      bungeePluginChannelEnabled: true
+      # Whether to register builtin commands on proxy start.
+      # Default: true
+      builtinCommands: true
+      # Whether players require permissions to
+      # execute a builtin proxy command like /server.
+      # Ignore this if `builtinCommands` is set to false.
+      # (This should be set to true in production environments.)
+      # Default: false
+      requireBuiltinCommandPermissions: false
+      # Declares the proxy commands to 1.13+ clients.
+      # Default: true
+      announceProxyCommands: true
+      # Should the proxy enforce the new public key
+      # security standard added in Minecraft 1.19?
+      # Default: true
+      forceKeyAuthentication: false
+      # The default disconnect reason to kick player on proxy shutdown when no other reason was given.
+      # Either in simple legacy '§' format or modern text component '{"text":"...", ...}' json.
+      shutdownReason: |
+        §cGate proxy is shutting down...
+        Please reconnect in a moment!
+      # Packet compression settings.
+      compression:
+        # The minimum size (in bytes) a packet must be before the proxy compresses it.
+        # The Minecraft vanilla server uses 256 by default.
+        threshold: 128
+        # Indicates what zlib compression level Gate should use.
+        # It goes from -1 to 9 where zero means no compression and -1 the default.
+        level: 6
+      # The time in milliseconds Gate waits to connect to a server before timing out.
+      connectionTimeout: 5000
+      # The time in milliseconds Gate waits to receive data from a server before timing out.
+      # If you use Forge, you may need to increase this setting.
+      readTimeout: 30000
+      # Whether to reconnect the player when disconnected from a server.
+      failoverOnUnexpectedServerDisconnect: true
+      # Enabled extra debug logging (only for debugging purposes).
+      debug: false
+      # This allows you to customize how player information such as IPs and UUIDs are forwarded to your server.
+      # See the documentation for more information.
+      forwarding:
+        # Options: legacy, none, velocity
+        mode: velocity
+        # The secret used if the mode is velocity.
+        velocitySecret: secret
+      # The quota settings allows rate-limiting IP (last block cut off) for certain operations.
+      # ops: The allowed operations per second.
+      # burst: The maximum operations per second (queue like). One burst unit per seconds is refilled.
+      # maxEntries: The maximum IPs to keep track of in cache for rate-limiting (if full, deletes oldest).
+      quota:
+        # Limit how many new connections can be established by the same IP range.
+        connections:
+          enabled: false
+          ops: 5
+          burst: 10
+          maxEntries: 1000
+        # Limit how many login requests can be made by the same IP range.
+        logins:
+          enabled: false
+          burst: 3
+          ops: 0.4
+          maxEntries: 1000
+      # Whether and how Gate should reply to GameSpy 4 (Minecraft query protocol on UDP) requests.
+      query:
+        enabled: false
+        port: 25577
+        showPlugins: false
+  bedrock:
+    # Bedrock edition is not yet supported!
+    enabled: false
+
+# Configuration for Connect, a network that organizes all Minecraft servers/proxies
+# and makes them universally accessible for all players.
+# Among a lot of other features it even allows players to join locally hosted
+# Minecraft servers without having an open port or public IP address.
+#
+# Visit https://developers.minekube.com/connect
+connect:
+  # Enabling Connect makes Gate register itself to Connect network.
+  # This feature is disabled by default, but you are encouraged to
+  # enable it and get empowered by the additional network services
+  # and by the growing community in this ecosystem.
+  enabled: false