| --- |
| title: Alpha MC |
| emoji: ⛏️ |
| colorFrom: green |
| colorTo: gray |
| sdk: docker |
| pinned: false |
| app_port: 7860 |
| datasets: [] |
| --- |
| |
| # ⛏️ Alpha MC — Minecraft Bedrock Server on HuggingFace |
|
|
| A fully automated **Minecraft Bedrock Dedicated Server** running on HuggingFace Spaces, tunneled via [playit.gg](https://playit.gg) so anyone can join from anywhere. |
|
|
| --- |
|
|
| ## 🚀 How to Connect |
|
|
| 1. Open the Space — wait for the **TUNNEL IS LIVE** message in the logs |
| 2. Copy the `*.playit.gg` address shown |
| 3. In Minecraft Bedrock → Add Server → paste the address → **Join!** |
|
|
| --- |
|
|
| ## ⚙️ Setup (First Time) |
|
|
| ### 1. Add your playit Secret Key |
| - Go to **Space Settings → Repository Secrets** |
| - Add a secret named `SECRET_KEY` |
| - Get your key from [playit.gg/account/agents](https://playit.gg/account/agents) |
|
|
| ### 2. Restart the Space |
| - The server will build, download Minecraft, and start automatically. |
|
|
| --- |
|
|
| ## 📁 Persistent Storage |
| World data is saved under `/data/bedrock-server/worlds` and **persists across restarts** as long as the Space is not deleted. |
|
|
| Automatic backups run every 6 hours to `/data/bedrock-server/backups` (last 10 kept). |
|
|
| --- |
|
|
| ## 🖥️ Status Page |
| Visit the Space URL in your browser to see a live status dashboard showing: |
| - Server online / offline |
| - Tunnel address |
| - Player count (from logs) |
| - System resource usage |
| - Recent server logs |
|
|
| --- |
|
|
| ## 📝 Server Info |
| | Setting | Value | |
| |---|---| |
| | Mode | Survival | |
| | Difficulty | Hard | |
| | Max Players | 20 | |
| | View Distance | 10 | |
| | Online Mode | true | |
|
|
| --- |
|
|
| ## ⚠️ Notes |
| - This uses **HuggingFace free tier** — uptime is best-effort |
| - Minecraft Bedrock uses **UDP** which HF doesn't expose directly — that's why playit.gg is used as the tunnel |
| - Never share your `SECRET_KEY` publicly |
|
|
