Hercules is a collaborative software development project revolving around the creation of a robust massively multiplayer online role playing game (MMORPG) server package. Written in C, the program is very versatile and provides NPCs, warps and modifications. The project is jointly managed by a group of volunteers located around the world as well…
C C++ PHP Makefile M4 Shell
Latest commit 7d7b08b Jan 15, 2017 @MishimaHaruna MishimaHaruna committed on GitHub Merge pull request #1545 from HerculesWS/md5buf
Update md5 calculation to be able to hash a binary buffer instead of …
Permalink
Failed to load latest commit information.
3rdparty Removed support for apostrophes in libconfig key names Nov 20, 2016
Hercules.xcodeproj Updated Xcode project to Xcode 8 Oct 6, 2016
cache Fixed typos on cache/. May 30, 2014
conf Added max_summoner_parameter: Oct 22, 2016
db Replaced some unsupported symbols in AegisNames (step 2) Nov 20, 2016
doc Update *waitingroom script document (#1537) Jan 2, 2017
log Fixed Typos (+1 squashed commits) Oct 21, 2015
npc Fixed announces from Koschei the Immortal (Moscovia Quests) (#1542) Jan 5, 2017
plugins Corrected line endings and BOM issues with several files Sep 16, 2013
save Fixed Typos (+1 squashed commits) Oct 21, 2015
sql-files Merge pull request #1491 from Smokexyz/patch-1 Jan 3, 2017
src HPM Hooks Update Jan 14, 2017
tools Let the CI test suite also run the tests Nov 19, 2016
vcproj-11 Updated Visual Studio projects with the conf/import file name changes Aug 21, 2016
vcproj-12 Updated Visual Studio projects with the conf/import file name changes Aug 21, 2016
vcproj-14 Updated Visual Studio projects with the conf/import file name changes Aug 21, 2016
.gitattributes * Implemented suggestion in topic:528, related to GMs being able to w… May 11, 2013
.gitignore Added Doxygen configuration (use 'make docs' to generate) Oct 2, 2016
.gitlab-ci.yml Aded gitlab pages configuration Oct 2, 2016
.travis.yml Moved travis.sh to tools/ci Oct 2, 2016
AUTHORS Added Chilly to AUTHORS Mar 9, 2014
CONTRIBUTING.md Updated README file Apr 23, 2016
Hercules-11.sln Follow up to 1d04521 Oct 31, 2014
Hercules-12.sln Follow-up to 1d04521 Oct 31, 2014
Hercules-14.sln Added support for visual Studio 2015 Aug 10, 2015
LICENSE Updated License from GNU GPLv2 to GNU GPLv3. Sep 9, 2010
Makefile.in Improved Makefile change detection Oct 6, 2016
README.md Fixing an small markdown mistake Dec 8, 2016
athena-start Dropped _sql suffix in server names. Feb 16, 2013
char-server.bat Removed executable flag from some files that don't require it Mar 10, 2014
char-server.sh Dropped _sql suffix in server names. Feb 16, 2013
configure Re-generated configure script Oct 17, 2016
configure.ac Re-add -fvisibility=hidden on FreeBSD (necessary for plugins) Dec 7, 2016
db2sql.bat Renamed some db2sql* plugin functions to itemdb2sql* Jan 29, 2016
dbghelp.dll - Updated dbghelp.dll Jul 10, 2013
libmysql.dll Updated DLLS to match libs. Please DO NOT update the libs from now on… Apr 17, 2006
login-server.bat Removed executable flag from some files that don't require it Mar 10, 2014
login-server.sh Dropped _sql suffix in server names. Feb 16, 2013
mac.start.scpt Added GPL-compliant header to all sources and build scripts Dec 15, 2015
map-server.bat Removed executable flag from some files that don't require it Mar 10, 2014
map-server.sh Dropped _sql suffix in server names. Feb 16, 2013
pcre3.dll * Merged changes ONLY eAthena 15101. May 31, 2012
run-server.bat Removed executable flag from some files that don't require it Mar 10, 2014
script-checker Added GPL-compliant header to all sources and build scripts Dec 15, 2015
script-checker.bat Clean up hercules.ws leftovers Jul 31, 2016
serv.bat Removed executable flag from some files that don't require it Mar 10, 2014
sysinfogen.sh Added GPL-compliant header to all sources and build scripts Dec 15, 2015
zlib1.dll * Merged changes ONLY eAthena 15100. May 31, 2012

README.md

Hercules

Build Status:
Build Status AppVeyor Build Status Coverity Scan Build Status
GitLabl Build Status Coverage Report

Issues and pull requests:
Open Issues Issues in progress Ready PRs

Development and Community:
GitHub Repository Waffle Board
IRC Community Forum Gitter
Twitter

Project Info:
Language License

Table of Contents

  • 1 What is Hercules?
  • 2 Prerequisites
  • 3 Installation
  • 4 Troubleshooting
  • 5 Helpful Links
  • 6 More Documentation

What is Hercules?

Hercules is a collaborative software development project revolving around the creation of a robust massively multiplayer online role playing game (MMORPG) server package. Written in C, the program is very versatile and provides NPCs, warps and modifications. The project is jointly managed by a group of volunteers located around the world as well as a tremendous community providing QA and support. Hercules is a continuation of the original Athena project.

Prerequisites

Before installing Hercules there are certain tools and applications you will need. This differs between the varying operating systems available, so the following is broken down into Windows and Unix (incl. Linux) prerequisites.

For a list of supported platforms, please refer to the Supported Platforms wiki page.

Windows

Unix/Linux/BSD (names of packages may require specific version numbers on certain distributions)

  • git
  • gcc or clang (version 4.5 or newer, recommended 5.0 or newer)
  • GNU make
  • mysql (mysql-server) or mariadb
  • libmysqlclient (mysql-devel)
  • zlib (zlib-devel)
  • libpcre (pcre-devel)
  • Optional dependencies for development only
    • perl (required to rebuild the HPM Hooks and HPMDataCheck)
    • Doxygen (required to rebuild the HPM Hooks and HPMDataCheck)

Mac OS X

  • Xcode or the Xcode command-line tools.
  • MySQL-compatible server (installation of mysql or mariadb through Homebrew is recommended)
  • PCRE library (installation of pcre through Homebrew is recommended)
  • Optional dependencies for development only
    • Doxygen (required to rebuild the HPM Hooks and HPMDataCheck)

Optional, useful tools

Installation

This section is a very brief set of installation instructions. For more concise guides relevant to your Operation System, please refer to the Wiki (links at the end of this file).

Windows

  1. Install the prerequisites.
  2. Clone the Hercules repository (see GitHub) using a git client, into a new folder.
  3. Connect to the MySQL server as root:
    • Create a database (hercules): CREATE DATABASE hercules;
    • Create a user (hercules): CREATE USER 'hercules'@'localhost' IDENTIFIED BY 'password';.
    • Give permissions (GRANT SELECT,INSERT,UPDATE,DELETE) to the user: GRANT SELECT,INSERT,UPDATE,DELETE ON hercules.* TO 'hercules'@'localhost';
  4. Connect to the MySQL server as the new user:
    • Import the .sql files in /sql-files/ into the new database.
  5. Start Visual Studio and load the provided solution:
    • Compile and run the three projects, login-server, char-server, map-server.

Unix

  1. Install the prerequisites through your distribution's package manager
    • (Red Hat compatible / CentOS) yum install gcc make mysql mysql-devel mysql-server pcre-devel zlib-devel git
    • (Debian compatible) apt-get install gcc make libmysqlclient-dev zlib1g-dev libpcre3-dev mysql-server git
    • (FreeBSD) pkg install clang35 gmake mysql56-server mysql-connector-c pcre git
    • (Mac OS X):
      • Install Xcode through the Mac App Store
      • Initialize the build tools through the Terminal xcode-select --help
      • Install Homebrew as described on the project page
      • Install the other prerequisites: brew install mysql pcre
  2. Clone the Hercules repository git clone https://github.com/HerculesWS/Hercules.git ~/Hercules
  3. Configure the MySQL server and start it.
  4. Connect to the MySQL server as root:
    • Create a database (hercules): CREATE DATABASE hercules;
    • Create a user (hercules): CREATE USER 'hercules'@'localhost' IDENTIFIED BY 'password';.
    • Give permissions (GRANT SELECT,INSERT,UPDATE,DELETE) to the user: GRANT SELECT,INSERT,UPDATE,DELETE ON hercules.* TO 'hercules'@'localhost';
  5. Connect to the MySQL server as the new user:
    • Import the .sql files in /sql-files/ into the new database.
  6. Enter the Hercules directory and configure/build Hercules
    • ./configure
    • make clean && make sql (on FreeBSD, replace make with gmake)
  7. Start the three servers login-server, char-server, map-server.

Troubleshooting

If you're having problems with starting your server, the first thing you should do is check what's happening on your consoles. More often that not, all support issues can be solved simply by looking at the error messages given.

Examples:

  • You get an error on your map-server_sql that looks something like this:
[Error]: npc_parsesrcfile: Unable to parse, probably a missing or extra TAB in file 'npc/custom/jobmaster.txt', line '17'. Skipping line...
        * w1=prontera,153,193,6 script
        * w2=Job Master
        * w3=123,{
        * w4=

If you look at the error, it's telling you that you're missing (or have an extra) TAB. This is easily fixed by looking at this part of the error: * w1=prontera,153,193,6 script. If there was a TAB where it's supposed to be, that line would have prontera,153,193,6 at w1 and script at w2. As there's a space instead of a TAB, the two sections are read as a single parameter.

  • You have a default user/password warning similar to the following:
[Warning]: Using the default user/password s1/p1 is NOT RECOMMENDED.
[Notice]: Please edit your 'login' table to create a proper inter-server user/password (gender 'S')
[Notice]: and then edit your user/password in conf/map-server.conf (or conf/import/map_conf.txt)

Relax. This is just indicating that you're using the default username and password. To fix this, check over the part in the installation instructions relevant to the login table.

  • Your Map Server says the following:
[Error]: make_connection: connect failed (socket #2, error 10061: No connection could be made because the target machine actively refused it.)!

If this shows up on the map server, it generally means that there is no Char Server available to accept the connection.

Helpful Links

The following list of links point to various help files within the repository, articles or pages on the Wiki or topics within the Hercules forum.

More Documentation

Hercules has a large collection of help files and sample NPC scripts located in /doc/

Scripting

It is recommended to look through /doc/script_commands.txt for help, pointers or even for ideas for your next NPC script. Most script commands have a usage example.

@commands

In-game, Game Masters have the ability to use Atcommands (@) to control players, create items, spawn mobs, reload configuration files and even control the weather. For an in-depth explanation, please see /doc/atcommands.txt

Permissions

The Hercules emulator has a permission system that enables certain groups of players to perform certain actions, or have access to certain visual enhancements or in-game activity. To see what permissions are available, they are detailed in /doc/permissions.txt

Others

There are more files in the /doc/ directory that will help you to create scripts or update the mapcache, or even explain how the job system and item bonuses work. Before posting a topic asking for help on the forums, we recommend that all users take the time to look over this directory.