AzerothCore
Posts (Latest 10 updated) :
Read all
Contents:
  1. how to start the services
  2. how to configure a restarter
    1. Restarter using acore dashboard (only for bash)
    2. Using docker (crossplatform)
    3. Advanced restarter (only for bash)
    4. Manual way (crossplatform)

AzerothCore is composed by 2 services: authserver and worldserver. Authserver only acts as an authenticator and a router for your realms redirecting your authorized client connections to the selected realm address. the Worldserver instead handles all connections related to the game mechanics and it's the single source of truth for everything related to a single realm.

Authserver and Worldservers can be placed to different environment, however, in the following guide we will explain you how to run them together on same environment.

how to start the services

both authserver and worldserver can be started by simply run the compiled binaries after completing the installation.

how to configure a restarter

Restarting and debugging an application works in many different way depending on your operating system. That's why we always suggest to use our docker solution that is fully supported on all platforms.

However, if you need to keep your server up and running after a crash and checking what's going on with your code, you can do it using a restarter and a debugger.

Below are going to explain how to use our integrated restarter scripts and the GDB debugger utility also to generate crash-dumps

Restarter using acore dashboard (only for bash)

You can use ./acore.sh run-worldserver and ./acore.sh run-authserver

They both work out of the box when you compile with the dashboard.

NOTE: To enable GDB you can use AC_RESTARTER_WITHGDB=true as an environment variable or by adding this to your /conf/config.sh file. After enabled GDB, if the server crashes, you will find the crashdump file (gdb.txt) within the /env/ folder. Keep in mind that you should compile your code with one of the following compilation types: Debug or RelWithDebInfo, otherwise GDB won't work properly

Using docker (crossplatform)

Our docker system integrates the scripts above within the docker-compose. It means that enabling the GDB works exactly in the same way in docker too. Moreover our docker-compose uses the restart-policy feature to keep the containers up and running.

For more information please refer to the Install-with-Docker documentation. You will also find a guide on how to debug your code by using VSCode combined with its Remote Docker extension.

Advanced restarter (only for bash)

For more advanced restarters that include several other useful configurations, you can try our "run-engine" system written in bash.

Here you can find the restarters for linux/bash environments: https://github.com/azerothcore/azerothcore-wotlk/tree/master/apps/startup-scripts

Those scripts are automatically copied after the compilation to the /dist directory if you're using our ./acore.sh dashboard

You can copy the conf.sh.dist and create a conf-world.sh file to customize those documented configurations (do the same for the conf-auth.sh). In this way, you have both restarter and gdb pre-configured to create a gdb.txt (crashdump) file when the core crashes. Make sure to use RelWithDebInfo or Debug compilation (in your CMake command) in order to get meaningful crash reports.

Then copy the restarter-world.sh and the restarter-auth.sh from the "examples" beside your conf file and in the same folder of the "run-engine" file.

Eventually you will have something like this:

example

Run those 2 restarter script to have both authserver and worldserver restarters with gdb support.

Manual way (crossplatform)

Always make sure to use RelWithDebInfo or Debug compilation (in your CMake command) in order to get meaningful crash reports.

Create a file called gdb.conf with this inside:

set logging on
set debug timestamp
run -c ../etc/worldserver.conf
bt

Then, to debug or create a crashdump you can just use the gdb command as described in its documentation:

gdb -x gdb.conf --batch ./worldserver

This command should be enough to both attach your IDE to debug your code and also generate a crashdump when the server crashes

For an "universal" and more advanced restarter, Personally I'm using PM2

pm2 start "gdb -x gdb.conf --batch ./worldserver"

It should be enough to automatically restart, monitoring and gdb your server