Skip to content
This repository has been archived by the owner on Apr 7, 2021. It is now read-only.

Editing the config

Jump to bottom
Luke edited this page Apr 10, 2020 · 2 revisions

On this page, Minecraft: Bedrock Edition (or simply Minecraft or MCPE) will referred to as "Bedrock"

The config file is where you can change certain settings for the proxy. The file is called config.yml.

Config location

The config is in different locations depending on whether you are running the standalone or bukkit-plugin versions.

  • Standalone: same directory as the DragonProxy.jar
  • Bukkit: plugins/DragonProxy-Bukkit/config.yml
    .

What everything means

  • config-version - This is the version of the config. Do not change this, or the config will fail to load.

  • bind-address - The IP address that the proxy should listen for bedrock connections on. Unless you know what you are doing, you should leave this as 0.0.0.0 (the default)

  • bind-port - The port the proxy should listen on. 19132 is the default port that the bedrock client will use to find games on LAN. You shouldn't need to change this if you are running the proxy on your own PC

  • motd - The MOTD (Message of The Day). This is the text that is displayed in the bedrock server list. This will be ignored if ping-passthrough is enabled, see below.

  • max-players - The maximum amount of bedrock players that can join the proxy. This will be ignored if ping-passthrough is enabled, see below.

  • remote-address - This is the address of the remote (Minecraft: Java Edition) server that you are wanting to connect to.

    • Examples:
    • mc.hypixel.net - Hypixel
    • localhost or 127.0.0.1 - A server that is on the same PC as the proxy

  • remote-port - The port of the remote (Minecraft: Java Edition) server. The default port is 25565 and will likely not need to be changed unless the server uses a different port.

  • remote-auth - This can be one of the following values:

    • credentials - If the remote server is an "online mode" server, meaning you must own a paid Minecraft: Java Edition account to join
    • offline - If the remote server is a "cracked" or "offline mode" server, meaning you DON'T need a Minecraft: Java Edition account

  • xbox-auth - Whether or not the bedrock players must be authenticated with Xbox Live. If you are joining via LAN (on the friends tab in bedrock edition), then set this to false otherwise it doesn't really matter

  • ping-passthrough - This setting will fetch the MOTD and player count from the remote server and display it on the bedrock edition server list
    .

Player settings (player-settings)

The following are player related settings:

  • enable-commands - (experimental) Whether to send commands to the bedrock client, if the remote server supports it. NOTE: commands will work regardless of whether this is enabled, this just makes them show in the autocomplete on the chat screen. Command arguments are buggy, and don't display correctly which is why this is off by default

  • auto-jump - This doesn't appear to work? I may be wrong

  • fetch-skins - Enable this if you want to see players with their Minecraft: Java Edition skins. This also works on yourself
    .

Metrics settings (metrics)

This doesn't work. Changing these values will do nothing. Instead, see the metrics.yml file for that. Do NOT change the server uuid value in metrics.yml, and please keep it enabled, but you don't have to.

.

Default config

The default config.yml file looks as follows:

# -----------------------------------------------
#   DragonProxy Configuration (25/03/20)
#   https://github.com/DragonetMC/DragonProxy
# -----------------------------------------------
# DO NOT CHANGE THIS VARIABLE!!!!!!
config-version: 2
# DO NOT CHANGE THIS VARIABLE!!!!!!

locale: 'EN'

# The IP and port the proxy will listen for connections on
# '0.0.0.0' will bind to all IP addresses available on your device
bind-address: '0.0.0.0'
bind-port: 19132

# The MOTD that will be shown on the MCPE server list
motd: 'DragonProxy'
motd2: 'https://github.com/DragonetMC/DragonProxy'

# The maximum amount of players that can join the proxy
max-players: 1

# The IP and port of the remote server to connect to
remote-address: '127.0.0.1'
remote-port: 25565

# The authentication method used for connecting to the remote server.
# Accepted values:
#   credentials   : This will display a form when you join the proxy asking you to enter your Mojang credentials
#   offline       :  No authentication, cant join premium servers such as Hypixel
remote-auth: credentials

# Whether or not Bedrock clients should be authenticated with xbox live
xbox-auth: false

# Whether or not to use the motd and player count of the primary remote server
ping-passthrough: true

# Player gameplay related settings
player-settings:
  # Whether or not to translate commands sent from the remote server and display
  # them on the Bedrock client. This is currently experimental.
  enable-commands: false

  # Whether or not to enable auto jump
  auto-jump: true

  # Whether or not to fetch skins from Mojang's servers
  fetch-skins: true

metrics:
  enabled: true
  # DO NOT CHANGE
  server-uuid: donotchange_serveruuid

# The amount of threads that will be used.
# Only change if you know what you are doing
thread-pool-size: 8
Clone this wiki locally