diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 65 |
1 files changed, 34 insertions, 31 deletions
@@ -1,43 +1,45 @@ Hercules ======== -Build Status: +Build Status: [](https://travis-ci.org/HerculesWS/Hercules) [](https://ci.appveyor.com/project/Haru/hercules) -[](https://scan.coverity.com/projects/herculesws-hercules) -[](https://gitlab.com/HerculesWS/Hercules/commits/master) +[](https://scan.coverity.com/projects/herculesws-hercules) +[](https://gitlab.com/HerculesWS/Hercules/commits/master) [](https://gitlab.com/HerculesWS/Hercules/commits/master) +[](https://lgtm.com/projects/g/HerculesWS/Hercules/context:cpp) +[](https://lgtm.com/projects/g/HerculesWS/Hercules/alerts) -Issues and pull requests: +Issues and pull requests: [](https://github.com/HerculesWS/Hercules/issues) -[](https://waffle.io/HerculesWS/Hercules) -[](https://waffle.io/HerculesWS/Hercules) +[](https://github.com/HerculesWS/Hercules/pulls) -Development and Community: -[](https://github.com/HerculesWS/Hercules) -[](https://waffle.io/HerculesWS/Hercules) -[](irc://rizon.net/Hercules) +Development and Community: +[](https://github.com/HerculesWS/Hercules) [](http://herc.ws) -[](https://gitter.im/HerculesWS/Hercules) -[](https://twitter.com/HerculesWS) +[](irc://rizon.net/Hercules) +[](https://discord.gg/rqCxS8p) +[](https://twitter.com/HerculesWS) -Project Info: +Project Info: +[](https://github.com/HerculesWS/Hercules/releases)  [](https://github.com/HerculesWS/Hercules/blob/master/LICENSE) +[](https://github.com/HerculesWS/Hercules/graphs/contributors) Table of Contents --------- -* 1 What is Hercules? -* 2 Prerequisites -* 3 Installation -* 4 Troubleshooting -* 5 Helpful Links -* 6 More Documentation +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) +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 @@ -45,9 +47,9 @@ 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. +Before installing Hercules, you will need to install certain tools and applications. +This differs between the varying Operating Systems available, so the +following list is broken down into Windows and Unix (incl. Linux) prerequisites. For a list of supported platforms, please refer to the [Supported Platforms](https://github.com/HerculesWS/Hercules/wiki/Supported-Platforms) wiki page. @@ -62,12 +64,13 @@ Platforms](https://github.com/HerculesWS/Hercules/wiki/Supported-Platforms) wiki - git - gcc or clang (version 4.5 or newer, recommended 5.0 or newer) - GNU make - - mysql (`mysql-server`) or mariadb + - 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) + - requires the XML::Simple module, which in turn requires libexpat-dev - Doxygen (required to rebuild the HPM Hooks and HPMDataCheck) #### Mac OS X @@ -134,7 +137,7 @@ 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 +do is check what's happening on your consoles. More often than not, all support issues can be solved simply by looking at the error messages given. Examples: @@ -182,17 +185,17 @@ 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. -* Hercules Forums: +* Hercules Forums: http://herc.ws/board/ -* Hercules Wiki: +* Hercules Wiki: http://herc.ws/wiki/Main_Page -* Git Repository URL: +* Git Repository URL: https://github.com/HerculesWS/Hercules -* Hercules IRC Channel: - Network: `irc.rizon.net` +* Hercules IRC Channel: + Network: `irc.rizon.net` Channel: `#Hercules` More Documentation @@ -215,7 +218,7 @@ the weather. For an in-depth explanation, please see /doc/atcommands.txt 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 +are detailed in /doc/permissions.md ### Others There are more files in the /doc/ directory that will help you to create scripts |