excommunicated/bedrock-connect repository overview

⁠Bedrock Connect

This is a Docker image based on PugMatt/BedrockConnect, the container is updated to Bedrock version 1.19.20. BedrockConnect is an easy to use solution for Minecraft Bedrock Edition players on Xbox One, Nintendo Switch, PS4, iOS, Android, etc. to join a self-hosted MineCraft server.

Please go to GitHub at https://github.com/Pugmatt/BedrockConnect⁠ to see all the documentation and buy Pugmatt a coffee if you like his work.

⁠Usage

All you need to do to get this container up and running is the following, firstly create the container by running the docker cli commands:

docker run -d -it
--name=bedrockconnect
-e featured_servers=true
-e user_servers=true
-e custom_servers=/brc/custom_servers.json
-p 19132:19132/udp
excommunicated/bedrock-connect:latest

The Bedrock Connect container has now been created, and you can now add custom servers to the custom_server.json file

⁠Defining your own custom servers

The BedrockConnect container fulfils the role of a serverlist server, it is a specially made Minecraft server that allows all players on any platform to join a self-hosted Minecraft server. When using BedrockConnect, a custom server list has to be created to allow all players to join. All servers are defined via a JSON file in the following format:

[
    {
        "name": "Survival Peaceful",
        "iconUrl": "https://i.imgur.com/3BmFZRE.png",
        "address": "192.168.0.10",
        "port": 19132
    },
    {
        "name": "Creative Easy",
        "iconUrl": "https://i.imgur.com/3BmFZRE.png",
        "address": "192.168.0.20",
        "port": 19132
    }
]

To configure the custom servers you have a couple of options.

⁠Edit existing file

Connect to the command line of the docker container, install a text editor apt-get update; apt-get install vim and edit the custom_server.json file within the /brc directory of the container. To do this type vim at the command line and copy the example text above configuring for your custom server setup, within vim hit ESC and :w custom_servers.json then ENTER. This will save the file, restart the container and you are good to go!

⁠Mount and consume an external file

The simplest option if to mount your own json file over the top of the pre created custom_servers.json file in the /brc directory. This can be done by mounting the file using a volume from the cli as shown

docker run -d -it
--name=bedrockconnect
-v /usr/home/customserver.json:/brc/custom_servers.json
-p 19132:19132/udp
excommunicated/bedrock-connect:latest

if you want to move the custom_servers.json file to another location, you can do that by also setting the environment variable custom_servers to your location you have mounted.

docker run -d -it
--name=bedrockconnect
-v /usr/home/custom_servers.json:/app/custom_servers.json
-e custom_servers=/app/custom_servers.json
-p 19132:19132/udp
excommunicated/bedrock-connect:latest