TheExDeus
|
|
Posted on: August 22, 2010, 10:30:48 am |
|
|
Joined: Apr 2008
Posts: 1860
|
So.. anyway. I though on how I could help and manual came to mind. I wanted to know how exactly will help work? At one point you made some online page, but I don't really think that online manual is the best idea. I for one, think that GM style help works the best. You can search really fast in it, and information about every functions is present. There was also some information thing in the function progress page, but it seems that it has been removed. As far as GM's functions are concerned, we could just take the information from the GM's manual (shamelessly copy and paste) and it would cover most of the manual.
edit: Also, I think the priority still should be not adding new functions, but just replicating the GM ones. So when you could open a GM game, press run, and just create a 5x smaller and 5x faster game than GM that would be the greatest thing. And would be a great insult to YYG too. Then we could become prophets, and go around GMC and tell about free new age of game development.
|
|
« Last Edit: August 22, 2010, 10:33:18 am by HaRRiKiRi »
|
Logged
|
|
|
|
|
IsmAvatar
|
|
Reply #2 Posted on: August 22, 2010, 10:55:57 am |
|
|
LateralGM Developer
Location: Pennsylvania/USA Joined: Apr 2008
Posts: 877
|
What I'd like to see is some kind of light-weight Markup Language version of a help file. This way, LGM can dynamically look up functions in it, and display the help for that function easily, as well as knowing the arguments for the function. Actually, LGM already has a text file with all the functions, their arguments, and the description of the function (the descriptions have yet to be filled in). It was generated from the online function list, which was in text, yaml, and xml (although I don't know where the topic's gotten to now). Edit: Found it. http://enigma-dev.org/forums/index.php?topic=520.msg6138#msg6138Seems the database has been changed and the export stuff wasn't updated, so it's broken now.
|
|
« Last Edit: August 22, 2010, 10:59:43 am by IsmAvatar »
|
Logged
|
|
|
|
Josh @ Dreamland
|
|
Reply #3 Posted on: August 22, 2010, 11:21:17 am |
|
|
Prince of all Goldfish
Location: Pittsburgh, PA, USA Joined: Feb 2008
Posts: 2950
|
I actually started a CHM file, but then I realized that maintaining it is too large a task for any one person, so I decided to invest in an online method and a way for LGM to retrieve that text, as Ism was pointing out.
With a little luck, we'll be able to pull off a Javadoc-like system, capable of looking up info on a function while you are coding.
I may maintain a generic CHM file for learning how to use LGM and ENIGMA, becoming a developer, etc... I need to think about organization, though.
But yes, when this is settled you will be able to help by submitting descriptions for functions that work in ENIGMA. We'll see what we can do with those from there.
|
|
|
Logged
|
"That is the single most cryptic piece of code I have ever seen." -Master PobbleWobble "I disapprove of what you say, but I will defend to the death your right to say it." -Evelyn Beatrice Hall, Friends of Voltaire
|
|
|
|
Josh @ Dreamland
|
|
Reply #5 Posted on: August 22, 2010, 03:48:49 pm |
|
|
Prince of all Goldfish
Location: Pittsburgh, PA, USA Joined: Feb 2008
Posts: 2950
|
CHM files are just HTML, too. If LGM could this format natively, though, without further coding (in excess of an include and a call), then the format sounds perfect. Otherwise... Most platforms come with some sort of chm viewer, or at least have one easily available.
|
|
|
Logged
|
"That is the single most cryptic piece of code I have ever seen." -Master PobbleWobble "I disapprove of what you say, but I will defend to the death your right to say it." -Evelyn Beatrice Hall, Friends of Voltaire
|
|
|
|
Josh @ Dreamland
|
|
Reply #7 Posted on: August 22, 2010, 05:03:17 pm |
|
|
Prince of all Goldfish
Location: Pittsburgh, PA, USA Joined: Feb 2008
Posts: 2950
|
Sounds good to me.
|
|
|
Logged
|
"That is the single most cryptic piece of code I have ever seen." -Master PobbleWobble "I disapprove of what you say, but I will defend to the death your right to say it." -Evelyn Beatrice Hall, Friends of Voltaire
|
|
|
|
|
IsmAvatar
|
|
Reply #10 Posted on: August 23, 2010, 11:17:18 am |
|
|
LateralGM Developer
Location: Pennsylvania/USA Joined: Apr 2008
Posts: 877
|
o I agree that some generated help would be needed, thou I still think it should be local in one way or another. This is what I'm in favor of as well, because not every user has internet access, and it can be annoying when a program needs to contact the internet for something. For now, you're welcome to document the already known GM functions.
|
|
|
Logged
|
|
|
|
TheExDeus
|
|
Reply #11 Posted on: August 23, 2010, 01:16:39 pm |
|
|
Joined: Apr 2008
Posts: 1860
|
With known you mean already implemented functions, or all GM functions? And in what format should I document? So LGM could load it at some point. And do we need short description, long description? Should simple things like functions information should be "function(argument0,argument1,argument2)" or "function(argument0 type argument0, argument1 type argument1...) etc. So draw_sprite(sprite sprite_index,int image_number,int x, int y).. Dunno if this would be needed, as arguments themselves tend to be quite self explanatory.
|
|
|
Logged
|
|
|
|
|
|
|
|