search

lo-th / Oimo.js

Lightweight 3d physics engine for javascript
http://lo-th.github.io/Oimo.js
MIT License
3.07k stars 303 forks source link

where to get documentation ? #1

Open jeromeetienne opened 10 years ago

jeromeetienne commented 10 years ago

the demos are very impressive. i would like to use this library. where can i find documentation on it ?

lo-th commented 10 years ago

hello thank's, i update soon the editor with basic usage and all function anyway your can look Basic test demo to initialise the engine.

On Fri, Jan 31, 2014 at 9:01 PM, Jerome Etienne notifications@github.comwrote:

the demos are very impressive. i would like to use this library. where can i find documentation on it ?

Reply to this email directly or view it on GitHubhttps://github.com/lo-th/Oimo.js/issues/1 .

LoTh - Freelance javascript / as3 / 3D website http://perso.numericable.fr/chamaslot/ | bloghttp://3dflashlo.wordpress.com

humbletim commented 10 years ago

How about porting the inline code comments from OimoPhysics.as (into JSdocs for Oimo.js)?

The main classes still seem to line up between projects so in theory this could even done by an automation script.

Also saharan's comments are of great quality -- and Google Translate seems to have no problem machine-translating any of his Japanese comments into English while keeping meaning (my Chrome browser started doing this automatically when looking at OimoPhysics.as, which is what gave me the idea to suggest bringing those comments over directly).

I'd be willing to join forces and attempt that if others also thought it was a good idea.

Canta commented 10 years ago

+1

jeromeetienne commented 10 years ago

seems a good idea to me too :)

humbletim commented 10 years ago

OK, had a few moments to test out automated porting of the comments; several quirks to it, but the overall classes and properties do seem to map-over pretty well still.

OimoPhysics.as comments as JSON

OimoPhysics comment JSON "mocked" into Oimo.js-like pseudoscript

I've pushed the current toy scripts into an Oimo.js fork in case anyone wants to take the experiment further in the meantime.

jeromeetienne commented 10 years ago

excelent start @humbletim

lo-th commented 10 years ago

i add full comment on src oimo dev

lo-th commented 10 years ago

start new docs with interactive setting i think is the best to see all options 0 the world 1 rigidbody (in progress) 2 _ joint (in progress)