This article is part of the Installation Guide. You can read it alone or click on the previous link to easily move between the steps.

<< Step 1: Requirements

Step 3: Database Installation >>

TrinityCore requires gcc 4.7 or higher and SSE2 capable processor. Check your distribution to ensure you have the correct version of gcc available.

[L]Getting started

This how-to will attempt to help with TrinityCore, and also show how this can be done in a way that also shows you the basics of how linux compilations works.

Most of this how-to is based on the use of a Debian based distribution, though we'll try to inform as best as we can when something differs totally.

Advices:

  • Read your distributions' documentation on how to install packages, and also have at least knowledge on how it works with regards to adding users.*
  • Run/install TrinityCore on a dedicated machine, or a machine that you know you have full control over.
  • Do NOT install the software on a shared server solution or any server where other users may have access or might require resources to be available at all times.

Your server may be abruptly killed by an angry administrator or system staff for overuse of system resources.

[L]Creating a user to work with

Start with logging in to your Linux-machine and create an account for the server itself - on most recent distributions this can easily be done with the following command :

sudo adduser <username>

Note : Change <username> into the preferred username of your server-account - we will as far as possible avoid using specific usernames in this how-to.

[L]Required software

See Requirements

[L]Optional software

These tools are only needed or useful if you are connecting from a Windows host to your Linux machine

Graphical database-viewing/editing

Please note that the software called Navicat is NOT supported due to issues with how it handles SQL-files with "/* */"-style comments. We advise all users to stay well clear of this program unless they really are looking for issues.

Remote console connects to the server

File transfer through SFTP or FTP

Contents

[L]Building the server itself

[L]Getting the source code

cd ~/
git clone -b 3.3.5 git://github.com/TrinityCore/TrinityCore.git 

This will clone 3.3.5a branch, this is the RECOMMENDED branch for starters.

cd ~/
git clone -b 6.x git://github.com/TrinityCore/TrinityCore.git 

This will clone 6.x branch, note that this is NOT the recommended branch for starters.

A directory trinitycore will be created automatically and all the source files will be stored in there.

FreeBSD users will need to apply the patch located  here  for g3d to compile properly, before doing anything else.

[L]Compiling the source code

Creating the build-directory

To avoid issues with updates and colliding source builds, we create a specific build-directory, so we avoid any possible issues due to that (if any might occur)

cd TrinityCore
mkdir build
cd build

Configuring for compiling

To configure the core, we use space-separated parameters attached to the configuration-tool (cmake) - do read the entire section before even starting on the configuration-part.
This is for your own good, and you HAVE been warned. A full example will also be shown underneath the explanations.

cmake ../ [additional parameters]

Parameter explanations

path to your OpenSSL library - do not use if you have OpenSSL installed system wide:

-DOPENSSL_LIBRARIES=<path to OpenSSL library>

path to your OpenSSL includes directory - do not use if you have OpenSSL installed system wide:

-DOPENSSL_INCLUDE_DIR=<path to OpenSSL includes>

-DSERVERS Build worldserver and authserver

-DSCRIPTS Build core with scripts included (enabled by default)
-DTOOLS Build map/vmap extraction/assembler tools -DTOOLS=1 (will include tools)
-DUSE_SCRIPTPCH Use precompiled headers when compiling scripts
-DUSE_COREPCH Use precompiled headers when compiling servers
-DWITH_WARNINGS Show all warnings during compile
-DWITH_COREDEBUG Include additional debug-code in core
-DPREFIX Set installation directory
-DCONF_DIR Set configuration directory
-DLIBSDIR Set library directory
-DCMAKE_C_FLAGS Set C_FLAGS for compile (advanced users only)
-DCMAKE_CXX_FLAGS Set CXX_FLAGS for compile (advanced users only)

Note : * means "used by default", and does not need to be set.

The above parameters when combined into a full example :

cmake ../ -DPREFIX=/home/<username>/server -DWITH_WARNINGS=1

Another Example Below: 
cmake ../ -DPREFIX=/home/wow/server -DCONF_DIR=/home/wow/server/etc -DLIBSDIR=/home/wow/server/lib -DTOOLS=1 -DWITH_WARNINGS=1

The above build the tools, set installation base directory to /home/<username>/server and show all warnings during compile.

Note that you WILL have to configure the server well if you ever want to use the RA-access functionality.

Building the core

After configuring and checking that everything is in order (read cmakes output), you can build Trinity (this will take some time unless you are on a rather fast machine)

make
make install

If you have multiple CPU cores, you can enable the use of those during compile :

make -j <number of cores>
make install 

After compiling and installing, you will find your core binaries in /home/<username>/server/bin, and the standard configuration files in the /home/<username>/server/etc folder.
(As usual, replace <username> with the username you created earlier). Now you can continue reading on and learn how how to update the source tree.

Keeping the code up to date

TrinityCore developers are always at work fixing and adding new features to the core. You can always check them here. To update the core files, do the following :

cd ~/TrinityCore/
git pull origin master

Now return to the compilation-section again, and repeat the instructions there.

[L]Installing libMPQ (MoPaQ) MPQ-reader library

Installation of the libMPQ library is only required if you want to extract the data files, and/or compile the tools.
Do note that the library has been hard-linked to the binary in later revisions, and is not "enforced" unless the tools are required.

Configuring, compiling and installing libMPQ

IMPORTANT : If you are the owner of the machine, and at this stage want the MPQ-library to be available for other users on your Linux-machine (and also making it easier for yourself at later stages), please follow  <i>alternative 2</i>

Change directory to ~/TrinityCore/dep/libmpq/ before doing this

Alternative 1 : Local installation

sh ./autogen.sh
./configure --prefix=/home/<username>/.sys/
make
make install

Again, replace <username> with the username you chose when creating the account.

Alternative 2 : System wide installation

sh ./autogen.sh
./configure
make
sudo make install

As stated above, alternative 2 will build the library as a user without any specific privileges, and then install it into /usr/local as root (the superuser), reachable for other users that wish to use it for their own projects.
It is safe to allow this library to be installed system wide.

[L]Installing MySQL Server

When configuring MySQL make sure you remember the password you set for the default root account and that you enabled both MyISAM and InnoDB engines.

You can leave all the other settings as default. You might want to enable remote access to your MySQL server if your are also testing a website for your Trinity server or if you have friends testing with you which need access from remote. Remember that this will decrease the security level of your MySQL server!

SPECIAL NOTES!

Things to notice :

-DSSLLIB=<path> has been deprecated and is not used at all (remove this if ever used before)
-DWITH_COREDEBUG=0 not required, as its default is : 0

The new method for custom SSL-libraries are:

-DOPENSSL_LIBRARIES=<path to OpenSSL libraries directory>
-DOPENSSL_INCLUDE_DIR=<path to OpenSSL br /includes directory>

The paths for installation can be done without any other parameters but this :

-DPREFIX=/path/to/where/you/want/core/to/be/installed

It will create the following structure:

<path>/bin/ - binaries will be placed here
<path>/etc/ - config files will be placed here

Also, compile has been tested on Debian 7.4 x32/x64, 8 x32/x64, Ubuntu 13.10 x64, Fedora Core 19 x64 - all without problems IF YOU DO NOT MESS AROUND ON YOUR OWN!

[M]Getting started

This guide describes how to get TrinityCore running on Mac OS X. Mac OS X ships with several libraries including OpenSSL and a special version of Readline - both required by TrinityCore. But: They are useless. OpenSSL is too old and Readline is... well... special. So we have to build the right ones. This is fairly easy and by doing this on your own (using programs like MacPorts or Homebrew is the alternative) you may learn more about libraries, your Mac and its handling on a non-graphic way. But no matter what you're doing in this guide there is one rule you should remind and never ever break:

DO NOT INSTALL ANYTHING YOU BUILD IN THIS GUIDE TO A SYSTEM-RELEVANT PATH! Rather use a path in your home directory.

 

We're going to put all the TrinityCore stuff to your home directory in the next step, even the installed binaries. We need to tell TrinityCore where its libraries are installed to.
Further I guess you simply want to type "cmake" or "mysql" instead of "/Users/<Username>/Trinity/bin/cmake" or "/usr/local/mysql/bin/mysql".
So we gonna set up a profile file which extends the default PATH and DYLD_LIBRARY_PATH variable and create a folder for the TrinityCore stuff:

mkdir ~/Trinity
nano ~/.profile

 

Add the following lines:

export TRINITY=/Users/<Username>/Trinity
export PATH=$PATH:$TRINITY/bin:/usr/local/mysql/bin
export DYLD_LIBRARY_PATH=$DYLD_LIBRARY_PATH:$TRINITY/lib:/usr/local/mysql/lib

Press Ctrl+O followed by Ctrl+X to save and close the file. Done. Quit the terminal application and restart it.

