Skip to content

Commit b6a3fb1

Browse files
committed
docs: enhance server configuration guide with new properties and improved formatting
1 parent 4f89180 commit b6a3fb1

File tree

1 file changed

+32
-28
lines changed

1 file changed

+32
-28
lines changed

content/docs/getting-started/first-steps.mdx

Lines changed: 32 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ This page helps you:
88
3. join from a Bedrock client.
99

1010
<Admonition type="tip">
11-
If you haven’t installed Endstone yet, see **[Getting Started](/docs/getting-started)** first.
11+
If you haven’t installed Endstone yet, see **[Getting Started](/docs/getting-started)** first.
1212
</Admonition>
1313

1414
## Start the server
@@ -28,45 +28,49 @@ Follow the instructions on the [Run with Docker](/docs/getting-started/installat
2828

2929
## Basic configuration
3030

31-
Most base-game settings live in the Bedrock **`server.properties`** file.
32-
After the first run, stop the server, edit the file, and start the server again.
31+
After the first run, the server will create a **`server.properties`** file in the server folder.
32+
This file contains most settings related to the base gameplay.
3333

34-
### Quick Tweak
35-
36-
Typical options you may want to set:
34+
The content of the file should look like this:
3735

3836
```ini filename="server.properties"
3937
server-name=Endstone Server
4038
gamemode=survival
41-
difficulty=normal
39+
force-gamemode=false
40+
difficulty=easy
41+
allow-cheats=true
4242
max-players=10
43-
allow-cheats=false
43+
online-mode=true
4444
allow-list=false
4545
server-port=19132
4646
server-portv6=19133
47+
enable-lan-visibility=true
48+
view-distance=32
49+
tick-distance=4
50+
player-idle-timeout=30
51+
max-threads=8
52+
level-name=Bedrock level
53+
level-seed=
4754
```
4855

49-
* **`server-name`**
50-
The name shown to clients in the server list. Cosmetic only; doesn’t affect reachability.
51-
52-
* **`gamemode`** (`survival` | `creative` | `adventure`)
53-
Default gamemode for new players. Existing players keep their current mode unless changed with commands.
56+
<Admonition type="tip">
57+
To change the settings, first **stop** the server, edit the file, **save**, and start the server again.
58+
</Admonition>
5459

55-
* **`difficulty`** (`peaceful` | `easy` | `normal` | `hard`)
56-
World difficulty. Can be changed at runtime with `/difficulty`, but set it here to persist.
5760

58-
* **`max-players`**
59-
Hard cap on simultaneous connections. Higher numbers increase CPU/RAM and bandwidth needs.
61+
There are some typical options you may want to set:
6062

61-
* **`allow-cheats`** (`true`/`false`)
62-
When **true**, the server allows cheats-like commands (like `/give`, `/tp`).
63-
You still need elevated permissions (see [Permissions](/docs/user-guide/permissions/)).
6463

65-
* **`allow-list`** (`true`/`false`)
66-
When **true**, only players listed in `allowlist.json` can join. Good for private servers.
64+
| Configuration | Description |
65+
|---------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
66+
| `server-name` | The name shown to clients in the server list. |
67+
| `gamemode` | Default gamemode for new players. Existing players keep their current mode unless changed with commands. Possible values are `survival`, `creative` and `adventure`. |
68+
| `difficulty` | World difficulty. Can be changed at runtime with `/difficulty`, but set it here to persist. Possible values are `peaceful`, `easy`, `normal` and `hard`. |
69+
| `max-player` | Hard cap on simultaneous connections. Higher numbers increase CPU/RAM and bandwidth needs. |
70+
| `allow-cheats` | When **true**, the server allows cheats-like commands (like `/give`, `/tp`). You still need elevated permissions (see [Permissions](/docs/user-guide/permissions/)). |
71+
| `allow-list` | When **true**, only players listed in `allowlist.json` can join. Good for private servers. |
72+
| `server-port` / `server-portv6` | The UDP ports the server listens on. If you’re behind a router/firewall, you **must** open/forward these (UDP, not TCP). |
6773

68-
* **`server-port` / `server-portv6`**
69-
The UDP ports the server listens on. If you’re behind a router/firewall, you **must** open/forward these (UDP, not TCP).
7074

7175
### Make yourself an operator
7276

@@ -81,12 +85,12 @@ op <YourGamertag>
8185
1. Make sure your **firewall allows UDP** on the Bedrock port (default **19132**).
8286
2. If you’re on the **same LAN**, the server usually appears under the **Friends / LAN** tab. Otherwise:
8387
3. On your device, go to **Play → Servers → Add Server** and enter:
84-
- **Server Address:** your PC's IP (or your public IP if port forwarded)
85-
- **Port:** `19132` (or whatever you set in `server-port`)
88+
- **Server Address:** your PC's IP (or your public IP if port forwarded)
89+
- **Port:** `19132` (or whatever you set in `server-port`)
8690
4. Save and **Join**.
8791

8892
<Admonition type="tip">
89-
Hosting over the internet? Don't forget to set up **port forwarding** on your router for UDP <b>19132</b> (and
90-
optionally <b>19133</b> for IPv6) to your server machine's local IP.
93+
Hosting over the internet? Don't forget to set up **port forwarding** on your router for UDP <b>19132</b> (and
94+
optionally <b>19133</b> for IPv6) to your server machine's local IP.
9195
</Admonition>
9296

0 commit comments

Comments
 (0)