node-omv Readme

Overview
========

node-omv is a node.js module which allows interaction with 3d online worlds like SecondLife.
At the moment it just supports simple login, logout and Chat tasks nativly.
The example client can handle local chat.
It's currently just a proof of concept.

Needed Node Modules:
--------------------
npm install xmlrpc
npm install getmac

How to Use:
-----------

As the module is working on a very low level, it only has 3 Events right now:

- GotPacket: which returns the packet itself and the parsed data.
- LoginFailed, LoginSuccess: which both return the raw xmlrpc response

Take a look at the example client which already handles some packets.

It already can parse nearly every packet of secondlife where the block is marked as "SINGLE".
It uses the original messages-template from LindenLab to get the Type and name of a Packet and it's data.

That means if an ImprovedInstantMessage (http://wiki.secondlife.com/wiki/ImprovedInstantMessage) is received the event "GotPacket" raises and data contains an object with the whole packet.
To access for example the "FromAgentName" field you can just get it from:
data.MessageBlock.FromAgentName.Value