README.md

Discotify

Discotify is a Discord/Spotify bot solution to enhance user experiences when listening to Spotify music in Discord parties. Our Discord bot solution allows multiple people to control Spotify listening parties instead of a single person. Your listening experience can now become fun and collaborative! Users who would benefit most from this program would be users who have Spotify premium and actively use Discord with friends or other people. Once users are in Discord and in each others Spotify listening parties, users can send commands to the bot. These commands include but are not limited to actions such as start track, pause track, skip track, and add to queue

General Commands

1. !hello : Greets the user.
2. !auth : Initiates authentication with Spotify.
3. !helps : Displays a list of avaiable commands.

Spotify Playback Control

1. !play <query> : plays a track on Spotify. The <query> can be a Spotify link, song name, or song name with the artist.
2. !pause : Pauses the current playback on Spotify.
3. !resume : Resumes playback on Spotify.
4. !next : Skips to the next track on Spotify.
5. !previous : Goes to the previous track on Spotify
6. !devices : Lists avaiable Spotify devices.

Spotify User Data

1. !toptracks : Shows the user's top 10 tracks on Spotify.
2. !playlist <name> : Plays a playlist from the user's library on Spotify by playlist name.
3. !profile : Show user Spotify profile

Create a Discord Bot Account

1. Go to the Discord Developer Portal: Open your web browser and navigate to the Discord Developer Portal.

2. Create a New Application: Click on the New Application button. Give your application a name and confirm the creation.

   

3. Create a Bot User: Within your application, find the Bot tab and click on Add Bot. Confirm the creation of the bot.
   

   

4. Enable Intents: In the bot tab, you will see options for Privileged Gateway Intents

   

Get Your Bot Token

1. Access the Bot Tab: In your application, navigate to the Bot tab.

2. Copy the Token: Under the Build-A-Bot section, you’ll see a token. Click on Reset Token to reset your bot's token and copy bot's token. Keep this token secure, as it allows anyone to control your bot.

   

Invite the Bot to Your Server

1. Generate the Invite Link: Go to the OAuth2 tab in your application. Under Scopes, select bot. Then, under Bot Permissions, choose the permissions you want your bot to have.

2. Copy and Use the Invite Link: Copy the generated link and paste it into your web browser. Select the server to which you want to add the bot and authorize it.

   

How to set up listening party on Discord

1. Open Spotify and play something
   
2. Click on the "+" button next to your chatbox at the bottom left and click on "Invite [users] to Listen to Spotify"
   If the option 'Invite [users] to listen to Spotify' does not appear, make sure your Discord status is set to online.
3. You should be able to see when you're in a listening party through Discord
   
   
4. People can now click the Join button to be in your listening party!

Note:

• Only the listening party host needs to run the executable file
• The listening party host must then authenticate (!auth) with the bot (only the listening party host needs to do this)
• After this is done, everyone in the listening party can use the commands for the bot
• If you pause (!pause) then the listening party will end, this is on Spotify/Discords end on how they made the functionality

[EXPERIMENTAL] How To set up Spotify Jam Session

1. Open Spotify and play something

2. Tap the connect device icon at the bottom of the screen and then start a Jam session

3. You will now have a Jam session

4. Invite your friends!

**Note:** - Only the jam session host needs to run the executable file - The jam session host must then authenticate (!auth) with the bot (only the jam session host needs to do this) - After this is done, everyone in the jam session can use the commands for the bot - Host cannot change the sound output of their Spotify to any other device output as it will end the Spotify Jam Session, limited to Spotify Jam functionality (still in Beta as of typing this) - Anyone other than the Host can change their output and the Jam session should still be okay

How to run

MacOS:

1. Ensure you have python3 installed on your system.

   • To check that python is installed properly run this command in your terminal:

     python --version
     

   • If the previous commands does not work try:

     python3 --version
     

   • If the command is successful you will see your current python version installed
   • You need Python 3.11 and greater to run this program

2. Open a terminal or command prompt.

3. Use the following command to install the required modules using pip, the package installer for Python:

    pip install discord requests
   

4. Wait for the installation to complete. Once finished, the required modules will be installed in the Python environment.

5. Download executable from release in Repo bot

