Hercules Wiki - User contributions [en]

Searchstores

2013-11-06T18:42:50Z

Akkarin: Removed requirement for missing template "Works With".

==Syntax==
*'''searchstores''' <uses>,<effect>;

==Description==
Invokes the store search window, which allows to search for both vending and buying stores. Parameter uses indicates, how many searches can be started, before the window has to be reopened. Affect value effects, what happens, when a result item is double-clicked and can be one of the following:
*0 = Shows the store's position on the mini-map and highlights the shop sign with yellow color, when the store is on same map as the invoking player.
*1 = Directly opens the shop, regardless of distance.

Works with clients 2010-08-03aRagexeRE or newer, and revisions from r14732 (Trunk) onwards.

==Examples==
searchstores 10,1;
Item Universal_Catalog_Gold (10 uses, effect: open shop)

==See Also==
* [[buyingstore]]

[[Category:Script Command]]

Hercules Plugin Manager

2013-11-06T17:37:30Z

Akkarin: /* 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.
* <code>void server_post_final (void)</code>
** Triggered after the server's main shutdown procedures are complete, core functionality such as memory manager, timer, and sockets are still available at this point.
With the [[HPM]] you only need to code the events your plugin will use.
== HPM Hooks ==
In Hercules, hooking is a simple operation, it is possible to hook an infinite number of times to the over 2k hookable functions (all the interfaced ones, accounting for over 99% of map server)<br/>
HPExport void plugin_init (void) {
addHookPre("pc->dropitem",my_pc_dropitem_preHook); /* int my_pc_dropitem_preHook(struct map_session_data *sd,int *n,int *amount) */
addHookPost("pc->dropitem",my_pc_dropitem_postHook);/* int my_pc_dropitem_postHook(int retVal, struct map_session_data *sd,int *n,int *amount) */
}
Hooks receive all function params as pointers, whereas the original may be
int pc_dropitem(struct map_session_data *sd,int n,int amount)
the one for the hook shall be
(struct map_session_data *sd,int *n,int *amount)
which allows for hooks to modify any and all data as it pleases.<br/>
postHooks receive one additional param, which accounts for the result of the original function,
int <name>(int retVal, struct map_session_data *sd,int *n,int *amount)
In this case it'd allow for the postHook to react properly to what the original returned, in this case (for pc_dropitem) 0 (failure) or 1 (success)<br/>
A full usage of this is demonstrated in the [[HPM]]'s sample {{git|src/plugins/sample.c}}
== 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.<br/>
A full usage of this is demonstrated in the [[HPM]]'s sample {{git|src/plugins/sample.c}}

