Page 1 of 2

More documentation for the beginners

PostPosted: Tue Feb 25, 2014 8:21 pm
by fro
Hi !

I want to create an online version of a strategic card game.

I got the free IGE Engine from Github ( and tried the examples.
I watched the tutorials and demos on Youtube.
I consulted the online API (

Then I tried to generate documentation on my server with http://localhost/ige/documentation/generate.php but I got errors such as:
Notice: Undefined variable: docItem in / Library / WebServer / Documents / ige / documentation / parser.php on line 339 Processing JavaScript file: .. / engine / assets / IgeCuboidSmartTexture.js

if anyone can help me ... :-)

Now, I wonder if there is more documentation somewhere?

Does the Personal License have more documentation and provides access to more examples?

Thank you in advance for your answers.

Re: More documentation for the beginners

PostPosted: Fri Feb 28, 2014 10:46 am
by fro

Re: More documentation for the beginners

PostPosted: Fri Feb 28, 2014 11:43 am
by robaldred
Hello, welcome to the forums.

Is there a specific problem you're having?

There are about 50 examples covering pretty much all aspects of the engine. All examples have detailed comments, it should be easy enough if you have a good grasp of javascript to understand how things are working.

Re: More documentation for the beginners

PostPosted: Fri Feb 28, 2014 4:16 pm
by Doidel
You've pretty much found all the docs already. The examples, as robaldred said, are a good starting point. Licensing the product won't provide you with more docs, just more functionality.
Generating docs with the doc API (what you tried to do) won't provide you with any more documentation than what's online.
Further, since all code is visible, it's a good idea to e.g. have a read through the files in /ige/engine, especially stuff like IgeEntity and such.


Re: More documentation for the beginners

PostPosted: Sat Mar 01, 2014 10:47 am
by fro
Hey, thank you for the answers.

I'm efficient in Javascript ; I ask myself questions mainly on the organization of code.

I noticed that the documentation is incomplete: it lacks some of the methods and classes.
When we start it is not easy to know what are IgeCamera, IgeScene2d, IgeBaseScene, IgeSceneGraph, IgeViewport, ... and how to use them.

(I created a simple class diagram for an overview of the main architecture)

I'd like you to add another tutorial to explain the architecture and main classes.

ps : sorry for the poor english

Re: More documentation for the beginners

PostPosted: Sun Mar 02, 2014 10:08 am
by foolmoron
Yeah, when I first started learning the engine, I quickly found that the auto-generated docs weren't the most useful when trying to figure out the engine. The best documentation is definitely the examples, and the engine source code (which is very clear and organized and readable).

Re: More documentation for the beginners

PostPosted: Sun Apr 20, 2014 1:43 pm
by Tonyeng
Noticed that the Blank_Game uses Rotator, but this does not exist in the free download. Is this correct ? ie: Is the purchased version GIT site different ?

Re: More documentation for the beginners

PostPosted: Sun Apr 20, 2014 10:07 pm
by robaldred
Hello, like I said there are over 50 example documenting almost every aspect of the engine. You really need to load them up and inspect the code.

Blank game does not do anything apart from setup the basic client classes needed to initialise the engine. Not sure what example you're looking at but the blank games are exactly that blank.

I can only comment on the licenced code.

Rotator is just an example class to used in loads of the examples, you can see it in action in example.


Re: More documentation for the beginners

PostPosted: Sat May 03, 2014 1:52 pm
by Tonyeng

Using purchased IGE - from GIThub zip.

I have a blank page when I start the index.html using Chrome in the examples.

Running VPS Centos 6.4 with Apache.

Installed ige in /usr/src
copied the examples to the /usr/local/apache/htdocs,
Changed the client.js and server.js to 8080 and references for var igeRoot = '/usr/src/ige/engine' and the src="/usr/src/ige/engine/loader.js"

run node with commands
cd /usr/local/apache/htdocs/24.5-multiplayer-isometric-mouse
node server/ige.js -g .
It has lots of output and says Executing IGE under Node.js Version c0.10.4...............netio listener on port 8080........, Server is listening on port 8080........Server now accepting connections !

to run client in Chrome
but screen is blank and with ctrl-shift-j also blank - so nothing has started on the client.

FYI - when I run all on my local PC works ok - can move sprit around isometric table grid - great!
ps On local PC I changed port to 2000, as node command displayed error 8080 already in use.

Any ideas would be very greatly appreciated - thanks for help in advance!

Re: More documentation for the beginners

PostPosted: Wed May 07, 2014 10:22 am
by robaldred
Sounds like a local setup issue.
Are you using apache to serve the examples?
Is there a custom vhost or are you just using the apache main document root?

The examples need to remain in the same place as the engine, because the paths are relative.

You're running the node server on 8080, that is the game engine, it will not serve your static files, the node server provides multiplayer functionality in a game.
x.x.x.x:8080/24.5-multiplayer-isometric-mouse/index.html will not work.

You need to call that on your normal webserver.

eg. localhost/24.5-multiplayer-isometric-mouse/index.html