Skip to Content
⚠ Under Construction
DocumentationGetting StartedFirst Steps

First Steps

This page helps you:

  1. start Endstone for the first time,
  2. make a few essential configuration changes, and
  3. join from a Bedrock client.

Start the server

If you installed with uv + pip

Open your project folder and activate the virtual environment, then start Endstone:

source .venv/bin/activate
uv run endstone

If you’re using Docker

Follow the instructions on the Run with Docker page.

Basic configuration

After the first run, the server will create a server.properties file in the server folder. This file contains most settings related to the base gameplay.

The content of the file should look like this:

server.properties
server-name=Endstone Server
gamemode=survival
force-gamemode=false
difficulty=easy
allow-cheats=true
max-players=10
online-mode=true
allow-list=false
server-port=19132
server-portv6=19133
enable-lan-visibility=true
view-distance=32
tick-distance=4
player-idle-timeout=30
max-threads=8
level-name=Bedrock level
level-seed=

There are some typical options you may want to set:

ConfigurationDescription
server-nameThe name shown to clients in the server list.
gamemodeDefault gamemode for new players. Existing players keep their current mode unless changed with commands. Possible values are survival, creative and adventure.
difficultyWorld difficulty. Can be changed at runtime with /difficulty, but set it here to persist. Possible values are peaceful, easy, normal and hard.
max-playerHard cap on simultaneous connections. Higher numbers increase CPU/RAM and bandwidth needs.
allow-cheatsWhen true, the server allows cheats-like commands (like /give, /tp). You still need elevated permissions (see Permissions).
allow-listWhen true, only players listed in allowlist.json can join. Good for private servers.
server-port / server-portv6The UDP ports the server listens on. If you’re behind a router/firewall, you must open/forward these (UDP, not TCP).

Make yourself an operator

From the server console, grant operator privileges to your player name (Gamertag):

op <YourGamertag>

Join from a Bedrock client

  1. Make sure your firewall allows UDP on the Bedrock port (default 19132).
  2. If you’re on the same LAN, the server usually appears under the Friends / LAN tab. Otherwise:
  3. On your device, go to Play → Servers → Add Server and enter:
  • Server Address: your PC’s IP (or your public IP if port forwarded)
  • Port: 19132 (or whatever you set in server-port)
  1. Save and Join.
Last updated on
DockerUpdate Endstone