How to set up a Lego Universe Server using DLU

Foreword

This guide showcases how to set up a Darkflame Universe server for Lego Universe on Linux (and the Windows Subsystem for Linux WSL)

It has been tested and deemed working ob both WSL 1 running Ubuntu 20.04, HiveOS (basically Ubuntu 18.04) and on Ubuntu 20.04 Azure and Oracle VMs.

The guide is constantly being updated to be more accurate for inexperienced users and to showcase ways of automating the setup process, as well as showcasing how to automate server maintenance and how to keep it up to date.

Youtube Tutorial

(Semi-)Automatic Installation

(*) As of recently, there is a Dockerfile available for easily building the server. To run this, download it to the folder where the res and locale directories are present, and then just execute docker build . -t lego_universe to build the image, and then run the image using

docker run -p 1001:1001/udp -p 2000:2000/udp -p 2005:2005/udp -p 3000-3300:3000-3300/udp lego_universe

The server will listen on the docker container's ip address by default, and you will be able to access the server on localhost.

Below you can find a tool called buildserver.sh that automatically does almost all the steps in this tutorial. The only thing you need to do is download the client to the machine you wish to build the server on and supply the res folder's location to the tool when prompted. Note: Due to the nature of Bash, usage of ~ is not permitted. Furthermore, leave out the trailing slash and use slashes instead of backslashes. A valid res path would look like this

/home/ubuntu/client/res

Prerequisites

Install the Windows Subsystem for Linux (WSL), it is much easier than doing the stuff in native windows. Or drop Windows for the server altogether and use Linux. This might generally be a good idea as I've had 6 Bluesreens of Death because of memory leaks in the MySQL connector and due to accidentally misconfiguring the server's ini files. On linux the MySQL server would crash, where on Windows it wouldn't be able to handle MySQL crashing in WSL.

After installing wsl, launch a commandline console (Windows Terminal preferrably) and enter "wsl" and hit enter to launch the Windows Subsystem for Linux. On Linux, open a Terminal instance.

Getting the sourcecode

You can get the sourcecode from Darkflame's Github or from my Fork

Installing git

Install git using

sudo apt install git -y

Downloading the sourcecode

To clone the repository, copy the repository link and execute

git clone https://github.com/DarkflameUniverse/DarkflameServer.git --recursive

**Note:** If you forget the "--recursive" tag then you need to initialize the submodules afterwards using

git submodule init
git submodule update --recursive

Installing Required Libraries

To compile the sourcecode you need both cmake and gcc, along with the ZLib library. Install them using

sudo apt update && sudo apt upgrade -y && sudo apt install gcc cmake zlib1g-dev -y

You might have to install build-essential and zlib aswell

sudo apt-get update
sudo apt-get install build-essential -y
sudo apt-get install zlib1g-dev -y

Setting the correct Network Protocol

Nano into the file "CMakeVariables.txt" and set "NET_VERSION" to 171022. If using a DLU Client (modded), set it to 171023.

Nano can be used by typing in "nano" followed by the file you would like to edit. To exit nano, hit CTRL+X then y and then enter to save. If you wish to discard the changes, type n instead of y when prompted.

For example, to edit the CMakeVariables.txt file type in

nano CMakeVariables.txt

Compiling the sourcecode

CD into the directory that was created and then execute the following series of commands

mkdir build
cd build
cmake ..
make

One-liner

mkdir build && cd build && sudo apt update && sudo apt upgrade -y && cmake .. && make

Setting up the database

mariaDB

• Install MariaDB

sudo apt-get install mariadb-server -y

• Start the service

sudo /etc/init.d/mysql start

on Linux, you can just execute

sudo service mysql start

instead.

• Login

sudo mysql -u root -p

