immjs / tph-docs-bot

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

tphdocsbot

A Discord bot to display documentation

Currently supported docs

  • discord.js (includes main/stable branch, includes djs-voice, djs-builders and djs-collection documentations)
  • Javascript (mdn)

Docker

To build and run the Docker container locally:

docker build . -t tphdocsbot:latest
docker run -e TOKEN=<your discord token> -e APPLICATIONID=<ApplicationID> -e GUILDID=<GuildID> tphdocsbot:latest

Cofiguration

  • TOKEN [required] the Discord bot token to run under
  • APPLICATIONID [required] the Discord bot's application ID. Get it from Dev portal -> your bot -> General Information -> Application ID
  • GUILDID (required to register on a specific guild) the guild id to register commands on, recommended to register on a specific guild for testing

Registering

In order to register the commands globally, run

npm run register-global-commands

For registering guild-specific commands (Recommended for testing)

npm run register-guild-commands

Afterwards to reset guild commands, (To avoid duplication of global and guild-specific commands)

npm run reset-guild-commands

About

License:MIT License


Languages

Language:TypeScript 100.0%