Documentation

International board Development
#1

Click below to download VCMI manual (file updated from time to time)

dc93.4shared.com/img/135714811/d0214227/vcmimanual.pdf

Since many new members join the project, it may be nessessary to figure out the structure of code. Doxygen does well for this purpose.
VCMI 0.73d in Doxy
Click index.html to open it.

[Archived] I want to help
New resolutions
#2

Wow, you’ve managed to parse VCMI source code with doxygen! I tried to do that but it didn’t work. I’ll look at this and see what it’s really worth.

#3

It’s not as useful as I expected. It does not recognize our documentation at all so Visual C++ help is more useful in most cases.

BTW, doxygen manual says that it can generate include graph. It could be quite useful to trace redundant include directives but it seems that you did not put it in your zip file. Could you generate it?

#4

File updated. Now it included search engine and entire source code, and probably much more I din’t figue out yet. There are even some images.

#5

I found it very helpful when trying to understand the GUI classes, particularly the inheritance hierarchy. Once I get more accustomed to the code base I might try to write a basic overview of it’s plumbing.

#6

I tested doxygen yesterday and I generated docs for vcmi with uml diagrams, call and caller graphs etc. but it’s very huge, about 160MB :slight_smile: Anyway I think, it’s very powerfull tool for understand how all work.

#7

After playing a bit with LaTeX, I came up with first VCMI manual. Hopefully it will stop people from asking about new resolutions over and over again.

#8

Nice initiative! :slight_smile:

A couple of suggestions:

  • add a (working) link where WoG 3.58f can be downloaded from (the fileplanet one would work, but the registration might confuse some ppl; I know some other links but to non-English websites… I could have a look for a better link if necessary)
  • specify that 1280x1024 is incomplete (though I will try to make some time one of the next days to finish it)
  • mention also other features/hotkeys introduced by VCMI (I’m not sure if Tow/TowDragon already have a list somewhere, otherwise I’ll put something up).
#9

Certainly I’d be thankful for this one. Since new version gets hundreds of downloads it would be nice to inform players about all the features.

#10

VCMI Enhanced Hotkeys:

  • ‘Q’ - Toggles the stack queue displaying (so it can be enabled/disabled it with single key press)
  • CTRL+Arrows - scrolls Adventure Map behind an open window
  • CTRL pressed blocks Adventure Map scrolling (it allows us to leave the application window without losing current focus)
  • Keybindings for components in selection window: 1, 2, and so on (e.g. for Treasure chest, Skill choice and in the future could be expanded to Commander skill choice and even screens such as Hill Fort).
  • Keybindings in the Split Stack screen (e.g.: 25 will split the stacks as such that there are 25 creatures in the 2nd stack)
  • NumPad 5 centers selected hero (it did nothing in H3; the other NumPad number keys function as in H3, moving hero on the 8 directions)
  • NumPad Enter functions same as normal Enter in the game (it didn’t in H3)
  • NumPad keys can be used in the Save Game screen (they didn’t work in H3)
  • Home / End - move to the top or bottom of the Scenario / Saved game list
  • Mouse wheel - scroll through the Scenario / Saved Game list

Currently we also have:

  • ‘T’ hotkey opens Marketplace window
  • however I believe that should change, as ‘T’ had a different functionality in H3 (select next town). I’ll update this post once we take a decision about this.

For reference, I’ve posted a list with all the original H3 Hotkeys HERE.

@Tow: I know you’ve worked on implementing most of them probably. Check the list again as I’ve made some changes today (the ‘T’ hotkey, plus updates for the Adv.Options & Sys.Options hotkeys).

#11

Ok, manual updated. Now it’s informative value is more than none :wink:

#12

Wow. That was fast. :slight_smile:

Two minor things need to be updated:

  • for Home, you need to remove the “or bottom” description
  • you can remove “Selection dialog can be closed with Enter key” from the list. That existed in H3 as well. It was a mistake from my part in the above post (I removed it now).
#13

It’s fast if you use the right tools. LaTeX does the entire formatting automagically, I need only to add text and a few tags.

WinShell, open-source LaTeX editor
Wikibooks manual explains all common functions.
Miktex is a program used to manage packages, covering pretty everything from quantum physics to bottle labels.

#14

Any new functionalities to describe? I’m gonna update manual, at least by bumping version to 0.8.

#15

If you have a bit of time, can you also update the topics on CH/HC? At CH it’s still mentioned about “Upcoming release 0.76 (1st January)”.

#16

Manual updated with some new info as well as FAQ (finally!).

#17

[size=75]A couple of details (mostly cosmetic, so can wait for the next release to correct):

  1. Indroduction
  • paragraph 1: is it just me, or there are 2 spaces between “HoMM3:” and “WoG”?
  • paragraph 2: “VCMI is a fan-made…”
  1. Installation
  • “VCMI requires full Heroes of Might and Magic 3” - and optionally you could even add between brackets “SoD, Complete or Platinum”, because I think just RoE or AB won’t do it (perhaps not for VCMI, but I’m not sure if WoG installation would be allowed). Though perhaps that’s what you meant by “full”.
  1. New resolutions
  • 1336x768 to be replaced by 1366x768. Plus you can add an asterisk next to it and a foot-note, mentioning that this resolution presents issues in combination with old video cards
  • Stack Queue is visible regardless of the resolution, just differently, so perhaps the part about it can be rephrased
  1. Release notes
  • “Monster has been enabled” - I guess it should be “Monster area of control…”
  • “Online game, random map generator as well as some other parts of the game” perhaps replaced by “Online multiplayer, RMG, Tutorial, High Score & Credits”
  1. Credits
  • Maybe we should have somewhere a list with the devs & testers. Pointing the reader to the board is not exactly “Credits”. Or we should just use another title there i/o Credits.

PS: I seem to have pretty lousy technical skills. I installed WinShell, but I couldn’t figure out how to use it to edit the pdf, to try the changes myself. :blush:

Oh, and an unrelated heads-up: The 0.81 link on page 3 of the VCMI tread on CH is pointing to the 3rd post in the topic i/o the original (#4714 i/o #4712).[/size]

#18

You can’t. PDF is compiled (rendered?) file and it contains info about all packages used to create it. There is no way to revert this process.

I will update the file as soon a spossible.

#19

I prepared doxygen documentation in Wiki style, hopefully now it can be more useful.

New file replaced the old one:
Clicky

#20

I just though of something else we could put in the manual : H3 known bugs which were never fixed in NWC’s add-ons/patches, but not “copied” in VCMI. :slight_smile:

I think we had a couple of these, though the only one I can recall now is boats not corresponding to alignments if bought from the town shipyard. This crossed my mind now because I just found another H3 bug (mentioned in my note to Mantis #370), which we might end up correcting as well.

No need to put this in the manual until we have a decent list, but I wanted to write this down before I forget about it. Maybe I’ll update this post if I remember of other examples (and feel free to point them out if you can think of any).