Giter Club home page Giter Club logo

minecraft-bedrock-connect's Introduction

GitLab Pipeline MIT License Docker latest by date Docker Pulls Docker Automate build Docker Image Size latest by date Open in Gitpod

A simple Docker image that can provide the Minecraft Bedrock Connect service.

https://minecraft-bedrock-connect.git-pages.com

Supported tags and respective Dockerfile links

Tags

Tag(s) Description
latest, 1, 1.* latest stable - ubuntu
beta, -beta. Beta. New features preview or help to test. It could be unstable.
nightly* development build, very unstable

Quick reference

โญ Features

  • Running Bedrock Connect as a Docker Container
  • Can be used with MySQL Database as backend
  • Configuration via ENV variables
  • Use of the custom_servers via json file possible

๐Ÿ’ก Environment Variables

The following arguments can be placed in the startup command to ajust settings:

Argument Description Default Value
BRC_VERSION The Bedrock Connect version is used when the container is started. For example, 1.15 for the Bedrock Connect version 1.15. It does not mean the Minecraft server version. latest
MYSQL_HOST MySQL Host localhost
MYSQL_DB MySQL Database Name bedrock-connect
MYSQL_USER MySQL Username root
MYSQL_PASS MySQL Password
SERVER_LIMIT How many servers a new player can have in their serverlist 100
NODB If true, use JSON files for data instead of MySQL false
KICK_INACTIVE If true, players will be kicked after 10 minutes of inactivity with the serverlist UI true
CUSTOM_SERVERS Sets the path to a custom server file, for specifying your servers in the list for all players. See custom servers.
USER_SERVERS If true, players can add and remove servers on the serverlist. If false, the options are hidden. true
FEATURED_SERVERS If true, the featured servers will be displayed in the serverlist. If false, the servers are hidden. true
WHITELIST Specify file containing list of whitelisted players. (Should be a text file with the player names specified on seperate lines)
FETCH_FEATURED_IPS If true, dynamically grab the featured server IPs from the domain names. If false, a file featured_server_ips.json will be generated, containing the hard-coded featured server IPs, and to allow changing them if needed. true

๐Ÿ”ง How to Install

The Docker image can be deployed quickly and easily via these two commands, or via Docker compose, see examples below.

๐Ÿ’ช๐Ÿป Non-Docker

For an installation without Docker, please follow the instructions from Pugmatt

๐Ÿณ Docker

# Create a volume
docker volume create bedrock-connect

# Start the container
docker run -d --restart=always -p 19132:19132/udp -e NODB=true -v bedrock-connect:/data --name bedrock-connect strausmann/minecraft-bedrock-connect:2

Exposed Ports

  • UDP 19132 : the Bedrock server port. NOTE that you must append /udp when exposing the port, such as -p 19132:19132/udp

๐Ÿณ Deploying with Docker Compose

---
version: "3.8"

services:
  bedrockconnect: 
    image: strausmann/minecraft-bedrock-connect:2
    restart: always
    environment:
      NODB: "true"
      CUSTOM_SERVERS: "/config/serverlist.json"
      SERVER_LIMIT: 25
    ports:
      - 19132:19132/udp
    volumes:
      - bedrockconnect:/config

volumes:
  bedrockconnect:
    driver: local

๐Ÿณ Deploying with Docker Compose and MySQL Backend

---
version: "3.8"

services:
  bedrockconnect: 
    image: strausmann/minecraft-bedrock-connect:2
    restart: always
    environment:
      MYSQL_HOST: "db"
      MYSQL_USER: "bedrock"
      MYSQL_PASS: "bedrock"
      MYSQL_DB: "bedrock"
      CUSTOM_SERVERS: "/config/serverlist.json"
      SERVER_LIMIT: 25
    ports:
      - 19132:19132/udp
    depends_on:
      - db
    volumes:
      - bedrockconnect:/config

  db: 
    image: mariadb:10.6
    restart: always
    environment:
      - MYSQL_ROOT_PASSWORD=rootpwbedrock
      - MYSQL_PASSWORD=bedrock
      - MYSQL_USER=bedrock
      - MYSQL_DATABASE=bedrock
      - TZ=Europe/Berlin
      - PGID=1000
      - PUID=1000
    ports:
      - 3306:3306
    volumes:
      - bedrockconnect_database:/var/lib/mysql

volumes:
  bedrockconnect:
    driver: local
  bedrockconnect_database:
    driver: local

License

View license information for the software contained in this image.

As with all Docker images, these likely also contain other software which may be under other licenses (such as Bash, etc from the base distribution, along with any direct or indirect dependencies of the primary software being contained).

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.