There is also an autocompletion script for git which can be downloaded and included here.

curl -o ~/.gitcompletion "https://raw.githubusercontent.com/git/git/master/contrib/completion/git-completion.bash"
nano ~/.profile

Add the following line:

source ~/.gitcompletion

 

Press Ctrl+O followed by Ctrl+X to save and close the file. Done. Quit the terminal application and restart it.

Contents

[M]Building the libraries

Open a terminal and change to your download folder. Safari automatically extracts .gz archives and leaves the tar ball.

[M]OpenSSL

tar xvf openssl-1.0.1j.tar
cd openssl-1.0.1j
./Configure darwin64-x86_64-cc shared --prefix=$TRINITY
make -j 2
make install
cd ..

 

[M]Readline

tar xvf readline-6.3.tar
cd readline-6.3
./configure --prefix=$TRINITY
make -j 2
make install
cd ..

 

[M]CMake

tar xvf cmake-3.0.2.tar
cd cmake-3.0.2
./bootstrap --prefix=$TRINITY
make -j 2
make install
cd .. 

 

 

[M]Boost

 tar xvf boost_1_57_0.tar
cd boost_1_57_0
./bootstrap.sh --with-libraries=system,thread,program_options,filesystem --prefix=$TRINITY
./b2 -j2
./b2 install
cd ..
 

[M]ZeroMQ

tar xvf zeromq-4.0.5.tar
cd zeromq-4.0.5
./configure --prefix=$TRINITY
make -j 2
make install
cd ..

 

 

[M]Installing TrinityCore

You successfully installed all the dependencies. Now it's time to install the server.

[M]Obtaining the source and preparing the build

cd $TRINITY
git clone -b 3.3.5 https://github.com/TrinityCore/TrinityCore.git repo
mkdir build
cd build

This will clone 3.3.5a branch, this is the RECOMMENDED branch for starters.

cd $TRINITY
git clone -b 6.x https://github.com/TrinityCore/TrinityCore.git repo
mkdir build
cd build

This will clone 6.x branch, note that this is NOT the recommended branch for starters.

 

Generate the Xcode project files using CMake:

cmake $TRINITY/repo -G "Xcode" \
-DMYSQL_ADD_INCLUDE_PATH=/usr/local/mysql/include \
-DMYSQL_LIBRARY=/usr/local/mysql/lib/libmysqlclient.dylib \
-DREADLINE_INCLUDE_DIR=$TRINITY/include \
-DREADLINE_LIBRARY=$TRINITY/lib/libreadline.dylib \
-DBOOST_INCLUDEDIR=$TRINITY/include \
-DBOOST_LIBRARYDIR=$TRINITY/lib \
-DOPENSSL_SSL_LIBRARIES=$TRINITY/lib/libssl.dylib \
-DOPENSSL_CRYPTO_LIBRARIES=$TRINITY/lib/libcrypto.dylib \
-DOPENSSL_INCLUDE_DIR=$TRINITY/include \
-DZMQ_LIBRARY=$TRINITY/lib/libzmq.dylib \
-DZMQ_INCLUDE_DIR=$TRINITY/include \
-DPREFIX=$TRINITY \
-DWITH_WARNINGS=1

[M]Building the binaries

This step may take a while and needs to be done every time the source code changes. Afterwards you'll find the binaries in "/Users/<Username>/Trinity/bin"

Terminal

xcodebuild -config Debug -jobs 2
xcodebuild -config Debug -target install

 

 

"Debug" can be replaced by "Release"  or "RelWithDebInfo"

Xcode

Open the generated "TrinityCore.xcodeproj" and select "Product" -> "Build" for a Debug build or "Product" ->"Archive" for a Release build. Do not forget to select "install" as compilation target.

[M]Keeping the code up to date

cd $TRINITY/repo
git reset --hard HEAD
git pull

 

Repeat the steps described in "Building the binaries".

[M]Setting up the server

... this part needs to be re-written. Coming soon!

 

 

 

 

 

[W]Getting started

Before you get scared by this long guide, we assure you the procedure is quite simple. Most of the following steps are to be performed only the first time you install Trinity and only the Trinity updating procedures will need to be run from time to time.

[W]Required Software

See Requirements

[W]Pulling & Compiling the Source

Pulling the Source

  1. Create a directory in which Core files will be pulled (for example: C:\Trinity).
  2. Right-click on the directory and click on Git Extensions -> Clone.
  3. Fill in the data as follows:

 

