Skip to content

Latest commit

 

History

History
46 lines (29 loc) · 1.72 KB

README.md

File metadata and controls

46 lines (29 loc) · 1.72 KB

verse-javascript

Build Status Code Climate Test Coverage

Websocket support for Verse protocol. Keep in mind that this project is still Work in progress!

Verse

Verse 2.0 is network protocol for real-time sharing of 3D data. It is successor of old Verse protocol developed at KTH. Verse 2.0 is still in alpha version.

Usage

bower install verse

Verse Websocket module is provided in two versions. You can use it as AMD for RequireJs or as a standalone library.

Minified versions of both modules can be found in the ./build directory.

See examples in the ./example directory. Choose standalone or amd version and then rename version.config.js to config.js. Add you config values and open version.html file in your browser. Check console, do something nice...

Requirements

If you want to use the unlinked sources, and run the Grunt task you will need also:

Build

git clone [email protected]:verse/verse-javascript.git 
cd verse-javascript
npm install
bower install

License

The source code of Verse Javascript library is licensed under MIT license. This library could be used for implementation of Web based Verse client. For details look at file LICENSE.