linkwe / osgjs

Javascript Implementation of OpenSceneGraph

Status

OSG.JS WebGL framework

(http://osgjs.org/)

OSGJS is a WebGL framework based on OpenSceneGraph concepts. It allows an individual to use an “OpenSceneGraph-like” toolbox to interact with WebGL via JavaScript, and provides facilities for exporting various assets to the osgjs format. The API is kept as similar to OpenSceneGraph as possible, providing a familiar environment to veterans of the library and introducing newcomers to a popular and heavily-scrutinzed set of interfaces

The mailing list is available here: http://groups.google.com/group/osgjs

If you are interested in contributing, contact us on the osgjs gitter channel ( https://gitter.im/cedricpinson/osgjs ) or on the IRC channel #osgjs on Freenode. Also by e-mail at [email protected]. Follow @trigrou on twitter to get news and updates.

How to build your own osgjs

First, clone a copy of the main git repo by running:

git clone git://github.com/cedricpinson/osgjs.git
cd osgjs

Install required node dependencies:

npm install # before you may need to execute npm install -g grunt-cli ( using sudo if you are running linux )

Compile:

grunt build
Alternatively you can use webpack -d

Compile whenever watched files change:

grunt watch
Alternatively use webpack -w  // faster than grunt watch because it uses webpack's incremental builds

The built version of osgjs will be put in the build/ subdirectory.

Running the examples

Simply type in the command-line:

grunt serve

It should open a browser pointing to the root source directory, then navigate to examples or tutorials folder.

Executing unitary tests

Launch:

grunt test

OpenSceneGraph osgjs plugin

There is a plugin on my openscengraph branch https://github.com/cedricpinson/osg. This plugin will help you to export data from osg to osgjs. More instructions are available on the wiki