Building HPM Plugin for MSVC

2015-12-11T15:25:19Z

Hemagx: Put Warning about wrong fix.

= Guide =
This is a guide on how to prepare your MSVC environment for a new [[HPM]] plugin.
== Installation ==
=== Step 1 ===
Go to '''src/plugins/''' folder, create a new '''.c''' file, e.g. '''dance.c''' (this name will be used throughout this guide)
[[File:step1.JPG|center|750px]]
=== Step 2 ===
Open dance.c and paste this code
<pre>
#include "common/hercules.h" // Should always be the first Hercules file included! (if you don't make it first, you won't be able to use interfaces)
#include <stdio.h>
#include <string.h>
#include "common/HPMi.h"
#include "map/script.h"
#include "map/pc.h"
#include "common/HPMDataCheck.h" // should always be the last file included! (if you don't make it last, it'll intentionally break compile time)

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

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

/* Server Startup */
HPExport void plugin_init (void) {
addAtcommand("dance",dance);
}
</pre>

=== Step 3 ===
Open your MSVC project (e.g. '''Hercules-10.sln'')
[[File:step2.JPG|center|750px]]
=== Step 4 ===
Go to the '''Solution Explorer'''
[[File:step3.JPG|center|750px]]
=== Step 5 ===
Right click the Hercules project (first item in '''Solution Explorer'''), and click '''Add->New Project'''
[[File:step4.JPG|center|750px]]
=== Step 6 ===
Select '''General''', and pick '''Empty Project'''.
[[File:step5.JPG|center|750px]]
=== Step 7 ===
Enter the name of your plugin in the '''Name''' field, and click OK.
=== Step 8 ===
In the solution explorer it'll display the new project.
[[File:step6.JPG|center|750px]]
=== Step 9 ===
Right click the new project, and open '''Add->Existing Item'''
[[File:step7.JPG|center|750px]]
=== Step 10 ===
Browse to '''src/plugins/''' and select the '''dance.c''' file, and hit OK.
[[File:step8.JPG|center|750px]]
=== Step 11 ===
It will place the '''dance.c''' file under the '''Source Files''' folder, drag it to the project you created and drop it (in a manner it be placed out of the source files folder.)
[[File:step9.JPG|center|750px]]
(It should look like the image below)
[[File:step10.JPG|center|750px]]
=== Step 12 ===
With the '''dance.c''' out of the folders, delete the 3 of them (select the 3, hit delete, hit ok)
[[File:step11.JPG|center|750px]]
(It should look like the image below)
[[File:step12.JPG|center|750px]]
=== Step 13 ===
Right click the project you created, open '''Properties'''
[[File:step13.JPG|center|750px]]
=== Step 14 ===
Under '''Configuration Properties''' click '''General''', change '''Output Directory''' to '''..\plugins\''', '''Intermediate Directory''' to '''$(ProjectName)\$(ConfigurationName)\''' and '''Configuration Type''' to '''Dynamic Library (.dll)'''
[[File:step14.JPG|center|750px]]
=== Step 15 ===
Under '''Configuration Properties''' click '''C/C++''' and open '''General''', change '''Additional Include Directories''' to '''..\src;..\3rdparty;..\3rdparty\msinttypes\include;%(AdditionalIncludeDirectories)'''
[[File:step15.JPG|center|750px]]
=== Step 16 ===
Under '''Configuration Properties''' click '''Linker''' and open '''General''', change '''Output File''' to '''$(OutDir)\$(ProjectName).dll'''
[[File:step16.JPG|center|750px]]
=== Step 17 ===
Under '''Configuration Properties''' click '''C/C++''' and open '''Preprocessor''', change '''Preprocessor Definitions''' to '''_WINDLL;PCRE_SUPPORT;%(PreprocessorDefinitions)'''
[[File:step17.jpg|center|750px]]
=== Step 18 ===
Add your code to the '''dance.c''' file, and then right-click the project you created, and select '''Build'''
=== Step 19 ===
Add it to ''' /conf/plugins.conf'''
<pre>
plugins_list: [
/* Enable HPMHooking when plugins in use rely on Hooking */
//"HPMHooking",
//"db2sql",
//"sample",
//"other",
"dance", // loads dance plugin
]
</pre>

== PCRE_SUPPORT ==
{{yellbox|The steps described here are a temporary solution. They will no longer be necessary after issue [https://github.com/HerculesWS/Hercules/issues/931 #931] is fixed.}}

Although previously on step-17 has included PCRE_SUPPORT, but it was just to prevent the error message on map-server if the plugin has included npc.h. To properly make use of the PCRE interface, there are 2 additional steps.
=== Step 1 ===
Under '''Configuration Properties''' click '''Linker''' and open '''Input''', On '''Additional Dependencies''', Add '''pcre.lib;''' at the beginning.
[[File:Pcre support step1.png|center|750px]]

Under '''Configuration Properties''' click '''Linker''' and open '''General''', On '''Additional Library Directory''', Add '''..\3rdparty\pcre\lib;'''
[[File:Pcre support step2.png|center|750px]]

=== Step 2 ===
And don't forget to include pcre.h in your plugin
#include "../3rdparty/pcre/include/pcre.h"

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

= New Note =
* Sorry for editing this page, I added step by step images for other people to follow so they can easily follow one of the best feature Hercules have, the HPM. - Thanna
* The tutorial is tested on MSVC 2010.
* Add additional steps for PCRE_SUPPORT, credit to hemagx for the info, which he claimed that came from Haru

[[Category:Installation]]

Map Server

2014-11-26T23:41:29Z

Hemagx: Created page with "{{incomplete}} == Server Overview == Map Server is responsible for Game Play Dynamics. == Server Tasks == * Running Game Play Dynamics"

{{incomplete}}

== Server Overview ==
Map Server is responsible for Game Play Dynamics.

== Server Tasks ==
* Running Game Play Dynamics

User:Hemagx

2014-11-26T23:29:44Z

Hemagx: Created page with "== Who's Hemagx ? == just another neko."

== Who's Hemagx ? ==

just another neko.

Inter Server

2014-11-26T23:23:59Z

Hemagx: Redirected page to Character Server

#REDIRECT [[Character Server]]

Character Server

2014-11-26T23:19:39Z

Hemagx: Created page with "{{incomplete}} == Character Server Overview == Character Server is where users/players go through while Character Select or Making new character. Map Server also use this ..."

{{incomplete}}
== Character Server Overview ==
Character Server is where users/players go through while Character Select or Making new character.
[[Map Server]] also use this server to handle character data saving and load process.
Character Server also holding inside it a [[Inter Server]].

== Character Server Tasks ==
* Process Character Select / Making new Character
* Load/Save Character Data and send it to Map Server
* Load/Save Character and Account based variables

== Inter Server Overview ==
Inter Server is made to sync between all [[Map Server|Map servers]], in case you're using [[Multi Zone]] System it will take care of sync all your servers.

== Inter Server Tasks ==
* Taking Care of Sync between all Map Servers

Login Server

2014-11-26T22:50:22Z

Hemagx:

== Server Overview ==
Login Server is where the users/players go right after pressing enter in the login screen of the client. During the process of logging in, username and password fields from the login table of hercules schema will be compared with the username and password inputted by the client. Once verified, the player will proceed to the [[Character Server]].

== Server Tasks ==

* Process user login
* Load/Save global accounts variables
* Load/Save accounts information
* Block/Unblock accounts

[[Category:Hercules]]

Hercules Wiki - User contributions [en]

Building HPM Plugin for MSVC

Map Server

User:Hemagx

Inter Server

Character Server

Login Server