Hercules Wiki - User contributions [en]

Hercules Hierarchy

2014-02-01T22:18:46Z

Via: Some housekeeping.

= Staff Titles =
Ordered alphabetically.<br/>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]

== 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/50-michieru/ Michieru]
* [http://hercules.ws/board/user/192-wolf/ Wolf]

== Global Moderators ==
Global Moderators are individuals who moderate all of the forums excluding International Communities, however, may still moderate.<br/>
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.<br/>
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]

== Int'l Moderators ==
International Moderators are individuals who moderate their respective International Community.<br/>
They are solely responsible in making sure their respective community is cleaned by moving, locking, removing, and cleaning topics of spams.<br/>
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 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/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]]

User:Via

2014-01-29T11:08:24Z

Via:

===Introduction===
Welcome to my user page. I joined here in January 2013, to learn and to share my knowledge.

==Personal==
* Alias: Mumbles (formerly Via)
* Hometown: San Francisco, California, USA
* Occupation: Student
* School: City College of San Francisco
* Homepage: http://facebook.com/datmumbles

==Hercules==
* [[Special:Contributions/Via|My Contributions]]
* [[Special:WantedPages|Wanted Pages]]

Basic Scripting

2014-01-28T20:22:24Z

Via: /* NPC */ Formatting. o-o

==The Basics==

Scripts control all NPCs, warps, mob spawns, shops, and quests you will find in the game--and nearly everything else! Clearly they play a large part in customizing a server, but learning isn't very hard.

Scripts are built up of predefined script commands, all of which can be found in {{git|doc/script_commands.txt}} (for explanations, see [[:Category:Script_Command|Script Commands]]). Every line should begin with a command and the argument it takes, and must end in a semicolon (or you'll get mapserver errors!). Arguments are usually separated by commas, and are sometimes contained in parentheses () or curly brackets {}. Tabs and proper indentation are standard scripting measures.

Scripts are saved as text (*.txt) files, so all code can be written in Notepad. There are also a lot of scripting programs to use: the most recent and comprehensive one is [http://rathena.org/board/topic/56484-enpc-script-editor/ Vince's eNPC]. All defined functions are highlighted, with an autocomplete feature included, and pressing "F1" will display the corresponding explanation for any command.

==Structure==

===NPC===
A '''Script NPC''' will look something like the following:
prontera,156,145,4 <tab> script <tab> Test NPC <tab> 58,{

The first section is the map location of the NPC, followed by its coordinates in x,y and the direction the NPC will face. Direction numbers are counted counterclockwise in 45º increments, with 0 being the center: <br>

[1][0][7] <br>
[2][  ][6] <br>
[3][4][5] <br>

After the first tab, the type of script is defined. For our purposes, it'll stay "script" for now, but can also be function, shop, or cashshop, for starters. <br>
The name of the NPC is next. You can use up to 24 characters, so make it unique! Any duplicates will cause warnings or errors, and the NPC will just be automatically renamed anyway. <br>
The last number is for the sprite (Ai4rei's sprite list can be found [http://nn.nachtwolke.com/dev/npclist/ here]). It's followed by a comma and open curly bracket, marking the beginning of the script contents. Of course, the script must also end in a curly bracket.<br>

===Function===
A '''Function script''' will look almost identical to:
function <tab> script <tab> Function Name <tab> {

The words "function" and "script" won't change; the name must also be unique. All functions can be called using the "callfunc" command. <br>

===Shop===
A '''Shop''' starts like a normal script:
prontera,156,145,4 <tab> shop <tab> Fruit Store <tab> 58,512:-1,513:1000

The first section defines the map, coordinates, and direction. The word "shop" replaces "script" (alternately, "cashshop" will use Cashpoints instead of Zeny). The name and sprite ID follow, then a comma. <br>
Items in the shop are defined in an ID:Price format. A price of -1 uses the default price in item_db.txt. Be sure the price is not too low, or a you will open a Zeny exploit in your server! <br>

==Fundamentals==

You can always look up commands that you need--even the best scripters don't have everything memorized. There are a few fundamentals that you should know by heart, though, since they are so commonly used.

===Message===

*mes "<string>";
This is the most basic command. Start the line with the word mes, then enter the message in quotes (don't forget the semicolon at the end!). <br>
To add color, simply add ^ and the hex code anywhere in the message. A list can be found [http://www.immigration-usa.com/html_colors.html here]. <br>

''As an example:''
mes "[^FF0000Test NPC^000000]";
mes "Hello!";

''Will display:''
[<span style="color:#FF0000;">Test NPC</span>]
Hello!

===Labels, Goto, and End===

To create a label, type a label name and a colon at the start of a line. If the label does not end with an "end;" command, everything following the label will be read, so don't forget it between labels! <br>
To go to a label, use the simple "goto" command:
*goto <label>;

''Note that there are "special" labels that trigger whenever a specific event occurs. The name usually makes it obvious, but you can find explanations in script_commands.txt. Here is a brief sampling:''
OnClock<hour><minute>:
OnInit:
OnAgitStart:
OnAgitEnd:
OnTouch:
OnPCLoginEvent:
OnPCLogoutEvent:
OnPCBaseLvUpEvent:
OnPCJobLvUpEvent:
OnPCDieEvent:
OnPCKillEvent:
OnNPCKillEvent:
OnPCLoadMapEvent:

===Menus, Close, and Next===
{{EntirePage|Menus}}

*menu "<option_text>",<target_label>{,"<option_text>",<target_label>,...};
*close;
*next;
Menus create a set of options, which trigger labels when selected. The text in quotes is what will be displayed, followed by its respective label. Enter as many choices as you want, and end the last one with a semicolon instead of a comma. <br>
"Close" will close any message window that is open (from "mes" commands). <br>
"Next" will clear the message window, bringing up a fresh screen. <br>

''For example:''
mes "[Test NPC]";
mes "How are you doing today?";
menu "I am doing okay!",doingokay,"Not doing too well",bad;

doingokay:
mes "Glad to hear it!";
close;
end;

bad:
mes "Aww, I'm sorry about that.";
close;
end;

===Conditions, Variables, and Set===
{{EntirePage|Variables}}

*if(condition) {<script>;}
*else {<script>;}
Conditional statements "if" and "else" are the same as anywhere else. Multiple conditions can be specified: || means ''or'', while && means ''and''. == is ''equal'', != is ''not equal''. Inequalities can be used as well (<, >, <=, >=).<br>
The "else" can be omitted, and the brackets aren't necessary unless multiple commands follow a conditional statement. <br>

The type of variable used is defined in the name. There are permanent and temporary variables, as well as scope (temporary NPC), character, global, and global account. The default type is an integer, and adding $ as a suffix creates a string.<br>
Here are some example types, taken from script_commands.txt:
name - permanent character integer variable
name$ - permanent character string variable
@name - temporary character integer variable
@name$ - temporary character string variable
$name - permanent global integer variable
$name$ - permanent global string variable
$@name - temporary global integer variable
$@name$ - temporary global string variable
.name - NPC integer variable
.name$ - NPC string variable
.@name - scope integer variable
.@name$ - scope string variable
#name - permanent local account integer variable
#name$ - permanent local account string variable
##name - permanent global account integer variable
##name$ - permanent global account string variable

The "set" command is used to give a value (or string) to a variable:
*set <variable>,<expression>;

''The following script will pick a random number, store it as the temporary scope variable .@random, and display two different messages depending on the result:''
set .@random, rand(1,2);
if (.@random == 1) { mes "I like you! :D"; }
else { mes "I don't like you. Get out of here!"; }
close;

===Duplicating===

It would be a huge waste of time and space to code the same NPC over and over again. By duplication, an NPC can be created in multiple locations. <br>

Take a look at our old Test NPC:
prontera,156,145,4 <tab> script <tab> Test NPC <tab> 58,{
To be able to duplicate this, we will change the heading to this:
- <tab> script <tab> Test NPC#01::testnpc <tab> 58,{
The location doesn't need to be defined in the NPC, since it will be in the duplicates. <br>
The displayed name remains "Test NPC". But since NPC names must be unique, adding #01 separates this one from the rest, which will be #02, #03, etc. Lastly, ::testnpc is the reference name used for duplicating NPCs; this part is not displayed on the screen. <br>

After creating the base NPC, duplicates can be added anywhere to any file, so long as you use the same NPC name:
spl_fild03,150,150,7 <tab> duplicate(testnpc) <tab> Test NPC <tab> 58
niflheim,50,50,2 <tab> duplicate(testnpc) <tab> Test NPC <tab> 58
tha_scene01,140,190,4 <tab> duplicate(testnpc) <tab> Test NPC <tab> 58
The first part is ''map,x,y,direction'', as you're probably used to by now. <br>
To define a duplicate, the word "duplicate" followed by the NPC, in parentheses, is needed. The last two parameters are the display name and sprite ID (yes, you can change these, too!).

==Finished Product==

Here is an example using the features explained above:

prontera,156,145,4 script Test NPC::test 589,{
mes "Hello, how are you?";
mes "I am fine, how are you?";
menu "I am doing okay!",-,"Not doing too good",bad;
mes "That's good, I'm glad to hear that";
close;

bad:
mes "Awww, that makes me a bit ^FF0000sad^000000. Sorry to hear that.";
next;
mes "Would you like some zeny to help yourself feel better?";
next;
menu "Sure, give it to me!",L_zeny,"Naw, No zeny for me",-;
close;

L_Zeny:
mes "I can only give you zeny if you have 10,000 or less.";
if (Zeny > 10000) goto toomuch;
mes "You have 10,000 zeny or less, I see.";
set Zeny,Zeny+10000;
next;
mes "Hope you feel better!";
close;

toomuch:
mes "You have over 10,000 zeny, you must feel really good about yourself!";
close;
}

lhz_dun01,157,285,4 duplicate(test) Test NPC 859
hu_fild05,186,210,4 duplicate(test) Test NPC 859
yuno_fild07,221,179,4 duplicate(test) Test NPC 859
tha_scene01,139,194,1 duplicate(test) Test NPC 859

==Adding Scripts==
{{EntirePage|Adding a Script}}
For an NPC to be loaded, it needs to be added to a .conf file. This is typically ''npc/scripts_custom.conf''.<br>
Add a line, and enter your NPC file in the following format:
npc: npc/path/to/script.txt
That's it! You're finished!

==External Links==
'''Reference Manuals for scriping commands'''
* {{git|/doc/script_commands.txt}} Original documentation

'''Sprite lists'''
* http://nn.nachtwolke.com/dev/npclist/

'''Color Charts'''
* http://www.immigration-usa.com/html_colors.html
* http://www.december.com/html/spec/colorcodes.html
* [[wikipedia:Hex_triplet|Hex triplet]]
* http://www.colorschemer.com/online.html

'''Support, Request and Release'''
* [http://hercules.ws/board/forum/22-script-support/ Scripting support on Hercules Boards]
* #Hercules on irc.rizon.net : Main Hercules channel.

[[Category:Scripting]]

Basic Scripting

2014-01-28T20:20:53Z

Via: /* NPC */ Misinformation. :<

==The Basics==

Scripts control all NPCs, warps, mob spawns, shops, and quests you will find in the game--and nearly everything else! Clearly they play a large part in customizing a server, but learning isn't very hard.

Scripts are built up of predefined script commands, all of which can be found in {{git|doc/script_commands.txt}} (for explanations, see [[:Category:Script_Command|Script Commands]]). Every line should begin with a command and the argument it takes, and must end in a semicolon (or you'll get mapserver errors!). Arguments are usually separated by commas, and are sometimes contained in parentheses () or curly brackets {}. Tabs and proper indentation are standard scripting measures.

Scripts are saved as text (*.txt) files, so all code can be written in Notepad. There are also a lot of scripting programs to use: the most recent and comprehensive one is [http://rathena.org/board/topic/56484-enpc-script-editor/ Vince's eNPC]. All defined functions are highlighted, with an autocomplete feature included, and pressing "F1" will display the corresponding explanation for any command.

==Structure==

===NPC===
A '''Script NPC''' will look something like the following:
prontera,156,145,4 <tab> script <tab> Test NPC <tab> 58,{

The first section is the map location of the NPC, followed by its coordinates in x,y and the direction the NPC will face. Direction numbers are counted counterclockwise in 45º increments, with 0 being the center: <br>

[1][0][7] <br>
[2] [6] <br>
[3][4][5] <br>

After the first tab, the type of script is defined. For our purposes, it'll stay "script" for now, but can also be function, shop, or cashshop, for starters. <br>
The name of the NPC is next. You can use up to 24 characters, so make it unique! Any duplicates will cause warnings or errors, and the NPC will just be automatically renamed anyway. <br>
The last number is for the sprite (Ai4rei's sprite list can be found [http://nn.nachtwolke.com/dev/npclist/ here]). It's followed by a comma and open curly bracket, marking the beginning of the script contents. Of course, the script must also end in a curly bracket.<br>

===Function===
A '''Function script''' will look almost identical to:
function <tab> script <tab> Function Name <tab> {

The words "function" and "script" won't change; the name must also be unique. All functions can be called using the "callfunc" command. <br>

===Shop===
A '''Shop''' starts like a normal script:
prontera,156,145,4 <tab> shop <tab> Fruit Store <tab> 58,512:-1,513:1000

The first section defines the map, coordinates, and direction. The word "shop" replaces "script" (alternately, "cashshop" will use Cashpoints instead of Zeny). The name and sprite ID follow, then a comma. <br>
Items in the shop are defined in an ID:Price format. A price of -1 uses the default price in item_db.txt. Be sure the price is not too low, or a you will open a Zeny exploit in your server! <br>

==Fundamentals==

You can always look up commands that you need--even the best scripters don't have everything memorized. There are a few fundamentals that you should know by heart, though, since they are so commonly used.

===Message===

*mes "<string>";
This is the most basic command. Start the line with the word mes, then enter the message in quotes (don't forget the semicolon at the end!). <br>
To add color, simply add ^ and the hex code anywhere in the message. A list can be found [http://www.immigration-usa.com/html_colors.html here]. <br>

''As an example:''
mes "[^FF0000Test NPC^000000]";
mes "Hello!";

''Will display:''
[<span style="color:#FF0000;">Test NPC</span>]
Hello!

===Labels, Goto, and End===

To create a label, type a label name and a colon at the start of a line. If the label does not end with an "end;" command, everything following the label will be read, so don't forget it between labels! <br>
To go to a label, use the simple "goto" command:
*goto <label>;

''Note that there are "special" labels that trigger whenever a specific event occurs. The name usually makes it obvious, but you can find explanations in script_commands.txt. Here is a brief sampling:''
OnClock<hour><minute>:
OnInit:
OnAgitStart:
OnAgitEnd:
OnTouch:
OnPCLoginEvent:
OnPCLogoutEvent:
OnPCBaseLvUpEvent:
OnPCJobLvUpEvent:
OnPCDieEvent:
OnPCKillEvent:
OnNPCKillEvent:
OnPCLoadMapEvent:

===Menus, Close, and Next===
{{EntirePage|Menus}}

*menu "<option_text>",<target_label>{,"<option_text>",<target_label>,...};
*close;
*next;
Menus create a set of options, which trigger labels when selected. The text in quotes is what will be displayed, followed by its respective label. Enter as many choices as you want, and end the last one with a semicolon instead of a comma. <br>
"Close" will close any message window that is open (from "mes" commands). <br>
"Next" will clear the message window, bringing up a fresh screen. <br>

''For example:''
mes "[Test NPC]";
mes "How are you doing today?";
menu "I am doing okay!",doingokay,"Not doing too well",bad;

doingokay:
mes "Glad to hear it!";
close;
end;

bad:
mes "Aww, I'm sorry about that.";
close;
end;

===Conditions, Variables, and Set===
{{EntirePage|Variables}}

*if(condition) {<script>;}
*else {<script>;}
Conditional statements "if" and "else" are the same as anywhere else. Multiple conditions can be specified: || means ''or'', while && means ''and''. == is ''equal'', != is ''not equal''. Inequalities can be used as well (<, >, <=, >=).<br>
The "else" can be omitted, and the brackets aren't necessary unless multiple commands follow a conditional statement. <br>

The type of variable used is defined in the name. There are permanent and temporary variables, as well as scope (temporary NPC), character, global, and global account. The default type is an integer, and adding $ as a suffix creates a string.<br>
Here are some example types, taken from script_commands.txt:
name - permanent character integer variable
name$ - permanent character string variable
@name - temporary character integer variable
@name$ - temporary character string variable
$name - permanent global integer variable
$name$ - permanent global string variable
$@name - temporary global integer variable
$@name$ - temporary global string variable
.name - NPC integer variable
.name$ - NPC string variable
.@name - scope integer variable
.@name$ - scope string variable
#name - permanent local account integer variable
#name$ - permanent local account string variable
##name - permanent global account integer variable
##name$ - permanent global account string variable

The "set" command is used to give a value (or string) to a variable:
*set <variable>,<expression>;

''The following script will pick a random number, store it as the temporary scope variable .@random, and display two different messages depending on the result:''
set .@random, rand(1,2);
if (.@random == 1) { mes "I like you! :D"; }
else { mes "I don't like you. Get out of here!"; }
close;

===Duplicating===

It would be a huge waste of time and space to code the same NPC over and over again. By duplication, an NPC can be created in multiple locations. <br>

Take a look at our old Test NPC:
prontera,156,145,4 <tab> script <tab> Test NPC <tab> 58,{
To be able to duplicate this, we will change the heading to this:
- <tab> script <tab> Test NPC#01::testnpc <tab> 58,{
The location doesn't need to be defined in the NPC, since it will be in the duplicates. <br>
The displayed name remains "Test NPC". But since NPC names must be unique, adding #01 separates this one from the rest, which will be #02, #03, etc. Lastly, ::testnpc is the reference name used for duplicating NPCs; this part is not displayed on the screen. <br>

After creating the base NPC, duplicates can be added anywhere to any file, so long as you use the same NPC name:
spl_fild03,150,150,7 <tab> duplicate(testnpc) <tab> Test NPC <tab> 58
niflheim,50,50,2 <tab> duplicate(testnpc) <tab> Test NPC <tab> 58
tha_scene01,140,190,4 <tab> duplicate(testnpc) <tab> Test NPC <tab> 58
The first part is ''map,x,y,direction'', as you're probably used to by now. <br>
To define a duplicate, the word "duplicate" followed by the NPC, in parentheses, is needed. The last two parameters are the display name and sprite ID (yes, you can change these, too!).

==Finished Product==

Here is an example using the features explained above:

prontera,156,145,4 script Test NPC::test 589,{
mes "Hello, how are you?";
mes "I am fine, how are you?";
menu "I am doing okay!",-,"Not doing too good",bad;
mes "That's good, I'm glad to hear that";
close;

bad:
mes "Awww, that makes me a bit ^FF0000sad^000000. Sorry to hear that.";
next;
mes "Would you like some zeny to help yourself feel better?";
next;
menu "Sure, give it to me!",L_zeny,"Naw, No zeny for me",-;
close;

L_Zeny:
mes "I can only give you zeny if you have 10,000 or less.";
if (Zeny > 10000) goto toomuch;
mes "You have 10,000 zeny or less, I see.";
set Zeny,Zeny+10000;
next;
mes "Hope you feel better!";
close;

toomuch:
mes "You have over 10,000 zeny, you must feel really good about yourself!";
close;
}

lhz_dun01,157,285,4 duplicate(test) Test NPC 859
hu_fild05,186,210,4 duplicate(test) Test NPC 859
yuno_fild07,221,179,4 duplicate(test) Test NPC 859
tha_scene01,139,194,1 duplicate(test) Test NPC 859

==Adding Scripts==
{{EntirePage|Adding a Script}}
For an NPC to be loaded, it needs to be added to a .conf file. This is typically ''npc/scripts_custom.conf''.<br>
Add a line, and enter your NPC file in the following format:
npc: npc/path/to/script.txt
That's it! You're finished!

==External Links==
'''Reference Manuals for scriping commands'''
* {{git|/doc/script_commands.txt}} Original documentation

'''Sprite lists'''
* http://nn.nachtwolke.com/dev/npclist/

'''Color Charts'''
* http://www.immigration-usa.com/html_colors.html
* http://www.december.com/html/spec/colorcodes.html
* [[wikipedia:Hex_triplet|Hex triplet]]
* http://www.colorschemer.com/online.html

'''Support, Request and Release'''
* [http://hercules.ws/board/forum/22-script-support/ Scripting support on Hercules Boards]
* #Hercules on irc.rizon.net : Main Hercules channel.

[[Category:Scripting]]

Getmapguildusers

2014-01-20T23:31:55Z

Via: Oops, wrong syntax.

=Syntax=
[[getmapguildusers]] ("<map name>")
=Description=
Returns the amount of persons from the given guild that are on the given map.
=Example=
<pre>
//Will set the @persons variable to the amount of persons from the guild
//which ID's = 10 and are at prontera.
set @persons, getmapguildusers("prontera", 10);
</pre>

[[Category:Script Command]]

Getmapguildusers

2014-01-20T23:31:26Z

Via: Created page with "=Syntax= getmapusers ("<map name>") =Description= Returns the amount of persons from the given guild that are on the given map. =Example= <pre> //Will set the @persons va..."

=Syntax=
[[getmapusers]] ("<map name>")
=Description=
Returns the amount of persons from the given guild that are on the given map.
=Example=
<pre>
//Will set the @persons variable to the amount of persons from the guild
//which ID's = 10 and are at prontera.
set @persons, getmapguildusers("prontera", 10);
</pre>

[[Category:Script Command]]

Getmapusers

2014-01-20T23:29:38Z

Via:

==Syntax==
* '''getmapusers'''("Map_Name");
==Description==
This function will return the number of users currently located on the specified
map.

It is often used in the PVP scripts to check if a PVP room is full of not,
if the number returned it equal to the maximum allowed it will not let you
enter.

==Example 1==

//This will ask the player what map they want to check that has players and return the value
//of the players on the map
[[input]] @map$;
[[mes]] '''getmapusers'''(@map$);
[[Category:Script_Command]]

Getmapusers;

2014-01-20T23:28:59Z

Via: Redirected page to Getmapusers

#REDIRECT [[getmapusers]]

GetGuildName

2014-01-20T23:27:29Z

Via: Moved to getguildname

#REDIRECT [[getguildname]]

GetCastleData

2014-01-20T23:25:53Z

Via: Added redirect to proper casing.

#REDIRECT [[getcastledata]]

GetCastleData

2014-01-20T23:24:59Z

Via: Removing parallel page.

Main Page

2013-12-13T08:11:29Z

Via: Reverted edits by Poetwatches (talk) to last revision by Via

{| style="width: 100%;" cellspacing="5" cellpadding="0"
| colspan="3" |
|-
| style="background: #FCFCFC; border: 1px solid #AAA; vertical-align: top;" |
<div style="background: #ACD; border: 1px solid #7BC; padding: 5px; margin: 3px; font-weight: bold; text-align: center; font-size: 120%;">About Hercules</div>
<div style="padding-left: 1em;">
[[Hercules]] is an [[wikipedia:Open_source|open-source]] project, revolving around the creation of a robust massively multiplayer online role playing game (MMORPG) server package, emulating a [[wikipedia:Ragnarok_Online|Ragnarok Online]] [[wikipedia:Server|Server]]. Written in [[wikipedia:C_(programming_language)|C]] the program is very versatile and provides NPCs, warps and modifications. and is currently version controlled via [[wikipedia:Git_(software)|Git]]. The project is jointly managed by a group of volunteers located around the world as well as a tremendous community providing QA and support. Hercules is a continuation of the original Athena project.

Hercules currently runs on most common [[wikipedia:Operating_system|Operating Systems]] currently available today. For a full list, please see the [[System Requirements]].

</div>

<div style="background: #ACD; border: 1px solid #7BC; padding: 5px; margin: 3px; font-weight: bold; text-align: center; font-size: 120%;">Editing the Wiki</div>
<div style="padding-left: 1em;">
All users must login to the wiki using their forum account. Any member can edit the wiki, but please keep in mind that the Hercules wiki is released under the [[wikipedia:GNU_Free_Documentation_License|GNU Free Documentation License]] Version 1.2. This means that the wiki and any works put on it can be edited at will. They may also be distributed, provided all history and copylefts remain intact. Please see [[Editing the wiki]] for more information.

Don't know where to start? Check the [[Special:WantedPages]] page and create a page that is listed there!

Please do not create pages for custom content, such as custom projects not relating to Hercules in any way. A full list of content that should not be on the wiki is listed at [[Editing the wiki]].

Please see [[:Category:Wiki_Projects|Wiki Projects]] for any ongoing projects that you might be able to help with!

</div>

<div style="background: #ACD; border: 1px solid #7BC; padding: 5px; margin: 3px; font-weight: bold; text-align: center; font-size: 120%;">Quick Tips</div>
<div style="padding-left: 1em;">
*Spell check your work and make sure the grammar is correct.
*Use English.
*Do not vandalize the wiki. Vandalization will come with harsh punishment.
*Please see [[mw:Help:Formatting|Formatting a wiki]] for tips on wiki formats and syntaxes.
</div>

| style="background: #FCFCFC; border: 1px solid #AAA; vertical-align: top;" |
<div style="width: 260px; background: #ACD; border: 1px solid #7BC; padding: 5px; margin: 3px; font-weight: bold; text-align: center; font-size: 120%;"><div style="float: right; padding: 0 20px;">[[Image:poring1.gif]]</div>Installation</div>
<div style="padding-left: 1em;">
; [[Getting Started]]
: [[System Requirements]]
; [[:Category:Installation|Installation]]
: [[Installation_(CentOS)|CentOS]]
; [[Compiling]]
; [[Connecting|Connecting and Starting]]
; [[:Category:Configuration|Configuration]]
</div>
<div style="background: #ACD; border: 1px solid #7BC; padding: 5px; margin: 3px; font-weight: bold; text-align: center; font-size: 120%;"><div style="float: right;">[[Image:develing1.gif]]</div>Server Side</div>
<div style="padding-left: 1em;">
; [[Scripting]]
: [[Basic Scripting]]
: [[:Category:Script_Command|Script Commands]]
: [[Permanent Monster Spawn]]
: [[Instancing]]
:
; [[Server Modification]]
: [[:Category:Source_Functions|Source Functions]]
: [[:Category:Source Snippets|Source Snippets]]
: [[Hercules Plugin Manager]]
: [[Packets]]
:
; [[:Category:Database|Database]]
: [[Custom Items]]
: [[Custom Mobs]]
: [[Custom weapons]]
</div>
<div style="background: #ACD; border: 1px solid #7BC; padding: 5px; margin: 3px; font-weight: bold; text-align: center; font-size: 120%;"><div style="float: right;">[[Image:angeling1.gif]]</div>Client Side</div>
<div style="padding-left: 1em;">
; [[:Category:Data|Data]]
; [[Spriting]]
: [[Palettes]]
: [[Acts]]
:
; [[:Category:Mapping|Mapping]]
: [[Modeling]]
: [[Texture]]
:
; [[:Category:Client_Configuration|Client Stuff]]
;
; [[:Category:Patchers|Patchers]]
</div>
|}

Hercules Hierarchy

2013-12-02T19:32:58Z

Via:

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

== Administrators ==
They administrate.
* [http://hercules.ws/board/user/1-ind/ Ind] ([http://hercules.ws/board/index.php?app=members&filter=4 Administrator])
* [http://hercules.ws/board/user/2-jman/ Jman] ([http://hercules.ws/board/index.php?app=members&filter=4 Administrator])

== Community Administrators ==
They oversee everything community wise and forum-related
* [http://hercules.ws/board/user/10-judas/ Judas] ([http://hercules.ws/board/index.php?app=members&filter=17 Community Administrator])
* [http://hercules.ws/board/user/43-mysterious/ Mysterious] ([http://hercules.ws/board/index.php?app=members&filter=17 Community Administrator])

== Core Developers ==
The kings of the code hill.
* [http://hercules.ws/board/user/28-greenbox/ GreenBox]
* [http://hercules.ws/board/user/307-haru/ Haru]
* [http://hercules.ws/board/user/20-malufett/ malufett]
* [http://hercules.ws/board/user/49-mkbu95/ mkbu95]
* [http://hercules.ws/board/user/725-susu/ Susu]

== Global Moderators ==
Global Moderators are individuals who moderate all of the forums excluding International Communities, however, may still moderate.<br/>
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.<br/>
Global Moderators also provide support to support topics, however, not to an extent as Support Leaders.
Global Moderator 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]

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

== High Council ==
They're an sort of upgrade from the [[#Community_Contributor | Community Contributor]] title.
* [http://hercules.ws/board/user/8-eurydice/ Eurydice]
* [http://hercules.ws/board/user/1160-gepard/ Gepard]
* [http://hercules.ws/board/user/6-jtynne/ jTynne]
* [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]

== Int'l Moderators ==
International Moderators are individuals who moderate their respective International Community.<br/>
They are solely responsible in making sure their respective community is cleaned by moving, locking, removing, and cleaning topics of spams.<br/>
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/25-jaypee/ JayPee]

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

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

====German====
* [http://hercules.ws/board/user/1071-shikazu/ Shikazu]

== Script Developers ==
Usually the members with the fastest key/second typing ratio.
* [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/50-michieru/ Michieru]
* [http://hercules.ws/board/user/7-nameless2you/ Nameless2you]
* [http://hercules.ws/board/user/756-joseph/ Joseph]
* [http://hercules.ws/board/user/192-wolf/ Wolf]

== Support Leaders ==
In charge of all the main supporting areas.
* [http://hercules.ws/board/user/4-emistry/ Emistry]

= Other Titles =
Non-staff Titles

== Community Contributor ==
This title is awarded to community members for their outstanding support of Hercules, for [http://hercules.ws/board/topic/376-hercules-cc-program/ more information check this thread]
* [http://hercules.ws/board/user/59-beret/ Beret]
* [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/1582-sevenzz23/ sevenzz23]
* [http://hercules.ws/board/user/297-shakto/ Shakto]
[[Category:Hercules]]

Db2sql

2013-12-02T13:52:22Z

Via: Created page with "== Files Converted == * {{git|db/pre-re/item_db.conf}} * {{git|db/re/item_db.conf}} * {{git|db/item_db2.conf}} == Description == This plugin converts the item database confi..."

== Files Converted ==
* {{git|db/pre-re/item_db.conf}}
* {{git|db/re/item_db.conf}}
* {{git|db/item_db2.conf}}

== Description ==
This plugin converts the item database configuration files for use with SQL servers.

== Compiling ==
The plugin needs to be compiled. If you've already compiled your server and/or other plugins, input these commands:
./configure
make plugin.db2sql

=== Windows ===
In Windows, compile the '''db2sql''' plugin in Visual Studio.

== Enabling db2sql ==
Next, the plugin needs to be enabled in {{git|conf/plugins.conf}}:
plugins_list: [
/* Enable HPMHooking when plugins in use rely on Hooking */
//"HPMHooking",
"db2sql",
//"sample",
//"other",
]

== Usage ==
To use the converter, update your changes in the desired item database (using {{git|db/item_db2.conf}} for customisations is recommended); then, run this command:
./map-server --db2sql

=== Windows ===
In Windows, run {{git|db2sql.bat}} in the root directory.

== Output ==
The resulting files will be output in the {{git|sql-files}} folder as {{git|sql-files/item_db.sql}}, {{git|sql-files/item_db_re.sql}}, and {{git|sql-files/item_db2.sql}}.

[[Category:Tools]]

Configure

2013-11-14T01:24:32Z

Via: /* 64-bit operating systems */ --outdated

Using '''configure''' script is a method to generate makefiles before compilation in Unix systems.

When installing Hercules, configure script should be run after [[SVN Checkout]],/[[Git Clone]] and before compiling.

== Basic usage ==
<onlyinclude><includeonly><blockquote>''Main article: [[Configure]].''</blockquote></includeonly>
To avoid errors in server-client communication, <code>[[PACKETVER]]</code> must be set to date the client you're going to use has been released at (in YYYYMMDD format), eg <code>20100730</code> for 2010-07-30aRagexeRE. Instead of editing [[mmo.h]] directly, <code>PACKETVER</code> can be set to desired date with configure switch <code>--enable-packetver=YYYYMMDD</code>.

Run following command, replacing ''YYYYMMDD'' with your client release date, eg ''20100730''.
./configure --enable-packetver=YYYYMMDD
Configure script will perform necessary tests and generate makefiles.
</onlyinclude>
=== Sample output ===
<pre>checking whether make sets $(MAKE)... yes
checking for gcc... gcc
checking for C compiler default output file name... a.out
checking whether the C compiler works... yes
checking whether we are cross compiling... no
checking for suffix of executables...
checking for suffix of object files... o
checking whether we are using the GNU C compiler... yes
checking whether gcc accepts -g... yes
checking for gcc option to accept ANSI C... none needed
checking how to run the C preprocessor... gcc -E
checking whether byte ordering is bigendian... no
checking whether pointers can be stored in ints (old code)... yes
checking whether gcc supports -Wno-unused-parameter... yes
checking whether gcc supports -Wno-pointer-sign... yes
checking whether gcc can actually use -Wno-pointer-sign... yes
checking whether gcc supports -Wno-switch... yes
checking whether gcc supports -fPIC... yes
checking whether gcc needs -fPIC for shared objects... no
checking whether gcc supports -fno-strict-aliasing... yes
checking whether gcc is able to typecast to union... yes
checking for setrlimit... yes
checking for strnlen... yes
checking for inflateEnd in -lz... yes
checking zlib.h usability... yes
checking zlib.h presence... yes
checking for zlib.h... yes
checking for library containing sqrt... -lm
checking for library containing clock_gettime... -lrt
checking whether CLOCK_MONOTONIC is supported and works... yes
checking for mysql_config... /usr/bin/mysql_config
checking for mysql_init in -lmysqlclient... yes
checking mysql.h usability... yes
checking mysql.h presence... yes
checking for mysql.h... yes
checking MySQL library (optional)... yes (5.0.51a)
checking for pcre_study in -lpcre... yes
checking PCRE library (optional)... yes
checking host OS... Linux
checking for MinGW... no
configure: creating ./config.status
config.status: creating Makefile
config.status: creating src/common/Makefile
config.status: creating 3rdparty/mt19937ar/Makefile
config.status: creating src/char/Makefile
config.status: creating src/login/Makefile
config.status: creating src/char_sql/Makefile
config.status: creating src/txt-converter/Makefile
config.status: creating src/map/Makefile
config.status: creating src/plugins/Makefile
config.status: creating src/tool/Makefile</pre>
=== Setting executable bit ===
In order to run configure script it must be executable, ie have the ''execute'' permission set. When checking out a working copy from SVN repository, executable bit should be set automatically thanks to <code>svn:executable</code> property. However, if it fails for some reason, running <code>./configure</code> will bring the following message (or similar):
bash: ./configure: Permission denied
To fix this, set executable permission with:
chmod +x ./configure

== Additional switches ==
To display all available switches use:
./configure --help

=== Debug mode ===
It is possible to compile Hercules in debug mode with <code>--enable-debug</code> switch.
[[Category:Installation]]

Delwall

2013-11-06T06:30:54Z

Via: Created page with "==Syntax== *'''delwall''' "<wallname>"; *'''setwall''' "<map name>",<x>,<y>,<size>,<dir>,<shootable>,"<wallname>"; ==Description== Deletes an invisible wall previously create..."

==Syntax==
*'''delwall''' "<wallname>";
*'''setwall''' "<map name>",<x>,<y>,<size>,<dir>,<shootable>,"<wallname>";

==Description==
Deletes an invisible wall previously created by Setwall; identified by the wall's name.

==See Also==
* [[Setwall]]

[[Category:Script Command]]

Setwall

2013-11-06T06:30:13Z

Via: Created page with "==Syntax== *'''setwall''' "<map name>",<x>,<y>,<size>,<dir>,<shootable>,"<wallname>"; *'''delwall''' "<wallname>"; ==Description== Creates an invisible wall, an array of "set..."

==Syntax==
*'''setwall''' "<map name>",<x>,<y>,<size>,<dir>,<shootable>,"<wallname>";
*'''delwall''' "<wallname>";

==Description==
Creates an invisible wall, an array of "setcell" starting from x,y and doing a
line of the given size in the given direction. The difference with setcell is
this one updates the client part too, to avoid the glitch problem. Directions are the
same as NPC sprite facing directions: 0=north, 1=northwest, 2=west, etc.

==Examples==
- script setwall -1,{
[[end]];
[[OnInit]]:
setwall "prontera",64,102,4,2,0,"PrtWall";
}
----

==See Also==
* [[Delwall]]

[[Category:Script Command]]

Hercules Hierarchy

2013-11-02T15:23:48Z

Via: Moved kyeme to HC, added ossi0110 and sevenzz23 to list of CCs, updated Via to Mumbles (changed alias) and did some alphabetical housekeeping. Sorry if I missed anyone!

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

== Administrators ==
They administrate.
* [http://hercules.ws/board/user/1-ind/ Ind] (Community Administrator)
* [http://hercules.ws/board/user/2-jman/ Jman] (Community Administrator)

== Core Developers ==
The kings of the code hill.
* [http://hercules.ws/board/user/28-greenbox/ GreenBox]
* [http://hercules.ws/board/user/307-haru/ Haru]
* [http://hercules.ws/board/user/20-malufett/ malufett]
* [http://hercules.ws/board/user/49-mkbu95/ mkbu95]
* [http://hercules.ws/board/user/725-susu/ Susu]

== Forum Managers ==
They oversee everything forum-related
* [http://hercules.ws/board/user/10-judas/ Judas] ([http://hercules.ws/board/index.php?app=members&filter=17 Forum Manager])
* [http://hercules.ws/board/user/43-mysterious/ Mysterious] ([http://hercules.ws/board/index.php?app=members&filter=17 Forum Manager])

== Global Moderators ==
Global Moderators are individuals who moderate all of the forums excluding International Communities, however, may still moderate.<br/>
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.<br/>
Global Moderators also provide support to support topics, however, not to an extent as Support Leaders.
Global Moderator 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]

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

== High Council ==
They're an sort of upgrade from the [[#Community_Contributor | Community Contributor]] title.
* [http://hercules.ws/board/user/8-eurydice/ Eurydice]
* [http://hercules.ws/board/user/1160-gepard/ Gepard]
* [http://hercules.ws/board/user/6-jtynne/ jTynne]
* [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]

== Int'l Moderators ==
International Moderators are individuals who moderate their respective International Community.<br/>
They are solely responsible in making sure their respective community is cleaned by moving, locking, removing, and cleaning topics of spams.<br/>
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/25-jaypee/ JayPee]

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

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

====German====
* [http://hercules.ws/board/user/1071-shikazu/ Shikazu]

== Script Developers ==
Usually the members with the fastest key/second typing ratio.
* [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/50-michieru/ Michieru]
* [http://hercules.ws/board/user/7-nameless2you/ Nameless2you]
* [http://hercules.ws/board/user/756-joseph/ Joseph]
* [http://hercules.ws/board/user/192-wolf/ Wolf]

== Support Leaders ==
In charge of all the main supporting areas.
* [http://hercules.ws/board/user/4-emistry/ Emistry]
* [http://hercules.ws/board/user/83-mumbles/ Mumbles]

= Other Titles =
Non-staff Titles

== Community Contributor ==
This title is awarded to community members for their outstanding support of Hercules, for [http://hercules.ws/board/topic/376-hercules-cc-program/ more information check this thread]
* [http://hercules.ws/board/user/59-beret/ Beret]
* [http://hercules.ws/board/user/315-neo/ Neo]
* [http://hercules.ws/board/user/87-ossi0110/ ossi0110]
* [http://hercules.ws/board/user/303-ryuuzaki/ Ryuuzaki]
* [http://hercules.ws/board/user/1582-sevenzz23/ sevenzz23]
* [http://hercules.ws/board/user/297-shakto/ Shakto]
[[Category:Hercules]]

User:Via

2013-11-02T14:43:56Z

Via: /* Personal */

===Introduction===
Welcome to my user page. I joined here in January 2013, to learn and to share my knowledge.

==Personal==
* Alias: Mumbles (formerly Via)
* Hometown: San Francisco, California, USA
* Occupation: Developer
* School: City College of San Francisco
* Homepage: http://dev.are-o.net

==Hercules==
* [[Special:Contributions/Via|My Contributions]]
* [[Special:WantedPages|Wanted Pages]]

Editing the wiki

2013-10-31T09:02:47Z

Via: Reverted edits by ErevyLiex (talk) to last revision by Dastgirpojee

==Welcome to the Hercules wiki!==
The Hercules wiki could always use some help. It is an ever changing repository of information related to Hercules, such as installation, configuration, scripting and even some client support. The wiki thanks you for stopping by and showing some interest in helping get the wiki full of the most useful information for Hercules.

===Where to Begin?===
All users must login to the wiki using their forum account. Any member with more than 1 post on the forums can edit the wiki, but please keep in mind that the Hercules wiki is released under the [[wikipedia:GNU_Free_Documentation_License|GNU Free Documentation License]] Version 1.2. This means that the wiki and any works put on it can be edited at will. They may also be distributed, provided all history and copylefts remain intact. Please see read this page for more information.

Don't know where to start? Check the [[Special:WantedPages]] page and create a page that is listed there!

Please do not create pages for custom content, such as custom projects not relating to Hercules in any way. A full list of content that should not be on the wiki is listed at [[Editing the wiki]].

Please see [[:Category:Wiki_Projects|Wiki Projects]] for any ongoing projects that you might be able to help with!

===License Requirements===
The Hercules wiki is to be released under the [[wikipedia:GNU_Free_Documentation_License|GNU Free Documentation License]]. For those that do not know, this license allows anyone to edit your work on the wiki at will, provided that all pertinent history is remained intact and all copylefts are abided by. This work can also be redistributed, again, provided that all copylefts remain intact.

===Editing Requirements===
You might be eager to start editing. The first question is....how do I start?

With the Hercules wiki, you can use IPB BBCodes to format your work, but there is a helpful toolbar at the top of the edit box to help you as well.

You can create a new page, but make sure that the page you are creating [[Special:AllPages|doesn't exist yet]] and preferably is already [[Special:WantedPages|being linked to]]. If it already exists, maybe you can head over and help edit in something that might be missing that someone forgot.

===General Rules for the Hercules wiki===
{{outdated|type=section}}
These guidelines/rules should be followed on the Hercules wiki. If not followed, your account is at risk for being banned from the wiki '''as well as''' from the forums. You have been warned.
* Deleting a page must come from a Community Administrator or a Documentation Manager. If you have a page that you request for deletion, please add the <code><nowiki>{{deletion suggested}}</nowiki></code> template. See [[Template:Delete]] for details.
* Editing wars are not to be tolerated. It creates unwanted and unneeded long history.
* Pornography is a not to appear on the Hercules wiki.
* Text must be appropriate in nature and not contain foul language.

===General tips for editing a wiki===
These tips should be referenced when you need to edit/write an article.
* As mentioned before, make sure that if a new page is being created, it [[Special:AllPages|doesn't exist yet]].
* Use proper English with proper spelling and grammar. The Hercules wiki is in English and English only at this point.
* Links should not appear in topic titles, such as the title of a section.
* There should be no reason to link to a page more than once if it appears in the article multiple times. The first mention of a topic that has a page should be linked to.
* Name your page appropriately and avoid special symbols. Don't make your page too long, but think of a name that will relate to the article (i.e: Don't name your article related to XRay 'client').
* Use images when Windows is involved. It is too hard and sometimes troublesome to read an article with the text: Go here, click OK, go here, hover your mouse here, click here, type this, click here, drag it to here, etc.
* Any section or article that relates to changing code should be in DIFF or PATCH format. This includes all of the proper syntax. If you do not know what a diff or patch file is, please refer to it's Wikipedia article [[wikipedia:Diff#Unified_format|here]]. 'find and replace' text is not acceptable.
* Make use of Wikipedia's help articles, if you are unsure about [[wikipedia:Wikipedia:How_to_edit_a_page|editing articles]] or [[wikipedia:Help:Wiki_markup|the use of some wiki-code]]. Note, that most of the templates used on Wikipedia cannot be applied to the Hercules wiki, except [[:Category:Templates|few ones]].
* Use the ''Show preview'' button before saving the page, especially when you are unsure, how your edit turns out. This helps avoiding follow-up "ooops"-edits.
* Before you save an article, add reason for your edit or summary of your edit in the ''Summary'' line. You help others to recognize, what was changed and why in the [[Special:RecentChanges|list of recent changes]] and it distinguishes you from spam-bots, which do not add a reason. You do not need to add a summary for your user-page or on article's talk pages. If you cannot remember what you changed, use the ''Show changes'' button to review all changes done to the page as a diff.
* Avoid excessive amount of formatting. Use either '''bold''' or ''italics'' but not '''''both'''''. Refrain from using <u>underlining</u> as this usually gives the impression of a link. <s>Strike-through</s> should be used on talk pages only, if there is something in an article to invalidate, simply delete it.

===Script Command Pages===
As a general rule of thumb, the following format should be used in order to keep the articles in a uniform fashion.

<nowiki>==Syntax==
*'''scriptcommand'''(<argument1>, <"argument2">);

==Description==
This command does this and that, and arguments mean that and this.

==Examples==
[[mes]] "...";
[[if]](scriptcommand(1, "abc"))
{
mes "...";
}
[[close]];

==See Also==
* [[related script command 1]]
* [[related script command 2]]

[[Category:Script Command]]</nowiki>

Monster

2013-08-16T11:32:45Z

Via: Created page with "{{OtherUse|the script command|the game object|Mob}} ==Syntax== *'''monster''' <"map name">, <x>, <y>, <"display name">, <mob id>, <amount>[, <"event label">]; ==Description==..."

{{OtherUse|the script command|the game object|Mob}}
==Syntax==
*'''monster''' <"map name">, <x>, <y>, <"display name">, <mob id>, <amount>[, <"event label">];

==Description==
This command spawns a monster at given map and coordinates, using given class and amount. Monsters spawned with this command will not re-spawn after being killed.

To address the map, on which the running [[NPC]] resides, ''map name'' can be set to "this". Spawning the monster on random coordinates is accomplished by setting parameters ''x'' and ''y'' to 0. The parameter ''display name'' specifies the in-game name of the monster, which is not necessary required to be the actual name, such as "Prontera minion". The ''display name'' accepts also two magic names, "--ja--" and "--en--", which are replaced by the server with the value of the kROName and iROName mob db columns of the given ''mob id'', respectively. Setting the ''mob id'' to -1, -2 or -3 will spawn a random monster from the dead branch, poring box or bloody branch list respectively.

Optionally an ''event label'' can be specified, which has the form "NpcName::OnLabel" and is run upon the monster's death. If the killer was a player, [[RID#Usage|it will be attached]] to the invoked script.

==Example==
[[mes]] "I will spawn 5 Porings for you!";
[[close2]];
monster "this",0,0,"Poring 1",1002,1,[[strnpcinfo]](0)+"::OnPoring1Dead";
monster "this",0,0,"Poring 2",1002,1,strnpcinfo(0)+"::OnPoring2Dead";
monster "this",0,0,"Poring 3",1002,1,strnpcinfo(0)+"::OnPoring3Dead";
monster "this",0,0,"Poring 4",1002,1,strnpcinfo(0)+"::OnPoring4Dead";
monster "this",0,0,"Poring 5",1002,1,strnpcinfo(0)+"::OnPoring5Dead";
[[end]];

OnPoring1Dead:
mes "You killed Poring 1";
[[close]];
OnPoring2Dead:
mes "You killed Poring 2";
close;
OnPoring3Dead:
mes "You killed Poring 3";
close;
OnPoring4Dead:
mes "You killed Poring 4";
close;
OnPoring5Dead:
mes "You killed Poring 5";
close;
This will spawn 5 Porings randomly distributed on the map of the invoking character with the names "Poring 1" to "Poring 5". Each time the player kills one of them, it triggers the given event label in the NPC, which will say "You killed Poring X"

[[Category:Script Command]]

Clone

2013-08-16T11:32:15Z

Via: Created page with "== Syntax == *'''clone''' "<map name>",<x>,<y>,"<event>",<char id>{,<master_id>{,<mode>{,<flag>,<duration>}}} == Description == This command creates a monster which is ..."

== Syntax ==

*'''clone''' "<map name>",<x>,<y>,"<event>",<char id>{,<master_id>{,<mode>{,<flag>,<duration>}}}

== Description ==

This command creates a [[monster]] which is a copy of another player. The first
four arguments serve the same purpose as in the monster script command. The
<char id> is the character ID of the player to clone (player must be online).
If <master id> is given, the clone will be a 'slave/minion' of it. Master_id
must be a character ID of another online player.

The mode can be specified to determine the behavior of the clone, it's
values are the same as the ones used for the mode field in the mob_db. The
default mode is aggressive, assists, can move, can attack.

Flag can be either zero or one currently. If zero, the clone is a normal
monster that'll target players, if one, it is considered a summoned monster,
and as such, it'll target other monsters. Defaults to zero.

The duration specifies how long the clone will live before it is auto-removed.
Specified in seconds, defaults to no limit (zero).

Returned value is the monster ID of the spawned clone. If command fails,
returned value is zero.

== Usage ==

[[set]] .@player,getcharid(0);
'''clone''' "prontera",150,150,"Test::OnEvent",.@player;
or
'''clone''' "prontera",150,150,"Test::OnEvent",getcharid(0);

[[Category:Script_Command]]

Setmapflag

2013-08-11T10:25:33Z

Via: /* Description */ SVN -> Git template conversion

== Syntax ==
* [[setmapflag]] "<map name>",<flag>{,<zone>};

== Description ==
This command marks a specified map with a map flag given. Map flags alter the behavior of the map, you can see the list of the available ones in '{{git|db/const.txt}}' under 'mf_'.

The map flags alter the behavior of the map regarding teleporting (mf_nomemo, mf_noteleport, mf_nowarp, mf_nogo), storing location when disconnected (mf_nosave), dead branch usage (mf_nobranch), penalties upon death (mf_nopenalty, mf_nozenypenalty), PVP behavior (mf_pvp, mf_pvp_noparty, mf_pvp_noguild), WoE behavior (mf_gvg,mf_gvg_noparty), ability to use skills or open up trade deals (mf_notrade, mf_novending, mf_noskill, mf_noicewall), current weather effects (mf_snow, mf_fog, mf_sakura, mf_leaves, mf_rain, mf_clouds, mf_fireworks) and whether night will be in effect on this map (mf_nightenabled).

The zone optional parameter is used to set the zone for restricted mapflags.

== Examples ==
// This sets the 'novending' mapflag on Prontera
setmapflag "prontera", mf_novending;

== See Also ==
* [[mapflag]]

[[Category:Script Command]]

Setmapflag

2013-08-11T10:24:27Z

Via: Created page with "== Syntax == * setmapflag "<map name>",<flag>{,<zone>}; == Description == This command marks a specified map with a map flag given. Map flags alter the behavior of the ma..."

== Syntax ==
* [[setmapflag]] "<map name>",<flag>{,<zone>};

== Description ==
This command marks a specified map with a map flag given. Map flags alter the behavior of the map, you can see the list of the available ones in '{{svn|trunk/db/const.txt}}' under 'mf_'.

The map flags alter the behavior of the map regarding teleporting (mf_nomemo, mf_noteleport, mf_nowarp, mf_nogo), storing location when disconnected (mf_nosave), dead branch usage (mf_nobranch), penalties upon death (mf_nopenalty, mf_nozenypenalty), PVP behavior (mf_pvp, mf_pvp_noparty, mf_pvp_noguild), WoE behavior (mf_gvg,mf_gvg_noparty), ability to use skills or open up trade deals (mf_notrade, mf_novending, mf_noskill, mf_noicewall), current weather effects (mf_snow, mf_fog, mf_sakura, mf_leaves, mf_rain, mf_clouds, mf_fireworks) and whether night will be in effect on this map (mf_nightenabled).

The zone optional parameter is used to set the zone for restricted mapflags.

== Examples ==
// This sets the 'novending' mapflag on Prontera
setmapflag "prontera", mf_novending;

== See Also ==
* [[mapflag]]

[[Category:Script Command]]

Removemapflag

2013-08-11T10:24:02Z

Via: Created page with "==Syntax== * removemapflag "<map name>",<flag>; ==Description== This command removes a mapflag from a specified map. See 'setmapflag'. Category:Script_Command"

==Syntax==
* [[removemapflag]] "<map name>",<flag>;
==Description==
This command removes a mapflag from a specified map. See '[[setmapflag]]'.
[[Category:Script_Command]]

Isnight

2013-08-07T02:19:57Z

Via: Created page with "==Syntax== *'''isday'''(); *'''isnight'''(); ==Description== These functions determine whether server day or night cycle is currently in effect or not. If the server night is..."

==Syntax==
*'''isday'''();
*'''isnight'''();

==Description==
These functions determine whether server day or night cycle is currently in effect or not. If the server night is in effect, isday and isnight will return 0 and 1, otherwise 1 and 0 respectively.

==Examples==
[[if]](!isday())
{
[[mes]] "I do not work at night, come again tomorrow.";
[[close]];
}

if(isnight())
{
mes "I do not work at night, come again tomorrow.";
close;
}
These two script fragments achieve the same effect.

[[Category:Script Command]]

Player Parameters (Scripting)

2013-08-07T02:06:44Z

Via:

'''Player Parameters''', in [[scripting]], are a set of params that look like [[Variables#Player Variables|character variables]], they exist during runtime only and make certain information regarding the character available to scripts for read (and write depending on the variable), they're the following (most of them are self-explanatory):
* StatusPoint
** Number of remaining Status Points the character has
* BaseLevel
* SkillPoint
** Number of remaining Skill Points the character has
* Class
* Upper
** (0) if the character is normal class, (1) if advanced, (2) if baby.
* Zeny
* Sex
** Whether the character is male (1) or female (0)
* Weight
* MaxWeight
* JobLevel
* BaseExp
* JobExp
* Karma
** Not officially in use. You can use this param however you want.
* Manner
* NextBaseExp
* NextJobExp
* Hp
* MaxHp
* Sp
* MaxSp
* BaseJob
* BaseClass
* killerrid
** The [[RID]] of the game object that last killed the character.
* killedrid
** The [[RID]] of the game object that was last killed by the character.
* SlotChange
** Stores the number of times this character may use the 'slot change' function in char select
** Can be modified
* CharRename
** Stores the number of times this character may use the 'char name change' function in char select
** Can be modified

[[Category:Scripting]]

OnTouch

2013-08-06T13:17:25Z

Via: Created page with "==Syntax== Map,X,Y,facing script NPCName ID,OnTouch_X,OnTouchY,{ OnTouch: ==Description== OnTouch is rather hard to explain. In the beginning of the script you specify th..."

==Syntax==
Map,X,Y,facing script NPCName ID,OnTouch_X,OnTouchY,{

OnTouch:

==Description==
OnTouch is rather hard to explain. In the beginning of the script you specify the area that when the player enters that specified area, the following script is executed. You cannot specify a specific area. If you do 3,3 if the player enters any 3 squares around the NPC, the script is executed.

'''Trick''': Using "end;" at the beginning of the script stops players from executing the script by clicking on the NPC, so they can only execute it if they walk into the specified area.

==Example==
prontera,147,153,3 script Mary 71,3,3,{
end;

OnTouch:
mes "[Mary]";
mes "Have you seen my lamb?";
close;
}

[[Category:Script Command]]

Setnpcdisplay

2013-08-06T08:13:58Z

Via: Created page with "== Syntax == * setnpcdisplay("<npc name>", "<display name>", <class id>, <size>) * setnpcdisplay("<npc name>", "<display name>", <class id>) * setnpcdisplay("<npc ..."

== Syntax ==
* [[setnpcdisplay]]("<npc name>", "<display name>", <class id>, <size>)
* [[setnpcdisplay]]("<npc name>", "<display name>", <class id>)
* [[setnpcdisplay]]("<npc name>", "<display name>")
* [[setnpcdisplay]]("<npc name>", <class id>)

== Description ==
Changes the display name and/or display class of the target NPC.

Returns 0 is successful, 1 if the NPC does not exist.

Size is 0 = normal 1 = small 2 = big.

== Examples ==
setnpcdisplay("Test","Test NPC","1002","2"); //The NPC 'Test' will receive the name 'Test NPC', the disguise of a Poring, and be large like a Mastering.
setnpcdisplay("Test","Test NPC","1002"); //The NPC 'Test' will receive the name 'Test NPC' and the disguise of a Poring.
setnpcdisplay("Test","Test NPC"); //The NPC 'Test' will receive the name 'Test NPC'.
setnpcdisplay("Test",1002); //The NPC 'Test' will receive the disguise of a Poring.

[[Category:Script Command]]

Getvariableofnpc

2013-08-06T07:40:28Z

Via: Created page with "==Syntax== *'''getvariableofnpc'''(<variable>, <"npc name">); ==Description== This function retrieves a variable reference to a [[Variables#NPC_Variables|permanent NPC variab..."

==Syntax==
*'''getvariableofnpc'''(<variable>, <"npc name">);

==Description==
This function retrieves a variable reference to a [[Variables#NPC_Variables|permanent NPC variable]] in an another NPC script. Note, that the return value behaves like a variable, not like a value, which means, the return value of this function can be used in other script commands, which expect a variable as parameter.

==Examples==
[[mes]] "The current name of my co-worker is "+getvariableofnpc(.npcname$, "Site Co-Worker");
Prints the value of the variable ''.npcname$'' as if it was used inside the NPC "Site Co-Worker".

mes "Let's give him an another name...";
[[set]] getvariableofnpc(.npcname$, "Site Co-Worker"), "Sleeping Tom";
Sets the variable ''.npcname$'' of the NPC "Site Co-Worker" to "Sleeping Tom".

set .mynpcnamecopy$, getvariableofnpc(.npcname$, "Site Co-Worker");
set .mynpcnamecopy$, "Sleeping Tom";
Will change the variable ''.mynpcnamecopy$'' to "Sleeping Tom", but keep the variable ''.npcname$'' of NPC "Site Co-Worker" unaffected, because the first call to set copies the value of ''.npcname$'' to ''.mynpcnamecopy$'', rather than the reference.

[[Category:Script Command]]

Misceffect

2013-08-05T10:47:32Z

Via: Created page with "== Syntax == * misceffect <effect number>; == Description == This command, if run from an NPC object that has a sprite, will call up a specified effect number, centered o..."

== Syntax ==
* [[misceffect]] <effect number>;

== Description ==
This command, if run from an NPC object that has a sprite, will call up a specified effect number, centered on the NPC sprite. If the running code does not have an object ID (a 'floating' NPC) or is not running from an NPC object at
all (an item script) the effect will be centered on the character who's RID got attached to the script, if any. For usable item scripts, this command will create an effect centered on the player using the item.

A full list of known effects is found in {{git|doc/effect_list.txt}} The list of those that actually work may differ greatly between client versions.

[[Category:Script Command]]

Category:Installation

2013-06-24T10:07:59Z

Via:

This category is used as a place for all pages covering installation of Hercules or its dependancies to be found. If you want to include a page here, and it covers installation of Hercules in any way, shape or form, or one of it's major dependancies, such as SQL or possibly SVN, tag it with the following:

<pre>[[Category:Installation]]</pre>

Please do not create duplicate articles. Thank you.

Doevent

2013-06-23T00:03:00Z

Via: Created page with "==Syntax== *'''doevent''' <"event label">; ==Description== This command invokes a script at given event label in an another NPC. The parameter ''event label'' has the for..."

==Syntax==
*'''doevent''' <"event label">;

==Description==
This command invokes a script at given event label in an another [[NPC]]. The parameter ''event label'' has the form "NpcName::OnLabel" and unlike in [[donpcevent]], it cannot target multiple NPCs by omitting the NPC name. It works much like a [[goto]] command into an another NPC. If there was an [[RID]] attached to the invoking script, it will be attached to the invoked script as well.

This command is not used very much, because it is more limited than donpcevent and passing RID to another script is usually not required.

==Examples==
prontera,150,150,3 script NPC1 53,{
[[mes]] "Let's see, no one look, so let as deal.";
[[next]];
doevent "NPC2::OnTalk";
mes "Damn, we were spotted, so no trade for you.";
[[close]];
}

prontera,152,150,5 script NPC2 53,{
// ...
OnTalk:
[[npctalk]] "Everyone look, "+[[strcharinfo]](0)+" tries to buy forbidden goods!";
[[end]];
}
Every time a player talks to NPC1, NPC2 will scream into it's area, what the player is about to do. Since doevent passes the RID to NPC2, it can use strcharinfo to retrieve the player's name.

[[Category:Script Command]]

Goto

2013-06-23T00:01:42Z

Via: Created page with "== Syntax == * goto <label>; == Description == This command will make the script execution jump to the specified label. It is often used by beginners in conjunction with ..."

== Syntax ==
* [[goto]] <label>;

== Description ==
This command will make the script execution jump to the specified label. It is often used by beginners in conjunction with [[if]], before they get accustomed to other conditional statements, such as [[for]] or [[switch]]. While advanced scripters typically discourage using [[goto]], it can come handy when requiring to leave a complex nested loop without having to use flags or even more complicated code.

== Examples ==
[[if]] ([[checkriding]]()) [[goto]] L_riding;
[[mes]] "Yay, you're not riding a Peco.";
[[close]];

L_riding:
[[mes]] "Please dismount your Peco first.";
[[close]];

[[Category:Script Command]]

AEGIS

2013-06-23T00:01:27Z

Via: Created page with "==What is it?== AEGIS is Windows Server software used along with Microsoft SQL Server by Gravity Corporation to run the official Ragnarok On..."

==What is it?==
AEGIS is Windows Server software used along with [[wikipedia:Microsoft_SQL_Server|Microsoft SQL Server]] by Gravity Corporation to run the official Ragnarok Online game servers.<br />
<br />
It was originally developed for exclusive use within Gravity and Gravity subsidiaries, but has been leaked within its lifetime, purportedly by several teams who compromised official computers which contained AEGIS binaries.<br /><br />

AEGIS consists of a number of components:
*'''Inter Server''' Responsible for Guild Siege, Guild Chat, Private Message and synchronization between servers
*'''Zone Server''' Responsible for Game Play Dynamics
*'''Character Server''' Responsible for Character Information
*'''Account Server''' Responsible for verifying information in the account database, such as if it exists, if it is either paid for or not (active/inactive), etc<br /><br />

==Short History==
AEGIS was originally created by Hakkyu Kim (Neolith) and was his first server project. Despite the fact that Aegis is referred to as production quality (due to the involvement of commercial organizations) leaked versions revealed that the majority of its configuration files were very simple, it used very inefficient means of storing information for reference, and showed very high memory usage when there were no routines running to suggest such usage.<br /><br />

The original development team was forced to leave the company after a takeover by [[wikipedia:Samsung_Electronics|Samsung Electronics] and most of the core members are now working on a project known as [[wikipedia:Granado_Espada|Granado Espada].

== External Links ==
* [[wikipedia:AEGIS_(Ragnarok_Online)|AEGIS article on Wikipedia]]
* [http://forum.asb-sakray.net/ Aegis Support Board]

[[Category:Basics]]

Donpcevent

2013-06-23T00:00:32Z

Via: Created page with "==Syntax== *'''donpcevent''' <"event label">; *'''cmdothernpc''' <"npc name">, <"command">; ==Description== This command invokes the event label code within an another [[NPC]..."

==Syntax==
*'''donpcevent''' <"event label">;
*'''cmdothernpc''' <"npc name">, <"command">;

==Description==
This command invokes the event label code within an another [[NPC]] or NPCs. If ''event label'' has the form "NpcName::OnLabel", then only given NPC's event label will be invoked (much like [[goto]] into another NPC). If the form is "::OnLabel" (''NpcName'' ommited), the event code of all NPCs with given label will be invoked, one after another. In both cases the invoked script will run without an attached [[RID]], whether or not the invoking script was attached to a player. The event label name is required to start with ''On''.

This command can be used to make other NPCs act, as if they were responding to the invoking NPC's actions, such as using an [[emotion]] or [[npctalk|talking]].

The command '''cmdothernpc''' is equivalent to '''donpcevent''' "<npc name>::OnCommand<command>" and an approximation to the [[AEGIS]] script command with same name.

==Examples==
prontera,150,150,3 script NPC 53,{
[[mes]] "Hey NPC2 copies what I do.";
[[close2]];
[[set]] .@emote, [[rand]](1,30);
donpcevent "NPC2::OnEmote";
OnEmote:
[[emotion]] .@emote;
[[end]];
}

prontera,152,150,5 script NPC2 53,{
mes "Hey NPC copies what I do.";
close2;
set .@emote, rand(1,30);
donpcevent "NPC::OnEmote";
OnEmote:
emotion .@emote;
end;
}
Whichever of the both NPCs is talked to, both will show a random emotion at the same time.

==See Also==
* [[doevent]]

[[Category:Script Command]]

Disablenpc

2013-06-22T23:54:59Z

Via: Created page with "Category:Script_Command ==Syntax== *disablenpc "<NPC object name>"; *'''enablenpc''' "<NPC object name>"; ==Description== These two commands will disable and en..."

[[Category:Script_Command]]

==Syntax==
*[[disablenpc]] "<NPC object name>";
*'''[[enablenpc]]''' "<NPC object name>";

==Description==

These two commands will disable and enable, respectively, an NPC object
specified by name. The disabled NPC will disappear from sight and will no longer
be triggerable in the normal way. It is not clear whether it will still be
accessible through '[[donpcevent]]' and other triggering commands, but it probably
will be. You can disable even warp NPCs if you know their object names, which is
an easy way to make a map only accessible through walking half the time. Then
you '[[enablenpc]]' them back.

You can also use these commands to create the illusion of an NPC switching
between several locations, which is often better than actually moving the NPC -
create one NPC object with a visible and a hidden part to their name, make a few
copies, and then disable all except one.

==Examples==
<pre>
prontera,100,100,4 script Tim 81,{
disablenpc "timsbrothertom";
mes "Hey you, I disabled my brother Tom by accident :S";
mes "Can you help me to enable him back?";
next;
if(select("Yes, sure!:No!") == 2) close;
enablenpc "timsbrothertom";
mes "Thank you very much! He is back now :)";
close;
}
prontera,102,100,4 script Tom#1::timsbrothertom 81,{
mes "Hi, I'm Tims brother!";
close;
}
</pre>

Enablenpc

2013-06-22T23:54:53Z

Via: Redirected page to Disablenpc

#REDIRECT [[disablenpc]]
[[Category:Script_Command]]

Delitem

2013-06-22T12:50:23Z

Via: Created page with "==Syntax== *'''delitem''' <item id>, <amount>[, <account id>]; *'''delitem''' <"item name">, <amount>[, <account id>]; ==Description== This command will take a specified amou..."

==Syntax==
*'''delitem''' <item id>, <amount>[, <account id>];
*'''delitem''' <"item name">, <amount>[, <account id>];

==Description==
This command will take a specified amount of given item from the [[RID#Usage|invoking]] character. The items are destroyed - there is no way an [[NPC]] can simply own and have an inventory of items, other than by destroying and recreating them when needed.

Before items are deleted, the script should check, if the player has given amount of items. If there are not enough items, they are deleted anyway, but the script is terminated with an error then, to prevent exploits. If the specified item does not exist, nothing will be deleted, but the script is terminated with an error as well.

If ''account id'' is given, the items are deleted from the character, which is currently online on that account instead. If the player is not online, the script terminates.

==Examples==
delitem 502, 10; // Orange_Potion
Removes 10 Orange Poitions from currently attached character.
delitem 617, 0, 2000110; // Old_Violet_Box
Removes 1 Old Violet Box from an online player on account 2000110.

[[Category:Script Command]]

Itemskill

2013-06-22T12:49:09Z

Via: Created page with "==Syntax== *'''itemskill''' <skill id>, <skill level>; *'''itemskill''' <"skill name">, <skill level>; ==Description== This command meant for item scripts to replicate single..."

==Syntax==
*'''itemskill''' <skill id>, <skill level>;
*'''itemskill''' <"skill name">, <skill level>;

==Description==
This command meant for item scripts to replicate single-use skills in usable items. It will not work properly, if there is a visible dialog window or menu. If the skill is self or auto-targeting, it will be used immediately otherwise a target cursor is shown.

==Examples==
605,Anodyne,Anodyne,11,2000,0,100,,,,,10477567,2,,,,,{ itemskill 8,1; },{}
When Anodyne is used, it will cast Endure (8), Level 1, as if the actual skill has been used from skill tree.

[[Category:Script Command]]

Skilleffect

2013-06-22T12:48:39Z

Via: Created page with "== Syntax == * skilleffect <skill id>,<number>; * skilleffect "<skill name>",<number>; == Description == This command displays visual and aural effects of given skill..."

== Syntax ==
* [[skilleffect]] <skill id>,<number>;
* [[skilleffect]] "<skill name>",<number>;

== Description ==
This command displays visual and aural effects of given skill on [[RID|currently attached character]]. The number parameter is for skill whose visual effect involves displaying of a number (healing or damaging). Note, that this command will not actually use the skill, it is intended for scripts, which simulate skill usage by the [[NPC]], such as buffs, by setting appropriate status and displaying the skill's effect.

== Examples ==
[[mes]] "Be blessed!";
// Heal of 2000 HP
[[heal]] 2000,0;
[[skilleffect]] 28,2000;

// Blessing Level 10
[[sc_start]] 10,240000,10;
[[skilleffect]] 34,0;

// Increase AGI Level 5
[[sc_start]] 12,140000,5;
[[skilleffect]] 29,0;

This will heal the character with 2000 HP, buff it with Blessing Lv 10 and Increase AGI Lv 5, and display appropriate effects.

[[Category:Script Command]]

Template:Mergebox/doc

2013-06-22T12:47:15Z

Via: Created page with "This template aids in creating merge templates. Do not use it for normal articles. If you want to place some merge notice inside an article, create a general template (if it [..."

This template aids in creating merge templates. Do not use it for normal articles. If you want to place some merge notice inside an article, create a general template (if it [[:Category:Templates|does not already exist]]) and put the template in the article instead.

<nowiki>{{mergebox|content}}</nowiki>

<nowiki>{{mergebox|Multi-line content 1
Multi-line content 2
.
.}}</nowiki>
<noinclude>[[Category:Template Documentation]]</noinclude>
<includeonly>[[Category:Box Templates]]</includeonly>

Talk:Hercules Interface System

2013-06-11T23:44:09Z

Via: /* Page Length */

===Page Length===
This article is huge. Wouldn't it be more efficient to create a [[Special: Categories|category]] for the [[Hercules Interface System]], with each large section its own article? Such articles would require the code <code><nowiki>[[Category: Hercules Interface System]]</nowiki></code> added to the footer, but it's simple enough that it can be arranged appropriately. My suggestion is based simply on how cluttered all of this information is on one page. -Via

Talk:Hercules Interface System

2013-06-11T23:43:39Z

Via: Created page with "===Page Length=== This article is huge. Wouldn't it be more efficient to create a category for the Hercules Interface System, with each large secti..."

@commands

2013-06-10T23:49:35Z

Via: Redirected page to GM Commands

#REDIRECT [[GM Commands]]
[[Category: Basics]]

GM Commands

2013-06-10T23:48:52Z

Via: Created page with "==Syntax== * '''@'''<command>{,<param 1>,<param 2>,...} * '''#'''<command>,<target>{,<param 1>,<param 2>,...} ==Description== GM commands can be used to perform a wide array o..."

==Syntax==
* '''@'''<command>{,<param 1>,<param 2>,...}
* '''#'''<command>,<target>{,<param 1>,<param 2>,...}
==Description==
GM commands can be used to perform a wide array of tasks in-game, such as system administration, database queries, player actions, and collecting information regarding a player, party, guild, pet, and/or homunculus. For a full list of atcommands, please see {{git|doc/atcommands.conf}}
==Examples==
===atcommands===
<pre>
@item 909 10
</pre>
Entering this command in-game will give the invoking player a the item 909 (Jellopy) in the amount of 10.

===charcommands===
<pre>
#item Ind 909 10
</pre>
Entering this command in-game will give the target player, Ind, the item 909 (Jellopy) in the amount of 10.

==Notes==
While it is common knowledge throughout the [[Ragnarok Online]] community that atcommands use the '''@''' symbol, the symbol used can be changed to any other character by adjusting '''atcommand_symbol''' and '''charcommand_symbol''' in {{git|conf/atcommand.conf}}

===Exceptions===
{| class="wikitable" border="1"
!Symbol
!Reason
|-
|(0x00-0x1f)||control-characters
|-
|%||party chat symbol
|-
|$||guild chat symbol
|-
|/||client commands symbol
|}

[[Category: Basics]]

Atcommand

2013-06-10T23:17:09Z

Via:

==Syntax==
* [[atcommand]] "Command Line";
==Description==
This command will run the given command line exactly as if it was typed in from the keyboard by the player connected to the invoking character, and that character belonged to an account which had GM level 99.

This command has a lot of good uses, I am sure you can have some fun with this
one.
==Examples==
<pre>
// This will ask the invoker for a character name and then use the '@nuke'
// GM command on them, killing them mercilessly.
input @player$;
atcommand "@nuke "+@player$;
</pre>
[[Category:Script_Command]]

Hercules Plugin Manager

2013-06-10T23:13:31Z

Via: /* HPM @commands */

Often referred to as the [[HPM]], the '''Hercules Plugin Manager''' is yet another [[Hercules Original]]
= Building a plugin =
While the [[C]] code for the plugin normally won't have discrepancies, in order to [[compile]] the plugin certain criteria must be met depending on your [[Operating System]], there are 2 guides below, one for windows and other for everything else (which should work on any *nix distro, as well as on OSX).
;Windows
: [[Building HPM Plugin for MSVC]]
;All Others
: [[Building HPM Plugin for gcc]]
= Creating a plugin =
After following the [[#Building_a_plugin|building a plugin]] guide, all thats left is for your plugin's code to be made, the following will guide you through the basics of how a [[HPM]] plugin works.
== HPM Events ==
Events are functions in a plugin that are triggered by the '''Hercules Plugin Mananger''' when they meet certain criteria.<br/>
* <code>void plugin_init (void)</code>
** Triggered when the server starts
* <code>void plugin_final (void)</code>
** Triggered when the server starts to shut itself down
* <code>void server_ready (void)</code>
** Triggered after the server is done starting, and is online.
With the [[HPM]] you only need to code the events your plugin will use.
== HPM Hooks ==
Support for Hooks will be enabled within the next [[HPM]] release.
== HPM @commands ==
The [[HPM]] makes it very simple to provide [[@commands]] through plugins.<br/>
You define a new atcommand exactly as it'd normally be done in {{git|src/map/atcommand.c}}<br/>
'''Example:'''
ACMD(sample) {//@sample command - 5 params: const int fd, struct map_session_data* sd, const char* command, const char* message, struct AtCommandInfo *info
clif->message(fd,"You used the @sample command!");
ShowDebug("I'm being run! message -> '%s' by '%s'\n",message,sd->status.name);
return true;
}
After that you just have to link your new command, to do that you use the <code>void plugin_init (void)</code> event.
HPMi->addCommand("sample",ACMD_A(sample));
and voila, your plugin now adds the '''@sample''' command.
A full usage of this is demonstrated in the [[HPM]]'s sample {{git|src/plugins/sample.c}}

== HPM Script Commands ==
The [[HPM]] makes it very simple to provide [[Category:Script_Command|script commands]] through plugins.<br/>
You define a new script command exactly as it'd normally be done in {{git|src/map/script.c}}<br/>
'''Example:'''
BUILDIN(sample) {//script command 'sample(num);' - 1 param: struct script_state* st
int arg = script_getnum(st,2);
ShowInfo("I'm being run! arg -> '%d'\n",arg);
return true;
}
After that you just have to link your new script command, to do that you use the <code>void plugin_init (void)</code> event.
HPMi->addScript("sample","i",BUILDIN_A(sample)); //note the 2nd param is this commands' arg-types (in this case, a number)
and voila, your plugin now adds the '''sample''' script command.
A full usage of this is demonstrated in the [[HPM]]'s sample {{git|src/plugins/sample.c}}
== HPM Console Commands ==
The [[HPM]] makes it very simple to provide [[Category:Console_Command|console commands]] through plugins.<br/>
You define a new console command exactly as it'd normally be done in {{git|src/common/console.c}}<br/>
'''Example:'''
CPCMD(sample) {//console command 'sample' - 1 param: char *line
ShowInfo("I'm being run! arg -> '%s'\n",line?line:"NONE");
}
After that you just have to link your new script command, to do that you use the <code>void plugin_init (void)</code> event.
addCPCommand("this:is:a:sample",CPCMD_A(sample)); // note the first param is the path to this command, in this case it translates to 'this is a sample' and everything afterwards is the commands' params
and voila, your plugin now adds the '''sample''' console command.
A full usage of this is demonstrated in the [[HPM]]'s sample {{git|src/plugins/sample.c}}
== HPM Function Overloading ==
Thanks to [[Hercules Renewal Phase One]], you're capable of overloading all functions covered by the [[Hercules Renewal Phase One]] interfaces, with your plugin.<br/>
'''Example:'''
int my_custom_check_target_function( struct block_list *src, struct block_list *target,int flag) {
//<...> code
}
struct battle_interface *battle;
void server_ready(void) {
battle = GET_SYMBOL("battle");
battle->check_target = &my_custom_check_target_function;
}
and voila, your plugin just overloaded the game server's '''battle_check_target''' function with your plugin's own, this is greatly handy to ensure your customs do not create conflicts when updating your [[Hercules|Hercules Repository]]
= Other Features =
Is there something you'd like to do with your plugin that requires modifications to [[HPM]]'s core? [http://hercules.ws/board/forum/55-suggestions/ let we know], and we'll do our best to make it happen.<br/>
[http://hercules.ws/board/forum/55-suggestions/ Post your suggestions here]
= Support =
Need help writing your plugin? [http://hercules.ws/board/forum/26-source-support/ post your question on our support forum]

Atcommand

2013-06-10T23:11:22Z

Via: Created page with "Category:Script_Command ==Syntax== * atcommand "Command Line"; ==Description== This command will run the given command line exactly as if it was typed in from the keyb..."

[[Category:Script_Command]]
==Syntax==
* [[atcommand]] "Command Line";
==Description==
This command will run the given command line exactly as if it was typed in from the keyboard by the player connected to the invoking character, and that character belonged to an account which had GM level 99.

This command has a lot of good uses, I am sure you can have some fun with this
one.
==Examples==
<pre>
// This will ask the invoker for a character name and then use the '@nuke'
// GM command on them, killing them mercilessly.
input @player$;
atcommand "@nuke "+@player$;
</pre>

Hercules Plugin Manager

2013-06-10T23:10:26Z

Via: Updated malformed links and file references

Often referred to as the [[HPM]], the '''Hercules Plugin Manager''' is yet another [[Hercules Original]]
= Building a plugin =
While the [[C]] code for the plugin normally won't have discrepancies, in order to [[compile]] the plugin certain criteria must be met depending on your [[Operating System]], there are 2 guides below, one for windows and other for everything else (which should work on any *nix distro, as well as on OSX).
;Windows
: [[Building HPM Plugin for MSVC]]
;All Others
: [[Building HPM Plugin for gcc]]
= Creating a plugin =
After following the [[#Building_a_plugin|building a plugin]] guide, all thats left is for your plugin's code to be made, the following will guide you through the basics of how a [[HPM]] plugin works.
== HPM Events ==
Events are functions in a plugin that are triggered by the '''Hercules Plugin Mananger''' when they meet certain criteria.<br/>
* <code>void plugin_init (void)</code>
** Triggered when the server starts
* <code>void plugin_final (void)</code>
** Triggered when the server starts to shut itself down
* <code>void server_ready (void)</code>
** Triggered after the server is done starting, and is online.
With the [[HPM]] you only need to code the events your plugin will use.
== HPM Hooks ==
Support for Hooks will be enabled within the next [[HPM]] release.
== HPM @commands ==
The [[HPM]] makes it very simple to provide [[Atcommand|atcommands]] through plugins.<br/>
You define a new atcommand exactly as it'd normally be done in {{git|src/map/atcommand.c}}<br/>
'''Example:'''
ACMD(sample) {//@sample command - 5 params: const int fd, struct map_session_data* sd, const char* command, const char* message, struct AtCommandInfo *info
clif->message(fd,"You used the @sample command!");
ShowDebug("I'm being run! message -> '%s' by '%s'\n",message,sd->status.name);
return true;
}
After that you just have to link your new command, to do that you use the <code>void plugin_init (void)</code> event.
HPMi->addCommand("sample",ACMD_A(sample));
and voila, your plugin now adds the '''@sample''' command.
A full usage of this is demonstrated in the [[HPM]]'s sample {{git|src/plugins/sample.c}}
== HPM Script Commands ==
The [[HPM]] makes it very simple to provide [[Category:Script_Command|script commands]] through plugins.<br/>
You define a new script command exactly as it'd normally be done in {{git|src/map/script.c}}<br/>
'''Example:'''
BUILDIN(sample) {//script command 'sample(num);' - 1 param: struct script_state* st
int arg = script_getnum(st,2);
ShowInfo("I'm being run! arg -> '%d'\n",arg);
return true;
}
After that you just have to link your new script command, to do that you use the <code>void plugin_init (void)</code> event.
HPMi->addScript("sample","i",BUILDIN_A(sample)); //note the 2nd param is this commands' arg-types (in this case, a number)
and voila, your plugin now adds the '''sample''' script command.
A full usage of this is demonstrated in the [[HPM]]'s sample {{git|src/plugins/sample.c}}
== HPM Console Commands ==
The [[HPM]] makes it very simple to provide [[Category:Console_Command|console commands]] through plugins.<br/>
You define a new console command exactly as it'd normally be done in {{git|src/common/console.c}}<br/>
'''Example:'''
CPCMD(sample) {//console command 'sample' - 1 param: char *line
ShowInfo("I'm being run! arg -> '%s'\n",line?line:"NONE");
}
After that you just have to link your new script command, to do that you use the <code>void plugin_init (void)</code> event.
addCPCommand("this:is:a:sample",CPCMD_A(sample)); // note the first param is the path to this command, in this case it translates to 'this is a sample' and everything afterwards is the commands' params
and voila, your plugin now adds the '''sample''' console command.
A full usage of this is demonstrated in the [[HPM]]'s sample {{git|src/plugins/sample.c}}
== HPM Function Overloading ==
Thanks to [[Hercules Renewal Phase One]], you're capable of overloading all functions covered by the [[Hercules Renewal Phase One]] interfaces, with your plugin.<br/>
'''Example:'''
int my_custom_check_target_function( struct block_list *src, struct block_list *target,int flag) {
//<...> code
}
struct battle_interface *battle;
void server_ready(void) {
battle = GET_SYMBOL("battle");
battle->check_target = &my_custom_check_target_function;
}
and voila, your plugin just overloaded the game server's '''battle_check_target''' function with your plugin's own, this is greatly handy to ensure your customs do not create conflicts when updating your [[Hercules|Hercules Repository]]
= Other Features =
Is there something you'd like to do with your plugin that requires modifications to [[HPM]]'s core? [http://hercules.ws/board/forum/55-suggestions/ let we know], and we'll do our best to make it happen.<br/>
[http://hercules.ws/board/forum/55-suggestions/ Post your suggestions here]
= Support =
Need help writing your plugin? [http://hercules.ws/board/forum/26-source-support/ post your question on our support forum]

Countitem

2013-06-10T22:53:24Z

Via:

==Syntax==
*[[countitem]](<itemid>);
*[[countitem]]("Itemname");

==Description==

Countitem will return the number of items of <itemid> the invoking player holds in his inventory.<br>
Like in [[getitem]], you can also write the name of the item ("Name"-column in ItemDB).<br>

==Example==

<pre>
mes "You have "+countitem(501)+"Apples!";
close;
</pre>Will print out the number of Apples the char holds...
<pre>
if(countitem("Apple")>=5){
mes "This will only print if you have 5 or more Apples!";
close;
}
</pre>

[[Category:Script_Command]]