node-lou

This node library provides methods to connect to the Lord of Ultima game API.

Installation

This package can be installed via the node npm package manager or by downloading the source.

npm install node-lou

Usage

You must first connect to LoU using the createClient() method. Once the connection is made you can then request info from LoU easily.

var lou = require('lou')

lou.createClient({
  acct: {
    email: '[email protected]'
  , pass: 'myloupassword'
  }
, world: {
    id: 55
  , url: 'prodgame10.lordofultima.com/128'
  }
}, function(err){
  if(err) console.log(err)
  else {
    lou.get.player([1,17], function(err, res){
      if(err) console.log(err)
      else {
        console.log(res)
      }
    })
  }
})

API

createClient

Used to provide configuration data, authenticate with LoU, and connect to the world. Returns null if successful or an error as the first argument in the callback function

lou.createClient(config, callback)

getSessKey

Retrieves the current LoU session key.

  var sessKey = lou.getSessKey()

get.alliance

Will retrieve an alliance object from LoU. Requires the alliance ID as the first argument given to the method. An array of ID's can be passed in to retrieve multiple alliances. Returns an error or null as the first argument of the callback and a alliance object as the second argument if it was successful.

lou.get.alliance(allianceId, callback)

get.player

Will retrieve a player object from LoU. Requires the player ID as the first argument given to the method. An array of ID's can be passed in to retrieve multiple players. Returns an error or null as the first argument of the callback and a player object as the second argument if it was successful.

lou.get.player(playerId, callback)

get.city

Will retrieve a city object from LoU. Requires the city ID as the first argument given to the method. An array of ID's can be passed in to retrieve multiple cities. Returns an error or null as the first argument of the callback and a player object as the second argument if it was successful.

lou.get.city(cityId, callback)

Contributing

Fork the node-lou repository on GitHub and send a Pull Request.

Notes

• Requires the 'htmlparser' and 'async' node modules.

TODO

• Add the rest of the API functions
• Create high-level functions for calculating resources and distance
• Add ability to provide multiple logins for pulling info from LoU in parallel

License

Copyright (c) 2012 Roger Mayfield ([email protected])

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.