Skip to content

Halocrea/forgehub-discordbot

Repository files navigation

Unofficial ForgeHub Discord Bot ⚒️

Version License: GNU GPLv3

A Discord bot that automatically fetches latest map submissions on forgehub.com, latest FH's tweets, and alerts whenever FH goes live on Twitch!

Prerequisites

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/forgehub-discordbot.git
cd forgehub-discordbot

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

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

Without Docker

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

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

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

npm

node index.js

Setup

Supported languages

  • 🇺🇸 English
  • 🇫🇷 French
  • 🇪🇸 Spanish

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

Commands list

Here's the list of slash commands available once the bot is on a server; please note that these commands are localized, for example /help to show this list of commands is /aide in French and /ayuda in Spanish.

General commands

  • /help: show this help message.
  • /latest topic: I will show you the latest map or tweet depending on which of those two_topics_ you choose.
  • /invite: get a link to invite this bot to your own servers.

Admin commands

  • /setup topic channel: You can set the channel into which I will automatically post the latest map/tweet/stream alert.
  • /set-language language: to define which language the bot should use whenever it automatically posts a message.

To ask questions to the developers of this bot, feel free to contact us at {discordInvite}!

Contribution

Thank you RBLS#7532 for the spanish translation!

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

Show your support

Give a ⭐️ if this project helped you!

About

A Discord bot that automatically fetches latest map submissions on forgehub.com, latest FH's tweets, and alerts whenever FH goes live on Twitch!

Resources

Stars

Watchers

Forks

Packages

No packages published