Requirements

Locker also has a hosted variant which is currently available on request while in BETA. Requesting Locker to be in your server can be done in the Single-Purpose Bots Discord (in Locker's#request channel).

Requirements

Mandatory Packages

Node.js 16.9.0 or newer is required. Ignore any warnings about unmet peer dependencies, as they're all optional.

  • discord-api-types, up to date Discord API Typings, versioned by the API version (npm install discord-api-types)

  • discord.js to interact with Discord API (npm install discord.js)

  • discord.js/builders, a collection of builders that you can use when creating your bot (npm install @discordjs/builders)

  • discordjs/rest, the REST API module for Discord.js (npm install @discordjs/rest)

  • mysql to interact with database (npm install mysql)

Optional packages

  • bufferutil for a much faster WebSocket connection (npm install bufferutil)

  • erlpack for significantly faster WebSocket data (de)serialisation (npm install discord/erlpack)

  • utf-8-validate in combination with bufferutil for much faster WebSocket processing (npm install utf-8-validate)

  • zlib-sync for WebSocket data compression and inflation (npm install zlib-sync)

Last updated

Was this helpful?