diff options
| -rw-r--r-- | CONTRIBUTING.md | 3 | ||||
| -rw-r--r-- | README.md | 162 |
2 files changed, 90 insertions, 75 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 25fa4b6e4..94544487e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -56,7 +56,8 @@ debug mode. fixes, make separate commits. Even if this causes commits that only affect one line of code. * Check for unnecessary whitespace with `git diff --check` before committing. -* Make sure you follow our [coding style guidelines](http://TODO). +* Make sure you follow our [coding style + guidelines](https://github.com/HerculesWS/Hercules/wiki/Coding-Style). * Make sure your commit messages are complete, describe the changes you made, and in proper English language. Make sure you mention the ID of the issue you fix. @@ -47,27 +47,31 @@ 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](https://github.com/HerculesWS/Hercules/wiki/Supported-Platforms) wiki page. + #### Windows - Git client - - MySQL-compatible server ([MySQL Community Edition](https://www.mysql.com/products/community/) or [MariaDB](https://mariadb.org/)) - - Microsoft Visual Studio ([Version 2010 through 2015](https://www.visualstudio.com/)) + - MySQL-compatible server ([MySQL Community Edition](https://www.mysql.com/products/community/) or + [MariaDB](https://mariadb.org/)) + - Microsoft Visual Studio ([Version 2012 through 2015](https://www.visualstudio.com/)) #### Unix/Linux/BSD (names of packages may require specific version numbers on certain distributions) - git - - gcc or clang (version 4.1 or newer, recommended 4.8 or newer) + - gcc or clang (version 4.5 or newer, recommended 5.0 or newer) - GNU make - - mysql (mysql-server) - - libmysqlclient (mysql-devel) - - zlib (zlib-devel) - - libpcre (pcre-devel) *optional* + - 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 or to regenerate the mobdb sql table) + - perl (required to rebuild the HPM Hooks and HPMDataCheck) - Doxygen (required to rebuild the HPM Hooks and HPMDataCheck) #### Mac OS X - - Xcode - - MySQL-compatible server (installation of mysql or mariadb through [Homebrew](http://brew.sh/) is recommended) - - libpcre (pcre-devel) *optional* + - Xcode or the Xcode command-line tools. + - MySQL-compatible server (installation of `mysql` or `mariadb` through [Homebrew](http://brew.sh/) is recommended) + - PCRE library (installation of `pcre` through [Homebrew](http://brew.sh) is recommended) - *Optional dependencies for development only* - Doxygen (required to rebuild the HPM Hooks and HPMDataCheck) @@ -76,7 +80,7 @@ following is broken down into Windows and Unix (incl. Linux) prerequisites. - [MySQL Workbench](http://www.mysql.com/downloads/workbench/) (cross-platform) - [HeidiSQL](http://www.heidisql.com/) (Windows) - [Sequel Pro](http://www.sequelpro.com/) (Mac OS X) - - Git clients + - GUI Git clients - [Atlassian SourceTree](https://www.sourcetreeapp.com/) (Windows, Mac OS X) - [TortoiseGit](https://tortoisegit.org/) (Windows) @@ -84,16 +88,19 @@ following is broken down into Windows and Unix (incl. Linux) prerequisites. 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). +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](https://github.com/HerculesWS/Hercules)) using a git client, into a new folder. + 2. Clone the Hercules repository (see [GitHub](https://github.com/HerculesWS/Hercules)) 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';` + - 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: @@ -108,13 +115,14 @@ relevant to your Operation System, please refer to the Wiki (links at the end of - 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 MySQL: `brew install mysql` + - 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';` + - 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 @@ -133,78 +141,84 @@ 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. +``` +[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/pa - ssword (gender 'S') - [Notice]: and then edit your user/password in conf/map-server.conf (or conf/impo - rt/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. +``` +[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. - )! +``` +[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. + 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 GIT, articles or -pages on the Wiki or topics within the Hercules forum. - -* Hercules Forums - http://herc.ws/board/ +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 Wiki - http://herc.ws/wiki/Main_Page +* Hercules Forums: + http://herc.ws/board/ -* GIT Repository URL: - https://github.com/HerculesWS/Hercules +* Hercules Wiki: + http://herc.ws/wiki/Main_Page -* Hercules IRC Channel - irc.rizon.net - Channel: #Hercules +* Git Repository URL: + https://github.com/HerculesWS/Hercules +* Hercules IRC Channel: + Network: `irc.rizon.net` + Channel: `#Hercules` 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 - -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. +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. |