Archive:TMWWeb Connector

What is a TMWWeb Connector?

The TMWWeb Connector is a package of methods provided by TMWWeb to allow foreign applications to access data of the running TMWServ server. A common example is a list of online users that are currently connected to the server. TMWWeb is able to deliver the data in different formats to be as open as possible for all kinds of applications, e.g. plain text or XML.

FAQ

How can I connect to the Connector?

There is no public installation of the Account Manager respective the connector. If you set up an installation of your own, just navigate your browser to the main page of TMWWeb and add a "index.php/connector/" to the URL. The URL might look like this: http://localhost/tmwweb/index.php/connector/.

This is the root URL of the connector. Now you have to extend the URL with the name of the connector function you want to execute, e.g. onlineuser which will give you this URL: http://localhost/tmwweb/index.php/connector/onlineuser/

Some methods might need input parameters or support different output formats. All parameters have to be added with a "/" to the URL, like the method name.

Method Specification

List of online users (onlineuser)

This will give you a list of all users online with a character in TMWServ.

Parameters

1. Output format:
   • "plain" (default) will return a plain text file with one character name per line:

  name
  name2
  ...

1. • "xml" will return an XML file with more detailed information about each online character:

  <users>
     <user name="[string]" 
           gender="[number]" 
           map="[number]" 
           login_timestamp="[number]"
           login_date="[string]" />
     <user ...>
  </users>

1. • "csv" will return a comma-separated list of character information, one online character per line:

  "name",gender,map,login_timestamp,"login_date"
  "name2",gender2,map2,login_timestamp2,"login_date2"
  ...

• name: Name of the character
• gender: 0 = male, 1 = female
• map: ID of the current location (see Configuration file:maps.xml)
• login_timestamp: Unix time-stamp the character logged in
• login_date: Time-stamp of login in ISO 8601 format (e.g. 2004-02-12T15:19:21+00:00)

Usage

The output format of the onlineuser module is specified like so: connector/onlineuser/[plain|xml|csv]