Unofficial Halopedia Discord Bot 📚

A Discord bot that lets members search for an article over halopedia.org; it'll fetch it nicely and offer pagination. Optionnally, the bot can automatically post @Halopedia's latest tweets.

Prerequisites

• node >=12.16.1
• yarn >=1.19.1

Install

With Docker

A Dockerfile is available at the root of the project so you can easily set the bot up without having to care about any global dependency or anything. If you want to do it this way, make sure you have Docker installed on your machine.

git clone https://github.com/Halocrea/halopedia-discordbot.git
cd haloduels

cp .env.dist .env
vi .env
#provide the information required in the .env file

docker build -t halopedia-discordbot .
docker run -d -v /absolute/path/to/halopedia-discordbot/data:/app/data --restart=always --name=halopedia-discordbot halopedia-discordbot

Without Docker

Make sure you have the proper Node.js and Yarn versions installed on your machine.

git clone https://github.com/Halocrea/halopedia-discordbot.git
cd haloduels

cp .env.dist .env
vi .env
#provide the information required in the .env file

yarn

node index.js

Setup

• If you never set up a Discord bot before, please follow the instructions over here.
• If you don't want to host your own version of the bot but consume an existing instance of it, you can use the following invite link: https://discordapp.com/oauth2/authorize?client_id=706831496861974618&scope=bot&permissions=125952
• Once that is done, invite the bot to your server, and type !halopedia to start the installation wizard.

Commands list

Use the command !halopedia help to get the full list of available commands. Here are the default ones:

General commands

• !halopedia help : send help
• !halopedia search your search terms: I will look for a page on Halopedia.org that matches best your search terms.
• !halopedia latest tweet : I'll post the latest tweet from the official @Halopedia Twitter account.
• !halopedia invite: get an link to invite this bot to your own servers.

Admin commands

• !halopedia prefix new-prefix: change the prefix used to call the bot.
• !halopedia auto-tweet #channel: the bot will automatically post Halopedia's latest tweets in the given channel.
• !halopedia auto-tweet disable: Use this command to stop me from automatically posting Halopedia's tweets.
• !halopedia uninstall: the bot will delete everything it stored about this Discord server and will leave it.

Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page.

Show your support

Give a ⭐️ if this project helped you!