Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve Documentation #22

Closed
liabru opened this issue May 11, 2014 · 10 comments
Closed

Improve Documentation #22

liabru opened this issue May 11, 2014 · 10 comments

Comments

@liabru
Copy link
Owner

liabru commented May 11, 2014

The project is still in an alpha state and the API has not yet solidified, so documentation is currently patchy as usage can change release to release. Some time is required to improve it before the first non-alpha release.

In the mean time, please use the following resources if you'd like to start using the engine despite the alpha status:

@liabru
Copy link
Owner Author

liabru commented May 20, 2014

Just pushed an update to documentation of core modules 2317f02

Also pushed the new documentation design that is much clearer and more detailed.

@spaceribs
Copy link

Homepage links incorrectly to Body: http://brm.io/matter-js-docs/classes/Bodys.html

screen shot 2014-05-22 at 1 36 47 pm

@liabru
Copy link
Owner Author

liabru commented May 22, 2014

Fixed, thanks @spaceribs

@liabru
Copy link
Owner Author

liabru commented Nov 28, 2014

Todo: the body param is missing from Body.setStatic docs

@liabru
Copy link
Owner Author

liabru commented Jan 6, 2015

I've just updated the docs for the master build:
http://brm.io/matter-js-docs-master/

@joetsuihk
Copy link

I would kindly request demo/doc for manipulating body after added to world. Imagine case like using keyboard to move a body/car.

@liabru
Copy link
Owner Author

liabru commented Jan 27, 2015

@joetsuihk

If you clone the repo and use the edge build, there's two new manipulation demos that may be helpful:
https://github.com/liabru/matter-js/blob/master/demo/js/Demo.js#L218-L317

@joetsuihk
Copy link

Thanks a lot @liabru ! What I ultimately want to do is click on a body and manipulate that body, can you share some code to look for the body being clicked? I tried Query.ray but the collisions returned cannot apply Body.translate

@liabru
Copy link
Owner Author

liabru commented Jan 28, 2015

@joetsuihk take a look at how it's done in MouseConstraint

@liabru
Copy link
Owner Author

liabru commented Jan 19, 2016

An updated version of the docs is now at http://brm.io/matter-js/docs/

@liabru liabru closed this as completed Jan 19, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants