Skip to content

A Ruby binding for Verse, a network protocol that lets multiple applications act together as one large application by sharing data over a network. It's still a work in progress.

License

ged/ruby-verse

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

18 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Ruby-Verse

Description

This is a Ruby binding for Verse. Verse is a network protocol that lets multiple applications act together as one large application by sharing data over a network.

It is still a work in progress.

Basic Design

The API was inspired by Ample, a C++ wrapper for Verse by Camilla Berglund elmindreda@elmindreda.org.

Ruby-Verse consists of several core module functions for interacting with a Verse server, a collection of Node classes, and mixin modules for adding Verse-awareness to your classes.

Namespace

All classes and modules in Ruby-Verse are declared inside the Verse module.

Classes

  • Server
  • Session (Observable)
  • Node (Observable)
    • ObjectNode
      • ObjectLink
      • ObjectTransform
      • ObjectMethod
      • ObjectMethodGroup
      • ObjectAnimation
    • GeometryNode
      • GeometryBone
      • GeometryLayer
      • GeometryCrease
    • MaterialNode
      • MaterialFragment
    • TextNode
      • TextBuffer
    • BitmapNode
      • BitmapLayer
    • CurveNode
      • CurveKey
    • AudioNode
      • AudioBuffer
      • AudioStream

Observer Mixins

  • PingObserver

  • SessionObserver

  • NodeObserver

    • NodeTagObserver
    • NodeTagGroupObserver
  • ObjectNodeObserver

    • ObjectLinkObserver
    • ObjectTransformObserver
    • ObjectMethodObserver
    • ObjectMethodGroupObserver
  • GeometryNodeObserver

    • GeometryBoneObserver
    • GeometryLayerObserver
    • GeometryCreaseObserver
  • MaterialNodeObserver

    • FragmentObserver
  • TextNodeObserver

    • TextBufferObserver
  • BitmapNodeObserver

    • BitmapLayerObserver
  • CurveNodeObserver

  • AudioNodeObserver

    • AudioBufferObserver
    • AudioStreamObserver

Installation

gem install verse

Contributing

You can check out the current development source with Mercurial via its Bitbucket project. Or if you prefer Git, via its Github mirror.

After checking out the source, run:

$ rake newb

This task will install any missing dependencies, run the tests/specs, and generate the API documentation.

License

Portions of this source code were derived from the Verse source, and are used under the following licensing terms:

Copyright (c) 2005-2008, The Uni-Verse Consortium. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

The Ruby binding is:

Copyright (c) 2011, Michael Granger All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

  • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

  • Neither the name of the author/s, nor the names of the project's contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

About

A Ruby binding for Verse, a network protocol that lets multiple applications act together as one large application by sharing data over a network. It's still a work in progress.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published