About

A simple easy to use module for interacting with AdventureQuest 3D API.

Table of contents

• Getting Started

  • Installation
  • Basic usage

• Client

  • Options
  • Events
  • Available endpoints

Features

• [x] Promise based methods
• [x] Realtime game events
• [x] Written in TypeScript
• [x] Fully OOP

Getting Started

• Node.js v9.0 or newer
• Text editor or IDE

Installation

npm install aq3d

Basic 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<Dialogue> | |character() | Promise<Character> |