Skip to main content

How to add a description to a Minecraft server

Put a readme.md file in the root of the server folder: ProximaClient shows it as the description on the server page. Whoever you pass the server to imports it into ProximaClient and sees right away what's inside and how to run it.

Steps​

  1. In the root of the server folder, next to server.properties, create a readme.md file (letter case doesn't matter). The app doesn't read files with another name or extension, such as README.txt.
  2. Write the description in Markdown: headings, lists, links and emphasis are displayed.

Check it: open the server page in ProximaClient. The description opens by itself (once), and after that it opens with the ⓘ icon next to the server name.

What to write​

The Minecraft version and the core, the list of mods or plugins, how to run the server and how to reach you.