| 1 | # --------------------------------
|
| 2 | # Geyser Configuration File
|
| 3 | #
|
| 4 | # A bridge between Minecraft: Bedrock Edition and Minecraft: Java Edition.
|
| 5 | #
|
| 6 | # GitHub: https://github.com/GeyserMC/Geyser
|
| 7 | # Discord: https://discord.gg/geysermc
|
| 8 | # Wiki: https://wiki.geysermc.org/
|
| 9 | #
|
| 10 | # NOTICE: See https://wiki.geysermc.org/geyser/setup/ for the setup guide. Many video tutorials are outdated.
|
| 11 | # In most cases, especially with server hosting providers, further hosting-specific configuration is required.
|
| 12 | # --------------------------------
|
| 13 |
|
| 14 | bedrock:
|
| 15 | # The IP address that will listen for connections.
|
| 16 | # Generally, you should only uncomment and change this if you want to limit what IPs can connect to your server.
|
| 17 | #address: 0.0.0.0
|
| 18 | # The port that will listen for connections
|
| 19 | port: 25599
|
| 20 | # Some hosting services change your Java port everytime you start the server and require the same port to be used for Bedrock.
|
| 21 | # This option makes the Bedrock port the same as the Java port every time you start the server.
|
| 22 | # This option is for the plugin version only.
|
| 23 | clone-remote-port: true
|
| 24 | # The MOTD that will be broadcasted to Minecraft: Bedrock Edition clients. This is irrelevant if "passthrough-motd" is set to true
|
| 25 | # If either of these are empty, the respective string will default to "Geyser"
|
| 26 | motd1: ' §x§A§4§6§0§1§5§lᴏ§x§C§2§6§D§0§E§lɴ§x§E§1§7§9§0§7§lʏ§x§F§F§8§6§0§0§lx§x§F§F§8§D§0§0§lꜱ§x§F§F§9§4§0§0§lᴍ§x§F§F§9§B§0§0§lᴘ'
|
| 27 | motd2: ' &8(&7ʀᴇʟᴇᴀꜱᴇ&8)'
|
| 28 | # The Server Name that will be sent to Minecraft: Bedrock Edition clients. This is visible in both the pause menu and the settings menu.
|
| 29 | server-name: "Geyser"
|
| 30 | # How much to compress network traffic to the Bedrock client. The higher the number, the more CPU usage used, but
|
| 31 | # the smaller the bandwidth used. Does not have any effect below -1 or above 9. Set to -1 to disable.
|
| 32 | compression-level: 6
|
| 33 | # The port to broadcast to Bedrock clients with the MOTD that they should use to connect to the server.
|
| 34 | # DO NOT uncomment and change this unless Geyser runs on a different internal port than the one that is used to connect.
|
| 35 | # broadcast-port: 19132
|
| 36 | # Whether to enable PROXY protocol or not for clients. You DO NOT WANT this feature unless you run UDP reverse proxy
|
| 37 | # in front of your Geyser instance.
|
| 38 | enable-proxy-protocol: false
|
| 39 | # A list of allowed PROXY protocol speaking proxy IP addresses/subnets. Only effective when "enable-proxy-protocol" is enabled, and
|
| 40 | # should really only be used when you are not able to use a proper firewall (usually true with shared hosting providers etc.).
|
| 41 | # Keeping this list empty means there is no IP address whitelist.
|
| 42 | # IP addresses, subnets, and links to plain text files are supported.
|
| 43 | #proxy-protocol-whitelisted-ips: [ "127.0.0.1", "**.**.**.**/16", "https://example.com/whitelist.txt" ]
|
| 44 | remote:
|
| 45 | # The IP address of the remote (Java Edition) server
|
| 46 | # If it is "auto", for standalone version the remote address will be set to 127.0.0.1,
|
| 47 | # for plugin versions, it is recommended to keep this as "auto" so Geyser will automatically configure address, port, and auth-type.
|
| 48 | # Leave as "auto" if floodgate is installed.
|
| 49 | address: auto
|
| 50 | # The port of the remote (Java Edition) server
|
| 51 | # For plugin versions, if address has been set to "auto", the port will also follow the server's listening port.
|
| 52 | port: 25599
|
| 53 | # Authentication type. Can be offline, online, or floodgate (see https://github.com/GeyserMC/Geyser/wiki/Floodgate).
|
| 54 | # For plugin versions, it's recommended to keep the `address` field to "auto" so Floodgate support is automatically configured.
|
| 55 | # If Floodgate is installed and `address:` is set to "auto", then "auth-type: floodgate" will automatically be used.
|
| 56 | auth-type: online
|
| 57 | # Whether to enable PROXY protocol or not while connecting to the server.
|
| 58 | # This is useful only when:
|
| 59 | # 1) Your server supports PROXY protocol (it probably doesn't)
|
| 60 | # 2) You run Velocity or BungeeCord with the option enabled in the proxy's main config.
|
| 61 | # IF YOU DON'T KNOW WHAT THIS IS, DON'T TOUCH IT!
|
| 62 | use-proxy-protocol: false
|
| 63 | # Forward the hostname that the Bedrock client used to connect over to the Java server
|
| 64 | # This is designed to be used for forced hosts on proxies
|
| 65 | forward-hostname: false
|
| 66 |
|
| 67 | # Floodgate uses encryption to ensure use from authorised sources.
|
| 68 | # This should point to the public key generated by Floodgate (BungeeCord, Spigot or Velocity)
|
| 69 | # You can ignore this when not using Floodgate.
|
| 70 | # If you're using a plugin version of Floodgate on the same server, the key will automatically be picked up from Floodgate.
|
| 71 | floodgate-key-file: key.pem
|
| 72 |
|
| 73 | # For online mode authentication type only.
|
| 74 | # Stores a list of Bedrock players that should have their Java Edition account saved after login.
|
| 75 | # This saves a token that can be reused to authenticate the player later. This does not save emails or passwords,
|
| 76 | # but you should still be cautious when adding to this list and giving others access to this Geyser instance's files.
|
| 77 | # Removing a name from this list will delete its cached login information on the next Geyser startup.
|
| 78 | # The file that tokens will be saved in is in the same folder as this config, named "saved-refresh-tokens.json".
|
| 79 | saved-user-logins:
|
| 80 | - ThisExampleUsernameShouldBeLongEnoughToNeverBeAnXboxUsername
|
| 81 | - ThisOtherExampleUsernameShouldAlsoBeLongEnough
|
| 82 |
|
| 83 | # Specify how many seconds to wait while user authorizes Geyser to access their Microsoft account.
|
| 84 | # User is allowed to disconnect from the server during this period.
|
| 85 | pending-authentication-timeout: 120
|
| 86 |
|
| 87 | # Bedrock clients can freeze when opening up the command prompt for the first time if given a lot of commands.
|
| 88 | # Disabling this will prevent command suggestions from being sent and solve freezing for Bedrock clients.
|
| 89 | command-suggestions: true
|
| 90 |
|
| 91 | # The following three options enable "ping passthrough" - the MOTD, player count and/or protocol name gets retrieved from the Java server.
|
| 92 | # Relay the MOTD from the remote server to Bedrock players.
|
| 93 | passthrough-motd: true
|
| 94 | # Relay the player count and max players from the remote server to Bedrock players.
|
| 95 | passthrough-player-counts: true
|
| 96 | # Enable LEGACY ping passthrough. There is no need to enable this unless your MOTD or player count does not appear properly.
|
| 97 | # This option does nothing on standalone.
|
| 98 | legacy-ping-passthrough: false
|
| 99 | # How often to ping the remote server, in seconds. Only relevant for standalone or legacy ping passthrough.
|
| 100 | # Increase if you are getting BrokenPipe errors.
|
| 101 | ping-passthrough-interval: 3
|
| 102 |
|
| 103 | # Whether to forward player ping to the server. While enabling this will allow Bedrock players to have more accurate
|
| 104 | # ping, it may also cause players to time out more easily.
|
| 105 | forward-player-ping: false
|
| 106 |
|
| 107 | # Maximum amount of players that can connect. This is only visual at this time and does not actually limit player count.
|
| 108 | max-players: 10
|
| 109 |
|
| 110 | # If debug messages should be sent through console
|
| 111 | debug-mode: false
|
| 112 |
|
| 113 | # Allow a fake cooldown indicator to be sent. Bedrock players otherwise do not see a cooldown as they still use 1.8 combat.
|
| 114 | # Please note: if the cooldown is enabled, some users may see a black box during the cooldown sequence, like below:
|
| 115 | # https://cdn.discordapp.com/attachments/613170125696270357/957075682230419466/Screenshot_from_2022-03-25_20-35-08.png
|
| 116 | # This can be disabled by going into Bedrock settings under the accessibility tab and setting "Text Background Opacity" to 0
|
| 117 | # This setting can be set to "title", "actionbar" or "false"
|
| 118 | show-cooldown: title
|
| 119 |
|
| 120 | # Controls if coordinates are shown to players.
|
| 121 | show-coordinates: true
|
| 122 |
|
| 123 | # Whether Bedrock players are blocked from performing their scaffolding-style bridging.
|
| 124 | disable-bedrock-scaffolding: false
|
| 125 |
|
| 126 | # If set, when a Bedrock player performs any emote, it will swap the offhand and mainhand items, just like the Java Edition keybind
|
| 127 | # There are three options this can be set to:
|
| 128 | # disabled - the default/fallback, which doesn't apply this workaround
|
| 129 | # no-emotes - emotes will NOT be sent to other Bedrock clients and offhand will be swapped. This effectively disables all emotes from being seen.
|
| 130 | # emotes-and-offhand - emotes will be sent to Bedrock clients and offhand will be swapped
|
| 131 | emote-offhand-workaround: "disabled"
|
| 132 |
|
| 133 | # The default locale if we dont have the one the client requested. Uncomment to not use the default system language.
|
| 134 | # default-locale: en_us
|
| 135 |
|
| 136 | # Specify how many days images will be cached to disk to save downloading them from the internet.
|
| 137 | # A value of 0 is disabled. (Default: 0)
|
| 138 | cache-images: 0
|
| 139 |
|
| 140 | # Allows custom skulls to be displayed. Keeping them enabled may cause a performance decrease on older/weaker devices.
|
| 141 | allow-custom-skulls: true
|
| 142 |
|
| 143 | # The maximum number of custom skulls to be displayed per player. Increasing this may decrease performance on weaker devices.
|
| 144 | # Setting this to -1 will cause all custom skulls to be displayed regardless of distance or number.
|
| 145 | max-visible-custom-skulls: 128
|
| 146 |
|
| 147 | # The radius in blocks around the player in which custom skulls are displayed.
|
| 148 | custom-skull-render-distance: 32
|
| 149 |
|
| 150 | # Whether to add any items and blocks which normally does not exist in Bedrock Edition.
|
| 151 | # This should only need to be disabled if using a proxy that does not use the "transfer packet" style of server switching.
|
| 152 | # If this is disabled, furnace minecart items will be mapped to hopper minecart items.
|
| 153 | # Geyser's block, item, and skull mappings systems will also be disabled.
|
| 154 | # This option requires a restart of Geyser in order to change its setting.
|
| 155 | add-non-bedrock-items: true
|
| 156 |
|
| 157 | # Bedrock prevents building and displaying blocks above Y127 in the Nether.
|
| 158 | # This config option works around that by changing the Nether dimension ID to the End ID.
|
| 159 | # The main downside to this is that the entire Nether will have the same red fog rather than having different fog for each biome.
|
| 160 | above-bedrock-nether-building: false
|
| 161 |
|
| 162 | # Force clients to load all resource packs if there are any.
|
| 163 | # If set to false, it allows the user to connect to the server even if they don't
|
| 164 | # want to download the resource packs.
|
| 165 | force-resource-packs: true
|
| 166 |
|
| 167 | # Allows Xbox achievements to be unlocked.
|
| 168 | xbox-achievements-enabled: true
|
| 169 |
|
| 170 | # Whether player IP addresses will be logged by the server.
|
| 171 | log-player-ip-addresses: true
|
| 172 |
|
| 173 | # Whether to alert the console and operators that a new Geyser version is available that supports a Bedrock version
|
| 174 | # that this Geyser version does not support. It's recommended to keep this option enabled, as many Bedrock platforms
|
| 175 | # auto-update.
|
| 176 | notify-on-new-bedrock-update: true
|
| 177 |
|
| 178 | # Which item to use to mark unavailable slots in a Bedrock player inventory. Examples of this are the 2x2 crafting grid while in creative,
|
| 179 | # or custom inventory menus with sizes different from the usual 3x9. A barrier block is the default item.
|
| 180 | unusable-space-block: minecraft:barrier
|
| 181 |
|
| 182 | # bStats is a stat tracker that is entirely anonymous and tracks only basic information
|
| 183 | # about Geyser, such as how many people are online, how many servers are using Geyser,
|
| 184 | # what OS is being used, etc. You can learn more about bStats here: https://bstats.org/.
|
| 185 | # https://bstats.org/plugin/server-implementation/GeyserMC
|
| 186 | metrics:
|
| 187 | # If metrics should be enabled
|
| 188 | enabled: true
|
| 189 | # UUID of server, don't change!
|
| 190 | uuid: 218b6eab-3e6e-403f-a5fd-e0c3a997700d
|
| 191 |
|
| 192 | # ADVANCED OPTIONS - DO NOT TOUCH UNLESS YOU KNOW WHAT YOU ARE DOING!
|
| 193 |
|
| 194 | # Geyser updates the Scoreboard after every Scoreboard packet, but when Geyser tries to handle
|
| 195 | # a lot of scoreboard packets per second can cause serious lag.
|
| 196 | # This option allows you to specify after how many Scoreboard packets per seconds
|
| 197 | # the Scoreboard updates will be limited to four updates per second.
|
| 198 | scoreboard-packet-threshold: 20
|
| 199 |
|
| 200 | # Allow connections from ProxyPass and Waterdog.
|
| 201 | # See https://www.spigotmc.org/wiki/firewall-guide/ for assistance - use UDP instead of TCP.
|
| 202 | enable-proxy-connections: false
|
| 203 |
|
| 204 | # The internet supports a maximum MTU of 1492 but could cause issues with packet fragmentation.
|
| 205 | # 1400 is the default.
|
| 206 | mtu: 1400
|
| 207 |
|
| 208 | # Whether to connect directly into the Java server without creating a TCP connection.
|
| 209 | # This should only be disabled if a plugin that interfaces with packets or the network does not work correctly with Geyser.
|
| 210 | # If enabled on plugin versions, the remote address and port sections are ignored
|
| 211 | # If disabled on plugin versions, expect performance decrease and latency increase
|
| 212 | use-direct-connection: true
|
| 213 |
|
| 214 | # Whether Geyser should attempt to disable compression for Bedrock players. This should be a benefit as there is no need to compress data
|
| 215 | # when Java packets aren't being handled over the network.
|
| 216 | # This requires use-direct-connection to be true.
|
| 217 | disable-compression: true
|
| 218 |
|
| 219 | config-version: 4
|