Repository to clone: https://github.com/TrinityCore/TrinityCore
Destination: C:\Trinity
Subdirectory to create: <none>
Branch: 3.3.5
Personal Repository: Yes

This will clone 3.3.5a branch, this is the RECOMMENDED branch for starters.

Repository to clone: https://github.com/TrinityCore/TrinityCore
Destination: C:\Trinity
Subdirectory to create: <none>
Branch: 6.x
Personal Repository: Yes

This will clone 6.x branch, note that this is NOT the recommended branch for starters.

Click Clone. Within a few minutes all of the TrinityCore source files will be pulled into the directory C:\Trinity.


Contents

Configuring and generating Visual C++ solutions with CMake

Before you begin, create an empty directory called Build. In this example, we will use D:\Build.

Note: If CMake do not recognize C/C++ compiler, choose Specific Native Compiler, and choose path to target vcvarsall.bat, e.g. C:\Program Files\Microsoft Visual Studio 12.0\VC\vcvarsall.bat

Click Browse Source... -> Select 
the source directory (C:/Trinity)

2. Click  Browse Build...  -> Select
the build directory (D:/Build)

3. Click Configure

4. Make sure  Use default native
compilers  is checked

5. In the drop-down menu, choose the
version of the compiler you downloaded
in the Software Required section .

6. Click Finish.

7. Make sure Tools is checked. This will
compile the map extractors needed later
in the setup. 

8. Click Configure again.

9. Click Generate. This will install the
selected build files into your D:/Build folder.

Note: If MySQL is not found by CMake it is required to set MYSQL_INCLUDE_DIR = C:/mysql_libs/include and MYSQL_LIBRARY= C:/mysql_libs/lib_XX/libmysql.lib.
XX depends if you are compiling in 32 or 64 bits mode. (See the 9th point of the Windows requirement list in Requirements.)

Note 2: If you get linker errors (e.g "error LNK2019: unresolved external symbol mysql_server_init"), make sure MYSQL_LIBRARY is set to the libmysql.lib that matches your compile mode (x64 vs 32 bits).

(If you do not see the MYSQL fields in CMake, tick the Advanced box).

Compiling the Source

Browse into your D:\Build folder and open TrinityCore.sln with Visual C++ Community.

On the menu at the top, click Build and select Configuration Manager.

Set Active Solution Configuration to Release

In the list menus below "Help", set Active Solution Platform to Win32 (if you set 64-bit compilation during the CMake configuration, select Win64)
click Close (settings get saved instantly).

Right-click ALL_BUILD in the Solution Explorer on the left sidebar and select Clean.
(on some VS2013 versions, click the Build menu and select  Clean  Solution.)

Right-click ALL_BUILD and select Build.

  1. Compilation length differs from machine to machine, you should expect it to take 5-30 minutes.
  2. If you are asked to "Reload build files" during the compile, do so.
  3. When the build is complete, you will find a message similar to the one below (the numbers may be different).
========== Build: 22 succeeded, 0 failed, 0 up-to-date, 0 skipped ==========

 

You will find your freshly compiled binaries in the C:\Build\bin\Release or C:\Build\bin\Debug folder. These are all used to run your server at the end of this instruction.

You will need the following files in order for the core to function properly:

libeay32.dll
libmySQL.dll
ssleay32.dll
worldserver.conf.dist
worldserver.exe
authserver.conf.dist
authserver.exe

There are a few DLLs that needs to be manually added to this folder, and you need to copy them over from the following installation/bin directories:

libmySQL.dll - C:\Program Files\MySQL\MySQL Server 5.x\lib
libeay32.dll, ssleay32.dll - C:\OpenSSL-Win32\bin

libzmq-v120-mt-4_0_4.dll - C:\Program Files\ZeroMQ 4.0.4\bin

[W]Keeping the Source Up-to-Date

TrinityCore Developers are always at work fixing and adding new features to the core. You can always check them here, or by viewing them from within Git Extensions.

Open your TrinityCore repository in GitExtensions.

  1. Click on the blue arrow
  2. In the new window, click Pull.

This will sync your local repo to the latest commits from the branch you have setup as default.

Now you will need to re-run CMake Configure & Generate to update your SLN files.

Compile

??

Profit!!

 

 

 

 

Help

If you still have any problem, check:

 

This article is part of the Installation Guide. You can read it alone or click on the previous link to easily move between the steps.

<< Step 1: Requirements

Step 3: Database Installation >>