Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
fixing current release link
  • Loading branch information
Darkside138 committed Apr 2, 2016
1 parent f2b6259 commit 98a681b
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Simple soundboard for discord. You can trigger sounds by commands typed in discord chat or you can choose the sound from the local UI. You will need to create an account that the bot will use to join and play sounds. The bot can only play sounds/respond to commands for servers it has been given access to. Requires java 8 or higher. This bot uses the [DiscordJDA](https://github.com/DV8FromTheWorld/JDA) library.

##Current Release
[discordSoundboard-v1.0.1.jar](https://github.com/Darkside138/DiscordSoundboard/releases/download/1.1.1/discordSoundboard-v1.1.1.zip). Download the zip file and extract it's contents in a directory. If you have an existing install do not overwrite the "app.proerties" file. In that same directory you will need a directory called "sounds". Put all the clips you want to play in the sounds directory. In the app.properties file you should fill in the login information for your bot (you should create a new discord account for your bot). Once you've created your new bot you must invite it to any server you want to use it on. The property "username_to_join_channel" is your username on discord. When you click a sound file to play in the soundboard the app will look for this username and join the voice channel that user is in. If you don't have this configured properly the bot will not work. Also, the bot can respond to text channel commands. See below for information on those commands. Once this is complete execute the .jar file or the .bat file. You should see a bunch of logging and eventually something like "Started MainController in 6.383 seconds (JVM running for 6.939)". Now you should be able to access the UI by opening a browser and navigating to "http://localhost:8080". In this release I've added a feature that allows you to filter the sounds displayed based on the folder they are in so if you would like you can separate your sounds into folders and a dropdown should apear in the UI to allow filtering. Also, I've implemented a "watch" on the sounds directory so that if you add or remove sounds all you have to do is refresh your broswer to see the changes, no need to restart the app.
[discordSoundboard-v1.1.1.jar](https://github.com/Darkside138/DiscordSoundboard/releases/download/v1.1.1/DiscordSoundboard-1.1.1.zip). Download the zip file and extract it's contents in a directory. If you have an existing install do not overwrite the "app.proerties" file. In that same directory you will need a directory called "sounds". Put all the clips you want to play in the sounds directory. In the app.properties file you should fill in the login information for your bot (you should create a new discord account for your bot). Once you've created your new bot you must invite it to any server you want to use it on. The property "username_to_join_channel" is your username on discord. When you click a sound file to play in the soundboard the app will look for this username and join the voice channel that user is in. If you don't have this configured properly the bot will not work. Also, the bot can respond to text channel commands. See below for information on those commands. Once this is complete execute the .jar file or the .bat file. You should see a bunch of logging and eventually something like "Started MainController in 6.383 seconds (JVM running for 6.939)". Now you should be able to access the UI by opening a browser and navigating to "http://localhost:8080". In this release I've added a feature that allows you to filter the sounds displayed based on the folder they are in so if you would like you can separate your sounds into folders and a dropdown should apear in the UI to allow filtering. Also, I've implemented a "watch" on the sounds directory so that if you add or remove sounds all you have to do is refresh your broswer to see the changes, no need to restart the app.

##app.properties file
The contents of the app.properties file are below with sample values:
Expand Down

0 comments on commit 98a681b

Please sign in to comment.