search

dkrey / ags_tumbleweed

Tumbleweed verbs - a 9 Verb adventure game GUI for AGS
MIT License
14 stars 5 forks source link

Custom dialog options are not documented #31

Open ivan-mogilko opened 2 months ago

ivan-mogilko commented 2 months ago

My attention was brought to this recently, it appears that CustomDialogGui module is not documented. It has a number of settings and few public functions, judging by this header: https://github.com/dkrey/ags_tumbleweed/blob/master/CustomDialogGui.ash

Unfortunately, there's no explanation of these neither in docs nor script itself, leaving users to guess how these should be used.

dkrey commented 2 months ago

The options are documented over here, beginning at line 150: https://github.com/dkrey/ags_tumbleweed/blob/master/TemplateSettings.asc

Since this version of the CDG module is just for this template I didn't bother (yet) to document it outside the settings module. But if it's preferred, I could also copy these comments to the main module.

ivan-mogilko commented 2 months ago

Sorry, I meant not just documentation in code, but the user manual: https://github.com/dkrey/ags_tumbleweed/tree/master/doc

I could not find anything related to the these dialog options.

As for the comments, it would be nice to have some in the header (CustomDialogGui.ash), to let users know what do all of these options mean.