As of [https://github.com/HerculesWS/Hercules/commit/778facb21f822cea549939c8dbee886e1cd342aa 778facb21f], atcommands loaded via plugins will overwrite default/original commands with the same name.

== 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.<br/>
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.<br/>
A full usage of this is demonstrated in the [[HPM]]'s sample {{git|src/plugins/sample.c}}
== HPM Custom Packets ==
The HPM makes it possible for a plugin to add or override packets within all 3 servers<br/>
'''Example:'''
/* sample packet implementation */
/* cmd 0xf3 - it is a client-server existent id, for clif_parse_GlobalMessage */
/* in this sample we do nothing and simply redirect */
void sample_packet0f3(int fd) {
struct map_session_data *sd = session[fd]->session_data;

if( !sd ) return;/* socket didn't fully log-in? this packet shouldn't do anything then! */

ShowInfo("sample_packet0f3: Hello World! received 0xf3 for '%s', redirecting!\n",sd->status.name);

clif->pGlobalMessage(fd,sd);
}
void plugin_init(void) {
HPMi->addPacket(0xf3,-1,sample_packet0f3,hpClif_Parse,HPMi->pid);
}
and voila, your plugin just changed the map server's '''0xf3''' packet to pass by '''sample_packet0f3''' prior to being sent to '''clif_parse_GlobalMessage'''<br/>
A full usage of this is demonstrated in the [[HPM]]'s sample {{git|src/plugins/sample.c}}
== HPM Custom Data Structs ==
The HPM makes it possible for a plugin to create and append structs to existent data, this feature is currently supported on player units (map_session_data) and network pipes (socket_data)<br/>
'''Example:'''
/* can be of any size, using any data types */
struct sample_data_struct {
struct point lastMSGPosition;
unsigned int someNumber;
};
/* appends/reads sample_data_struct in a network session data entry (socket_data) */
void some_function_receiving_a_socket_fd(int fd) {
struct sample_data_struct *data;

if( !(data = HPMi->getFromSession(session[fd],HPMi->pid,0)) ) {
CREATE(data,struct sample_data_struct,1);

data->lastMSGPosition.map = 1;
data->lastMSGPosition.x = 150;
data->lastMSGPosition.y = 150;
data->someNumber = rand()%777;

ShowInfo("Created Appended session[] data, %d %d %d %d\n",data->lastMSGPosition.map,data->lastMSGPosition.x,data->lastMSGPosition.y,data->someNumber);
HPMi->addToSession(session[fd],data,HPMi->pid,0,true);
} else {
ShowInfo("Existent Appended session[] data, %d %d %d %d\n",data->lastMSGPosition.map,data->lastMSGPosition.x,data->lastMSGPosition.y,data->someNumber);
if( rand()%4 == 2 ) {
ShowInfo("Removing Appended session[] data\n");
HPMi->removeFromSession(session[fd],HPMi->pid,0);
}
}
}
and voila, your plugin becomes capable of appending and handling your custom struct data<br/>
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
}
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]

Close2

2013-11-06T17:30:20Z

Akkarin: Minor formatting update.

==Syntax==
*'''close2''';

==Description==
This command will create a 'close' button in the message window for the invoking character. This is one of the ways to end a speech from an [[NPC]]. Once the button is clicked, the message box will disappear, but unlike [[close]] the script execution will continue. So after a '''close2''' command an [[end]] command must follow to terminate the script. If no window is currently on screen, the [[RID|invoking character]] will get stuck in the NPC.

==Examples==
[[mes]] "[Woman]";
mes "I am finished talking to you, click the close button.";
'''close2''';
[[dispbottom]] "This will be shown at the characters chat window.";
[[end]];

mes "Thank you for using";
mes "the Kafra Services.";
'''close2''';
[[cutin]] "", 255;
end;
Probably the most common usage of this command. Removing a previously set cutin, after the NPC dialog is closed.

[[Category:Script Command]]

Getlook

2013-11-06T17:12:29Z

Akkarin: Minor formatting update.

== Syntax ==
* '''getlook'''(<type>)

== Description ==
This function will return the number for the current character look value specified by type. See '[[setlook]]' for valid look types.

This can be used to make a certain script behave differently for characters wearing certain styles/colors. :)

== Examples ==
To see '''getlook''' used in an example script, see [[changelook]].
[[Category:Script Command]]

Queueadd

2013-11-06T17:07:49Z

Akkarin: Minor formatting update.

== Syntax ==
*'''queueadd'''(<queue_id>,<account_id>);

== Description ==
Adds <account_id> to queue of <queue_id>, returning 1 if <account_id> is already
present in the queue, if <account_id> was not present in queue, it returns 0.

== Example ==
if('''queueadd'''(.@id,[[getcharid]](3)) == 1){
[[mes]] "You are already in the queue.";
[[close]];
}

[[Category:Script_Command]]
[[Category:Queue]]

Getguildmasterid

2013-11-06T17:06:27Z

Akkarin: Minor formatting update.

==Syntax==
*'''getguildmasterid'''(<guild id>);

==Description==
This function will return the character ID number of the guild master of
the guild specified by the ID. 0 if the character is not a guild master of
any guild.

==Examples==
prontera,155,180,5 script guildmasterID 89,{
if ([[getcharid]](2)!=0) {
[[mes]] '''getguildmasterid'''(getcharid(2))+" it's your guildmaster id";
[[close]];
}
}

==See Also==
* [[getguildmaster]]

[[Category:Script Command]]

Getequippedon

2013-11-06T17:03:31Z

Akkarin: Minor formatting update.

== Introduction ==
=== Why use this command ===
An often unknown feature of equipment is that they can be slotted wherever they like. More specifically, cards can be defined to be slotted in more than just one type of equipment. You can define that a card can be equipped in either an Armor, a Shield or a Garment. The only problem is that, if you want a card to perform different scripts when in different items, you may run into problems finding which type of equipment the card is slotted in.
This command is designed to combat the problem, and to return the type of item the card is slotted in.
=== Example of a card ===
4490,Multislot_Card,Multislot Card,6,2,,10,,,,,,,,52,,,,,{},{},{}

This card can be slotted in an Armor (16), a Shield (32) or a Garment (4) ''(16 + 32 + 4 = 52)''.
However, let's say that you want the following effects to apply:

<pre>[Slotted in Shield]
MDEF + 3
[Slotted in Armor]
DEF + 4
[Slotted in Garment]
FLEE + 10</pre>

We wouldn't be able to differentiate where the card is currently slotted without coding a long, complicated function to find out. This wouldn't be very effective when the player's status has to be recalculated.

== Open /src/map/script.c ==

Insert the following code somewhere:

<pre>/*=======================================================
* Returns where the current item is equipped.
*-------------------------------------------------------*/
BUILDIN_FUNC(getequippedon)
{
int i = current_equip_item_index; // Store here for neater code.
TBL_PC *sd;
if ((sd = script_rid2sd(st))!= NULL)
{
switch(i)
{
case EQI_HAND_L:
script_pushint(st, (sd->inventory_data[i]->type == IT_ARMOR ? EQP_SHIELD : EQP_WEAPON));
break;
default:
script_pushint(st, sd->status.inventory_data[i].equip);
break;
}
}
else
script_pushint(st,0);
return 0;
}</pre>

----

Find
BUILDIN_DEF(getequippercentrefinery,"i"),

Add below
BUILDIN_DEF('''getequippedon''',""),

== Usage ==

To use this command now, perhaps for the aforementioned card, use it as follows:

4490,Multislot_Card,Multislot Card,6,2,,10,,,,,,,,52,,,,,{ if(getequippedon()==EQP_ARMOR) { [[bonus]] bDef,4; } else
if('''getequippedon'''()==EQP_SHIELD) { bonus bMdef,3; } else bonus bFlee,10; },{},{}

[[Category:Source Snippets]]

Close

2013-11-06T16:59:15Z

Akkarin: Minor formatting update.

==Syntax==
*'''close''';

==Description==
This command will create a 'close' button in the message window for the invoking character. This is one of the ways to end a speech from an [[NPC]]. Once the button is clicked, the NPC script execution will end, and the message box will disappear. If no window is currently on screen, the script ends right away.

==Examples==
[[mes]] "[Woman]";
mes "I am finished talking to you, click the close button";
'''close''';
mes "This command will not run at all, cause the script has ended.";

[[Category:Script Command]]

Set

2013-11-06T16:56:55Z

Akkarin: Applied "obsolete" template.

{{obsolete
|type=Script Command
|when=r15982}}

== Syntax ==
* [[set]] <variable>,<expression>;
* [[set]](<variable>,<expression>)
* <variable> = <expression>;

== Description ==
This command will set a variable to the value that the expression results in. <br />

This is the most basic script command and is used a lot whenever you try to do
anything more advanced than just printing text into a message box.

Returns the variable reference (since trunk {{rev|12870}}).

== Examples ==
[[set]] .@x,100; // will make .@x equal 100.

[[set]] .@x,1+5/8+9; // will compute 1+5/8+9 (which is, surprisingly, 10 - remember, all numbers are integer in this language) and make .@x equal it.

or
.@x = 100; // will make .@x equal 100.

.@x = 1+5/8+9; // will compute 1+5/8+9 (which is, surprisingly, 10 - remember, all numbers are integer in this language) and make .@x equal it.

For more information read: [http://rathena.org/board/topic/62395-r15982-script-engine-update/ r15982: Script Engine Update]

[[Category:Script Command]]

Template:Obsolete

2013-11-06T16:55:33Z

Akkarin:

<blockquote>{{yellbox|''This {{{type|script command}}} '''became obsolete''' as of {{{when|<noinclude>some date</noinclude><includeonly>(missing 'when' attribute for template:obsolete)</includeonly>}}}. This page remains intact for legacy purposes.}}''</blockquote><noinclude>

{{Documentation}}
</noinclude>

Template:Obsolete

2013-11-06T16:54:37Z

Akkarin:

<blockquote>{{yellbox|''This {{{type|script command}}} '''became obsolete''' as of {{{when|<noinclude>some date</noinclude><includeonly>(missing 'when' attribute for template:obsolete)</includeonly>}}} This page remains intact for legacy purposes.}}.''</blockquote><noinclude>

{{Documentation}}
</noinclude>

Template:Obsolete

2013-11-06T16:53:00Z

Akkarin:

<blockquote>{{yellbox|''This {{{type|script command}}} '''became obsolete''' as of {{{when|<noinclude>some date</noinclude><includeonly>(missing 'when' attribute for template:obsolete)</includeonly> This page remains intact for legacy purposes.}}}}}.''</blockquote><noinclude>

{{Documentation}}
</noinclude>

Template:Obsolete

2013-11-06T16:50:35Z

Akkarin:

<blockquote>{{yellbox|''This {{{type|article}}} '''became obsolete''' as of {{{when|<noinclude>some date</noinclude><includeonly>(missing 'when' attribute for template:obsolete)</includeonly>}}}}}.''</blockquote><noinclude>

{{Documentation}}
</noinclude>

Queueremove

2013-11-06T16:38:19Z

Akkarin: Minor formatting update.

== Syntax ==
*'''queueremove'''(<queue_id>,<account_id>);
== Description ==
Removes <account_id> from queue of <queue_id>, returns 1 if <account_id> is not
present in the queue, otherwise returns 0.
== Example ==
if ('''queueremove'''(.@id,[[getcharid]](3))==1){;
[[mes]] "You were not in the queue";
[[close]];
}
//Rest Script code Below
......
[[Category:Script_Command]]
[[Category:Queue]]

GetCastleData

2013-11-06T16:35:40Z

Akkarin:

== Syntax ==
*'''getcastledata'''("<map name>",<type of data>)
*'''setcastledata''' "<map name>",<type of data>,<value>;

<br />
== Description ==
This function returns the castle ownership information for the castle referred to by its map name. Castle information is stored in `guild_castle` SQL table.

<br />
== Type of datas ==
Types of data correspond to `guild_castle` table columns:

1 - `guild_id` - Guild ID.
2 - `economy` - Castle Economy score.
3 - `defense` - Castle Defense score.
4 - `triggerE` - Number of times the economy was invested in today.
5 - `triggerD` - Number of times the defense was invested in today.
6 - `nextTime` - unused
7 - `payTime` - unused
8 - `createTime` - unused
9 - `visibleC` - Is 1 if a Kafra was hired for this castle, 0 otherwise.
10 - `visibleG0` - Is 1 if the 1st guardian is present (Soldier Guardian)
11 - `visibleG1` - Is 1 if the 2nd guardian is present (Soldier Guardian)
12 - `visibleG2` - Is 1 if the 3rd guardian is present (Soldier Guardian)
13 - `visibleG3` - Is 1 if the 4th guardian is present (Archer Guardian)
14 - `visibleG4` - Is 1 if the 5th guardian is present (Archer Guardian)
15 - `visibleG5` - Is 1 if the 6th guardian is present (Knight Guardian)
16 - `visibleG6` - Is 1 if the 7th guardian is present (Knight Guardian)
17 - `visibleG7` - Is 1 if the 8th guardian is present (Knight Guardian)

All types of data have their meaning determined by [[War of Emperium]] scripts,
with exception of:
- `guild_id` that is always considered ID of the guild that owns the castle,
- `defense` that is used in Guardians & Emperium HP calculations,
- `visibleG` that is always considered to hold guardian presence bits.

The ''''setcastledata'''' command will behave identically, but instead of returning
values for the specified types of accessible data, it will alter them and cause
them to be sent to the char-server for storage.

Changing Guild ID or Castle Defense will trigger additional actions, like
recalculating guardians' HP.
[[Category:Script Command]]

Thor Patcher

2013-11-06T15:52:21Z

Akkarin: Added examples for notice page and patch list file.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

=Packing the Config Into the Patcher=

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

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

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

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

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

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

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

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

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

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

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

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

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

=See Also=
* [[GRF]]

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

[[Category:Patchers]]

Monster

2013-11-06T15:21:34Z

Akkarin: /* Example */

{{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]]

User:Akkarin

2013-11-06T11:49:46Z

Akkarin:

=About=

== RO Related ==
A relatively unknown entity within Hercules. Akkarin helps out around the [http://rathena.org/board/forum/3-rathena-support-releases/ rAthena Support & Releases] forum. Akkarin has been the Documentation Manager for rAthena at the end of 2012 (looked after /trunk/doc/*). In other *Athena incarnations, Akkarin was known as -Caleb-.

Administrator at [http://spriterepository.com The Sprite Repository].

== General ==
An angry Englishman living in the heart of England. No, he doesn't enjoy the British summer weather. No, he doesn't like crumpets. Yes, he drinks alot of tea.

Akkarin also owns an online alternative clothing store, amongst other websites.

=Special Variables=

==Statistics==
{| class="wikitable"
|-
! Variable
! Output
! Description
|-
| <code><nowiki>{{NUMBEROFPAGES}}</nowiki></code>
| {{NUMBEROFPAGES}}
| Number of wiki pages.
|-
| <code><nowiki>{{NUMBEROFARTICLES}}</nowiki></code>
| {{NUMBEROFARTICLES}}
| Number of pages in namespace.
|-
| <code><nowiki>{{NUMBEROFFILES}}</nowiki></code>
| {{NUMBEROFFILES}}
| Number of uploaded files.
|-
| <code><nowiki>{{NUMBEROFEDITS}}</nowiki></code>
| {{NUMBEROFEDITS}}
| Number of page edits.
|-
| <code><nowiki>{{NUMBEROFVIEWS}}</nowiki></code>
| {{NUMBEROFVIEWS}}
| Number of page views. Usually useless on a wiki using caching.
|-
| <code><nowiki>{{NUMBEROFACTIVEUSERS}}</nowiki></code>
| {{NUMBEROFACTIVEUSERS}}
| Number of active users, based on the criteria used in [[Special:Statistics]].
|}

==Stats==
{| class="wikitable"
|-
! Variable
! Output
! Description
|-
| <code><nowiki>{{REVISIONID}}</nowiki></code>
| {{REVISIONID}}
| Unique revision ID
|-
| <code><nowiki>{{REVISIONDAY}}</nowiki></code>
| {{REVISIONDAY}}
| Day edit was made (unpadded number)
|-
| <code><nowiki>{{REVISIONDAY2}}</nowiki></code>
| {{REVISIONDAY2}}
| Day edit was made (zero-padded number)
|-
| <code><nowiki>{{REVISIONMONTH}}</nowiki></code>
| {{REVISIONMONTH}}
| Month edit was made (zero-padded number as of 1.17+, unpadded number in prior versions)
|-
| <code><nowiki>{{REVISIONMONTH1}}</nowiki></code>
| {{REVISIONMONTH1}}
| Month edit was made (unpadded number)
|-
| <code><nowiki>{{REVISIONYEAR}}</nowiki></code>
| {{REVISIONYEAR}}
| Year edit was made
|-
| <code><nowiki>{{REVISIONTIMESTAMP}}</nowiki></code>
| {{REVISIONTIMESTAMP}}
| Timestamp as of time of edit
|-
| <code><nowiki>{{REVISIONUSER}}</nowiki></code>
| {{REVISIONUSER}}
| The username of the user who made the most recent edit to the page, or the current user when previewing an edit
|}

=Links=

==General==
* [http://hercules.ws/board/user/60-akkarin/ Hercules Forum Profile]
* Akkarin's Wiki [[Special:Contributions/Akkarin|Contributions]]

==Akky's test pages==
[[User:Akkarin/SandboxTitle]]

User:Akkarin/SandboxTitle

2013-11-06T11:37:07Z

Akkarin:

{| 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: 10px; margin: 3px; font-weight: bold; text-align: center; font-size: 180%;">Welcome to 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]].

<br>
<center><b>[[Hercules|About Hercules]]    |    [[Editing_the_wiki|Editing the Wiki]]    |    [https://github.com/HerculesWS/Hercules/blob/master/ GitHub]    |    [http://hercules.ws/board/forum/13-support-releases/ Help & Support]</b></center>
<br>
</div>
|}

{| style="border:0; margin: 0;" width="100%" cellspacing="8"

| 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%;">'''[[Getting_Started|Getting Started]]'''</div>
<div style="background: #FCFCFC; vertical-align: top; padding: 5px; margin: 3px; font-size: 120%;text-align: center;font-weight: bold;">
[[File:Getstarted.png|128px|center|link=Getting_Started]]
Where Do I Start??
<hr>
</div>
<div>
* '''[[:Category:Installation|Installation]]''' instructions
* '''[[Compiling|Compiling]]''' on your OS
* '''[[Connecting|Connecting & Starting]]''' Hercules
</div>

| 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%;">'''[[:Category:Configuration|Configure]] your Server'''</div>
<div style="background: #FCFCFC; vertical-align: top; padding: 5px; margin: 3px; font-size: 120%;text-align: center;font-weight: bold;">
[[File:Configserver.png|128px|center|link=:Category:Configuration]]
Making Hercules Work
<hr>
</div>
<div>
* '''[[Scripting|Scripting]]''' like a pro!
* '''[[Server_Modification|Server Modifications]]''' and what to expect
* '''[[:Category:Database|Database]]''' Configurations - say what??
</div>

| 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%;">'''[[:Category:Client_Configuration|Setup the Client]]'''</div>
<div style="background: #FCFCFC; vertical-align: top; padding: 5px; margin: 3px; font-size: 120%;text-align: center;font-weight: bold;">
[[File:Configclient.png|128px|center|link=:Category:Client_Configuration]]
Creating Connections
<hr>
</div>
<div>
* '''[[Data_Folder_Structure|Data]]''' folder
* '''[[Spriting|Spriting]]''', pixel by pixel
* '''[[:Category:Mapping|Mapping]]''' tutorials
* '''[[:Category:Client_Configuration|Client Configs]]''' make you original
* '''[[:Category:Patchers|Patchers]]''' keep you up-to date!
</div>
|}

{| style="border:0; margin: 0;" width="100%" cellspacing="8"

| 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%;">'''Editing the Wiki'''</div>
<div style="padding: 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>
* Spell check your work!
* Use correct English.
* Do not vandalize the wiki. Vandalization will come with harsh punishment.
* 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="background: #ACD; border: 1px solid #7BC; padding: 5px; margin: 3px; font-weight: bold; text-align: center; font-size: 120%;">'''Latest Tweets'''</div>
<div style="padding: 1em;">
1 Nov
Septober Digest 2013: As mentioned in my previous news, here is the Septober Digest that covers the month of S...<br /> http://bit.ly/1e0HG2E
<div style="text-align: center;">
<hr>
</div>

25 Oct
Hercules: Changes, Adjustments, and Explanations!: Hello Hercules Community!<br />
As you may have noticed, the st... <br />http://bit.ly/19GdJAG
<div style="text-align: center;">
<hr>
</div>

15 Oct
Monster Transform Update: Monster Transform Update<br />
What is it? A new feature when in you can transform your c... <br />http://bit.ly/1cpQHyP
<div style="text-align: center;">
<hr>
</div>

10 Oct
Introducing Bank Support: Bank SupportAccount-Wide Bank May store up to 2.1 Billion Zeny. Works on clients from 2... <br />http://bit.ly/1c4A7o5
</div>
|}

User:Akkarin/SandboxTitle

2013-11-06T11:35:23Z

Akkarin: Making the main page look sexy! Thrown onto test page.

{| 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: 10px; margin: 3px; font-weight: bold; text-align: center; font-size: 180%;">Welcome to 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]].

<br>
<center><b>[[Hercules|About Hercules]]    |    [[Editing_the_wiki|Editing the Wiki]]    |    [https://github.com/HerculesWS/Hercules/blob/master/ GitHub]    |    [http://hercules.ws/board/forum/13-support-releases/ Help & Support]</b></center>
<br>
</div>
|}

{| style="border:0; margin: 0;" width="100%" cellspacing="8"

| 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%;">'''[[Getting_Started|Getting Started]]'''</div>
<div style="background: #FCFCFC; vertical-align: top; padding: 5px; margin: 3px; font-size: 120%;text-align: center;font-weight: bold;">
[[File:Getstarted.png|128px|center|link=Getting_Started]]
Where Do I Start??
<hr>
</div>
<div>
* '''[[:Category:Installation|Installation]]''' instructions
* '''[[Compiling|Compiling]]''' on your OS
* '''[[Connecting|Connecting & Starting]]''' Hercules
</div>

| 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%;">'''[[:Category:Configuration|Configure]] your Server'''</div>
<div style="background: #FCFCFC; vertical-align: top; padding: 5px; margin: 3px; font-size: 120%;text-align: center;font-weight: bold;">
[[File:Configserver.png|128px|center|link=:Category:Configuration]]
Making Hercules Work
<hr>
</div>
<div>
* '''[[Scripting|Scripting]]''' like a pro!
* '''[[Server_Modification|Server Modifications]]''' and what to expect
* '''[[:Category:Database|Database]]''' Configurations - say what??
</div>

| 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%;">'''[[:Category:Client_Configuration|Setup the Client]]'''</div>
<div style="background: #FCFCFC; vertical-align: top; padding: 5px; margin: 3px; font-size: 120%;text-align: center;font-weight: bold;">
[[File:Configclient.png|128px|center|link=:Category:Client_Configuration]]
Creating Connections
<hr>
</div>
<div>
* '''[[:Category:Data|Data]]''' folder
* '''[[Spriting|Spriting]]''', pixel by pixel
* '''[[:Category:Mapping|Mapping]]''' tutorials
* '''[[:Category:Client_Configuration|Client Configs]]''' make you original
* '''[[:Category:Patchers|Patchers]]''' keep you up-to date!
</div>
|}

{| style="border:0; margin: 0;" width="100%" cellspacing="8"

| 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%;">'''Editing the Wiki'''</div>
<div style="padding: 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>
* Spell check your work!
* Use correct English.
* Do not vandalize the wiki. Vandalization will come with harsh punishment.
* 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="background: #ACD; border: 1px solid #7BC; padding: 5px; margin: 3px; font-weight: bold; text-align: center; font-size: 120%;">'''Latest Tweets'''</div>
<div style="padding: 1em;">
1 Nov
Septober Digest 2013: As mentioned in my previous news, here is the Septober Digest that covers the month of S...<br /> http://bit.ly/1e0HG2E
<div style="text-align: center;">
<hr>
</div>

25 Oct
Hercules: Changes, Adjustments, and Explanations!: Hello Hercules Community!<br />
As you may have noticed, the st... <br />http://bit.ly/19GdJAG
<div style="text-align: center;">
<hr>
</div>

15 Oct
Monster Transform Update: Monster Transform Update<br />
What is it? A new feature when in you can transform your c... <br />http://bit.ly/1cpQHyP
<div style="text-align: center;">
<hr>
</div>

10 Oct
Introducing Bank Support: Bank SupportAccount-Wide Bank May store up to 2.1 Billion Zeny. Works on clients from 2... <br />http://bit.ly/1c4A7o5
</div>
|}

File:Getstarted.png

2013-11-06T11:32:42Z

Akkarin:

File:Configserver.png

2013-11-06T11:32:34Z

Akkarin:

File:Configclient.png

2013-11-06T11:32:10Z

Akkarin:

User:Akkarin

2013-11-06T11:11:30Z

Akkarin: Added akky's wiki stats table and link to test pages.

Akkarin's user profile on Hercules.ws: [http://hercules.ws/board/user/60-akkarin/ profile]

=Statistics=
{| class="wikitable"
|-
! Variable
! Output
! Description
|-
| <code><nowiki>{{NUMBEROFPAGES}}</nowiki></code>
| {{NUMBEROFPAGES}}
| Number of wiki pages.
|-
| <code><nowiki>{{NUMBEROFARTICLES}}</nowiki></code>
| {{NUMBEROFARTICLES}}
| Number of pages in namespace.
|-
| <code><nowiki>{{NUMBEROFFILES}}</nowiki></code>
| {{NUMBEROFFILES}}
| Number of uploaded files.
|-
| <code><nowiki>{{NUMBEROFEDITS}}</nowiki></code>
| {{NUMBEROFEDITS}}
| Number of page edits.
|-
| <code><nowiki>{{NUMBEROFVIEWS}}</nowiki></code>
| {{NUMBEROFVIEWS}}
| Number of page views. Usually useless on a wiki using caching.
|-
| <code><nowiki>{{NUMBEROFACTIVEUSERS}}</nowiki></code>
| {{NUMBEROFACTIVEUSERS}}
| Number of active users, based on the criteria used in [[Special:Statistics]].
|}

=This Page=
{| class="wikitable"
|-
! Variable
! Output
! Description
|-
| <code><nowiki>{{REVISIONID}}</nowiki></code>
| {{REVISIONID}}
| Unique revision ID
|-
| <code><nowiki>{{REVISIONDAY}}</nowiki></code>
| {{REVISIONDAY}}
| Day edit was made (unpadded number)
|-
| <code><nowiki>{{REVISIONDAY2}}</nowiki></code>
| {{REVISIONDAY2}}
| Day edit was made (zero-padded number)
|-
| <code><nowiki>{{REVISIONMONTH}}</nowiki></code>
| {{REVISIONMONTH}}
| Month edit was made (zero-padded number as of 1.17+, unpadded number in prior versions)
|-
| <code><nowiki>{{REVISIONMONTH1}}</nowiki></code>
| {{REVISIONMONTH1}}
| Month edit was made (unpadded number)
|-
| <code><nowiki>{{REVISIONYEAR}}</nowiki></code>
| {{REVISIONYEAR}}
| Year edit was made
|-
| <code><nowiki>{{REVISIONTIMESTAMP}}</nowiki></code>
| {{REVISIONTIMESTAMP}}
| Timestamp as of time of edit
|-
| <code><nowiki>{{REVISIONUSER}}</nowiki></code>
| {{REVISIONUSER}}
| The username of the user who made the most recent edit to the page, or the current user when previewing an edit
|}

Akky's test pages:
[[User:Akkarin/SandboxTitle]]

User:Akkarin/Sandbox

2013-05-29T01:38:58Z

Akkarin: /* Statistics */

=Statistics=
{| class="wikitable"
|-
! Variable
! Output
! Description
|-
| <code><nowiki>{{NUMBEROFPAGES}}</nowiki></code>
| {{NUMBEROFPAGES}}
| Number of wiki pages.
|-
| <code><nowiki>{{NUMBEROFARTICLES}}</nowiki></code>
| {{NUMBEROFARTICLES}}
| Number of pages in hercules namespace.
|-
| <code><nowiki>{{NUMBEROFFILES}}</nowiki></code>
| {{NUMBEROFFILES}}
| Number of uploaded files.
|-
| <code><nowiki>{{NUMBEROFEDITS}}</nowiki></code>
| {{NUMBEROFEDITS}}
| Number of page edits.
|-
| <code><nowiki>{{NUMBEROFVIEWS}}</nowiki></code>
| {{NUMBEROFVIEWS}}
| Number of page views. Usually useless on a wiki using caching.
|-
| <code><nowiki>{{NUMBEROFACTIVEUSERS}}</nowiki></code>
| {{NUMBEROFACTIVEUSERS}}
| Number of active users, based on the criteria used in [[Special:Statistics]].
|}

=This Page=
{| class="wikitable"
|-
! Variable
! Output
! Description
|-
| <code><nowiki>{{REVISIONID}}</nowiki></code>
| {{REVISIONID}}
| Unique revision ID
|-
| <code><nowiki>{{REVISIONDAY}}</nowiki></code>
| {{REVISIONDAY}}
| Day edit was made (unpadded number)
|-
| <code><nowiki>{{REVISIONDAY2}}</nowiki></code>
| {{REVISIONDAY2}}
| Day edit was made (zero-padded number)
|-
| <code><nowiki>{{REVISIONMONTH}}</nowiki></code>
| {{REVISIONMONTH}}
| Month edit was made (zero-padded number as of 1.17+, unpadded number in prior versions)
|-
| <code><nowiki>{{REVISIONMONTH1}}</nowiki></code>
| {{REVISIONMONTH1}}
| Month edit was made (unpadded number)
|-
| <code><nowiki>{{REVISIONYEAR}}</nowiki></code>
| {{REVISIONYEAR}}
| Year edit was made
|-
| <code><nowiki>{{REVISIONTIMESTAMP}}</nowiki></code>
| {{REVISIONTIMESTAMP}}
| Timestamp as of time of edit
|-
| <code><nowiki>{{REVISIONUSER}}</nowiki></code>
| {{REVISIONUSER}}
| The username of the user who made the most recent edit to the page, or the current user when previewing an edit
|}

User:Akkarin/Sandbox

2013-05-29T01:38:05Z

Akkarin: Created page with "=Statistics= {| class="wikitable" |- ! Variable ! Output ! Description |- | <code><nowiki>{{NUMBEROFPAGES}}</nowiki></code> | {{NUMBEROFPAGES}} | Number of wiki pages. |- | <c..."

=Statistics=
{| class="wikitable"
|-
! Variable
! Output
! Description
|-
| <code><nowiki>{{NUMBEROFPAGES}}</nowiki></code>
| {{NUMBEROFPAGES}}
| Number of wiki pages.
|-
| <code><nowiki>{{NUMBEROFARTICLES}}</nowiki></code>
| {{NUMBEROFARTICLES}}
| Number of pages in RAthena.
|-
| <code><nowiki>{{NUMBEROFFILES}}</nowiki></code>
| {{NUMBEROFFILES}}
| Number of uploaded files.
|-
| <code><nowiki>{{NUMBEROFEDITS}}</nowiki></code>
| {{NUMBEROFEDITS}}
| Number of page edits.
|-
| <code><nowiki>{{NUMBEROFVIEWS}}</nowiki></code>
| {{NUMBEROFVIEWS}}
| Number of page views. Usually useless on a wiki using caching.
|-
| <code><nowiki>{{NUMBEROFACTIVEUSERS}}</nowiki></code>
| {{NUMBEROFACTIVEUSERS}}
| Number of active users, based on the criteria used in [[Special:Statistics]].
|}

=This Page=
{| class="wikitable"
|-
! Variable
! Output
! Description
|-
| <code><nowiki>{{REVISIONID}}</nowiki></code>
| {{REVISIONID}}
| Unique revision ID
|-
| <code><nowiki>{{REVISIONDAY}}</nowiki></code>
| {{REVISIONDAY}}
| Day edit was made (unpadded number)
|-
| <code><nowiki>{{REVISIONDAY2}}</nowiki></code>
| {{REVISIONDAY2}}
| Day edit was made (zero-padded number)
|-
| <code><nowiki>{{REVISIONMONTH}}</nowiki></code>
| {{REVISIONMONTH}}
| Month edit was made (zero-padded number as of 1.17+, unpadded number in prior versions)
|-
| <code><nowiki>{{REVISIONMONTH1}}</nowiki></code>
| {{REVISIONMONTH1}}
| Month edit was made (unpadded number)
|-
| <code><nowiki>{{REVISIONYEAR}}</nowiki></code>
| {{REVISIONYEAR}}
| Year edit was made
|-
| <code><nowiki>{{REVISIONTIMESTAMP}}</nowiki></code>
| {{REVISIONTIMESTAMP}}
| Timestamp as of time of edit
|-
| <code><nowiki>{{REVISIONUSER}}</nowiki></code>
| {{REVISIONUSER}}
| The username of the user who made the most recent edit to the page, or the current user when previewing an edit
|}

Template:Disputed

2013-05-29T01:08:19Z

Akkarin: Changing Doc to doc includes the correct documentation templates.

{{yellbox|''This {{{type|article}}}'s '''factual accuracy is [[wikipedia:Wikipedia:Accuracy_dispute|disputed]]'''. Please see the relevant discussion on the [[{{TALKPAGENAME}}|talk page]] and comment on the further proceeding with this {{{type|article}}}.'' <small>''({{{date|unknown date}}})''</small>}}<includeonly>{{{nocat|[[Category:Accuracy disputes from {{{date}}}]]}}}</includeonly><noinclude>

{{documentation}}
</noinclude>

Template:Git

2013-05-29T01:07:37Z

Akkarin: Changing Doc to doc includes the correct documentation templates.

[https://github.com/HerculesWS/Hercules/blob/master/{{{1|}}} {{#ifeq: {{{2|}}} | full | https://github.com/HerculesWS/Hercules/blob/master/ | }}{{{1|}}}]<noinclude>
{{documentation}}
</noinclude>

Template:Incomplete

2013-05-29T01:01:57Z

Akkarin: Corrected wikipedia link

{{yellbox|''This {{{type|article}}} is '''incomplete'''. If you'd like to help [{{SERVER}}{{localurl:{{FULLPAGENAME}}|action=edit}} expand it], see the [[wikipedia:Help:Editing|help on editing]] and the [[wikipedia:Wikipedia:Manual_of_style|style guide]], or comment on the [[{{NAMESPACE}} talk:{{PAGENAME}}|talk page]].''}}<includeonly>[[Category:Incomplete]]</includeonly><noinclude>

{{Documentation}}
</noinclude>

User:Akkarin

2013-05-29T00:50:15Z

Akkarin:

#REDIRECT [http://hercules.ws/board/user/60-akkarin/]

User:Akkarin

2013-05-29T00:30:35Z

Akkarin: Created page with "Yeah.. i don't like redlinks."

Yeah.. i don't like redlinks.

Template:Yellbox/doc

2013-05-29T00:29:06Z

Akkarin: Created page with "The {{tl|yellbox}} template is a simple template used to enclose information in a yellow box that is easy to notice. There are many other templates that use this as a base for..."

The {{tl|yellbox}} template is a simple template used to enclose information in a yellow box that is easy to notice. There are many other templates that use this as a base for their output, such as:

'''<nowiki>{{outdated}}</nowiki>'''
{{outdated}}
<br />

'''<nowiki>{{incomplete}}</nowiki>'''
{{incomplete}}
<br />

'''<nowiki>{{duplication}}</nowiki>'''
{{duplication}}
<br />

'''<nowiki>{{disputed}}</nowiki>'''
{{yellbox|''This article's '''factual accuracy is disputed'''. Please see the relevant discussion on the [[{{TALKPAGENAME}}|talk page]] and comment on the further proceeding with this article.'' <small>''(unknown date)''</small>}}

You can also use this template for your own needs. See the following examples.

== Usage ==
Yellbox only has one parameter and all information can be placed within.

For example, <nowiki>{{yellbox|Example string enclosed using {{yellbox}} template}}</nowiki> will display as:
{{yellbox|Example string enclosed using <nowiki>{{yellbox}}</nowiki> template}}

<noinclude>[[Category:Template Documentation]]</noinclude>
<includeonly>[[Category:Templates]]</includeonly>