Want to add your Minecraft server to Lunar Client ServerMappings, but you’re a bit unfamiliar with GitHub? This guide provides a walkthrough of everything you need to know in order to submit a pull request and add your Minecraft server to the repository!

❓ Why should I add my server to the ServerMappings?

Server Mappings is a collection of mappings for Minecraft servers, including the most popular servers such as Hypixel, Mineplex, and more. Server Mappings provides information such as server name, server icon and more. For more information about the use cases of ServerMappings, check the official developer website.

🤔 How do I add my own Minecraft server to Lunar Client ServerMappings?

To add your server, you’ll need to fork the official repository, add your server to your fork, and submit a pull request. If you have no idea how this can be done, I got you covered!

🔑 Step 1: GitHub

• You’ll need a GitHub account to do this. If you already have an account, log in. If you don’t, sign up for an account; It’s free!

📁 Step 2: Prepare the Required Files

• To add your server, you should prepare some files. Some of these are required, but some others are optional.

1. (required) metadata.json
2. (reqiured) logo.png
3. (optional) background.png
4. (optional) banner.png / banner.gif
5. (optional) wordmark.png

🔗 1. Metadata

This json file includes all the necessary data about your server. Below is an example of how it should look like. Copy this json, use any text editor, and save it as a .json file named metadata. Make sure you edit everything in this example with your own server’s information. (For an advanced guide on this, visit the developer website.)

⚠️ Warning: For the love of god, before changing anything in this, if you have no idea what these are, visit this page that explains everything (please!).

{
    "id": "lunarnetwork",
    "name": "Lunar Network",
    "description": "Home of Competitive Minecraft PvP",
    "addresses": [
        "lunar.gg",
        "lunargg.dev",
        "mcteams.com"
    ],
    "primaryAddress": "lunar.gg",
    "minecraftVersions": [
        "1.7.*",
        "1.8.*"
    ],
    "primaryMinecraftVersion": "1.8.9",
    "primaryColor": "#44a1e3",
    "secondaryColor": "#a854de",
    "primaryLanguage": "en",
    "languages": [
        "en"
    ],
    "primaryRegion": "NA",
    "regions": [
        "NA",
        "EU",
        "OC",
        "AS",
        "SA"
    ],
    "gameTypes": [
        "PvP"
    ],
    "website": "https://www.lunar.gg",
    "store": "https://store.lunar.gg",
    "compliance": {
        "privacyPolicy": "https://www.lunar.gg/privacy",
        "termsOfService": "https://www.lunar.gg/terms",
        "rules": "https://www.lunar.gg/rules"
    },
    "socials": {
        "twitter": "LunarNetwork",
        "telegram": "lunarnetwork",
        "discord": "https://www.lunar.gg/discord"
    },
    "crossplay": false
}

🖼️ 2. Logo

The name is self-explanatory. You’ll need the logo of your server as a PNG file. However, there are a few things to consider:

1. It has to be a PNG.
2. It should be transparent (and this depends on how your logo looks like).
3. It has to be a square (so it should have a 1:1 aspect ratio).
4. The width/height of it has to be at least 512px.
5. You shouldn’t submit a low-quality image you upscaled.
6. It has to be your own logo, not some copyrighted stuff that doesn’t belong to you.

3, 4, 5. Background, Banner, and Wordmark

Since these aren’t required for you to add your server, I won’t talk about these in here. However, everything you need to know about these can be found on the developer website.

🍴 Step 3: Fork the Repository

• Once you’re logged into your GitHub account, visit the official LunarClient ServerMapping GitHub repository. On top-right of the page, click on the “Fork” option.

• In the next page you’re redirected to, just click on “Create Fork”.

⚙️ Step 4: Modify Your Fork

• Let’s go back to GitHub. Open your own GitHub profile, and click on the “Repostiories” tab. If you’ve done everything correctly on step three, you should see your own fork of the Server Mappings repository in there.

• Click on the name, and it should bring you the forked repository.

• There are different ways of uploading files to GitHub, but I would rather explain how to use GitHub’s web editor. While you’re on the main page of your fork, press period (.) on your keyboard. GitHub will now redirect you to the web editor. That’s where you’ll be editing the files.

• Once you’re there, click on the servers folder to select it. Then create a new folder using the option on top, and set a name for the folder. The name should be the exact same as your server’s id in your metadata.json file ("id": "lunarnetwork").

• Now drag and drop your metadata.json file you previously created, as well as your logo.png file, right on the folder you created (and if you also have a banner/background/wordmark, upload that too). Make sure you don’t upload it to another server’s folder by accident!

• Next, you have to commit & push your changes. Click on Source Control (or press Ctrl + Shift + G), give it a name (anything, like Add LunarNetwork, as this doesn’t really matter), click on “Commit & Push”, and wait for it to be done.

🚀 Step 5 - Submit a Pull Request

• Close the web editor, go back to your GitHub profile, then repositories, and click on your forked repository. If you’ve done everything correctly, you should see an option to “Contribute”. Click on that, and open pull request.

• All you have to do here is to click on “Create pull request”.

• For the title of your pull request, explain what you’re doing. In my case, I’m adding LunarNetwork to ServerMappings, so the title will be “Add LunarNetwork”.

• Finally, click on “Create pull request”, and your pull request should now be submitted.

• To check if you’ve done everything correctly, visit the official ServerMappings repository by LunarClient, go to the pull requests tab, and you should see your pull request listed in there. If it has the “Ready for review” label, you’re good to go.

• However, if it doesn’t have the label, click on it, and check for any comments on your pull request, requesting for something to be changed. Here’s an example:

• Congrats! You’ve submitted your pull request. Remember, pull requests are manually reviewed, so it might take up to a week for them to be looked at. Please be patient and check your pull request’s status once a while, so you’re aware when it gets merged, or when a change is required.

📚 “I need some help with this!”

Join the Lunar Client Developers Discord server and everyone will be happy to help you!

Brought to you by Vaption, good luck adding your server!