README

Path: README  (CVS)
Last Update: Wed Jul 27 22:48:36 EDT 2005

Ruby-ODE

Authors

  * Michael Granger <ged@FaerieMUD.org>

General Information

This is a Ruby binding for the Open Dynamics Engine, a free, industrial quality library for simulating articulated rigid body dynamics - for example ground vehicles, legged creatures, and moving objects in VR environments. It is fast, flexible, robust and platform independent, with advanced joints, contact with friction, and built-in collision detection.

You can find out more about ODE, including instructions for obtaining it, on the author’s page at <www.q12.org/ode/ode.html>.

Caveats

IMPORTANT: This is an alpha release. It might blow up, compromise your security, write random data to sensitive portions of your hard drive, or otherwise fail to work as advertised. It is intended to be used by developers who are interested in helping out or curious onlookers who don’t mind getting a bit wet.

That said, I would greatly appreciate feedback on any aspect of this software. Suggestions, feature requests, questions, design critiques, and bug reports are most welcome. Relevant patches are particularly helpful. I may be reached at <ged@FaerieMUD.org>.

Requirements

 * Ruby >= 1.7.3
 * ODE >= 0.035
 * Test::Unit (if you want to run tests)
 * Rdoc (if you want to make documentation)

Installation

 $ ruby extconf.rb
 $ make
 $ make test #(if Test::Unit is installed)
 $ make docs #(If Rdoc API documentation is desired)
 # make site-install

More Information

You may also access a web interface to the Ruby-ODE CVS module at: <cvs.faeriemud.org/cgi/viewcvs.cgi/Ruby-ODE/>, which includes instructions on checking out the CVS version.

Legal

Ruby-ODE is Open Source Software which is Copyright © 2001-2003 by The FaerieMUD Consortium.

This work is licensed under the Creative Commons Attribution License. To view a copy of this license, visit creativecommons.org/licenses/by/1.0 or send a letter to Creative Commons, 559 Nathan Abbott Way, Stanford, California 94305, USA.

  $Id: README 96 2005-07-28 02:48:31Z ged $

[Validate]