QM Client API

From ScarletDME
Jump to navigation Jump to search


QM provides a remote API access to any client system that can get to the server via socket 4243, and obeys the protocol.

Server Setup

QM is technically able to handle API connections about of the box. However your server will need some configuring. (RPM will do this for you in near future).

QM API Server setup guide


The following is a guide to the protocol that the server responds to.

Currently a working document, far from perfect, but you get the idea:



  • Diccon 15 Jan 2009 Update - The packet header docs have been updated, and the whole login process is pretty clean. The docs are missing a large number of the simpler commands, but they are pretty easy to figure out from the VBSRVR basic code in GPL.BP. I will write them out progressivly.
  • Diccon 12 Jan 2009 Resolved - Turns out it was the new server environment. However the Documentation is slightly wrong for the login protocol. Login is actually a server command not a special case. Will try and update the docs and debug the further issues on the test server environment.
  • Diccon 8 Dec 2008 Confirmed - Functioning Java-QM client for 2.4.17 does not work on 2.6.6. Exact reason why has yet to be determined. Should have some answers soon, new year 2009 has a need for the Java API on 266.
  • Diccon 7 December 2008 Warning: I have suspicions that the protocol changed for login quite dramatically for 2-6-6, as opposed to 2-4-17 which this Spec doc was originally based on.

API library's

  • C - native - Released
  • Visual Basic - native - released (library only released with commercial?)
  • Java API - native - Beta, stable working. LGPL release
  • Delphi - Wrapper - (native expected Q1 2009)
  • PHP - wrapper - Beta (TomDel)
  • PHP Native API - Alpha stages but alive and kicking
  • C++ Wrapper