Skip to main content

Overview

Learn how to add servers to the server mappings

You can add your server to our Server Mappings by creating a pull request on the Client-API repository following the guidelines detailed here.

warning

We ask that this repository is only used to store mappings for public Minecraft servers.

Some server IPs, such as private SMPs, tournament servers, etc. should not be listed in this repository, out of respect for privacy.

Creating an ID for your server​

In order to add your server to the mappings, you will need to create a subfolder within the servers directory. This folder should be named after your server in the form of an "ID".

When creating an ID for your server, please ensure that it is:

  • Unique (no other servers should have the same ID)
  • Short and concise (it should be similar to the server's name)
  • Alphanumeric (no special characters or spaces)

Creating the necessary files​

Your server's folder must contain the following files:

Partnered servers must also include the following files: