I’ve completed a draft of the Vassal Designer’s Guide. The guide covers how to create, edit and publish modules. As well as incorporating the online help, it includes a great deal of stuff from the forums on how to make best use of various module components and even adds a lot of new, currently undocumented information. There are over a hundred pages of information in the current draft.
I’m intending that the guide will eventually be included with each Vassal download, like the User’s Guide is currently.
Before finalizing and publishing it, I’d like to get review comments from developers, past or present module designers, or anyone who’d like to design a module but hasn’t yet. Anyone is welcome to give feedback on the draft. You can return comments to me either by PM here, or send them directly to my email address (ed at crucible dot cc.)
Hi,
That link doesn’t seem to do anything, just takes you the to front page of mediafire. Also, there will be a lot of updates needed for version 3.2.
Regards,
Brent.
Brilliant work! I like how it is organized. The level of detail is impressive. There is a lot explained here that I remember digging around in modules to make sense of. Well done.
This is very impressive (and thorough) work. Thank you for the contribution. It can go a long way toward addressing the frequent laments I see on BGG and CSW to the effect of: “I’d like to make a module for VASSAL, but I don’t know how to even start.”
I find that to be a little lazy, but it’s definitely a common sentiment out there. At least VASSAL has documentation readily available just about everywhere within the Editor, which is more than you can say for the Cyberboard designer program.
That’s looking really good. I’ve been collecting all my samples for doing various things together and making a web page. It may be a while before I’m finished putting that together but I’ll let you know when it’s ready. You may find it useful to link some of those samples into the documentation.
A guide like this is absolutely essential, in my opinion. I’ve tinkered my own module up to about 70% complete just by poking around on my own, and I can’t wait to see if your guide will provide me with the final answers that I couldn’t find around here. Can’t wait to read it!
Thanks to all for the kind words. I’m looking forward to making the final version available.
I was hoping to get a more detailed review of the content of the draft, particularly in terms of accuracy. There’s a fair amount of information in there, some of which is not currently documented anyplace else, and I want to make sure it’s not misleading or just plain wrong.
If time is an issue, I could defer publication until the 3.2 timeframe. I would simply update this draft with the new 3.2 features (such as named keywords and mathematical expressions) and then it could be published in the 3.2 package.
Thanks to all for the kind words. I’m looking forward to making the
final version available.
I was hoping to get a more detailed review of the content of the draft,
particularly in terms of accuracy. There’s a fair amount of information
in there, some of which is not currently documented anyplace else, and I
want to make sure it’s not misleading or just plain wrong.
If time is an issue, I could defer publication until the 3.2 timeframe.
I would simply update this draft with the new 3.2 features (such as
named keywords and mathematical expressions) and then it could be
published in the 3.2 package.
I haven’t had time to look at this myself, due to fighting with bugs in
the trunk. I intend to comment once I have.