Hercules Wiki - User contributions [en]

Installation (CentOS)

2016-06-10T18:53:06Z

Dastgirpojee: Reverted edits by Gmclerk (talk) to last revision by Dastgirpojee

This guide covers how to install [[Hercules]] on [[wikipedia:CentOS|CentOS]] and other [[wikipedia:List_of_Linux_distributions#RPM-based|versions of Linux]] that use [[wikipedia:Yellowdog_Updater,_Modified|yum]].

== Requirements ==
* [[wikipedia:CentOS|CentOS]] or an [[wikipedia:List_of_Linux_distributions#RPM-based|RPM-based Linux]] that has the '''[[wikipedia:Yellowdog_Updater,_Modified|yum]]''' command
* root access or access to an account that has [[wikipedia:Sudo|sudo privileges]]
* an Internet connection to download install packages

== Prerequisites ==
All of these commands will be typed at the [[wikipedia:Command-line_interface|command-line interface]].
=== Install Prerequisites ===
# Login to your server via [[wikipedia:Secure_Shell|SSH]], or if you are already logged into a [[wikipedia:Graphical_user_interface|GUI]] press Ctrl+Alt+T to open a terminal window.
# Type the following command (this will install GCC, Make, MySQL, MySQL header files, MySQL Server, PCRE header files, Git, and Zlib header files)
#: <pre>yum install gcc make mysql mysql-devel mysql-server pcre-devel git zlib-devel</pre>
# (Optional) type the following command to install some additional packages:
#: <pre>yum -y install dos2unix gdb nano screen unzip wget zip</pre>

=== Create a non-root Linux user ===
By the [[wikipedia:Principle_of_least_privilege|principle of least privilege]], it is recommended you do '''NOT''' run Hercules as root.
# Type the following command to create a non-root Linux account:
#: <pre>useradd --create-home --shell /bin/bash hercules1234</pre>
#: <code>--create-home</code> = create the user's home directory
#: <code>--shell</code> = sets their login shell to [[wikipedia:Bash_(Unix_shell)|Bash]]
#: '''<code>hercules1234</code>''' = the login name of the new Linux account
#: ''<code>1234</code>'' = pick your own random numbers to make the username more unique
# Set a password for the new user (run this command and follow the prompts):
#: <pre>passwd hercules1234</pre>

=== Configure MySQL ===

==== Set a root password ====
The default MySQL Server install creates a MySQL user 'root'@'localhost' with NO password. It is recommended you create a password for the root user.
# Run this command and follow the prompts:
#: Firest Start MySQL:
#: <pre>/etc/init.d/mysqld start </pre>
#: Then configure MySQL by:
#: <pre>mysql_secure_installation</pre>
# Login to your MySQL Server as root:
#: ''When prompted, enter your root MySQL password.''
#: <pre>mysql --user=root -p</pre>
# Now your prompt should look like this (the MySQL command prompt):
#: <pre>mysql> </pre>

==== Create SQL database for Hercules ====
# At the MySQL prompt, type this to [http://dev.mysql.com/doc/refman/5.5/en/create-database.html create a database] (replace <code>hercules1234</code> with the Linux username you created earlier):
#: <pre>mysql> CREATE DATABASE hercules1234_rag;</pre>
# Create a separate database for logs:
#: <pre>mysql> CREATE DATABASE hercules1234_log;</pre>

==== Setup a MySQL user for Hercules ====
# At the MySQL prompt, type something like this to create a new MySQL user:
#: <pre>mysql> CREATE USER 'hercules1234'@'localhost' IDENTIFIED BY 'secretpassword';</pre>
#: <code>hercules1234</code> = the name of the MySQL user (we named it the same as the Linux user to make it easier to identify)
#: <code>localhost</code> = the hostname or IP it will connect from
#: '''<code>secretpassword</code>''' = the password for this MySQL user
# [http://dev.mysql.com/doc/refman/5.5/en/grant.html Grant privileges] to the 'hercules' MySQL user:
#: <pre>mysql> GRANT SELECT,INSERT,UPDATE,DELETE ON `hercules1234\_rag`.* TO 'hercules1234'@'localhost';</pre>
#: <pre>mysql> GRANT SELECT,INSERT ON `hercules1234\_log`.* TO 'hercules1234'@'localhost';</pre> (note the [http://dev.mysql.com/doc/refman/5.5/en/string-literals.html#character-escape-sequences escaped underscore])

== Install [[Hercules]] ==

=== Login as your non-root Linux user ===
The rest of the setup is done as hercules1234 (the Linux user you created in step 2.2)
# Logout from root SSH (or minimize the window).
# Login to your server via SSH as the hercules1234 Linux user.

=== Git Clone ===
{{:Git Clone/Unix}}

=== [http://dev.mysql.com/doc/refman/5.5/en/batch-commands.html Import] MySQL Tables ===
# Change directory to the '''sql-files''' folder.
#: <pre>cd sql-files/</pre>
# Execute these commands:
#: ''When prompted, enter your MySQL root password.''
#: <pre>mysql -u root -prootpassword hercuser_rodb < main.sql</pre>
#: <pre>mysql -u root -prootpassword hercuser_rodblog < logs.sql</pre>
# If your Control Panel software or website requires it, you may also import the item, monster and monster skill databases (not necessary for the correct operation of Hercules)
#: (pre-renewal)
#: <pre>mysql -u root -prootpassword hercuser_rodb < item_db.sql</pre>
#: <pre>mysql -u root -prootpassword hercuser_rodb < mob_db.sql</pre>
#: <pre>mysql -u root -prootpassword hercuser_rodb < mob_skill_db.sql</pre>
#: (renewal)
#: <pre>mysql -u root -prootpassword hercuser_rodb < item_db_re.sql</pre>
#: <pre>mysql -u root -prootpassword hercuser_rodb < mob_db_re.sql</pre>
#: <pre>mysql -u root -prootpassword hercuser_rodb < mob_skill_db_re.sql</pre>
#: (common to renewal and pre-renewal)
#: <pre>mysql -u root -prootpassword hercuser_rodb < item_db2.sql</pre>
#: <pre>mysql -u root -prootpassword hercuser_rodb < mob_db2.sql</pre>
#: <pre>mysql -u root -prootpassword hercuser_rodb < mob_skill_db2.sql</pre>

NOTE: if you want to use different SQL DBs for login/char/map servers this is the list of databases each server use:
#login-server: global_acc_reg_num_db, global_acc_reg_str_db, ipbanlist, login, loginlog
#map-server: autotrade_data, autotrade_merchants, mapreg, npc_market_data
#char-server: everything else
Note that the sql_updates table is needed by all three servers.

=== [[:Category:Configuration|Configure Hercules]]===

=== Compile Source Code ===
cd Hercules
./configure
make sql

===== How to Recompile =====
In the future (after you update or edit any file in /src) to recompile, add ''make clean'' before make sql:
cd Hercules
./configure
'''make clean'''
make sql

== Start your Hercules Server ==
//change access mode of athena-start file so that you can execute it.
//Use (dos2unix athena-start) if yo uare getting ^M errors ie. newline errors
chmod a+x athena-start

//To Start
./athena-start start
//To Stop
./athena-start stop
//To Restart
./athena-start restart

== See Also ==

[[Category:Installation Guides|CentOS]]

Installation (CentOS)

2016-06-08T13:17:01Z

Dastgirpojee: Undo revision 1140 by Gmclerk (talk)

Installation (CentOS)

2016-06-08T13:16:40Z

Dastgirpojee: Undo revision 1139 by Gmclerk (talk)

This guide covers how to install [[Hercules]] on [[wikipedia:CentOS|CentOS]] and other [[wikipedia:List_of_Linux_distributions#RPM-based|versions of Linux]] that use [[wikipedia:Yellowdog_Updater,_Modified|yum]].

== Requirements ==
* [[wikipedia:CentOS|CentOS]] or an [[wikipedia:List_of_Linux_distributions#RPM-based|RPM-based Linux]] that has the '''[[wikipedia:Yellowdog_Updater,_Modified|yum]]''' command
* root access or access to an account that has [[wikipedia:Sudo|sudo privileges]]
* an Internet connection to download install packages

== Prerequisites ==
All of these commands will be typed at the [[wikipedia:Command-line_interface|command-line interface]].
=== Install Prerequisites ===
# Login to your server via [[wikipedia:Secure_Shell|SSH]], or if you are already logged into a [[wikipedia:Graphical_user_interface|GUI]] press Ctrl+Alt+T to open a terminal window.
# Type the following command (this will install GCC, Make, MySQL, MySQL header files, MySQL Server, PCRE header files, Git, and Zlib header files)
#: <pre>yum install gcc make mysql mysql-devel mysql-server pcre-devel git zlib-devel</pre>
# (Optional) type the following command to install some additional packages:
#: <pre>yum -y install dos2unix gdb nano screen unzip wget zip</pre>

=== Create a non-root Linux user ===
By the [[wikipedia:Principle_of_least_privilege|principle of least privilege]], it is recommended you do '''NOT''' run Hercules as root.
# Type the following command to create a non-root Linux account:
#: <pre>useradd --create-home --shell /bin/bash hercules1234</pre>
#: <code>--create-home</code> = create the user's home directory
#: <code>--shell</code> = sets their login shell to [[wikipedia:Bash_(Unix_shell)|Bash]]
#: '''<code>hercules1234</code>''' = the login name of the new Linux account
#: ''<code>1234</code>'' = pick your own random numbers to make the username more unique
# Set a password for the new user (run this command and follow the prompts):
#: <pre>passwd hercules1234</pre>

=== Configure MySQL ===

==== Set a root password ====
The default MySQL Server install creates a MySQL user 'root'@'localhost' with NO password. It is recommended you create a password for the root user.
# Run this command and follow the prompts:
#: Firest Start MySQL:
#: <pre>/etc/init.d/mysqld start </pre>
#: Then configure MySQL by:
#: <pre>mysql_secure_installation</pre>
# Login to your MySQL Server as root:
#: ''When prompted, enter your root MySQL password.''
#: <pre>mysql --user=root -p</pre>
# Now your prompt should look like this (the MySQL command prompt):
#: <pre>mysql> </pre>

==== Create SQL database for Hercules ====
# At the MySQL prompt, type this to [http://dev.mysql.com/doc/refman/5.5/en/create-database.html create a database] (replace <code>hercules1234</code> with the Linux username you created earlier):
#: <pre>mysql> CREATE DATABASE hercules1234_rag;</pre>
# Create a separate database for logs:
#: <pre>mysql> CREATE DATABASE hercules1234_log;</pre>

==== Setup a MySQL user for Hercules ====
# At the MySQL prompt, type something like this to create a new MySQL user:
#: <pre>mysql> CREATE USER 'hercules1234'@'localhost' IDENTIFIED BY 'secretpassword';</pre>
#: <code>hercules1234</code> = the name of the MySQL user (we named it the same as the Linux user to make it easier to identify)
#: <code>localhost</code> = the hostname or IP it will connect from
#: '''<code>secretpassword</code>''' = the password for this MySQL user
# [http://dev.mysql.com/doc/refman/5.5/en/grant.html Grant privileges] to the 'hercules' MySQL user:
#: <pre>mysql> GRANT SELECT,INSERT,UPDATE,DELETE ON `hercules1234\_rag`.* TO 'hercules1234'@'localhost';</pre>
#: <pre>mysql> GRANT SELECT,INSERT ON `hercules1234\_log`.* TO 'hercules1234'@'localhost';</pre> (note the [http://dev.mysql.com/doc/refman/5.5/en/string-literals.html#character-escape-sequences escaped underscore])

== Install [[Hercules]] ==

=== Login as your non-root Linux user ===
The rest of the setup is done as hercules1234 (the Linux user you created in step 2.2)
# Logout from root SSH (or minimize the window).
# Login to your server via SSH as the hercules1234 Linux user.

=== Git Clone ===
{{:Git Clone/Unix}}

=== [http://dev.mysql.com/doc/refman/5.5/en/batch-commands.html Import] MySQL Tables ===
# Change directory to the '''sql-files''' folder.
#: <pre>cd /home/juke/Hercules/sql-files/</pre>
# Execute these commands:
#: ''When prompted, enter your MySQL root password.''
#: <pre>mysql -u root -prootpassword hercuser_rodb < main.sql</pre>
#: <pre>mysql -u root -prootpassword hercuser_rodblog < logs.sql</pre>
# If your Control Panel software or website requires it, you may also import the item, monster and monster skill databases (not necessary for the correct operation of Hercules)
#: (pre-renewal)
#: <pre>mysql -u root -prootpassword hercuser_rodb < item_db.sql</pre>
#: <pre>mysql -u root -prootpassword hercuser_rodb < mob_db.sql</pre>
#: <pre>mysql -u root -prootpassword hercuser_rodb < mob_skill_db.sql</pre>
#: (renewal)
#: <pre>mysql -u root -prootpassword hercuser_rodb < item_db_re.sql</pre>
#: <pre>mysql -u root -prootpassword hercuser_rodb < mob_db_re.sql</pre>
#: <pre>mysql -u root -prootpassword hercuser_rodb < mob_skill_db_re.sql</pre>
#: (common to renewal and pre-renewal)
#: <pre>mysql -u root -prootpassword hercuser_rodb < item_db2.sql</pre>
#: <pre>mysql -u root -prootpassword hercuser_rodb < mob_db2.sql</pre>
#: <pre>mysql -u root -prootpassword hercuser_rodb < mob_skill_db2.sql</pre>

NOTE: if you want to use different SQL DBs for login/char/map servers this is the list of databases each server use:
#login-server: global_acc_reg_num_db, global_acc_reg_str_db, ipbanlist, login, loginlog
#map-server: autotrade_data, autotrade_merchants, mapreg, npc_market_data
#char-server: everything else
Note that the sql_updates table is needed by all three servers.

=== [[:Category:Configuration|Configure Hercules]]===

=== Compile Source Code ===
cd Hercules
./configure
make sql

===== How to Recompile =====
In the future (after you update or edit any file in /src) to recompile, add ''make clean'' before make sql:
cd Hercules
./configure
'''make clean'''
make sql

== Start your Hercules Server ==
//change access mode of athena-start file so that you can execute it.
//Use (dos2unix athena-start) if yo uare getting ^M errors ie. newline errors
chmod a+x athena-start

//To Start
./athena-start start
//To Stop
./athena-start stop
//To Restart
./athena-start restart

== See Also ==

[[Category:Installation Guides|CentOS]]

Installation (CentOS)

2016-06-08T13:16:18Z

Dastgirpojee: Undo revision 1138 by Gmclerk (talk)

This guide covers how to install [[Hercules]] on [[wikipedia:CentOS|CentOS]] and other [[wikipedia:List_of_Linux_distributions#RPM-based|versions of Linux]] that use [[wikipedia:Yellowdog_Updater,_Modified|yum]].

== Requirements ==
* [[wikipedia:CentOS|CentOS]] or an [[wikipedia:List_of_Linux_distributions#RPM-based|RPM-based Linux]] that has the '''[[wikipedia:Yellowdog_Updater,_Modified|yum]]''' command
* root access or access to an account that has [[wikipedia:Sudo|sudo privileges]]
* an Internet connection to download install packages

== Prerequisites ==
All of these commands will be typed at the [[wikipedia:Command-line_interface|command-line interface]].
=== Install Prerequisites ===
# Login to your server via [[wikipedia:Secure_Shell|SSH]], or if you are already logged into a [[wikipedia:Graphical_user_interface|GUI]] press Ctrl+Alt+T to open a terminal window.
# Type the following command (this will install GCC, Make, MySQL, MySQL header files, MySQL Server, PCRE header files, Git, and Zlib header files)
#: <pre>yum install gcc make mysql mysql-devel mysql-server pcre-devel git zlib-devel</pre>
# (Optional) type the following command to install some additional packages:
#: <pre>yum -y install dos2unix gdb nano screen unzip wget zip</pre>

=== Create a non-root Linux user ===
By the [[wikipedia:Principle_of_least_privilege|principle of least privilege]], it is recommended you do '''NOT''' run Hercules as root.
# Type the following command to create a non-root Linux account:
#: <pre>useradd --create-home --shell /bin/bash hercules1234</pre>
#: <code>--create-home</code> = create the user's home directory
#: <code>--shell</code> = sets their login shell to [[wikipedia:Bash_(Unix_shell)|Bash]]
#: '''<code>hercules1234</code>''' = the login name of the new Linux account
#: ''<code>1234</code>'' = pick your own random numbers to make the username more unique
# Set a password for the new user (run this command and follow the prompts):
#: <pre>passwd hercules1234</pre>

=== Configure MySQL ===

==== Set a root password ====
The default MySQL Server install creates a MySQL user 'root'@'localhost' with NO password. It is recommended you create a password for the root user.
# Run this command and follow the prompts:
#: Firest Start MySQL:
#: <pre>/etc/init.d/mysqld start </pre>
#: Then configure MySQL by:
#: <pre>mysql_secure_installation</pre>
# Login to your MySQL Server as root:
#: ''When prompted, enter your root MySQL password.''
#: <pre>mysql --user=root -p</pre>
# Now your prompt should look like this (the MySQL command prompt):
#: <pre>mysql> </pre>

==== Create SQL database for Hercules ====
# At the MySQL prompt, type this to [http://dev.mysql.com/doc/refman/5.5/en/create-database.html create a database] (replace <code>hercules1234</code> with the Linux username you created earlier):
#: <pre>mysql> CREATE DATABASE hercules1234_rag;</pre>
# Create a separate database for logs:
#: <pre>mysql> CREATE DATABASE hercules1234_log;</pre>

==== Setup a MySQL user for Hercules ====
# At the MySQL prompt, type something like this to create a new MySQL user:
#: <pre>mysql> CREATE USER 'juke'@'localhost' IDENTIFIED BY 'Masgercey123';</pre>
#: <code>hercules1234</code> = the name of the MySQL user (we named it the same as the Linux user to make it easier to identify)
#: <code>localhost</code> = the hostname or IP it will connect from
#: '''<code>secretpassword</code>''' = the password for this MySQL user
# [http://dev.mysql.com/doc/refman/5.5/en/grant.html Grant privileges] to the 'hercules' MySQL user:
#: <pre>mysql> GRANT SELECT,INSERT,UPDATE,DELETE ON `juke\_rag`.* TO 'juke'@'localhost';</pre>
#: <pre>mysql> GRANT SELECT,INSERT ON `juke\_log`.* TO 'juke'@'localhost';</pre> (note the [http://dev.mysql.com/doc/refman/5.5/en/string-literals.html#character-escape-sequences escaped underscore])

== Install [[Hercules]] ==

=== Login as your non-root Linux user ===
The rest of the setup is done as hercules1234 (the Linux user you created in step 2.2)
# Logout from root SSH (or minimize the window).
# Login to your server via SSH as the hercules1234 Linux user.

=== Git Clone ===
{{:Git Clone/Unix}}

=== [http://dev.mysql.com/doc/refman/5.5/en/batch-commands.html Import] MySQL Tables ===
# Change directory to the '''sql-files''' folder.
#: <pre>cd /home/juke/Hercules/sql-files/</pre>
# Execute these commands:
#: ''When prompted, enter your MySQL root password.''
#: <pre>mysql -u root -prootpassword hercuser_rodb < main.sql</pre>
#: <pre>mysql -u root -prootpassword hercuser_rodblog < logs.sql</pre>
# If your Control Panel software or website requires it, you may also import the item, monster and monster skill databases (not necessary for the correct operation of Hercules)
#: (pre-renewal)
#: <pre>mysql -u root -prootpassword hercuser_rodb < item_db.sql</pre>
#: <pre>mysql -u root -prootpassword hercuser_rodb < mob_db.sql</pre>
#: <pre>mysql -u root -prootpassword hercuser_rodb < mob_skill_db.sql</pre>
#: (renewal)
#: <pre>mysql -u root -prootpassword hercuser_rodb < item_db_re.sql</pre>
#: <pre>mysql -u root -prootpassword hercuser_rodb < mob_db_re.sql</pre>
#: <pre>mysql -u root -prootpassword hercuser_rodb < mob_skill_db_re.sql</pre>
#: (common to renewal and pre-renewal)
#: <pre>mysql -u root -prootpassword hercuser_rodb < item_db2.sql</pre>
#: <pre>mysql -u root -prootpassword hercuser_rodb < mob_db2.sql</pre>
#: <pre>mysql -u root -prootpassword hercuser_rodb < mob_skill_db2.sql</pre>

NOTE: if you want to use different SQL DBs for login/char/map servers this is the list of databases each server use:
#login-server: global_acc_reg_num_db, global_acc_reg_str_db, ipbanlist, login, loginlog
#map-server: autotrade_data, autotrade_merchants, mapreg, npc_market_data
#char-server: everything else
Note that the sql_updates table is needed by all three servers.

=== [[:Category:Configuration|Configure Hercules]]===

=== Compile Source Code ===
cd Hercules
./configure
make sql

===== How to Recompile =====
In the future (after you update or edit any file in /src) to recompile, add ''make clean'' before make sql:
cd Hercules
./configure
'''make clean'''
make sql

== Start your Hercules Server ==
//change access mode of athena-start file so that you can execute it.
//Use (dos2unix athena-start) if yo uare getting ^M errors ie. newline errors
chmod a+x athena-start

//To Start
./athena-start start
//To Stop
./athena-start stop
//To Restart
./athena-start restart

== See Also ==

[[Category:Installation Guides|CentOS]]

Installation (CentOS)

2016-06-08T13:15:58Z

Dastgirpojee: Undo revision 1137 by Gmclerk (talk)

This guide covers how to install [[Hercules]] on [[wikipedia:CentOS|CentOS]] and other [[wikipedia:List_of_Linux_distributions#RPM-based|versions of Linux]] that use [[wikipedia:Yellowdog_Updater,_Modified|yum]].

== Requirements ==
* [[wikipedia:CentOS|CentOS]] or an [[wikipedia:List_of_Linux_distributions#RPM-based|RPM-based Linux]] that has the '''[[wikipedia:Yellowdog_Updater,_Modified|yum]]''' command
* root access or access to an account that has [[wikipedia:Sudo|sudo privileges]]
* an Internet connection to download install packages

== Prerequisites ==
All of these commands will be typed at the [[wikipedia:Command-line_interface|command-line interface]].
=== Install Prerequisites ===
# Login to your server via [[wikipedia:Secure_Shell|SSH]], or if you are already logged into a [[wikipedia:Graphical_user_interface|GUI]] press Ctrl+Alt+T to open a terminal window.
# Type the following command (this will install GCC, Make, MySQL, MySQL header files, MySQL Server, PCRE header files, Git, and Zlib header files)
#: <pre>yum install gcc make mysql mysql-devel mysql-server pcre-devel git zlib-devel</pre>
# (Optional) type the following command to install some additional packages:
#: <pre>yum -y install dos2unix gdb nano screen unzip wget zip</pre>

=== Create a non-root Linux user ===
By the [[wikipedia:Principle_of_least_privilege|principle of least privilege]], it is recommended you do '''NOT''' run Hercules as root.
# Type the following command to create a non-root Linux account:
#: <pre>useradd --create-home --shell /bin/bash hercules1234</pre>
#: <code>--create-home</code> = create the user's home directory
#: <code>--shell</code> = sets their login shell to [[wikipedia:Bash_(Unix_shell)|Bash]]
#: '''<code>hercules1234</code>''' = the login name of the new Linux account
#: ''<code>1234</code>'' = pick your own random numbers to make the username more unique
# Set a password for the new user (run this command and follow the prompts):
#: <pre>passwd hercules1234</pre>

=== Configure MySQL ===

==== Set a root password ====
The default MySQL Server install creates a MySQL user 'root'@'localhost' with NO password. It is recommended you create a password for the root user.
# Run this command and follow the prompts:
#: Firest Start MySQL:
#: <pre>/etc/init.d/mysqld start </pre>
#: Then configure MySQL by:
#: <pre>mysql_secure_installation</pre>
# Login to your MySQL Server as root:
#: ''When prompted, enter your root MySQL password.''
#: <pre>mysql --user=root -p</pre>
# Now your prompt should look like this (the MySQL command prompt):
#: <pre>mysql> </pre>

==== Create SQL database for Hercules ====
# At the MySQL prompt, type this to [http://dev.mysql.com/doc/refman/5.5/en/create-database.html create a database] (replace <code>hercules1234</code> with the Linux username you created earlier):
#: <pre>mysql> CREATE DATABASE juke_rag;</pre>
# Create a separate database for logs:
#: <pre>mysql> CREATE DATABASE juke_log;</pre>

==== Setup a MySQL user for Hercules ====
# At the MySQL prompt, type something like this to create a new MySQL user:
#: <pre>mysql> CREATE USER 'juke'@'localhost' IDENTIFIED BY 'Masgercey123';</pre>
#: <code>hercules1234</code> = the name of the MySQL user (we named it the same as the Linux user to make it easier to identify)
#: <code>localhost</code> = the hostname or IP it will connect from
#: '''<code>secretpassword</code>''' = the password for this MySQL user
# [http://dev.mysql.com/doc/refman/5.5/en/grant.html Grant privileges] to the 'hercules' MySQL user:
#: <pre>mysql> GRANT SELECT,INSERT,UPDATE,DELETE ON `juke\_rag`.* TO 'juke'@'localhost';</pre>
#: <pre>mysql> GRANT SELECT,INSERT ON `juke\_log`.* TO 'juke'@'localhost';</pre> (note the [http://dev.mysql.com/doc/refman/5.5/en/string-literals.html#character-escape-sequences escaped underscore])

== Install [[Hercules]] ==

=== Login as your non-root Linux user ===
The rest of the setup is done as hercules1234 (the Linux user you created in step 2.2)
# Logout from root SSH (or minimize the window).
# Login to your server via SSH as the hercules1234 Linux user.

=== Git Clone ===
{{:Git Clone/Unix}}

=== [http://dev.mysql.com/doc/refman/5.5/en/batch-commands.html Import] MySQL Tables ===
# Change directory to the '''sql-files''' folder.
#: <pre>cd /home/juke/Hercules/sql-files/</pre>
# Execute these commands:
#: ''When prompted, enter your MySQL root password.''
#: <pre>mysql -u root -prootpassword hercuser_rodb < main.sql</pre>
#: <pre>mysql -u root -prootpassword hercuser_rodblog < logs.sql</pre>
# If your Control Panel software or website requires it, you may also import the item, monster and monster skill databases (not necessary for the correct operation of Hercules)
#: (pre-renewal)
#: <pre>mysql -u root -prootpassword hercuser_rodb < item_db.sql</pre>
#: <pre>mysql -u root -prootpassword hercuser_rodb < mob_db.sql</pre>
#: <pre>mysql -u root -prootpassword hercuser_rodb < mob_skill_db.sql</pre>
#: (renewal)
#: <pre>mysql -u root -prootpassword hercuser_rodb < item_db_re.sql</pre>
#: <pre>mysql -u root -prootpassword hercuser_rodb < mob_db_re.sql</pre>
#: <pre>mysql -u root -prootpassword hercuser_rodb < mob_skill_db_re.sql</pre>
#: (common to renewal and pre-renewal)
#: <pre>mysql -u root -prootpassword hercuser_rodb < item_db2.sql</pre>
#: <pre>mysql -u root -prootpassword hercuser_rodb < mob_db2.sql</pre>
#: <pre>mysql -u root -prootpassword hercuser_rodb < mob_skill_db2.sql</pre>

NOTE: if you want to use different SQL DBs for login/char/map servers this is the list of databases each server use:
#login-server: global_acc_reg_num_db, global_acc_reg_str_db, ipbanlist, login, loginlog
#map-server: autotrade_data, autotrade_merchants, mapreg, npc_market_data
#char-server: everything else
Note that the sql_updates table is needed by all three servers.

=== [[:Category:Configuration|Configure Hercules]]===

=== Compile Source Code ===
cd Hercules
./configure
make sql

===== How to Recompile =====
In the future (after you update or edit any file in /src) to recompile, add ''make clean'' before make sql:
cd Hercules
./configure
'''make clean'''
make sql

== Start your Hercules Server ==
//change access mode of athena-start file so that you can execute it.
//Use (dos2unix athena-start) if yo uare getting ^M errors ie. newline errors
chmod a+x athena-start

//To Start
./athena-start start
//To Stop
./athena-start stop
//To Restart
./athena-start restart

== See Also ==

[[Category:Installation Guides|CentOS]]

Installation (CentOS)

2016-06-08T13:14:51Z

Dastgirpojee: Reverted edits by Dastgirpojee (talk) to last revision by Gmclerk

This guide covers how to install [[Hercules]] on [[wikipedia:CentOS|CentOS]] and other [[wikipedia:List_of_Linux_distributions#RPM-based|versions of Linux]] that use [[wikipedia:Yellowdog_Updater,_Modified|yum]].

== Requirements ==
* [[wikipedia:CentOS|CentOS]] or an [[wikipedia:List_of_Linux_distributions#RPM-based|RPM-based Linux]] that has the '''[[wikipedia:Yellowdog_Updater,_Modified|yum]]''' command
* root access or access to an account that has [[wikipedia:Sudo|sudo privileges]]
* an Internet connection to download install packages

== Prerequisites ==
All of these commands will be typed at the [[wikipedia:Command-line_interface|command-line interface]].
=== Install Prerequisites ===
# Login to your server via [[wikipedia:Secure_Shell|SSH]], or if you are already logged into a [[wikipedia:Graphical_user_interface|GUI]] press Ctrl+Alt+T to open a terminal window.
# Type the following command (this will install GCC, Make, MySQL, MySQL header files, MySQL Server, PCRE header files, Git, and Zlib header files)
#: <pre>yum install gcc make mysql mysql-devel mysql-server pcre-devel git zlib-devel</pre>
# (Optional) type the following command to install some additional packages:
#: <pre>yum -y install dos2unix gdb nano screen unzip wget zip</pre>

=== Create a non-root Linux user ===
By the [[wikipedia:Principle_of_least_privilege|principle of least privilege]], it is recommended you do '''NOT''' run Hercules as root.
# Type the following command to create a non-root Linux account:
#: <pre>useradd --create-home --shell /bin/bash juke</pre>
#: <code>--create-home</code> = create the user's home directory
#: <code>--shell</code> = sets their login shell to [[wikipedia:Bash_(Unix_shell)|Bash]]
#: '''<code>hercules1234</code>''' = the login name of the new Linux account
#: ''<code>1234</code>'' = pick your own random numbers to make the username more unique
# Set a password for the new user (run this command and follow the prompts):
#: <pre>passwd juke</pre>

=== Configure MySQL ===

==== Set a root password ====
The default MySQL Server install creates a MySQL user 'root'@'localhost' with NO password. It is recommended you create a password for the root user.
# Run this command and follow the prompts:
#: Firest Start MySQL:
#: <pre>/etc/init.d/mysqld start </pre>
#: Then configure MySQL by:
#: <pre>mysql_secure_installation</pre>
# Login to your MySQL Server as root:
#: ''When prompted, enter your root MySQL password.''
#: <pre>mysql --user=root -p</pre>
# Now your prompt should look like this (the MySQL command prompt):
#: <pre>mysql> </pre>

==== Create SQL database for Hercules ====
# At the MySQL prompt, type this to [http://dev.mysql.com/doc/refman/5.5/en/create-database.html create a database] (replace <code>hercules1234</code> with the Linux username you created earlier):
#: <pre>mysql> CREATE DATABASE juke_rag;</pre>
# Create a separate database for logs:
#: <pre>mysql> CREATE DATABASE juke_log;</pre>

==== Setup a MySQL user for Hercules ====
# At the MySQL prompt, type something like this to create a new MySQL user:
#: <pre>mysql> CREATE USER 'juke'@'localhost' IDENTIFIED BY 'Masgercey123';</pre>
#: <code>hercules1234</code> = the name of the MySQL user (we named it the same as the Linux user to make it easier to identify)
#: <code>localhost</code> = the hostname or IP it will connect from
#: '''<code>secretpassword</code>''' = the password for this MySQL user
# [http://dev.mysql.com/doc/refman/5.5/en/grant.html Grant privileges] to the 'hercules' MySQL user:
#: <pre>mysql> GRANT SELECT,INSERT,UPDATE,DELETE ON `juke\_rag`.* TO 'juke'@'localhost';</pre>
#: <pre>mysql> GRANT SELECT,INSERT ON `juke\_log`.* TO 'juke'@'localhost';</pre> (note the [http://dev.mysql.com/doc/refman/5.5/en/string-literals.html#character-escape-sequences escaped underscore])

== Install [[Hercules]] ==

=== Login as your non-root Linux user ===
The rest of the setup is done as hercules1234 (the Linux user you created in step 2.2)
# Logout from root SSH (or minimize the window).
# Login to your server via SSH as the hercules1234 Linux user.

=== Git Clone ===
{{:Git Clone/Unix}}

=== [http://dev.mysql.com/doc/refman/5.5/en/batch-commands.html Import] MySQL Tables ===
# Change directory to the '''sql-files''' folder.
#: <pre>cd /home/juke/Hercules/sql-files/</pre>
# Execute these commands:
#: ''When prompted, enter your MySQL root password.''
#: <pre>mysql -u root -prootpassword hercuser_rodb < main.sql</pre>
#: <pre>mysql -u root -prootpassword hercuser_rodblog < logs.sql</pre>
# If your Control Panel software or website requires it, you may also import the item, monster and monster skill databases (not necessary for the correct operation of Hercules)
#: (pre-renewal)
#: <pre>mysql -u root -prootpassword hercuser_rodb < item_db.sql</pre>
#: <pre>mysql -u root -prootpassword hercuser_rodb < mob_db.sql</pre>
#: <pre>mysql -u root -prootpassword hercuser_rodb < mob_skill_db.sql</pre>
#: (renewal)
#: <pre>mysql -u root -prootpassword hercuser_rodb < item_db_re.sql</pre>
#: <pre>mysql -u root -prootpassword hercuser_rodb < mob_db_re.sql</pre>
#: <pre>mysql -u root -prootpassword hercuser_rodb < mob_skill_db_re.sql</pre>
#: (common to renewal and pre-renewal)
#: <pre>mysql -u root -prootpassword hercuser_rodb < item_db2.sql</pre>
#: <pre>mysql -u root -prootpassword hercuser_rodb < mob_db2.sql</pre>
#: <pre>mysql -u root -prootpassword hercuser_rodb < mob_skill_db2.sql</pre>

NOTE: if you want to use different SQL DBs for login/char/map servers this is the list of databases each server use:
#login-server: global_acc_reg_num_db, global_acc_reg_str_db, ipbanlist, login, loginlog
#map-server: autotrade_data, autotrade_merchants, mapreg, npc_market_data
#char-server: everything else
Note that the sql_updates table is needed by all three servers.

=== [[:Category:Configuration|Configure Hercules]]===

=== Compile Source Code ===
cd Hercules
./configure
make sql

===== How to Recompile =====
In the future (after you update or edit any file in /src) to recompile, add ''make clean'' before make sql:
cd Hercules
./configure
'''make clean'''
make sql

== Start your Hercules Server ==
//change access mode of athena-start file so that you can execute it.
//Use (dos2unix athena-start) if yo uare getting ^M errors ie. newline errors
chmod a+x athena-start

//To Start
./athena-start start
//To Stop
./athena-start stop
//To Restart
./athena-start restart

== See Also ==

[[Category:Installation Guides|CentOS]]

Installation (CentOS)

2016-06-08T13:13:07Z

Dastgirpojee: Undo revision 1137 by Gmclerk (talk)

This guide covers how to install [[Hercules]] on [[wikipedia:CentOS|CentOS]] and other [[wikipedia:List_of_Linux_distributions#RPM-based|versions of Linux]] that use [[wikipedia:Yellowdog_Updater,_Modified|yum]].

== Requirements ==
* [[wikipedia:CentOS|CentOS]] or an [[wikipedia:List_of_Linux_distributions#RPM-based|RPM-based Linux]] that has the '''[[wikipedia:Yellowdog_Updater,_Modified|yum]]''' command
* root access or access to an account that has [[wikipedia:Sudo|sudo privileges]]
* an Internet connection to download install packages

== Prerequisites ==
All of these commands will be typed at the [[wikipedia:Command-line_interface|command-line interface]].
=== Install Prerequisites ===
# Login to your server via [[wikipedia:Secure_Shell|SSH]], or if you are already logged into a [[wikipedia:Graphical_user_interface|GUI]] press Ctrl+Alt+T to open a terminal window.
# Type the following command (this will install GCC, Make, MySQL, MySQL header files, MySQL Server, PCRE header files, Git, and Zlib header files)
#: <pre>yum install gcc make mysql mysql-devel mysql-server pcre-devel git zlib-devel</pre>
# (Optional) type the following command to install some additional packages:
#: <pre>yum -y install dos2unix gdb nano screen unzip wget zip</pre>

=== Create a non-root Linux user ===
By the [[wikipedia:Principle_of_least_privilege|principle of least privilege]], it is recommended you do '''NOT''' run Hercules as root.
# Type the following command to create a non-root Linux account:
#: <pre>useradd --create-home --shell /bin/bash hercules1234</pre>
#: <code>--create-home</code> = create the user's home directory
#: <code>--shell</code> = sets their login shell to [[wikipedia:Bash_(Unix_shell)|Bash]]
#: '''<code>hercules1234</code>''' = the login name of the new Linux account
#: ''<code>1234</code>'' = pick your own random numbers to make the username more unique
# Set a password for the new user (run this command and follow the prompts):
#: <pre>passwd hercules1234</pre>

=== Configure MySQL ===

==== Set a root password ====
The default MySQL Server install creates a MySQL user 'root'@'localhost' with NO password. It is recommended you create a password for the root user.
# Run this command and follow the prompts:
#: Firest Start MySQL:
#: <pre>/etc/init.d/mysqld start </pre>
#: Then configure MySQL by:
#: <pre>mysql_secure_installation</pre>
# Login to your MySQL Server as root:
#: ''When prompted, enter your root MySQL password.''
#: <pre>mysql --user=root -p</pre>
# Now your prompt should look like this (the MySQL command prompt):
#: <pre>mysql> </pre>

==== Create SQL database for Hercules ====
# At the MySQL prompt, type this to [http://dev.mysql.com/doc/refman/5.5/en/create-database.html create a database] (replace <code>hercules1234</code> with the Linux username you created earlier):
#: <pre>mysql> CREATE DATABASE juke_rag;</pre>
# Create a separate database for logs:
#: <pre>mysql> CREATE DATABASE juke_log;</pre>

==== Setup a MySQL user for Hercules ====
# At the MySQL prompt, type something like this to create a new MySQL user:
#: <pre>mysql> CREATE USER 'juke'@'localhost' IDENTIFIED BY 'Masgercey123';</pre>
#: <code>hercules1234</code> = the name of the MySQL user (we named it the same as the Linux user to make it easier to identify)
#: <code>localhost</code> = the hostname or IP it will connect from
#: '''<code>secretpassword</code>''' = the password for this MySQL user
# [http://dev.mysql.com/doc/refman/5.5/en/grant.html Grant privileges] to the 'hercules' MySQL user:
#: <pre>mysql> GRANT SELECT,INSERT,UPDATE,DELETE ON `juke\_rag`.* TO 'juke'@'localhost';</pre>
#: <pre>mysql> GRANT SELECT,INSERT ON `juke\_log`.* TO 'juke'@'localhost';</pre> (note the [http://dev.mysql.com/doc/refman/5.5/en/string-literals.html#character-escape-sequences escaped underscore])

== Install [[Hercules]] ==

=== Login as your non-root Linux user ===
The rest of the setup is done as hercules1234 (the Linux user you created in step 2.2)
# Logout from root SSH (or minimize the window).
# Login to your server via SSH as the hercules1234 Linux user.

=== Git Clone ===
{{:Git Clone/Unix}}

=== [http://dev.mysql.com/doc/refman/5.5/en/batch-commands.html Import] MySQL Tables ===
# Change directory to the '''sql-files''' folder.
#: <pre>cd sql-files/</pre>
# Execute these commands:
#: ''When prompted, enter your MySQL root password.''
#: <pre>mysql -u root -prootpassword hercuser_rodb < main.sql</pre>
#: <pre>mysql -u root -prootpassword hercuser_rodblog < logs.sql</pre>
# If your Control Panel software or website requires it, you may also import the item, monster and monster skill databases (not necessary for the correct operation of Hercules)
#: (pre-renewal)
#: <pre>mysql -u root -prootpassword hercuser_rodb < item_db.sql</pre>
#: <pre>mysql -u root -prootpassword hercuser_rodb < mob_db.sql</pre>
#: <pre>mysql -u root -prootpassword hercuser_rodb < mob_skill_db.sql</pre>
#: (renewal)
#: <pre>mysql -u root -prootpassword hercuser_rodb < item_db_re.sql</pre>
#: <pre>mysql -u root -prootpassword hercuser_rodb < mob_db_re.sql</pre>
#: <pre>mysql -u root -prootpassword hercuser_rodb < mob_skill_db_re.sql</pre>
#: (common to renewal and pre-renewal)
#: <pre>mysql -u root -prootpassword hercuser_rodb < item_db2.sql</pre>
#: <pre>mysql -u root -prootpassword hercuser_rodb < mob_db2.sql</pre>
#: <pre>mysql -u root -prootpassword hercuser_rodb < mob_skill_db2.sql</pre>

NOTE: if you want to use different SQL DBs for login/char/map servers this is the list of databases each server use:
#login-server: global_acc_reg_num_db, global_acc_reg_str_db, ipbanlist, login, loginlog
#map-server: autotrade_data, autotrade_merchants, mapreg, npc_market_data
#char-server: everything else
Note that the sql_updates table is needed by all three servers.

=== [[:Category:Configuration|Configure Hercules]]===

=== Compile Source Code ===
cd Hercules
./configure
make sql

===== How to Recompile =====
In the future (after you update or edit any file in /src) to recompile, add ''make clean'' before make sql:
cd Hercules
./configure
'''make clean'''
make sql

== Start your Hercules Server ==
//change access mode of athena-start file so that you can execute it.
//Use (dos2unix athena-start) if yo uare getting ^M errors ie. newline errors
chmod a+x athena-start

//To Start
./athena-start start
//To Stop
./athena-start stop
//To Restart
./athena-start restart

== See Also ==

[[Category:Installation Guides|CentOS]]

Installation (CentOS)

2016-06-08T13:12:53Z

Dastgirpojee: Undo revision 1138 by Gmclerk (talk)

This guide covers how to install [[Hercules]] on [[wikipedia:CentOS|CentOS]] and other [[wikipedia:List_of_Linux_distributions#RPM-based|versions of Linux]] that use [[wikipedia:Yellowdog_Updater,_Modified|yum]].

== Requirements ==
* [[wikipedia:CentOS|CentOS]] or an [[wikipedia:List_of_Linux_distributions#RPM-based|RPM-based Linux]] that has the '''[[wikipedia:Yellowdog_Updater,_Modified|yum]]''' command
* root access or access to an account that has [[wikipedia:Sudo|sudo privileges]]
* an Internet connection to download install packages

== Prerequisites ==
All of these commands will be typed at the [[wikipedia:Command-line_interface|command-line interface]].
=== Install Prerequisites ===
# Login to your server via [[wikipedia:Secure_Shell|SSH]], or if you are already logged into a [[wikipedia:Graphical_user_interface|GUI]] press Ctrl+Alt+T to open a terminal window.
# Type the following command (this will install GCC, Make, MySQL, MySQL header files, MySQL Server, PCRE header files, Git, and Zlib header files)
#: <pre>yum install gcc make mysql mysql-devel mysql-server pcre-devel git zlib-devel</pre>
# (Optional) type the following command to install some additional packages:
#: <pre>yum -y install dos2unix gdb nano screen unzip wget zip</pre>

=== Create a non-root Linux user ===
By the [[wikipedia:Principle_of_least_privilege|principle of least privilege]], it is recommended you do '''NOT''' run Hercules as root.
# Type the following command to create a non-root Linux account:
#: <pre>useradd --create-home --shell /bin/bash juke</pre>
#: <code>--create-home</code> = create the user's home directory
#: <code>--shell</code> = sets their login shell to [[wikipedia:Bash_(Unix_shell)|Bash]]
#: '''<code>hercules1234</code>''' = the login name of the new Linux account
#: ''<code>1234</code>'' = pick your own random numbers to make the username more unique
# Set a password for the new user (run this command and follow the prompts):
#: <pre>passwd juke</pre>

=== Configure MySQL ===

==== Set a root password ====
The default MySQL Server install creates a MySQL user 'root'@'localhost' with NO password. It is recommended you create a password for the root user.
# Run this command and follow the prompts:
#: Firest Start MySQL:
#: <pre>/etc/init.d/mysqld start </pre>
#: Then configure MySQL by:
#: <pre>mysql_secure_installation</pre>
# Login to your MySQL Server as root:
#: ''When prompted, enter your root MySQL password.''
#: <pre>mysql --user=root -p</pre>
# Now your prompt should look like this (the MySQL command prompt):
#: <pre>mysql> </pre>

==== Create SQL database for Hercules ====
# At the MySQL prompt, type this to [http://dev.mysql.com/doc/refman/5.5/en/create-database.html create a database] (replace <code>hercules1234</code> with the Linux username you created earlier):
#: <pre>mysql> CREATE DATABASE hercules1234_rag;</pre>
# Create a separate database for logs:
#: <pre>mysql> CREATE DATABASE hercules1234_log;</pre>

==== Setup a MySQL user for Hercules ====
# At the MySQL prompt, type something like this to create a new MySQL user:
#: <pre>mysql> CREATE USER 'juke'@'localhost' IDENTIFIED BY 'Masgercey123';</pre>
#: <code>hercules1234</code> = the name of the MySQL user (we named it the same as the Linux user to make it easier to identify)
#: <code>localhost</code> = the hostname or IP it will connect from
#: '''<code>secretpassword</code>''' = the password for this MySQL user
# [http://dev.mysql.com/doc/refman/5.5/en/grant.html Grant privileges] to the 'hercules' MySQL user:
#: <pre>mysql> GRANT SELECT,INSERT,UPDATE,DELETE ON `juke\_rag`.* TO 'juke'@'localhost';</pre>
#: <pre>mysql> GRANT SELECT,INSERT ON `juke\_log`.* TO 'juke'@'localhost';</pre> (note the [http://dev.mysql.com/doc/refman/5.5/en/string-literals.html#character-escape-sequences escaped underscore])

== Install [[Hercules]] ==

=== Login as your non-root Linux user ===
The rest of the setup is done as hercules1234 (the Linux user you created in step 2.2)
# Logout from root SSH (or minimize the window).
# Login to your server via SSH as the hercules1234 Linux user.

=== Git Clone ===
{{:Git Clone/Unix}}

=== [http://dev.mysql.com/doc/refman/5.5/en/batch-commands.html Import] MySQL Tables ===
# Change directory to the '''sql-files''' folder.
#: <pre>cd sql-files/</pre>
# Execute these commands:
#: ''When prompted, enter your MySQL root password.''
#: <pre>mysql -u root -prootpassword hercuser_rodb < main.sql</pre>
#: <pre>mysql -u root -prootpassword hercuser_rodblog < logs.sql</pre>
# If your Control Panel software or website requires it, you may also import the item, monster and monster skill databases (not necessary for the correct operation of Hercules)
#: (pre-renewal)
#: <pre>mysql -u root -prootpassword hercuser_rodb < item_db.sql</pre>
#: <pre>mysql -u root -prootpassword hercuser_rodb < mob_db.sql</pre>
#: <pre>mysql -u root -prootpassword hercuser_rodb < mob_skill_db.sql</pre>
#: (renewal)
#: <pre>mysql -u root -prootpassword hercuser_rodb < item_db_re.sql</pre>
#: <pre>mysql -u root -prootpassword hercuser_rodb < mob_db_re.sql</pre>
#: <pre>mysql -u root -prootpassword hercuser_rodb < mob_skill_db_re.sql</pre>
#: (common to renewal and pre-renewal)
#: <pre>mysql -u root -prootpassword hercuser_rodb < item_db2.sql</pre>
#: <pre>mysql -u root -prootpassword hercuser_rodb < mob_db2.sql</pre>
#: <pre>mysql -u root -prootpassword hercuser_rodb < mob_skill_db2.sql</pre>

NOTE: if you want to use different SQL DBs for login/char/map servers this is the list of databases each server use:
#login-server: global_acc_reg_num_db, global_acc_reg_str_db, ipbanlist, login, loginlog
#map-server: autotrade_data, autotrade_merchants, mapreg, npc_market_data
#char-server: everything else
Note that the sql_updates table is needed by all three servers.

=== [[:Category:Configuration|Configure Hercules]]===

=== Compile Source Code ===
cd Hercules
./configure
make sql

===== How to Recompile =====
In the future (after you update or edit any file in /src) to recompile, add ''make clean'' before make sql:
cd Hercules
./configure
'''make clean'''
make sql

== Start your Hercules Server ==
//change access mode of athena-start file so that you can execute it.
//Use (dos2unix athena-start) if yo uare getting ^M errors ie. newline errors
chmod a+x athena-start

//To Start
./athena-start start
//To Stop
./athena-start stop
//To Restart
./athena-start restart

== See Also ==

[[Category:Installation Guides|CentOS]]

Installation (CentOS)

2016-06-08T13:12:41Z

Dastgirpojee: Undo revision 1139 by Gmclerk (talk)

This guide covers how to install [[Hercules]] on [[wikipedia:CentOS|CentOS]] and other [[wikipedia:List_of_Linux_distributions#RPM-based|versions of Linux]] that use [[wikipedia:Yellowdog_Updater,_Modified|yum]].

== Requirements ==
* [[wikipedia:CentOS|CentOS]] or an [[wikipedia:List_of_Linux_distributions#RPM-based|RPM-based Linux]] that has the '''[[wikipedia:Yellowdog_Updater,_Modified|yum]]''' command
* root access or access to an account that has [[wikipedia:Sudo|sudo privileges]]
* an Internet connection to download install packages

== Prerequisites ==
All of these commands will be typed at the [[wikipedia:Command-line_interface|command-line interface]].
=== Install Prerequisites ===
# Login to your server via [[wikipedia:Secure_Shell|SSH]], or if you are already logged into a [[wikipedia:Graphical_user_interface|GUI]] press Ctrl+Alt+T to open a terminal window.
# Type the following command (this will install GCC, Make, MySQL, MySQL header files, MySQL Server, PCRE header files, Git, and Zlib header files)
#: <pre>yum install gcc make mysql mysql-devel mysql-server pcre-devel git zlib-devel</pre>
# (Optional) type the following command to install some additional packages:
#: <pre>yum -y install dos2unix gdb nano screen unzip wget zip</pre>

=== Create a non-root Linux user ===
By the [[wikipedia:Principle_of_least_privilege|principle of least privilege]], it is recommended you do '''NOT''' run Hercules as root.
# Type the following command to create a non-root Linux account:
#: <pre>useradd --create-home --shell /bin/bash juke</pre>
#: <code>--create-home</code> = create the user's home directory
#: <code>--shell</code> = sets their login shell to [[wikipedia:Bash_(Unix_shell)|Bash]]
#: '''<code>hercules1234</code>''' = the login name of the new Linux account
#: ''<code>1234</code>'' = pick your own random numbers to make the username more unique
# Set a password for the new user (run this command and follow the prompts):
#: <pre>passwd juke</pre>

=== Configure MySQL ===

==== Set a root password ====
The default MySQL Server install creates a MySQL user 'root'@'localhost' with NO password. It is recommended you create a password for the root user.
# Run this command and follow the prompts:
#: Firest Start MySQL:
#: <pre>/etc/init.d/mysqld start </pre>
#: Then configure MySQL by:
#: <pre>mysql_secure_installation</pre>
# Login to your MySQL Server as root:
#: ''When prompted, enter your root MySQL password.''
#: <pre>mysql --user=root -p</pre>
# Now your prompt should look like this (the MySQL command prompt):
#: <pre>mysql> </pre>

==== Create SQL database for Hercules ====
# At the MySQL prompt, type this to [http://dev.mysql.com/doc/refman/5.5/en/create-database.html create a database] (replace <code>hercules1234</code> with the Linux username you created earlier):
#: <pre>mysql> CREATE DATABASE juke_rag;</pre>
# Create a separate database for logs:
#: <pre>mysql> CREATE DATABASE juke_log;</pre>

==== Setup a MySQL user for Hercules ====
# At the MySQL prompt, type something like this to create a new MySQL user:
#: <pre>mysql> CREATE USER 'hercules1234'@'localhost' IDENTIFIED BY 'secretpassword';</pre>
#: <code>hercules1234</code> = the name of the MySQL user (we named it the same as the Linux user to make it easier to identify)
#: <code>localhost</code> = the hostname or IP it will connect from
#: '''<code>secretpassword</code>''' = the password for this MySQL user
# [http://dev.mysql.com/doc/refman/5.5/en/grant.html Grant privileges] to the 'hercules' MySQL user:
#: <pre>mysql> GRANT SELECT,INSERT,UPDATE,DELETE ON `hercules1234\_rag`.* TO 'hercules1234'@'localhost';</pre>
#: <pre>mysql> GRANT SELECT,INSERT ON `hercules1234\_log`.* TO 'hercules1234'@'localhost';</pre> (note the [http://dev.mysql.com/doc/refman/5.5/en/string-literals.html#character-escape-sequences escaped underscore])

== Install [[Hercules]] ==

=== Login as your non-root Linux user ===
The rest of the setup is done as hercules1234 (the Linux user you created in step 2.2)
# Logout from root SSH (or minimize the window).
# Login to your server via SSH as the hercules1234 Linux user.

=== Git Clone ===
{{:Git Clone/Unix}}

=== [http://dev.mysql.com/doc/refman/5.5/en/batch-commands.html Import] MySQL Tables ===
# Change directory to the '''sql-files''' folder.
#: <pre>cd sql-files/</pre>
# Execute these commands:
#: ''When prompted, enter your MySQL root password.''
#: <pre>mysql -u root -prootpassword hercuser_rodb < main.sql</pre>
#: <pre>mysql -u root -prootpassword hercuser_rodblog < logs.sql</pre>
# If your Control Panel software or website requires it, you may also import the item, monster and monster skill databases (not necessary for the correct operation of Hercules)
#: (pre-renewal)
#: <pre>mysql -u root -prootpassword hercuser_rodb < item_db.sql</pre>
#: <pre>mysql -u root -prootpassword hercuser_rodb < mob_db.sql</pre>
#: <pre>mysql -u root -prootpassword hercuser_rodb < mob_skill_db.sql</pre>
#: (renewal)
#: <pre>mysql -u root -prootpassword hercuser_rodb < item_db_re.sql</pre>
#: <pre>mysql -u root -prootpassword hercuser_rodb < mob_db_re.sql</pre>
#: <pre>mysql -u root -prootpassword hercuser_rodb < mob_skill_db_re.sql</pre>
#: (common to renewal and pre-renewal)
#: <pre>mysql -u root -prootpassword hercuser_rodb < item_db2.sql</pre>
#: <pre>mysql -u root -prootpassword hercuser_rodb < mob_db2.sql</pre>
#: <pre>mysql -u root -prootpassword hercuser_rodb < mob_skill_db2.sql</pre>

NOTE: if you want to use different SQL DBs for login/char/map servers this is the list of databases each server use:
#login-server: global_acc_reg_num_db, global_acc_reg_str_db, ipbanlist, login, loginlog
#map-server: autotrade_data, autotrade_merchants, mapreg, npc_market_data
#char-server: everything else
Note that the sql_updates table is needed by all three servers.

=== [[:Category:Configuration|Configure Hercules]]===

=== Compile Source Code ===
cd Hercules
./configure
make sql

===== How to Recompile =====
In the future (after you update or edit any file in /src) to recompile, add ''make clean'' before make sql:
cd Hercules
./configure
'''make clean'''
make sql

== Start your Hercules Server ==
//change access mode of athena-start file so that you can execute it.
//Use (dos2unix athena-start) if yo uare getting ^M errors ie. newline errors
chmod a+x athena-start

//To Start
./athena-start start
//To Stop
./athena-start stop
//To Restart
./athena-start restart

== See Also ==

[[Category:Installation Guides|CentOS]]

Installation (CentOS)

2016-06-08T13:11:10Z

Dastgirpojee: Undo revision 1140 by Gmclerk (talk)

This guide covers how to install [[Hercules]] on [[wikipedia:CentOS|CentOS]] and other [[wikipedia:List_of_Linux_distributions#RPM-based|versions of Linux]] that use [[wikipedia:Yellowdog_Updater,_Modified|yum]].

== Requirements ==
* [[wikipedia:CentOS|CentOS]] or an [[wikipedia:List_of_Linux_distributions#RPM-based|RPM-based Linux]] that has the '''[[wikipedia:Yellowdog_Updater,_Modified|yum]]''' command
* root access or access to an account that has [[wikipedia:Sudo|sudo privileges]]
* an Internet connection to download install packages

== Prerequisites ==
All of these commands will be typed at the [[wikipedia:Command-line_interface|command-line interface]].
=== Install Prerequisites ===
# Login to your server via [[wikipedia:Secure_Shell|SSH]], or if you are already logged into a [[wikipedia:Graphical_user_interface|GUI]] press Ctrl+Alt+T to open a terminal window.
# Type the following command (this will install GCC, Make, MySQL, MySQL header files, MySQL Server, PCRE header files, Git, and Zlib header files)
#: <pre>yum install gcc make mysql mysql-devel mysql-server pcre-devel git zlib-devel</pre>
# (Optional) type the following command to install some additional packages:
#: <pre>yum -y install dos2unix gdb nano screen unzip wget zip</pre>

=== Create a non-root Linux user ===
By the [[wikipedia:Principle_of_least_privilege|principle of least privilege]], it is recommended you do '''NOT''' run Hercules as root.
# Type the following command to create a non-root Linux account:
#: <pre>useradd --create-home --shell /bin/bash juke</pre>
#: <code>--create-home</code> = create the user's home directory
#: <code>--shell</code> = sets their login shell to [[wikipedia:Bash_(Unix_shell)|Bash]]
#: '''<code>hercules1234</code>''' = the login name of the new Linux account
#: ''<code>1234</code>'' = pick your own random numbers to make the username more unique
# Set a password for the new user (run this command and follow the prompts):
#: <pre>passwd juke</pre>

=== Configure MySQL ===

==== Set a root password ====
The default MySQL Server install creates a MySQL user 'root'@'localhost' with NO password. It is recommended you create a password for the root user.
# Run this command and follow the prompts:
#: Firest Start MySQL:
#: <pre>/etc/init.d/mysqld start </pre>
#: Then configure MySQL by:
#: <pre>mysql_secure_installation</pre>
# Login to your MySQL Server as root:
#: ''When prompted, enter your root MySQL password.''
#: <pre>mysql --user=root -p</pre>
# Now your prompt should look like this (the MySQL command prompt):
#: <pre>mysql> </pre>

==== Create SQL database for Hercules ====
# At the MySQL prompt, type this to [http://dev.mysql.com/doc/refman/5.5/en/create-database.html create a database] (replace <code>hercules1234</code> with the Linux username you created earlier):
#: <pre>mysql> CREATE DATABASE juke_rag;</pre>
# Create a separate database for logs:
#: <pre>mysql> CREATE DATABASE juke_log;</pre>

==== Setup a MySQL user for Hercules ====
# At the MySQL prompt, type something like this to create a new MySQL user:
#: <pre>mysql> CREATE USER 'juke'@'localhost' IDENTIFIED BY 'Masgercey123';</pre>
#: <code>hercules1234</code> = the name of the MySQL user (we named it the same as the Linux user to make it easier to identify)
#: <code>localhost</code> = the hostname or IP it will connect from
#: '''<code>secretpassword</code>''' = the password for this MySQL user
# [http://dev.mysql.com/doc/refman/5.5/en/grant.html Grant privileges] to the 'hercules' MySQL user:
#: <pre>mysql> GRANT SELECT,INSERT,UPDATE,DELETE ON `juke\_rag`.* TO 'juke'@'localhost';</pre>
#: <pre>mysql> GRANT SELECT,INSERT ON `juke\_log`.* TO 'juke'@'localhost';</pre> (note the [http://dev.mysql.com/doc/refman/5.5/en/string-literals.html#character-escape-sequences escaped underscore])

== Install [[Hercules]] ==

=== Login as your non-root Linux user ===
The rest of the setup is done as hercules1234 (the Linux user you created in step 2.2)
# Logout from root SSH (or minimize the window).
# Login to your server via SSH as the hercules1234 Linux user.

=== Git Clone ===
{{:Git Clone/Unix}}

=== [http://dev.mysql.com/doc/refman/5.5/en/batch-commands.html Import] MySQL Tables ===
# Change directory to the '''sql-files''' folder.
#: <pre>cd sql-files/</pre>
# Execute these commands:
#: ''When prompted, enter your MySQL root password.''
#: <pre>mysql -u root -prootpassword hercuser_rodb < main.sql</pre>
#: <pre>mysql -u root -prootpassword hercuser_rodblog < logs.sql</pre>
# If your Control Panel software or website requires it, you may also import the item, monster and monster skill databases (not necessary for the correct operation of Hercules)
#: (pre-renewal)
#: <pre>mysql -u root -prootpassword hercuser_rodb < item_db.sql</pre>
#: <pre>mysql -u root -prootpassword hercuser_rodb < mob_db.sql</pre>
#: <pre>mysql -u root -prootpassword hercuser_rodb < mob_skill_db.sql</pre>
#: (renewal)
#: <pre>mysql -u root -prootpassword hercuser_rodb < item_db_re.sql</pre>
#: <pre>mysql -u root -prootpassword hercuser_rodb < mob_db_re.sql</pre>
#: <pre>mysql -u root -prootpassword hercuser_rodb < mob_skill_db_re.sql</pre>
#: (common to renewal and pre-renewal)
#: <pre>mysql -u root -prootpassword hercuser_rodb < item_db2.sql</pre>
#: <pre>mysql -u root -prootpassword hercuser_rodb < mob_db2.sql</pre>
#: <pre>mysql -u root -prootpassword hercuser_rodb < mob_skill_db2.sql</pre>

NOTE: if you want to use different SQL DBs for login/char/map servers this is the list of databases each server use:
#login-server: global_acc_reg_num_db, global_acc_reg_str_db, ipbanlist, login, loginlog
#map-server: autotrade_data, autotrade_merchants, mapreg, npc_market_data
#char-server: everything else
Note that the sql_updates table is needed by all three servers.

=== [[:Category:Configuration|Configure Hercules]]===

=== Compile Source Code ===
cd Hercules
./configure
make sql

===== How to Recompile =====
In the future (after you update or edit any file in /src) to recompile, add ''make clean'' before make sql:
cd Hercules
./configure
'''make clean'''
make sql

== Start your Hercules Server ==
//change access mode of athena-start file so that you can execute it.
//Use (dos2unix athena-start) if yo uare getting ^M errors ie. newline errors
chmod a+x athena-start

//To Start
./athena-start start
//To Stop
./athena-start stop
//To Restart
./athena-start restart

== See Also ==

[[Category:Installation Guides|CentOS]]

Building HPM Plugin for MSVC

2015-12-04T09:50:12Z

Dastgirpojee: Reverted edits by Dastgirpojee (talk) to last revision by Annieruru

This is a guide on how to prepare your MSVC environment for a new [[HPM]] plugin.
= Guide =
1. Go to '''src/plugins/''' folder, create a new '''.c''' file, e.g. '''dance.c''' (this name will be used throughout this guide)
[[File:step1.JPG|center|750px]]
2. Open dance.c and paste this code

<pre>
#include <stdio.h>
#include <string.h>
#include "../common/HPMi.h"
#include "../map/script.h"
#include "../map/pc.h"

#include "../common/HPMDataCheck.h" //Should always be the last include file.

HPExport struct hplugin_info pinfo =
{
"@dance", // Plugin name
SERVER_TYPE_MAP,// Which server types this plugin works with?
"0.1a", // Plugin version
HPM_VERSION, // HPM Version (don't change, macro is automatically updated)
};

ACMD(dance)
{

if (!message || !*message) {
clif->message(fd, "usage: @dance 1-9");
return -1;
}
if ( atoi(message) == 1 ) {
clif->specialeffect(&sd->bl, 413, ALL_CLIENT);
} else if ( atoi(message) == 2 ) {
clif->specialeffect(&sd->bl, 414, ALL_CLIENT);
} else if ( atoi(message) == 3 ) {
clif->specialeffect(&sd->bl, 415, ALL_CLIENT);
} else if ( atoi(message) == 4 ) {
clif->specialeffect(&sd->bl, 426, ALL_CLIENT);
} else if ( atoi(message) == 5 ) {
clif->specialeffect(&sd->bl, 458, ALL_CLIENT);
} else if ( atoi(message) == 6 ) {
clif->specialeffect(&sd->bl, 466, ALL_CLIENT);
} else if ( atoi(message) == 7 ) {
clif->specialeffect(&sd->bl, 501, ALL_CLIENT);
} else if ( atoi(message) == 8 ) {
clif->specialeffect(&sd->bl, 540, ALL_CLIENT);
} else if ( atoi(message) == 9 ) {
clif->specialeffect(&sd->bl, 550, ALL_CLIENT);
}
else
{
clif->message(fd, "usage: @dance 1-9");
}
return true;
}

/* Server Startup */
HPExport void plugin_init (void)
{
clif = GET_SYMBOL("clif");
script = GET_SYMBOL("script");
skill = GET_SYMBOL("skill");

addAtcommand("dance",dance);
}
</pre>
3. Open your MSVC project (e.g. '''Hercules-10.sln'')
[[File:step2.JPG|center|750px]]
4. Go to the '''Solution Explorer'''
[[File:step3.JPG|center|750px]]
5. Right click the Hercules project (first item in '''Solution Explorer'''), and click '''Add->New Project'''
[[File:step4.JPG|center|750px]]
6. Select '''General''', and pick '''Empty Project'''.
[[File:step5.JPG|center|750px]]
7. Enter the name of your plugin in the '''Name''' field, and click OK. 

8. In the solution explorer it'll display the new project.
[[File:step6.JPG|center|750px]]
9. Right click the new project, and open '''Add->Existing Item'''
[[File:step7.JPG|center|750px]]
10. Browse to '''src/plugins/''' and select the '''dance.c''' file, and hit OK.
[[File:step8.JPG|center|750px]]
11. It will place the '''dance.c''' file under the '''Source Files''' folder, drag it to the project you created and drop it (in a manner it be placed out of the source files folder.)
[[File:step9.JPG|center|750px]]
(It should look like the image below)
[[File:step10.JPG|center|750px]]
12. With the '''dance.c''' out of the folders, delete the 3 of them (select the 3, hit delete, hit ok)
[[File:step11.JPG|center|750px]]
(It should look like the image below)
[[File:step12.JPG|center|750px]]
13. Right click the project you created, open '''Properties'''
[[File:step13.JPG|center|750px]]
14. Under '''Configuration Properties''' click '''General''', change '''Output Directory''' to '''..\plugins\''', '''Intermediate Directory''' to '''$(ProjectName)\$(ConfigurationName)\''' and '''Configuration Type''' to '''Dynamic Library (.dll)'''
[[File:step14.JPG|center|750px]]
15. Under '''Configuration Properties''' click '''C/C++''' and open '''General''', change '''Additional Include Directories''' to '''..\src;..\3rdparty;..\3rdparty\msinttypes\include;%(AdditionalIncludeDirectories)'''
[[File:step15.JPG|center|750px]]
16. Under '''Configuration Properties''' click '''Linker''' and open '''General''', change '''Output File''' to '''$(OutDir)\$(ProjectName).dll'''
[[File:step16.JPG|center|750px]]
17. Under '''Configuration Properties''' click '''C/C++''' and open '''Preprocessor''', change '''Preprocessor Definitions''' to '''_WINDLL;PCRE_SUPPORT;%(PreprocessorDefinitions)'''
[[File:step17.jpg|center|750px]]
18. Add your code to the '''dance.c''' file, and then right-click the project you created, and select '''Build'''

19. Add it to ''' /conf/plugins.conf'''

<pre>
plugins_list: [
/* Enable HPMHooking when plugins in use rely on Hooking */
//"HPMHooking",
//"db2sql",
//"sample",
//"other",
"dance", // loads dance plugin
]
</pre>

= Notes =
* This guide is probably the worst I've ever written, if you can do better please hit the 'Edit' button, will be most welcome. - Ind
* I used MSVC 2008 when testing this guide.

= New Note =
* Sorry for editing this page, I added step by step images for other people to follow so they can easily follow one of the best feature Hercules have, the HPM. - Thanna
* The tutorial is tested on MSVC 2010.

[[Category:Installation]]

Building HPM Plugin for MSVC

2015-12-04T09:49:18Z

Dastgirpojee: Reverted edits by Annieruru (talk) to last revision by Jolteo

This is a guide on how to prepare your MSVC environment for a new [[HPM]] plugin.
= Guide =
1. Go to '''src/plugins/''' folder, create a new '''.c''' file, e.g. '''dance.c''' (this name will be used throughout this guide)
[[File:step1.JPG|center|750px]]
2. Open dance.c and paste this code

<pre>
#include <stdio.h>
#include <string.h>
#include "../common/HPMi.h"
#include "../map/script.h"
#include "../map/pc.h"

#include "../common/HPMDataCheck.h" //Should always be the last include file.

HPExport struct hplugin_info pinfo =
{
"@dance", // Plugin name
SERVER_TYPE_MAP,// Which server types this plugin works with?
"0.1a", // Plugin version
HPM_VERSION, // HPM Version (don't change, macro is automatically updated)
};

ACMD(dance)
{

if (!message || !*message) {
clif->message(fd, "usage: @dance 1-9");
return -1;
}
if ( atoi(message) == 1 ) {
clif->specialeffect(&sd->bl, 413, ALL_CLIENT);
} else if ( atoi(message) == 2 ) {
clif->specialeffect(&sd->bl, 414, ALL_CLIENT);
} else if ( atoi(message) == 3 ) {
clif->specialeffect(&sd->bl, 415, ALL_CLIENT);
} else if ( atoi(message) == 4 ) {
clif->specialeffect(&sd->bl, 426, ALL_CLIENT);
} else if ( atoi(message) == 5 ) {
clif->specialeffect(&sd->bl, 458, ALL_CLIENT);
} else if ( atoi(message) == 6 ) {
clif->specialeffect(&sd->bl, 466, ALL_CLIENT);
} else if ( atoi(message) == 7 ) {
clif->specialeffect(&sd->bl, 501, ALL_CLIENT);
} else if ( atoi(message) == 8 ) {
clif->specialeffect(&sd->bl, 540, ALL_CLIENT);
} else if ( atoi(message) == 9 ) {
clif->specialeffect(&sd->bl, 550, ALL_CLIENT);
}
else
{
clif->message(fd, "usage: @dance 1-9");
}
return true;
}

/* Server Startup */
HPExport void plugin_init (void)
{
clif = GET_SYMBOL("clif");
script = GET_SYMBOL("script");
skill = GET_SYMBOL("skill");

addAtcommand("dance",dance);
}
</pre>
3. Open your MSVC project (e.g. '''Hercules-10.sln'')
[[File:step2.JPG|center|750px]]
4. Go to the '''Solution Explorer'''
[[File:step3.JPG|center|750px]]
5. Right click the Hercules project (first item in '''Solution Explorer'''), and click '''Add->New Project'''
[[File:step4.JPG|center|750px]]
6. Select '''General''', and pick '''Empty Project'''.
[[File:step5.JPG|center|750px]]
7. Enter the name of your plugin in the '''Name''' field, and click OK. 

8. In the solution explorer it'll display the new project.
[[File:step6.JPG|center|750px]]
9. Right click the new project, and open '''Add->Existing Item'''
[[File:step7.JPG|center|750px]]
10. Browse to '''src/plugins/''' and select the '''dance.c''' file, and hit OK.
[[File:step8.JPG|center|750px]]
11. It will place the '''dance.c''' file under the '''Source Files''' folder, drag it to the project you created and drop it (in a manner it be placed out of the source files folder.)
[[File:step9.JPG|center|750px]]
(It should look like the image below)
[[File:step10.JPG|center|750px]]
12. With the '''dance.c''' out of the folders, delete the 3 of them (select the 3, hit delete, hit ok)
[[File:step11.JPG|center|750px]]
(It should look like the image below)
[[File:step12.JPG|center|750px]]
13. Right click the project you created, open '''Properties'''
[[File:step13.JPG|center|750px]]
14. Under '''Configuration Properties''' click '''General''', change '''Output Directory''' to '''..\plugins\''', '''Intermediate Directory''' to '''$(ProjectName)\$(ConfigurationName)\''' and '''Configuration Type''' to '''Dynamic Library (.dll)'''
[[File:step14.JPG|center|750px]]
15. Under '''Configuration Properties''' click '''C/C++''' and open '''General''', change '''Additional Include Directories''' to '''..\src;..\3rdparty;..\3rdparty\msinttypes\include;%(AdditionalIncludeDirectories)'''
[[File:step15.JPG|center|750px]]
16. Under '''Configuration Properties''' click '''Linker''' and open '''General''', change '''Output File''' to '''$(OutDir)\PluginName.dll''' (TargetName is the name of the project)
[[File:step16.JPG|center|750px]]
17. Add your code to the '''dance.c''' file, and then right-click the project you created, and select '''Build'''

18. Add it to ''' /conf/plugins.conf'''

<pre>
plugins_list: [
/* Enable HPMHooking when plugins in use rely on Hooking */
//"HPMHooking",
//"db2sql",
//"sample",
//"other",
"dance", // loads dance plugin
]
</pre>

= Notes =
* This guide is probably the worst I've ever written, if you can do better please hit the 'Edit' button, will be most welcome. - Ind
* I used MSVC 2008 when testing this guide.

= New Note =
* Sorry for editing this page, I added step by step images for other people to follow so they can easily follow one of the best feature Hercules have, the HPM. - Thanna
* The tutorial is tested on MSVC 2010.

[[Category:Installation]]

Custom Mobs

2015-11-05T14:45:04Z

Dastgirpojee: /* Database Structure */

= Intro =
You can have up to 10,000 mob IDs. This guide was written without testing on Git; use at your own discretion.
Well, its pretty easy if you do it correctly and go step by step without rushing.

= Gettings Started =
== Database Structure ==
Let's take a look at the structure of the entries in mob_db.conf:

Note: If you're adding custom mobs, it's better to add them to mob_db2.conf

<pre>
{
// =================== Mandatory fields ===============================
Id: ID (int)
SpriteName: "SPRITE_NAME" (string)
Name: "Mob name" (string)
// =================== Optional fields ================================
Lv: level (int, defaults to 1)
Hp: health (int, defaults to 1)
Sp: mana (int, defaults to 0)
Exp: basic experience (int, defaults to 0)
JExp: job experience (int, defaults to 0)
AttackRange: attack range (int, defaults to 1)
Attack: [attack1, attack2] (int, defaults to 0)
Def: defence (int, defaults to 0)
Mdef: magic defence (int, defaults to 0)
Stats: {
Str: strength (int, defaults to 0)
Agi: agility (int, defaults to 0)
Vit: vitality (int, defaults to 0)
Int: intelligence (int, defaults to 0)
Dex: dexterity (int, defaults to 0)
Luk: luck (int, defaults to 0)
}
ViewRange: view range (int, defaults to 1)
ChaseRange: chase range (int, defaults to 1)
Size: size (int, defaults to 1)
Race: race (int, defaults to 0)
Element: (type, level)
Mode: {
CanMove: true/false (bool)
Looter: true/false (bool)
Aggressive: true/false (bool)
Assist: true/false (bool)
CastSensorIdle:true/false (bool)
Boss: true/false (bool)
Plant: true/false (bool)
CanAttack: true/false (bool)
Detector: true/false (bool)
CastSensorChase: true/false (bool)
ChangeChase: true/false (bool)
Angry: true/false (bool)
ChangeTargetMelee: true/false (bool)
ChangeTargetChase: true/false (bool)
TargetWeak: true/false (bool)
}
MoveSpeed: move speed (int, defaults to 0)
AttackDelay: attack delay (int, defaults to 4000)
AttackMotion: attack motion (int, defaults to 2000)
DamageMotion: damage motion (int, defaults to 0)
MvpExp: mvp experience (int, defaults to 0)
MvpDrops: {
AegisName: chance (string: int)
...
}
Drops: {
AegisName: chance (string: int)
...
}

},
</pre>

{| class="wikitable"
|-
! Fields !! Description
|-
| '''Id''' || ID of the mob
|-
| '''SpriteName''' || This first name is the DB name. When you use @spawn/@summon and you know the name of the mob, but not the ID, type this name instead. Try making the normal name the same as this so you wont get confused.
|-
| '''Name''' || This is the name the server shows.
|-
| '''Lv''' || Level of the mob
|-
| '''Hp''' || HP of the mob
|-
| '''Sp''' || SP of the mob
|-
| '''Exp''' || Exp granted by the mob
|-
| '''JExp''' || Job exp granted by the mob
|-
| '''AttackRange''' || Range of the mob attack. If set to 1 or 2, it will melee. 3 or more than 3 will set it to ranged
|-
| '''Attack1''' || Affects ATK of the mob
|-
| '''Attack2''' || Affects MATK of the mob
|-
| '''Def''' || Defense of the mob (Tip: 100 def = Invulnerability below 8K attack. Watch out, only melee/ranged attacks, but generally direct hits attacks are drastically reduced. Setting this high enough may make monks pretty cheap to level because of of Psychic Wave/Occult Impact/Investigate.)
|-
| '''MDef''' || Magic Defense of the mob (Hint: 100 mdef = golden thief bug effect below 9K magic attack. It's for all magic-using skills.)
|-
| '''Stats''' || All Stats of mobs belongs to this block.
{| class="wikitable"
|-
! Stats !! Description
|-
| '''Str''' || Strength of the mob. This also affects its ATK.
|-
| '''Agi''' || Agility of the mob. This also affects the mob flee rate.
|-
| '''Vit''' || Vitality of the mob. This affects the duration of stun status.
|-
| '''Int''' || Intelligence of the mob. This also affects its MATK.
|-
| '''Dex''' || Dexterity of the mob. This also affects the mob hit rate.
|-
| '''Luk''' || Luck of the mob. This also defines the mob perfect dodge/lucky flee/perfect flee/lucky dodge rate.
|}
|-
| '''ViewRange''' || Maximum Skill Range
|-
| '''ChaseRange''' || Sight limit for mobs. If set to 1000 or beyond, mobs will follow you all over the map.
|-
| '''Size''' || 0 if its Small, 1 if its Medium, 2 if its Large
|-
| '''Race''' || 0=formless, 1=undead, 2=animal, 3=plant, 4=insect, 5=fish, 6=demon, 7=demihuman, 8=angel, 9=dragon.
|-
| '''Element''' || This is a two-digit number representing the rank (level) and element of the mob. 
|-
| '''Element(Type)''' || Element Type of mob as mentioned below. 
{| class="wikitable" style="text-align: center;"
|
|Neutral
|Water
|Earth
|Fire
|Wind
|Poison
|Holy
|Shadow
|Ghost
|Undead
|-
| Type
|0
|1
|2
|3
|4
|5
|6
|7
|8
|9
|}

|-
| '''Element(Level)''' || Element level of mob from (1-4). 
|-
| '''Mode''' || This defines the mob behaves.
|-
| '''MoveSpeed''' || Walking speed of the mob. 1 is the fastest, 1000 is the lowest. 100 is the normal walking speed.
|-
| '''AttackDelay''' || ADelay= Attack Delay, also known as ASPD. This one will change the aspd of the mob. The lower the faster, but don't make it too low or it will lag when mobbed by several of these.
|-
| '''AttackMotion''' || Attack animation motion. Lower this value and the mob's attack will be displayed in higher fps (making it shorter, too) (Thanks to Wallex for this)
|-
| '''DamageMotion''' || Damage animation motion, same as aMotion but used to display the "I am hit" animation. Coincidentally, this same value is used to determine how long it is before the mob/player can move again. Endure is dMotion = 0, obviously.
|-
| '''MvpExp''' || The MVP exp the mob gives when it is defeated (to the player who got the MVP reward) (This exp is a percentage of the exp the monster gives.)
|-
The following fields are for drops and drop rates. Remember that these are in percentages; i.e. 100 = 100%
|-
| '''MvpDrops''' || The MvP Drops goes here, format is:
<pre>AegisName: Chance</pre>
Example:
<pre>Poring_Card: 1000</pre>
|-
| '''Drops''' || The Normal Drops goes here, format is:
<pre>AegisName: Chance</pre>
Example:
<pre>Poring_Card: 1000</pre>
|}

== Making it visible ==
=== Server Side ===
If you've got a sprite and you're happy with it, then you can skip this part. If you would like to make your mob look like another mob, or even a player, then you need to take a look at {{git|db/mob_avail.txt|full}}

For normal mobs, you can use the data that's already in the file as an example to work on:
// mob_id,sprite_id,equip #
// iRO Halloween Event 2008
//3000,1015,0
//3001,1036,0
//3002,1298,0

// iRO Halloween Event 2009
//3014,1179,0
//3015,1272,0

However, if you would like to make your mob look like a character, you need to add more options: 
// Valaris
{| class="wikitable"
|-
| MobID || SpriteID || Sex || Hair || Hair_Color || Weapon || Shield || Head_Top || Head_Middle || Head_Bottom || Option || Dye_Color
|-
| 1900, || 4013, || 1, || 1, || 1, || 1254, || 0, || 67, || 12, || 54, || 16, || 1
|}
You will need to use the Item ID for your mob's weapon and shield instead of the View ID of the item. Doing so may have undesirable effects.

A more in-depth look at each value: 
 '''MobID''': This is your mob ID.
 '''SpriteID''': The Job number you want it to look like. They are:
<pre>Job_Novice 0
Job_Swordman 1
Job_Mage 2
Job_Archer 3
Job_Acolyte 4
Job_Merchant 5
Job_Thief 6
Job_Knight 7
Job_Priest 8
Job_Wizard 9
Job_Blacksmith 10
etc</pre>
They can also be found on {{git|db/const.txt}} file.

 '''Sex''': 0 for female, 1 for male
 '''Hair''': The mob hair style, goes from 1 to 23
 '''Hair_Color''': The mob hair color. Goes from 0 to 8 or 10, but it depends on the server's palette files.
 '''Weapon''':The ID of the Weapon you want. See [[Custom_weapons|Custom Weapons]] for it. Also read at the end of the pre if you cant find the headgear you want.
 '''Shield''': Same as above
 '''Head_Top''': Same as above
 '''Head_Middle''': Same as above
 '''Head_Bottom''': Same as above
 '''Option''': this option parameter will make the mob change its status, as well as give them carts, pecopecos, and falcons. In other words, this will change the visual effects of your mobs. The options are these*:
<pre>
1 Sight 32 Peco Peco riding 2048 Orc Head
2 Hide 64 GM Perfect Hide 4096 Wedding Sprites
4 Cloak 128 Level 2 Cart 8192 Ruwach
8 Level 1 Cart 256 Level 3 Cart
16 Falcon 512 Level 4 Cart
1024 Level 5 Cart
</pre>

 '''Dye_Color''': Same as hair color. It goes from 0 to 77

=== Client Side ===
For your mob to exist in the client, you need to add it to a few [[Lua]] files.
==== datainfo/npcidentity.lua ====
Example at the end of the file: 
["JT_4_F_TAEKWON"] = 644,
["JT_4_F_SWORDMAN"] = 645,
-- Custom Mobs
["JT_JACOB"] = 2500,
["JT_AQUARING"] = 2600
}
The number after the = sign denotes the mob's database ID number. Other sprites in this file have their view ID e.g. [[Adding_a_Script#Client_Side|NPC sprite number]].

==== datainfo/jobname.lua ====
Example at the end of the file: 
[jobtbl.JT_GIBBET] = "GIBBET",
[jobtbl.JT_DULLAHAN] = "DULLAHAN",
[jobtbl.JT_LOLI_RURI] = "LOLI_RURI",
[jobtbl.JT_DISGUISE] = "DISGUISE",
-- Custom Mobs
[jobtbl.JT_JACOB] = "jacobmob",
[jobtbl.JT_AQUARING] = "aquaring"
}
In this file, the value after the = sign is the name of the actual sprite in your data folder/[[GRF]]

== Your mob in other files ==
=== Dead Branch ===
Adding your mob to {{git|db/pre-re/mob_branch.txt}} or {{git|db/re/mob_branch.txt}} will allow Dead Branches to summon it.

=== Bloody Branch ===
Adding your mob to {{git|db/pre-re/mob_boss.txt}} or {{git|db/re/mob_boss.txt}} will allow Bloody Branches to summon it.

=== Poring Box ===
Adding your mob to {{git|db/pre-re/mob_poring.txt}} or {{git|db/re/mob_poring.txt}} will make your mob spawnable via the Poring Box.

=== Monster Racial Groups ===
Adding your mob to {{git|db/pre-re/mob_race2_db.txt}} or {{git|db/re/mob_race2_db.txt}} will add your mob to a [[Racial_Group|Racial Group]]. Guardians, Goblins and other mobs are members of particular Racial Groups.

=== Red Pouch of Surprise ===
Adding your mob to {{git|db/mob_pouch.txt}} will make your mob spawnable via the Red Pouch of Surprise.

== Spawn Points ==
Let's look at the syntax of a mob spawn point:

<pre>
<map name>,<x1>,<y1>,<x2>,<y2>%TAB%monster%TAB%<monster name>%TAB%<mob id>,<amount>,<delay1>,<delay2>,<event>{,<mob size>,<mob ai>}
</pre>

Only the things between <> are changed. Do not remove or change monster after the coordinates, because that's what tells the server that this line is a monster spawn script.

 '''map name''': Name of the map. Use /where along with the following coordinates
 '''x1''': X axis coordinates. It start from the left side of the map, and the higher it gets, the more it gets closer to the right side of the map.
 '''y1''': Y axis coordinates. It start from the bottom, and the higher it gets, the more it gets closer to the top of the map.
 '''x2''': X axis coordinates. It start from the left side of the map, and the higher it gets, the more it gets closer to the right side of the map.
 '''y2''': Y axis coordinates. It start from the bottom, and the higher it gets, the more it gets closer to the top of the map.
 These 4 coordinates will make a spawn area where the mob will spawn, however it won't limit its movement, so lets say you put 120,150 on the first pair, and 130,160 pair- That's a 10x10 cell area where the mob will spawn randomly.
 If you want the mob to spawn at a random point, use 0 for all the coordinates.
 '''monster name''': The name of the mob you want to be shown (using --ja-- in place of a name will display the "Japanese Name" from your database).
 You can specify a custom level to use for the mob different from the one of the database by adjoining the level after the name with a comma. eg: "Poring,50" for a name will spawn a monster with name Poring and level 50.
 '''mob id''': The ID of your mob.
 '''amount''': How many mobs you want to be spawned.
 '''delay1''': Minimum amount of time before a monster respawns.
 '''delay2''': Maximum amount of time before a monster respawns.
 delay1 and delay2 are used to define the time it takes for a monster to respawn; in milliseconds. Normal mobs usually have 0 (Instant Respawn), while MVPs have 7200000 (2 hours). If delay2 is greater than delay 1, the mob won't respawn until the map server restarts.
 '''event''': Script event to be executed when the mob is killed. The event must be in the form "NPCName::OnEventName" to execute, and the event name label should start with "On". As with all events, if the NPC is an on-touch NPC, the player who triggers the script must be within 'trigger' range for the event to work.
 '''size''': Optional. Size can be 0 (medium), 1 (small), or 2 (big).
 '''ai''': Optional. AI can be 0 (default), 1 (attack/friendly), 2 (sphere), 3 (flora), or 4 (zanzou).

== Adding Skills ==

Lets look at the syntax of a mob skill:

<pre>
MOB_ID, a unused dummy character sequence (for information only), STATE, SKILL_ID, SKILL_LV,
rate (10000 = 100%), casttime, delay, cancelable, a target, a condition type, a condition value,
a value 1, a value 2, a value 3, a value 4, a value 5, emotion
</pre>

 '''''
NOTE: I had to cut the mob_avail structure so it could fit.
It's a whole line, not 3 lines.
'''''

 '''MOD_ID''': your mob ID.
 '''an unused.. etc etc''': you can put any text here you want, its just for information and to know what does this do.* tip tip*You will see inside this file things like Poring@TF_POISON. Well, you could use this too. It would tell you: mob_name@DB_Skill_Name. *tip tip*
 '''state''': this is the state that the mob must accomplish before being able to use this skill. The states are:

<pre>
any, idle (in standby), walk (in movement), attack, dead (on killed), loot, chase (following target),
counterattack.
</pre>

 '''SKILL_ID''': The ID of the skill goes here. To look for one, go to your db folder and open the skill_db.txt file. You will see a lot of lines like this one:

<pre>2,0,0,0,0,0,10,0,no,0,0,0,weapon,0 //SM_SWORD#Œ•C—û#</pre>

And the syntax is:

<pre>
id,range,hit,inf,pl,nk,max,list_num,castcancel,cast_defence_rate,inf2,maxcount,skill_type,blow_count
</pre>

so, the ID of the SM_SWORD, which is the Swordman's Sword Mastery by the way, is 2:

<pre>'''2''',0,0,0,0,0,10,0,no,0,0,0,weapon,0 //SM_SWORD#Œ•C—û#</pre>

 '''SKILL_LV''': You can put the skill level as high as you want. Though, 100 is usually as far as most skills go.
 '''rate''': How frequent will the mob use the skill.
 '''casttime''': Skill's cast time.
 '''delay''': How much time must pass before the skill can be used again, in milliseconds.
 '''cancelable''': if the skill cast can be interrupted. Set it either '''yes''' or '''no'''.
 '''a target''': the target of the skill. It can be:
<pre>
target (player), self (the mob itself), friend (slaves)
</pre>

 '''a condition type''':a condition that also must be fulfilled before the mob is able to use this skill. There are two kinds of conditions:

1. Mob Condition:
<pre>//conditions: (condition type) (value which specifies a condition value)
// always unconditional
// myhpltmaxrate when the mob's hp drops to a certain %
// mystatuson If the mob has any abnormalities in status (condition value),
// mystatusoff If the mob has ended any abnormalities in status (condition value),
// friendhpltmaxrate when the mobs' friend's hp drops to a certain %
// friendstatuson If the friend has any abnormalities in status (condition value),
// friendstatusoff If the friend has ended any abnormalities in status (condition value),
// attackpcgt Attack PC becomes more than the number of specification
// attackpcge Attack PC becomes equal or more than the number of specification.
// slavelt when the number of slaves is lower than the original number of specification.
// slavele when the number of slaves is lower or equal than the original number of specification.
// closedattacked when melee attacked (close range attack)
// longrangeattacked when long ranged attacked (like bows and far range weapons)
// skillused when a skill is used on the mob
// casttargeted when a target is in cast range.
// rudeattacked when a target is rude attacked
// hiding when a target is hidden *not implemented yet*
</pre>

2. Target Conditions
<pre>
// The character's state which can be specified to be a condition value
// by the statuson/statusoff system
//
// anybad any type of state change
// stone condition of being in stone state
// freeze condition of being in frozen state
// stan condition of being in stunned state
// sleep condition of being in sleep state
// poison condition of being in poisoned state
// curse condition of being in cursed state
// silence condition of being in silenced state
// confusion condition of being in confusion state
// blind condition of being in blind state
// hiding condition of being in hidden state
// sight condition of being in unhidden state
</pre>

You can use only ONE of these conditions.

 '''value1,value2,value3,value4,value5''': Basically they're only the same but, when you want your mob using the same condition to trigger the skill, but in different times, in case of the myhpltmaxrate when the hp is being decreased, you can set them in a decreasing order, like:

<pre>80,60,40,20,10</pre>

 '''emotion''': Lets your mob use an emotion, at random times. The emotion IDs are:

<pre>
e_gasp 0
e_what 1
e_ho 2
e_lv 3
e_swt 4
e_ic 5
etc
</pre>

For more info, go to your {{git|db/const.txt}} file.

== Making it talk! ==
Another add, suggested by chronocrosser_x and Fenrir Soarblade:

Well, I believe you have seen some mobs on your server talking when certain things happens. I never saw them again talking, dont know why but they used to talk. I believe they still do it.

Ok, go to your Data folder. If you look in the files, you should find a file called monstertalktable. If there isnt, we will create one with Wordpad =3!. If there is, open it with Wordpad, not Notepad.

Once there, we will copy and paste this:

<pre><nowiki><?xml version="1.0" encoding="euc-kr" ?>

<enemy_monster_talk_table>

<mob_db_name_here>
<discovery></discovery>
<attack></attack>
<hp50></hp50>
<hp25></hp25>
<kill></kill>
<dead></dead>
</mob_db_name_here>
</enemy_monster_talk_table></nowiki></pre>

Well, lets see step by step =3!:

 '''<enemy_monster_talk_table>''': This is the start of the monster talk table. Leave it as it is =3!
 '''<mob_db_name_here>''': The mob_db.txt first name you see, after the ID, goes here =3! Its used to identify the mob
 '''<discovery>%TAB%Text Here%TAB%</discovery>''': This is an event, same as the one below. When a monster see you, this one will be displayed =3!
 '''<attack>%TAB%Text Here%TAB%</attack>''': When a monster attacks you, this one will be displayed O_O!
 '''<hp50>%TAB%Text Here%TAB%</hp50>''': When a monster's hp is at 50%, this one will be displayed o..o!
 '''<hp25>%TAB%Text Here%TAB%</hp25>''': When a monster's hp is at 25%, this one will be displayed x,x
 '''<kill>%TAB%Text Here%TAB%</kill>''': When a monster kills a character/player, this one will be displayed T~T!
 '''<dead>%TAB%Text Here%TAB%</dead>''': When a monster dies by player hand, this one will be displayed ^__^!
 '''</mob_db_name_here>''': The same name of the mob_db.txt, the one after the ID.
 '''</enemy_monster_talk_table>''': Keep it like this.

I never messed with this, but i think its ok =3! Also for those spaces other than the messages spaces, use TAB, not the Space Bar for it ._.!

[[Category:Database]]
[[Category:Data]]
[[Category:Customization]]

Building HPM Plugin for MSVC

2015-10-02T08:55:23Z

Dastgirpojee:

This is a guide on how to prepare your MSVC environment for a new [[HPM]] plugin.
= Guide =
1. Go to '''src/plugins/''' folder, create a new '''.c''' file, e.g. '''dance.c''' (this name will be used throughout this guide)
[[File:step1.JPG|center|750px]]
2. Open dance.c and paste this code

<pre>
#include <stdio.h>
#include <string.h>
#include "../common/HPMi.h"
#include "../map/script.h"
#include "../map/pc.h"

#include "../common/HPMDataCheck.h" //Should always be the last include file.

HPExport struct hplugin_info pinfo =
{
"@dance", // Plugin name
SERVER_TYPE_MAP,// Which server types this plugin works with?
"0.1a", // Plugin version
HPM_VERSION, // HPM Version (don't change, macro is automatically updated)
};

ACMD(dance)
{

if (!message || !*message) {
clif->message(fd, "usage: @dance 1-9");
return -1;
}
if ( atoi(message) == 1 ) {
clif->specialeffect(&sd->bl, 413, ALL_CLIENT);
} else if ( atoi(message) == 2 ) {
clif->specialeffect(&sd->bl, 414, ALL_CLIENT);
} else if ( atoi(message) == 3 ) {
clif->specialeffect(&sd->bl, 415, ALL_CLIENT);
} else if ( atoi(message) == 4 ) {
clif->specialeffect(&sd->bl, 426, ALL_CLIENT);
} else if ( atoi(message) == 5 ) {
clif->specialeffect(&sd->bl, 458, ALL_CLIENT);
} else if ( atoi(message) == 6 ) {
clif->specialeffect(&sd->bl, 466, ALL_CLIENT);
} else if ( atoi(message) == 7 ) {
clif->specialeffect(&sd->bl, 501, ALL_CLIENT);
} else if ( atoi(message) == 8 ) {
clif->specialeffect(&sd->bl, 540, ALL_CLIENT);
} else if ( atoi(message) == 9 ) {
clif->specialeffect(&sd->bl, 550, ALL_CLIENT);
}
else
{
clif->message(fd, "usage: @dance 1-9");
}
return true;
}

/* Server Startup */
HPExport void plugin_init (void)
{
clif = GET_SYMBOL("clif");
script = GET_SYMBOL("script");
skill = GET_SYMBOL("skill");

addAtcommand("dance",dance);
}
</pre>
3. Open your MSVC project (e.g. '''Hercules-10.sln'')
[[File:step2.JPG|center|750px]]
4. Go to the '''Solution Explorer'''
[[File:step3.JPG|center|750px]]
5. Right click the Hercules project (first item in '''Solution Explorer'''), and click '''Add->New Project'''
[[File:step4.JPG|center|750px]]
6. Select '''General''', and pick '''Empty Project'''.
[[File:step5.JPG|center|750px]]
7. Enter the name of your plugin in the '''Name''' field, and click OK. 

8. In the solution explorer it'll display the new project.
[[File:step6.JPG|center|750px]]
9. Right click the new project, and open '''Add->Existing Item'''
[[File:step7.JPG|center|750px]]
10. Browse to '''src/plugins/''' and select the '''dance.c''' file, and hit OK.
[[File:step8.JPG|center|750px]]
11. It will place the '''dance.c''' file under the '''Source Files''' folder, drag it to the project you created and drop it (in a manner it be placed out of the source files folder.)
[[File:step9.JPG|center|750px]]
(It should look like the image below)
[[File:step10.JPG|center|750px]]
12. With the '''dance.c''' out of the folders, delete the 3 of them (select the 3, hit delete, hit ok)
[[File:step11.JPG|center|750px]]
(It should look like the image below)
[[File:step12.JPG|center|750px]]
13. Right click the project you created, open '''Properties'''
[[File:step13.JPG|center|750px]]
14. Under '''Configuration Properties''' click '''General''', change '''Output Directory''' to '''..\plugins\''', '''Intermediate Directory''' to '''$(ProjectName)\$(ConfigurationName)\''' and '''Configuration Type''' to '''Dynamic Library (.dll)'''
[[File:step14.JPG|center|750px]]
15. Under '''Configuration Properties''' click '''C/C++''' and open '''General''', change '''Additional Include Directories''' to '''..\src;..\3rdparty;..\3rdparty\msinttypes\include'''
[[File:step15.JPG|center|750px]]
16. Under '''Configuration Properties''' click '''Linker''' and open '''General''', change '''Output File''' to '''$(OutDir)\PluginName.dll''' (TargetName is the name of the project)
[[File:step16.JPG|center|750px]]
17. Add your code to the '''dance.c''' file, and then right-click the project you created, and select '''Build'''

18. Add it to ''' /conf/plugins.conf'''

<pre>
plugins_list: [
/* Enable HPMHooking when plugins in use rely on Hooking */
//"HPMHooking",
//"db2sql",
//"sample",
//"other",
"dance", // loads dance plugin
]
</pre>

= Notes =
* This guide is probably the worst I've ever written, if you can do better please hit the 'Edit' button, will be most welcome. - Ind
* I used MSVC 2008 when testing this guide.

= New Note =
* Sorry for editing this page, I added step by step images for other people to follow so they can easily follow one of the best feature Hercules have, the HPM. - Thanna
* The tutorial is tested on MSVC 2010.

[[Category:Installation]]

Hercules Hierarchy

2014-12-10T16:31:30Z

Dastgirpojee: /* High Council */

= Staff Titles =
Ordered alphabetically. All staff titles, regardless of their description, possesses full moderation powers.

== Administrators ==
They administrate.
* [http://hercules.ws/board/user/307-haru/ Haru] ([http://hercules.ws/board/index.php?app=members&filter=4 Development Administrator])
* [http://hercules.ws/board/user/1-ind/ Ind] ([http://hercules.ws/board/index.php?app=members&filter=4 Development Administrator])
* [http://hercules.ws/board/user/43-mysterious/ Mysterious] ([http://hercules.ws/board/index.php?app=members&filter=4 Community Administrator])

== Core Developers ==
The kings of the code hill.
* [http://hercules.ws/board/user/20-malufett/ malufett]
* [http://hercules.ws/board/user/49-mkbu95/ mkbu95]
* [http://hercules.ws/board/user/4055-pan/ Pan]
* [http://hercules.ws/board/user/50-michieru/ Michieru]

== Script Developers ==
Usually the members with the fastest key/second typing ratio.
* [http://hercules.ws/board/user/48-dastgir/ Dastgir]
* [http://hercules.ws/board/user/1664-kisuka/ Kisuka]
* [http://hercules.ws/board/user/192-wolf/ Wolf]

== Scripting Moderators ==
* [http://hercules.ws/board/user/4102-annieruru/ AnnieRuru]

== Global Moderators ==
Global Moderators are individuals who moderate all of the forums excluding International Communities, however, may still moderate. 
Global Moderator ensure that all of the forums are cleaned by removing duplicate topics, ensuring posts/topics don't have spam, moving topics where need be, and locking topics. 
Global Moderators also provide support to support topics, however, not to an extent as Support Leaders. This is not a position one can apply to, but be promoted to from other moderation position thanks to one's efforts and commitment to moderation.
* [http://hercules.ws/board/user/387-jabote/ jaBote]
* [http://hercules.ws/board/user/83-mumbles/ Mumbles]

== Support Leaders ==
In charge of all the main supporting areas.

== Graphics Moderators ==
In charge of all the main graphics areas.
* [http://hercules.ws/board/user/1460-uzieal/ Uzieal]
* [http://hercules.ws/board/user/11-olrox/ Orlox]

== Int'l Moderators ==
International Moderators are individuals who moderate their respective International Community. 
They are solely responsible in making sure their respective community is cleaned by moving, locking, removing, and cleaning topics of spams. 
International Moderators don't have sole responsibility of other forums outside their community and they must provide support to individuals in their community.

====Filipino====
* [http://hercules.ws/board/user/1582-mhalicot/ Mhalicot]

====Portuguese====
* [http://hercules.ws/board/user/63-juliocf/ JulioCF]

====Spanish====
* [http://hercules.ws/board/user/125-m45t3r/ M45T3R]

== High Council ==
They're an upgrade from the [[#Community_Contributor | Community Contributor]] title.
* [http://hercules.ws/board/user/59-beret/ Beret]
* [http://hercules.ws/board/user/6674-csnv/ csnv]
* [http://hercules.ws/board/user/6-eiphes/ Eiphes]
* [http://hercules.ws/board/user/8-eurydice/ Eurydice]
* [http://hercules.ws/board/user/1160-gepard/ Gepard]
* [http://hercules.ws/board/user/88-kyeme/ kyeme]
* [http://hercules.ws/board/user/99-muad_dib/ Muad_Dib]
* [http://hercules.ws/board/user/456-rytech/ Rytech]
* [http://hercules.ws/board/user/409-yommy/ Yommy]
* [http://hercules.ws/board/user/67-xgear/ Xgear]

= Former Staff Members =
Former staff members who've contributed throughout Hercules.

== Former Administrators ==
* [http://hercules.ws/board/user/2-jman/ Jman]

== Former Core Developers ==
* [http://hercules.ws/board/user/28-greenbox/ GreenBox]
* [http://hercules.ws/board/user/725-susu/ Susu]

== Former Script Developers ==
* [http://hercules.ws/board/user/756-joseph/ Joseph]
* [http://hercules.ws/board/user/5-kenpachi/ Kenpachi]
* [http://hercules.ws/board/user/23-martin/ Martin]
* [http://hercules.ws/board/user/757-masao/ Masao]
* [http://hercules.ws/board/user/7-nameless2you/ Nameless2you]

== Former Scripting Moderators ==

== Former Global Moderators ==
* [http://hercules.ws/board/user/10-judas/ Judas]

== Former Support Leaders ==
* [http://hercules.ws/board/user/4-emistry/ Emistry]

== Former Graphic Moderators ==
* [http://hercules.ws/board/user/129-adel/ Adel]

== Former International Moderators ==
==== Filipino ====
* [http://hercules.ws/board/user/25-jaypee/ JayPee]

= Community Contributors =
This title is awarded to community members for their outstanding support of Hercules. For more information, [http://hercules.ws/board/topic/376-hercules-cc-program/ read the thread about it on the forum.]
* [http://hercules.ws/board/user/137-bgamez23/ bgamez23]
* [http://hercules.ws/board/user/1352-evilpuncker/ evilpuncker]
* [http://hercules.ws/board/user/5970-gmocean/ GmOcean]
* [http://hercules.ws/board/user/118-mleo1/ mleo1]
* [http://hercules.ws/board/user/315-neo/ Neo]
* [http://hercules.ws/board/user/87-ossi0110/ ossi0110]
* [http://hercules.ws/board/user/449-patskie/ Patskie]
* [http://hercules.ws/board/user/303-ryuuzaki/ Ryuuzaki]
* [http://hercules.ws/board/user/297-shakto/ Shakto]

[[Category:Hercules]]

Hercules Hierarchy

2014-12-09T05:50:45Z

Dastgirpojee: /* Script Developers */

= Staff Titles =
Ordered alphabetically. All staff titles, regardless of their description, possesses full moderation powers.

== Administrators ==
They administrate.
* [http://hercules.ws/board/user/307-haru/ Haru] ([http://hercules.ws/board/index.php?app=members&filter=4 Development Administrator])
* [http://hercules.ws/board/user/1-ind/ Ind] ([http://hercules.ws/board/index.php?app=members&filter=4 Development Administrator])
* [http://hercules.ws/board/user/43-mysterious/ Mysterious] ([http://hercules.ws/board/index.php?app=members&filter=4 Community Administrator])

== Core Developers ==
The kings of the code hill.
* [http://hercules.ws/board/user/20-malufett/ malufett]
* [http://hercules.ws/board/user/49-mkbu95/ mkbu95]
* [http://hercules.ws/board/user/4055-pan/ Pan]
* [http://hercules.ws/board/user/50-michieru/ Michieru]

== Script Developers ==
Usually the members with the fastest key/second typing ratio.
* [http://hercules.ws/board/user/48-dastgir/ Dastgir]
* [http://hercules.ws/board/user/1664-kisuka/ Kisuka]
* [http://hercules.ws/board/user/192-wolf/ Wolf]

== Scripting Moderators ==
* [http://hercules.ws/board/user/4102-annieruru/ AnnieRuru]

== Global Moderators ==
Global Moderators are individuals who moderate all of the forums excluding International Communities, however, may still moderate. 
Global Moderator ensure that all of the forums are cleaned by removing duplicate topics, ensuring posts/topics don't have spam, moving topics where need be, and locking topics. 
Global Moderators also provide support to support topics, however, not to an extent as Support Leaders. This is not a position one can apply to, but be promoted to from other moderation position thanks to one's efforts and commitment to moderation.
* [http://hercules.ws/board/user/387-jabote/ jaBote]
* [http://hercules.ws/board/user/83-mumbles/ Mumbles]

== Support Leaders ==
In charge of all the main supporting areas.

== Graphics Moderators ==
In charge of all the main graphics areas.
* [http://hercules.ws/board/user/1460-uzieal/ Uzieal]
* [http://hercules.ws/board/user/11-olrox/ Orlox]

== Int'l Moderators ==
International Moderators are individuals who moderate their respective International Community. 
They are solely responsible in making sure their respective community is cleaned by moving, locking, removing, and cleaning topics of spams. 
International Moderators don't have sole responsibility of other forums outside their community and they must provide support to individuals in their community.

====Filipino====
* [http://hercules.ws/board/user/1582-mhalicot/ Mhalicot]

====Portuguese====
* [http://hercules.ws/board/user/63-juliocf/ JulioCF]

====Spanish====
* [http://hercules.ws/board/user/125-m45t3r/ M45T3R]

== High Council ==
They're an upgrade from the [[#Community_Contributor | Community Contributor]] title.
* [http://hercules.ws/board/user/59-beret/ Beret]
* [http://hercules.ws/board/user/6-eiphes/ Eiphes]
* [http://hercules.ws/board/user/8-eurydice/ Eurydice]
* [http://hercules.ws/board/user/1160-gepard/ Gepard]
* [http://hercules.ws/board/user/88-kyeme/ kyeme]
* [http://hercules.ws/board/user/99-muad_dib/ Muad_Dib]
* [http://hercules.ws/board/user/456-rytech/ Rytech]
* [http://hercules.ws/board/user/409-yommy/ Yommy]
* [http://hercules.ws/board/user/67-xgear/ Xgear]

= Former Staff Members =
Former staff members who've contributed throughout Hercules.

== Former Administrators ==
* [http://hercules.ws/board/user/2-jman/ Jman]

== Former Core Developers ==
* [http://hercules.ws/board/user/28-greenbox/ GreenBox]
* [http://hercules.ws/board/user/725-susu/ Susu]

== Former Script Developers ==
* [http://hercules.ws/board/user/756-joseph/ Joseph]
* [http://hercules.ws/board/user/5-kenpachi/ Kenpachi]
* [http://hercules.ws/board/user/23-martin/ Martin]
* [http://hercules.ws/board/user/757-masao/ Masao]
* [http://hercules.ws/board/user/7-nameless2you/ Nameless2you]

== Former Scripting Moderators ==

== Former Global Moderators ==
* [http://hercules.ws/board/user/10-judas/ Judas]

== Former Support Leaders ==
* [http://hercules.ws/board/user/4-emistry/ Emistry]

== Former Graphic Moderators ==
* [http://hercules.ws/board/user/129-adel/ Adel]

== Former International Moderators ==
==== Filipino ====
* [http://hercules.ws/board/user/25-jaypee/ JayPee]

= Community Contributors =
This title is awarded to community members for their outstanding support of Hercules. For more information, [http://hercules.ws/board/topic/376-hercules-cc-program/ read the thread about it on the forum.]
* [http://hercules.ws/board/user/137-bgamez23/ bgamez23]
* [http://hercules.ws/board/user/1352-evilpuncker/ evilpuncker]
* [http://hercules.ws/board/user/5970-gmocean/ GmOcean]
* [http://hercules.ws/board/user/118-mleo1/ mleo1]
* [http://hercules.ws/board/user/315-neo/ Neo]
* [http://hercules.ws/board/user/87-ossi0110/ ossi0110]
* [http://hercules.ws/board/user/449-patskie/ Patskie]
* [http://hercules.ws/board/user/303-ryuuzaki/ Ryuuzaki]
* [http://hercules.ws/board/user/297-shakto/ Shakto]

[[Category:Hercules]]

Installation (CentOS)

2014-11-07T05:17:07Z

Dastgirpojee:

This guide covers how to install [[Hercules]] on [[wikipedia:CentOS|CentOS]] and other [[wikipedia:List_of_Linux_distributions#RPM-based|versions of Linux]] that use [[wikipedia:Yellowdog_Updater,_Modified|yum]].

== Requirements ==
* [[wikipedia:CentOS|CentOS]] or an [[wikipedia:List_of_Linux_distributions#RPM-based|RPM-based Linux]] that has the '''[[wikipedia:Yellowdog_Updater,_Modified|yum]]''' command
* root access or access to an account that has [[wikipedia:Sudo|sudo privileges]]
* an Internet connection to download install packages

== Prerequisites ==
All of these commands will be typed at the [[wikipedia:Command-line_interface|command-line interface]].
=== Install Prerequisites ===
# Login to your server via [[wikipedia:Secure_Shell|SSH]], or if you are already logged into a [[wikipedia:Graphical_user_interface|GUI]] press Ctrl+Alt+T to open a terminal window.
# Type the following command (this will install GCC, Make, MySQL, MySQL header files, MySQL Server, PCRE header files, Git, and Zlib header files)
#: <pre>yum install gcc make mysql mysql-devel mysql-server pcre-devel git zlib-devel</pre>
# (Optional) type the following command to install some additional packages:
#: <pre>yum -y install dos2unix gdb nano screen unzip wget zip</pre>

=== Create a non-root Linux user ===
By the [[wikipedia:Principle_of_least_privilege|principle of least privilege]], it is recommended you do '''NOT''' run Hercules as root.
# Type the following command to create a non-root Linux account:
#: <pre>useradd --create-home --shell /bin/bash hercules1234</pre>
#: <code>--create-home</code> = create the user's home directory
#: <code>--shell</code> = sets their login shell to [[wikipedia:Bash_(Unix_shell)|Bash]]
#: '''<code>hercules1234</code>''' = the login name of the new Linux account
#: ''<code>1234</code>'' = pick your own random numbers to make the username more unique
# Set a password for the new user (run this command and follow the prompts):
#: <pre>passwd hercules1234</pre>

=== Configure MySQL ===

==== Set a root password ====
The default MySQL Server install creates a MySQL user 'root'@'localhost' with NO password. It is recommended you create a password for the root user.
# Run this command and follow the prompts:
#: Firest Start MySQL:
#: <pre>/etc/init.d/mysqld start </pre>
#: Then configure MySQL by:
#: <pre>mysql_secure_installation</pre>
# Login to your MySQL Server as root:
#: ''When prompted, enter your root MySQL password.''
#: <pre>mysql --user=root -p</pre>
# Now your prompt should look like this (the MySQL command prompt):
#: <pre>mysql> </pre>

==== Create SQL database for Hercules ====
# At the MySQL prompt, type this to [http://dev.mysql.com/doc/refman/5.5/en/create-database.html create a database] (replace <code>hercules1234</code> with the Linux username you created earlier):
#: <pre>mysql> CREATE DATABASE hercules1234_rag;</pre>
# Create a separate database for logs:
#: <pre>mysql> CREATE DATABASE hercules1234_log;</pre>

==== Setup a MySQL user for Hercules ====
# At the MySQL prompt, type something like this to create a new MySQL user:
#: <pre>mysql> CREATE USER 'hercules1234'@'localhost' IDENTIFIED BY 'secretpassword';</pre>
#: <code>hercules1234</code> = the name of the MySQL user (we named it the same as the Linux user to make it easier to identify)
#: <code>localhost</code> = the hostname or IP it will connect from
#: '''<code>secretpassword</code>''' = the password for this MySQL user
# [http://dev.mysql.com/doc/refman/5.5/en/grant.html Grant privileges] to the 'hercules' MySQL user:
#: <pre>mysql> GRANT SELECT,INSERT,UPDATE,DELETE ON `hercules1234\_rag`.* TO 'hercules1234'@'localhost';</pre>
#: <pre>mysql> GRANT SELECT,INSERT ON `hercules1234\_log`.* TO 'hercules1234'@'localhost';</pre> (note the [http://dev.mysql.com/doc/refman/5.5/en/string-literals.html#character-escape-sequences escaped underscore])

== Install [[Hercules]] ==

=== Login as your non-root Linux user ===
The rest of the setup is done as hercules1234 (the Linux user you created in step 2.2)
# Logout from root SSH (or minimize the window).
# Login to your server via SSH as the hercules1234 Linux user.

=== SVN Checkout ===
{{:Git Clone/Unix}}

=== [http://dev.mysql.com/doc/refman/5.5/en/batch-commands.html Import] MySQL Tables ===
# Change directory to the '''sql-files''' folder.
#: <pre>cd sql-files/</pre>
# Execute these commands:
#: ''When prompted, enter your MySQL root password.''
#: <pre>mysql -u root -prootpassword hercules1234_rag < main.sql</pre>
#: <pre>mysql -u root -prootpassword hercules1234_rag < item_db.sql</pre>
#: <pre>mysql -u root -prootpassword hercules1234_rag < item_db2.sql</pre>
#: <pre>mysql -u root -prootpassword hercules1234_rag < mob_db.sql</pre>
#: <pre>mysql -u root -prootpassword hercules1234_rag < mob_db2.sql</pre>
#: <pre>mysql -u root -prootpassword hercules1234_rag < mob_skill_db.sql</pre>
#: <pre>mysql -u root -prootpassword hercules1234_rag < mob_skill_db2.sql</pre>
#: <pre>mysql -u root -prootpassword hercules1234_log < logs.sql</pre>
# If you are using Renewal you also have to import the following
#: <pre>mysql -u root -prootpassword hercules1234_rag < item_db_re.sql</pre>
#: <pre>mysql -u root -prootpassword hercules1234_rag < item_db2_re.sql</pre>
#: <pre>mysql -u root -prootpassword hercules1234_rag < mob_db_re.sql</pre>
#: <pre>mysql -u root -prootpassword hercules1234_rag < mob_skill_db_re.sql</pre>

NOTE: if you want to use different SQL DBs for login/char/map servers this is the list of databases each server use:
#login-server: global_reg_value, ipbanlist, login, loginlog
#map-server: mapreg, item_db, item_db2, mob_db, mob_db2,mob_skill_db
#char-server: everything else + global_reg_value once again
Note that global_reg_value tables are needed by both login-server and char-server (though it may be different tables)

=== [[:Category:Configuration|Configure Hercules]]===

=== Compile Source Code ===
cd trunk
./configure
make sql

*If you're using CentOS 32-bit please use:
./configure --disable-64bit

===== How to Recompile =====
In the future (after you update or edit any file in /src) to recompile, add ''make clean'' before make sql:
cd trunk
./configure
'''make clean'''
make sql

== Start your Hercules Server ==
//change access mode of athena-start file so that you can execute it.
//Use (dos2unix athena-start) if yo uare getting ^M errors ie. newline errors
chmod a+x athena-start

//To Start
./athena-start start
//To Stop
./athena-start stop
//To Restart
./athena-start restart

== See Also ==

[[Category:Installation Guides|CentOS]]

Git Clone

2014-11-07T05:16:03Z

Dastgirpojee:

To download Hercules, you need to perform a '''clone''' from [[wikipedia:Git|Git]] (Git) repository. Checking out from a repository creates a working copy of it on your local machine.

A Git is required to perform a clone. Recommended applications are:
* [http://git-scm.com/ git] for Unix systems
* [http://code.google.com/p/msysgit/downloads/list?can=2 MSysGit] And [http://code.google.com/p/tortoisegit/wiki/Download?tm=2 TortoiseGit] for Windows systems (Both Required

== Unix ==
<blockquote>''For detailed instructions on how to install subversion, please refer to OS specific [[:Category:Installation Guides|installation guides]].''</blockquote>
{{:Git Clone/Unix}}

== Windows ==
Check [http://hercules.ws/board/topic/152-obtaining-hercules/?p=845#entry845 Obtaining Hercules] for info on how to clone in windows

Git Clone/Unix

2014-11-07T05:15:46Z

Dastgirpojee: Created page with "Type the following to create a Hercules working copy in your home (~) directory git clone https://github.com/HerculesWS/Hercules.git ~/Hercules Category:Installation"

Type the following to create a Hercules working copy in your home (~) directory
git clone https://github.com/HerculesWS/Hercules.git ~/Hercules
[[Category:Installation]]

Git Clone

2014-11-07T05:13:28Z

Dastgirpojee: Created page with "To download Hercules, you need to perform a '''clone''' from Git (Git) repository. Checking out from a repository creates a working copy of it on your local ..."

To download Hercules, you need to perform a '''clone''' from [[wikipedia:Git|Git]] (Git) repository. Checking out from a repository creates a working copy of it on your local machine.

A Git is required to perform a clone. Recommended applications are:
* [http://git-scm.com/ git] for Unix systems
* [http://code.google.com/p/msysgit/downloads/list?can=2 MSysGit] And [http://code.google.com/p/tortoisegit/wiki/Download?tm=2 TortoiseGit] for Windows systems (Both Required

== Unix ==
<blockquote>''For detailed instructions on how to install subversion, please refer to OS specific [[:Category:Installation Guides|installation guides]].''</blockquote>
Type the following to create a Hercules working copy in your home (~) directory
git clone https://github.com/HerculesWS/Hercules.git ~/Hercules
== Windows ==
Check [http://hercules.ws/board/topic/152-obtaining-hercules/?p=845#entry845 Obtaining Hercules] for info on how to clone in windows

Getequipname

2014-04-18T12:07:32Z

Dastgirpojee: Created page with "==Syntax== *'''getequipname'''(<equipment slot>); ==Description== Returns the jname of the item equipped in the specified equipment slot on the invoking character, or an empt..."

==Syntax==
*'''getequipname'''(<equipment slot>);

==Description==
Returns the jname of the item equipped in the specified equipment slot on the invoking character, or an empty string ("") if nothing is equipped in that position.

Does the same thing as [[getitemname]](getequipid(<slot>)). Useful for an NPC to state what your are wearing, or maybe saving as a string variable.

See '[[getequipid]]' for a full list of valid equipment slots.

==Examples==

[[if]] (getequipname(EQI_HAND_L)==""){
[[mes]] "You are wearing nothing on Left Hand";
} else {
mes "You are wearing "+getequipname(EQI_HAND_L)+" on Left Hand";
}

==See Also==
* [[getequipid]]
* [[getitemname]]

[[Category:Script Command]]

Getequipid

2014-04-18T12:02:28Z

Dastgirpojee: Created page with "==Syntax== *'''getequipid'''(<equipment slot>); ==Description== This function returns the item ID of the item equipped in the equipment slot specified on the invoking charact..."

==Syntax==
*'''getequipid'''(<equipment slot>);

==Description==
This function returns the item ID of the item equipped in the equipment slot specified on the invoking character. If nothing is equipped on the specified slot, command returns -1.
{| class="wikitable"
|+ Equipment Slots:
|-
|EQI_HEAD_TOP (1)
|Upper head gear
|-
|EQI_ARMOR (2)
|Armor (Where you keep your Jackets and Robes)
|-
|EQI_HAND_L (3)
|What is in your Left hand.
|-
|EQI_HAND_R (4)
|What is in your Right hand.
|-
|EQI_GARMENT (5)
|The garment slot (Mufflers, Hoods, Manteaus)
|-
|EQI_SHOES (6)
|What foot gear the player has on.
|-
|EQI_ACC_L (7)
|Accessory 1.
|-
|EQI_ACC_R (8)
|Accessory 2.
|-
|EQI_HEAD_MID (9)
|Middle Headgear (masks and glasses)
|-
|EQI_HEAD_LOW (10)
|Lower Headgear (beards, some masks)
|-
|EQI_COSTUME_HEAD_LOW (11)
|Lower Costume Headgear
|-
|EQI_COSTUME_HEAD_MID (12)
|Middle Costume Headgear
|-
|EQI_COSTUME_HEAD_TOP (13)
|Upper Costume Headgear
|-
|EQI_COSTUME_GARMENT (14)
|Costume Garment
|-
|EQI_SHADOW_ARMOR (15)
|Shadow Armor
|-
|EQI_SHADOW_WEAPON (16)
|Shadow Weapon
|-
|EQI_SHADOW_SHIELD (17)
|Shadow Shield
|-
|EQI_SHADOW_SHOES (18)
|Shadow Shoes
|-
|EQI_SHADOW_ACC_R (19)
|Shadow Accessory 2
|-
|EQI_SHADOW_ACC_L (20)
|Shadow Accessory 1
|}

==Examples==

[[mes ]] "You should wear a cotton shirt to continue the quest";
[[if]] (getequipid(EQI_ARMOR)==Cotton_Shirt) goto L_WearingShirt;
mes "Come Back when you have Cotton Shirt Equipped.";
[[close]];

==See Also==
* [[getequipname]]

[[Category:Script Command]]

Hercules Hierarchy

2014-03-25T10:57:29Z

Dastgirpojee:

= Staff Titles =
Ordered alphabetically. All staff titles, regardless of their description, possesses full moderation powers.

== Administrators ==
They administrate.
* [http://hercules.ws/board/user/307-haru/ Haru] ([http://hercules.ws/board/index.php?app=members&filter=4 Development Administrator])
* [http://hercules.ws/board/user/1-ind/ Ind] ([http://hercules.ws/board/index.php?app=members&filter=4 Development Administrator])
* [http://hercules.ws/board/user/43-mysterious/ Mysterious] ([http://hercules.ws/board/index.php?app=members&filter=4 Community Administrator])

== Core Developers ==
The kings of the code hill.
* [http://hercules.ws/board/user/20-malufett/ malufett]
* [http://hercules.ws/board/user/49-mkbu95/ mkbu95]
* [http://hercules.ws/board/user/4055-pan/ Pan]
* [http://hercules.ws/board/user/50-michieru/ Michieru]

== Script Developers ==
Usually the members with the fastest key/second typing ratio.
* [http://hercules.ws/board/user/1664-kisuka/ Kisuka]
* [http://hercules.ws/board/user/192-wolf/ Wolf]

== Scripting Moderators ==
* [http://hercules.ws/board/user/4102-annieruru/ AnnieRuru]

== Global Moderators ==
Global Moderators are individuals who moderate all of the forums excluding International Communities, however, may still moderate. 
Global Moderator ensure that all of the forums are cleaned by removing duplicate topics, ensuring posts/topics don't have spam, moving topics where need be, and locking topics. 
Global Moderators also provide support to support topics, however, not to an extent as Support Leaders. This is not a position one can apply to, but be promoted to from other moderation position thanks to one's efforts and commitment to moderation.
* [http://hercules.ws/board/user/387-jabote/ jaBote]
* [http://hercules.ws/board/user/83-mumbles/ Mumbles]

== Support Leaders ==
In charge of all the main supporting areas.

== Graphics Moderators ==
In charge of all the main graphics areas.
* [http://hercules.ws/board/user/1460-uzieal/ Uzieal]
* [http://hercules.ws/board/user/11-olrox/ Orlox]

== Int'l Moderators ==
International Moderators are individuals who moderate their respective International Community. 
They are solely responsible in making sure their respective community is cleaned by moving, locking, removing, and cleaning topics of spams. 
International Moderators don't have sole responsibility of other forums outside their community and they must provide support to individuals in their community.

====Filipino====
* [http://hercules.ws/board/user/1582-mhalicot/ Mhalicot]

====Portuguese====
* [http://hercules.ws/board/user/63-juliocf/ JulioCF]

====Spanish====
* [http://hercules.ws/board/user/125-m45t3r/ M45T3R]

== High Council ==
They're an upgrade from the [[#Community_Contributor | Community Contributor]] title.
* [http://hercules.ws/board/user/59-beret/ Beret]
* [http://hercules.ws/board/user/6-eiphes/ Eiphes]
* [http://hercules.ws/board/user/8-eurydice/ Eurydice]
* [http://hercules.ws/board/user/1160-gepard/ Gepard]
* [http://hercules.ws/board/user/88-kyeme/ kyeme]
* [http://hercules.ws/board/user/99-muad_dib/ Muad_Dib]
* [http://hercules.ws/board/user/456-rytech/ Rytech]
* [http://hercules.ws/board/user/409-yommy/ Yommy]
* [http://hercules.ws/board/user/67-xgear/ Xgear]

= Former Staff Members =
Former staff members who've contributed throughout Hercules.

== Former Administrators ==
* [http://hercules.ws/board/user/2-jman/ Jman]

== Former Core Developers ==
* [http://hercules.ws/board/user/28-greenbox/ GreenBox]
* [http://hercules.ws/board/user/725-susu/ Susu]

== Former Script Developers ==
* [http://hercules.ws/board/user/756-joseph/ Joseph]
* [http://hercules.ws/board/user/5-kenpachi/ Kenpachi]
* [http://hercules.ws/board/user/23-martin/ Martin]
* [http://hercules.ws/board/user/757-masao/ Masao]
* [http://hercules.ws/board/user/7-nameless2you/ Nameless2you]

== Former Scripting Moderators ==

== Former Global Moderators ==
* [http://hercules.ws/board/user/10-judas/ Judas]

== Former Support Leaders ==
* [http://hercules.ws/board/user/4-emistry/ Emistry]

== Former Graphic Moderators ==
* [http://hercules.ws/board/user/129-adel/ Adel]

== Former International Moderators ==
==== Filipino ====
* [http://hercules.ws/board/user/25-jaypee/ JayPee]

= Community Contributors =
This title is awarded to community members for their outstanding support of Hercules. For more information, [http://hercules.ws/board/topic/376-hercules-cc-program/ read the thread about it on the forum.]
* [http://hercules.ws/board/user/137-bgamez23/ bgamez23]
* [http://hercules.ws/board/user/48-dastgir-pojee/ Dastgir Pojee]
* [http://hercules.ws/board/user/1352-evilpuncker/ evilpuncker]
* [http://hercules.ws/board/user/118-mleo1/ mleo1]
* [http://hercules.ws/board/user/315-neo/ Neo]
* [http://hercules.ws/board/user/87-ossi0110/ ossi0110]
* [http://hercules.ws/board/user/449-patskie/ Patskie]
* [http://hercules.ws/board/user/303-ryuuzaki/ Ryuuzaki]
* [http://hercules.ws/board/user/297-shakto/ Shakto]

[[Category:Hercules]]

Category:Tools

2014-03-03T02:28:21Z

Dastgirpojee: Created page with "Tools to help Editing/Managing Hercules Server."

Tools to help Editing/Managing Hercules Server.

Category:Queue

2014-03-03T02:27:25Z

Dastgirpojee: Created page with "New Queue System is a improved command for battleground, replacing waitingroom"

New Queue System is a improved command for battleground, replacing waitingroom

Developers

2014-03-03T02:22:05Z

Dastgirpojee: Redirected page to Hercules Hierarchy

#REDIRECT [[Hercules_Hierarchy]]

Github

2014-03-03T02:20:55Z

Dastgirpojee: Redirected page to Git

#REDIRECT [[Git]]

Scripting

2014-02-18T04:31:21Z

Dastgirpojee:

[[Category:Incomplete]]
__NOTOC__

{| style="padding:0.3em; clear:right; margin-left:15px; border:1px solid #A3B1BF; background:#f7f8ff; text-align:left; font-size:95%; line-height:1.5em;" align="right"
| style="background: #ACD; text-align: center; border: 1px solid #7BC;" | '''Scripting Overview'''
|-
|'''General'''
* [[Adding a Script]]
* [[Basic Scripting]]
* [[:Category:Script_Command|Script Commands]]
* [[Overview of Errors]]
* [[Tips_and_Tricks_(Scripting)|Tips and Tricks]]
|-
|'''Map Flags'''
* [[Mapflag|Map Flags]]
|-
|'''Monster Spawns'''
* [[Permanent Monster Spawn]]
|-
|'''Non Playable Characters'''
* [[Loops]]
* [[Timers (Scripting)|Timers]]
* [[Variables]]
* [[Menus]]
|-
|'''Warp Points'''
* [[Defining Warp Points]]
|-
|'''Shops'''
|-
|'''Functions'''
* [[Functions]]
* [[WoE]]
|-
|}

All pages that specifically related to the '''Scripting''' goes in this Category Page.

Articles will cover the following topics Map Flags, Permanent Monster Spawns, Non Playable Characters, Warp Points, Shops, and Functions.

All articles related to scripting can be found alphabetically [[:Category:Scripting]]

== General ==
Articles in this category are mainly written to create or improve your foundations on Scripting.

More Information:
* [[Adding_a_Script|[Tutorial] Add a Script]]
* [[Basic_Scripting|[Tutorial] NPC Scripting (Basics)]]
* [[Overview_of_Errors|NPC Errors]]
* [[Tips_and_Tricks_(Scripting)|Tips and Tricks]]

== Map Flags ==
A Map Flag describes restriction, property, and behavior of a certain map. The map flags alter the behavior of the map regarding teleporting, storing location when disconnected, dead branch usage, penalties upon death, PVP behavior, WoE behavior, ability to use skills or open up trade deals ,current weather effects, and whether day/night will be in effect on this map. Articles about Map Flags are placed under this category...

Read more at [[Mapflag|Map Flags]]

== Monster Spawns ==
In Depth articles that are related to Monster Spawns can be found under this category.

* [[Permanent_Monster_Spawn|Permanent Monster Spawns]]

== Non Playable Character ==
In Depth articles that are related to NPC Scripting can all be found under this category.

More Information
* [[Loops|NPC Loops]]
* [[Timers|NPC Timers]]
* [[Variables|NPC Variables]]
* [[Menus|NPC Menus]]

== Warp Points ==
In Depth articles related to Warp Points are listed in this category
* [[Defining_Warp_Points|Defining a warp point]]

== Shops ==
Articles about Shops and Cash Shops are placed under this category.
* [[General Shop creation]]

== Functions ==
In Depth articles that are related to Functions can all be found under this category.
* [[Functions|How functions work]]
* [[WoE|Functions used in WoE]]

== Help Expand This Section ==
Help minimize the broadness of Scripting by helping create or expand the following pages

* [[Basic Scripting]]
* [[Binaries|Binary Variable System]]

Tag your articles with this

<nowiki>[[Category:Scripting]]</nowiki>

[[Category:Scripting]]

Mmo.h

2014-02-18T04:30:55Z

Dastgirpojee:

[[Category:Incomplete]]

{{git|src/common/mmo.h}} This source file holds global declarations and hard-coded settings, that are used by the login, char and map server. If you modify anything, you have to recompile all three servers, otherwise you may run into errors.

=== PACKETVER ===
Specifies the packet version to use for server-client communication. It must be set to date, your client has been released at, e. g. 20090922 for 2009-09-22aRagexeRE. Note: If you have a client, that is newer, than the latest packet version in the comment, some things might not work properly, if the client packets have changed since then.

=== ENABLE_SC_SAVING ===
If you disable this define, all status changes get discarded upon logout.

=== HOTKEY_SAVING ===
When enabled, the server stores client hotkeys. While older clients save them locally in the registry, newer clients require this define to be enabled.

=== MAX_MAP_PER_SERVER ===
Sets how many maps a single map server may manage. This also includes instanced maps.

=== MAX_INVENTORY ===
Sets maximum amount of item slots in the character item inventory. If you set this above 127, some scripts, that enumerate characters' inventory will break.

=== MAX_CHARS ===
Max number of characters per account. Note, that changing this setting alone is not enough if the client is not hexed to support more characters as well.

=== GLOBAL_REG_NUM ===
Max number of permanent [[Variables#Player_Variables|char variables]].

=== ACCOUNT_REG_NUM ===
Max number of permanent [[Variables#Account_Variables|account variables]].

=== ACCOUNT_REG_NUM2 ===
Max number of permanent [[Variables#Global_Account_Variables|global account variables]].

=== MAX_QUEST_DB ===
Maximum number of Quest database to be loaded. File is located in db/questdb.txt
note: if you have too many quests, your map server will show errors that there's too many quest db. remember to recompile your server if you do!
[[Category:Configuration]]

Mapflags

2014-02-18T04:28:47Z

Dastgirpojee: Redirected page to Mapflag

#REDIRECT [[Mapflag]]

Lub

2014-02-18T04:28:01Z

Dastgirpojee:

Lub files are the compiled version of [[Lua]]

Lub

2014-02-18T04:27:38Z

Dastgirpojee: Created page with "== Lub == Lub files are the compiled version of Lua"

== Lub ==

Lub files are the compiled version of [[Lua]]

Kafra

2014-02-18T04:23:24Z

Dastgirpojee:

[[Category:Incomplete]]
[[Image:Kafra2.gif|thumb|Kafra Staff Tayelin]]'''Kafra Corporation''' is a group of Ragnarok Online [[NPC|NPCs]], which is generally responsible for setting save points, giving access to player's item storage, providing teleport services and renting merchant class carts. Later episodes introduced two further groups for the same services; namely Cool Event Corporation (western continent) and Cat Hand Services (new world).

[[Category:Basics]]

Texture

2014-02-18T04:22:53Z

Dastgirpojee:

[[Category:Incomplete]]

== Texture Editing ==

There are 2 types of Texture editing. The first is editing the ground textures of maps the second is the textures of objects or models used in maps.

== Map Texture Editing ==

Map textures are easy to make, load Photoshop, paint .net or even just paint and create a square image (Normal map images are either 256x256 or 512x512 pixels) then draw your image and save it as a 256 color bmp (You can make them higher but 256 color images take less space, have less issues and you don't need all the extra colors) to what ever locaion you desire in your client's data folder (You can make your own folder when it's your textures for your maps).

== Adding A Texture To A Map ==

If you are using Browedit you'll need to edit the texture text file within Browedit's data folder (It can be handy to make your own but if you do you will have to add it to the config file your using). The texture files are structured in a simple way, which is, menu location and display name followed by directory location then file name (Eg. sets/prontera/forest/grass_path-curve1|ÇÊµå¹Ù´Ú\pron-dun-03.bmp). You can even set out how you want the menu listing for added sections by simply having just the menu location listed without any display names or file or folder listings (Eg. floor/carpet/|). This way you can structure your texture file at the beginning and list the textures afterwords.
If you have successfully added your next map texture or textures to one of Browedit's texture files you'll be then able to find your texture in the texture window under what you put it under. If you are having trouble with the texture file just follow how one of the files is listed in there already.

== Model Texture Editing ==

If you are like some and wish to edit the textures of an object (aka model) and may or may not wish to replace the existing model then read on. Also like map textures, model textures are simple bmp files which any image editor should be able to open and edit. But while this is so, transparency on models seems to be lost when replaced by another (Borf may fix this in Browedit).
*Remember to make sure your textures are 256 color bmp files when you save them or they may not work.

== Replacing a Model's Texture ==

With Browedit replacing a model's texture is as easy as pie. Load browedit and under 'Windows > RSM Editor' open the model you wish to edit then click the texture you wish to replace and in the texture window (Just like map textures you will have to have added your model texture or textures if you wish to replace any textures) and once you have clicked on the new texture the old will be replace by the new and you can save your creation. It's that simple.

*Note. If you do not want to replace a model's texture but instead make a copy and replace it then just remember to click 'save as' (as save will replace the opened model) and rename the model file and then just like the map textures add it to the model list file in Browedit's data folder

[[Category:Mapping]]

Racial Group

2014-02-18T04:21:55Z

Dastgirpojee:

[[Category:Incomplete]]

= Intro =
This page will try to explain the file {{git|db/pre-re/mob_race2_db.txt}}

== What is it for? ==
The mob_race2_db.txt file is used to define groups of monsters "racially".

== Usage and Syntax ==
The values in this file don't seem to be referenced in {{git|doc/script_commands.txt}}, nor in {{git|db/const.txt}} {{why}}

Item script

2014-02-18T04:21:11Z

Dastgirpojee:

Item scripts are scripts, that are attached to specific items and ran upon usage (usable items), or when putting on and off equipment (equip-able items). Certain script commands can be used only within item scripts, because they refer to the item ''currently in-use''.

[[Category:Scripting]][[Category:Incomplete]]

Talk:Installation (CentOS)

2014-02-18T04:18:05Z

Dastgirpojee: /* Git Clone */

This guide covers how to install [[Hercules]] on [[wikipedia:CentOS|CentOS]] and other [[wikipedia:List_of_Linux_distributions#RPM-based|versions of Linux]] that use [[wikipedia:Yellowdog_Updater,_Modified|yum]].

== Requirements ==
* [[wikipedia:CentOS|CentOS]] or an [[wikipedia:List_of_Linux_distributions#RPM-based|RPM-based Linux]] that has the '''[[wikipedia:Yellowdog_Updater,_Modified|yum]]''' command
* root access or access to an account that has [[wikipedia:Sudo|sudo privileges]]
* an Internet connection to download install packages

== Prerequisites ==
All of these commands will be typed at the [[wikipedia:Command-line_interface|command-line interface]].
=== Install Prerequisites ===
# Login to your server via [[wikipedia:Secure_Shell|SSH]], or if you are already logged into a [[wikipedia:Graphical_user_interface|GUI]] press Ctrl+Alt+T to open a terminal window.
# Type the following command (this will install GCC, Make, MySQL, MySQL header files, MySQL Server, PCRE header files, Subversion, and Zlib header files)
#: <pre>yum install gcc make mysql mysql-devel mysql-server pcre-devel git zlib-devel</pre>
# (Optional) type the following command to install some additional packages:
#: <pre>yum -y install dos2unix gdb nano screen unzip wget zip</pre>

=== Create a non-root Linux user ===
By the [[wikipedia:Principle_of_least_privilege|principle of least privilege]], it is recommended you do '''NOT''' run Herculesas root.
# Type the following command to create a non-root Linux account:
#: <pre>useradd --create-home --shell /bin/bash hercules1234</pre>
#: <code>--create-home</code> = create the user's home directory
#: <code>--shell</code> = sets their login shell to [[wikipedia:Bash_(Unix_shell)|Bash]]
#: '''<code>hercules1234</code>''' = the login name of the new Linux account
#: ''<code>1234</code>'' = pick your own random numbers to make the username more unique
# Set a password for the new user (run this command and follow the prompts):
#: <pre>passwd hercules1234</pre>

=== Configure MySQL ===

==== Set a root password ====
The default MySQL Server install creates a MySQL user 'root'@'localhost' with NO password. It is recommended you create a password for the root user.
# Run this command and follow the prompts:
#: <pre>mysql_secure_installation</pre>
# Login to your MySQL Server as root:
#: ''When prompted, enter your root MySQL password.''
#: <pre>mysql --user=root -p</pre>
# Now your prompt should look like this (the MySQL command prompt):
#: <pre>mysql> </pre>
#: ''In case your mysql server isn't started, you may have to start it with:''
#: <pre>/etc/init.d/mysqld start </pre>

==== Create SQL database for Hercules====
# At the MySQL prompt, type this to [http://dev.mysql.com/doc/refman/5.5/en/create-database.html create a database] (replace <code>hercules1234</code> with the Linux username you created earlier):
#: <pre>mysql> CREATE DATABASE hercules1234_rag;</pre>
# Create a separate database for logs:
#: <pre>mysql> CREATE DATABASE hercules1234_log;</pre>

==== Setup a MySQL user for Hercules ====
# At the MySQL prompt, type something like this to create a new MySQL user:
#: <pre>mysql> CREATE USER 'hercules1234'@'localhost' IDENTIFIED BY 'secretpassword';</pre>
#: <code>hercules1234</code> = the name of the MySQL user (we named it the same as the Linux user to make it easier to identify)
#: <code>localhost</code> = the hostname or IP it will connect from
#: '''<code>secretpassword</code>''' = the password for this MySQL user
# [http://dev.mysql.com/doc/refman/5.5/en/grant.html Grant privileges] to the 'Hercules' MySQL user:
#: <pre>mysql> GRANT SELECT,INSERT,UPDATE,DELETE ON `hercules1234\_rag`.* TO 'hercules1234'@'localhost';</pre>
#: <pre>mysql> GRANT SELECT,INSERT ON `hercules1234\_log`.* TO 'hercules1234'@'localhost';</pre> (note the [http://dev.mysql.com/doc/refman/5.5/en/string-literals.html#character-escape-sequences escaped underscore])

== Install [[Hercules]] ==

=== Login as your non-root Linux user ===
The rest of the setup is done as hercules1234(the Linux user you created in step 2.2)
# Logout from root SSH (or minimize the window).
# Login to your server via SSH as the hercules1234Linux user.

=== Git Clone ===
Execute the following command, and it will download Hercules Repository into hercules folder
git clone git://github.com/HerculesWS/Hercules.git hercules

=== [http://dev.mysql.com/doc/refman/5.5/en/batch-commands.html Import] MySQL Tables ===
# Change directory to the '''sql-files''' folder.
#: <pre>cd trunk/sql-files/</pre>
# Execute these commands:
#: ''When prompted, enter your MySQL root password.''
#: <pre>mysql -u root -prootpassword hercules1234_rag < main.sql</pre>
#: <pre>mysql -u root -prootpassword hercules1234_rag < item_db.sql</pre>
#: <pre>mysql -u root -prootpassword hercules1234_rag < item_db2.sql</pre>
#: <pre>mysql -u root -prootpassword hercules1234_rag < mob_db.sql</pre>
#: <pre>mysql -u root -prootpassword hercules1234_rag < mob_db2.sql</pre>
#: <pre>mysql -u root -prootpassword hercules1234_rag < mob_skill_db.sql</pre>
#: <pre>mysql -u root -prootpassword hercules1234_rag < mob_skill_db2.sql</pre>
#: <pre>mysql -u root -prootpassword hercules1234_log < logs.sql</pre>
# If you are using Renewal you also have to import the following
#: <pre>mysql -u root -prootpassword hercules1234_log < item_db_re.sql</pre>
#: <pre>mysql -u root -prootpassword hercules1234_log < item_db2_re.sql</pre>
#: <pre>mysql -u root -prootpassword hercules1234_log < mob_db_re.sql</pre>
#: <pre>mysql -u root -prootpassword hercules1234_log < mob_skill_db_re.sql</pre>

NOTE: if you want to use different SQL DBs for login/char/map servers this is the list of databases each server use:
#login-server: global_reg_value, ipbanlist, login, loginlog
#map-server: mapreg, item_db, item_db2, mob_db, mob_db2
#char-server: everything else + global_reg_value once again
Note that global_reg_value tables are needed by both login-server and char-server (though it may be different tables)

=== [[:Category:Configuration|Configure Hercules]]===

=== Compile Source Code ===
cd trunk
./configure
make sql

*If you're using CentOS 32-bit please use:
./configure --disable-64bit

===== How to Recompile =====
In the future (after you update or edit any file in /src) to recompile, add ''make clean'' before make sql:
cd trunk
./configure
'''make clean'''
make sql

== Start your HerculesServer ==
//change access mode of athena-start file so that you can execute it.
//Use (dos2unix athena-start) if yo uare getting ^M errors ie. newline errors
chmod a+x athena-start

//To Start
./athena-start start
//To Stop
./athena-start stop
//To Restart
./athena-start restart

== See Also ==

[[Category:Installation Guides|CentOS]]

Building HPM Plugin for MSVC

2014-02-09T05:29:03Z

Dastgirpojee: /* Guide */

This is a guide on how to prepare your MSVC environment for a new [[HPM]] plugin.
= Guide =
1. Go to '''src/plugins/''' folder, create a new '''.c''' file, e.g. '''dance.c''' (this name will be used throughout this guide)
[[File:step1.JPG|center|750px]]
2. Open dance.c and paste this code

<pre>
#include <stdio.h>
#include <string.h>
#include "../common/HPMi.h"
#include "../map/script.h"
#include "../map/pc.h"

#include "../common/HPMDataCheck.h" //Should always be the last include file.

HPExport struct hplugin_info pinfo =
{
"@dance", // Plugin name
SERVER_TYPE_MAP,// Which server types this plugin works with?
"0.1a", // Plugin version
HPM_VERSION, // HPM Version (don't change, macro is automatically updated)
};

ACMD(dance)
{

if (!message || !*message) {
clif->message(fd, "usage: @dance 1-9");
return -1;
}
if ( atoi(message) == 1 ) {
clif->specialeffect(&sd->bl, 413, ALL_CLIENT);
} else if ( atoi(message) == 2 ) {
clif->specialeffect(&sd->bl, 414, ALL_CLIENT);
} else if ( atoi(message) == 3 ) {
clif->specialeffect(&sd->bl, 415, ALL_CLIENT);
} else if ( atoi(message) == 4 ) {
clif->specialeffect(&sd->bl, 426, ALL_CLIENT);
} else if ( atoi(message) == 5 ) {
clif->specialeffect(&sd->bl, 458, ALL_CLIENT);
} else if ( atoi(message) == 6 ) {
clif->specialeffect(&sd->bl, 466, ALL_CLIENT);
} else if ( atoi(message) == 7 ) {
clif->specialeffect(&sd->bl, 501, ALL_CLIENT);
} else if ( atoi(message) == 8 ) {
clif->specialeffect(&sd->bl, 540, ALL_CLIENT);
} else if ( atoi(message) == 9 ) {
clif->specialeffect(&sd->bl, 550, ALL_CLIENT);
}
else
{
clif->message(fd, "usage: @dance 1-9");
}
return true;
}

/* Server Startup */
HPExport void plugin_init (void)
{
clif = GET_SYMBOL("clif");
script = GET_SYMBOL("script");
skill = GET_SYMBOL("skill");

addAtcommand("dance",dance);
}
</pre>
3. Open your MSVC project (e.g. '''Hercules-10.sln'')
[[File:step2.JPG|center|750px]]
4. Go to the '''Solution Explorer'''
[[File:step3.JPG|center|750px]]
5. Right click the Hercules project (first item in '''Solution Explorer'''), and click '''Add->New Project'''
[[File:step4.JPG|center|750px]]
6. Select '''General''', and pick '''Empty Project'''.
[[File:step5.JPG|center|750px]]
7. Enter the name of your plugin in the '''Name''' field, and click OK. 

8. In the solution explorer it'll display the new project.
[[File:step6.JPG|center|750px]]
9. Right click the new project, and open '''Add->Existing Item'''
[[File:step7.JPG|center|750px]]
10. Browse to '''src/plugins/''' and select the '''dance.c''' file, and hit OK.
[[File:step8.JPG|center|750px]]
11. It will place the '''dance.c''' file under the '''Source Files''' folder, drag it to the project you created and drop it (in a manner it be placed out of the source files folder.)
[[File:step9.JPG|center|750px]]
(It should look like the image below)
[[File:step10.JPG|center|750px]]
12. With the '''dance.c''' out of the folders, delete the 3 of them (select the 3, hit delete, hit ok)
[[File:step11.JPG|center|750px]]
(It should look like the image below)
[[File:step12.JPG|center|750px]]
13. Right click the project you created, open '''Properties'''
[[File:step13.JPG|center|750px]]
14. Under '''Configuration Properties''' click '''General''', change '''Output Directory''' to '''..\plugins\''', '''Intermediate Directory''' to '''$(ProjectName)\$(ConfigurationName)\''' and '''Configuration Type''' to '''Dynamic Library (.dll)'''
[[File:step14.JPG|center|750px]]
15. Under '''Configuration Properties''' click '''C/C++''' and open '''General''', change '''Additional Include Directories''' to '''..\src\common;..\3rdparty\msinttypes\include'''
[[File:step15.JPG|center|750px]]
16. Under '''Configuration Properties''' click '''Linker''' and open '''General''', change '''Output File''' to '''$(OutDir)$(TargetName).dll''' (TargetName is the name of the project)
[[File:step16.JPG|center|750px]]
17. Add your code to the '''dance.c''' file, and then right-click the project you created, and select '''Build'''

18. Add it to ''' /conf/plugins.conf'''

<pre>
plugins_list: [
/* Enable HPMHooking when plugins in use rely on Hooking */
//"HPMHooking",
//"db2sql",
//"sample",
//"other",
"dance", // loads dance plugin
]
</pre>

= Notes =
* This guide is probably the worst I've ever written, if you can do better please hit the 'Edit' button, will be most welcome. - Ind
* I used MSVC 2008 when testing this guide.

= New Note =
* Sorry for editing this page, I added step by step images for other people to follow so they can easily follow one of the best feature Hercules have, the HPM. - Thanna
* The tutorial is tested on MSVC 2010.

[[Category:Installation]]

Building HPM Plugin for MSVC

2014-02-02T05:01:07Z

Dastgirpojee:

This is a guide on how to prepare your MSVC environment for a new [[HPM]] plugin.
= Guide =
1. Go to '''src/plugins/''' folder, create a new '''.c''' file, e.g. '''dance.c''' (this name will be used throughout this guide)
[[File:step1.JPG|center|750px]]
2. Open dance.c and paste this code

<pre>
#include <stdio.h>
#include <string.h>
#include "../common/HPMi.h"
#include "../map/script.h"
#include "../map/pc.h"

HPExport struct hplugin_info pinfo =
{
"@dance", // Plugin name
SERVER_TYPE_MAP,// Which server types this plugin works with?
"0.1a", // Plugin version
HPM_VERSION, // HPM Version (don't change, macro is automatically updated)
};

ACMD(dance)
{

if (!message || !*message) {
clif->message(fd, "usage: @dance 1-9");
return -1;
}
if ( atoi(message) == 1 ) {
clif->specialeffect(&sd->bl, 413, ALL_CLIENT);
} else if ( atoi(message) == 2 ) {
clif->specialeffect(&sd->bl, 414, ALL_CLIENT);
} else if ( atoi(message) == 3 ) {
clif->specialeffect(&sd->bl, 415, ALL_CLIENT);
} else if ( atoi(message) == 4 ) {
clif->specialeffect(&sd->bl, 426, ALL_CLIENT);
} else if ( atoi(message) == 5 ) {
clif->specialeffect(&sd->bl, 458, ALL_CLIENT);
} else if ( atoi(message) == 6 ) {
clif->specialeffect(&sd->bl, 466, ALL_CLIENT);
} else if ( atoi(message) == 7 ) {
clif->specialeffect(&sd->bl, 501, ALL_CLIENT);
} else if ( atoi(message) == 8 ) {
clif->specialeffect(&sd->bl, 540, ALL_CLIENT);
} else if ( atoi(message) == 9 ) {
clif->specialeffect(&sd->bl, 550, ALL_CLIENT);
}
else
{
clif->message(fd, "usage: @dance 1-9");
}
return true;
}

/* Server Startup */
HPExport void plugin_init (void)
{
clif = GET_SYMBOL("clif");
script = GET_SYMBOL("script");
skill = GET_SYMBOL("skill");

addAtcommand("dance",dance);
}
</pre>
3. Open your MSVC project (e.g. '''Hercules-10.sln'')
[[File:step2.JPG|center|750px]]
4. Go to the '''Solution Explorer'''
[[File:step3.JPG|center|750px]]
5. Right click the Hercules project (first item in '''Solution Explorer'''), and click '''Add->New Project'''
[[File:step4.JPG|center|750px]]
6. Select '''General''', and pick '''Empty Project'''.
[[File:step5.JPG|center|750px]]
7. Enter the name of your plugin in the '''Name''' field, and click OK. 

8. In the solution explorer it'll display the new project.
[[File:step6.JPG|center|750px]]
9. Right click the new project, and open '''Add->Existing Item'''
[[File:step7.JPG|center|750px]]
10. Browse to '''src/plugins/''' and select the '''dance.c''' file, and hit OK.
[[File:step8.JPG|center|750px]]
11. It will place the '''dance.c''' file under the '''Source Files''' folder, drag it to the project you created and drop it (in a manner it be placed out of the source files folder.)
[[File:step9.JPG|center|750px]]
(It should look like the image below)
[[File:step10.JPG|center|750px]]
12. With the '''dance.c''' out of the folders, delete the 3 of them (select the 3, hit delete, hit ok)
[[File:step11.JPG|center|750px]]
(It should look like the image below)
[[File:step12.JPG|center|750px]]
13. Right click the project you created, open '''Properties'''
[[File:step13.JPG|center|750px]]
14. Under '''Configuration Properties''' click '''General''', change '''Output Directory''' to '''..\plugins\''', '''Intermediate Directory''' to '''$(ProjectName)\$(ConfigurationName)\''' and '''Configuration Type''' to '''Dynamic Library (.dll)'''
[[File:step14.JPG|center|750px]]
15. Under '''Configuration Properties''' click '''C/C++''' and open '''General''', change '''Additional Include Directories''' to '''..\src\common;..\3rdparty\msinttypes\include'''
[[File:step15.JPG|center|750px]]
16. Under '''Configuration Properties''' click '''Linker''' and open '''General''', change '''Output File''' to '''$(OutDir)$(TargetName).dll''' (TargetName is the name of the project)
[[File:step16.JPG|center|750px]]
17. Add your code to the '''dance.c''' file, and then right-click the project you created, and select '''Build'''

18. Add it to ''' /conf/plugins.conf'''

<pre>
plugins_list: [
/* Enable HPMHooking when plugins in use rely on Hooking */
//"HPMHooking",
//"db2sql",
//"sample",
//"other",
"dance", // dance.c
]
</pre>

= Notes =
* This guide is probably the worst I've ever written, if you can do better please hit the 'Edit' button, will be most welcome. - Ind
* I used MSVC 2008 when testing this guide.

= New Note =
* Sorry for editing this page, I added step by step images for other people to follow so they can easily follow one of the best feature Hercules have, the HPM. - Thanna
* The tutorial is tested on MSVC 2010.

[[Category:Installation]]

Thor Patcher

2014-01-23T04:45:37Z

Dastgirpojee:

{{infobox/software
|heading=[[Image:thor-oobe.jpg|250px]] Thor Patcher out of the box with default skin and settings.
|developer=Aeomin
|version=2.5.4.18 / September 18, 2009 2.6.2.66 / August 1, 2011
|os=Windows 2000/XP/Vista/7
|lang=Multiple (6)
|type=Patch Client
|license=unknown (closed source)
|web=http://thor.aeomin.net/}}
[[Thor Patcher]] is designed with the client-side config file embed ''inside'' the patcher itself. Since it uses no extra DLLs, you may distribute 1 file to your players. This guide will not discuss how to setup a [[wikipedia:Web_Server|Web Server]].

=Features=
* Pack into single/multi grf file [0x200]
* Automatically generate GRF if not exists
* RGZ support
* Customizable skin
* Multilingual base on user's OS region setting
* Background music
* No extra dll, not even config file is needed when distribute [No conflict with other server]
* Embed config file and resource data (images for background/buttons)
* Custom Buttons [Hard limit >2 billion, soft limit non-existence as in 2.6.2.68]
* Remote config file
* Self update and client update [Supports multi client exe update(Up to 255)]

=Files=
#Patcher folder contents:
#* '''Thor.exe''' (''Patcher's executable file'')
#Tools folder contents:
#* '''ConfigEmbeder.exe''' (''used to add your config to the patcher exe'')
#* '''CheckSum.exe''' (''used to generate a CRC32 sum of the patcher and client exe'')
#* '''ThorGenerator.exe''' (''used to make patches'')
#* Sample skin files
#* sample '''config.ini'''
#* sample '''language.ini'''
#Web folder contents:
#* a sample '''notice.html'''
#* a sample '''main.ini'''

=Setup=
To set up your thor patcher, you need to go through the following steps:
* make a skin
* write a config.ini
* write a language.ini (optional)
* pack the config & skin into the patcher exe
* write a main.ini
* write a notice webpage
* upload the main.ini & the notice to your webserver

==Making a Skin==
A Thor Patcher skin is divided into following parts:
# '''Background''' (''This is the main part of a skin'')
#* supported formats
#** jpg (no transparency)
#** bmp (the very top-left pixel is used for transparency)
#** partial transparency (.png) is not supported yet
# '''Buttons'''
#* System Buttons:
#** The typical buttons you see on every patcher:
#** Start : starts the main client
#** Cancel : cancels the update process
#** Close : closes thor patcher
#* Custom Buttons:
#: see [[#Custom Buttons|guide]]
# '''Custom Notice Box''':
#: see [[#Custom Notice Box|guide]]
# '''Progressbar''' (''Shows the patching progress'')
#* Supported formats when use image based progress bar
#** bmp
#** jpg (crashes on 2.6.1.66)
#** png (crashes on 2.6.1.66)
# '''Status message''' (''Displays the patcher status'')
::You can change the size and the position of every element of the patcher, so there are almost no limits to what you can do - be creative. The easiest way to make a skin is to make a single photoshop file with layers for each part of the skin.

=Writing the Config=
Config.ini contains the following lines:

==[Config:Main]==
*RootURL='<nowiki>http://domain.com/patch/</nowiki>'
**The URL where you plan to store all data related to thor patcher.
*RemoteConfigFile='main.ini'
**The name of the 2nd part of the config (NOT the full path).
*TimeOut=0
**This option enables you to control how long the patcher will try to connect to your webhost before giving up.
**Format: time in seconds.
**0 = Default value.
**'''Don't''' change this unless you know what you are doing! Might lead to patcher not patching.
*StatusFile='server.dat'
** File that stores patch ID and possibly miscellaneous data in the future. Change it to fit your server.
*DefaultGRF='YourRO.grf'
**The main GRF that your server uses. This GRF will will be patched if you left target GRF field blank during making .thor file or patch from GRF/GPF.
*ClientEXE='Your RO.exe'
**The name of the executable that the patcher will launch after patching.
*ClientParameter='-1sak1'
**The parameter thor uses when calling your client exe. Useful when you want your players to be fully patched. leave blank when not using.
**'''Advice''': Change the parameter in your exe to something unique by hexing it, makes harder to bypass patching. Don't forget to change it in your config too.
*FinishOnConnectionFailure=false
**The user can only exit if the patch fails and the setting is set to false. If set to true, the user can continue to launch the game if the patcher is unable to connect to your webserver. Setting to true may lead to gravity errors and crashes.

==[Config:Window]==
*AutoResize=true
**The size of the patcher changes depending on the size of the background image. True or false.
*Style='none'
**Choose the style your window should have
**none : No border, window not resizable.
**single : Normal border, window not resizeable.
**sizeable : Normal border, window resizeable (would not work if windows_autosize = true).
*Width=1
**Width of your patcher (in pixels). Would not work if ''Autosize'' = true
**Possible values:
***1 to 10000
*Height=531
**Height of your patcher (in pixels). Would not work if ''Autosize'' = true
**Possible values:
***1 to 10000
*DragHandling=true
**Should the user be able to move the patcher window by dragging on background? Note that when setting this to false, users would have to move window like every other GUI application, but they will unable to move when ''Style'' is set to ''none''. True or false.
*Background='images/bg.bmp'
**Your background image path.
**Relative to location of your config.ini
***Example: c:\config.ini *> c:\images\bg.jpg
**Supported formats:
***JPG (no transparency)
***BMP (very first pixel at top left is choosed as transparent color)
***Partial Transparency (.png) is not supported at this moment
**Will be packed into the patcher.exe
*FadeOnDrag=true
**Whether or not the window will create a fade effect when clicked and dragged (similar to window in RO). True or false.

==[Config:BGM]==
*File=
**File name.
*Loop=True
**Do you want the song to play over and over (AKA Loop)? True or false.
*Volume=20
**How loud the song is. 1-100 in volume.
*Directory=
**Where the song is located. When this field is set, patcher will randomly choose a music file in the specified directory. Note that ''File'' will be ignored in this case.

==[Config:Misc]==
*Title='Your RO Patcher'
**Text displayed on the window title (if ''Style'' is not set to 'none'') and in taskbar.
*HideProgressBarWhenFinish=false
**Should the progress bar vanish when the patching is done? True or false.

==[ProgressBar:bar1]==
*Width=1
**Width of the progress bar.
*Height=1
**Height of the progress bar.
*Left=1
**Number of pixels to the left.
*Top=1
**Number of pixels away from the top.
*BackColorStart=$009DEEEF
**The background color of the progress bar when it is patching.
*BackColorEnd=$00C2F1F1
**The background color of the progress bar when it has finished patching.
*FrontColorStart=$006ED5B0
**Foreground color of the progress bar when patching.
*FrontColorEnd=$0080DDCA
**Foreground color when it is done.
*FrontImage=
**Foreground image name. (NOTE: Image must be placed in Tools\Images folder.)
*BackImage=
**Background image name. (NOTE: Image must be placed in Tools\Images folder.)
*Hook='ProgressChange'
**Most likely something to do with programming and shouldn't be messed with.

==[Label:Status]==
*AutoResize = false
**When set to true, this label will change its width depend on text size. True or false.
*Width=369
**How wide the text area is in pixels. Ignored when ''AutoResize'' is true.
*Height=
**How tall the text area is in pixels. Ignored when ''AutoResize'' is true.
*Left=15
**How far from the right the text area is in pixels.
*Top=498
**How far from the top the text area is in pixels.
*Alignment='center'
**Text alignment. Can be center, left, or right.
*FontColor=$000000
**Color of the text.
*FontName = ''
**If you desire a different font to be displayed, you put the name here. Users must have the font installed in order to see the font, so downloaded fonts most likely won't be seen.
*FontSize =
**Text size.
*Text=''
**Text to be displayed at the bottom of the progress bar.
*Hook='StatusChange'
**Programming related.

==[NoticeBox:Box0]==
*Width=347
**Width of notice box.
*Height=250
**Height of notice box.
*Left=21
**How far from the left.
*Top=217
**How far from the top.
*URL='<nowiki>http://domain.com/patch/notice.html</nowiki>'
**URL to notice HTML file that will be displayed on startup, as long as the player is connected to the internet.

==[Button:Start]==
* Default='images/start.png'
** Image of the button in normal state.
* OnHover='images/start2.png'
** Image of the button when the user places the mouse cursor over it.
* OnDown='images/start3.png'
** Image of the button when the user presses the button.
* Left=1
** X coordinates of the button (in pixels).
** Counted from the left of the background image.
* Top=1
** Y coordinates of the button (in pixels).
** Counted from the top of the background image.

==[Button:Exit]==
* Default='images/exit.png'
** Image of the button in normal state.
* OnHover='images/exit2.png'
** Image of the button when the user places the mouse cursor over it.
* OnDown='images/exit3.png'
** Image of the button when the user presses the button.
* Left=1
** X coordinates of the button (in pixels).
** Counted from the left of the background image.
* Top=1
** Y coordinates of the button (in pixels).
** Counted from the top of the background image.

==[Button:Cancel]==
* Default='images/exit.png'
** Image of the button in normal state.
* OnHover='images/exit2.png'
** Image of the button when the user places the mouse cursor over it.
* OnDown='images/exit3.png'
** Image of the button when the user presses the button.
* Left=1
** X coordinates of the button (in pixels).
** Counted from the left of the background image.
* Top=1
** Y coordinates of the button (in pixels).
** Counted from the top of the background image.

==Custom Buttons==
<code><pre>
[Button:Name]
Default='images/button1.png'
OnHover='images/button2.png'
OnDown='images/button3.png'

Left=80
Top=406
Mode=1
Action='http://example.com'
</pre></code>
Declares a new button
*[Button:Name]
** Name or ID, must be unique for each and every button
*Default='images/button1.png'
** image of the button on normal state
*OnHover='images/button2.png'
** image of the button when mouse hovers it
*OnDown='images/button3.png'
** image of the button when the user click on it
*Left=80
** X coordinate of the button (in pixels)
** Counted from the left of the background image.
*Top=406
** Y coordinate of the button (in pixels)
** Counted from the left of the background image.
*Mode=1
** Functions of the button
*** Possible Mode values:
**** 1 : Open URL
**** 2 : Open File/Program
**** 3 : Displays a Message Box
**** 4 : Minimize window
**** 5 : Close Patcher
**** 6 : Makes this button as clone start button behavior
*Action='<nowiki>http://example.com</nowiki>'
** Applies on modes 1-3

==Custom Notice Box==
<code>
<pre>
[NoticeBox:Name]
Width=347
Height=250
Left=21
Top=217
URL='http://domain.com/patch/notice.html'
</pre>
</code>
Declares the notice box
*[NoticeBox:Name]
** Name or ID, must be unique for each and every notice boxes
*Width=347
** Width of notice box.
*Height=250
** Height of notice box.
*Left=21
** How far from the left.
*Top=217
** How far from the top.
*URL='<nowiki>http://domain.com/patch/notice.html</nowiki>'
** URL to notice HTML file that will be displayed on startup, as long as the player is connected to the internet.

=Writing a language.ini=
The langauge.ini is a fast way to switch your patcher's langauge without having to change the config file.
It contains the same configuration lines as the language part of the config.ini

* getting_info=Getting Information...
** is displayed when the patcher connects to the webhost
* update_patcher=Updating Patcher...
** is displayed when the patcher updates itself
* update_client=Updating Client...
** is displayed when the patcher upates the client
* repacking=Repacking resource files...
** is displayed while the patcher repacks the grf
* saving_res=Saving Resource...
** is displayed when the patcher generating table
* getting_file=Getting file %s.
** is displayed when the patcher is downloading a file.
** "%s" will be replaced with the filename of the file
** if you want to use the "%" symbol in this message, write it as "%%"!
* need_defrag=Data fragment reached %u%%, would you like to defrag now?
** is displayed when the grf fragmentation reaches a certain level (configured in the main.ini)
** "%u" will be replaced with a numeric value
** if you want to use the "%" symbol in this message, write it as "%%"!
* defraging=Defragment in process...
** is displayed while the patcher defragments the grf
* confirmation=Waiting Confirmation...
** is displayed while waiting for a reply from the user
* client_locked=Client Application is locked
** is displayed when trying to patch a running client
* failed_to_communicate=Failed to communicate with server
** is displayed when the patcher can't connect to the webhost
* failed_to_get=Failed to get %s
** is displayed when the patcher cannot find a file on the webhost
** "%s" will be replaced by the filename of the file
** if you want to use the "%" symbol in this message, write it as "%%"!

=Packing the Config Into the Patcher=

Make sure the following files are in the same folder before proceeding:
* config.ini
* language.ini (optional)
* Skin Files
* ConfigPacker.exe

Now, we are going to pack the config into the patcher.
* Start ConfigPacker
* Select your copy of Thor.exe by clicking "browse"
* Press "Combine"

=Writing the main.ini=
==[Main]==
*allow=true
** Allow patching or not.
*Force_Start=false
*policy_msg=

* file_url=<nowiki>http://domain.com/patch/data/</nowiki>
** the URL where you plan to save your patches in
*** supports both HTTP and FTP
**** HTTP: use the following format:
***** <nowiki>http://domain.com/dir/</nowiki>
**** FTP :
***** connecting as anonymous:
****** <nowiki>ftp://domain.com/dir/</nowiki>
***** connecting with user & pass:
****** <nowiki>ftp://username:password@domain.com:port/dir/</nowiki>
****** username is required if you want to use a password
****** if you don't specify the port, the default one will be used

==[Patch]==
*ClientSum=
*PatcherSum=
** Can be obtained from CheckSum tool.

*ClientPath=
*PatcherPath=
** Filename of patch file when update patcher/client. These files should store in the place with other patch files.

*PatchList=plist.txt
** Patch list file.

=Writing the Notice Page=
The archive includes a sample notice.html, but you can use other formats like .php, .asp etc. By doing so, you also need change notice_file in '''config.ini'''.

If for example, you would like a feed exported from your "News and Announcements" sub-forum (or variations thereof), you could easily include a small snippet of php on the page to echo out a few of your latest topics. For example, the following code would be sufficient to output the latest 5 topics in your notice.php:

<?php
$content = file_get_contents('http://mywebsite.com/forums/index.php?/rss/forums/1-announcements/');
if($content) {
$i = 0;
$xml = new SimpleXmlElement($content);
$newsAmount = (int)5;
}
?>

<?php if(isset($xml) && isset($xml->channel)): ?>
<?php foreach($xml->channel->item as $rssItem): ?>
<?php $i++; if($i <= $newsAmount): ?>
<nowiki><div style="padding-left: 20px;"></nowiki>
<nowiki><a href="<?php echo $rssItem->link ?>"><?php echo $rssItem->title ?></a></nowiki>
<nowiki></nowiki>
<?php echo $rssItem->description ?>
<?php echo date('M j, Y', strtotime($rssItem->pubDate)) ?>
<nowiki></nowiki>
<nowiki> </nowiki>
<nowiki></div></nowiki>
<?php endif ?>
<?php endforeach ?>
<?php endif ?>

You will need to ensure that the forum topics you are exporting have an RSS feed being output. If not (in the case of IPB especially) you will need to login to the admin panel and create the export feed manually.

=Patch List=
By default, the file containing a list of your uploaded patches is called plist.txt, and is defined in the main.ini file situated on your web host. Patches should be defined in sequential number like so:
...
15 20131106_newclient.thor
16 20131106_GM_Fix.thor
17 20131106_Wings.thor
... etc

=See Also=
* [[GRF]]

==External Links==
* [http://thor.aeomin.net/ Official Thor Patcher Homepage]
* [http://www.eathena.ws/board/index.php?showtopic=171632 Official Thor Patcher Thread]

[[Category:Patchers]]

Sakray

2014-01-23T04:43:05Z

Dastgirpojee: /* History */

'''Sakray''' is what official [[Ragnarok Online]] test servers are usually referred to. They are used to test new content and features, before they get installed on the normal servers. When the name "Sakray" is used alone, it typically refers to the kRO Sakray server. Sakray servers are always accessible via a separate client, which is available through a separate download.

==History==

===Renewal===
Gravity discontinued the original Sakray development after June 17, 2009, where the last Sakray client was released, and replaced it with Sakray Renewal, which is mostly referred to as "Renewal" or "RE".

On kRO, on July 28th Gravity set up a new test server for their Ragnarok Renewal Project. The Renewal is a full scale re-balancing of Ragnarok. The plan is to make RO more accessible to users, and more in line with modern day MMORPG's. In addition, the new mechanics are intended so that they can easily add and improve on current game content (such as 3rd jobs) without destroying game balance.

The intention for renewing Ragnarok Online, was partially the decreasing interest in the game, due to it's age and lack of features present in latest MMORPG, such as tabbed chat or safe skill point distribution, which were part of the first round of renewal, the interface renewal. Further changes include an overhaul in the stat, damage and experience calculation.

Schedule for tests of Renewal Server:
* Closed Beta Test
Start Date: 2008/07/30
Server Name: Sakray Renewal Test Server
Participation: Accepted testers
Test Period: 2008/07/30 ~ 2008/08/27 (4 weeks)
* Open Beta Test
Start Date: 2008/08/27
Server Name: Sakray Renewal Test Server
Participation: Anyone
Test Period: 2008/08/27 ~ 2008/09/24 (4 weeks)

==Usage==
[[Hexing|Hexed]] kRO Sakray clients are the most used clients with [[Hercules]], although a few people prefer using kRO (live server) clients or clients from different service providers.

[[Category:Basics]]

AID

2014-01-23T04:35:33Z

Dastgirpojee:

An '''account id''' uniquely identifies a player (gender Female(F) or Male (M)) or server account (gender S) not only inside the database, but also in inter-server communication and in associations of data with an account, such as [[Variables|account variables]]. Account ID is also used to save the character data, and is uniqu. In-game it is mostly used as a [[GID|game id]]. It should not be confused with [[CID|character id]] which identifies a character.

[[Category:Basics]]

Adding a Script

2014-01-04T16:36:11Z

Dastgirpojee: /* Tips & Hints */

== Adding and Activating Scripts ==
Scripts are usually kept in the ''npc'' folder for the sake of organization even though scripts can contain more than a mere NPC. All files are saved as text files. Scripts cannot be loaded on to the server unless their text file is activated in a *.conf file.

=== A New Script ===
New scripts must be saved as a text file first. The file may be located anywhere in the Hercules directory, but is in the ''npc'' folder by default.

=== Configuration Files ===
Any text editor may be used to edit *.conf files. The ''npc/*.conf'' files are used to determine which script text files should be loaded. There are about a dozen *.conf that handle different groups of scripts for the purpose of organization. It does not matter which *.conf holds your custom scripts as long as the path is correct.

Typical *.conf entry layout:
npc: npc/path/to/yourscript1.txt
// npc: npc/path/to/yourscript2.txt
Note how the second line is preceded with a double slash. Content on the same line after double slashes will not be parsed. In other words, ''script2.txt'' will not be loaded. The slashes can be used to write comments.

{{git|npc/scripts_main.conf}} determines which of the *.conf will be read by the server.
import: npc/path/to/configuration.conf

=== The NPC in Game ===
After adding the script, it must be loaded before the script contents take effect in game. There are a few ways to do this.
* The map server can be rebooted. This is generally the safest route though not the most convenient for active servers.
* The GM command '''@reloadscript''' maybe used in game, though this may cause monster spawn bugs.
* If a script needs to be reloaded because it has been edited, the GM commands '''@loadnpc''' and '''@unloadnpc''' may be used. This method is not convenient for script texts that contain multiple NPCs.

== Client Side ==
The NPC name used in examples is "Teddy".
===Lua===
The two files you will need to open and edit are "jobname.lua" and "npcidentity.lua". Jobname.lua will look like:

[jobtbl.NPCNAME] = "NPCNAME",
Example:
[jobtbl.TEDDY] = "TEDDY",
npcidentity.lua will look like:
["NPCNAME"] = NPCID,
Example:
["TEDDY"] = 587,
If your NPC has spaces in its name, its best to either remove them or replace them with underscores. So if the NPC's name was Brown Teddy the sprite's name would be Brown_Teddy.spr or BrownTeddy.spr and the lua files would be BROWN_TEDDY or BROWNTEDDY. Whatever ID you choose for your sprite, either NPC Sprite name(Case-Sensitive, In Capital Letters) or ID will be use in the script. The beginning of my script will look like:

xmas_in,111,107,3 script Teddy 587,{
xmas_in,111,107,3 script Teddy TEDDY,{

===Sprite===
The sprite part is straightforward, just Teddy.spr is fine, you don't need Teddy_m.spr or anything like that, but if you want to add m for male to the name you can do that, but it won't effect its functionality in-game. NPC sprites are located in data/sprite/npc.

== Tips & Hints ==
* If you are copy/pasting a script from a forum, be sure to check that the tabs are still intact.
* Remember that paths and file names are case sensitive.
* Remember to save after editing.
* Create your own NPC folder and *.conf file. This will make it much easier to keep track of your own scripts and can reduce the hassle when merging new revisions of Hercules. Follow the basic layout of the other *.conf files and remember to import the *.conf in {{git|npc/scripts_main.conf}}

[[Category:Scripting]]

Modeling

2013-12-29T13:20:52Z

Dastgirpojee:

[[Category:incomplete]]

== Modeling ==

While there is Borf's '3ds to RSM' converter tool, Borf has it added to Borf edit so use the one there as it is likely to be updated. Making a model that can be converted to RSM format is another issue. Someone who has done this can fill us in.

== What You Will Need ==

*Browedit
*3d Studio Max (Or something that can save to 3ds files)

== 3ds to RSM ==

Now the 3ds to RSM is a bit limited due to the fact the object must be fully textured and the textures be with the file (If your missing any it will make the tool list them as .bmp) and once converted to rsm the images have to be flipped upside down on the vertical axis and saved as bmp files... Ask Borf about that if you want more info.
While with these limitation the tool is easy to use, simply open Browedit, load a map (It won't do anything until you do), and under 'Tools > Convert 3ds to RSM' select your 3d Studio Max file and click 'open'. The plug-in will then create a .rsm file which you can then add to Browedit (add it to the model text file or your own model text file) and then to your maps.

== RSM to 3ds ==

To date there is nothing to convert RSM files to 3ds files.

[[Category:Mapping]]

Git

2013-12-29T13:20:40Z

Dastgirpojee:

[[Category:incomplete]]
==Preface==
This article will cover the '''Git''' details related to Hercules. '''Git''' is a version control system that allows multiple users to contribute to the development of Hercules, if permitted. It is also the most efficient method to downloading the source code of Hercules.

==About Git==
As mentioned above '''Subversion''' is a version control system that allows users to download the latest source code. It uses the structure of trunk and branch to declare the development code and the stable code. A '''trunk''' is referred to as the development code that needs to be tested and validated for bugs. A '''branch''' is typically used for developing larger features or as alternative development path, without breaking current trunk code. Exception to this is '''stable''', which is considered stable subset of trunk.

===Checkout===
When you '''checkout''' a piece of code, it is downloaded, along with all history, properties and files, onto your machine so you can make local changes or use it in a production environment.

===Commit===
When you '''commit''' a piece of code, you are uploading your changes back to the server and increasing the revision number of the SVN by 1. The increase in revision number by 1 is done no matter how many changes are made per commit. Each commit includes the author's name, what they changed and when they changed it, which can be viewed and referenced later.

Only members of the [[Staff|Hercules development team]] can commit code straight to the Hercules Git.

===Update===
When you '''update''' your SVN, you are taking your local copy of the SVN that was previously '''checked out''' and applying the latest updates from the server to it. In this operation, many files are changed, but some are added, deleted or moved. When you update your copy of the SVN, a lot of conflicts can happen, so keep an eye out of those.

===Making changes===
When you make a change to your copy of the Git on Windows, a number of different icons will appear in the directory of the SVN. Below is a brief explanation of what each of these icons mean:
{|
|[[Image:SVN_red.jpg|Modified SVN tag]]
|Changes have been made from the original downloaded script this indicates what scripts you have modified.
|-
|[[Image:SVN_yellow.jpg|Conflict SVN tag]]
|Conflicts with original script you need to search for the <<<<<<mine> and >>>>>>><mine> to see what parts are conflicting and change accordingly.
|-
|[[Image:SVN_green.jpg|Unmodified SVN tag]]
|No changes with original script have been made.
|-
|style="white-space:nowrap;"|[[Image:SVN_-.jpg|Generated SVN tag]] or [[Image:SVN_q.jpg|New SVN tag]]
|Files you added yourself that weren't in the original repository.
|}

===Obtain/Install Subversion===
Please see the [[:Category:Installation]] appropriate category for installation of Subversion on your operating system of choice and how to utilize it.

==Hercules Git Details==
You can find the root or index of the Hercules source code at the following link: <code>{{git||full}}</code>. This link can be used if you need to view a single file and don't want to dig up your "copy" of the source code.

===Hercules Trunk===
'''Hercules Trunk''' is used as the ''testing'' or otherwise development code. It has all of the latest features, but is not guaranteed to be bug or problem free.

You can checkout the trunk branch from the following link:
<code>{{git|trunk/}}</code>

===Hercules Developer Branches===
Each developer that contributes to the Hercules Project is welcome to their own folder on the SVN, where they may make their own branch. A lot of times, this separate branch is a testing bed for a new feature. You should never assume that any branch that is not trunk or not stable is usable. Often times, it is not.

==Using .diff/.patch files==
{{EntirePage|Diff}}
Often times, developers and contributors will release their work with a .diff or .patch file. these files are designed specifically to be applied to an SVN revision and 'patched' in.

In Windows, you can apply a diff or patch file by placing the diff file into the SVN directory, right clicking the diff or patch file, navigating to the Subversion menu and clicking 'Apply Patch'.

If the revision numbers are different, or the code is different in anyway, the patch will likely fail with the error message that the revision numbers do not match. The diff file will include some important symbols and numbers to help you apply them manually.
/path/to/file [Revision 233]
@@ +241,4 -241,4 @@
+ This line will be added at the line number or position indicated above.
- This line will be removed at the line number or position indicated above.
So in the file, we're to remove line 241 and replace it with the line that has the '+' next to it.

[[Category:Basics]]

Mob

2013-12-29T13:19:23Z

Dastgirpojee:

[[Category:incomplete]]
A [[Mob]] is basically a monster. Mobs range from Poring to Baphomet. Most commonly, the word 'mob' is used to refer to monster.

This page will contain all functions on mob.c and mob.h

[[Mob Once Spawn]]

[[Mob Get Random Id]]

[[Category:Source_Functions]]

Mapflag

2013-12-29T13:18:08Z

Dastgirpojee:

[[Category:incomplete]]
== Map Flags are used to set serval permissions on maps. ==
 

# Battleground
# GvG
# Nightenabled
# Nightmare
# Nobranch
# Noexp
# Noicewall
# Noloot
# Nomemo
# Nopenalty
# Nopvp
# Noreturn
# Nosave
# Noskill
# Noteleport
# Novending
# Nowarp
# Nowarpto
# Partylock
# Pvp
# Pvpnoguild
# Pvpnoparty
# Reset
# Skillduration
# Skillmodifier
# Town
# Zone

Battleground 
'''Description:''' Defines the Map as Battleground. 
'''File:''' npc/mapflag/battleground.txt 
'''Parameter:''' 2 ( Activate Scoreboard ) 

<code> usage: <map> mapflag battleground <parameter(Optional)></code> 
 
Gvg 
'''Description:''' Defines the Map as Guild Vs. Guild Map, so Guilds can Fight each other. 
'''File:''' npc/mapflag/gvg.txt 
'''Parameter:''' <none> 

<code> usage: <map> mapflag gvg</code> 

 
Nightenabled 
'''Description:''' Nightmode Effects on defined Maps. 
'''File:''' npc/mapflag/night.txt 
'''Parameter:''' <none> 

<code> usage: <map> mapflag nightenabled</code> 
 

Nightmare 
'''Description:''' Drops Player Items or Equipments on player death. 
'''File:''' npc/mapflag/nightmare.txt 
'''ID:''' ItemID,random 
'''Type:''' inventory, equip, all 
'''Percent:''' Droprate 

<code> usage: <map> mapflag pvpnightmaredrop <id>,<type>,<percent></code> 

 
Nobranch 
'''Description:''' Disables Dead Branch / Bloody Brunch / Red Brunch and Porinx Box. 
'''File:''' npc/mapflag/nobranch.txt 
'''Parameter:''' <none> 

<code> usage: <map> mapflag nobranch
</code> 

Noexp 
'''Description:''' Disable Exp gain for Players. 
'''File:'''npc/mapflag/noexp.php 
'''Parameter:''' <none> 

<code> usage: <map> mapflag noexp</code> 
 

Noicewall 
'''Description:''' Disable Icewall on a Map. 
'''File:''' npc/mapflag/noicewall.txt 
'''Parameter:''' 

<code> usage: <map> mapflag noicewall</code> 
 

Noloot 
'''Description:''' Disable loot on a Map. 
'''File:''' npc/mapflag/noloot.txt 
'''Parameter:''' <map> mapflag noloot 

<code> usage: <map> mapflag noloot</code> 
 

Nomemo 
'''Description:''' Disable /memo on a Map 
'''File:''' npc/mapflag/nomemo.txt 
'''Parameter:''' <none> 

<code> usage: <map> mapflag nomemo</code> 

 
Nopenalty 
'''Description:''' Disable death penalty. 
'''File:''' npc/mapflag/nopenalty.txt 
'''Parameter:''' <none> 

<code> usage: <map> mapflag nopenalty</code> 
 

Nopvp 
'''Description:''' Disable PvP (Player vs. Player) on a Map 
'''File:''' npc/mapflag/nopvp.txt 
'''Parameter:''' off 

<code> usage: <map> mapflag pvp <parameter></code> 
 

Noreturn 
'''Description:''' Disables the Return Warp. 
'''File:''' npc/mapflag/noreturn.php 
'''Parameter:''' <none> 

<code> usage: <map> mapflag noreturn</code> 
 

Nosave 
'''Description:''' Disables Autosave on a Map, if the Parameter isnt defined, Warp to the last field. 
'''File:''' npc/mapflag/nosave.txt 
'''Parameter:''' SavePoint 

<code> usage: <map> mapflag nosave <parameter(Optional)></code> 
 

Noskill 
'''Description:''' Disable Skills 
'''File:''' npc/mapflag/noskill.txt 
'''Parameter:''' <none> 

<code> usage: <map> mapflag noskill</code> 
 

Noteleport 
'''Description:''' Disable all kinds of Teleport. 
'''File:''' npc/mapflag/noteleport.txt 
'''Parameter:''' <none> 

<code> usage: <map> mapflag noteleport</code> 
 

Novending 
'''Description:''' Disable Vending 
'''File:''' npc/mapflag/novending.txt 
'''Parameter:''' <none> 

<code> usage: <map> mapflag novending</code> 
 

Nowarp 
'''Description:''' Disable @GO 
'''File:''' npc/mapflag/nowarp.txt 
'''Parameter:''' <none> 

<code> usage: <map> mapflag nowarp</code> 
 

Nowarpto 
'''Description:''' Disable Warp to 
'''File:''' npc/mapflag/nowarpto.txt 
'''Parameter:''' <none> 

<code> usage: <map> mapflag nowarpto</code> 
 

Partylock 
'''Description:''' Disables Party modifications 
'''File:''' npc/mapflag/partylock.txt 
'''Parameter:''' <none> 

<code> usage: <map> mapflag partylock</code> 
 

Pvp 
'''Description:''' Defines the Map as Player vs Player Map 
'''File:''' npc/mapflag/pvp.txt 
'''Parameter:''' <none> 

<code> usage: <map> mapflag pvp</code> 
 

Pvpnoguild 
'''Description:''' Ignore Aliances on Guild vs Guild Maps 
'''File:''' npc/mapflag/pvpnoguild.txt 
'''Parameter:''' <none> 

<code> usage: <map> mapflag pvpnoguild </code> 
 

Pvpnoparty 
'''Description:''' Ignore Party on Player vs Player Maps 
'''File:''' npc/mapflag/pvpnoparty.txt 
'''Parameter:''' <none> 

<code> usage: <map> mapflag pvpnoparty</code> 
 

Reset 
'''Description:''' Disable Neuralizer Item(12213) usage 
'''File:''' npc/mapflag/reset.txt 
'''Parameter:''' <none> 

<code> usage: <map> mapflag reset</code> 
 

Skillduration 
'''Description:''' Set Duration for a Skill on a Map 
'''File:''' npc/mapflag/skillduration.txt 
'''Parameter:''' 0-...(?) 

<code> usage: <map> mapflag skillduration <parameter></code> 
 

Skillmodifier 
'''Description:''' Set the Damage for a Skill on a Map 
'''File:''' npc/mapflag/skillmodifier.txt 
'''Parameter:'''0-...(?) 

<code> usage: <map> mapflag skillmodifier <parameter></code> 
 

Town 
'''Description:''' Defines a Map as a Town. 
'''File:''' npc/mapflag/town.txt 
'''Parameter:''' <none> 

<code> usage: <map> mapflag town</code> 
 

Zone 
'''Description:''' Flags maps as part of zones 
'''File:''' npc/mapflag/zone.txt 
'''Parameter:''' see mapzonedb.txt 

<code> usage: (?) mapflag zone Aldebaran Turbo Track (?)</code> 
 
[[Category:Scripting]]

CID

2013-12-29T13:17:11Z

Dastgirpojee:

[[Category:incomplete]]
A '''character ID''' uniquely identifies a character, not only inside the database, but also in inter-server communication and association of data with a character, such as [[Variables|character variables]] or [[Status_List|status ailments]]. The character ID fulfills the same role as a combination of [[AID|account ID]] and character's slot ID, which means, if two character ids match their account IDs are automatically the same as well.

The Character ID typically increments starting from 150000 and going up.

[[Category:Basics]]

Spriting

2013-12-29T13:15:40Z

Dastgirpojee:

[[Category:incomplete]]

== Creating Your Own Frames ==

You will need

* Image Editing Software (e.g. [[wikipedia:Adobe_Photoshop|Photoshop]])
* Concept
* Skill

When creating a new image, it is recommended that you use the bitmap format. The size itself depends on what it is you are planing to make. It does not need to be a particular size (only the inventory item sprite and .bmp image must have a size of 24x24 px, it is recommended that the drop sprite be this size too), but remember the bigger it is the more likely it is to look odd inside the game (and if your frames are too big, there is a big chance of getting an error ingame). The background needs to 'Magenta'. The hexadecimal format of this color is #FF00FF. The RGB for this color is R 255, G 0, B 255.

Now that you have the size and everything figured out, its time to change it from .bmp to indexed color. Download this file: [[RO Pixeling Colors|RO common colors]], then navigate to Image > Mode > Indexed Color... In the window that pops up, the palette can be anything you want, but if forced you select Custom... Then select load and change file type from .act to .pal, then find the .pal file then select and open it, it will be wherever you saved the file to. Once it has loaded, make sure the colors are 256, then select OK, then you will now have an image compatible with ragnarok, and you can now draw out your image. After this you can save your image as .bmp (bitmap).

You must get familiarized with this color table (you can access to your color table in Photoshop through Image > Mode > Color Table). First color in the color table is the transparency color. This means that ingame, this color won't appear. This color must be #FF00FF for inventory items (you can change the colors of the color table by clicking on them. You can also make color gradients by selecting a group of colors if you are working with Photoshop). It can be any other color for Mobs, Jobs, Headgears, etc. However, It is recommended to use this color as background transparency color. Make sure background color is the first color in the color table. It is common that color #FF00FF (magenta) appears as the third color in the color table, and not first. If you are working with inventory items images, you must change this color to any other color and make first color #FF00FF. Then, you must change the background color to #FF00FF manually (replacing the background color for #FF00FF). We do this because you may have two magenta's in your color table (one in the first cell and another one in the third). If this happens and you make your background color #FF00FF you may be using the third color, and not first. What will happen then? It will make a part of your inventory skin background disappear. So background color must be always the first color in the color table, and when we are working with inventory items, it also must be color #FF00FF.

Some spriters usually use some neon colors as references, to make the edges of their sprite before coloring it. It is recommended you start making only the edges, so you can concentrate only in the perspective and size of your sprite without caring about shading. Neon colors are pretty visible, so if you happen to need them, add some neon colors to your color table and then use them in your frame.

Finally, when you finished making your base image for pixeling, you can put an image of the color table and pick colors with the eyedropper. If you are working with paint, in example, you can cut and paste an image with all the RO common colors. There is a small [http://www.divinero.net/devilevil/PixelingColorsTable.bmp table of RO colors] that you can use for this.

== Making A Sprite ==

As soon as you have one frame (8bits/256 colors bmp image), you will be able to create your sprite. For this, you will need a SPR maker. You can use [http://www.divinero.net/devilevil/archivos/tools/SPRConviewer.rar SPR Conviewer] (made by bakausagi) to make your sprite. Once you opened SPR conview, you will have to go to "Convert > Bmp to SPR" (only works with 8 bits bmp images). Click on "Add" and select all your frames. Try to name them like "Frame1", "Frame2", etc. and then select them all at the same time. If not, the order of frames in the sprite may not be correct. Avoid using control + click to add more frames. Select them all and if you selected something you don't want, just use control + click to deselect it. But don't use it to select frames because it may mess the frames up. Then, browse the directory where you want to save the sprite. When you finished with that, disable "encode" (because the frames may appear messed up and cut). Click convert and then open the sprite in conview to make sure it looks right.

There are other sprites that don't use 8 bits bmp images, but 32 bits TGA images. Those can only be made with [http://ratemyserver.net/index.php?page=download_tool Actor] (either 1 or 2). You must add image per image and then save it as a sprite. You can't open these sprites with SPR Conview. The making of this sprite is different and more advanced, but you will be able to use four channels (RGB and Alpha).

== Editing a Sprite ==

Remember that if this is a custom sprite that someone else made, to first ask permission before editing the sprite. Use a tool like SPR Conview to first convert the sprite from .spr (sprite) format to .bmp (bitmap) format. To be safe your sprite should have the same frame's as the one you are editing (if you plan to make a whole new sprite based off the original), but it is not required. If you are to share your sprite with the community, please include the words "Originally made by: (Username here)", as the original owner may get angry.

== Simple Way To Prevent Theft ==

'''Note: This doesn't guarantee that your sprite is safe. But if this frame is included you have definitive proof that the sprite is yours.'''

Simply include a frame with the sprite that has your username or name on it, it may show up in game depending on what kind of sprite it is. Just make sure you have all the frames required filled, then include one extra frame with your credits. For example the drop sprite for an item only needs one frame, so you can include a second with your credits. The maximum size the credit frame can be is 179x33.

If you had different versions of the sprite you can also include one frame or a screen shot of the frames as evidence.

You can also put your username on the collection image. This can be easily removed from the folder, but most servers do not remove the collection image.

== See also ==
* [[:Category:Data|Data]]
* [[:Category:Database|Database]]
* [[Palettes]]
* [[Sprite Recolors]]
* [[Pixeling]]

[[Category:Spriting]]

Palettes

2013-12-29T13:14:05Z

Dastgirpojee:

{{merge
|target=[[Alternate Palette Guide]]
|talk=Talk:Alternate Palette Guide
|date=July 2010
}}

== What you need ==

*SPR Conview
*Photoshop or something else that can make .pal palette files

== Editing Pallets With Photoshop ==

Editing pallets with Photoshop is a simple task. Simply load a sprite with a sprite viewer such as SPR Conview or SprTool+4-6 and export a single frame of the sprite as an image and load it with Photoshop. If your doing job sprites use a image from the job class you wish to make your pallet for and the same goes for hairs, head gear and monsters. As each sprite can have it's own pallet.

[[Image:SPR Conview.jpg]]
[[Image:sprite.jpg]]

Once loaded into Photoshop load the color table via the 'Image > Mode > Color Table' like so:

[[Image:load color table.jpg]]

If the color table is grayed out then the image isn't 256 colors and you won't be able to proceed. Once the color table window is up you'll see the range of colors available and used in the original sprite. Edit them is simple, either click a single color box or select a group (Selecting a group allows you to easily create a gradient range of colors by picking a light color and then picking a darker color, remember to click the 'ok' button.) then pick the new color or enter in the color values into any of the color boxes.

[[Image:edit color table.jpg]]

Once your new pallet is created simple click the save button in the color table window and save your pallet to a .pal file.

== Editing The .Pal File For Use in Ragnarok With Notepad ==

Ragnarok Online Pallet files are simply normal pallet files (.pal) with the header removed. Simply open the file like so

[[Image:notepad1.jpg]]

Then selecting whats highlighted in the image and delete it and save. It's that simple.

== Editing The .Pal File For Use in Ragnarok Without Notepad ==

If you have a tool or something please fill in this area.

== Replacing A Sprite's Pallet ==

Replacing a sprite's pallet in order to recolor it there are a few options, the most simple and probably the easiest way is to load the sprite into SPR Conview and under 'Pallet > Open Pallet' select the pallet you made before (normal non RO pallet) and then save the sprite. It's that easy.

== Client naming scheme for palettes ==

Cloth palettes go to '''data\palette\¸ö\''' (data\palette\몸\), each file name follows the pattern '''<jobname>_<gender>_<palette id>.pal''', ex. ¸¶¹ý»ç_¿©_4.pal (마법사_여_4.pal) for a female wizard palette).

The hair palettes go to '''data\palette\¸Ó¸®\''' (data\palette\머리\) and follow the pattern '''¸Ó¸®<head sprite id>_<gender>_<palette id>.pal''', ex. ¸Ó¸®8_¿©_2.pal (머리8_여_2.pal) for a female head sprite 8.

== Technical Support, or FAQs ==
*Q: My palettes won't show up in game, it says invalid number, I cannot access my palettes in the dye changer. How do I fix this?
*A: Athena servers must have the conf settings changed to support new palettes for dyes before commands and npcs can use them. Once the conf is edited the dye npc your using must also have it's max dyes increased in number or players will not be able to select any new dyes. Also not all jobs have their own pallet files. Most jobs will use the pallets of the first jobs that come before them instead of using their own, this was done in order to save space in the grf file and thou save on download bandwidth, also time and effort in making them.
*Q: My palette shows up as black with a bunch of neon lines and crap. Why?
*A: This could be a variety of things. The main reason is usually because they are not places in the right spot, and your client just doesn't error for palettes. This is due to the client not finding any pallet files because their either in the wrong place or incorrectly named. Job pallets and hair pallets have their own folders along with a folder for each sex and then the file name is made up of the job name (or hair) sex and then the number pallet. Another reason could be that you didn't convert it to RO format by removing the things pictured above. Make sure you do that.

[[Category:Spriting]]

[[Category:incomplete]]

GDB

2013-12-06T10:28:36Z

Dastgirpojee: /* Using gdb with Hercules */

GDB stands for GNU Debugger. It is a program for *nix related systems that allows you to view stacktrace and coredumps of your servers if it crashes.

= Getting GDB =
Typically GDB comes installed on most *nix distro's. It comes installed on FreeBSD 7.1-RELEASE or newer if the ports collection is installed. Typically, it will be located in /usr/bin/gdb, but if it is not, you can either compile it from source or install it using your package manager for your distribution.

== Debian Based (apt-get, aptitude or synaptic) ==
On Debian based systems, you can use apt-get or aptitude, or the synaptic package manager to install gdb. If you prefer the terminal, you can issue ONE of the following to install gdb:

[sudo] aptitude install gdb
[sudo] apt-get install gdb

If you have access to gdm and the synaptic package manager, you can simply search for 'gdb' and mark for complete installation.

== YUM based (Redhat/CentOS) ==
On YUM based systems, you can simply issue the following to install gdb via RPM packages:

yum install gdb

== *BSD based ==
Typically GDM will come with an install of FreeBSD, but if it's not, it is best to make it from source, skip ahead.

== Compiling from source ==
Use your favourite download manager (wget, etc) to get the .tar.gz of the latest stable version of gdb from gdb's website. (http://www.gnu.org/software/gdb/)

Extract the .tar.gz using the following command:

tar -zxf gdb-x.xx.tar.gz

You need a GCC compatible compiler, so if you don't have one, get one now. there is a 99% chance that your distribution comes with a gcc compiler.

./configure && make && make install

Should install it for use. If you're on a *BSD based system, you may have to issue the following command to be able to use it.

% rehash

= Using gdb with Hercules =

Go to Your Hercules Folder and type the following command

ulimit -u unlimited

Restart the server then,
Find out which program(map/char/login server) crashed and it's core file (should be named the same as the server file with an additional ".core" extension).. then on the console, type:

gdb xxx-server xxx-server.core

'''[xxx = map/char/login (The one which is crashing)]'''

You should get some limited output of the problem, or if the servers do not have a trace, you will get the following error:

No stack.

If it says Dump file was not found, then type the following command(The file is saved with other name)

gdb xxx-server core

'''[xxx = map/char/login (The one which is crashing)]'''

If a valid dump was found, you should get a prompt

gdb>

At that prompt, type:

gdb> bt full

And that will give you a full output of the problem area and a line number in which you should look for the crash. This just told you where the crash is located and what line you should look at to fix it. If you feel that is an Hercules development problem, feel free to submit a bug with that full report and one of the core developers can look into it.

= See Also =
* [http://www.gnu.org/software/gdb/download/ Download page for GDB]
[[Category:Debugging]]