[SOLVED] Manual / help file for non-native AGS templates or modules

Started by Monsieur OUXX, Wed 30/12/2020 14:23:09

Previous topic - Next topic

Monsieur OUXX

I'm thinking of releasing this very beefy module (I'll package it in a template for convenience) and I'd like to know what are the most recent refinements in terms of help files for something that's not native to AGS.
I've seen some very important modules (I can't remember if it was Tweens or maybe Tumbleweed/9verbs) that had their own help sections directly included in the AGS help and I'd like to know exactly how they made that happen.

Was it simply that this module was considered an essential? And since it was in the git repo, then the writer was "allowed" to add a few sections in the main help file?
We can talk later about deciding if my module is considered an essential, right now I'm just asking about the context of how it came to happen.
 

Crimson Wizard

#1
It's Tumbleweed template, and its help was included because it's a part of AGS distribution. There's a page explaining game templates: https://github.com/adventuregamestudio/ags-manual/wiki/Templates
All of them except "Empty Game" have their own articles. Thumbleweed manual was directly copied by one of the people who worked on the manual in past couple of years (I think it was either Morgan Willcock or eri0o).

I don't think we have any pages dedicated to anything that we don't include with AGS program.

Monsieur OUXX

 

eri0o

Hey Monsieur OUXX, all templates included with AGS are included in the help file! As CW said, the reason for inclusion of docs for tumbleweed was because the template was shipped with the Editor.

Outside of templates, modules aren't shipped with the Editor currently - so Tween is not shipped.

The templates shipped with the Editor have their sources here: https://github.com/adventuregamestudio/ags-template-source

Their are exported to .agt files and stored here: https://github.com/adventuregamestudio/ags-templates

When packaging the Editor they are pulled from there.

Tumbleweed which had proper docs written by abstauber here: https://github.com/dkrey/ags_tumbleweed/tree/master/doc which was then reformatted and modified to work inside the current ags manual.

Monsieur OUXX

 

SMF spam blocked by CleanTalk