Community JGSS documentation

[redspark]

Perhaps we could create a sticky thread in this forum that has posts to document the JGSS code.  There is next to nothing in the code and if every scripter who has written a plugin pitches in to document the classes/code that they know and understand (what the code is doing, how the JGSS works overall, etc.) then more developers would be able to work on improving MV. 

What do you think?  Thanks.

 

[taarna23]

I think this is a fantastic idea, but a wiki might be preferable over a thread.

 

[Zalerinian]

A solution for documentation is being worked on, but if you'd like to create a temporary wiki, that's fine.

 

[Hudell]

I'd rather see something like this: http://rgss3.hudell.com

 

[Zalerinian]

I'd rather see something like this: http://rgss3.hudell.com

I'm working on essentially that. The original version won't be pretty, but it should have the point across.

 

[redspark]

I'm working on essentially that. The original version won't be pretty, but it should have the point across.

That would be nice.  Will it be part of this site or your own?  May be the community could post threads in here and contribute, if you have a format to publish the documentation in.

 

[EternalShadow]

I would love this, I have no idea how to make edits as the docs we have aren't substantial enough.


I would also however like some plain English explanations as to what some things are, so we don't have to keep pulling out dictionaries when we're not advanced scripters


Like, the current docs say the property of variableId is the id of a variable, but says nothing about actually accessing the one you want. You have to actually look in the raw code, apparently.


Additionally, some explanation of the coding structure used (such as how to overwrite something that is already there, like controls) would be greatly appreciated. I am assuming it is prototypes, but I cannot be sure, as there's too much hidden info since I'm no advanced scripter. There's a lot left to be assumed.


I know how to code a bit - just not in this context!

 

[redspark]

Additionally, some explanation of the coding structure used (such as how to overwrite something that is already there, like controls) would be greatly appreciated. I am assuming it is prototypes, but I cannot be sure, as there's too much hidden info since I'm no advanced scripter. There's a lot left to be assumed.

A process flow diagram for combat and the function of each overall screen would be nice too.  That way you can visually see how the code works very quickly and where to go when you want to make a change.

 

[Zalerinian]

That would be nice.  Will it be part of this site or your own?  May be the community could post threads in here and contribute, if you have a format to publish the documentation in.

As I'm not affiliated with RMW, it'd be run on my own website.

 

[EternalShadow]

A process flow diagram for combat and the function of each overall screen would be nice too.  That way you can visually see how the code works very quickly and where to go when you want to make a change.

Yeah, and because you'd be writing it for the default program functions, it's not like you'd be writing it ever again.

 

[redspark]

Yeah, and because you'd be writing it for the default program functions, it's not like you'd be writing it ever again.

Exactly.  The gift that keeps on giving.

 

[Zalerinian]

Your first gift of documentation awaits you!

 

[DarknessFalls]

I cannot wait for proper documentation