Compiling

Unix

Using configure & make

Configure and make are commands used commonly to configure, build and install Linux applications.

Configure

Main article: Configure.

To avoid errors in server-client communication, PACKETVER must be set to date the client you're going to use has been released at (in YYYYMMDD format), eg 20100730 for 2010-07-30aRagexeRE. Instead of editing mmo.h directly, PACKETVER can be set to desired date with configure switch --enable-packetver=YYYYMMDD.

Run following command, replacing YYYYMMDD with your client release date, eg 20100730.

 ./configure --enable-packetver=YYYYMMDD

Configure script will perform necessary tests and generate makefiles.

Make

make sql

You should be now noticing that you have 3 new files: char-server, map-server, and login-server. Make install is not yet supported.

Using cmake & make

Cmake is a cross-platform configure.

Start creating a new sub directory and move there

  mkdir build
  cd build

Building makefiles

Generate the make files by cmake

  cmake -G"Unix Makefiles" -DINSTALL_TO_SOURCE=ON ..

-- The C compiler identification is GNU
-- Check for working C compiler: /usr/bin/gcc
-- Check for working C compiler: /usr/bin/gcc -- works
-- Detecting C compiler ABI info
-- Detecting C compiler ABI info - done
-- Detecting system MYSQL
-- Found MYSQL: /usr/lib/libmysqlclient.so (found version "5.1.58")
-- Detecting system MYSQL - done
-- Configuring for system MYSQL
-- Configuring for system MYSQL - done
-- Detecting system PCRE
-- Found PCRE: /usr/lib/i386-linux-gnu/libpcre.so (found version "8.12")
-- Detecting system PCRE - done
-- Configuring for system PCRE
...
-- Creating target login-server_sql
-- Creating target login-server_sql - done
-- Creating target char-server_sql
-- Creating target char-server_sql - done
-- Creating target map-server_sql
-- Enabled PCRE code
-- Creating target map-server_sql - done
-- Creating target mapcache
-- Creating target mapcache - done
-- Disabled dbghelpplug plugin target (requires WIN32 and HAVE_DBGHELP_H)
-- Available targets:
-- 	common_base
-- 	common_sql
-- 	login-server_sql
-- 	map-server_sql
-- 	mapcache
-- Configuring done
-- Generating done
-- Build files have been written to: /home/*/Hercules/build

Compilation

Then compile

  make install

Scanning dependencies of target common_base
[  1%] Building C object src/common/CMakeFiles/common_base.dir/__/__/3rdparty/mt19937ar/mt19937ar.c.o
[  1%] Building C object src/common/CMakeFiles/common_base.dir/core.c.o
[  2%] Building C object src/common/CMakeFiles/common_base.dir/db.c.o
[  3%] Building C object src/common/CMakeFiles/common_base.dir/des.c.o
...
[ 98%] Building C object src/tool/CMakeFiles/mapcache.dir/__/common/grfio.c.o
[ 99%] Building C object src/tool/CMakeFiles/mapcache.dir/__/common/utils.c.o
[100%] Building C object src/tool/CMakeFiles/mapcache.dir/mapcache.c.o
...
-- Installing: ~/Hercules/./login-server_sql
-- Installing: ~/Hercules/./char-server_sql
-- Installing: ~/Hercules/./map-server_sql
-- Installing: ~/Hercules/./mapcache

You'll see nice green output progression then finally login-server_sql, map-server_sql, char-server_sql, in main folder

Windows

For compiling on Windows, Visual Studio is the preferred method, although using Cygwin is also possible.

Using Visual Studio

MS Visual Studio 2012: Compile configuration (red) and solution (blue) with it's child projects.

Hercules ships with solution and project files for Visual Studio from 2012 onwards.

• Download the latest version of Visual Studio (at the time of writing, MS Visual Studio 2015 Community Edition) and install it, if you do not have Visual Studio already installed.
• Open Hercules-14.sln in your Hercules folder if you use Visual Studio 2015, for Visual Studio 2013, you need to open Hercules-12.sln, for Visual Studio 2012, you need to open Hercules-11.sln instead.
• Select the desired compile configuration (marked red). Use Release when you compile the server, where players will be playing on. Debug compiles the server without optimizations and with debugging information.
• Right-click the solution node (marked blue) and select Build solution. If you have compiled the server before, it is recommended to use Rebuild solution, as it forces the compiling of all components, not just those, which seem to have changed since last compile.
• If the compilation was successful, the resulting executables are in the same folder as the solution named login-server.exe, char-server.exe, map-server.exe and mapcache.exe.

Using Cygwin

Cygwin is a POSIX compatibility layer for Windows. As such it enables compiling the way it would be done on Linux. Compiling in Cygwin is not recommended due to lower performance and increased installation complexity.

• Download Cygwin and install it, if not already done so. When installing, select following packages:
  • from Devel: cmake, gcc and make
  • from Lib: libidn-devel, libpcre-devel, readline, zlib-devel
• Running Cygwin Terminal will create folder home/user inside Cygwin installation folder, where user is the name currently logged on Windows user.
• SQL server needs to be installed in Cygwin so the compiler can access the SQL libraries. Download the .tar.gz archive from the MySQL website, such as mysql-5.5.20.tar.gz.
• Place the archive into /home/user and execute following inside Cygwin Terminal to unpack it:

 cd ~
 tar xvzf mysql-5.5.20.tar.gz

• Navigate to directory with unpacked archive:

 cd mysql-5.5.20

• To avoid conficts, replace dtoa() with _dtoa() in strings/dtoa.c file:

 sed -i 's/dtoa(/_dtoa(/g' ./strings/dtoa.c

• Build MySQL with following commands:

 cmake .
 make mysqlclient libmysql
 make install

• After everything completes, Cygwin is ready for compiling Hercules. Navigate to the Hercules folder in Cygwin. Windows drives are accesible as /cygdrive/x where x is the letter assigned to the drive by Windows.
• Execute following commands inside Hercules folder to compile it:

 ./configure --with-mysql=/usr/local/mysql/bin/mysql_config
 make sql

• If the compilation was successful, the resulting executables are in the Hercules folder named login-server_sql.exe, char-server_sql.exe and map-server_sql.exe.
• Server executables can be run inside Cygwin Terminal or directly, but in this case you need to copy required libraries to Hercules folder:
  • cygwin1.dll, cygz.dll, cyggcc_s-1.dll, cygpcre-0.dll from /bin
  • cygmysqlclient-18.dll from /usr/local/mysql/lib