ℹ️ Achievement notice

The bot portion of this application is no longer running and the code base has been ported to a slash command only application which is maintained at https://github.com/discordjs/discord-utils-bot

archived README

About

Utility bot for discord, to aid support and development with discord.js. Tags are deliberately only occasionally mirrored from the discord.js server. A feature to modify tags is not planned.

Slash commands

The bot scope should be considered deprecated. This project will move forward to focus on slash command integration instead. Add the discord.js interaction to your server: (click here)

Commands

The list below uses the default prefix djs . This prefix may vary based on bot instance and server.

click to toggle list

about

Display information about the bot.

Usage: djs about

docs

Query discord.js documentation.

Usage: djs docs <query> [--source=<source>] [--force]
Source: 'stable', 'master', 'rpc', 'commando', 'collection'
Flags:

• --force -f Refresh documentation cache
• --source=<source>, -src=<source> Provide a source other than the discord.js main repository

Both Class#method as well as Class.method notations are supported. For functions, omit the call signature (). The query is case-insensitive.

help

Display a list of commands or specifics about one command. By default only displays commands you are able to use in this channel, considering user permissions and bot permissions.

Usage1: djs help [--all]
Usage2: djs help <command>
Flags:

• --all -a Display all commands, regardless of restrictions

load

Owner only. Load tags from specified .yaml format as applied by the main bot of discord.js official. This command needs to be used with a file upload.

Usage: djs load [--reset]

Flags:

• --reset -r Reset the tag database before loading
• --cache -c Update tag cache after loading successfully (runs reload command after load)

ping

Displays the websocket heartbeat and API latency.

Usage: djs ping

prefix

Display the prefix of this guild or set prefix (requires MANAGE_GUILD permission)

USAGE: djs prefix [new prefix] *

* prefix has to be 1-5 characters

reload

Owner only. Reload the tag cache from the database.

Usage: djs reload

tag

Shows or searches a tag mirrored from discord.js official (This bot does not allow adding new or modifying tags)

Usage1: djs tag search <query>
Usage2: djs tag show <tagname>
Usage: djs <tagname> (in a normal message, with prefix, without command has to be the only content)

Getting started

Remove the .example suffix from the environment variables files and fill them out. The comments tell you what information is asked for.

Docker

What is docker?

The bot and its Postgres instance are set up with docker-compose. Run

docker-compose up

in the root directory to build and run the project.

If you made changes to the source you want to apply to the container pass the --build flag. Note that the flag has to come directly after the up command.

docker-compose up --build
docker-compose up --build bot

Contributing

If you wish to contribute, feel free to fork the repository and submit a pull request. I use ESLint to enforce a consistent code style, having that set up in your editor of choice is a great boon for your development process.

git clone https://github.com/almostSouji/djs-utils.git
npm install

Remember to always lint your edits/additions before making a commit to ensure everything is lined up and consistent with the rest of the codebase. The version with the :fix suffix will try to automatically fix fixable style issues.

npm run lint
npm run lint:fix
npm run build

Try to build the project as well, so the typescript code is compiled and checked.

Author

djs-utils © almostSouji.
Authored and maintained by almostSouji.

GitHub @almostSouji