Requirements

• Xcode Setup
• Homebrew Setup
• Dependencies Setup
• MySQL Environment Setup
• How to update MySQL
• Getting the Files
• Compiling
• DBC and Map files
• Logon Database
• World Database
• Configuration Files
• Create an Account

macOS Guide

Please note: this guide is intended for the installation and configuration of macOS on systems with Intel processors.

Xcode Setup

Xcode is available from the App Store for free. Run the following command from the terminal to install the required command line tools:

xcode-select --install

Homebrew Setup

Homebrew — The Package Manager for macOS.

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

Dependencies Setup

brew update
brew install mysql openssl cmake unzip
brew config

Alternative GUI installation: MySQL, CMake.

MySQL Environment Setup

1. The installation will take a while. After it’s finished, you can start your MySQL server with the following command:

brew services start mysql

2. The next step is to run the following command to secure the MySQL server. Securing the server is hugely important as it will help prevent unauthorized access.

mysql_secure_installation

This command will trigger a series of prompts that you will need to read carefully. Most of the prompts are straightforward, such as allowing password verification, setting a root password, disallowing remote root access, removing the anonymous user, and more.

3. To access your MySQL server, enter the following command in the terminal. You will need to ensure that the server is running.

mysql -u root -p

You will need to enter your password after entering the command above. It is the same password that you set in step 2.

4. Let’s create the databases. Again replace your_username with the username you used in the previous step.

CREATE DATABASE `ascemu_world`;
GRANT ALL PRIVILEGES ON ascemu_world.* TO 'your_username'@'%';
CREATE DATABASE `ascemu_char`;
GRANT ALL PRIVILEGES ON ascemu_char.* TO 'your_username'@'%';
CREATE DATABASE `ascemu_logon`;
GRANT ALL PRIVILEGES ON ascemu_logon.* TO 'your_username'@'%';
FLUSH PRIVILEGES;

Check create the databases.

SHOW DATABASES;

You can issue MySQL commands once you are in the MySQL prompt (mysql>). If you want to return to bash simply enter exit or \q.

How to update MySQL

The easiest way to update your MySQL is to run brew upgrade mysql in Terminal.

Note that in this case, a manual update is far less convenient - it means that you will have to uninstall your current MySQL and then install a new version from scratch.

Getting the Files

Next, we need to download the AscEmu source files to compile them. Let’s make sure we are in the home directory:

cd ~

We will create an Server, and AscEmu directory so that we can keep all of our files straight.

sudo mkdir Development

sudo mkdir Development/Server

As you may have guessed, the AscEmu directory will contain AscEmu source files, and the Server directory will contain the actual compiled files (like the libraries and binaries) to run the Server.
The next step is to download the source files, so we will change to our Development/AscEmu directory and use git to get the files.

cd ~/Development

With the –branch required_branch, you can select a branch (master / develop).

git clone https://github.com/AscEmu/AscEmu.git --branch master

Compiling

Once we have the source files we can start compiling AscEmu. The first step is to create a configuration file that will be used to pass the variables to the make file so that AscEmu will compile properly.

sudo mkdir ~/Development/AscEmu_build

cd ~/Development/AscEmu_build

gcc

cmake -DCMAKE_INSTALL_PREFIX=~/Development/Server -DCMAKE_BUILD_TYPE=Release -DBUILD_WITH_WARNINGS=0 -DBUILD_TOOLS=0 -DASCEMU_VERSION=WotLK ~/Development/AscEmu

clang

cmake -DCMAKE_C_COMPILER=clang -DCMAKE_CXX_COMPILER=clang++ -DCMAKE_INSTALL_PREFIX=~/Development/Server -DCMAKE_BUILD_TYPE=Release -DBUILD_WITH_WARNINGS=0 -DBUILD_TOOLS=0 -DASCEMU_VERSION=WotLK ~/Development/AscEmu

-DCMAKE_INSTALL_PREFIX = the location where AscEmu binaries are installed
-DCMAKE_BUILD_TYPE = choose from Release or Debug mode
-DBUILD_WITH_WARNINGS = 0 (disabled) or 1 (enabled)
-DBUILD_TOOLS = 0 (disabled) or 1 (enabled)
-DASCEMU_VERSION = choose from Classic, TBC, WotLK, Cata or MoP
-DAE_USE_PCH = 0 (disabled) or 1 (enabled) - Precompiled headers are enabled by default

