@satyrnidae/apdb-api v4.1.0

Another Pluggable Discord Bot API

The API layer for the 'Another Pluggable Discord Bot' project.

Developing APDB plugins

The APDB API should be installed for all plugins developed for Another Pluggable Discord Bot.

Further information for developing plugins will be detailed in the project wiki (coming soon).

Installing as a dependency

APDB-API requires the following peer dependencies when installed:

• @types/node (^12.12.21)
• discord.js (^11.5.1)
• inversify (^5.0.1)
• inversify-inject-decorators (^3.1.0)
• typeorm (^0.2.21)
• xmlhttprequest (^1.8.0)
• yargs-parser (^13.1.1)

These dependencies are provided by the Another Pluggable Discord Bot core application, so you need only install them as dev dependencies in your plugin.

Developing the API

Setting Up

To set up the development environment:

• Clone the repository via git
• Run npm i in your preferred command interpreter to install all dependencies
• Open the folder in Visual Studio Code (if desired)

You should now be all set! Build with tsc to transpile to JavaScript. Tests can be run via npm test.