2.1.1 • Published 5 years ago
aq3d v2.1.1
About
A simple easy to use module for interacting with AdventureQuest 3D API.
Table of contents
Features
- Promise based methods
- Realtime game events
- Written in TypeScript
- Fully OOP
Getting Started
- Node.js v9.0 or newer
- Text editor or IDE
Installation
npm install aq3dBasic Usage
const { Client } = require('aq3d');
// Create an new instance of the client
const client = new Client();
// Fetch the character information
client.character('0x53')
.then(console.log);Client
Options
useGameService Optinal game service connection for adminyells.
timeout Request Timeout for awaiting a response until it fails. Defaults to
3000 milliseconds.
proxy Requests through a proxy.
Available Endpoints
| Route | Returns |
|---|---|
| serverlist() | Promise\<Server[]> |
| ptrServerList() | Promise\<PTRServer[]> |
| item() | Promise\<Item[]> |
| apop() | Promise\<APop[]> |
| fantasyNames() | Promise\<string[]> |
| news() | Promise\<INews[]> |
| customscreen() | Promise\<CustomScreen[]> |
| dialogue() | Promise\ |
| character() | Promise\ |