6. Set up environment variables

   • In the same directory the executable is located, create a .env file

       nano .env
   

   • Set your Client ID and Client Secret in the following format (How to find Client ID and Client Secret):

      SPOTIFY_CLIENT_ID= your_client_id
      SPOTIFY_CLIENT_SECRET= your_client_secret
      DISCORD_TOKEN= your_discord_token
   

   • Save that file.

7. Run executable.

   • In the directory you downloaded the executeable, Run:

   ./bot 
   

Windows OS:

1. Ensure you have python3 installed on your system.

   • To check that python is installed properly run this command in your terminal:

     python --version
     

   • If the previous commands does not work try:

     python3 --version
     

   • If the command is successful you will see your current python version installed

2. Open a terminal or command prompt.

3. Use the following command to install the required modules using pip or pip3, the package installer for Python:

    pip install discord requests
   

4. Wait for the installation to complete. Once finished, the required modules will be installed in the Python environment.

5. Download executable from release in Repo bot.exe

6. Set up environment variables

   • In the same directory the executable is located, create a .env file in Notepad

   • Set your Client ID and Client Secret in the following format (How to find Client ID and Client Secret):

      SPOTIFY_CLIENT_ID= your_client_id
      SPOTIFY_CLIENT_SECRET= your_client_secret
      DISCORD_TOKEN= your_discord_token
   

   • Save that file.
   • Make sure you save it as type All Files

7. Run executable.

   • In the directory you downloaded the executeable, Run:

   .\bot.exe 
   

   • Can also run executable by right-clicking bot.exe in File Explorer and then clicking on Open

Docker:

1. Ensure Docker is installed on your current OS (Docker Desktop Download)

2. Once Docker is installed be sure to run the Docker application ensuring that the daemon is running.

3. Open a terminal of your choice and check to see if Docker is installed properly with the following command:

   docker --version
   

4. Once you have verified Docker is installed and running pull our latest image.

   docker pull andrewto/discotify:v3.0
   

5. Once pulled be sure to setup your environment variables.

   • In the same directory the executable is located, create a .env file in Notepad

   • Set your Client ID and Client Secret in the following format (How to find Client ID and Client Secret):

      SPOTIFY_CLIENT_ID= your_client_id
      SPOTIFY_CLIENT_SECRET= your_client_secret
      DISCORD_TOKEN= your_discord_token
   

   • Save that file.
   • Make sure you save it as type All Files

6. Run the image with the following command:

   docker run --env-file env_file andrewto/discotify:v3.0
   

   • env_file will be the path to your .env file that you created in the previous step
   • to run multiple containers you can a command similar to:

   docker run --env-file env_file_1 -d --name container1 andrewto/discotify:v3.0
   docker run --env-file env_file_2 -d --name container2 andrewto/discotify:v3.0
   

   • env_file_1 and env_file_2 are paths to your two .env files while container1 and container2 can be any names you want to want to name your container

How to contribute

Follow this project board to know the latest status of the project: http://...

How to build

https://github.com/orgs/cis3296f23/projects/112

• Use this github repository: ...
• Specify what branch to use for a more stable release or for cutting edge development.
• Use Visual Studio
• Specify additional library to download if needed
• What file and target to compile and run.
• What is expected to happen when the app start.

Troubleshooting Problems

Continuously adding new problems that come up through development or building, will post common problems and solutions for current/future developers to refer to.

Compiling/Building Issues

If pip install discord jsonlib base64 requests doesn't work and you are on macOS, try removing the base64 and see if that works. Make sure you are also using the correct interpreter for your IDE if you using that to run the program. you can check what interpreter your terminal is using with which python or which python3.

INVALID_CLIENT error when authenticating Issues

If you received this error, make sure to add your Spotify Client ID and Secret to 4 environment variables as if you don't you will receive an INVALID_CLIENT: Invalid client error when you click on the authentication link sent by the discord bot. Make sure you have also added your own Discord Bot token to the environment variable DISCORD_TOKEN.

403 Error with !previous

If you used !previous and got an error 403, it's most likely because you tried to do the command while not in a playlist. If you did !play and then !previous, you will get the error since you are playing just one single song and there hasn't been any previous history.

"bot" cannot be open because it is from an unidentified developer (Mac)

1. Choose Apple menu > System Settings
2. Click Privacy & Security from the left sidebar
   

   

3. Scroll down to Security 4. Click `Open Anyway`

5. After enter your password, Click `Open`

6. Bot are ready to go.