Plugin Automator for Windows

[fourxhackd]

View File

Plugin Automator for Windows




This program automates some of the tedious manual process of building a plugin into your Hercules server on a Windows Machine.

It follows the instructions on the Hercules Wiki. From the guide linked, this does steps 1 to 10 of the Old Method (for Windows).

The requirements are still the same (IDE, etc.). This simply manages the repetitive things that need to be done manually.

It also performs error checking so that it's newbie friendly.

What does it do?

1. Locates `YourProject.c`.
2. Locates your Hercules folder.
3. Copies your `YourProject.c` file into your `hercules/src/plugins/` folder. 
4. Select which visual studio project to use.
5. Copies the `plugin-sample.vcxproj` template into your own `YourProject.vcxproj`.
6. Opens the `YourProject.vcxproj` and replace all instances of:

<ProjectName>plugin-sample</projectname>


into 

<ProjectName>YourProject</projectname>


7. Replaces:

<TargetName Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'">sample</targetname>


into

<TargetName Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'">YourProject</targetname>



8. Replace:

 <ClCompile Include="..\src\plugins\sample.c" />


into

 <ClCompile Include="..\src\plugins\YourProject.c" />




9. Finally, instructs you to do the remaining things, as specified in the Hercules Wikipedia.

• Submitter
  fourxhackd
• Submitted
  12/13/18
• Category
  Server Managers / Editors Releases

 

[fourxhackd]

Details

I'm actually the guy who updated the documentation on the Wiki on building an HPM plugin. Been wanting to contribute to the community. So I think this will make plugin deployment easier (with error checking!).

Testing

Currently, I have only tested it on my machine (Windows x64). If you guys could please try testing it on other machines, I would like to know if it works for others.

I am not sure if it requires Node 8.0 to run (as I wrote it using Javascript).

 

[fourxhackd]

Future plans

• I plan to automate the last step (Step 5 on the image on this thread) since that's pretty tedious too.
  
• I also plan to automatically include your plugin into the `Makefile` in the src/plugins/ folder.
  

Discontinuing further work

No longer updating this, since KirieZ VS Plugin Creator tool seems to be more advanced (Has GUI for user friendly experience, integrates your plugin straight into your Visual Studio Solution).