diff --git a/README.md b/README.md new file mode 100644 index 0000000..3fb1501 --- /dev/null +++ b/README.md @@ -0,0 +1,44 @@ +# Blockland Pelican Egg + +Pelican Panel egg for running Blockland dedicated servers. Uses the [rallyblockk/blockland-pelican](https://hub.docker.com/r/rallyblockk/blockland-pelican) Docker image. + +## Files + +| File | Description | +|------|-------------| +| `egg-blockland.json` | Egg export in JSON format — use this to import into Pelican | +| `egg-blockland.yaml` | Same egg in YAML format — for reference or editing | + +## How to Import + +1. Open your Pelican Panel **Admin Panel** +2. Go to **Eggs** in the sidebar +3. Click **Import** (top right) +4. Either: + - **Upload** the `egg-blockland.json` file, or + - **Paste a URL** if you host the JSON somewhere (e.g. GitHub raw link) + +5. Select the **nest** to add the egg to +6. Click **Import** + +## Requirements + +- [Pelican Panel](https://pelican.dev/) installed +- The `rallyblockk/blockland-pelican` Docker image (Pelican pulls it when you create a server) +- A [Blockland DToken](https://blockland.us/steam-dToken.php) for authentication + +## Egg Variables + +After import, configure these when creating a server: + +| Variable | Description | +|----------|-------------| +| **bl dtoken** | Your DToken from your Steam account (required for hosting) | +| **bl patch enable** | Patches Blockland.exe with RedBlocklandLoader for WineFix (default: 1) | +| **bl port** | Server port (defaults to `{{SERVER_PORT}}` from Pelican) | +| **bl unzip addons** | Unzips .zip add-ons on startup (default: 0) | +| **bl inst force** | Forces full game install on each launch (default: 0) | + +## Related + +- **Docker image**: [rallyblockk/blockland-pelican](https://hub.docker.com/r/rallyblockk/blockland-pelican)