I would like to design a module. Is there a developer's guide?

Module Design
1

I looked in “Documentation” and the FAQs and I don’t see a link to a module developer’s guide. How does one learn about it? Thank you.

2

Joel toppin did an excellent video series some years ago on YouTube . Look up Vassal module design 101
It is a bit dated on the interface but the information is still valid.
Kevin

3 Likes
3

Thank you kindly.

4

There should be a link on the main page of the wiki–specifically this: Module Designer’s Guide.

1 Like
5

Note that that Designer’s Guide is seriously out-of-date; there are easier/better ways to do many things nowadays (the guide was written for version 3.1, and we’re up to 3.7 now). However, everything in there should still work, I believe.

1 Like
6

Best to visit Youtube and watch the many videos there, and come here and ask questions. Vassal seems over the top until it finally clicks, once it clicks its easy!

1 Like
7

It’s what I’m doing, having started with Jardic’s suggestion.

1 Like
8

Isaac
I have made a few modules for people he is a questioner I send them. Its good information to know before you start making a module. IMO ‘Prototypes’ are your best friend making modules. I Try to keep only the minimum amount of information counter specific and EVERYTHING else on prototypes. and remember you can nest prototypes.
Below is a cut and paste of the file I send out.

Requested vassal module information.

QUESTIONS ANSWERS
GENERAL
1. Do you have a cover picture?
2. Do you have a preferred font for module?
PLAYER SIDES
1. How many Sides (factions) are there?
2. What are the different side’s names?
3. Is there information that is secret from other players?
4. If more than 2 Sides, and there is secret information, there is a 2 player version what are the combinations?
MAP
1. How many main Maps?
2. If 1 map, do you want the map to be able to open/shut?
3. I will assume you want zoom.
4. Mark the units moved?
5. Do you want Movement Trails?
6. Do you want the Ability to show/Hide units?
7. I will default to NOT centering on opponents move, (set to “Use preferences Setting).
8. Do you want reporting for moving units, creating units, modifying units on this map?
UNITS [this is where I need the most information]
1. How many different types of units are there?
2. What abilities do different units have (more detail better), like masked, flipped, damage, place markers, go somewhere, etc?
3. Text Labels for units?
4. Rotate? How many increments ? free?
5. Mask? Make invisible to opponent?
6. Only be given commands by owner?
7. Show area of effect?
8. Do different Side’s identical units (say armor) need to have different abilities (like go to different force pools)?
TOP ROW BUTTONS
1. Dice; how many, what sided?
2. Charts and tables;
3. Player Specific maps/hands? Only accessible only to owner/side?
4. Inventory menu (list of pieces in play, or pieces with specific features)
5. Do you want generic vassal note window?
6. Do you want generic vassal turn counter.
7. Do you want an ‘Action Button(s)’ (clear all activated markers, delete all disrupted markers, send all air units back to airbases, etc).
9

Jardic, thank you again for the effort. And, happy New Year.