Update README.md

This commit is contained in:
2026-03-07 19:51:28 -05:00
parent 679a9f38eb
commit 90f36caaf6

View File

@@ -10,7 +10,7 @@ Create a custom egg in Pelican that uses `rallyblockk/blockland-pelican` as its
The image is available on Docker Hub at [rallyblockk/blockland-pelican](https://hub.docker.com/r/rallyblockk/blockland-pelican).
**Note:** Blockland works best with host networking due to UDP and Join IP behavior (see Networking section). Host network is configured in Wings (`/etc/pelican/config.yml`), not in the egg.
**Note:** If you run into connection issues, see the Networking section—host network mode may help (configured in Wings, not in the egg).
### Environment variables
| Name | Type | Default | Description |
@@ -34,10 +34,10 @@ The image is available on Docker Hub at [rallyblockk/blockland-pelican](https://
| WINEDEBUG | string | -all | Controls how much logging Wine does to the console (default hides everything)
### Networking
Blockland uses UDP and can be finicky with Docker bridge networks. For the most reliable results, configure Wings to use host network mode in `/etc/pelican/config.yml` (see [Pelican's optional config docs](https://pelican.dev/docs/wings/optional-config/)). Host network is Linux-only and removes Docker network isolationuse with caution on shared nodes.
Blockland uses UDP. The original image recommended host network mode for reliability, but many users run fine with Pelicans default bridge network. If you have connection issues (players cant join, server not visible, etc.), try configuring Wings for host network mode in `/etc/pelican/config.yml`see [Pelicans optional config docs](https://pelican.dev/docs/wings/optional-config/). Host network is Linux-only and removes Docker isolation; use with caution on shared nodes.
### Volumes
Pelican mounts each server's data directory at `/home/container` (the working directory). Files there are persisted as the server's storage. The container runs as UID/GID 1000—Pelican typically handles permissions, but that can cause issues if something is misconfigured at the node level.
### Wine
Wine seems to be having less and less compatibility with Blockland as time goes on. Back when Wine 5.18 came out, we lost the Curses backend, and it stopped being possible to interact with Blockland's console. I eventually figured out what the issue with Wine was, and created [Wine Fix](https://gitlab.com/Eagle517/wine-fix) which allowed console interaction to work with Wine up to 8.0.2. With Wine 9 and later, it appears the console is just completely broken now. I don't have the time to figure out what shenanigans the Wine devs got up to, so we're stuck with 8.0.2 for now.
Wine seems to be having less and less compatibility with Blockland as time goes on. Back when Wine 5.18 came out, we lost the Curses backend, and it stopped being possible to interact with Blockland's console. I eventually figured out what the issue with Wine was, and created [Wine Fix](https://gitlab.com/Eagle517/wine-fix) which allowed console interaction to work with Wine up to 8.0.2. With Wine 9 and later, it appears the console is just completely broken now. I don't have the time to figure out what shenanigans the Wine devs got up to, so we're stuck with 8.0.2 for now.