diff options
| author | Brandon <bwaggone@umich.edu> | 2018-04-10 20:54:12 -0400 |
|---|---|---|
| committer | Brandon <bwaggone@umich.edu> | 2018-04-10 20:54:12 -0400 |
| commit | 7ffaf405f251bac54c9831253e92c769e197a1f5 (patch) | |
| tree | 7a1c3bce13ef741416c9a4c93114f44c85e63c53 | |
| parent | 05395d976b90ec672a6edc7b81180fff3a679140 (diff) | |
| download | SoundChan-7ffaf405f251bac54c9831253e92c769e197a1f5.tar.gz SoundChan-7ffaf405f251bac54c9831253e92c769e197a1f5.tar.bz2 SoundChan-7ffaf405f251bac54c9831253e92c769e197a1f5.zip | |
Add README and example
| -rw-r--r-- | .gitignore | 1 | ||||
| -rw-r--r-- | README.md | 22 | ||||
| -rw-r--r-- | soundchan.properties.example | 8 |
3 files changed, 31 insertions, 0 deletions
@@ -2,3 +2,4 @@ .idea gradle.propreties build +soundchan.properties diff --git a/README.md b/README.md new file mode 100644 index 0000000..465f32e --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +# SoundChan: The Discord Voice Bot + +## How to Run + +Currently the only way to run Sound Chan is to build the bot from source. As such you'll need the JRE and JDK. + +## Instructions For Use + +To run the sound bot on your Server, you'll need a developer's bot token from Discord. Full instructions for use will be coming, but in the meantime for development purposes, place your token and the corresponding settings in a file named, `soundchan.properties`. You can see an example of how the file should be formatted in `soundchan.properties.example`. + +## Requirements to Run + +* Java Runtime Environment + +## Requirements to Develop + +* Java Runtime Environment +* Java Development Kit +* `net.dv8tion:JDA:3.5.1_339` +* `com.sedmelluq:lavaplayer:1.2.53` + +More information to come. diff --git a/soundchan.properties.example b/soundchan.properties.example new file mode 100644 index 0000000..f862cc5 --- /dev/null +++ b/soundchan.properties.example @@ -0,0 +1,8 @@ +//The Bot Token you will have received from the discord developers page +botToken=BOT_TOKEN_FROM_DISCORD + +//The local file path to the directory of your sounds. Don't forget to escape your slashes +localFilePath=C:\\PATH\\TO\\SOUNDS\\DIRECTORY + +//The user for the +followingUser=USERNAME |