Pages: [1] 2
  Print  
Author Topic: Help File?  (Read 5158 times)
Offline (Unknown gender) TheExDeus
Posted on: August 22, 2010, 10:30:48 AM

Developer
Joined: Apr 2008
Posts: 1886

View Profile
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
Offline (Male) RetroX
Reply #1 Posted on: August 22, 2010, 10:38:28 AM

Master of all things Linux
Contributor
Location: US
Joined: Apr 2008
Posts: 1055
MSN Messenger - classixretrox@gmail.com
View Profile Email
There will not be a CHM for ENIGMA.

kthx, bai

Also, I mentioned ENIGMA on the GMC once, and a staff member actually deleted my post and PMed me saying that it was rude.
Logged
My Box: Phenom II 3.4GHz X4 | ASUS ATI RadeonHD 5770, 1GB GDDR5 RAM | 1x4GB DDR3 SRAM | Arch Linux, x86_64 (Cube) / Windows 7 x64 (Blob)
Quote from: Fede-lasse
Why do all the pro-Microsoft people have troll avatars? :(
Offline (Female) IsmAvatar
Reply #2 Posted on: August 22, 2010, 10:55:57 AM

LateralGM Developer
LGM Developer
Location: Pennsylvania/USA
Joined: Apr 2008
Posts: 886

View Profile Email
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#msg6138
Seems 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
Offline (Male) Josh @ Dreamland
Reply #3 Posted on: August 22, 2010, 11:21:17 AM

Prince of all Goldfish
Developer
Location: Ohio, United States
Joined: Feb 2008
Posts: 2925

View Profile Email
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
Offline (Unknown gender) TGMG
Reply #4 Posted on: August 22, 2010, 03:46:11 PM

Developer
Joined: Jun 2008
Posts: 107

View Profile WWW Email
What about javaHelp? It looks similar to the kind of chm help system, with search etc and cross platform. The files are just html, so they can be parsed by an xml library for LGM function list.
Plus all the formatting tags of html, can have images etc :)
Logged
me
GMbed 2.0 :: Embed you gm games in websites.
Offline (Male) Josh @ Dreamland
Reply #5 Posted on: August 22, 2010, 03:48:49 PM

Prince of all Goldfish
Developer
Location: Ohio, United States
Joined: Feb 2008
Posts: 2925

View Profile Email
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
Offline (Female) IsmAvatar
Reply #6 Posted on: August 22, 2010, 03:53:37 PM

LateralGM Developer
LGM Developer
Location: Pennsylvania/USA
Joined: Apr 2008
Posts: 886

View Profile Email
CHM format is proprietary, meaning that LGM can't use it. End of story.

I like the javaHelp idea. LGM can read and display HTML very easily.
Logged
Offline (Male) Josh @ Dreamland
Reply #7 Posted on: August 22, 2010, 05:03:17 PM

Prince of all Goldfish
Developer
Location: Ohio, United States
Joined: Feb 2008
Posts: 2925

View Profile Email
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
Offline (Male) RetroX
Reply #8 Posted on: August 22, 2010, 08:19:39 PM

Master of all things Linux
Contributor
Location: US
Joined: Apr 2008
Posts: 1055
MSN Messenger - classixretrox@gmail.com
View Profile Email
CHM is MSHTML.  Don't use it. :V
Logged
My Box: Phenom II 3.4GHz X4 | ASUS ATI RadeonHD 5770, 1GB GDDR5 RAM | 1x4GB DDR3 SRAM | Arch Linux, x86_64 (Cube) / Windows 7 x64 (Blob)
Quote from: Fede-lasse
Why do all the pro-Microsoft people have troll avatars? :(
Offline (Unknown gender) TheExDeus
Reply #9 Posted on: August 23, 2010, 10:44:56 AM

Developer
Joined: Apr 2008
Posts: 1886

View Profile
javaHelp sounds good. I guess Enigma wouldn't be something like GM, that is updated once in 4 or so years, so chm isn't a good solution. So I agree that some generated help would be needed, thou I still think it should be local in one way or another.
Anyway, when the infrastructure is there, I would gladly help with documenting some functions.
« Last Edit: August 23, 2010, 10:52:43 AM by HaRRiKiRi » Logged
Offline (Female) IsmAvatar
Reply #10 Posted on: August 23, 2010, 11:17:18 AM

LateralGM Developer
LGM Developer
Location: Pennsylvania/USA
Joined: Apr 2008
Posts: 886

View Profile Email
Quote
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
Offline (Unknown gender) TheExDeus
Reply #11 Posted on: August 23, 2010, 01:16:39 PM

Developer
Joined: Apr 2008
Posts: 1886

View Profile
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
Offline (Male) RetroX
Reply #12 Posted on: August 23, 2010, 01:53:05 PM

Master of all things Linux
Contributor
Location: US
Joined: Apr 2008
Posts: 1055
MSN Messenger - classixretrox@gmail.com
View Profile Email
I'd put it in C-style with the argument type.
Logged
My Box: Phenom II 3.4GHz X4 | ASUS ATI RadeonHD 5770, 1GB GDDR5 RAM | 1x4GB DDR3 SRAM | Arch Linux, x86_64 (Cube) / Windows 7 x64 (Blob)
Quote from: Fede-lasse
Why do all the pro-Microsoft people have troll avatars? :(
Offline (Female) IsmAvatar
Reply #13 Posted on: August 23, 2010, 01:59:29 PM

LateralGM Developer
LGM Developer
Location: Pennsylvania/USA
Joined: Apr 2008
Posts: 886

View Profile Email
Feel free to do all the GM functions, since that's the goal of Enigma. Or if you'd like, just do only the implemented GM functions. Eventually there will be a number of additional enigma functions which we'd like to have documented as well, but I wouldn't just go with the current function list, since any number of those could disappear at any moment.

I'm in favor of including the argument type as well.
Logged
Offline (Male) RetroX
Reply #14 Posted on: August 23, 2010, 02:09:56 PM

Master of all things Linux
Contributor
Location: US
Joined: Apr 2008
Posts: 1055
MSN Messenger - classixretrox@gmail.com
View Profile Email
Also, I'd recommend using "sprite_id" instead of "sprite" because really, you could probably enter any number and it would be considered acceptable by the compiler.
Logged
My Box: Phenom II 3.4GHz X4 | ASUS ATI RadeonHD 5770, 1GB GDDR5 RAM | 1x4GB DDR3 SRAM | Arch Linux, x86_64 (Cube) / Windows 7 x64 (Blob)
Quote from: Fede-lasse
Why do all the pro-Microsoft people have troll avatars? :(
Pages: [1] 2
  Print