and enter the password (if you haven't changed it, the password is also root)

• Create a new database and name it whatever you like, in this example we're using "darkflame"

CREATE DATABASE `darkflame`;

• Create a new user for the darkflame server (the server should NOT connect using the root user!)

CREATE USER 'dflame'@'localhost' IDENTIFIED BY 'dflame';
GRANT ALL PRIVILEGES ON darkflame.* TO 'dflame'@'localhost';

• Note: The user also needs access to the dbo.UNIX_TIMESTAMP subroutine so the WorldServer doesn't crash whenever you load a leaderboard ingame. Execute

GRANT EXECUTE ON PROCEDURE dbo.UNIX_TIMESTAMP TO 'dflame'@'localhost';

or

GRANT EXECUTE ON PROCEDURE UNIX_TIMESTAMP TO 'dflame'@'localhost'; 

• You can check the available databases to make sure yours was created using

show databases;

• Select the database using

use darkflame;

Creating tables

• Either execute the following while in the build/ directory

mysql -u dflame -p darkflame < ../migrations/dlu/0_initial.sql
mysql -u dflame -pdflame darkflame < ../migrations/dlu/1_unique_charinfo_names.sql
mysql -u dflame -pdflame darkflame < ../migrations/dlu/2_reporter_id.sql
mysql -u dflame -pdflame darkflame < ../migrations/dlu/3_add_performance_cost.sql
mysql -u dflame -pdflame darkflame < ../migrations/dlu/4_friends_list_objectids.sql
mysql -u dflame -pdflame darkflame < ../migrations/dlu/5_brick_model_sd0.sql
mysql -u dflame -pdflame darkflame < ../migrations/dlu/6_property_behaviors.sql
mysql -u dflame -pdflame darkflame < ../migrations/dlu/7_make_play_key_id_nullable.sql
mysql -u dflame -pdflame darkflame < ../migrations/dlu/8_foreign_play_key.sql
mysql -u dflame -pdflame darkflame < ../migrations/dlu/9_Update_Leaderboard_Storage.sql
mysql -u dflame -pdflame darkflame < ../migrations/dlu/10_Security_updates.sql
mysql -u dflame -pdflame darkflame < ../migrations/dlu/11_fix_cheat_detection_table.sql

• Or create the tables from the initial.sql file manually (you can copy paste each query - or the whole big query - into the console and then hit enter)

CREATE OR REPLACE TABLE accounts (
    id INT NOT NULL AUTO_INCREMENT PRIMARY KEY,
    name VARCHAR(35) NOT NULL UNIQUE,
    password TEXT NOT NULL,
    gm_level INT UNSIGNED NOT NULL DEFAULT 0,
    locked BOOLEAN NOT NULL DEFAULT FALSE,
    banned BOOLEAN NOT NULL DEFAULT FALSE,
    play_key_id INT NOT NULL DEFAULT 0,
    created_at TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP(),
    mute_expire BIGINT UNSIGNED NOT NULL DEFAULT 0
);
CREATE OR REPLACE TABLE charinfo (
    id BIGINT NOT NULL PRIMARY KEY,
    account_id INT NOT NULL REFERENCES accounts(id),
    name VARCHAR(35) NOT NULL,
    pending_name VARCHAR(35) NOT NULL,
    needs_rename BOOLEAN NOT NULL DEFAULT FALSE,
    prop_clone_id BIGINT UNSIGNED AUTO_INCREMENT UNIQUE,
    last_login BIGINT UNSIGNED NOT NULL DEFAULT 0,
    permission_map BIGINT UNSIGNED NOT NULL DEFAULT 0
);
CREATE OR REPLACE TABLE charxml (
    id BIGINT NOT NULL PRIMARY KEY REFERENCES charinfo(id),
    xml_data LONGTEXT NOT NULL
);
CREATE OR REPLACE TABLE command_log (
    id INT NOT NULL AUTO_INCREMENT PRIMARY KEY,
    character_id BIGINT NOT NULL REFERENCES charinfo(id),
    command VARCHAR(256) NOT NULL
);
CREATE OR REPLACE TABLE friends (
    player_id BIGINT NOT NULL REFERENCES charinfo(id),
    friend_id BIGINT NOT NULL REFERENCES charinfo(id),
    best_friend BOOLEAN NOT NULL DEFAULT FALSE,
    PRIMARY KEY (player_id, friend_id)
);
CREATE OR REPLACE TABLE leaderboard (
    id INT NOT NULL AUTO_INCREMENT PRIMARY KEY,
    game_id INT UNSIGNED NOT NULL DEFAULT 0,
    last_played TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP(),
    character_id BIGINT NOT NULL REFERENCES charinfo(id),
    time BIGINT UNSIGNED NOT NULL,
    score BIGINT UNSIGNED NOT NULL DEFAULT 0
);
CREATE OR REPLACE TABLE mail (
    id INT NOT NULL AUTO_INCREMENT PRIMARY KEY,
    sender_id INT NOT NULL DEFAULT 0,
    sender_name VARCHAR(35) NOT NULL DEFAULT '',
    receiver_id BIGINT NOT NULL REFERENCES charinfo(id),
    receiver_name VARCHAR(35) NOT NULL,
    time_sent BIGINT UNSIGNED NOT NULL,
    subject TEXT NOT NULL,
    body TEXT NOT NULL,
    attachment_id BIGINT NOT NULL DEFAULT 0,
    attachment_lot INT NOT NULL DEFAULT 0,
    attachment_subkey BIGINT NOT NULL DEFAULT 0,
    attachment_count INT NOT NULL DEFAULT 0,
    was_read BOOLEAN NOT NULL DEFAULT FALSE
);
CREATE OR REPLACE TABLE object_id_tracker (
    last_object_id BIGINT UNSIGNED NOT NULL DEFAULT 0 PRIMARY KEY
);
CREATE OR REPLACE TABLE pet_names (
    id BIGINT NOT NULL AUTO_INCREMENT PRIMARY KEY,
    pet_name TEXT NOT NULL,
    approved INT UNSIGNED NOT NULL
);
CREATE OR REPLACE TABLE play_keys (
    id INT NOT NULL AUTO_INCREMENT PRIMARY KEY,
    key_string CHAR(19) NOT NULL UNIQUE,
    key_uses INT NOT NULL DEFAULT 1,
    created_at TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP(),
    active BOOLEAN NOT NULL DEFAULT TRUE
);
CREATE OR REPLACE TABLE properties (
    id BIGINT NOT NULL PRIMARY KEY,
    owner_id BIGINT NOT NULL REFERENCES charinfo(id),
    template_id INT UNSIGNED NOT NULL,
    clone_id BIGINT UNSIGNED REFERENCES charinfo(prop_clone_id),
    name TEXT NOT NULL,
    description TEXT NOT NULL,
    rent_amount INT NOT NULL,
    rent_due BIGINT NOT NULL,
    privacy_option INT NOT NULL,
    mod_approved BOOLEAN NOT NULL DEFAULT FALSE,
    last_updated BIGINT NOT NULL,
    time_claimed BIGINT NOT NULL,
    rejection_reason TEXT NOT NULL,
    reputation BIGINT UNSIGNED NOT NULL,
    zone_id INT NOT NULL
);
CREATE OR REPLACE TABLE ugc (
    id INT NOT NULL AUTO_INCREMENT PRIMARY KEY,
    account_id INT NOT NULL REFERENCES accounts(id),
    character_id BIGINT NOT NULL REFERENCES charinfo(id),
    is_optimized BOOLEAN NOT NULL DEFAULT FALSE,
    lxfml MEDIUMBLOB NOT NULL,
    bake_ao BOOLEAN NOT NULL DEFAULT FALSE,
    filename TEXT NOT NULL DEFAULT ''
);
CREATE OR REPLACE TABLE properties_contents (
    id BIGINT NOT NULL PRIMARY KEY,
    property_id BIGINT NOT NULL REFERENCES properties(id),
    ugc_id INT NULL REFERENCES ugc(id),
    lot INT NOT NULL,
    x FLOAT NOT NULL,
    y FLOAT NOT NULL,
    z FLOAT NOT NULL,
    rx FLOAT NOT NULL,
    ry FLOAT NOT NULL,
    rz FLOAT NOT NULL,
    rw FLOAT NOT NULL
);
CREATE OR REPLACE TABLE activity_log (
    id INT NOT NULL AUTO_INCREMENT PRIMARY KEY,
    character_id BIGINT NOT NULL REFERENCES charinfo(id),
    activity INT NOT NULL,
    time BIGINT UNSIGNED NOT NULL,
    map_id INT NOT NULL
);
CREATE OR REPLACE TABLE bug_reports (
    id INT NOT NULL AUTO_INCREMENT PRIMARY KEY,
    body TEXT NOT NULL,
    client_version TEXT NOT NULL,
    other_player_id TEXT NOT NULL,
    selection TEXT NOT NULL,
    submitted TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP()
);
CREATE OR REPLACE TABLE servers (
    id INT NOT NULL AUTO_INCREMENT PRIMARY KEY,
    name TEXT NOT NULL,
    ip TEXT NOT NULL,
    port INT NOT NULL,
    state INT NOT NULL,
    version INT NOT NULL DEFAULT 0
);

• Check to see that all tables were created using

SHOW TABLES;

• Exit by typing in "exit" and hitting enter

Res Folder Setup

• In the "build/" directory create a new directory called "res"

mkdir res

• Copy the folders "maps", "macros", "BrickModels", "names" and the file "chatplus_en_us.txt" from the "res/" folder in your client to the "res/" folder in the server's "build/" folder
• If you want to be able to use additonal words other than the ones in the chatplus file, execute the following (while in "build/res"):

curl -O https://raw.githubusercontent.com/dwyl/english-words/master/words.txt
cat words.txt >> chatplus_en_us.txt
rm words.txt

This will add "over 466k English words" to the allowed wordlist (including cuss words, you can remove these).

• [NOTE] In earlier commits the chat didn't work because the "chatplus_en_us.txt" had DOS line endings (\n\r) and these needed to be converted to unix ones (\n). One way to do this is using dos2unix:

sudo apt-get install dos2unix -y
dos2unix chatplus_en_us.txt

• [NOTE] In earlier commits unapproved pet names also had a visual bug where the background was shifted. This was also due to their DOS line endings. If you face this issue, go into the "names/" directory and execute dos2unix for every txt file in it.
• Unzip the "/resources/navmeshes.zip" file to "build/res/maps/navmeshes" (the binary files should be inside the folder navmeshes). The following command can be executed from the "build/" directory.

mkdir res/maps/navmeshes/
unzip ../resources/navmeshes.zip res/maps/navmeshes/.

[NOTE] If you missed this step you will notice as soon as stromlings start glitching through walls.

• In the build directory create a "locale" directory if it does not already exist.

mkdir locale

• Copy over or create symlinks from "locale.xml" in your client's "locale" directory to the "build/locale" directory (simlink: "ln -s path/to/client/directory/locale/locale.xml locale/locale.xml" - note that the client directory must always be accessible to the server and the location must never change, therefor copying it is recommended)

SQLite Setup

• Download this using the following command (on Windows execute the following in CMD, DO NOT execute it in Powershell as the syntax will be marked as incorrect, because "curl" in Powershell is an alias of Invoke-WebRequest. You can remove the alias using "Remove-Alias -Name curl" or in powershell 5.x+ "Remove-Item Alias:someAlias")

curl -O https://raw.githubusercontent.com/lcdr/utils/master/utils/fdb_to_sqlite.py

and place it inside the unpacked client's "res" folder, then execute (while in the clients unpacked "res/" folder, on Windows omit the "3" in "python3")

python3 ./fdb_to_sqlite.py ./cdclient.fdb

• Rename "cdclient.sqlite" into "CDServer.sqlite" and move it from the client's "res/" folder into the server's "build/res" directory. ("build/res/CDServer.sqlite")
• Install sqlite3

sudo apt install sqlite3 -y

• Execute the queries found under "migrations/cdserver" (while in "/build/res"). [NOTE] If it says that the files cannot be found, you either did not use the --recursive flag while cloning the directory or did not move the CDServer.sqlite into the right location. Please see above how to initiate the submodules after having already cloned the repository if the first point applies.

sqlite3 CDServer.sqlite < ../../migrations/cdserver/0_nt_footrace.sql
sqlite3 CDServer.sqlite < ../../migrations/cdserver/1_fix_overbuild_mission.sql
sqlite3 CDServer.sqlite < ../../migrations/cdserver/2_script_component.sql
sqlite3 CDServer.sqlite < ../../migrations/cdserver/3_plunger_gun_fix.sql
sqlite3 CDServer.sqlite < ../../migrations/cdserver/4_nt_footrace_parrot.sql

DO NOT DELETE THE cdclient.fdb FILE AS DLU NOW CHECKS FOR ITS EXISTANCE TO DETERMINE THE CLIENT VERSION. If you are updating your server to the latest version, you need to copy the file over again if you deleted it prior to the latest update (October 2022).

INI Files

• In the build folder there will now be 4 ini files (authconfig.ini, chatconfig.ini, masterconfig.ini, worldconfig.ini, sharedconfig.ini). Nano into each of them (or use whatever other text editor you use) and set the database address to 127.0.0.1 (or localhost), the username and password to the ones you set above in MariaDB and the database name to the name you set above. Example:

mysql_host=127.0.0.1
mysql_database=darkflame
mysql_username=dflame
mysql_password=dflame

Additionally, you might have to add the following line to sharedconfig.ini:

client_location=./res

If you want to run the server locally or online, you will have to also set the "external_ip" accordingly. See section "Online Multiplayer" for help setting this address.

Validate

Before running the server, make sure your "build" directory has the following structure and that no files are missing:

DarkflameServer/
├── build/
|   ├── AuthServer
|   ├── ChatServer
|   ├── MasterServer
|   ├── WorldServer
|   ├── locale/
|   │   └── locale.xml
|   ├── res/
|   |   ├── cdclient.fdb
|   |   ├── CDServer.sqlite
|   |   ├── chatplus_en_us.txt
|   |   ├── macros/
|   |   |   └── ...
|   |   ├── BrickModels/
|   |   |   └── ...
|   |   ├── maps/
|   |   |   ├── navmeshes/
|   |   |   |   └── ...
|   |   |   └── ...
|   |   └── names/
|   |       └── ...
|   ├── authconfig.ini
|   ├── chatconfig.ini
|   ├── masterconfig.ini
|   ├── worldconfig.ini
|   ├── sharedconfig.ini
|   └── ...
└── ...

Adding Admin user and running server

• While in the server's "build" directory, execute

./MasterServer -a

to add an admin

• Run the server using

sudo ./MasterServer

(sudo because the port is under 1000 and either needs firewall access or sudo)

Brick-by-Brick Building

Note: it seems like this issue has been fixed and it is no longer required to do any of the following steps. If you're still on an older server version, you should update it.

For Brick-by-Brick building, an HTTP server should be running and returning error code "404-Not Found" at all times on the client side. This can be achieved by running a python simple HTTP server in the background. To do this, execute the following command on a client's machine:

python3 -m http.server 80 &

The HTTP server may later be terminated by bringing it back to the foreground using

fg

and then by hitting CTRL+C.

Alternatively, you can set the client's UGCSERVERIP in the client's boot.cfg file to leolion3.github.io/404 as shown below:

UGCSERVERIP=0:leolion3.github.io/404

Known Errors

Errors in MySQL Connector

If you receive any type of error saying there was an error with the MySQL Connector, then ensure that:

• the MySQL Service is running

sudo service mysql status

• The database was configured correctly, and the server is able to access the database you created. To test this, try to manually log into mysql using the username/password you set for the server

mysql -u dflame -p

then check to make sure the database exists

show databases;

then check to make sure the tables exist

use darkflame;
show tables;

the following tables should exist:

+---------------------+
| Tables_in_darkflame |
+---------------------+
| accounts            |
| activity_log        |
| bug_reports         |
| charinfo            |
| charxml             |
| command_log         |
| friends             |
| leaderboard         |
| mail                |
| object_id_tracker   |
| pet_names           |
| play_keys           |
| properties          |
| properties_contents |
| servers             |
| ugc                 |
+---------------------+

then check to make sure the tables configured correctly by attempting to read out some of the data

select * from accounts;

which should return a table containing some data (if you already created an admin), as shown below

+----+-------------+--------------------------------------------------------------+----------+--------+--------+-------------+---------------------+-------------+
| id | name        | password                                                     | gm_level | locked | banned | play_key_id | created_at          | mute_expire |
+----+-------------+--------------------------------------------------------------+----------+--------+--------+-------------+---------------------+-------------+
|  1 | TestAccount | $2a$12$N0bXz4ERLQFr9pcrhl3JtekXrj0tLFamObrkDjwi/QGMv46TRHnWm |        9 |      0 |      0 |           0 | 2021-12-05 00:00:00 |           0 |
+----+-------------+--------------------------------------------------------------+----------+--------+--------+-------------+---------------------+-------------+

Manually Updating User Data

If for some reason you need to manually update user data, you can do so by logging into mysql and updating the tables. In this example, I will showcase how to manually update a user's password.

The user passwords are hashed using BCrypt with 12 rounds. For creating the hash and keeping things simple, I will be using an online tool.

Our reference user is going to be a user named "TestAccount" with a current password of "Test" (irrelevant) and an ID of "1" (knowing the user's ID is key to being able to change his data in the table). My current "accounts" table looks like this (see above how to show data from a table in MySQL):

+----+-------------+--------------------------------------------------------------+----------+--------+--------+-------------+---------------------+-------------+
| id | name        | password                                                     | gm_level | locked | banned | play_key_id | created_at          | mute_expire |
+----+-------------+--------------------------------------------------------------+----------+--------+--------+-------------+---------------------+-------------+
|  1 | TestAccount | $2a$12$N0bXz4ERLQFr9pcrhl3JtekXrj0tLFamObrkDjwi/QGMv46TRHnWm |        9 |      0 |      0 |           0 | 2021-12-05 00:00:00 |           0 |
+----+-------------+--------------------------------------------------------------+----------+--------+--------+-------------+---------------------+-------------+

• First off, log into mysql using your username/password combination and then select the server's database:

mysql -u dflame -p

USE darkflame;

• Generate a new password using the online tool. My new password will be "test123" (your hash for the same password will look different because of the different salt used), with a hash value of "$2a$12$J.38IJLJLbvPwkaYsCayqef.9lsXFwyuUFiaAN0Om2XVpzMIvyHjK".
• Update the "password" column in the "accounts" table using:

UPDATE accounts SET password='$2a$12$J.38IJLJLbvPwkaYsCayqef.9lsXFwyuUFiaAN0Om2XVpzMIvyHjK' WHERE id=1;

• You should get a prompt telling you the query executed successfully

Query OK, 1 row affected (0.017 sec)
Rows matched: 1  Changed: 1  Warnings: 0

• Check to see the changed data

select * from accounts;

+----+-------------+--------------------------------------------------------------+----------+--------+--------+-------------+---------------------+-------------+
| id | name        | password                                                     | gm_level | locked | banned | play_key_id | created_at          | mute_expire |
+----+-------------+--------------------------------------------------------------+----------+--------+--------+-------------+---------------------+-------------+
|  1 | TestAccount | $2a$12$J.38IJLJLbvPwkaYsCayqef.9lsXFwyuUFiaAN0Om2XVpzMIvyHjK |        9 |      0 |      0 |           0 | 2021-12-05 00:00:00 |           0 |
+----+-------------+--------------------------------------------------------------+----------+--------+--------+-------------+---------------------+-------------+

Client Config

Please ensure that you and your friends change the line UGCUSE3DSERVICES=7:1, in your boot.cfg file to UGCUSE3DSERVICES=7:0,

Not doing this can result in disconnects after finishing certain missions/achievements on an attempted world switch.

Avant Gardens Survival Bug

As stated on the Darkflame Repository: "The client script for the survival minigame has a bug in it which can cause the minigame to not load." Fox fixing this, do the following:

• open the client's "res/scripts/ai/minigame/survival/l_zone_survival_client.lua" in a text editor. (preferably one with line count displayed)
• Navigate all the way to the bottom to line 617
• Where it says "PlayerReady(self)", change it to "onPlayerReady(self)"
• Save the file, overwriting Read-only mode. If it cannot be edited in Notepad++, click on "Edit" and then on "Clear Read-Only Flag" and repeat the steps above.

Assembly Logo not Displayed

The Assembly Logo is not correctly displayed in some unpacked clients. The reason for this is a misconfigured path in the client's "assembly_sign_anim_sm.kfm" file. To fix it, do the following:

• open the file "res/animations/3dui/assembly_sign_anim_sm.kfm". Don't worry about all the "NULL" flags, this is due to the nature of the file type.
• In Notepad++, clear the read only flag. See "Avant Gardens Survival Bug" on how to do this. In other text editors, you will have to overwrite the read-only flag when saving.
• Replace the very first readable symbol from a "9" to a "(".
• Replace "z:lwo\4_game\client\res" by .\..\..
• The resulting file should look like this

Connecting to the server

Based on how your server is hosted, you have to set the server's ip address in the client's "boot.cfg" to either of the following:

• localhost - if the server is hosted on the same machine
• The server's IPv4 Address - if the server is hosted on the same network
• The server's public IP Address - if the server is hosted on a different network.

To change the IP Address in the client, edit the "boot.cfg" file and set the IP Address for both the "PATCHSERVERIP" and "AUTHSERVERIP". A valid configuration for a server on the same network (with an IPv4 Address of "192.168.1.123") would look as shown below.

SERVERNAME=0:Your Server's Name,
PATCHSERVERIP=0:192.168.1.123,
AUTHSERVERIP=0:192.168.1.123,
[... More stuff down here ...]

Automation

Foreword

This section is NOT intended for normal server operators. While the functionalities below are indeed very useful they may be a tad too complex for normal users. You may attempt to set up some of the below functionalities for your server, but you may indeed fail.

Note: Don't forget to enable the x-bit on the bash scripts to be able to execute them (if not using a .sh file extension) using chmod +x filename

Keeping Server Up-to-Date

Now since the server's source code is ever changing, one wants to be able to update the server without losing the current ingame progress. To cope with this, one might want to use 2 repositories instead of 1:

• One containing the server's source code, which is updated occasionally to include the newest features and bug fixes
• Another one containing the actual server, which is backed up to the cloud (or to a local resource) to store the users' progress and not have to go through the entire setup process every single time the server is updated.

The way I set this up is with the following structure:

Somefolder/
└── DarkflameServer/
└── Github/
    └── DarkflameServer/

The "DarkflameServer" has the same internal structure of "Github/DarkflameServer", however instead of actually containing the same directories and C++ source files it instead has symlinks to the files inside the "Github/DarkflameServer" directory. This allows me to independantly update the "DarkflameServer" repository without affecting the current server's status, since the "DarkflameServer" directory is also a git repository, which is instead used for backing up the server. To skip the whole "res" folder setup, I also chose to keep the "res" folder in my own repository by removing it from the .gitignore. This means that all I have to do when updating the server's source code is to re-run the "make" instruction and then replace the ini files with my server's config files, where both tasks have also been automated using some bash scripts.

Note: In the following steps, whenever the "original DarkflameServer directory" is mentioned we are talking about the "DarkflameServer/" directory and not about "Github/DarkflameServer". E.g. your own repository with your own version of the server which only contains symlinks, not the actual clone of DarkflameServer by DLU.

To do this yourself

• Create the top directory and clone a version of "DarkflameServer" into it and set it up as explained above (set up the server as you normally would). After doing so, navigate into the root of the cloned repository and delete the following directories and files:
  • .git - since we are going to set up a different git repository for backing up our server. You may aswell just change the upstream URL inside the .git/config file, but this is not recommended for less experienced people.
  • CMakeLists.txt
  • CMakeVariables.txt
  • dAuthServer
  • dChatFilter
  • dChatServer
  • dCommon
  • dDatabase
  • dGame
  • dMasterServer
  • dNet
  • dPhysics
  • dScripts
  • dNavigation
  • dWorldServer
  • dZoneManager
  • migrations
  • resources
  • thirdparty
  • vanity
  • versions.txt using:

rm -rf .git
rm CMakeLists.txt
rm CMakeVariables.txt
rm -rf dAuthServer
rm -rf dChatFilter
rm -rf dChatServer
rm -rf dCommon
rm -rf dDatabase
rm -rf dGame
rm -rf dMasterServer
rm -rf dNet
rm -rf dPhysics
rm -rf dScripts
rm -rf dNavigatiom
rm -rf dWorldServer
rm -rf dZoneManager
rm -rf migrations
rm -rf resources
rm -rf thirdparty
rm -rf vanity
rm versions.txt

• Navigate out of the "DarkflameServer" directory and create a new directory called "Github". cd into this directory and clone the "DarkflameServer" repository again.
• Create symlinks for the previously deleted files to the newly cloned repository (execute these while in the original "DarkflameServer" directory, not the "Github/DarkflameServer" one)

ln -s ../Github/DarkflameServer/CMakeLists.txt CMakeLists.txt
ln -s ../Github/DarkflameServer/CMakeVariables.txt CMakeVariables.txt
ln -s ../Github/DarkflameServer/dAuthServer dAuthServer
ln -s ../Github/DarkflameServer/dChatFilter dChatFilter
ln -s ../Github/DarkflameServer/dChatServer dChatServer
ln -s ../Github/DarkflameServer/dCommon dCommon
ln -s ../Github/DarkflameServer/dDatabase dDatabase
ln -s ../Github/DarkflameServer/dGame dGame
ln -s ../Github/DarkflameServer/dMasterServer dMasterServer
ln -s ../Github/DarkflameServer/dNet dNet
ln -s ../Github/DarkflameServer/dPhysics dPhysics
ln -s ../Github/DarkflameServer/dNavigation dNavigation
ln -s ../Github/DarkflameServer/dScripts dScripts
ln -s ../Github/DarkflameServer/dWorldServer dWorldServer
ln -s ../Github/DarkflameServer/dZoneManager dZoneManager
ln -s ../Github/DarkflameServer/migrations migrations
ln -s ../Github/DarkflameServer/resources resources
ln -s ../Github/DarkflameServer/thirdparty thirdparty
ln -s ../Github/DarkflameServer/vanity vanity
ln -s ../Github/DarkflameServer/versions.txt versions.txt

• Create a directory called ini_files and cd into it
• Copy over the 4 ini files you configured previously to this directory
• Create a file called fix_ini_files:

cp authconfig.ini ../build/authconfig.ini
cp chatconfig.ini ../build/chatconfig.ini
cp masterconfig.ini ../build/masterconfig.ini
cp worldconfig.ini ../build/worldconfig.ini

• Whenever you rebuild the server, simply cd into ini_files and execute ./fix_ini_files to copy over your configs.
• Modify the ".gitignore" file inside the original "DarkflameServer" directory to include the "res/" and "locale/" directories:

!build/res/
!build/locale/

• Create a new repository somewhere (locally or on Github/Gitlab etc.) and clone it locally. Then move the .git directory from it into the original "DarkflameServer" directory. (replacing the one we deleted previously)
• You may now back-up your server independently, all the while keeping it up to date with Darkflame. (You just have to pull the "Github/DarkflameServer" repository whenever it is updated and recompile your server)

Note: Since the symlinks may break when you clone the repository to a different system, you may want to add a "fixlnks" file in the root of your repository to automate the symlink creation:

rm CMakeLists.txt
rm CMakeVariables.txt
rm dAuthServer
rm dChatFilter
rm dChatServer
rm dCommon
rm dDatabase
rm dGame
rm dMasterServer
rm dServer
rm dNet
rm dPhysics
rm dScripts
rm dWorldServer
rm dZoneManager
rm migrations
rm resources
rm thirdparty
rm vanity
rm cmake
rm versions.txt
ln -s ../Github/DarkflameServer/dServer dServer
ln -s ../Github/DarkflameServer/cmake cmake
ln -s ../Github/DarkflameServer/CMakeLists.txt CMakeLists.txt
ln -s ../Github/DarkflameServer/CMakeVariables.txt CMakeVariables.txt
ln -s ../Github/DarkflameServer/dAuthServer dAuthServer
ln -s ../Github/DarkflameServer/dChatFilter dChatFilter
ln -s ../Github/DarkflameServer/dChatServer dChatServer
ln -s ../Github/DarkflameServer/dCommon dCommon
ln -s ../Github/DarkflameServer/dDatabase dDatabase
ln -s ../Github/DarkflameServer/dGame dGame
ln -s ../Github/DarkflameServer/dMasterServer dMasterServer
ln -s ../Github/DarkflameServer/dNet dNet
ln -s ../Github/DarkflameServer/dPhysics dPhysics
ln -s ../Github/DarkflameServer/dScripts dScripts
ln -s ../Github/DarkflameServer/dWorldServer dWorldServer
ln -s ../Github/DarkflameServer/dZoneManager dZoneManager
ln -s ../Github/DarkflameServer/migrations migrations
ln -s ../Github/DarkflameServer/resources resources
ln -s ../Github/DarkflameServer/thirdparty thirdparty
ln -s ../Github/DarkflameServer/vanity vanity
ln -s ../Github/DarkflameServer/versions.txt versions.txt

Backing up and restoring server database

To back up your server's database, you can dump it to an sql file:

sudo /etc/init.d/mysql start
mysqldump -u dflame -p darkflame > backup.sql
sudo /etc/init.d/mysql stop

The data can also be restored using:

sudo /etc/init.d/mysql start
mysql -u dflame -p darkflame < darkflame.sql
sudo /etc/init.d/mysql stop

If you have set up your own github repository for your server as shown previously, then you might want to automate the back-up process of your database. To do this, in the root of your repository "DarkflameServer/":

• create a directory called darkflame_database and another one called fix_database.
• cd into fix_database
• create a file named export_database:

rm ../darkflame_database/darkflame.sql
sudo /etc/init.d/mysql start
mysqldump -u dflame -p darkflame > ../darkflame_database/darkflame.sql
sudo /etc/init.d/mysql stop

• create a second file called import_database:

sudo /etc/init.d/mysql start
mysql -u dflame -p darkflame < ../darkflame_database/darkflame.sql
sudo /etc/init.d/mysql stop

• To export your database you may now execute ./export_database. To import it ./import_database.

Note: See the next section for how to automate the backup process further.

Note: Restoring the database without it being empty will most likely not work. To avoid conflicts in the SQL Database, drop the current one and import your backup instead.

drop database darkflame;
create database darkflame;

Note: If you would like to automate your repo backup using a Cron job while the server is running, then you have to omit the sudo /etc/init.d/mysql start and sudo /etc/init.d/mysql stop commands in the backup script (export_database).

Server run/shutdown/backup automation

To automate the server further, cd into the build directory.

• Create a file called "runserver":

sudo service mysql start
sudo ./MasterServer

• Create another file called "endserver":

cd ../fix_database
./export_database
sudo service mysql stop
cd ..
git add .
git commit -m "update database"
git push

• To run the server, simply execute "./runserver". To stop it and back-up your progress, execute "./endserver", which will automatically back up the database to an sql file and push the stuff to your repository.

Automated Backup using Cron job

Note: if you want to back up your server/database while the server is running then you have to omit the sudo /etc/init.d/mysql start and sudo /etc/init.d/mysql stop in export_database and endserver scripts

• Create a new cron job using

crontab -e

• Scroll all the way to the bottom and add a new cron job (The syntax for the first 2 parameters is MM HH, e.g. at what time the job should run. I will set mine to run at 1 am every night). Note that you have to first cd into your server's "build/" directory to be able to execute the backup script, so you need to chain the execution command to a cd command.

* 1 * * * cd /path/to/DarkflameServer/build && ./endserver

• Exit crontab by pressing ESC and then hitting 0

Multiplayer

To set up the server for multiplayer you need to change the "external_ip" in the masterserver's ini file and the IP Addresses in the client's boot config file (set the client's ip address to whatever you set the server's address in the steps below).

LAN Multiplayer

To play on LAN you need to set the "external_ip" to your local IPv4 address. To get it on windows, execute

ipconfig

and copy the value beside "IPv4 Address"

To get it on Linux, execute

ip route get 1.2

• If you don't have "ip", use the legacy "ifconfig" command

ifconfig

Online Multiplayer

To create an online multiplayer the "external_ip" needs to be set to your Public IP Address. You can get this by executing

curl https://api.ipify.org

in Linux or on Windows in CMD (Powershell has an Alias that sets Curl to use Invoke-WebRequest, which returns the data inside the Content variable, so in powershell you would have to execute (curl https://api.ipify.org).Content to get the ip address)

• Alternatively you can go to a website like "https://www.whatismyip.com/" or similar to get your public IP Address

Firewall rules and port forwarding

For using online multiplayer you need your firewall to allow access as well as your router to forward the ports to your local machine. Besides the legal limitations on running a Lego Universe online multiplayer server, I would not recommend running a server on your own machine, on your own network, while having this many ports open because of the security concerns it brings with it for inexperienced users. Proceed at your own risk.

Lego Universe requires the following ports to operate:

• Port 1001 UDP for client authentication
• Ports 3000-3300 (start port is defined in the masterserver's ini and set to 3000) UDP for the worlds
• Port 5000 TCP for the Account Manager

Ports 2000 (masterserver) and 2005 (account manager) dont need to be forwarded!

You will need to both allow access through firewall for these ports as well as forward them.

Note: If you are running advanced networking gear then make sure "L2 Isolation" is NOT enabled. If you are concerned about security, set up the server on a different virtual network and enable some firewall rules. (In Unifi, create a new Network and set it to be isolated from the rest of your networks, then set LAN In rules to Drop any traffic originating from the Network and going into one of your other networks)

Commands and Items

Commands

Notation:

• <> brackets: this value has to be set
• [] brackets: this value is optional

Command	Functionality	GM Level
/gmlevel <level>	Set player's GM level. 9 is Mythran, 0 is for normal players.
/gmadditem <itemID> [quantity]	Give the player an item (or many if quantity was set)	8

For more see the Darkflame Repo

Special Items

Item	Description
Objects_1727_name (Jetpack)	1727
Objects_2243_name (Insta-kill hammer)	2243