DarkflameServer/README.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

452 lines
22 KiB
Markdown
Raw Normal View History

2021-12-05 17:40:43 +00:00
# <img style="float: left; padding-right: 5px" height=35px width=35px src="logo.png"> Darkflame Universe
## Introduction
Darkflame Universe (DLU) is a server emulator for LEGO® Universe. Development started in 2013 and has gone through multiple iterations and is now able to present a near perfect emulation of the game server.
### LEGO® Universe
Developed by NetDevil and The LEGO Group, LEGO® Universe launched in October 2010 and ceased operation in January 2012.
## License
Darkflame Universe is licensed under AGPLv3, please read [LICENSE](LICENSE). Some important points:
* We are not liable for anything you do with the code
* The code comes without any warranty what so ever
* You must disclose any changes you make to the code when you distribute it
* Hosting a server for others counts as distribution
## Disclaimers
### Setup difficulty
Throughout the entire build and setup process a level of familiarity with the command line and preferably a Unix-like development environment is greatly advantageous.
### Hosting a server
Update README (#806) * Update README The README is very out of date, the following changes have been made - Update what the file tree should look like - Remove client Avant Gardens Survival script fix - Update some incorrect commands or commands that were missing packages. - Add packed client setup instructions - Add *config.ini setup instructions - Describe what configs should be modified and what you may want to change - More detail in the verify step - Change Account Manager link to Nexus Dashboard - Remove table of commands and reference Commands.md instead - Specify that UGCSERVERIP may need to be changed to localhost as well * Fix Avant Gardens Survival This addresses the Avant Gardens Survival bug. Squeezing it in with the README changes since it is a small change. * Remove Locale * Update README.md Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> * Remove dLocale again? * Saving for the night * Revert "Fix Avant Gardens Survival" This reverts commit b1a1ce2d84e870c328a039673c9b77859e6e3dbd. * Update Mission.cpp * Update README.md Move comments and add pre-processor define Update README.md Update README.md Update CMakePresets.json Update CMakeVariables.txt Update README.md i love readmes Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md * Update README.md Co-authored-by: Daniel Seiler <me@xiphoseer.de> * Address feedback * Update README.md * Update Database.cpp * Update README.md * Revert tcp specification Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> Co-authored-by: Aaron Kimbrell <aronwk.aaron@gmail.com> Co-authored-by: Daniel Seiler <me@xiphoseer.de>
2022-12-28 21:58:53 +00:00
We do not recommend hosting public servers. Darkflame Universe is intended for small scale deployment, for example within a group of friends. It has not been tested for large scale deployment which comes with additional security risks.
2021-12-05 17:40:43 +00:00
### Supply of resource files
Update README (#806) * Update README The README is very out of date, the following changes have been made - Update what the file tree should look like - Remove client Avant Gardens Survival script fix - Update some incorrect commands or commands that were missing packages. - Add packed client setup instructions - Add *config.ini setup instructions - Describe what configs should be modified and what you may want to change - More detail in the verify step - Change Account Manager link to Nexus Dashboard - Remove table of commands and reference Commands.md instead - Specify that UGCSERVERIP may need to be changed to localhost as well * Fix Avant Gardens Survival This addresses the Avant Gardens Survival bug. Squeezing it in with the README changes since it is a small change. * Remove Locale * Update README.md Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> * Remove dLocale again? * Saving for the night * Revert "Fix Avant Gardens Survival" This reverts commit b1a1ce2d84e870c328a039673c9b77859e6e3dbd. * Update Mission.cpp * Update README.md Move comments and add pre-processor define Update README.md Update README.md Update CMakePresets.json Update CMakeVariables.txt Update README.md i love readmes Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md * Update README.md Co-authored-by: Daniel Seiler <me@xiphoseer.de> * Address feedback * Update README.md * Update Database.cpp * Update README.md * Revert tcp specification Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> Co-authored-by: Aaron Kimbrell <aronwk.aaron@gmail.com> Co-authored-by: Daniel Seiler <me@xiphoseer.de>
2022-12-28 21:58:53 +00:00
Darkflame Universe is a server emulator and does not distribute any LEGO® Universe files. A separate game client is required to setup this server emulator and play the game, which we cannot supply. Users are strongly suggested to refer to the safe checksums listed [here](#verifying-your-client-files) to see if a client will work.
2023-12-01 00:11:45 +00:00
## Step by step walkthrough for a single-player server
If you would like a setup for a single player server only on a Windows machine, use the [Native Windows Setup Guide by HailStorm](https://gist.github.com/HailStorm32/169df65a47a104199b5cc57d10fa57de) and skip this README.
Update README (#806) * Update README The README is very out of date, the following changes have been made - Update what the file tree should look like - Remove client Avant Gardens Survival script fix - Update some incorrect commands or commands that were missing packages. - Add packed client setup instructions - Add *config.ini setup instructions - Describe what configs should be modified and what you may want to change - More detail in the verify step - Change Account Manager link to Nexus Dashboard - Remove table of commands and reference Commands.md instead - Specify that UGCSERVERIP may need to be changed to localhost as well * Fix Avant Gardens Survival This addresses the Avant Gardens Survival bug. Squeezing it in with the README changes since it is a small change. * Remove Locale * Update README.md Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> * Remove dLocale again? * Saving for the night * Revert "Fix Avant Gardens Survival" This reverts commit b1a1ce2d84e870c328a039673c9b77859e6e3dbd. * Update Mission.cpp * Update README.md Move comments and add pre-processor define Update README.md Update README.md Update CMakePresets.json Update CMakeVariables.txt Update README.md i love readmes Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md * Update README.md Co-authored-by: Daniel Seiler <me@xiphoseer.de> * Address feedback * Update README.md * Update Database.cpp * Update README.md * Revert tcp specification Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> Co-authored-by: Aaron Kimbrell <aronwk.aaron@gmail.com> Co-authored-by: Daniel Seiler <me@xiphoseer.de>
2022-12-28 21:58:53 +00:00
## Steps to setup server
* [Clone this repository](#clone-the-repository)
* [Install dependencies](#install-dependencies)
* [Database setup](#database-setup)
* [Build the server](#build-the-server)
* [Configuring your server](#configuring-your-server)
* [Required Configuration](#required-configuration)
* [Optional Configuration](#optional-configuration)
* [Verify your setup](#verify-your-setup)
* [Running the server](#running-the-server)
* [User Guide](#user-guide)
* [Docker](#docker)
Update README (#806) * Update README The README is very out of date, the following changes have been made - Update what the file tree should look like - Remove client Avant Gardens Survival script fix - Update some incorrect commands or commands that were missing packages. - Add packed client setup instructions - Add *config.ini setup instructions - Describe what configs should be modified and what you may want to change - More detail in the verify step - Change Account Manager link to Nexus Dashboard - Remove table of commands and reference Commands.md instead - Specify that UGCSERVERIP may need to be changed to localhost as well * Fix Avant Gardens Survival This addresses the Avant Gardens Survival bug. Squeezing it in with the README changes since it is a small change. * Remove Locale * Update README.md Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> * Remove dLocale again? * Saving for the night * Revert "Fix Avant Gardens Survival" This reverts commit b1a1ce2d84e870c328a039673c9b77859e6e3dbd. * Update Mission.cpp * Update README.md Move comments and add pre-processor define Update README.md Update README.md Update CMakePresets.json Update CMakeVariables.txt Update README.md i love readmes Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md * Update README.md Co-authored-by: Daniel Seiler <me@xiphoseer.de> * Address feedback * Update README.md * Update Database.cpp * Update README.md * Revert tcp specification Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> Co-authored-by: Aaron Kimbrell <aronwk.aaron@gmail.com> Co-authored-by: Daniel Seiler <me@xiphoseer.de>
2022-12-28 21:58:53 +00:00
## Clone the repository
If you are on Windows, you will need to download and install git from [here](https://git-scm.com/download/win)
Then run the following command
2021-12-05 17:40:43 +00:00
```bash
git clone --recursive https://github.com/DarkflameUniverse/DarkflameServer
```
Update README (#806) * Update README The README is very out of date, the following changes have been made - Update what the file tree should look like - Remove client Avant Gardens Survival script fix - Update some incorrect commands or commands that were missing packages. - Add packed client setup instructions - Add *config.ini setup instructions - Describe what configs should be modified and what you may want to change - More detail in the verify step - Change Account Manager link to Nexus Dashboard - Remove table of commands and reference Commands.md instead - Specify that UGCSERVERIP may need to be changed to localhost as well * Fix Avant Gardens Survival This addresses the Avant Gardens Survival bug. Squeezing it in with the README changes since it is a small change. * Remove Locale * Update README.md Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> * Remove dLocale again? * Saving for the night * Revert "Fix Avant Gardens Survival" This reverts commit b1a1ce2d84e870c328a039673c9b77859e6e3dbd. * Update Mission.cpp * Update README.md Move comments and add pre-processor define Update README.md Update README.md Update CMakePresets.json Update CMakeVariables.txt Update README.md i love readmes Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md * Update README.md Co-authored-by: Daniel Seiler <me@xiphoseer.de> * Address feedback * Update README.md * Update Database.cpp * Update README.md * Revert tcp specification Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> Co-authored-by: Aaron Kimbrell <aronwk.aaron@gmail.com> Co-authored-by: Daniel Seiler <me@xiphoseer.de>
2022-12-28 21:58:53 +00:00
## Install dependencies
Update README (#806) * Update README The README is very out of date, the following changes have been made - Update what the file tree should look like - Remove client Avant Gardens Survival script fix - Update some incorrect commands or commands that were missing packages. - Add packed client setup instructions - Add *config.ini setup instructions - Describe what configs should be modified and what you may want to change - More detail in the verify step - Change Account Manager link to Nexus Dashboard - Remove table of commands and reference Commands.md instead - Specify that UGCSERVERIP may need to be changed to localhost as well * Fix Avant Gardens Survival This addresses the Avant Gardens Survival bug. Squeezing it in with the README changes since it is a small change. * Remove Locale * Update README.md Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> * Remove dLocale again? * Saving for the night * Revert "Fix Avant Gardens Survival" This reverts commit b1a1ce2d84e870c328a039673c9b77859e6e3dbd. * Update Mission.cpp * Update README.md Move comments and add pre-processor define Update README.md Update README.md Update CMakePresets.json Update CMakeVariables.txt Update README.md i love readmes Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md * Update README.md Co-authored-by: Daniel Seiler <me@xiphoseer.de> * Address feedback * Update README.md * Update Database.cpp * Update README.md * Revert tcp specification Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> Co-authored-by: Aaron Kimbrell <aronwk.aaron@gmail.com> Co-authored-by: Daniel Seiler <me@xiphoseer.de>
2022-12-28 21:58:53 +00:00
### Windows packages
Ensure that you have either the [MSVC C++ compiler](https://visualstudio.microsoft.com/vs/features/cplusplus/) (recommended) or the [Clang compiler](https://github.com/llvm/llvm-project/releases/) installed.
You'll also need to download and install [CMake](https://cmake.org/download/) (version <font size="4">**CMake version 3.25**</font> or later!).
Update README (#806) * Update README The README is very out of date, the following changes have been made - Update what the file tree should look like - Remove client Avant Gardens Survival script fix - Update some incorrect commands or commands that were missing packages. - Add packed client setup instructions - Add *config.ini setup instructions - Describe what configs should be modified and what you may want to change - More detail in the verify step - Change Account Manager link to Nexus Dashboard - Remove table of commands and reference Commands.md instead - Specify that UGCSERVERIP may need to be changed to localhost as well * Fix Avant Gardens Survival This addresses the Avant Gardens Survival bug. Squeezing it in with the README changes since it is a small change. * Remove Locale * Update README.md Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> * Remove dLocale again? * Saving for the night * Revert "Fix Avant Gardens Survival" This reverts commit b1a1ce2d84e870c328a039673c9b77859e6e3dbd. * Update Mission.cpp * Update README.md Move comments and add pre-processor define Update README.md Update README.md Update CMakePresets.json Update CMakeVariables.txt Update README.md i love readmes Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md * Update README.md Co-authored-by: Daniel Seiler <me@xiphoseer.de> * Address feedback * Update README.md * Update Database.cpp * Update README.md * Revert tcp specification Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> Co-authored-by: Aaron Kimbrell <aronwk.aaron@gmail.com> Co-authored-by: Daniel Seiler <me@xiphoseer.de>
2022-12-28 21:58:53 +00:00
### MacOS packages
Ensure you have [brew](https://brew.sh) installed.
You will need to install the following packages
```bash
Update README (#806) * Update README The README is very out of date, the following changes have been made - Update what the file tree should look like - Remove client Avant Gardens Survival script fix - Update some incorrect commands or commands that were missing packages. - Add packed client setup instructions - Add *config.ini setup instructions - Describe what configs should be modified and what you may want to change - More detail in the verify step - Change Account Manager link to Nexus Dashboard - Remove table of commands and reference Commands.md instead - Specify that UGCSERVERIP may need to be changed to localhost as well * Fix Avant Gardens Survival This addresses the Avant Gardens Survival bug. Squeezing it in with the README changes since it is a small change. * Remove Locale * Update README.md Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> * Remove dLocale again? * Saving for the night * Revert "Fix Avant Gardens Survival" This reverts commit b1a1ce2d84e870c328a039673c9b77859e6e3dbd. * Update Mission.cpp * Update README.md Move comments and add pre-processor define Update README.md Update README.md Update CMakePresets.json Update CMakeVariables.txt Update README.md i love readmes Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md * Update README.md Co-authored-by: Daniel Seiler <me@xiphoseer.de> * Address feedback * Update README.md * Update Database.cpp * Update README.md * Revert tcp specification Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> Co-authored-by: Aaron Kimbrell <aronwk.aaron@gmail.com> Co-authored-by: Daniel Seiler <me@xiphoseer.de>
2022-12-28 21:58:53 +00:00
brew install cmake gcc mariadb openssl zlib
```
Update README (#806) * Update README The README is very out of date, the following changes have been made - Update what the file tree should look like - Remove client Avant Gardens Survival script fix - Update some incorrect commands or commands that were missing packages. - Add packed client setup instructions - Add *config.ini setup instructions - Describe what configs should be modified and what you may want to change - More detail in the verify step - Change Account Manager link to Nexus Dashboard - Remove table of commands and reference Commands.md instead - Specify that UGCSERVERIP may need to be changed to localhost as well * Fix Avant Gardens Survival This addresses the Avant Gardens Survival bug. Squeezing it in with the README changes since it is a small change. * Remove Locale * Update README.md Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> * Remove dLocale again? * Saving for the night * Revert "Fix Avant Gardens Survival" This reverts commit b1a1ce2d84e870c328a039673c9b77859e6e3dbd. * Update Mission.cpp * Update README.md Move comments and add pre-processor define Update README.md Update README.md Update CMakePresets.json Update CMakeVariables.txt Update README.md i love readmes Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md * Update README.md Co-authored-by: Daniel Seiler <me@xiphoseer.de> * Address feedback * Update README.md * Update Database.cpp * Update README.md * Revert tcp specification Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> Co-authored-by: Aaron Kimbrell <aronwk.aaron@gmail.com> Co-authored-by: Daniel Seiler <me@xiphoseer.de>
2022-12-28 21:58:53 +00:00
### Linux packages
Make sure packages like `gcc`, and `zlib` are installed. Depending on the distribution, these packages might already be installed. Note that on systems like Ubuntu, you will need the `zlib1g-dev` package so that the header files are available. `libssl-dev` will also be required as well as `openssl`. You will also need a MySQL database solution to use. We recommend using `mariadb-server`.
Update README (#806) * Update README The README is very out of date, the following changes have been made - Update what the file tree should look like - Remove client Avant Gardens Survival script fix - Update some incorrect commands or commands that were missing packages. - Add packed client setup instructions - Add *config.ini setup instructions - Describe what configs should be modified and what you may want to change - More detail in the verify step - Change Account Manager link to Nexus Dashboard - Remove table of commands and reference Commands.md instead - Specify that UGCSERVERIP may need to be changed to localhost as well * Fix Avant Gardens Survival This addresses the Avant Gardens Survival bug. Squeezing it in with the README changes since it is a small change. * Remove Locale * Update README.md Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> * Remove dLocale again? * Saving for the night * Revert "Fix Avant Gardens Survival" This reverts commit b1a1ce2d84e870c328a039673c9b77859e6e3dbd. * Update Mission.cpp * Update README.md Move comments and add pre-processor define Update README.md Update README.md Update CMakePresets.json Update CMakeVariables.txt Update README.md i love readmes Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md * Update README.md Co-authored-by: Daniel Seiler <me@xiphoseer.de> * Address feedback * Update README.md * Update Database.cpp * Update README.md * Revert tcp specification Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> Co-authored-by: Aaron Kimbrell <aronwk.aaron@gmail.com> Co-authored-by: Daniel Seiler <me@xiphoseer.de>
2022-12-28 21:58:53 +00:00
For Ubuntu, you would run the following commands. On other systems, the package install command will differ.
2021-12-05 17:40:43 +00:00
Update README (#806) * Update README The README is very out of date, the following changes have been made - Update what the file tree should look like - Remove client Avant Gardens Survival script fix - Update some incorrect commands or commands that were missing packages. - Add packed client setup instructions - Add *config.ini setup instructions - Describe what configs should be modified and what you may want to change - More detail in the verify step - Change Account Manager link to Nexus Dashboard - Remove table of commands and reference Commands.md instead - Specify that UGCSERVERIP may need to be changed to localhost as well * Fix Avant Gardens Survival This addresses the Avant Gardens Survival bug. Squeezing it in with the README changes since it is a small change. * Remove Locale * Update README.md Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> * Remove dLocale again? * Saving for the night * Revert "Fix Avant Gardens Survival" This reverts commit b1a1ce2d84e870c328a039673c9b77859e6e3dbd. * Update Mission.cpp * Update README.md Move comments and add pre-processor define Update README.md Update README.md Update CMakePresets.json Update CMakeVariables.txt Update README.md i love readmes Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md * Update README.md Co-authored-by: Daniel Seiler <me@xiphoseer.de> * Address feedback * Update README.md * Update Database.cpp * Update README.md * Revert tcp specification Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> Co-authored-by: Aaron Kimbrell <aronwk.aaron@gmail.com> Co-authored-by: Daniel Seiler <me@xiphoseer.de>
2022-12-28 21:58:53 +00:00
```bash
sudo apt update && sudo apt upgrade
2021-12-05 17:40:43 +00:00
Update README (#806) * Update README The README is very out of date, the following changes have been made - Update what the file tree should look like - Remove client Avant Gardens Survival script fix - Update some incorrect commands or commands that were missing packages. - Add packed client setup instructions - Add *config.ini setup instructions - Describe what configs should be modified and what you may want to change - More detail in the verify step - Change Account Manager link to Nexus Dashboard - Remove table of commands and reference Commands.md instead - Specify that UGCSERVERIP may need to be changed to localhost as well * Fix Avant Gardens Survival This addresses the Avant Gardens Survival bug. Squeezing it in with the README changes since it is a small change. * Remove Locale * Update README.md Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> * Remove dLocale again? * Saving for the night * Revert "Fix Avant Gardens Survival" This reverts commit b1a1ce2d84e870c328a039673c9b77859e6e3dbd. * Update Mission.cpp * Update README.md Move comments and add pre-processor define Update README.md Update README.md Update CMakePresets.json Update CMakeVariables.txt Update README.md i love readmes Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md * Update README.md Co-authored-by: Daniel Seiler <me@xiphoseer.de> * Address feedback * Update README.md * Update Database.cpp * Update README.md * Revert tcp specification Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> Co-authored-by: Aaron Kimbrell <aronwk.aaron@gmail.com> Co-authored-by: Daniel Seiler <me@xiphoseer.de>
2022-12-28 21:58:53 +00:00
# Install packages
sudo apt install build-essential gcc zlib1g-dev libssl-dev openssl mariadb-server cmake
2021-12-05 17:40:43 +00:00
```
Update README (#806) * Update README The README is very out of date, the following changes have been made - Update what the file tree should look like - Remove client Avant Gardens Survival script fix - Update some incorrect commands or commands that were missing packages. - Add packed client setup instructions - Add *config.ini setup instructions - Describe what configs should be modified and what you may want to change - More detail in the verify step - Change Account Manager link to Nexus Dashboard - Remove table of commands and reference Commands.md instead - Specify that UGCSERVERIP may need to be changed to localhost as well * Fix Avant Gardens Survival This addresses the Avant Gardens Survival bug. Squeezing it in with the README changes since it is a small change. * Remove Locale * Update README.md Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> * Remove dLocale again? * Saving for the night * Revert "Fix Avant Gardens Survival" This reverts commit b1a1ce2d84e870c328a039673c9b77859e6e3dbd. * Update Mission.cpp * Update README.md Move comments and add pre-processor define Update README.md Update README.md Update CMakePresets.json Update CMakeVariables.txt Update README.md i love readmes Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md * Update README.md Co-authored-by: Daniel Seiler <me@xiphoseer.de> * Address feedback * Update README.md * Update Database.cpp * Update README.md * Revert tcp specification Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> Co-authored-by: Aaron Kimbrell <aronwk.aaron@gmail.com> Co-authored-by: Daniel Seiler <me@xiphoseer.de>
2022-12-28 21:58:53 +00:00
#### Required CMake version
2024-03-29 02:32:46 +00:00
This project uses <font size="4">**CMake version 3.25**</font> or higher and as such you will need to ensure you have this version installed.
Update README (#806) * Update README The README is very out of date, the following changes have been made - Update what the file tree should look like - Remove client Avant Gardens Survival script fix - Update some incorrect commands or commands that were missing packages. - Add packed client setup instructions - Add *config.ini setup instructions - Describe what configs should be modified and what you may want to change - More detail in the verify step - Change Account Manager link to Nexus Dashboard - Remove table of commands and reference Commands.md instead - Specify that UGCSERVERIP may need to be changed to localhost as well * Fix Avant Gardens Survival This addresses the Avant Gardens Survival bug. Squeezing it in with the README changes since it is a small change. * Remove Locale * Update README.md Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> * Remove dLocale again? * Saving for the night * Revert "Fix Avant Gardens Survival" This reverts commit b1a1ce2d84e870c328a039673c9b77859e6e3dbd. * Update Mission.cpp * Update README.md Move comments and add pre-processor define Update README.md Update README.md Update CMakePresets.json Update CMakeVariables.txt Update README.md i love readmes Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md * Update README.md Co-authored-by: Daniel Seiler <me@xiphoseer.de> * Address feedback * Update README.md * Update Database.cpp * Update README.md * Revert tcp specification Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> Co-authored-by: Aaron Kimbrell <aronwk.aaron@gmail.com> Co-authored-by: Daniel Seiler <me@xiphoseer.de>
2022-12-28 21:58:53 +00:00
You can check your CMake version by using the following command in a terminal.
2021-12-05 17:40:43 +00:00
```bash
Update README (#806) * Update README The README is very out of date, the following changes have been made - Update what the file tree should look like - Remove client Avant Gardens Survival script fix - Update some incorrect commands or commands that were missing packages. - Add packed client setup instructions - Add *config.ini setup instructions - Describe what configs should be modified and what you may want to change - More detail in the verify step - Change Account Manager link to Nexus Dashboard - Remove table of commands and reference Commands.md instead - Specify that UGCSERVERIP may need to be changed to localhost as well * Fix Avant Gardens Survival This addresses the Avant Gardens Survival bug. Squeezing it in with the README changes since it is a small change. * Remove Locale * Update README.md Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> * Remove dLocale again? * Saving for the night * Revert "Fix Avant Gardens Survival" This reverts commit b1a1ce2d84e870c328a039673c9b77859e6e3dbd. * Update Mission.cpp * Update README.md Move comments and add pre-processor define Update README.md Update README.md Update CMakePresets.json Update CMakeVariables.txt Update README.md i love readmes Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md * Update README.md Co-authored-by: Daniel Seiler <me@xiphoseer.de> * Address feedback * Update README.md * Update Database.cpp * Update README.md * Revert tcp specification Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> Co-authored-by: Aaron Kimbrell <aronwk.aaron@gmail.com> Co-authored-by: Daniel Seiler <me@xiphoseer.de>
2022-12-28 21:58:53 +00:00
cmake --version
2021-12-05 17:40:43 +00:00
```
Update README (#806) * Update README The README is very out of date, the following changes have been made - Update what the file tree should look like - Remove client Avant Gardens Survival script fix - Update some incorrect commands or commands that were missing packages. - Add packed client setup instructions - Add *config.ini setup instructions - Describe what configs should be modified and what you may want to change - More detail in the verify step - Change Account Manager link to Nexus Dashboard - Remove table of commands and reference Commands.md instead - Specify that UGCSERVERIP may need to be changed to localhost as well * Fix Avant Gardens Survival This addresses the Avant Gardens Survival bug. Squeezing it in with the README changes since it is a small change. * Remove Locale * Update README.md Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> * Remove dLocale again? * Saving for the night * Revert "Fix Avant Gardens Survival" This reverts commit b1a1ce2d84e870c328a039673c9b77859e6e3dbd. * Update Mission.cpp * Update README.md Move comments and add pre-processor define Update README.md Update README.md Update CMakePresets.json Update CMakeVariables.txt Update README.md i love readmes Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md * Update README.md Co-authored-by: Daniel Seiler <me@xiphoseer.de> * Address feedback * Update README.md * Update Database.cpp * Update README.md * Revert tcp specification Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> Co-authored-by: Aaron Kimbrell <aronwk.aaron@gmail.com> Co-authored-by: Daniel Seiler <me@xiphoseer.de>
2022-12-28 21:58:53 +00:00
If you are going to be using an Ubuntu environment to run the server, you may need to get a more recent version of `cmake` than the packages available may provide.
2021-12-05 17:40:43 +00:00
Update README (#806) * Update README The README is very out of date, the following changes have been made - Update what the file tree should look like - Remove client Avant Gardens Survival script fix - Update some incorrect commands or commands that were missing packages. - Add packed client setup instructions - Add *config.ini setup instructions - Describe what configs should be modified and what you may want to change - More detail in the verify step - Change Account Manager link to Nexus Dashboard - Remove table of commands and reference Commands.md instead - Specify that UGCSERVERIP may need to be changed to localhost as well * Fix Avant Gardens Survival This addresses the Avant Gardens Survival bug. Squeezing it in with the README changes since it is a small change. * Remove Locale * Update README.md Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> * Remove dLocale again? * Saving for the night * Revert "Fix Avant Gardens Survival" This reverts commit b1a1ce2d84e870c328a039673c9b77859e6e3dbd. * Update Mission.cpp * Update README.md Move comments and add pre-processor define Update README.md Update README.md Update CMakePresets.json Update CMakeVariables.txt Update README.md i love readmes Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md * Update README.md Co-authored-by: Daniel Seiler <me@xiphoseer.de> * Address feedback * Update README.md * Update Database.cpp * Update README.md * Revert tcp specification Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> Co-authored-by: Aaron Kimbrell <aronwk.aaron@gmail.com> Co-authored-by: Daniel Seiler <me@xiphoseer.de>
2022-12-28 21:58:53 +00:00
The general approach to do so would be to obtain a copy of the signing key and then add the CMake repository to your apt.
You can do so with the following commands.
2021-12-05 17:40:43 +00:00
Update README (#806) * Update README The README is very out of date, the following changes have been made - Update what the file tree should look like - Remove client Avant Gardens Survival script fix - Update some incorrect commands or commands that were missing packages. - Add packed client setup instructions - Add *config.ini setup instructions - Describe what configs should be modified and what you may want to change - More detail in the verify step - Change Account Manager link to Nexus Dashboard - Remove table of commands and reference Commands.md instead - Specify that UGCSERVERIP may need to be changed to localhost as well * Fix Avant Gardens Survival This addresses the Avant Gardens Survival bug. Squeezing it in with the README changes since it is a small change. * Remove Locale * Update README.md Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> * Remove dLocale again? * Saving for the night * Revert "Fix Avant Gardens Survival" This reverts commit b1a1ce2d84e870c328a039673c9b77859e6e3dbd. * Update Mission.cpp * Update README.md Move comments and add pre-processor define Update README.md Update README.md Update CMakePresets.json Update CMakeVariables.txt Update README.md i love readmes Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md * Update README.md Co-authored-by: Daniel Seiler <me@xiphoseer.de> * Address feedback * Update README.md * Update Database.cpp * Update README.md * Revert tcp specification Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> Co-authored-by: Aaron Kimbrell <aronwk.aaron@gmail.com> Co-authored-by: Daniel Seiler <me@xiphoseer.de>
2022-12-28 21:58:53 +00:00
[Source of the below commands](https://askubuntu.com/questions/355565/how-do-i-install-the-latest-version-of-cmake-from-the-command-line)
2021-12-05 17:40:43 +00:00
Update README (#806) * Update README The README is very out of date, the following changes have been made - Update what the file tree should look like - Remove client Avant Gardens Survival script fix - Update some incorrect commands or commands that were missing packages. - Add packed client setup instructions - Add *config.ini setup instructions - Describe what configs should be modified and what you may want to change - More detail in the verify step - Change Account Manager link to Nexus Dashboard - Remove table of commands and reference Commands.md instead - Specify that UGCSERVERIP may need to be changed to localhost as well * Fix Avant Gardens Survival This addresses the Avant Gardens Survival bug. Squeezing it in with the README changes since it is a small change. * Remove Locale * Update README.md Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> * Remove dLocale again? * Saving for the night * Revert "Fix Avant Gardens Survival" This reverts commit b1a1ce2d84e870c328a039673c9b77859e6e3dbd. * Update Mission.cpp * Update README.md Move comments and add pre-processor define Update README.md Update README.md Update CMakePresets.json Update CMakeVariables.txt Update README.md i love readmes Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md * Update README.md Co-authored-by: Daniel Seiler <me@xiphoseer.de> * Address feedback * Update README.md * Update Database.cpp * Update README.md * Revert tcp specification Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> Co-authored-by: Aaron Kimbrell <aronwk.aaron@gmail.com> Co-authored-by: Daniel Seiler <me@xiphoseer.de>
2022-12-28 21:58:53 +00:00
```bash
# Remove the old version of CMake
sudo apt purge --auto-remove cmake
2021-12-06 05:39:13 +00:00
Update README (#806) * Update README The README is very out of date, the following changes have been made - Update what the file tree should look like - Remove client Avant Gardens Survival script fix - Update some incorrect commands or commands that were missing packages. - Add packed client setup instructions - Add *config.ini setup instructions - Describe what configs should be modified and what you may want to change - More detail in the verify step - Change Account Manager link to Nexus Dashboard - Remove table of commands and reference Commands.md instead - Specify that UGCSERVERIP may need to be changed to localhost as well * Fix Avant Gardens Survival This addresses the Avant Gardens Survival bug. Squeezing it in with the README changes since it is a small change. * Remove Locale * Update README.md Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> * Remove dLocale again? * Saving for the night * Revert "Fix Avant Gardens Survival" This reverts commit b1a1ce2d84e870c328a039673c9b77859e6e3dbd. * Update Mission.cpp * Update README.md Move comments and add pre-processor define Update README.md Update README.md Update CMakePresets.json Update CMakeVariables.txt Update README.md i love readmes Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md * Update README.md Co-authored-by: Daniel Seiler <me@xiphoseer.de> * Address feedback * Update README.md * Update Database.cpp * Update README.md * Revert tcp specification Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> Co-authored-by: Aaron Kimbrell <aronwk.aaron@gmail.com> Co-authored-by: Daniel Seiler <me@xiphoseer.de>
2022-12-28 21:58:53 +00:00
# Prepare for installation
sudo apt update && sudo apt install -y software-properties-common lsb-release && sudo apt clean all
Add Aarch64 support (#231) * added mariadb-connector-cpp submodule * raknet aarch64 support * fix compile errors * mariadb connector swap (in progress) * update CMakeLists, add preprocessor definition to switch between mysql and mariadb connectors * update types with missing aarch64 check * corrected adding extra flag to properly compile mariadbconn in CMakeLists * updated readme with arm builds section * fix build failure if test folder does not exist * Remove mysql connector from all builds, add mariadbconnector to windows build * readd Linux check for backtrace lib to CMakeLists.txt * Separate system specific mariadbconncpp extra compile flags * Copy dlls to exes directory once built * fetch prebuilt binaries on windows so that ClangCL can be used * Delay load dll so that plugin directory is set correctly * Fixed typo in glibcxx compile flag * whitespacing, spaces -> tabs * Updated README.md, included instructions to update * Updated README.md added libssl-dev requirement and removed mysql connector references from macOS builds section * apple compile fixes for zlib and shared library name * add windows arm64 checks to raknet * remove extra . in shared library location * Setup plugins directory for the connector to search in, pass openssl_root_dir on for apple * Fix copy paths for single config generators and non windows * change plugin folder location, another single config generator fix * GENERATOR_IS_MULTI_CONFIG is a property not a variable * Fixed a few errors after merge * Fix plugin directory path, force windows to look at the right folder * fixed directory name for make_directory command * Update README.md Updated MacOS, Windows build instructions. * set INSTALL_PLUGINDIR so that the right directory is used * Support for relative rpath for docker build * added mariadb-connector-cpp submodule * raknet aarch64 support * fix compile errors * mariadb connector swap (in progress) * update CMakeLists, add preprocessor definition to switch between mysql and mariadb connectors * update types with missing aarch64 check * corrected adding extra flag to properly compile mariadbconn in CMakeLists * updated readme with arm builds section * fix build failure if test folder does not exist * Remove mysql connector from all builds, add mariadbconnector to windows build * readd Linux check for backtrace lib to CMakeLists.txt * Separate system specific mariadbconncpp extra compile flags * Copy dlls to exes directory once built * fetch prebuilt binaries on windows so that ClangCL can be used * Delay load dll so that plugin directory is set correctly * Fixed typo in glibcxx compile flag * whitespacing, spaces -> tabs * Updated README.md, included instructions to update * Updated README.md added libssl-dev requirement and removed mysql connector references from macOS builds section * apple compile fixes for zlib and shared library name * add windows arm64 checks to raknet * Setup plugins directory for the connector to search in, pass openssl_root_dir on for apple * Fix copy paths for single config generators and non windows * change plugin folder location, another single config generator fix * GENERATOR_IS_MULTI_CONFIG is a property not a variable * Fixed a few errors after merge * Fix plugin directory path, force windows to look at the right folder * fixed directory name for make_directory command * Update README.md Updated MacOS, Windows build instructions. * set INSTALL_PLUGINDIR so that the right directory is used * Support for relative rpath for docker build * Rebase on main * Remove extra git submodule * Update CMakeLists.txt * Remove CMakeLists.txt file from mariadb Remove the CMakeLists.txt file from the mariaDBConnector so we dont build the tests. Also add a config option to the CMakeVariables.txt so you can build the connector with multiple jobs * Compile on windows Specify the mariadbcpp.dll file location with a defined absolute path so windows knows it actually exists. * default to 1 job Default mariadb jobs running in parallel to 1 instead of 4 * Move mariadbcpp.dll file to the expected directory on windows * Changed plugin Updated the plugin location from the project binary directory to the expected location, the mariadb binary directory. * Addressed windows dll issues by moving files to the expected directory instead of a directory that wouldnt get created * Update README Co-authored-by: Aaron Kimbrell <aronwk.aaron@gmail.com> Co-authored-by: EmosewaMC <39972741+EmosewaMC@users.noreply.github.com>
2022-07-04 04:33:05 +00:00
Update README (#806) * Update README The README is very out of date, the following changes have been made - Update what the file tree should look like - Remove client Avant Gardens Survival script fix - Update some incorrect commands or commands that were missing packages. - Add packed client setup instructions - Add *config.ini setup instructions - Describe what configs should be modified and what you may want to change - More detail in the verify step - Change Account Manager link to Nexus Dashboard - Remove table of commands and reference Commands.md instead - Specify that UGCSERVERIP may need to be changed to localhost as well * Fix Avant Gardens Survival This addresses the Avant Gardens Survival bug. Squeezing it in with the README changes since it is a small change. * Remove Locale * Update README.md Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> * Remove dLocale again? * Saving for the night * Revert "Fix Avant Gardens Survival" This reverts commit b1a1ce2d84e870c328a039673c9b77859e6e3dbd. * Update Mission.cpp * Update README.md Move comments and add pre-processor define Update README.md Update README.md Update CMakePresets.json Update CMakeVariables.txt Update README.md i love readmes Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md * Update README.md Co-authored-by: Daniel Seiler <me@xiphoseer.de> * Address feedback * Update README.md * Update Database.cpp * Update README.md * Revert tcp specification Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> Co-authored-by: Aaron Kimbrell <aronwk.aaron@gmail.com> Co-authored-by: Daniel Seiler <me@xiphoseer.de>
2022-12-28 21:58:53 +00:00
# Obtain a copy of the signing key
wget -O - https://apt.kitware.com/keys/kitware-archive-latest.asc 2>/dev/null | gpg --dearmor - | sudo tee /etc/apt/trusted.gpg.d/kitware.gpg >/dev/null
2021-12-05 17:40:43 +00:00
Update README (#806) * Update README The README is very out of date, the following changes have been made - Update what the file tree should look like - Remove client Avant Gardens Survival script fix - Update some incorrect commands or commands that were missing packages. - Add packed client setup instructions - Add *config.ini setup instructions - Describe what configs should be modified and what you may want to change - More detail in the verify step - Change Account Manager link to Nexus Dashboard - Remove table of commands and reference Commands.md instead - Specify that UGCSERVERIP may need to be changed to localhost as well * Fix Avant Gardens Survival This addresses the Avant Gardens Survival bug. Squeezing it in with the README changes since it is a small change. * Remove Locale * Update README.md Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> * Remove dLocale again? * Saving for the night * Revert "Fix Avant Gardens Survival" This reverts commit b1a1ce2d84e870c328a039673c9b77859e6e3dbd. * Update Mission.cpp * Update README.md Move comments and add pre-processor define Update README.md Update README.md Update CMakePresets.json Update CMakeVariables.txt Update README.md i love readmes Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md * Update README.md Co-authored-by: Daniel Seiler <me@xiphoseer.de> * Address feedback * Update README.md * Update Database.cpp * Update README.md * Revert tcp specification Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> Co-authored-by: Aaron Kimbrell <aronwk.aaron@gmail.com> Co-authored-by: Daniel Seiler <me@xiphoseer.de>
2022-12-28 21:58:53 +00:00
# Add the repository to your sources list.
sudo apt-add-repository "deb https://apt.kitware.com/ubuntu/ $(lsb_release -cs) main"
2021-12-05 17:40:43 +00:00
Update README (#806) * Update README The README is very out of date, the following changes have been made - Update what the file tree should look like - Remove client Avant Gardens Survival script fix - Update some incorrect commands or commands that were missing packages. - Add packed client setup instructions - Add *config.ini setup instructions - Describe what configs should be modified and what you may want to change - More detail in the verify step - Change Account Manager link to Nexus Dashboard - Remove table of commands and reference Commands.md instead - Specify that UGCSERVERIP may need to be changed to localhost as well * Fix Avant Gardens Survival This addresses the Avant Gardens Survival bug. Squeezing it in with the README changes since it is a small change. * Remove Locale * Update README.md Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> * Remove dLocale again? * Saving for the night * Revert "Fix Avant Gardens Survival" This reverts commit b1a1ce2d84e870c328a039673c9b77859e6e3dbd. * Update Mission.cpp * Update README.md Move comments and add pre-processor define Update README.md Update README.md Update CMakePresets.json Update CMakeVariables.txt Update README.md i love readmes Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md * Update README.md Co-authored-by: Daniel Seiler <me@xiphoseer.de> * Address feedback * Update README.md * Update Database.cpp * Update README.md * Revert tcp specification Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> Co-authored-by: Aaron Kimbrell <aronwk.aaron@gmail.com> Co-authored-by: Daniel Seiler <me@xiphoseer.de>
2022-12-28 21:58:53 +00:00
# Next you'll want to ensure that Kitware's keyring stays up to date
sudo apt update
sudo apt install kitware-archive-keyring
sudo rm /etc/apt/trusted.gpg.d/kitware.gpg
2021-12-05 17:40:43 +00:00
Update README (#806) * Update README The README is very out of date, the following changes have been made - Update what the file tree should look like - Remove client Avant Gardens Survival script fix - Update some incorrect commands or commands that were missing packages. - Add packed client setup instructions - Add *config.ini setup instructions - Describe what configs should be modified and what you may want to change - More detail in the verify step - Change Account Manager link to Nexus Dashboard - Remove table of commands and reference Commands.md instead - Specify that UGCSERVERIP may need to be changed to localhost as well * Fix Avant Gardens Survival This addresses the Avant Gardens Survival bug. Squeezing it in with the README changes since it is a small change. * Remove Locale * Update README.md Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> * Remove dLocale again? * Saving for the night * Revert "Fix Avant Gardens Survival" This reverts commit b1a1ce2d84e870c328a039673c9b77859e6e3dbd. * Update Mission.cpp * Update README.md Move comments and add pre-processor define Update README.md Update README.md Update CMakePresets.json Update CMakeVariables.txt Update README.md i love readmes Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md * Update README.md Co-authored-by: Daniel Seiler <me@xiphoseer.de> * Address feedback * Update README.md * Update Database.cpp * Update README.md * Revert tcp specification Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> Co-authored-by: Aaron Kimbrell <aronwk.aaron@gmail.com> Co-authored-by: Daniel Seiler <me@xiphoseer.de>
2022-12-28 21:58:53 +00:00
# If sudo apt update above returned an error, copy the public key at the end of the error message and run the following command
# if the error message was "The following signatures couldn't be verified because the public key is not available: NO_PUBKEY 6AF7F09730B3F0A4"
# then the below command would be "sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 6AF7F09730B3F0A4"
sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys <TheCopiedPublicKey>
2021-12-05 17:40:43 +00:00
Update README (#806) * Update README The README is very out of date, the following changes have been made - Update what the file tree should look like - Remove client Avant Gardens Survival script fix - Update some incorrect commands or commands that were missing packages. - Add packed client setup instructions - Add *config.ini setup instructions - Describe what configs should be modified and what you may want to change - More detail in the verify step - Change Account Manager link to Nexus Dashboard - Remove table of commands and reference Commands.md instead - Specify that UGCSERVERIP may need to be changed to localhost as well * Fix Avant Gardens Survival This addresses the Avant Gardens Survival bug. Squeezing it in with the README changes since it is a small change. * Remove Locale * Update README.md Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> * Remove dLocale again? * Saving for the night * Revert "Fix Avant Gardens Survival" This reverts commit b1a1ce2d84e870c328a039673c9b77859e6e3dbd. * Update Mission.cpp * Update README.md Move comments and add pre-processor define Update README.md Update README.md Update CMakePresets.json Update CMakeVariables.txt Update README.md i love readmes Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md * Update README.md Co-authored-by: Daniel Seiler <me@xiphoseer.de> * Address feedback * Update README.md * Update Database.cpp * Update README.md * Revert tcp specification Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> Co-authored-by: Aaron Kimbrell <aronwk.aaron@gmail.com> Co-authored-by: Daniel Seiler <me@xiphoseer.de>
2022-12-28 21:58:53 +00:00
# Finally update and install
sudo apt update
2021-12-05 17:40:43 +00:00
sudo apt install cmake
```
Update README (#806) * Update README The README is very out of date, the following changes have been made - Update what the file tree should look like - Remove client Avant Gardens Survival script fix - Update some incorrect commands or commands that were missing packages. - Add packed client setup instructions - Add *config.ini setup instructions - Describe what configs should be modified and what you may want to change - More detail in the verify step - Change Account Manager link to Nexus Dashboard - Remove table of commands and reference Commands.md instead - Specify that UGCSERVERIP may need to be changed to localhost as well * Fix Avant Gardens Survival This addresses the Avant Gardens Survival bug. Squeezing it in with the README changes since it is a small change. * Remove Locale * Update README.md Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> * Remove dLocale again? * Saving for the night * Revert "Fix Avant Gardens Survival" This reverts commit b1a1ce2d84e870c328a039673c9b77859e6e3dbd. * Update Mission.cpp * Update README.md Move comments and add pre-processor define Update README.md Update README.md Update CMakePresets.json Update CMakeVariables.txt Update README.md i love readmes Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md * Update README.md Co-authored-by: Daniel Seiler <me@xiphoseer.de> * Address feedback * Update README.md * Update Database.cpp * Update README.md * Revert tcp specification Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> Co-authored-by: Aaron Kimbrell <aronwk.aaron@gmail.com> Co-authored-by: Daniel Seiler <me@xiphoseer.de>
2022-12-28 21:58:53 +00:00
## Database setup
First you'll need to start MariaDB.
2021-12-05 17:40:43 +00:00
Update README (#806) * Update README The README is very out of date, the following changes have been made - Update what the file tree should look like - Remove client Avant Gardens Survival script fix - Update some incorrect commands or commands that were missing packages. - Add packed client setup instructions - Add *config.ini setup instructions - Describe what configs should be modified and what you may want to change - More detail in the verify step - Change Account Manager link to Nexus Dashboard - Remove table of commands and reference Commands.md instead - Specify that UGCSERVERIP may need to be changed to localhost as well * Fix Avant Gardens Survival This addresses the Avant Gardens Survival bug. Squeezing it in with the README changes since it is a small change. * Remove Locale * Update README.md Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> * Remove dLocale again? * Saving for the night * Revert "Fix Avant Gardens Survival" This reverts commit b1a1ce2d84e870c328a039673c9b77859e6e3dbd. * Update Mission.cpp * Update README.md Move comments and add pre-processor define Update README.md Update README.md Update CMakePresets.json Update CMakeVariables.txt Update README.md i love readmes Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md * Update README.md Co-authored-by: Daniel Seiler <me@xiphoseer.de> * Address feedback * Update README.md * Update Database.cpp * Update README.md * Revert tcp specification Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> Co-authored-by: Aaron Kimbrell <aronwk.aaron@gmail.com> Co-authored-by: Daniel Seiler <me@xiphoseer.de>
2022-12-28 21:58:53 +00:00
For Windows the service is always running by default.
Add Aarch64 support (#231) * added mariadb-connector-cpp submodule * raknet aarch64 support * fix compile errors * mariadb connector swap (in progress) * update CMakeLists, add preprocessor definition to switch between mysql and mariadb connectors * update types with missing aarch64 check * corrected adding extra flag to properly compile mariadbconn in CMakeLists * updated readme with arm builds section * fix build failure if test folder does not exist * Remove mysql connector from all builds, add mariadbconnector to windows build * readd Linux check for backtrace lib to CMakeLists.txt * Separate system specific mariadbconncpp extra compile flags * Copy dlls to exes directory once built * fetch prebuilt binaries on windows so that ClangCL can be used * Delay load dll so that plugin directory is set correctly * Fixed typo in glibcxx compile flag * whitespacing, spaces -> tabs * Updated README.md, included instructions to update * Updated README.md added libssl-dev requirement and removed mysql connector references from macOS builds section * apple compile fixes for zlib and shared library name * add windows arm64 checks to raknet * remove extra . in shared library location * Setup plugins directory for the connector to search in, pass openssl_root_dir on for apple * Fix copy paths for single config generators and non windows * change plugin folder location, another single config generator fix * GENERATOR_IS_MULTI_CONFIG is a property not a variable * Fixed a few errors after merge * Fix plugin directory path, force windows to look at the right folder * fixed directory name for make_directory command * Update README.md Updated MacOS, Windows build instructions. * set INSTALL_PLUGINDIR so that the right directory is used * Support for relative rpath for docker build * added mariadb-connector-cpp submodule * raknet aarch64 support * fix compile errors * mariadb connector swap (in progress) * update CMakeLists, add preprocessor definition to switch between mysql and mariadb connectors * update types with missing aarch64 check * corrected adding extra flag to properly compile mariadbconn in CMakeLists * updated readme with arm builds section * fix build failure if test folder does not exist * Remove mysql connector from all builds, add mariadbconnector to windows build * readd Linux check for backtrace lib to CMakeLists.txt * Separate system specific mariadbconncpp extra compile flags * Copy dlls to exes directory once built * fetch prebuilt binaries on windows so that ClangCL can be used * Delay load dll so that plugin directory is set correctly * Fixed typo in glibcxx compile flag * whitespacing, spaces -> tabs * Updated README.md, included instructions to update * Updated README.md added libssl-dev requirement and removed mysql connector references from macOS builds section * apple compile fixes for zlib and shared library name * add windows arm64 checks to raknet * Setup plugins directory for the connector to search in, pass openssl_root_dir on for apple * Fix copy paths for single config generators and non windows * change plugin folder location, another single config generator fix * GENERATOR_IS_MULTI_CONFIG is a property not a variable * Fixed a few errors after merge * Fix plugin directory path, force windows to look at the right folder * fixed directory name for make_directory command * Update README.md Updated MacOS, Windows build instructions. * set INSTALL_PLUGINDIR so that the right directory is used * Support for relative rpath for docker build * Rebase on main * Remove extra git submodule * Update CMakeLists.txt * Remove CMakeLists.txt file from mariadb Remove the CMakeLists.txt file from the mariaDBConnector so we dont build the tests. Also add a config option to the CMakeVariables.txt so you can build the connector with multiple jobs * Compile on windows Specify the mariadbcpp.dll file location with a defined absolute path so windows knows it actually exists. * default to 1 job Default mariadb jobs running in parallel to 1 instead of 4 * Move mariadbcpp.dll file to the expected directory on windows * Changed plugin Updated the plugin location from the project binary directory to the expected location, the mariadb binary directory. * Addressed windows dll issues by moving files to the expected directory instead of a directory that wouldnt get created * Update README Co-authored-by: Aaron Kimbrell <aronwk.aaron@gmail.com> Co-authored-by: EmosewaMC <39972741+EmosewaMC@users.noreply.github.com>
2022-07-04 04:33:05 +00:00
Update README (#806) * Update README The README is very out of date, the following changes have been made - Update what the file tree should look like - Remove client Avant Gardens Survival script fix - Update some incorrect commands or commands that were missing packages. - Add packed client setup instructions - Add *config.ini setup instructions - Describe what configs should be modified and what you may want to change - More detail in the verify step - Change Account Manager link to Nexus Dashboard - Remove table of commands and reference Commands.md instead - Specify that UGCSERVERIP may need to be changed to localhost as well * Fix Avant Gardens Survival This addresses the Avant Gardens Survival bug. Squeezing it in with the README changes since it is a small change. * Remove Locale * Update README.md Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> * Remove dLocale again? * Saving for the night * Revert "Fix Avant Gardens Survival" This reverts commit b1a1ce2d84e870c328a039673c9b77859e6e3dbd. * Update Mission.cpp * Update README.md Move comments and add pre-processor define Update README.md Update README.md Update CMakePresets.json Update CMakeVariables.txt Update README.md i love readmes Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md * Update README.md Co-authored-by: Daniel Seiler <me@xiphoseer.de> * Address feedback * Update README.md * Update Database.cpp * Update README.md * Revert tcp specification Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> Co-authored-by: Aaron Kimbrell <aronwk.aaron@gmail.com> Co-authored-by: Daniel Seiler <me@xiphoseer.de>
2022-12-28 21:58:53 +00:00
For MacOS, run the following command
Add Aarch64 support (#231) * added mariadb-connector-cpp submodule * raknet aarch64 support * fix compile errors * mariadb connector swap (in progress) * update CMakeLists, add preprocessor definition to switch between mysql and mariadb connectors * update types with missing aarch64 check * corrected adding extra flag to properly compile mariadbconn in CMakeLists * updated readme with arm builds section * fix build failure if test folder does not exist * Remove mysql connector from all builds, add mariadbconnector to windows build * readd Linux check for backtrace lib to CMakeLists.txt * Separate system specific mariadbconncpp extra compile flags * Copy dlls to exes directory once built * fetch prebuilt binaries on windows so that ClangCL can be used * Delay load dll so that plugin directory is set correctly * Fixed typo in glibcxx compile flag * whitespacing, spaces -> tabs * Updated README.md, included instructions to update * Updated README.md added libssl-dev requirement and removed mysql connector references from macOS builds section * apple compile fixes for zlib and shared library name * add windows arm64 checks to raknet * remove extra . in shared library location * Setup plugins directory for the connector to search in, pass openssl_root_dir on for apple * Fix copy paths for single config generators and non windows * change plugin folder location, another single config generator fix * GENERATOR_IS_MULTI_CONFIG is a property not a variable * Fixed a few errors after merge * Fix plugin directory path, force windows to look at the right folder * fixed directory name for make_directory command * Update README.md Updated MacOS, Windows build instructions. * set INSTALL_PLUGINDIR so that the right directory is used * Support for relative rpath for docker build * added mariadb-connector-cpp submodule * raknet aarch64 support * fix compile errors * mariadb connector swap (in progress) * update CMakeLists, add preprocessor definition to switch between mysql and mariadb connectors * update types with missing aarch64 check * corrected adding extra flag to properly compile mariadbconn in CMakeLists * updated readme with arm builds section * fix build failure if test folder does not exist * Remove mysql connector from all builds, add mariadbconnector to windows build * readd Linux check for backtrace lib to CMakeLists.txt * Separate system specific mariadbconncpp extra compile flags * Copy dlls to exes directory once built * fetch prebuilt binaries on windows so that ClangCL can be used * Delay load dll so that plugin directory is set correctly * Fixed typo in glibcxx compile flag * whitespacing, spaces -> tabs * Updated README.md, included instructions to update * Updated README.md added libssl-dev requirement and removed mysql connector references from macOS builds section * apple compile fixes for zlib and shared library name * add windows arm64 checks to raknet * Setup plugins directory for the connector to search in, pass openssl_root_dir on for apple * Fix copy paths for single config generators and non windows * change plugin folder location, another single config generator fix * GENERATOR_IS_MULTI_CONFIG is a property not a variable * Fixed a few errors after merge * Fix plugin directory path, force windows to look at the right folder * fixed directory name for make_directory command * Update README.md Updated MacOS, Windows build instructions. * set INSTALL_PLUGINDIR so that the right directory is used * Support for relative rpath for docker build * Rebase on main * Remove extra git submodule * Update CMakeLists.txt * Remove CMakeLists.txt file from mariadb Remove the CMakeLists.txt file from the mariaDBConnector so we dont build the tests. Also add a config option to the CMakeVariables.txt so you can build the connector with multiple jobs * Compile on windows Specify the mariadbcpp.dll file location with a defined absolute path so windows knows it actually exists. * default to 1 job Default mariadb jobs running in parallel to 1 instead of 4 * Move mariadbcpp.dll file to the expected directory on windows * Changed plugin Updated the plugin location from the project binary directory to the expected location, the mariadb binary directory. * Addressed windows dll issues by moving files to the expected directory instead of a directory that wouldnt get created * Update README Co-authored-by: Aaron Kimbrell <aronwk.aaron@gmail.com> Co-authored-by: EmosewaMC <39972741+EmosewaMC@users.noreply.github.com>
2022-07-04 04:33:05 +00:00
```bash
Update README (#806) * Update README The README is very out of date, the following changes have been made - Update what the file tree should look like - Remove client Avant Gardens Survival script fix - Update some incorrect commands or commands that were missing packages. - Add packed client setup instructions - Add *config.ini setup instructions - Describe what configs should be modified and what you may want to change - More detail in the verify step - Change Account Manager link to Nexus Dashboard - Remove table of commands and reference Commands.md instead - Specify that UGCSERVERIP may need to be changed to localhost as well * Fix Avant Gardens Survival This addresses the Avant Gardens Survival bug. Squeezing it in with the README changes since it is a small change. * Remove Locale * Update README.md Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> * Remove dLocale again? * Saving for the night * Revert "Fix Avant Gardens Survival" This reverts commit b1a1ce2d84e870c328a039673c9b77859e6e3dbd. * Update Mission.cpp * Update README.md Move comments and add pre-processor define Update README.md Update README.md Update CMakePresets.json Update CMakeVariables.txt Update README.md i love readmes Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md * Update README.md Co-authored-by: Daniel Seiler <me@xiphoseer.de> * Address feedback * Update README.md * Update Database.cpp * Update README.md * Revert tcp specification Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> Co-authored-by: Aaron Kimbrell <aronwk.aaron@gmail.com> Co-authored-by: Daniel Seiler <me@xiphoseer.de>
2022-12-28 21:58:53 +00:00
brew services start mariadb
Add Aarch64 support (#231) * added mariadb-connector-cpp submodule * raknet aarch64 support * fix compile errors * mariadb connector swap (in progress) * update CMakeLists, add preprocessor definition to switch between mysql and mariadb connectors * update types with missing aarch64 check * corrected adding extra flag to properly compile mariadbconn in CMakeLists * updated readme with arm builds section * fix build failure if test folder does not exist * Remove mysql connector from all builds, add mariadbconnector to windows build * readd Linux check for backtrace lib to CMakeLists.txt * Separate system specific mariadbconncpp extra compile flags * Copy dlls to exes directory once built * fetch prebuilt binaries on windows so that ClangCL can be used * Delay load dll so that plugin directory is set correctly * Fixed typo in glibcxx compile flag * whitespacing, spaces -> tabs * Updated README.md, included instructions to update * Updated README.md added libssl-dev requirement and removed mysql connector references from macOS builds section * apple compile fixes for zlib and shared library name * add windows arm64 checks to raknet * remove extra . in shared library location * Setup plugins directory for the connector to search in, pass openssl_root_dir on for apple * Fix copy paths for single config generators and non windows * change plugin folder location, another single config generator fix * GENERATOR_IS_MULTI_CONFIG is a property not a variable * Fixed a few errors after merge * Fix plugin directory path, force windows to look at the right folder * fixed directory name for make_directory command * Update README.md Updated MacOS, Windows build instructions. * set INSTALL_PLUGINDIR so that the right directory is used * Support for relative rpath for docker build * added mariadb-connector-cpp submodule * raknet aarch64 support * fix compile errors * mariadb connector swap (in progress) * update CMakeLists, add preprocessor definition to switch between mysql and mariadb connectors * update types with missing aarch64 check * corrected adding extra flag to properly compile mariadbconn in CMakeLists * updated readme with arm builds section * fix build failure if test folder does not exist * Remove mysql connector from all builds, add mariadbconnector to windows build * readd Linux check for backtrace lib to CMakeLists.txt * Separate system specific mariadbconncpp extra compile flags * Copy dlls to exes directory once built * fetch prebuilt binaries on windows so that ClangCL can be used * Delay load dll so that plugin directory is set correctly * Fixed typo in glibcxx compile flag * whitespacing, spaces -> tabs * Updated README.md, included instructions to update * Updated README.md added libssl-dev requirement and removed mysql connector references from macOS builds section * apple compile fixes for zlib and shared library name * add windows arm64 checks to raknet * Setup plugins directory for the connector to search in, pass openssl_root_dir on for apple * Fix copy paths for single config generators and non windows * change plugin folder location, another single config generator fix * GENERATOR_IS_MULTI_CONFIG is a property not a variable * Fixed a few errors after merge * Fix plugin directory path, force windows to look at the right folder * fixed directory name for make_directory command * Update README.md Updated MacOS, Windows build instructions. * set INSTALL_PLUGINDIR so that the right directory is used * Support for relative rpath for docker build * Rebase on main * Remove extra git submodule * Update CMakeLists.txt * Remove CMakeLists.txt file from mariadb Remove the CMakeLists.txt file from the mariaDBConnector so we dont build the tests. Also add a config option to the CMakeVariables.txt so you can build the connector with multiple jobs * Compile on windows Specify the mariadbcpp.dll file location with a defined absolute path so windows knows it actually exists. * default to 1 job Default mariadb jobs running in parallel to 1 instead of 4 * Move mariadbcpp.dll file to the expected directory on windows * Changed plugin Updated the plugin location from the project binary directory to the expected location, the mariadb binary directory. * Addressed windows dll issues by moving files to the expected directory instead of a directory that wouldnt get created * Update README Co-authored-by: Aaron Kimbrell <aronwk.aaron@gmail.com> Co-authored-by: EmosewaMC <39972741+EmosewaMC@users.noreply.github.com>
2022-07-04 04:33:05 +00:00
```
Update README (#806) * Update README The README is very out of date, the following changes have been made - Update what the file tree should look like - Remove client Avant Gardens Survival script fix - Update some incorrect commands or commands that were missing packages. - Add packed client setup instructions - Add *config.ini setup instructions - Describe what configs should be modified and what you may want to change - More detail in the verify step - Change Account Manager link to Nexus Dashboard - Remove table of commands and reference Commands.md instead - Specify that UGCSERVERIP may need to be changed to localhost as well * Fix Avant Gardens Survival This addresses the Avant Gardens Survival bug. Squeezing it in with the README changes since it is a small change. * Remove Locale * Update README.md Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> * Remove dLocale again? * Saving for the night * Revert "Fix Avant Gardens Survival" This reverts commit b1a1ce2d84e870c328a039673c9b77859e6e3dbd. * Update Mission.cpp * Update README.md Move comments and add pre-processor define Update README.md Update README.md Update CMakePresets.json Update CMakeVariables.txt Update README.md i love readmes Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md * Update README.md Co-authored-by: Daniel Seiler <me@xiphoseer.de> * Address feedback * Update README.md * Update Database.cpp * Update README.md * Revert tcp specification Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> Co-authored-by: Aaron Kimbrell <aronwk.aaron@gmail.com> Co-authored-by: Daniel Seiler <me@xiphoseer.de>
2022-12-28 21:58:53 +00:00
For Linux, run the following command
Add Aarch64 support (#231) * added mariadb-connector-cpp submodule * raknet aarch64 support * fix compile errors * mariadb connector swap (in progress) * update CMakeLists, add preprocessor definition to switch between mysql and mariadb connectors * update types with missing aarch64 check * corrected adding extra flag to properly compile mariadbconn in CMakeLists * updated readme with arm builds section * fix build failure if test folder does not exist * Remove mysql connector from all builds, add mariadbconnector to windows build * readd Linux check for backtrace lib to CMakeLists.txt * Separate system specific mariadbconncpp extra compile flags * Copy dlls to exes directory once built * fetch prebuilt binaries on windows so that ClangCL can be used * Delay load dll so that plugin directory is set correctly * Fixed typo in glibcxx compile flag * whitespacing, spaces -> tabs * Updated README.md, included instructions to update * Updated README.md added libssl-dev requirement and removed mysql connector references from macOS builds section * apple compile fixes for zlib and shared library name * add windows arm64 checks to raknet * remove extra . in shared library location * Setup plugins directory for the connector to search in, pass openssl_root_dir on for apple * Fix copy paths for single config generators and non windows * change plugin folder location, another single config generator fix * GENERATOR_IS_MULTI_CONFIG is a property not a variable * Fixed a few errors after merge * Fix plugin directory path, force windows to look at the right folder * fixed directory name for make_directory command * Update README.md Updated MacOS, Windows build instructions. * set INSTALL_PLUGINDIR so that the right directory is used * Support for relative rpath for docker build * added mariadb-connector-cpp submodule * raknet aarch64 support * fix compile errors * mariadb connector swap (in progress) * update CMakeLists, add preprocessor definition to switch between mysql and mariadb connectors * update types with missing aarch64 check * corrected adding extra flag to properly compile mariadbconn in CMakeLists * updated readme with arm builds section * fix build failure if test folder does not exist * Remove mysql connector from all builds, add mariadbconnector to windows build * readd Linux check for backtrace lib to CMakeLists.txt * Separate system specific mariadbconncpp extra compile flags * Copy dlls to exes directory once built * fetch prebuilt binaries on windows so that ClangCL can be used * Delay load dll so that plugin directory is set correctly * Fixed typo in glibcxx compile flag * whitespacing, spaces -> tabs * Updated README.md, included instructions to update * Updated README.md added libssl-dev requirement and removed mysql connector references from macOS builds section * apple compile fixes for zlib and shared library name * add windows arm64 checks to raknet * Setup plugins directory for the connector to search in, pass openssl_root_dir on for apple * Fix copy paths for single config generators and non windows * change plugin folder location, another single config generator fix * GENERATOR_IS_MULTI_CONFIG is a property not a variable * Fixed a few errors after merge * Fix plugin directory path, force windows to look at the right folder * fixed directory name for make_directory command * Update README.md Updated MacOS, Windows build instructions. * set INSTALL_PLUGINDIR so that the right directory is used * Support for relative rpath for docker build * Rebase on main * Remove extra git submodule * Update CMakeLists.txt * Remove CMakeLists.txt file from mariadb Remove the CMakeLists.txt file from the mariaDBConnector so we dont build the tests. Also add a config option to the CMakeVariables.txt so you can build the connector with multiple jobs * Compile on windows Specify the mariadbcpp.dll file location with a defined absolute path so windows knows it actually exists. * default to 1 job Default mariadb jobs running in parallel to 1 instead of 4 * Move mariadbcpp.dll file to the expected directory on windows * Changed plugin Updated the plugin location from the project binary directory to the expected location, the mariadb binary directory. * Addressed windows dll issues by moving files to the expected directory instead of a directory that wouldnt get created * Update README Co-authored-by: Aaron Kimbrell <aronwk.aaron@gmail.com> Co-authored-by: EmosewaMC <39972741+EmosewaMC@users.noreply.github.com>
2022-07-04 04:33:05 +00:00
```bash
Update README (#806) * Update README The README is very out of date, the following changes have been made - Update what the file tree should look like - Remove client Avant Gardens Survival script fix - Update some incorrect commands or commands that were missing packages. - Add packed client setup instructions - Add *config.ini setup instructions - Describe what configs should be modified and what you may want to change - More detail in the verify step - Change Account Manager link to Nexus Dashboard - Remove table of commands and reference Commands.md instead - Specify that UGCSERVERIP may need to be changed to localhost as well * Fix Avant Gardens Survival This addresses the Avant Gardens Survival bug. Squeezing it in with the README changes since it is a small change. * Remove Locale * Update README.md Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> * Remove dLocale again? * Saving for the night * Revert "Fix Avant Gardens Survival" This reverts commit b1a1ce2d84e870c328a039673c9b77859e6e3dbd. * Update Mission.cpp * Update README.md Move comments and add pre-processor define Update README.md Update README.md Update CMakePresets.json Update CMakeVariables.txt Update README.md i love readmes Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md * Update README.md Co-authored-by: Daniel Seiler <me@xiphoseer.de> * Address feedback * Update README.md * Update Database.cpp * Update README.md * Revert tcp specification Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> Co-authored-by: Aaron Kimbrell <aronwk.aaron@gmail.com> Co-authored-by: Daniel Seiler <me@xiphoseer.de>
2022-12-28 21:58:53 +00:00
sudo systemctl start mysql
# If systemctl is not a known command on your distribution, try the following instead
sudo service mysql start
Add Aarch64 support (#231) * added mariadb-connector-cpp submodule * raknet aarch64 support * fix compile errors * mariadb connector swap (in progress) * update CMakeLists, add preprocessor definition to switch between mysql and mariadb connectors * update types with missing aarch64 check * corrected adding extra flag to properly compile mariadbconn in CMakeLists * updated readme with arm builds section * fix build failure if test folder does not exist * Remove mysql connector from all builds, add mariadbconnector to windows build * readd Linux check for backtrace lib to CMakeLists.txt * Separate system specific mariadbconncpp extra compile flags * Copy dlls to exes directory once built * fetch prebuilt binaries on windows so that ClangCL can be used * Delay load dll so that plugin directory is set correctly * Fixed typo in glibcxx compile flag * whitespacing, spaces -> tabs * Updated README.md, included instructions to update * Updated README.md added libssl-dev requirement and removed mysql connector references from macOS builds section * apple compile fixes for zlib and shared library name * add windows arm64 checks to raknet * remove extra . in shared library location * Setup plugins directory for the connector to search in, pass openssl_root_dir on for apple * Fix copy paths for single config generators and non windows * change plugin folder location, another single config generator fix * GENERATOR_IS_MULTI_CONFIG is a property not a variable * Fixed a few errors after merge * Fix plugin directory path, force windows to look at the right folder * fixed directory name for make_directory command * Update README.md Updated MacOS, Windows build instructions. * set INSTALL_PLUGINDIR so that the right directory is used * Support for relative rpath for docker build * added mariadb-connector-cpp submodule * raknet aarch64 support * fix compile errors * mariadb connector swap (in progress) * update CMakeLists, add preprocessor definition to switch between mysql and mariadb connectors * update types with missing aarch64 check * corrected adding extra flag to properly compile mariadbconn in CMakeLists * updated readme with arm builds section * fix build failure if test folder does not exist * Remove mysql connector from all builds, add mariadbconnector to windows build * readd Linux check for backtrace lib to CMakeLists.txt * Separate system specific mariadbconncpp extra compile flags * Copy dlls to exes directory once built * fetch prebuilt binaries on windows so that ClangCL can be used * Delay load dll so that plugin directory is set correctly * Fixed typo in glibcxx compile flag * whitespacing, spaces -> tabs * Updated README.md, included instructions to update * Updated README.md added libssl-dev requirement and removed mysql connector references from macOS builds section * apple compile fixes for zlib and shared library name * add windows arm64 checks to raknet * Setup plugins directory for the connector to search in, pass openssl_root_dir on for apple * Fix copy paths for single config generators and non windows * change plugin folder location, another single config generator fix * GENERATOR_IS_MULTI_CONFIG is a property not a variable * Fixed a few errors after merge * Fix plugin directory path, force windows to look at the right folder * fixed directory name for make_directory command * Update README.md Updated MacOS, Windows build instructions. * set INSTALL_PLUGINDIR so that the right directory is used * Support for relative rpath for docker build * Rebase on main * Remove extra git submodule * Update CMakeLists.txt * Remove CMakeLists.txt file from mariadb Remove the CMakeLists.txt file from the mariaDBConnector so we dont build the tests. Also add a config option to the CMakeVariables.txt so you can build the connector with multiple jobs * Compile on windows Specify the mariadbcpp.dll file location with a defined absolute path so windows knows it actually exists. * default to 1 job Default mariadb jobs running in parallel to 1 instead of 4 * Move mariadbcpp.dll file to the expected directory on windows * Changed plugin Updated the plugin location from the project binary directory to the expected location, the mariadb binary directory. * Addressed windows dll issues by moving files to the expected directory instead of a directory that wouldnt get created * Update README Co-authored-by: Aaron Kimbrell <aronwk.aaron@gmail.com> Co-authored-by: EmosewaMC <39972741+EmosewaMC@users.noreply.github.com>
2022-07-04 04:33:05 +00:00
```
2021-12-05 17:40:43 +00:00
Update README (#806) * Update README The README is very out of date, the following changes have been made - Update what the file tree should look like - Remove client Avant Gardens Survival script fix - Update some incorrect commands or commands that were missing packages. - Add packed client setup instructions - Add *config.ini setup instructions - Describe what configs should be modified and what you may want to change - More detail in the verify step - Change Account Manager link to Nexus Dashboard - Remove table of commands and reference Commands.md instead - Specify that UGCSERVERIP may need to be changed to localhost as well * Fix Avant Gardens Survival This addresses the Avant Gardens Survival bug. Squeezing it in with the README changes since it is a small change. * Remove Locale * Update README.md Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> * Remove dLocale again? * Saving for the night * Revert "Fix Avant Gardens Survival" This reverts commit b1a1ce2d84e870c328a039673c9b77859e6e3dbd. * Update Mission.cpp * Update README.md Move comments and add pre-processor define Update README.md Update README.md Update CMakePresets.json Update CMakeVariables.txt Update README.md i love readmes Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md * Update README.md Co-authored-by: Daniel Seiler <me@xiphoseer.de> * Address feedback * Update README.md * Update Database.cpp * Update README.md * Revert tcp specification Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> Co-authored-by: Aaron Kimbrell <aronwk.aaron@gmail.com> Co-authored-by: Daniel Seiler <me@xiphoseer.de>
2022-12-28 21:58:53 +00:00
<font size="4">**You will need to run this command every time you restart your environment**</font>
2021-12-05 17:40:43 +00:00
Update README (#806) * Update README The README is very out of date, the following changes have been made - Update what the file tree should look like - Remove client Avant Gardens Survival script fix - Update some incorrect commands or commands that were missing packages. - Add packed client setup instructions - Add *config.ini setup instructions - Describe what configs should be modified and what you may want to change - More detail in the verify step - Change Account Manager link to Nexus Dashboard - Remove table of commands and reference Commands.md instead - Specify that UGCSERVERIP may need to be changed to localhost as well * Fix Avant Gardens Survival This addresses the Avant Gardens Survival bug. Squeezing it in with the README changes since it is a small change. * Remove Locale * Update README.md Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> * Remove dLocale again? * Saving for the night * Revert "Fix Avant Gardens Survival" This reverts commit b1a1ce2d84e870c328a039673c9b77859e6e3dbd. * Update Mission.cpp * Update README.md Move comments and add pre-processor define Update README.md Update README.md Update CMakePresets.json Update CMakeVariables.txt Update README.md i love readmes Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md * Update README.md Co-authored-by: Daniel Seiler <me@xiphoseer.de> * Address feedback * Update README.md * Update Database.cpp * Update README.md * Revert tcp specification Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> Co-authored-by: Aaron Kimbrell <aronwk.aaron@gmail.com> Co-authored-by: Daniel Seiler <me@xiphoseer.de>
2022-12-28 21:58:53 +00:00
If you are using Linux and `systemctl` and want the MariaDB instance to start on startup, run the following command
2021-12-05 17:40:43 +00:00
```bash
Update README (#806) * Update README The README is very out of date, the following changes have been made - Update what the file tree should look like - Remove client Avant Gardens Survival script fix - Update some incorrect commands or commands that were missing packages. - Add packed client setup instructions - Add *config.ini setup instructions - Describe what configs should be modified and what you may want to change - More detail in the verify step - Change Account Manager link to Nexus Dashboard - Remove table of commands and reference Commands.md instead - Specify that UGCSERVERIP may need to be changed to localhost as well * Fix Avant Gardens Survival This addresses the Avant Gardens Survival bug. Squeezing it in with the README changes since it is a small change. * Remove Locale * Update README.md Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> * Remove dLocale again? * Saving for the night * Revert "Fix Avant Gardens Survival" This reverts commit b1a1ce2d84e870c328a039673c9b77859e6e3dbd. * Update Mission.cpp * Update README.md Move comments and add pre-processor define Update README.md Update README.md Update CMakePresets.json Update CMakeVariables.txt Update README.md i love readmes Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md * Update README.md Co-authored-by: Daniel Seiler <me@xiphoseer.de> * Address feedback * Update README.md * Update Database.cpp * Update README.md * Revert tcp specification Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> Co-authored-by: Aaron Kimbrell <aronwk.aaron@gmail.com> Co-authored-by: Daniel Seiler <me@xiphoseer.de>
2022-12-28 21:58:53 +00:00
sudo systemctl enable --now mysql
2021-12-05 17:40:43 +00:00
```
Update README (#806) * Update README The README is very out of date, the following changes have been made - Update what the file tree should look like - Remove client Avant Gardens Survival script fix - Update some incorrect commands or commands that were missing packages. - Add packed client setup instructions - Add *config.ini setup instructions - Describe what configs should be modified and what you may want to change - More detail in the verify step - Change Account Manager link to Nexus Dashboard - Remove table of commands and reference Commands.md instead - Specify that UGCSERVERIP may need to be changed to localhost as well * Fix Avant Gardens Survival This addresses the Avant Gardens Survival bug. Squeezing it in with the README changes since it is a small change. * Remove Locale * Update README.md Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> * Remove dLocale again? * Saving for the night * Revert "Fix Avant Gardens Survival" This reverts commit b1a1ce2d84e870c328a039673c9b77859e6e3dbd. * Update Mission.cpp * Update README.md Move comments and add pre-processor define Update README.md Update README.md Update CMakePresets.json Update CMakeVariables.txt Update README.md i love readmes Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md * Update README.md Co-authored-by: Daniel Seiler <me@xiphoseer.de> * Address feedback * Update README.md * Update Database.cpp * Update README.md * Revert tcp specification Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> Co-authored-by: Aaron Kimbrell <aronwk.aaron@gmail.com> Co-authored-by: Daniel Seiler <me@xiphoseer.de>
2022-12-28 21:58:53 +00:00
Once MariaDB is started, you'll need to create a user and an empty database for Darkflame Universe to use.
2021-12-05 17:40:43 +00:00
Update README (#806) * Update README The README is very out of date, the following changes have been made - Update what the file tree should look like - Remove client Avant Gardens Survival script fix - Update some incorrect commands or commands that were missing packages. - Add packed client setup instructions - Add *config.ini setup instructions - Describe what configs should be modified and what you may want to change - More detail in the verify step - Change Account Manager link to Nexus Dashboard - Remove table of commands and reference Commands.md instead - Specify that UGCSERVERIP may need to be changed to localhost as well * Fix Avant Gardens Survival This addresses the Avant Gardens Survival bug. Squeezing it in with the README changes since it is a small change. * Remove Locale * Update README.md Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> * Remove dLocale again? * Saving for the night * Revert "Fix Avant Gardens Survival" This reverts commit b1a1ce2d84e870c328a039673c9b77859e6e3dbd. * Update Mission.cpp * Update README.md Move comments and add pre-processor define Update README.md Update README.md Update CMakePresets.json Update CMakeVariables.txt Update README.md i love readmes Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md * Update README.md Co-authored-by: Daniel Seiler <me@xiphoseer.de> * Address feedback * Update README.md * Update Database.cpp * Update README.md * Revert tcp specification Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> Co-authored-by: Aaron Kimbrell <aronwk.aaron@gmail.com> Co-authored-by: Daniel Seiler <me@xiphoseer.de>
2022-12-28 21:58:53 +00:00
First, login to the MariaDB instance.
2021-12-05 17:40:43 +00:00
Update README (#806) * Update README The README is very out of date, the following changes have been made - Update what the file tree should look like - Remove client Avant Gardens Survival script fix - Update some incorrect commands or commands that were missing packages. - Add packed client setup instructions - Add *config.ini setup instructions - Describe what configs should be modified and what you may want to change - More detail in the verify step - Change Account Manager link to Nexus Dashboard - Remove table of commands and reference Commands.md instead - Specify that UGCSERVERIP may need to be changed to localhost as well * Fix Avant Gardens Survival This addresses the Avant Gardens Survival bug. Squeezing it in with the README changes since it is a small change. * Remove Locale * Update README.md Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> * Remove dLocale again? * Saving for the night * Revert "Fix Avant Gardens Survival" This reverts commit b1a1ce2d84e870c328a039673c9b77859e6e3dbd. * Update Mission.cpp * Update README.md Move comments and add pre-processor define Update README.md Update README.md Update CMakePresets.json Update CMakeVariables.txt Update README.md i love readmes Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md * Update README.md Co-authored-by: Daniel Seiler <me@xiphoseer.de> * Address feedback * Update README.md * Update Database.cpp * Update README.md * Revert tcp specification Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> Co-authored-by: Aaron Kimbrell <aronwk.aaron@gmail.com> Co-authored-by: Daniel Seiler <me@xiphoseer.de>
2022-12-28 21:58:53 +00:00
To do this on Ubuntu/Linux, MacOS, or another Unix like operating system, run the following command in a terminal
```bash
# Logs you into the MariaDB instance as root
sudo mysql
```
Address Brick-By-Brick builds not properly saving and make migrations automatic (#725) * Properly store BBB in database Store the BBB data in the database as the received SD0 packet as opposed to just the raw lxfml. Addressed several memory leaks as well. * Add Sd0Conversion Add brick by brick conversion commands with 2 parameters to tell the program what to do with the data. Add zlib -> sd0 conversion. Files look good at a glance but should be tested in game to ensure stability. Tests to come. * moving to laptop ignore this commit. I need to move this to my laptop * Add functionality to delete bad models Adds functionality to delete bad models. Models are batched together and deleted in one commit. More testing is needed to ensure data safety. Positive tests on a live database reveal the broken models were truncated and complete ones were kept around successfully. Tests should be done to ensure larger sd0 models are properly saved and not truncated since this command should be able to be run any time. Valgrind tests need to be run as well to ensure no memory leaks exist. * Delete from query change Changed from delete to delete cascade and instead deleting from properties_contents as opposed to ugc. * Address numerous bugs DELETE CASCADE is not a valid SQL command so this was changed to a better delete statement. Added user confirmation before deleting a broken model. Address appending the string model appending bad data, causing excess deletion. Addressed memory leaks with sql::Blob * Error handling for string * Even more proper handling... * Add bounds check for cli command Output a message if a bad command is used. Update MasterServer.cpp * Remove user interference -Add back in mariadb build jobs so i dont nuke others systems - Remove all user interference and consolidate work into one command since 1 depends on the next. * Add comments test Revert "test" This reverts commit fb831f268b7a2f0ccd20595aff64902ab4f4b4ee. * Update CMakeMariaDBLists.txt Test * Improve migration runner Migration runner now runs automatically. - Resolved an issue where extremely large sql queries caused the database to go into an invalid state. - Made migrations run automatically on server start. - Resolved a tiny memory leak in migration runner? (discarded returned pointer) - Moved sd0 migrations of brick models to be run automatically with migration runner. - Created dummy file to tell when brick migrations have been run. * Update README Updated the README to reflect the new server migration state. * Make model deleter actually delete models My complicated sql actually did nothing... Tested that this new SQL properly gets rid of bad data. * Revert "Update CMakeMariaDBLists.txt" This reverts commit 8b859d8529755d7132cef072b2532589c098f683.
2022-10-24 22:20:36 +00:00
Update README (#806) * Update README The README is very out of date, the following changes have been made - Update what the file tree should look like - Remove client Avant Gardens Survival script fix - Update some incorrect commands or commands that were missing packages. - Add packed client setup instructions - Add *config.ini setup instructions - Describe what configs should be modified and what you may want to change - More detail in the verify step - Change Account Manager link to Nexus Dashboard - Remove table of commands and reference Commands.md instead - Specify that UGCSERVERIP may need to be changed to localhost as well * Fix Avant Gardens Survival This addresses the Avant Gardens Survival bug. Squeezing it in with the README changes since it is a small change. * Remove Locale * Update README.md Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> * Remove dLocale again? * Saving for the night * Revert "Fix Avant Gardens Survival" This reverts commit b1a1ce2d84e870c328a039673c9b77859e6e3dbd. * Update Mission.cpp * Update README.md Move comments and add pre-processor define Update README.md Update README.md Update CMakePresets.json Update CMakeVariables.txt Update README.md i love readmes Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md * Update README.md Co-authored-by: Daniel Seiler <me@xiphoseer.de> * Address feedback * Update README.md * Update Database.cpp * Update README.md * Revert tcp specification Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> Co-authored-by: Aaron Kimbrell <aronwk.aaron@gmail.com> Co-authored-by: Daniel Seiler <me@xiphoseer.de>
2022-12-28 21:58:53 +00:00
For Windows, run the following command in the `Command Prompt (MariaDB xx.xx)` terminal
```bash
# Logs you into the mysql instance
mysql -u root -p
# You will then be prompted for the password you set for root during installation of MariaDB
```
Update README (#806) * Update README The README is very out of date, the following changes have been made - Update what the file tree should look like - Remove client Avant Gardens Survival script fix - Update some incorrect commands or commands that were missing packages. - Add packed client setup instructions - Add *config.ini setup instructions - Describe what configs should be modified and what you may want to change - More detail in the verify step - Change Account Manager link to Nexus Dashboard - Remove table of commands and reference Commands.md instead - Specify that UGCSERVERIP may need to be changed to localhost as well * Fix Avant Gardens Survival This addresses the Avant Gardens Survival bug. Squeezing it in with the README changes since it is a small change. * Remove Locale * Update README.md Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> * Remove dLocale again? * Saving for the night * Revert "Fix Avant Gardens Survival" This reverts commit b1a1ce2d84e870c328a039673c9b77859e6e3dbd. * Update Mission.cpp * Update README.md Move comments and add pre-processor define Update README.md Update README.md Update CMakePresets.json Update CMakeVariables.txt Update README.md i love readmes Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md * Update README.md Co-authored-by: Daniel Seiler <me@xiphoseer.de> * Address feedback * Update README.md * Update Database.cpp * Update README.md * Revert tcp specification Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> Co-authored-by: Aaron Kimbrell <aronwk.aaron@gmail.com> Co-authored-by: Daniel Seiler <me@xiphoseer.de>
2022-12-28 21:58:53 +00:00
Now that you are logged in, run the following commands.
2021-12-05 17:40:43 +00:00
Update README (#806) * Update README The README is very out of date, the following changes have been made - Update what the file tree should look like - Remove client Avant Gardens Survival script fix - Update some incorrect commands or commands that were missing packages. - Add packed client setup instructions - Add *config.ini setup instructions - Describe what configs should be modified and what you may want to change - More detail in the verify step - Change Account Manager link to Nexus Dashboard - Remove table of commands and reference Commands.md instead - Specify that UGCSERVERIP may need to be changed to localhost as well * Fix Avant Gardens Survival This addresses the Avant Gardens Survival bug. Squeezing it in with the README changes since it is a small change. * Remove Locale * Update README.md Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> * Remove dLocale again? * Saving for the night * Revert "Fix Avant Gardens Survival" This reverts commit b1a1ce2d84e870c328a039673c9b77859e6e3dbd. * Update Mission.cpp * Update README.md Move comments and add pre-processor define Update README.md Update README.md Update CMakePresets.json Update CMakeVariables.txt Update README.md i love readmes Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md * Update README.md Co-authored-by: Daniel Seiler <me@xiphoseer.de> * Address feedback * Update README.md * Update Database.cpp * Update README.md * Revert tcp specification Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> Co-authored-by: Aaron Kimbrell <aronwk.aaron@gmail.com> Co-authored-by: Daniel Seiler <me@xiphoseer.de>
2022-12-28 21:58:53 +00:00
```bash
# Creates a user for this computer which uses a password and grant said user all privileges.
# Change mydarkflameuser to a custom username and password to a custom password.
GRANT ALL ON *.* TO 'mydarkflameuser'@'localhost' IDENTIFIED BY 'password' WITH GRANT OPTION;
FLUSH PRIVILEGES;
2021-12-05 17:40:43 +00:00
Update README (#806) * Update README The README is very out of date, the following changes have been made - Update what the file tree should look like - Remove client Avant Gardens Survival script fix - Update some incorrect commands or commands that were missing packages. - Add packed client setup instructions - Add *config.ini setup instructions - Describe what configs should be modified and what you may want to change - More detail in the verify step - Change Account Manager link to Nexus Dashboard - Remove table of commands and reference Commands.md instead - Specify that UGCSERVERIP may need to be changed to localhost as well * Fix Avant Gardens Survival This addresses the Avant Gardens Survival bug. Squeezing it in with the README changes since it is a small change. * Remove Locale * Update README.md Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> * Remove dLocale again? * Saving for the night * Revert "Fix Avant Gardens Survival" This reverts commit b1a1ce2d84e870c328a039673c9b77859e6e3dbd. * Update Mission.cpp * Update README.md Move comments and add pre-processor define Update README.md Update README.md Update CMakePresets.json Update CMakeVariables.txt Update README.md i love readmes Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md * Update README.md Co-authored-by: Daniel Seiler <me@xiphoseer.de> * Address feedback * Update README.md * Update Database.cpp * Update README.md * Revert tcp specification Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> Co-authored-by: Aaron Kimbrell <aronwk.aaron@gmail.com> Co-authored-by: Daniel Seiler <me@xiphoseer.de>
2022-12-28 21:58:53 +00:00
# Then create a database for Darkflame Universe to use.
CREATE DATABASE darkflame;
```
Update README (#806) * Update README The README is very out of date, the following changes have been made - Update what the file tree should look like - Remove client Avant Gardens Survival script fix - Update some incorrect commands or commands that were missing packages. - Add packed client setup instructions - Add *config.ini setup instructions - Describe what configs should be modified and what you may want to change - More detail in the verify step - Change Account Manager link to Nexus Dashboard - Remove table of commands and reference Commands.md instead - Specify that UGCSERVERIP may need to be changed to localhost as well * Fix Avant Gardens Survival This addresses the Avant Gardens Survival bug. Squeezing it in with the README changes since it is a small change. * Remove Locale * Update README.md Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> * Remove dLocale again? * Saving for the night * Revert "Fix Avant Gardens Survival" This reverts commit b1a1ce2d84e870c328a039673c9b77859e6e3dbd. * Update Mission.cpp * Update README.md Move comments and add pre-processor define Update README.md Update README.md Update CMakePresets.json Update CMakeVariables.txt Update README.md i love readmes Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md * Update README.md Co-authored-by: Daniel Seiler <me@xiphoseer.de> * Address feedback * Update README.md * Update Database.cpp * Update README.md * Revert tcp specification Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> Co-authored-by: Aaron Kimbrell <aronwk.aaron@gmail.com> Co-authored-by: Daniel Seiler <me@xiphoseer.de>
2022-12-28 21:58:53 +00:00
## Build the server
You can either run `build.sh` when in the root folder of the repository:
Update README (#806) * Update README The README is very out of date, the following changes have been made - Update what the file tree should look like - Remove client Avant Gardens Survival script fix - Update some incorrect commands or commands that were missing packages. - Add packed client setup instructions - Add *config.ini setup instructions - Describe what configs should be modified and what you may want to change - More detail in the verify step - Change Account Manager link to Nexus Dashboard - Remove table of commands and reference Commands.md instead - Specify that UGCSERVERIP may need to be changed to localhost as well * Fix Avant Gardens Survival This addresses the Avant Gardens Survival bug. Squeezing it in with the README changes since it is a small change. * Remove Locale * Update README.md Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> * Remove dLocale again? * Saving for the night * Revert "Fix Avant Gardens Survival" This reverts commit b1a1ce2d84e870c328a039673c9b77859e6e3dbd. * Update Mission.cpp * Update README.md Move comments and add pre-processor define Update README.md Update README.md Update CMakePresets.json Update CMakeVariables.txt Update README.md i love readmes Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md * Update README.md Co-authored-by: Daniel Seiler <me@xiphoseer.de> * Address feedback * Update README.md * Update Database.cpp * Update README.md * Revert tcp specification Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> Co-authored-by: Aaron Kimbrell <aronwk.aaron@gmail.com> Co-authored-by: Daniel Seiler <me@xiphoseer.de>
2022-12-28 21:58:53 +00:00
```bash
./build.sh
```
2021-12-05 17:40:43 +00:00
Update README (#806) * Update README The README is very out of date, the following changes have been made - Update what the file tree should look like - Remove client Avant Gardens Survival script fix - Update some incorrect commands or commands that were missing packages. - Add packed client setup instructions - Add *config.ini setup instructions - Describe what configs should be modified and what you may want to change - More detail in the verify step - Change Account Manager link to Nexus Dashboard - Remove table of commands and reference Commands.md instead - Specify that UGCSERVERIP may need to be changed to localhost as well * Fix Avant Gardens Survival This addresses the Avant Gardens Survival bug. Squeezing it in with the README changes since it is a small change. * Remove Locale * Update README.md Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> * Remove dLocale again? * Saving for the night * Revert "Fix Avant Gardens Survival" This reverts commit b1a1ce2d84e870c328a039673c9b77859e6e3dbd. * Update Mission.cpp * Update README.md Move comments and add pre-processor define Update README.md Update README.md Update CMakePresets.json Update CMakeVariables.txt Update README.md i love readmes Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md * Update README.md Co-authored-by: Daniel Seiler <me@xiphoseer.de> * Address feedback * Update README.md * Update Database.cpp * Update README.md * Revert tcp specification Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> Co-authored-by: Aaron Kimbrell <aronwk.aaron@gmail.com> Co-authored-by: Daniel Seiler <me@xiphoseer.de>
2022-12-28 21:58:53 +00:00
Or manually run the commands used in [build.sh](build.sh).
If you would like to build the server faster, append `-j<number>` where number is the number of simultaneous compile jobs to run at once. It is recommended that you have this number always be 1 less than your core count to prevent slowdowns. The command would look like this if you would build with 4 jobs at once:
```bash
./build.sh -j4
```
Update README (#806) * Update README The README is very out of date, the following changes have been made - Update what the file tree should look like - Remove client Avant Gardens Survival script fix - Update some incorrect commands or commands that were missing packages. - Add packed client setup instructions - Add *config.ini setup instructions - Describe what configs should be modified and what you may want to change - More detail in the verify step - Change Account Manager link to Nexus Dashboard - Remove table of commands and reference Commands.md instead - Specify that UGCSERVERIP may need to be changed to localhost as well * Fix Avant Gardens Survival This addresses the Avant Gardens Survival bug. Squeezing it in with the README changes since it is a small change. * Remove Locale * Update README.md Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> * Remove dLocale again? * Saving for the night * Revert "Fix Avant Gardens Survival" This reverts commit b1a1ce2d84e870c328a039673c9b77859e6e3dbd. * Update Mission.cpp * Update README.md Move comments and add pre-processor define Update README.md Update README.md Update CMakePresets.json Update CMakeVariables.txt Update README.md i love readmes Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md * Update README.md Co-authored-by: Daniel Seiler <me@xiphoseer.de> * Address feedback * Update README.md * Update Database.cpp * Update README.md * Revert tcp specification Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> Co-authored-by: Aaron Kimbrell <aronwk.aaron@gmail.com> Co-authored-by: Daniel Seiler <me@xiphoseer.de>
2022-12-28 21:58:53 +00:00
### Notes
Depending on your operating system, you may need to adjust some pre-processor defines in [CMakeVariables.txt](./CMakeVariables.txt) before building:
* If you are on MacOS, ensure OPENSSL_ROOT_DIR is pointing to the openssl root directory.
* If you are using a Darkflame Universe client, ensure `client_net_version` in `build/sharedconfig.ini` is changed to 171023.
Update README (#806) * Update README The README is very out of date, the following changes have been made - Update what the file tree should look like - Remove client Avant Gardens Survival script fix - Update some incorrect commands or commands that were missing packages. - Add packed client setup instructions - Add *config.ini setup instructions - Describe what configs should be modified and what you may want to change - More detail in the verify step - Change Account Manager link to Nexus Dashboard - Remove table of commands and reference Commands.md instead - Specify that UGCSERVERIP may need to be changed to localhost as well * Fix Avant Gardens Survival This addresses the Avant Gardens Survival bug. Squeezing it in with the README changes since it is a small change. * Remove Locale * Update README.md Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> * Remove dLocale again? * Saving for the night * Revert "Fix Avant Gardens Survival" This reverts commit b1a1ce2d84e870c328a039673c9b77859e6e3dbd. * Update Mission.cpp * Update README.md Move comments and add pre-processor define Update README.md Update README.md Update CMakePresets.json Update CMakeVariables.txt Update README.md i love readmes Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md * Update README.md Co-authored-by: Daniel Seiler <me@xiphoseer.de> * Address feedback * Update README.md * Update Database.cpp * Update README.md * Revert tcp specification Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> Co-authored-by: Aaron Kimbrell <aronwk.aaron@gmail.com> Co-authored-by: Daniel Seiler <me@xiphoseer.de>
2022-12-28 21:58:53 +00:00
## Configuring your server
This server has a few steps that need to be taken to configure the server for your use case.
### Required Configuration
Darkflame Universe can run with either a packed or an unpacked client.
Navigate to `build/sharedconfig.ini` and fill in the following fields:
* `mysql_host` (This is the IP address or hostname of your MariaDB server. This is highly likely `localhost`)
* If you setup your MariaDB instance on a port other than 3306, which can be done on a Windows install, you will need to make this value `tcp://localhost:portNum` where portNum is replaced with the port you chose to run MariaDB on.
* `mysql_database` (This is the database you created for the server)
* `mysql_username` (This is the user you created for the server)
* `mysql_password` (This is the password for the user you created for the server)
* `client_location` (This is the location of the client files. This should be the folder path of a packed or unpacked client)
* Ideally the path to the client should not contain any spaces.
### Optional Configuration
* After the server has been built there should be five `ini` files in the build directory: `sharedconfig.ini`, `authconfig.ini`, `chatconfig.ini`, `masterconfig.ini`, and `worldconfig.ini`.
* `authconfig.ini` contains an option to enable or disable play keys on your server. Do not change the default port for auth.
* `chatconfig.ini` contains a port option.
* `masterconfig.ini` contains options related to permissions you want to run your servers with.
* `sharedconfig.ini` contains several options that are shared across all servers
* `worldconfig.ini` contains several options to turn on QOL improvements should you want them. If you would like the most vanilla experience possible, you will need to turn some of these settings off.
## Verify your setup
2021-12-05 17:40:43 +00:00
Your build directory should now look like this:
* AuthServer
* ChatServer
* MasterServer
* WorldServer
* authconfig.ini
* chatconfig.ini
* masterconfig.ini
Update README (#806) * Update README The README is very out of date, the following changes have been made - Update what the file tree should look like - Remove client Avant Gardens Survival script fix - Update some incorrect commands or commands that were missing packages. - Add packed client setup instructions - Add *config.ini setup instructions - Describe what configs should be modified and what you may want to change - More detail in the verify step - Change Account Manager link to Nexus Dashboard - Remove table of commands and reference Commands.md instead - Specify that UGCSERVERIP may need to be changed to localhost as well * Fix Avant Gardens Survival This addresses the Avant Gardens Survival bug. Squeezing it in with the README changes since it is a small change. * Remove Locale * Update README.md Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> * Remove dLocale again? * Saving for the night * Revert "Fix Avant Gardens Survival" This reverts commit b1a1ce2d84e870c328a039673c9b77859e6e3dbd. * Update Mission.cpp * Update README.md Move comments and add pre-processor define Update README.md Update README.md Update CMakePresets.json Update CMakeVariables.txt Update README.md i love readmes Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md * Update README.md Co-authored-by: Daniel Seiler <me@xiphoseer.de> * Address feedback * Update README.md * Update Database.cpp * Update README.md * Revert tcp specification Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> Co-authored-by: Aaron Kimbrell <aronwk.aaron@gmail.com> Co-authored-by: Daniel Seiler <me@xiphoseer.de>
2022-12-28 21:58:53 +00:00
* sharedconfig.ini
2021-12-05 17:40:43 +00:00
* worldconfig.ini
* ...
## Running the server
Update README (#806) * Update README The README is very out of date, the following changes have been made - Update what the file tree should look like - Remove client Avant Gardens Survival script fix - Update some incorrect commands or commands that were missing packages. - Add packed client setup instructions - Add *config.ini setup instructions - Describe what configs should be modified and what you may want to change - More detail in the verify step - Change Account Manager link to Nexus Dashboard - Remove table of commands and reference Commands.md instead - Specify that UGCSERVERIP may need to be changed to localhost as well * Fix Avant Gardens Survival This addresses the Avant Gardens Survival bug. Squeezing it in with the README changes since it is a small change. * Remove Locale * Update README.md Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> * Remove dLocale again? * Saving for the night * Revert "Fix Avant Gardens Survival" This reverts commit b1a1ce2d84e870c328a039673c9b77859e6e3dbd. * Update Mission.cpp * Update README.md Move comments and add pre-processor define Update README.md Update README.md Update CMakePresets.json Update CMakeVariables.txt Update README.md i love readmes Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md * Update README.md Co-authored-by: Daniel Seiler <me@xiphoseer.de> * Address feedback * Update README.md * Update Database.cpp * Update README.md * Revert tcp specification Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> Co-authored-by: Aaron Kimbrell <aronwk.aaron@gmail.com> Co-authored-by: Daniel Seiler <me@xiphoseer.de>
2022-12-28 21:58:53 +00:00
If everything has been configured correctly you should now be able to run the `MasterServer` binary which is located in the `build` directory. Darkflame Universe utilizes port numbers under 1024, so under Linux you either have to give the `AuthServer` binary network permissions or run it under sudo.
To give `AuthServer` network permissions and not require sudo, run the following command
```bash
sudo setcap 'cap_net_bind_service=+ep' AuthServer
```
and then go to `build/masterconfig.ini` and change `use_sudo_auth` to 0.
2021-12-05 17:40:43 +00:00
### Linux Service
If you are running this on a linux based system, it will use your terminal to run the program interactively, preventing you using it for other tasks and requiring it to be open to run the server.
_Note: You could use screen or tmux instead for virtual terminals_
To run the server non-interactively, we can use a systemctl service by copying the following file:
```shell
cp ./systemd.example /etc/systemd/system/darkflame.service
```
Make sure to edit the file in `/etc/systemd/system/darkflame.service` and change the:
- `User` and `Group` to the user that runs the darkflame server.
- `ExecPath` to the full file path of the server executable.
To register, enable and start the service use the following commands:
- Reload the systemd manager configuration to make it aware of the new service file:
```shell
systemctl daemon-reload
```
- Start the service:
```shell
systemctl start darkflame.service
```
- Enable OR disable the service to start on boot using:
```shell
systemctl enable darkflame.service
systemctl disable darkflame.service
```
- Verify that the service is running without errors:
```shell
systemctl status darkflame.service
```
- You can also restart, stop, or check the logs of the service using journalctl
```shell
systemctl restart darkflame.service
systemctl stop darkflame.service
journalctl -xeu darkflame.service
```
2021-12-05 17:40:43 +00:00
### First admin user
Run `MasterServer -a` to get prompted to create an admin account. This method is only intended for the system administrator as a means to get started, do NOT use this method to create accounts for other users!
Update README (#806) * Update README The README is very out of date, the following changes have been made - Update what the file tree should look like - Remove client Avant Gardens Survival script fix - Update some incorrect commands or commands that were missing packages. - Add packed client setup instructions - Add *config.ini setup instructions - Describe what configs should be modified and what you may want to change - More detail in the verify step - Change Account Manager link to Nexus Dashboard - Remove table of commands and reference Commands.md instead - Specify that UGCSERVERIP may need to be changed to localhost as well * Fix Avant Gardens Survival This addresses the Avant Gardens Survival bug. Squeezing it in with the README changes since it is a small change. * Remove Locale * Update README.md Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> * Remove dLocale again? * Saving for the night * Revert "Fix Avant Gardens Survival" This reverts commit b1a1ce2d84e870c328a039673c9b77859e6e3dbd. * Update Mission.cpp * Update README.md Move comments and add pre-processor define Update README.md Update README.md Update CMakePresets.json Update CMakeVariables.txt Update README.md i love readmes Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md * Update README.md Co-authored-by: Daniel Seiler <me@xiphoseer.de> * Address feedback * Update README.md * Update Database.cpp * Update README.md * Revert tcp specification Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> Co-authored-by: Aaron Kimbrell <aronwk.aaron@gmail.com> Co-authored-by: Daniel Seiler <me@xiphoseer.de>
2022-12-28 21:58:53 +00:00
### Account management tool (Nexus Dashboard)
**If you are just using this server for yourself, you can skip setting up Nexus Dashboard**
2021-12-05 17:40:43 +00:00
Update README (#806) * Update README The README is very out of date, the following changes have been made - Update what the file tree should look like - Remove client Avant Gardens Survival script fix - Update some incorrect commands or commands that were missing packages. - Add packed client setup instructions - Add *config.ini setup instructions - Describe what configs should be modified and what you may want to change - More detail in the verify step - Change Account Manager link to Nexus Dashboard - Remove table of commands and reference Commands.md instead - Specify that UGCSERVERIP may need to be changed to localhost as well * Fix Avant Gardens Survival This addresses the Avant Gardens Survival bug. Squeezing it in with the README changes since it is a small change. * Remove Locale * Update README.md Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> * Remove dLocale again? * Saving for the night * Revert "Fix Avant Gardens Survival" This reverts commit b1a1ce2d84e870c328a039673c9b77859e6e3dbd. * Update Mission.cpp * Update README.md Move comments and add pre-processor define Update README.md Update README.md Update CMakePresets.json Update CMakeVariables.txt Update README.md i love readmes Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md * Update README.md Co-authored-by: Daniel Seiler <me@xiphoseer.de> * Address feedback * Update README.md * Update Database.cpp * Update README.md * Revert tcp specification Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> Co-authored-by: Aaron Kimbrell <aronwk.aaron@gmail.com> Co-authored-by: Daniel Seiler <me@xiphoseer.de>
2022-12-28 21:58:53 +00:00
Follow the instructions [here](https://github.com/DarkflameUniverse/NexusDashboard) to setup the DLU Nexus Dashboard web application. This is the intended way for users to create accounts and the intended way for moderators to approve names/pets/properties and do other moderation actions.
2021-12-05 17:40:43 +00:00
### Admin levels
Update README (#806) * Update README The README is very out of date, the following changes have been made - Update what the file tree should look like - Remove client Avant Gardens Survival script fix - Update some incorrect commands or commands that were missing packages. - Add packed client setup instructions - Add *config.ini setup instructions - Describe what configs should be modified and what you may want to change - More detail in the verify step - Change Account Manager link to Nexus Dashboard - Remove table of commands and reference Commands.md instead - Specify that UGCSERVERIP may need to be changed to localhost as well * Fix Avant Gardens Survival This addresses the Avant Gardens Survival bug. Squeezing it in with the README changes since it is a small change. * Remove Locale * Update README.md Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> * Remove dLocale again? * Saving for the night * Revert "Fix Avant Gardens Survival" This reverts commit b1a1ce2d84e870c328a039673c9b77859e6e3dbd. * Update Mission.cpp * Update README.md Move comments and add pre-processor define Update README.md Update README.md Update CMakePresets.json Update CMakeVariables.txt Update README.md i love readmes Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md * Update README.md Co-authored-by: Daniel Seiler <me@xiphoseer.de> * Address feedback * Update README.md * Update Database.cpp * Update README.md * Revert tcp specification Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> Co-authored-by: Aaron Kimbrell <aronwk.aaron@gmail.com> Co-authored-by: Daniel Seiler <me@xiphoseer.de>
2022-12-28 21:58:53 +00:00
The admin level, or Game Master level (hereafter referred to as gmlevel), is specified in the `accounts.gm_level` column in the MySQL database. Normal players should have this set to `0`, which comes with no special privileges. The system administrator will have this set to `9`, which comes will all privileges. gmlevel `8` should be used to give a player a majority of privileges without the safety critical once.
2021-12-05 17:40:43 +00:00
Update README (#806) * Update README The README is very out of date, the following changes have been made - Update what the file tree should look like - Remove client Avant Gardens Survival script fix - Update some incorrect commands or commands that were missing packages. - Add packed client setup instructions - Add *config.ini setup instructions - Describe what configs should be modified and what you may want to change - More detail in the verify step - Change Account Manager link to Nexus Dashboard - Remove table of commands and reference Commands.md instead - Specify that UGCSERVERIP may need to be changed to localhost as well * Fix Avant Gardens Survival This addresses the Avant Gardens Survival bug. Squeezing it in with the README changes since it is a small change. * Remove Locale * Update README.md Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> * Remove dLocale again? * Saving for the night * Revert "Fix Avant Gardens Survival" This reverts commit b1a1ce2d84e870c328a039673c9b77859e6e3dbd. * Update Mission.cpp * Update README.md Move comments and add pre-processor define Update README.md Update README.md Update CMakePresets.json Update CMakeVariables.txt Update README.md i love readmes Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md * Update README.md Co-authored-by: Daniel Seiler <me@xiphoseer.de> * Address feedback * Update README.md * Update Database.cpp * Update README.md * Revert tcp specification Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> Co-authored-by: Aaron Kimbrell <aronwk.aaron@gmail.com> Co-authored-by: Daniel Seiler <me@xiphoseer.de>
2022-12-28 21:58:53 +00:00
While a character has a gmlevel of anything but `0`, some gameplay behavior will change. When testing gameplay, you should always use a character with a gmlevel of `0`.
2021-12-05 17:40:43 +00:00
Update README (#806) * Update README The README is very out of date, the following changes have been made - Update what the file tree should look like - Remove client Avant Gardens Survival script fix - Update some incorrect commands or commands that were missing packages. - Add packed client setup instructions - Add *config.ini setup instructions - Describe what configs should be modified and what you may want to change - More detail in the verify step - Change Account Manager link to Nexus Dashboard - Remove table of commands and reference Commands.md instead - Specify that UGCSERVERIP may need to be changed to localhost as well * Fix Avant Gardens Survival This addresses the Avant Gardens Survival bug. Squeezing it in with the README changes since it is a small change. * Remove Locale * Update README.md Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> * Remove dLocale again? * Saving for the night * Revert "Fix Avant Gardens Survival" This reverts commit b1a1ce2d84e870c328a039673c9b77859e6e3dbd. * Update Mission.cpp * Update README.md Move comments and add pre-processor define Update README.md Update README.md Update CMakePresets.json Update CMakeVariables.txt Update README.md i love readmes Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md * Update README.md Co-authored-by: Daniel Seiler <me@xiphoseer.de> * Address feedback * Update README.md * Update Database.cpp * Update README.md * Revert tcp specification Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> Co-authored-by: Aaron Kimbrell <aronwk.aaron@gmail.com> Co-authored-by: Daniel Seiler <me@xiphoseer.de>
2022-12-28 21:58:53 +00:00
# User guide
Some changes to the client `boot.cfg` file are needed to play on your server.
2021-12-05 17:40:43 +00:00
Update README (#806) * Update README The README is very out of date, the following changes have been made - Update what the file tree should look like - Remove client Avant Gardens Survival script fix - Update some incorrect commands or commands that were missing packages. - Add packed client setup instructions - Add *config.ini setup instructions - Describe what configs should be modified and what you may want to change - More detail in the verify step - Change Account Manager link to Nexus Dashboard - Remove table of commands and reference Commands.md instead - Specify that UGCSERVERIP may need to be changed to localhost as well * Fix Avant Gardens Survival This addresses the Avant Gardens Survival bug. Squeezing it in with the README changes since it is a small change. * Remove Locale * Update README.md Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> * Remove dLocale again? * Saving for the night * Revert "Fix Avant Gardens Survival" This reverts commit b1a1ce2d84e870c328a039673c9b77859e6e3dbd. * Update Mission.cpp * Update README.md Move comments and add pre-processor define Update README.md Update README.md Update CMakePresets.json Update CMakeVariables.txt Update README.md i love readmes Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md * Update README.md Co-authored-by: Daniel Seiler <me@xiphoseer.de> * Address feedback * Update README.md * Update Database.cpp * Update README.md * Revert tcp specification Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> Co-authored-by: Aaron Kimbrell <aronwk.aaron@gmail.com> Co-authored-by: Daniel Seiler <me@xiphoseer.de>
2022-12-28 21:58:53 +00:00
## Allowing a user to connect to your server
2021-12-05 17:40:43 +00:00
To connect to a server follow these steps:
* In the client directory, locate `boot.cfg`
* Open it in a text editor and locate where it says `AUTHSERVERIP=0:`
* Replace the contents after to `:` and the following `,` with what you configured as the server's public facing IP. For example `AUTHSERVERIP=0:localhost` for locally hosted servers
* Next locate the line `UGCUSE3DSERVICES=7:`
* Ensure the number after the 7 is a `0`
2021-12-05 17:40:43 +00:00
* Launch `legouniverse.exe`, through `wine` if on a Unix-like operating system
* Note that if you are on WSL2, you will need to configure the public IP in the server and client to be the IP of the WSL2 instance and not localhost, which can be found by running `ifconfig` in the terminal. Windows defaults to WSL1, so this will not apply to most users.
2021-12-05 17:40:43 +00:00
Update README (#806) * Update README The README is very out of date, the following changes have been made - Update what the file tree should look like - Remove client Avant Gardens Survival script fix - Update some incorrect commands or commands that were missing packages. - Add packed client setup instructions - Add *config.ini setup instructions - Describe what configs should be modified and what you may want to change - More detail in the verify step - Change Account Manager link to Nexus Dashboard - Remove table of commands and reference Commands.md instead - Specify that UGCSERVERIP may need to be changed to localhost as well * Fix Avant Gardens Survival This addresses the Avant Gardens Survival bug. Squeezing it in with the README changes since it is a small change. * Remove Locale * Update README.md Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> * Remove dLocale again? * Saving for the night * Revert "Fix Avant Gardens Survival" This reverts commit b1a1ce2d84e870c328a039673c9b77859e6e3dbd. * Update Mission.cpp * Update README.md Move comments and add pre-processor define Update README.md Update README.md Update CMakePresets.json Update CMakeVariables.txt Update README.md i love readmes Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md * Update README.md Co-authored-by: Daniel Seiler <me@xiphoseer.de> * Address feedback * Update README.md * Update Database.cpp * Update README.md * Revert tcp specification Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> Co-authored-by: Aaron Kimbrell <aronwk.aaron@gmail.com> Co-authored-by: Daniel Seiler <me@xiphoseer.de>
2022-12-28 21:58:53 +00:00
## Updating your server
To update your server to the latest version navigate to your cloned directory
```bash
cd path/to/DarkflameServer
```
Run the following commands to update to the latest changes
```bash
git pull
git submodule update --init --recursive
```
Now follow the [build](#build-the-server) section for your system and your server is up to date.
## In-game commands
* A list of all in-game commands can be found [here](./docs/Commands.md).
## Verifying your client files
### LEGO® Universe 1.10.64
To verify that you are indeed using a LEGO® Universe 1.10.64 client, make sure you have the full client compressed **in a rar file** and run the following command.
```bash
# Replace <file> with the file path to the zipped client
# If on Linux or MacOS
shasum -a 256 <file>
# If on Windows using the Command Prompt
certutil -hashfile <file> SHA256
```
Below are known good SHA256 checksums of the client:
* `8f6c7e84eca3bab93232132a88c4ae6f8367227d7eafeaa0ef9c40e86c14edf5` (packed client, rar compressed)
* `c1531bf9401426042e8bab2de04ba1b723042dc01d9907c2635033d417de9e05` (packed client, includes extra locales, rar compressed)
* `0d862f71eedcadc4494c4358261669721b40b2131101cbd6ef476c5a6ec6775b` (unpacked client, includes extra locales, rar compressed)
If the returned hash matches one of the lines above then you can continue with setting up the server. If you are using a fully downloaded and complete client from live, then it will work, but the hash above may not match. Otherwise you must obtain a full install of LEGO® Universe 1.10.64.
You must also make absolutely sure your LEGO Universe client is not in a Windows OneDrive. DLU is not and will not support a client being stored in a OneDrive, so ensure you have moved the client outside of that location.
Update README (#806) * Update README The README is very out of date, the following changes have been made - Update what the file tree should look like - Remove client Avant Gardens Survival script fix - Update some incorrect commands or commands that were missing packages. - Add packed client setup instructions - Add *config.ini setup instructions - Describe what configs should be modified and what you may want to change - More detail in the verify step - Change Account Manager link to Nexus Dashboard - Remove table of commands and reference Commands.md instead - Specify that UGCSERVERIP may need to be changed to localhost as well * Fix Avant Gardens Survival This addresses the Avant Gardens Survival bug. Squeezing it in with the README changes since it is a small change. * Remove Locale * Update README.md Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> * Remove dLocale again? * Saving for the night * Revert "Fix Avant Gardens Survival" This reverts commit b1a1ce2d84e870c328a039673c9b77859e6e3dbd. * Update Mission.cpp * Update README.md Move comments and add pre-processor define Update README.md Update README.md Update CMakePresets.json Update CMakeVariables.txt Update README.md i love readmes Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md * Update README.md Co-authored-by: Daniel Seiler <me@xiphoseer.de> * Address feedback * Update README.md * Update Database.cpp * Update README.md * Revert tcp specification Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> Co-authored-by: Aaron Kimbrell <aronwk.aaron@gmail.com> Co-authored-by: Daniel Seiler <me@xiphoseer.de>
2022-12-28 21:58:53 +00:00
### Darkflame Universe Client
Darkflame Universe clients identify themselves using a higher version number than the regular live clients out there.
This was done make sure that older and incomplete clients wouldn't produce false positive bug reports for us, and because we made bug fixes and new content for the client.
To verify that you are indeed using a Darkflame Universe client, make sure you have the full client compressed **in a zip file** and run the following command.
```bash
# Replace <file> with the file path to the zipped client
# If on Linux or MacOS
shasum -a 1 <file>
# If on Windows using the Command Prompt
certutil -hashfile <file> SHA1
```
Known good *SHA1* checksum of the Darkflame Universe client:
- `91498e09b83ce69f46baf9e521d48f23fe502985` (packed client, zip compressed)
# Docker
The Darkflame Server is automatically built and published as a Docker Container / [OCI](https://opencontainers.org/) Image to the GitHub Container Registry at:
[`ghcr.io/darkflameuniverse/darkflameserver`](https://github.com/DarkflameUniverse/DarkflameServer/pkgs/container/darkflameserver).
## Compose
> [!WARNING]
> It seems that Docker Desktop on Windows with the WSL 2 backend has some issues with MariaDB (c.f. [mariadb-docker#331](https://github.com/MariaDB/mariadb-docker/issues/331)) triggered by NexusDashboard
> migrations, so this setup may not work for you. If that is the case, please tell us about your setup in [NexusDashboard#92](https://github.com/DarkflameUniverse/NexusDashboard/issues/92).
You can use the `docker-compose` tool to [setup a MariaDB database](#database-setup), run the Darkflame Server and manage it with [Nexus Dashboard](https://github.com/DarkflameUniverse/NexusDashboard) all
at once. For that:
- [Install Docker Desktop](https://docs.docker.com/get-docker/)
- Open the directory that contains your LU Client
- If the `legouniverse.exe` is in a subfolder called `client`, you're good to go. There may also be a folder `versions`.
- Otherwise, create a new `client` folder and move the exe and everything else (e.g. `res` and `locale`) in there. This is necessary to work around a bug in the client that will prevent that you to log back in after getting disconnected.
- Download the [docker-compose.yml](docker-compose.yml) file and place it next to `client`.
- Download the [.env.example](.env.example) file and place it next to `client` with the file name `.env`
- You may get warnings that this name starts with a dot, acknowledge those, this is intentional. Depending on your operating system, you may need to activate showing hidden files (e.g. Ctrl-H in Gnome on Linux) and/or file extensions ("File name extensions" in the "View" tab on Windows).
- Update the `ACCOUNT_MANAGER_SECRET` and `MARIADB_PASSWORD` with strong random passwords.
- Use a password generator like <https://keygen.io>
- Avoid `:` and `@` characters
- Once the database user is created, changing the password will not update it, so the server will just fail to connect.
- Set `EXTERNAL_IP` to your LAN IP or public IP if you want to host the game for friends & family
- Open a terminal in the folder with the `docker-compose.yml` and `client`
- Run `docker compose up -d`
- This might require `sudo` on Linux, and a recent version of [docker compose](https://docs.docker.com/compose/install/)
- Run `docker exec -it dlu-darkflameserver-1 /app/MasterServer -a` and follow the instructions to create the initial admin account
- Open <http://localhost:8000> to access Nexus Dashboard with the admin account to create normal users
- Set `AUTHSERVERIP=0:localhost` in `client/boot.cfg`
- Replace `localhost` with the value of `EXTERNAL_IP` if you changed that earlier.
- Also make sure `UGCUSE3DSERVICES=7:` is set to `0`
- Launch `legouniverse.exe`
## Standalone
This assumes that you have a database deployed to your host or in another docker container.
A basic deployment of this contianer would look like:
```sh
# example docker contianer deployment
docker run -it \
-v /path/to/configs/:/app/configs \
-v /path/to/logs/:/app/logs \
-v /path/to/dumps/:/app/dumps \
-v /path/to/res:/app/res:ro \
-v /path/to/resServer:/app/resServer \
-e DUMP_FOLDER=/app/dumps \
-p 1001:1001/udp \
-p 2005:2005/udp \
-p 3000-3300:3000-3300/udp \
ghcr.io/darkflameuniverse/darkflameserver:latest
```
You will need to replace the `/path/to/`'s to reflect the paths on your host.
Any config option in the `.ini`'s can be overridden with environmental variables: Ex: `log_to_console=1` from `shared_config.ini` would be overidden like `-e LOG_TO_CONSOLE=0`
Update README (#806) * Update README The README is very out of date, the following changes have been made - Update what the file tree should look like - Remove client Avant Gardens Survival script fix - Update some incorrect commands or commands that were missing packages. - Add packed client setup instructions - Add *config.ini setup instructions - Describe what configs should be modified and what you may want to change - More detail in the verify step - Change Account Manager link to Nexus Dashboard - Remove table of commands and reference Commands.md instead - Specify that UGCSERVERIP may need to be changed to localhost as well * Fix Avant Gardens Survival This addresses the Avant Gardens Survival bug. Squeezing it in with the README changes since it is a small change. * Remove Locale * Update README.md Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> * Remove dLocale again? * Saving for the night * Revert "Fix Avant Gardens Survival" This reverts commit b1a1ce2d84e870c328a039673c9b77859e6e3dbd. * Update Mission.cpp * Update README.md Move comments and add pre-processor define Update README.md Update README.md Update CMakePresets.json Update CMakeVariables.txt Update README.md i love readmes Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md * Update README.md Co-authored-by: Daniel Seiler <me@xiphoseer.de> * Address feedback * Update README.md * Update Database.cpp * Update README.md * Revert tcp specification Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> Co-authored-by: Aaron Kimbrell <aronwk.aaron@gmail.com> Co-authored-by: Daniel Seiler <me@xiphoseer.de>
2022-12-28 21:58:53 +00:00
# Development Documentation
This is a Work in Progress, but below are some quick links to documentaion for systems and structs in the server
[Networked message structs](https://lcdruniverse.org/lu_packets/lu_packets/index.html)
[General system documentation](https://docs.lu-dev.net/en/latest/index.html)
2021-12-05 17:40:43 +00:00
# Credits
Update README (#806) * Update README The README is very out of date, the following changes have been made - Update what the file tree should look like - Remove client Avant Gardens Survival script fix - Update some incorrect commands or commands that were missing packages. - Add packed client setup instructions - Add *config.ini setup instructions - Describe what configs should be modified and what you may want to change - More detail in the verify step - Change Account Manager link to Nexus Dashboard - Remove table of commands and reference Commands.md instead - Specify that UGCSERVERIP may need to be changed to localhost as well * Fix Avant Gardens Survival This addresses the Avant Gardens Survival bug. Squeezing it in with the README changes since it is a small change. * Remove Locale * Update README.md Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> * Remove dLocale again? * Saving for the night * Revert "Fix Avant Gardens Survival" This reverts commit b1a1ce2d84e870c328a039673c9b77859e6e3dbd. * Update Mission.cpp * Update README.md Move comments and add pre-processor define Update README.md Update README.md Update CMakePresets.json Update CMakeVariables.txt Update README.md i love readmes Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md Update README.md * Update README.md Co-authored-by: Daniel Seiler <me@xiphoseer.de> * Address feedback * Update README.md * Update Database.cpp * Update README.md * Revert tcp specification Co-authored-by: Jonathan Romano <jonathan@luxaritas.com> Co-authored-by: Aaron Kimbrell <aronwk.aaron@gmail.com> Co-authored-by: Daniel Seiler <me@xiphoseer.de>
2022-12-28 21:58:53 +00:00
2022-06-22 07:57:36 +00:00
## DLU Team
2022-06-21 23:04:45 +00:00
* [DarwinAnim8or](https://github.com/DarwinAnim8or)
2022-06-21 08:03:31 +00:00
* [Wincent01](https://github.com/Wincent01)
* [Mick](https://github.com/MickVermeulen)
* [averysumner](https://github.com/codeshaunted)
* [Jon002](https://github.com/jaller200)
* [Jonny](https://github.com/cuzitsjonny)
* [Aaron K.](https://github.com/aronwk-aaron)
2021-12-05 17:40:43 +00:00
### Research and Tools
2022-06-21 08:03:31 +00:00
* [lcdr](https://github.com/lcdr)
* [Xiphoseer](https://github.com/Xiphoseer)
2021-12-05 17:40:43 +00:00
### Community Management
2022-06-21 08:03:31 +00:00
* [Neal](https://github.com/NealSpellman)
2021-12-05 17:40:43 +00:00
### Logo
* Cole Peterson (BlasterBuilder)
## Active Contributors
* [EmosewaMC](https://github.com/EmosewaMC)
* [Jettford](https://github.com/Jettford)
## Former Contributors
2022-06-21 23:35:24 +00:00
* TheMachine
* Matthew
2023-07-01 22:40:34 +00:00
* [Raine](https://github.com/uwainium)
2022-06-21 23:35:24 +00:00
* Bricknave
## Special Thanks
2021-12-05 17:40:43 +00:00
* humanoid24
* pwjones1969
* [Simon](https://github.com/SimonNitzsche)
* [ALL OF THE NETDEVIL AND LEGO TEAMS!](https://www.mobygames.com/game/macintosh/lego-universe/credits)