Halo Duels ✊

A Discord Bot to let your servers' members fight some "Halo-themed" duels, full of gifs and funny stuff!

🏠 Homepage

🔫 Demo

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/tepec/haloduels.git
cd haloduels

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

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

Without Docker

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

git clone https://github.com/tepec/haloduels.git
cd haloduels

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

yarn

node index.js

OPTIONAL FEATURE: TWITCH CHANNEL IN BOT STATUS

The bot can automatically change its status from the default one ("playing halocrea.com") to "streaming %Game%" based on the activity of your Twitch channel.

In order to do that, you must provide in the .env file:

• TWITCH_CLIENT_ID: your own Twitch Developer Client ID. To get yours, check this page.
• TWITCH_CHANNEL_ID: the ID of the channel you want to "watch". It's not the name of your channel. To retrieve your channel's ID, you can use the Twitch API's Endpoint https://api.twitch.tv/kraken/users?login=%YOUR CHANNEL NAME% (you will need to provide your client ID in the header of the request, check this page for more info).

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=697434313351757865&scope=bot&permissions=8
• Once that is done, invite the bot to your server, and type !duel to start the installation wizard.

Supported languages

• 🇺🇸 English
• 🇫🇷 French

If you'd like to get the bot in another language, feel free to contact us and contribute!

Contributing

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

Show your support

Give a ⭐️ if this project helped you!