Then we now simply invoke make and make install to install to the prefix directory.

make && make install

It’s common to use -j$(($(sysctl -n hw.ncpu) + 1)) — which adds one extra thread beyond the number of CPU cores - to maximize CPU usage.
However, this is only recommended if your system has good thermal management and cooling.

make -j$(sysctl -n hw.ncpu) && make install

This will not effect your server, this will only tell “make” to compile using all of your available CPU power.

If this last step is successful then you are ready to configure your server and get on your way.

DBC and Map Files

Next you will transfer the DBC and Maps files over to your server.

Use Wine if you must but preferably a Windows machine to extract the DBC and map files.

sudo mkdir ~/Development/Server/dbc

sudo mkdir ~/Development/Server/maps

Place the DBC and map files in their respective directories above.
Extracting Vmaps and MMaps files is not required but is highly recommended.

Logon Database

Next you must apply base logon database manually because there is one column you must change before running your server.

Login to MySQL. Replace your_username with the username you used in “MySQL Environment Setup” section.

mysql -u your_username -p

Select logon database and execute SQL file.

use ascemu_logon;
source ~/Development/AscEmu/sql/logon/logon_base.sql

Now you must set a password for logonserver. This is an unique password that prevents unauthorized worldservers to register with your logonserver.
Memorize the password because you’ll need it later.

UPDATE realms SET password="your_password" WHERE id=1;
quit

World Database

AscEmu supports only OneDB world database which is maintained by AscEmu team. OneDB, as the name suggests, has all versions (Classic - Mop) packed into a single database. Link to Github.

First, switch back to your installer folder and use git to clone the OneDB repository.

cd ~/Development
git clone https://github.com/AscEmu/OneDB.git OneDB

Let’s copy the world database to server directory and unzip it.

sudo mkdir ~/Development/Server/sql
sudo mkdir ~/Development/Server/sql/world/
sudo cp OneDB/world_base.zip ~/Development/Server/sql/world/
cd ~/Development/Server/sql/world
sudo unzip world_base.zip

World database is now ready to be applied.
All future world database updates are added to AscEmu base repository so you don’t need to update your OneDB repository.

Configuration Files

All that is left to do is to create the /configs/ directory and move the configuration files there.

cd ~/Development/Server
sudo mkdir configs
sudo mv ~/Development/AscEmu/configs/*.conf ~/Development/Server/configs

Now your configuration files are in the ~/Development/Server/configs folder ready to be edited, and used by the AscEmu server.

Use an editor of your choice. Make sure to read all config files at least once, so you know what configuration is where and you don’t end up with an administrator account with default password you didn’t know about ;)

cd ~/Development/Server/configs
cat logon.conf
cat world.conf

Configuring logon.conf

Enter your MySQL information you created in MySQL Setup at the the following section.

<LogonDatabase Hostname = "localhost"
               Username = "ascemu"
               Password = "ascemu"
               Name     = "ascemu_logon"
               Port     = "3306">

Configuring world.conf

Enter your MySQL information you created in MySQL Setup at the the following section.

<WorldDatabase Hostname = "localhost"
               Username = "ascemu"
               Password = "ascemu"
               Name     = "ascemu_world"
               Port     = "3306">

<CharacterDatabase Hostname = "localhost"
                   Username = "ascemu"
                   Password = "ascemu"
                   Name     = "ascemu_char"
                   Port     = "3306">

Make sure RemotePassword matches the password in realms table in logon database that you set in “Logon Database” section.

<LogonServer Address        = "127.0.0.1"
             Port           = "8093"
             Name           = "Default Logon"
             RealmCount     = "1"
             DisablePings   = "0"
             RemotePassword = "change_me_logon">

That’s it! You should now have a fully functioning copy of AscEmu.
When you first time run the binaries your databases are automatically populated and updated to latest version. This process is fully automated. You can read about it github.svg more here.](https://ascemu.github.io/Wiki/database/auto_update/)

Applying especially world database or some large updates can take some time.

Create an Account

1. Go to your world console and create an account.

createaccount <accountname> <password>

example: createaccount admin adminpassword

2. Change permission(gmlevel) in your world console:

setaccpermission <accountname> <permission>

example: setaccpermission admin az

For further information about access levels, have a look to this page GM Access Levels