+-
diff --git a/docs/basics/realm.md b/docs/basics/realm.md
deleted file mode 100644
index 3e31ce0..0000000
--- a/docs/basics/realm.md
+++ /dev/null
@@ -1,3 +0,0 @@
-A Realm is a pair of 1 [char server](Character-Server) and 1 [map server](Map-Server). It is possible to have more than 1 Realm for a single [login server](Login-Server).
-
-_See [Multi-Realm](Multi-Realm)_
\ No newline at end of file
diff --git a/docs/basics/rid.md b/docs/basics/rid.md
index 763b1fc..40b8a5b 100644
--- a/docs/basics/rid.md
+++ b/docs/basics/rid.md
@@ -1,11 +1,20 @@
-{{OtherUse|the script state reference id|game object id|GID}}
+Most scripting commands and functions will want to request data about a character, store variables referenced to that
+character, send stuff to the client connected to that specific character. Whenever a script is invoked by a character,
+it is passed a so-called RID - this is the account ID number of a character that caused the code to execute by clicking
+on it, walking into it's [OnTouch](OnTouch "wikilink") zone, or otherwise.
-Most scripting commands and functions will want to request data about a character, store variables referenced to that character, send stuff to the client connected to that specific character. Whenever a script is invoked by a character, it is passed a so-called RID - this is the account ID number of a character that caused the code to execute by clicking on it, walking into it's [[OnTouch]] zone, or otherwise.
+# Usage
-=Usage=
-When writing simple [[NPC|NPCs]] only, this topic will not require much attention. However, when using [[Functions|functions]], [[Timers (Scripting)|timers]], or clock-based script activation, one requires to be aware of all cases when a script execution can be triggered without a RID attached. This will make a lot of commands and functions unusable, since they request data from a specific character, send data to a specific client, or store variables specific to a character, which are unavailable, if there's no RID, which refers to the character to work with, unless [[attachrid]] is used to explicitly attach a character to the script first.
+When writing simple [NPCs](NPC "wikilink") only, this topic will not require much attention. However, when using
+[functions](Functions "wikilink"), [timers](Timers_(Scripting) "wikilink"), or clock-based script activation, one
+requires to be aware of all cases when a script execution can be triggered without a RID attached. This will make a lot
+of commands and functions unusable, since they request data from a specific character, send data to a specific client,
+or store variables specific to a character, which are unavailable, if there's no RID, which refers to the character to
+work with, unless [attachrid](attachrid "wikilink") is used to explicitly attach a character to the script first.
-Whenever is stated ''invoking character'' or ''currently attached character'', it actually means ''the character whose RID is currently attached to the running script''. The script function [[playerattached]] can be used to check which is the currently attached player to the script (it will return 0 if the there is no player attached or the attached player no longer is logged on to the map-server). The function [[detachrid]] will explicitly set the RID to 0, so care must be taken, that follow-up commands do not depend on a character being attached, especially access to [[Variables|temporary character variables]].
-
-[[Category:Basics]]
-[[Category:Scripting]]
+Whenever is stated *invoking character* or *currently attached character*, it actually means *the character whose RID is
+currently attached to the running script*. The script function [playerattached](playerattached "wikilink") can be used
+to check which is the currently attached player to the script (it will return 0 if the there is no player attached or
+the attached player no longer is logged on to the map-server). The function [detachrid](detachrid "wikilink") will
+explicitly set the RID to 0, so care must be taken, that follow-up commands do not depend on a character being attached,
+especially access to [temporary character variables](../scripting/variables.md).
diff --git a/docs/basics/sakray.md b/docs/basics/sakray.md
index 7f3e50e..8b3d63c 100644
--- a/docs/basics/sakray.md
+++ b/docs/basics/sakray.md
@@ -1,27 +1,42 @@
-'''Sakray''' is what official [[Ragnarok Online]] test servers are usually referred to. They are used to test new content and features, before they get installed on the normal servers. When the name "Sakray" is used alone, it typically refers to the kRO Sakray server. Sakray servers are always accessible via a separate client, which is available through a separate download.
+**Sakray** is what official [Ragnarok Online](Ragnarok_Online "wikilink") test servers are usually referred to. They are
+used to test new content and features, before they get installed on the normal servers. When the name "Sakray" is used
+alone, it typically refers to the kRO Sakray server. Sakray servers are always accessible via a separate client, which
+is available through a separate download.
-==History==
+## History
-===Renewal===
-Gravity discontinued the original Sakray development after June 17, 2009, where the last Sakray client was released, and replaced it with Sakray Renewal, which is mostly referred to as "Renewal" or "RE".
+### Renewal
-On kRO, on July 28th Gravity set up a new test server for their Ragnarok Renewal Project. The Renewal is a full scale re-balancing of Ragnarok. The plan is to make RO more accessible to users, and more in line with modern day MMORPG's. In addition, the new mechanics are intended so that they can easily add and improve on current game content (such as 3rd jobs) without destroying game balance.
+Gravity discontinued the original Sakray development after June 17, 2009, where the last Sakray client was released, and
+replaced it with Sakray Renewal, which is mostly referred to as "Renewal" or "RE".
-The intention for renewing Ragnarok Online, was partially the decreasing interest in the game, due to it's age and lack of features present in latest MMORPG, such as tabbed chat or safe skill point distribution, which were part of the first round of renewal, the interface renewal. Further changes include an overhaul in the stat, damage and experience calculation.
+On kRO, on July 28th Gravity set up a new test server for their Ragnarok Renewal Project. The Renewal is a full scale
+re-balancing of Ragnarok. The plan is to make RO more accessible to users, and more in line with modern day MMORPG's. In
+addition, the new mechanics are intended so that they can easily add and improve on current game content (such as 3rd
+jobs) without destroying game balance.
+
+The intention for renewing Ragnarok Online, was partially the decreasing interest in the game, due to it's age and lack
+of features present in latest MMORPG, such as tabbed chat or safe skill point distribution, which were part of the first
+round of renewal, the interface renewal. Further changes include an overhaul in the stat, damage and experience
+calculation.
Schedule for tests of Renewal Server:
-* Closed Beta Test
- Start Date: 2008/07/30
- Server Name: Sakray Renewal Test Server
- Participation: Accepted testers
- Test Period: 2008/07/30 ~ 2008/08/27 (4 weeks)
-* Open Beta Test
- Start Date: 2008/08/27
- Server Name: Sakray Renewal Test Server
- Participation: Anyone
- Test Period: 2008/08/27 ~ 2008/09/24 (4 weeks)
-
-==Usage==
-[[Hexing|Hexed]] kRO Sakray clients are the most used clients with [[Hercules]], although a few people prefer using kRO (live server) clients or clients from different service providers.
-
-[[Category:Basics]]
\ No newline at end of file
+
+- Closed Beta Test
+
+` Start Date: 2008/07/30`
+` Server Name: Sakray Renewal Test Server`
+` Participation: Accepted testers`
+` Test Period: 2008/07/30 ~ 2008/08/27 (4 weeks)`
+
+- Open Beta Test
+
+` Start Date: 2008/08/27`
+` Server Name: Sakray Renewal Test Server`
+` Participation: Anyone`
+` Test Period: 2008/08/27 ~ 2008/09/24 (4 weeks)`
+
+## Usage
+
+[Hexed](Hexing "wikilink") kRO Sakray clients are the most used clients with [Hercules](Hercules "wikilink"), although a
+few people prefer using kRO (live server) clients or clients from different service providers.
diff --git a/docs/basics/zeny.md b/docs/basics/zeny.md
index 2c00468..eed6559 100644
--- a/docs/basics/zeny.md
+++ b/docs/basics/zeny.md
@@ -1,29 +1,46 @@
-[[Zeny]] is the in-game currency used in [[Ragnarok Online]], which can be used for buying and selling items from and to [[NPC]] shops and other players.
+[Zeny](Zeny "wikilink") is the in-game currency used in [Ragnarok Online](Ragnarok_Online "wikilink"), which can be used
+for buying and selling items from and to [NPC](NPC "wikilink") shops and other players.
-== Limitation ==
-The technical limit is for both the client and server up to 2,147,483,647 Zeny, which is typically capped at 1,000,000,000. The cap can be changed inside [`src/common/mmo.h`](https://github.com/HerculesWS/Hercules/blob/stable/src/common/mmo.h) by adjusting the macro ''MAX_ZENY'' to a desired value below the technical limit. The source must be recompiled after this change. If a value is specified which surpasses the technical limit, the server will not compile.
+## Limitation
-== Penalty ==
-Along with EXP death penalties, a Zeny penalty may be set in [`conf/battle/exp.conf`](https://github.com/HerculesWS/Hercules/blob/stable/conf/battle/exp.conf) which reduced the amount of Zeny the player holds upon death:
- // When a player dies (to another player), how much zeny should we penalize them with?
- // NOTE: It is a percentage of their zeny, so 100 = 1%
- zeny_penalty: 0
+The technical limit is for both the client and server up to 2,147,483,647 Zeny, which is typically capped at
+1,000,000,000. The cap can be changed inside
+[`src/common/mmo.h`](https://github.com/HerculesWS/Hercules/blob/stable/src/common/mmo.h) by adjusting the macro
+*MAX_ZENY* to a desired value below the technical limit. The source must be recompiled after this change. If a value is
+specified which surpasses the technical limit, the server will not compile.
-[[Mapflag]]s can be set on certain maps to disable the zeny penalty in [`conf/mapflag/nopenalty.txt`](https://github.com/HerculesWS/Hercules/blob/stable/conf/mapflag/nopenalty.txt)
+## Penalty
-== Vending ==
-The amount of Zeny that can be set to an item when vending is soft-limited to 1,000,000,000 and can be overridden by the setting ''vending_max_value'' in [`conf/battle/items.conf`](https://github.com/HerculesWS/Hercules/blob/stable/conf/battle/items.conf) and [[hexing]] the client to correct the client-side warnings.
+Along with EXP death penalties, a Zeny penalty may be set in
+[`conf/battle/exp.conf`](https://github.com/HerculesWS/Hercules/blob/stable/conf/battle/exp.conf) which reduced the
+amount of Zeny the player holds upon death:
-If the seller obtains more Zeny through vending than ''MAX_ZENY'' the surplus Zeny is discarded. To avoid this, the setting ''vending_over_max'' in [`conf/battle/items.conf`](https://github.com/HerculesWS/Hercules/blob/stable/conf/battle/items.conf) can be set to ''no'', which causes the deal to fail if it would result in more Zeny than the seller is able to hold.
+```
+// When a player dies (to another player), how much zeny should we penalize them with?
+// NOTE: It is a percentage of their zeny, so 100 = 1%
+zeny_penalty: 0
+```
-== Scripting ==
+[Mapflags](Mapflag "wikilink") can be set on certain maps to disable the zeny penalty in
+[`conf/mapflag/nopenalty.txt`](https://github.com/HerculesWS/Hercules/blob/stable/conf/mapflag/nopenalty.txt)
-The name ''Zeny'' is recognized by the script engine as a [[parameter constant]], which affects the amount of Zeny of the [[RID#Usage|currently attached]] player. It can be both read and written.
+## Vending
- [[set]] Zeny,Zeny+120; // gives the player 120z
- [[mes]] "Your current balance is "+Zeny+"z.";
- [[set]] Zeny,0; // takes all Zeny from the player
+The amount of Zeny that can be set to an item when vending is soft-limited to 1,000,000,000 and can be overridden by the
+setting *vending_max_value* in
+[`conf/battle/items.conf`](https://github.com/HerculesWS/Hercules/blob/stable/conf/battle/items.conf) and
+[hexing](hexing "wikilink") the client to correct the client-side warnings.
-[[Category:Basics]]
-[[Category:Configuration]]
-[[Category:Scripting]]
+If the seller obtains more Zeny through vending than *MAX_ZENY* the surplus Zeny is discarded. To avoid this, the
+setting *vending_over_max* in
+[`conf/battle/items.conf`](https://github.com/HerculesWS/Hercules/blob/stable/conf/battle/items.conf) can be set to
+*no*, which causes the deal to fail if it would result in more Zeny than the seller is able to hold.
+
+## Scripting
+
+The name *Zeny* is recognized by the script engine as a [parameter constant](parameter_constant "wikilink"), which
+affects the amount of Zeny of the [currently attached](RID#Usage "wikilink") player. It can be both read and written.
+
+[`set`](set "wikilink")` Zeny,Zeny+120; // gives the player 120z`
+[`mes`](mes "wikilink")` "Your current balance is "+Zeny+"z.";`
+[`set`](set "wikilink")` Zeny,0; // takes all Zeny from the player`
diff --git a/docs/client/assets/edit_color_table_in_photoshop.jpg b/docs/client/assets/edit_color_table_in_photoshop.jpg
new file mode 100644
index 0000000..1345ada
Binary files /dev/null and b/docs/client/assets/edit_color_table_in_photoshop.jpg differ
diff --git a/docs/client/assets/editing_palette_in_notepad.jpg b/docs/client/assets/editing_palette_in_notepad.jpg
new file mode 100644
index 0000000..829c5b2
Binary files /dev/null and b/docs/client/assets/editing_palette_in_notepad.jpg differ
diff --git a/docs/client/assets/load_color_table_in_phoshop.jpg b/docs/client/assets/load_color_table_in_phoshop.jpg
new file mode 100644
index 0000000..9e0dd98
Binary files /dev/null and b/docs/client/assets/load_color_table_in_phoshop.jpg differ
diff --git a/docs/client/assets/sprite_in_photoshop.jpg b/docs/client/assets/sprite_in_photoshop.jpg
new file mode 100644
index 0000000..f84c45b
Binary files /dev/null and b/docs/client/assets/sprite_in_photoshop.jpg differ
diff --git a/docs/client/assets/sprite_in_spr_conview.jpg b/docs/client/assets/sprite_in_spr_conview.jpg
new file mode 100644
index 0000000..69d2f39
Binary files /dev/null and b/docs/client/assets/sprite_in_spr_conview.jpg differ
diff --git a/docs/client/hexing.md b/docs/client/hexing.md
index e4a292f..c659a67 100644
--- a/docs/client/hexing.md
+++ b/docs/client/hexing.md
@@ -4,7 +4,7 @@ As '''hexing''' is considered the process of modifying raw contents of a file on
==Creating custom RagRE client using a DIFF patcher==
RagRE is the abbreviation for Ragnarok Renewal client (ragexeRE.exe), which is normally updated by Gravity weekly, to add new items or features, to fix bugs and the like. This is also the client, which is currently used for Hercules. Although it is possible to use an unmodified client with Hercules (up to 2010/08/04), it is typically modified using a DIFF patcher.
-Each new client requires [http://herc.ws/board/topic/827-weediff-aka-shins-diff-patcher-weediffgen-continuation/ Wee Diff Gen plugin/Shins Diff Patcher] OR [http://herc.ws/board/topic/852-xdiffpatcher-xdiffgen2-packet-parser-and-packet-extractor/ xDiffPatcher].
+Each new client requires [https://herc.ws/board/topic/827-weediff-aka-shins-diff-patcher-weediffgen-continuation/ Wee Diff Gen plugin/Shins Diff Patcher] OR [https://herc.ws/board/topic/852-xdiffpatcher-xdiffgen2-packet-parser-and-packet-extractor/ xDiffPatcher].
===Diffing your client===
====Download your client====
@@ -125,8 +125,8 @@ All changes in OllyDbg is not affected on our Sakexe until we save these changes
* [[clientinfo.xml]]
==External Links==
-* [http://herc.ws/board/topic/852-xdiffpatcher-xdiffgen2-packet-parser-and-packet-extractor/ xDiff Patcher]
-* [http://herc.ws/board/topic/827-weediff-aka-shins-diff-patcher-weediffgen-continuation/ WeeDif/Shin's Diff Patcher]
+* [https://herc.ws/board/topic/852-xdiffpatcher-xdiffgen2-packet-parser-and-packet-extractor/ xDiff Patcher]
+* [https://herc.ws/board/topic/827-weediff-aka-shins-diff-patcher-weediffgen-continuation/ WeeDif/Shin's Diff Patcher]
* [http://www.7-zip.org/download.html 7zip]
* [http://subversion.assembla.com/svn/weetools/ Weetools Repository]
diff --git a/docs/client/palettes.md b/docs/client/palettes.md
index a84cd06..ddcd15b 100644
--- a/docs/client/palettes.md
+++ b/docs/client/palettes.md
@@ -8,16 +8,16 @@
Editing pallets with Photoshop is a simple task. Simply load a sprite with a sprite viewer such as SPR Conview or SprTool+4-6 and export a single frame of the sprite as an image and load it with Photoshop. If your doing job sprites use a image from the job class you wish to make your pallet for and the same goes for hairs, head gear and monsters. As each sprite can have it's own pallet.
-
-
+
+
Once loaded into Photoshop load the color table via the 'Image > Mode > Color Table' like so:
-
+
If the color table is grayed out then the image isn't 256 colors and you won't be able to proceed. Once the color table window is up you'll see the range of colors available and used in the original sprite. Edit them is simple, either click a single color box or select a group (Selecting a group allows you to easily create a gradient range of colors by picking a light color and then picking a darker color, remember to click the 'ok' button.) then pick the new color or enter in the color values into any of the color boxes.
-
+
Once your new pallet is created simple click the save button in the color table window and save your pallet to a .pal file.
@@ -26,7 +26,7 @@ Once your new pallet is created simple click the save button in the color table
Ragnarok Online Pallet files are simply normal pallet files (.pal) with the header removed. Simply open the file like so
-
+
Then selecting whats highlighted in the image and delete it and save. It's that simple.
diff --git a/docs/customization/assets/MSVC_step1.png b/docs/customization/assets/MSVC_step1.png
new file mode 100644
index 0000000..d4035e9
Binary files /dev/null and b/docs/customization/assets/MSVC_step1.png differ
diff --git a/docs/customization/assets/MSVC_step10.png b/docs/customization/assets/MSVC_step10.png
new file mode 100644
index 0000000..44aad61
Binary files /dev/null and b/docs/customization/assets/MSVC_step10.png differ
diff --git a/docs/customization/assets/MSVC_step11.png b/docs/customization/assets/MSVC_step11.png
new file mode 100644
index 0000000..94e8c92
Binary files /dev/null and b/docs/customization/assets/MSVC_step11.png differ
diff --git a/docs/customization/assets/MSVC_step12.png b/docs/customization/assets/MSVC_step12.png
new file mode 100644
index 0000000..fa2fda8
Binary files /dev/null and b/docs/customization/assets/MSVC_step12.png differ
diff --git a/docs/customization/assets/MSVC_step13.png b/docs/customization/assets/MSVC_step13.png
new file mode 100644
index 0000000..d8f84a2
Binary files /dev/null and b/docs/customization/assets/MSVC_step13.png differ
diff --git a/docs/customization/assets/MSVC_step2.png b/docs/customization/assets/MSVC_step2.png
new file mode 100644
index 0000000..b155564
Binary files /dev/null and b/docs/customization/assets/MSVC_step2.png differ
diff --git a/docs/customization/assets/MSVC_step3.png b/docs/customization/assets/MSVC_step3.png
new file mode 100644
index 0000000..6f8ce0a
Binary files /dev/null and b/docs/customization/assets/MSVC_step3.png differ
diff --git a/docs/customization/assets/MSVC_step4.png b/docs/customization/assets/MSVC_step4.png
new file mode 100644
index 0000000..dd55607
Binary files /dev/null and b/docs/customization/assets/MSVC_step4.png differ
diff --git a/docs/customization/assets/MSVC_step5.png b/docs/customization/assets/MSVC_step5.png
new file mode 100644
index 0000000..f9dd680
Binary files /dev/null and b/docs/customization/assets/MSVC_step5.png differ
diff --git a/docs/customization/assets/MSVC_step6.png b/docs/customization/assets/MSVC_step6.png
new file mode 100644
index 0000000..38ba38b
Binary files /dev/null and b/docs/customization/assets/MSVC_step6.png differ
diff --git a/docs/customization/assets/MSVC_step6_.png b/docs/customization/assets/MSVC_step6_.png
new file mode 100644
index 0000000..21fb44d
Binary files /dev/null and b/docs/customization/assets/MSVC_step6_.png differ
diff --git a/docs/customization/assets/MSVC_step7.png b/docs/customization/assets/MSVC_step7.png
new file mode 100644
index 0000000..c658315
Binary files /dev/null and b/docs/customization/assets/MSVC_step7.png differ
diff --git a/docs/customization/assets/MSVC_step7_.png b/docs/customization/assets/MSVC_step7_.png
new file mode 100644
index 0000000..047a8a0
Binary files /dev/null and b/docs/customization/assets/MSVC_step7_.png differ
diff --git a/docs/customization/assets/MSVC_step8.png b/docs/customization/assets/MSVC_step8.png
new file mode 100644
index 0000000..2e0de17
Binary files /dev/null and b/docs/customization/assets/MSVC_step8.png differ
diff --git a/docs/customization/assets/MSVC_step8_.png b/docs/customization/assets/MSVC_step8_.png
new file mode 100644
index 0000000..e3c739e
Binary files /dev/null and b/docs/customization/assets/MSVC_step8_.png differ
diff --git a/docs/customization/building-hpm-plugin-for-msvc.md b/docs/customization/building-hpm-plugin-for-msvc.md
index 1fba275..6a00b3e 100644
--- a/docs/customization/building-hpm-plugin-for-msvc.md
+++ b/docs/customization/building-hpm-plugin-for-msvc.md
@@ -20,13 +20,13 @@ As of December 2018, the IDE version I used for updating this guide uses `Micros
#### The plugin you wish to install
-For this tutorial on how to build your HPM plugin, we will use `YourProject` as the name of the plugin. This means that it is contained in a file called `YourProject.c`. Plugins can be downloaded from the [Hercules Board, Plugin Releases](http://herc.ws/board/forum/142-plugin-releases/).
+For this tutorial on how to build your HPM plugin, we will use `YourProject` as the name of the plugin. This means that it is contained in a file called `YourProject.c`. Plugins can be downloaded from the [Hercules Board, Plugin Releases](https://herc.ws/board/forum/142-plugin-releases/).
## Are there any tools that I can use to automate this?
-In May 2018, User [Kiriez](http://herc.ws/board/profile/8365-kiriez/) introduced the [VS Plugin Creator](http://herc.ws/board/topic/15917-vs-plugin-creator), which automates steps 1 to 13 of the New Method described below. I suggest you try this first to see if it works. Give feedback on the tool (whether it works or not, errors you might encounter) on the thread itself.
+In May 2018, User [Kiriez](https://herc.ws/board/profile/8365-kiriez/) introduced the [VS Plugin Creator](https://herc.ws/board/topic/15917-vs-plugin-creator), which automates steps 1 to 13 of the New Method described below. I suggest you try this first to see if it works. Give feedback on the tool (whether it works or not, errors you might encounter) on the thread itself.
-If his tool didn't work, try using the [Plugin Automator for Windows](http://herc.ws/board/topic/16480-plugin-automator-for-windows) by User [fourxhackd](http://herc.ws/board/profile/17499-fourxhackd/), which automates steps 1 to 10 of the New Method.
+If his tool didn't work, try using the [Plugin Automator for Windows](https://herc.ws/board/topic/16480-plugin-automator-for-windows) by User [fourxhackd](https://herc.ws/board/profile/17499-fourxhackd/), which automates steps 1 to 10 of the New Method.
Using the tools will make sure you don't make simple typo-related mistakes, or placing the files in the wrong folder. Doing it manually, as described in the New Method, will show you exactly what the tools do.
@@ -42,64 +42,64 @@ This method was imported from the Wiki data in 2016, and was updated as of Decem
#### Step 1
-Download the `YourProject.c` from the [Hercules Board, Plugin Releases](http://herc.ws/board/forum/142-plugin-releases/) or build it yourself.
+Download the `YourProject.c` from the [Hercules Board, Plugin Releases](https://herc.ws/board/forum/142-plugin-releases/) or build it yourself.
#### Step 2
Copy or move the `YourProject.c` file into your `/src/plugins/` folder.
-
+
#### Step 3
Depending on which Visual Studio C project version (`.vcproj`) you are using, navigate to the appropriate folder.
For example, if you are using Microsoft Visual Studio IDE (Community 2017), navigate to the directory `\vcproj-15\`. We use 15 because that is the latest build type available (better to use 15 instead of using the older build solutions).
-
+
#### Step 4
Select `plugin-sample.vcxproj`, copy the file, and paste it on the same directory. This will produce a copy of the file with filename `plugin-sample - Copy.vcxproj`.
-
+
#### Step 5
Rename `plugin-sample - Copy.vcxproj` into `YourProject.vcxproj`
While renaming, Highlight the word `YourProject` and Copy it by **Ctrl+C**
-
+
#### Step 6
Right click on `YourProject.vcxproj`, select `Edit with Notepad++` or Microsoft Notepad.
-
+
#### Step 7
Find the following line:
`plugin-sample`
-
+
Replace `plugin-sample` with `YourProject`. Make sure that you copy this correctly and not make typos.
To avoid typos, you can use `CTRL+C` to copy the name of the plugin and `CTRL+V` to paste the name of the plugin without making mistakes.
-
+
#### Step 8
Find the following line:
`sample`
-
+
Replace `sample` to `YourProject`.
`YourProject`
-
+
#### Step 9
Find the following line:
``
-
+
Replace `sample` to `YourProject`.
-
+
#### Step 10
@@ -108,22 +108,22 @@ Save the file by pressing `CTRL+S`.
#### Step 11
From your the main folder of your server, open the appropriate Visual Studio solution file `Hercules-N.sln` using your IDE. In this example, we used `Hercules-15.sln` because we are using Microsoft Visual Studio (Community 2017).
-
+
#### Step 12
On the Solution Explorer tab, right click `Hercules-15`, select `Add > Existing Project...`
-
+
#### Step 13
Select `YourProject.vcxproj` in the `\vcproj-15\` folder.
-
+
#### Step 14
Right click `Solution 'Hercules-15' and select Build Solution.
-
+
This will now re-build your Hercules server while also integrating your plugin. This patches up the source code as necessary and includes the code into the appropriate `.c` files without you having to go to the individual files.
diff --git a/docs/customization/custom-items.md b/docs/customization/custom-items.md
index b2438da..b3c7401 100644
--- a/docs/customization/custom-items.md
+++ b/docs/customization/custom-items.md
@@ -341,7 +341,7 @@ In the doc folder look for a text file called "item\_bonus", it shows
all the scripts items can have and how they work.
For more information about this structure read [Item DB file structure
-overhaul](http://herc.ws/board/topic/2954-item-db-file-structure-overhaul/)
+overhaul](https://herc.ws/board/topic/2954-item-db-file-structure-overhaul/)
# Defining Items clientside - all clients
@@ -352,7 +352,7 @@ For old and new clients alike, the following two files need to be updated
accname.lub can be found with the other lua files under RO
folder/data/luafiles514/luafiles/datainfo. If you do not have these
folders or this file, [see this
-topic](http://herc.ws/board/topic/398-client-translation-project/) and
+topic](https://herc.ws/board/topic/398-client-translation-project/) and
download the latest translated data folder. It points to the item's
sprite file. It is as follows:
diff --git a/docs/customization/custom-pets.md b/docs/customization/custom-pets.md
index 3f29102..d0bf67e 100644
--- a/docs/customization/custom-pets.md
+++ b/docs/customization/custom-pets.md
@@ -85,7 +85,7 @@ Next, you must inherit the item in item_db2.conf for information about the tamin
Script: <" pet 1370; ">
},
-''Note: Read more information about [http://herc.ws/board/topic/2954-item-db-file-structure-overhaul/ Item DB file structure overhaul]''
+''Note: Read more information about [https://herc.ws/board/topic/2954-item-db-file-structure-overhaul/ Item DB file structure overhaul]''
Now you are done, and have a Succubus instead of a Poring. To catch a Succubus, you will use an Unripe Apple (619). To change the item descriptions and egg sprites, please refer to another section of this guide.
==Adding A New Pet==
diff --git a/docs/customization/hercules-plugin-manager.md b/docs/customization/hercules-plugin-manager.md
index fb602f2..bd67836 100644
--- a/docs/customization/hercules-plugin-manager.md
+++ b/docs/customization/hercules-plugin-manager.md
@@ -4,7 +4,7 @@ The **Hercules Plugin Manager**, often referred to as the [[HPM]], is yet anothe
### What does building a plugin mean?
-To build a plugin is the same as to [compile](https://github.com/HerculesWS/Hercules/wiki/Compiling) a plugin. This means that you want to use an existing plugin (that you may have downloaded from [the Plugin Releases forum](http://herc.ws/board/forum/142-plugin-releases/)) in a server.
+To build a plugin is the same as to [compile](https://github.com/HerculesWS/Hercules/wiki/Compiling) a plugin. This means that you want to use an existing plugin (that you may have downloaded from [the Plugin Releases forum](https://herc.ws/board/forum/142-plugin-releases/)) in a server.
### Where do I start?
@@ -22,7 +22,7 @@ There are two (2) guides below: One for Windows and the other for everything els
### What does creating a plugin mean?
-Creating a plugin means to develop/design your custom source code edits that introduces new systems into RO. For example, the people who release plugins in the [Plugin Releases](http://herc.ws/board/forum/142-plugin-releases/) forum created plugins. People who use the plugins that they made should follow the **building a plugin** guide shown above.
+Creating a plugin means to develop/design your custom source code edits that introduces new systems into RO. For example, the people who release plugins in the [Plugin Releases](https://herc.ws/board/forum/142-plugin-releases/) forum created plugins. People who use the plugins that they made should follow the **building a plugin** guide shown above.
**This is usually what more advanced users do, so if you're not sure if you're creating a plugin or not, you most likely aren't creating a plugin.**
@@ -221,12 +221,12 @@ and voila, your plugin just overloaded the game server's **battle\_check\_target
# Other Features
-Is there something you'd like to do with your plugin that requires modifications to [HPM](HPM "wikilink")'s core? [let us know](http://herc.ws/board/forum/55-suggestions/), and we'll do our best to make it happen.
-[Post your suggestions here](http://herc.ws/board/forum/55-suggestions/)
+Is there something you'd like to do with your plugin that requires modifications to [HPM](HPM "wikilink")'s core? [let us know](https://herc.ws/board/forum/55-suggestions/), and we'll do our best to make it happen.
+[Post your suggestions here](https://herc.ws/board/forum/55-suggestions/)
# Support
-Need help writing your plugin? [post your question on our support forum](http://herc.ws/board/forum/26-source-support/)
+Need help writing your plugin? [post your question on our support forum](https://herc.ws/board/forum/26-source-support/)
[script commands](Category:Script_Command "wikilink")
[console commands](Category:Console_Command "wikilink")
diff --git a/docs/customization/mapcache.md b/docs/customization/mapcache.md
index cd52b2d..e6435d1 100644
--- a/docs/customization/mapcache.md
+++ b/docs/customization/mapcache.md
@@ -79,4 +79,4 @@ data_dir: C:\Users\JohnD\Documents\Data Folder\
This will refer to the data folder found at `C:\Users\JohnD\Documents\Data Folder\data`.
## References / Extended Reading
-1. [Myriad's Mapcache Generation 2018](http://herc.ws/board/topic/15868-guide-mapcache-generation-2018/#comment-90027)
+1. [Myriad's Mapcache Generation 2018](https://herc.ws/board/topic/15868-guide-mapcache-generation-2018/#comment-90027)
diff --git a/docs/index.md b/docs/index.md
index c61ef40..340d11b 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -1,9 +1,24 @@
# Welcome to Hercules
-Hercules is an open-source project, revolving around the creation of a robust massively multiplayer online role playing game (MMORPG) server package, emulating a Ragnarok Online Server. 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](https://github.com/Satureja/Athena/wiki/Athena) project.
+Hercules is an open-source project, revolving around the creation of a robust massively multiplayer online role playing
+game (MMORPG) server package, emulating a Ragnarok Online Server. 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](https://github.com/Satureja/Athena/wiki/Athena) project.
-Hercules currently runs on most common Operating Systems currently available today. For a full list, please see the [[System Requirements]].
+Hercules currently runs on most common Operating Systems currently available today. For a full list, please see the
+[System Requirements](setup/system-requirements.md).
-You must have a Github account to edit this wiki. All of its contents are released under the 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.
+You must have a Github account to edit this wiki. All of its contents are released under the 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 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]].
\ No newline at end of file
+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](contributing/editing-the-wiki.md).
+
+
+
+ [Git Repository](https://github.com/HerculesWS/Hercules)
+ |  [Editing the wiki]()
+ |  [Assistance & Support](https://herc.ws/board/)
+
+
diff --git a/docs/main-page.md b/docs/main-page.md
deleted file mode 100644
index ce55b4f..0000000
--- a/docs/main-page.md
+++ /dev/null
@@ -1,95 +0,0 @@
-{| style="width: 100%;" cellspacing="5" cellpadding="0"
-| colspan="3" |
-|-
-| style="background: #FCFCFC; border: 1px solid #AAA; vertical-align: top;" |
-Welcome to Hercules
-
-[[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]]. 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]].
-
-
-
-
-Editing the Wiki
-
-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!
-
-
-'''Quick Editing Tips'''
-*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.
-
-
-
-
-Quick Links
-
-
[[File:about_herc.png]][[Hercules|About Hercules]] | [[File:Git repo.png]][https://github.com/HerculesWS/Hercules Git Repository] |
-[[File:Wiki edit.png]][[Editing the wiki|Editing the Wiki]] | [[File:support.png]][http://herc.ws/board/ Assistance & Support]
-
-
-
-Wiki Contributor
-
-Do you enjoy creating new content such as Guides? Maybe you like doing some organizing and cleaning up of documents? If so, why not apply for a Wiki Contributor position? You'll be acknowledge for your constant contribution of fixing broken pages and creating new ones with a Wiki Contributor badge!
-* [http://herc.ws/board/contactus/ Apply Here!]
-
[[File:Wiki-contrib.png]]
-
-
-| style="background: #FCFCFC; border: 1px solid #AAA; vertical-align: top;" |
-[[Image:poring1.gif]]
Installation
-; [[Getting Started]]
-: [[System Requirements]]
-; [[:Category:Installation|Installation]]
-: [[Installation_(CentOS)|CentOS]]
-: [[Installation_(Debian)|Debian Linux]]
-: [[Installation_(FreeBSD)|FreeBSD]]
-; [[Compiling]]
-; [[Connecting|Connecting and Starting]]
-; [[:Category:Configuration|Configuration]]
-
-[[Image:develing1.gif]]
Server Side
-; [[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]]
-
-[[Image:angeling1.gif]]
Client Side
-; [[:Category:Data|Data]]
-; [[Spriting]]
-: [[Palettes]]
-: [[Acts]]
-:
-; [[:Category:Mapping|Mapping]]
-: [[Modeling]]
-: [[Texture]]
-:
-; [[:Category:Client_Configuration|Client Stuff]]
-;
-; [[:Category:Patchers|Patchers]]
-
-|}
\ No newline at end of file
diff --git a/docs/overview/hercules-changes.md b/docs/overview/hercules-changes.md
index afd958e..fb114f9 100644
--- a/docs/overview/hercules-changes.md
+++ b/docs/overview/hercules-changes.md
@@ -7,7 +7,7 @@ A Compilation of noteworthy changes done by Hercules throughout its existence, n
== April ==
== May ==
=== Instances / Instancing ===
-Since May 30th on the [http://herc.ws/board/topic/928-memory-slasher-may-30-patch/|Memory Slasher Patch]
+Since May 30th on the [https://herc.ws/board/topic/928-memory-slasher-may-30-patch/|Memory Slasher Patch]
==== Functionality/Feature ====
* map server was made capable of creating instances of any maps regardless of client-side edits, e.g. one can clone prontera and call it "mymapname"
* instances were modified to be employed in 4 distinct ways:
diff --git a/docs/overview/hercules-original.md b/docs/overview/hercules-original.md
index 56b0773..f6fec61 100644
--- a/docs/overview/hercules-original.md
+++ b/docs/overview/hercules-original.md
@@ -1,8 +1,8 @@
List of [[Hercules Original|Original Hercules Features]]
-* '''[New]'''[http://herc.ws/board/topic/2954-item-db-file-structure-overhaul/ Item DB File Structure Overhaul]
-* [http://herc.ws/board/topic/302-introducing-hercules-map-zone-database/ Hercules Map Zone DB]
+* '''[New]'''[https://herc.ws/board/topic/2954-item-db-file-structure-overhaul/ Item DB File Structure Overhaul]
+* [https://herc.ws/board/topic/302-introducing-hercules-map-zone-database/ Hercules Map Zone DB]
* [[HPM|Hercules Plugin Mananger]]
-* [http://herc.ws/board/topic/316-introducing-hercules-channel-system/ Hercules Channel System]
-* [http://herc.ws/board/topic/353-packetdb-overhaul/ Packet DB Overhaul]
-* [http://herc.ws/board/topic/548-hercules-console-input-update/ Console Input Redesign]
+* [https://herc.ws/board/topic/316-introducing-hercules-channel-system/ Hercules Channel System]
+* [https://herc.ws/board/topic/353-packetdb-overhaul/ Packet DB Overhaul]
+* [https://herc.ws/board/topic/548-hercules-console-input-update/ Console Input Redesign]
[[Category:Hercules]]
\ No newline at end of file
diff --git a/docs/overview/hercules-renewal-phase-one.md b/docs/overview/hercules-renewal-phase-one.md
index b67d0d7..e573786 100644
--- a/docs/overview/hercules-renewal-phase-one.md
+++ b/docs/overview/hercules-renewal-phase-one.md
@@ -1,4 +1,4 @@
-The [[Hercules Renewal Phase One]] started March 01, 2013, as [http://herc.ws/board/topic/237-hercules-renewal/ announced over the forum by Ind]
+The [[Hercules Renewal Phase One]] started March 01, 2013, as [https://herc.ws/board/topic/237-hercules-renewal/ announced over the forum by Ind]
The primary goal of the [[Hercules Renewal Phase One]] was to prepare the core for the [[Hercules Plugin Manager]]
The [[Hercules Renewal Phase One]] is Completed[[https://github.com/HerculesWS/Hercules/commit/2f2afbd3b63a75695f8f96e3bcb4db9fff5a7dc6 2f2afbd]].
= Available Interfaces =
diff --git a/docs/overview/indai.md b/docs/overview/indai.md
index 7e762fd..7aca3c2 100644
--- a/docs/overview/indai.md
+++ b/docs/overview/indai.md
@@ -1,4 +1,4 @@
-IndAI is a feature employed by [http://herc.ws/board/topic/342-introducing-hercules-stress-test-server/ Hercules Stress Test Server].
+IndAI is a feature employed by [https://herc.ws/board/topic/342-introducing-hercules-stress-test-server/ Hercules Stress Test Server].
== Preamble ==
# '''What is this?''' to make it short, its the ability for the game server to create and control player-looking units
@@ -9,6 +9,6 @@ IndAI is a feature employed by [http://herc.ws/board/topic/342-introducing-hercu
* IndAI units are capable of farming, doing pvp, doing woe, doing battlegrounds.
== Availability ==
-We judged this feature to be potentially dangerous to the private server community if made public, so we'll be keeping it private to be used solely by the [http://herc.ws/board/topic/342-introducing-hercules-stress-test-server/ Hercules Stress Test Server]
+We judged this feature to be potentially dangerous to the private server community if made public, so we'll be keeping it private to be used solely by the [https://herc.ws/board/topic/342-introducing-hercules-stress-test-server/ Hercules Stress Test Server]
[[Category:Hercules]]
\ No newline at end of file
diff --git a/docs/scripting/basic-scripting.md b/docs/scripting/basic-scripting.md
index 6d3a16f..5ccf86a 100644
--- a/docs/scripting/basic-scripting.md
+++ b/docs/scripting/basic-scripting.md
@@ -217,5 +217,5 @@ That's it! You're finished!
* http://www.colorschemer.com/online.html
'''Support, Request and Release'''
-* [http://herc.ws/board/forum/22-script-support/ Scripting support on Hercules Boards]
+* [https://herc.ws/board/forum/22-script-support/ Scripting support on Hercules Boards]
* #Hercules on irc.rizon.net : Main Hercules channel.
diff --git a/docs/setup/connecting.md b/docs/setup/connecting.md
index 2a9f3d9..3703f36 100644
--- a/docs/setup/connecting.md
+++ b/docs/setup/connecting.md
@@ -158,7 +158,7 @@ See [[Hexing#Creating_custom_RagRE_client_using_a_DIFF_patcher|Hexing]].
Execute your exe.
==Trouble Shooting==
-Its always best to post in the [http://herc.ws/board/forum/31-client-side-support/ client support] sub-forum for things that go wrong with the client, and [http://herc.ws/board/forum/14-general-server-support/ server support] sub-forum for things that go wrong with Hercules connecting or if errors pop up in your server log.
+Its always best to post in the [https://herc.ws/board/forum/31-client-side-support/ client support] sub-forum for things that go wrong with the client, and [https://herc.ws/board/forum/14-general-server-support/ server support] sub-forum for things that go wrong with Hercules connecting or if errors pop up in your server log.
===CHARACTER_INFO size error!!===
To fix this, locate the src/common folder and open mmo.h in notepad. Find the following line:
diff --git a/docs/setup/git-clone.md b/docs/setup/git-clone.md
index ce73728..18a96c7 100644
--- a/docs/setup/git-clone.md
+++ b/docs/setup/git-clone.md
@@ -9,4 +9,4 @@ A Git is required to perform a clone. Recommended applications are:
{{:Git Clone/Unix}}
== Windows ==
-Check [http://herc.ws/board/topic/152-obtaining-hercules/?p=845#entry845 Obtaining Hercules] for info on how to clone in windows
\ No newline at end of file
+Check [https://herc.ws/board/topic/152-obtaining-hercules/?p=845#entry845 Obtaining Hercules] for info on how to clone in windows
\ No newline at end of file
diff --git a/docs/setup/index.md b/docs/setup/index.md
index eb004f6..9e4b245 100644
--- a/docs/setup/index.md
+++ b/docs/setup/index.md
@@ -3,6 +3,6 @@
This category contains complete, detailed Hercules installation guides for various operating systems and software.
[[Category:Installation]]
Temporary:
-For instructions on how to install on Linux, please refer to the following forum post by Ind, http://herc.ws/board/topic/105-regarding-github/
+For instructions on how to install on Linux, please refer to the following forum post by Ind, https://herc.ws/board/topic/105-regarding-github/
Please note, if your Linux does not have "apt-get", you may need to use "yum install" instead.
diff --git a/mkdocs.yml b/mkdocs.yml
index 5965532..96d58dd 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -26,6 +26,8 @@ markdown_extensions:
name: mermaid
preserve_tabs: true
- tables
+ - toc:
+ permalink: true
repo_url: https://github.com/HerculesWS/hercules-docs
site_name: Hercules Docs
theme: