Documentation is incredibly vague. about matter-js HOT 5 CLOSED

I did not need the documentation, having the script itself.
https://github.com/liabru/matter-js/tree/master/src
The code it's commented and so clear. Check it out

from matter-js.

I've been reading it-
The problem is that the documentation is generated from the code comments- so by looking at the documentation I'm just looking at a styled version of what's written in the code.
Don't get me wrong, the documentation of the methods of the main classes are pretty descriptive, but the classes themselves have no description and no examples of what they do on their own.

That's my main issue.

If I could get something on the screen, I could poke around but there's nothing I've found that will show me how to get started from scratch- from a point of a literal blank script.
The demos are helpful in showing what Matter.js does but I'm not finding them helpful in how to create a new document...

@NiciusB you know how to start from scratch, you could add a few lines to the readme that provide a point of reference.

from matter-js.

Apologies for the lack of documentation, but please note that the project is still in an alpha state and the API has not solidified. I plan to spend some time on it before I get to the first non-alpha release.

This is why the documentation points you to Demo.js as this is currently the best resource on how to use the engine and many have already used this to figure out how to get started working with it.

Another good resource is this collection on CodePen, in particular this one is a good minimal example.

Generally though the code and architecture follow that of a standard physics engine, so if you've used something like Box2d before then the naming should be fairly familiar - a Body for example refers to a rigid body.

As @NiciusB points out, I've made a lot of effort to make the code clear and well commented, so it's worth scanning over if you're interested in learning from it.

Feel free to add any more questions here though, cheers

from matter-js.

I actually discovered matter.js via CodePen :-)
I've never worked with a physics engine before. I've actually never even written a full fledged game before either...but I want to! This is day 1.

from matter-js.

No worries! The CodePen examples are probably the best place for you to start then.

I've opened an issue re. improving documentation, so I'll close this one now.

Best of luck on starting with starting game dev though :)

from matter-js.