Skip to main content

Enabling MineSphere Integration

MineSphere is a powerful web-based platform that works seamlessly with LandGuard to provide players and server admins with an enhanced land management experience outside of Minecraft. Through MineSphere, users can view, organize, and manage their lands via an intuitive online dashboard — and even benefit from automatic cloud backups.

🌐 What is MineSphere?​

MineSphere offers the following features:

  • Web Access to Lands: Players can view their own lands and explore other players’ lands via a modern web UI.
  • Cloud Backups: All land data is automatically backed up to the cloud, protecting against data loss in case of server failure.
  • Cloud Restoration: Admins and land owners can restore land data from the cloud through compatible plugins like LandGuard.

🔐 Getting Started​

To enable MineSphere on your server, follow these steps:

  1. Register your server
    You must start by registering your server in MineSphere to obtain the necessary credentials. To do this, you should go to MineSphere's Server Registration Page and fill out the form with your server details.

    Please make sure to choose a secure password, and store it safely as it will be needed later.

  2. Obtain Your Credentials
    After registering, you should see a confirmation message indicating that your server has been registered successfully. In this message, you will find your serverId. Make sure to store the ID as you will need it to configure LandGuard.

  3. Update the Configuration File
    Open your config.yml and locate the cloud section. Fill in this section with:

    • serverId: The unique identifier you received after registering your server in MineSphere.
    • serverSecret: The password you set when registering your server.

    Here is an example of how the cloud section should look:

    cloud:
      serverId: "your-server-id"
      serverSecret: "your-password"

  4. Restart Your Server
    After saving the config, restart the server to apply the changes and activate the MineSphere integration.

💵 MineSphere Premium​

The Free version of MineSphere allows players to view their lands and access basic features. However, a server with a Free subscription has limitations on the amount of lands that can be stored in the cloud.

To unlock the full potential of MineSphere, including a higher limit for land storage and advanced features, you can upgrade to MineSphere Premium.

If you have purchased LandGuard, you are eligible to activate MineSphere Premium for your server at no additional cost. Follow these steps to activate the premium features:

  1. Join the LandGuard Discord

  2. Write a message in the #claim-offer channel to request activation of MineSphere Premium for your server. You can use the following template:

    @Hugo1307 I have purchased LandGuard and would like to activate MineSphere Premium. 

    Username: [YourUsername] // The username you used to purchase LandGuard in the BuiltByBit store
    Server Id: [Your Server's ID]

  3. That's it! The admin team will process your request and activate the premium features for your server!

📌 Notes​

  • Your serverSecret should be kept private. Do not share it with others.
  • If the server cannot connect to MineSphere, land data will still be managed locally — but cloud-based features will be disabled.
  • MineSphere Premium is included for free with your purchase of LandGuard.