Staredit Network > Forums > SC1 Mapping Tools > Topic: Chkdraft Plugins
Chkdraft Plugins
Jun 5 2014, 10:53 pm
By: jjf28  

Jun 5 2014, 10:53 pm jjf28 Post #1

Cartography Artisan

So you're looking to make a plugin... first thing's first, you need to decide whether it should be a part of Chkdraft, a standalone program with some of Chkdraft's code to get you started, or a a plugin, each holds advantages and disadvantages.

A Part of Chkdraft: If whatever you're creating has very little abstraction from blizzards map format and is justifiably useful to everyone that might use Chkdraft, pitch it to me, gather a bit of what others think about it, if it seems to fit or has a lot of demand we can work together to get it integrated, the source is included with every official release of Chkdraft so you can look at doing the code yourself if I approve and don't show high enough interest to do it straight away (please track your changes if this is the case).

Advantages: Can use all of Chkdraft's code, no hassle for users, easier distribution of your feature
Disadvantages: Need to get my approval, your code may be altered from time to time

A Standalone Program: If you want to read a map or make some one-time changes a standalone program's the right way to go.

What's provided: Code for opening and saving, almost all code used by Chkdraft to read and make changes to the map
Advantages: Easier and quicker to code than plugins (starts the same way)
Disadvantages: Map may be saved over by this or another program, you're in charge of distribution

A Plugin: If you're making something that would be most useful modifying open maps, this is the right path, it's a little more difficult to get started then a standalone program.

What's provided: Everything you have with standalone programs plus... messages for saving the map, importing and exporting scenario files from/to Chkdraft, and sending new triggers in text or raw TRIG section form
Advantages: Can work near-seamlessly with open maps, instant synchronization
Disadvantages: More difficult to code than standalone programs, you're in charge of distribution





Getting Started:
For starting either a standalone program or plugin, if you do not plan to import/export whole scenarios in a plugin, skip to 9-12

1. Obtain a compiler, ideally Visual Studios 2012
2. Create a new project for your plugin/program
3. Download the latest copy of Chkdraft
4. Browse to //Chkdraft/src/Chkdraft/Source Files/ and copy the entire Mapping Core folder to your projects code folder
5. Include SFmpq_MT.lib for your release configuration and SFmpq_MTd.lib for your debug configuration
    - In VS2012 go to project->properties, select your configuration in the top left box, select linker->input and in addition dependencies put "Mapping Core/SFmpq_MT.lib;" and "Mapping Core/SFmpq_MTd.lib;" for release and debug configurations respectively.
6. In project->properties, under C/C++ All Options, change runtime library to /MT (for release configuration) and /MTd (for debug configuration)
7. Include all the .h and .cpp files from mapping core in your project, preferably under their own filters
8. Put #include "Mapping Core/MappingCore.h" at the top of your main and any other project files that need it

Plugin only steps:

9. Copy ChkdPlugins.h from Chkdraft to your project code folder, include it in your project and #include "ChkdPlugins.h" in any files necessary
10. If your project doesn't have a window, setup a message-only window for communicating with Chkdraft (see example programs if necessary)
11. Get a handle to Chkdraft ( HWND hChkdraft = FindWindow("MainChkdraftWin", NULL); )
12. Send messages as ChkdPlugins.h specifies to communicate with Chkdraft


Examples:

Plugins:
    http://www.staredit.net/files/2962/
    ATextTrigGenerator (link pending)

Standalone Programs:
    http://www.staredit.net/files/2901/
    TerrainScale (link pending)
    TrigAnalysis (link pending)
    TrigCount (link pending)

Post has been edited 5 time(s), last time on Jun 6 2014, 12:03 am by jjf28.



Rs_yes-im4real - Clan Aura - jjf28.net84.net

Reached the top of StarCraft theory crafting 2:12 AM CST, August 2nd, 2014.

Jun 6 2014, 8:51 pm Roy Post #2

An artist's depiction of an Extended Unit Death

Regarding option #1: wouldn't it be easier for you to just put the source up on, say, GitHub, and anyone that wants to add a feature can just make a pull request? Are you using source control for Chkdraft?




Jun 17 2014, 7:30 am Heinermann Post #3

SDE, BWAPI owner, hacker.

Yeah you should definitely put this up on github.

This would allow people to put up pull requests for changes that you can approve/reject. It also provides an issues tracker, as well as releases.

Just make sure you have both a stable and unstable branch. A common setup is to make master the release branch (master reflects the most recent release), and a development branch where you push your changes to.




Jun 17 2014, 11:31 pm leeonix Post #4



i suggest using premake4 to generate project file. not only vs2012.
premake4 is easy to use.



None.

Jun 18 2014, 8:27 am CecilSunkure Post #5



I use premake for all my stuff. Premake is great!



None.

Jul 6 2014, 10:58 pm jjf28 Post #6

Cartography Artisan

Project is now on GitHub: https://github.com/jjf28/Chkdraft/



Rs_yes-im4real - Clan Aura - jjf28.net84.net

Reached the top of StarCraft theory crafting 2:12 AM CST, August 2nd, 2014.

Jul 7 2014, 7:16 am Heinermann Post #7

SDE, BWAPI owner, hacker.

Is there supposed to be a solution(sln) file?




Jul 7 2014, 8:41 am jjf28 Post #8

Cartography Artisan

woops shaved a directory level - it's there now



Rs_yes-im4real - Clan Aura - jjf28.net84.net

Reached the top of StarCraft theory crafting 2:12 AM CST, August 2nd, 2014.

Options
  Back to forum
Please log in to reply to this topic or to report it.
Members in this topic: None.
[02:47 am]
KrayZee -- Yaaay!
[11:54 pm]
MTiger156 -- :wob: :wob:
[11:38 pm]
RIVE -- :wob:
[11:10 pm]
Zycorax -- :wob:
[02:26 pm]
Lingie -- :wob:
[02:25 pm]
Lingie -- Shit, I'm late!
[01:14 pm]
TF- -- SHARTYUKEN!
[2019-12-10. : 1:53 am]
RIVE -- Employers be kink shaming.
[2019-12-09. : 10:01 pm]
MTiger156 -- wut.....
Please log in to shout.


Members Online: Roy, emmabailey, Fraioliaq70, jjf28