The central nervous system of Project Earth
The API implementation is NOT complete, which means that not all of the game features might work as expected.
Thanks to jackcaver. 🙌 Thanks to BitcoderCZ. 🙌 Special thanks to LukeFZ for providing all of the necessary data for recovering missing features 🙌
The core API handles the bulk of game functionality - pretty much everything that isn't direct AR gameplay is done here.
| Currently working features | Partially working features |
|---|---|
| 🗺️ Map | 🏗️ Buildplates (Implementation is not complete) |
| 🎯 Tappables | 🏞️ Adventures/Encounters (Implementation is not complete) |
| 🔨 Crafting | 🛠️ Smelting (Implementation is not complete) |
| 🏬 Store | 🔄 Buildplate sharing (Webpage is not implemented) |
| 🎒 Inventory | 🏆 Challenges (Challenge conditions are broken) |
| 💥 Boosts (Do not confuse with boost minis) | |
| 📖 Journal | |
| 📝 Activity Log |
git clone --recursive https://github.com/andiricum2/MCEarth-Server.gitcd Apidotnet buildor use any IDE that you want and build it there
To start, ensure that you have built copies of all the required components downloaded:
- A built copy of the Api (you are in this repo), which you can get from GitHub Actions
- You'll need the Modified Minecraft Earth resource pack file with new mobs, download the
vanilla.zipand placed in thedata/resourcepacks. You can procure the resourcepack from here. - Our fork of Cloudburst. Builds of this can be found here. This jar can be located elsewhere from the Api things.
- Run Cloudburst once to generate the file structure.
- In the plugins folder, you'll need GenoaPlugin, and GenoaAllocatorPlugin. The CI for this can be found here and here. Note: make sure to rename your GenoaAllocatorPlugin.jar to ZGenoaAllocatorPlugin.jar, or you will run into issues with class loading
- IF YOU WANT TO USE CUSTOM SPAWN YOU'LL NEED TO INSTALL THE TILE SERVER here 🔴 YOU NEED DOCKER 😅
On the cloudburst side:
- Within the
pluginsfolder, create aGenoaAllocatorPluginfolder, and in there, make akey.txtfile containing a base64 encryption key andip.txtfile containing your server's ip address. An example key is:
/g1xCS33QYGC+F2s016WXaQWT8ICnzJvdqcVltNtWljrkCyjd5Ut4tvy2d/IgNga0uniZxv/t0hELdZmvx+cdA==
- Edit the cloudburst.yml file, and change the core API url to the url your Api will be accessible from.
- On the Api side, go to
data/config/apiconfig.json, and add the following:
"multiplayerAuthKeys": {
"The same IP you put in ip.txt": "the same key you put in key.txt earlier"
}- Start up the Api.
- Start up Cloudburst. After a short while, the Api should mention a server being connected.
- If you run into issues, retrace your steps, or contact us on Discord.
- If everything works, your next challenge is to get Minecraft Earth to talk to your Api. If you're on Android, you can utilize our patcher. If you're on IOS, the only way to accomplish this without jailbreak is to utilize a DNS, such as bind9. Setup for that goes beyond the scope of this guide.