FFXIV Hunt Bot
Discord bot for announcing hunts as they are reported on XIV-Hunt. Powered by discordrb.
Dependencies
- ruby (version 2.5.1)
- ruby-dev
- gcc
- libffi-dev
- make
- g++
Installation
This is a private bot. You will need to create and run your own Discord app to add it to your server.
- Create a new Discord app
- Click "Create a Bot User"
- Insert your client ID into the following URL:
https://discordapp.com/oauth2/authorize?client_id=INSERT_CLIENT_ID_HERE&scope=bot&permissions=19456
- Follow the URL to add the bot to your server (requires the Manage Server permission)
git clone https://github.com/mattantonelli/ffxiv-hunt-bot
cd ffxiv-hunt-bot
bundle install
- Set up the configuration file
cp config/config.yml.example config/config.yml
- Updated the example values appropriately
bundle exec ruby run.rb
Please consider pinning the following message in your hunt channels:
These callouts are provided thanks to https://xivhunt.net/. If you are on PC, please consider contributing to this data by running their client: https://xivhunt.net/Client. However, please keep in mind that this third party software violates FFXIV's EULA. Please be courteous when pulling. <3
Permissions
- Read Text Channels & See Voice Channels
- Send Messages
- Embed Links
Deployment
This bot is set up for Capistrano deployment. The deployment strategy is dependent on rbenv
and screen
. You can configure deployment to your own server by updating config/deploy.rb
and config/deploy/production.rb
appropriately.