Skip to content

sgoudham-university/Winston-Bot

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Winston | Personal Project for HTLANL

A Powerful Discord Music Bot made using Discord JDA & Lavaplayer themed around Winston (From Overwatch, the hit 2016 IGN Game of The Year)

Description

This bot was previously made for my How To Learn a New Language Course in the first year of my Software Engineering Graduate Apprenticeship. The previous README.md can be found here

Commands

TODO

Installation

You can deploy an instance of winston on your own server with the steps below!

  1. First, you're going to want to git clone the repo as shown below
git clone https://github.com/sgoudham-university/Winston-Bot

I've laid out 2 methods below for further installation, it's up to you which one you choose. I'd recommend method 1 for more experienced users in the terminal and method 2 for beginner users.

Method 1

  1. After successfully cloning the repo, run
mvn package

This will read the pom.xml file and build all the dependencies that the bot will need to run on your local machine. This is assuming that you have maven installed and ready to go on your computer, if not, you can grab it here

  1. Now you can run the bot through the terminal by using the command shown below (after configuring your environment properly)
java -jar target/winston.jar

Method 2

If you have Intellij installed, you can directly read in the pom.xml file, and it can resolve all your dependencies for you.

  1. After successfully cloning the repo, start-up Intellij and then select the pom.xml and then Open as Project

Configuration

  • Open the application.yml file within the root directory
  • To ensure the application can run, the variables inside ${} must be set as environment variables

In order to get your bot token above, you will need to head over to the Discord Developers website and register a bot application. There are many other tutorials out there that cover this, personally, I recommend reading this to get your bot setup. To enable the usage of Slash Commands, the application.commands scope must also be ticked. Furthermore, please visit this discord support article for help in obtaining your Owner ID.