Whitelist – StarMade

Introduction

This article briefly describes how to add a Whitelist to a StarMade server. The principle of a Whitelist is quite simple: players on the Whitelist are allowed on the server, while all others are not. There are three different ways to use a Whitelist: by name, IP address, or the account system from the StarMade registry. This article, however, describes only the account system, as the other two methods are considered unsafe and are therefore only suitable for testing.

Creation of a StarMade account/Uplinking the account

First, create an account on StarMade Registry. To create an account, only a desired username, an email address, and a password are required. Then, confirm the account via the email link. After this step, you need to “uplink” the account in-game. Simply go to the game and click “Uplink To StarMade.org” in the main window.

Then a window will open where you enter the recently created account details. These can be saved to avoid having to enter them each time you start the game. If the uplinking is successful, no message will appear, and you will return to the main window.

Perform service settings

To activate the Whitelist on the server, a few settings need to be adjusted. First, open the StarMade server.cfg in the Web Interface via the Config Editor [extended] v2. Then press “CTRL + F” on your keyboard to open a search window in the browser and search for the following settings (also variables):

USE_STARMADE_AUTHENTICATION REQUIRE_STARMADE_AUTHENTICATION USE_WHITELIST

Replace “false” with “true” for each setting so that they look like this:

USE_STARMADE_AUTHENTICATION = true // Allow StarMade.org authentication
REQUIRE_STARMADE_AUTHENTICATION = true // Require StarMade.org authentication (USE_STARMADE_AUTHENTICATION must be true)
USE_WHITELIST = true // Only names/IPs from whitelist.txt are allowed
    

Then save the file. The settings will be applied after a server restart.

Add players to Whitelist

Since no players have been added to the Whitelist yet, nobody can join the server. There are two ways to edit the Whitelist: through the in-game console or via the Config Editor [extended] v2.

Whitelist using the Config Editor [extended] v2

To edit the Whitelist via the Config Editor [extended] v2, open the editor and select whitelist.txt. This file is empty. Enter the usernames that should be added to the Whitelist according to the following scheme:

Act: -1: USERNAME1
Act: -1: USERNAME2
    

Replace “USERNAME1” and “USERNAME2” with the respective usernames. Save the file, restart the server, and then check the server.

Whitelist using the in-game console

To use the in-game console, the admin must be logged into the server. This is only possible if the admin has been added to the Whitelist via Config Editor [extended] v2 or has entered the game while the Whitelist was not active yet. To add a player to the Whitelist using the in-game console, the administrator must be set as an admin on the server. To do this, open the File Browser in the Web Interface and navigate to the /niXXXX_X/starmade/StarMade folder. There is an admins.txt file. Click the “Pen” icon to the left to open the file. Enter the usernames according to the following scheme:

USERNAME1
USERNAME2
    

Restart the server. In-game, you can now open the console by pressing the Enter key and use the following command to add a user:

/Whitelist_account USERNAME