adventuregamestudio / ags-manual

AGS documentation.
https://adventuregamestudio.github.io/ags-manual/
MIT License
26 stars 9 forks source link

Expand and enhance the "Editors" topics #218

Open ivan-mogilko opened 1 year ago

ivan-mogilko commented 1 year ago

There are articles for each of the item editor (or a panel) within the Editor, but I notice that their description is not complete.

To give an example, the Room Editor explains how to place objects and characters, but does not thoroughly explain how to edit masks. It gives only a brief note about it, but does not explain how to switch masks, or use eraser, and so on. More screenshots may be also beneficial.

On other panels there are no screenshots at all, and in general - a lack of description for existing properties.

I suppose we need a set of guidelines for the editor topics, which would set a minimal requirements for the article. Such as:

  1. A screenshot of the pane itself, where the controls are marked and have a hint, or a number, with more explanation under the image.
  2. A thorough explanation on how to edit the item, what edit modes exist, how to change between sub-items (if there are any) - such as room contents, or GUI controls.
  3. A full list of properties for the edited item: what it means; and if it's present in script then add a link to Script API article.