robinfriedli / Botify

Discord bot that plays Spotify tracks and YouTube videos or any URL including Soundcloud links and Twitch streams.

• Play and search Spotify tracks and YouTube videos or playlists or play any URL including Soundcloud links and Twitch streams
• Create cross-platform playlists with tracks from any source
• Simple and customisable player commands
• Create custom command presets as shortcuts for your most used commands
• Adjustable properties for even deeper customisation
• Sign in to Spotify to play your own playlists or upload botify playlists
• Manage what roles can access which commands
• Customise how you want to summon your bot by using a custom prefix or giving your bot a name
• Advanced admin commands such as updating and rebooting the bot or cleaning up the database available to bot administrators

botify 2

Botify 2 is currently in development. Check out the development/v2.0 branch to see the latest progress.

Milestones:

• [x] migrate from maven to gradle
• [x] implement spring boot framework
• [x] add support for lavaplayer youtube ip rotator
• [x] cleanup transaction invokers
• [x] cleanup track loading executors and improve concurrency
• [x] create new query builder API as a wrapper for hibernate criteria queries that simplifies writing queries and introduces new features like forking and query interceptors
• [x] adapt to changes in behaviour of JPA hibernate now that it’s bootstrapped by spring boot via JPA
• [ ] additional commands to alter existing playlist, incl. renaming and adding a thumbnail
• [ ] support for PLS files to export / import playlists (maybe, evaluation pending)
• [x] enable search for soundcloud tracks using lavaplayer scsearch
• [x] fully configure command arguments in XML and use groovy scripts for rules
• [ ] advanced queue management that allows removing items from the queue and reflects changes to queued playlists
• [ ] store discord snowflake ids as long instead of string
• [x] better manage storage / retrieval of JDA entities (esp. on AudioPlayback, GuildContext and AbstractWidget)
• [ ] drop cached GuildContext instances for inactive guilds
• [x] implement system for pagination widgets
• [ ] pagination widget for playlist view and maybe add pagination to queue widget
• [ ] enable skipping to a specific queue index
• [ ] save and restore playback states when rebooting (queue, current track position etc)
• [ ] adjust charts command and add user specific charts
• [ ] user specific track suggestions
• [x] enhanced permission system that allows setting permissions for command arguments and custom targets
• [x] evaluate command / scripting sandbox + custom scripted CommandInterceptors
• [ ] web client that communicates with Botify via rest (eval Rust + WebAssembly vs TypeScript)

Invite it to your guild

https://discordapp.com/api/oauth2/authorize?client_id=483377420494176258&permissions=70315072&scope=bot

Host it yourself

1. Create a Discord app

1.1 Go to https://discordapp.com/developers/applications and create an application

1.2 Click "Bot" on the side menu to create a bot and copy the token for later

2. Create a Spotify app

2.1 Go to https://developer.spotify.com/dashboard/applications to create a Spotify application and copy the client id

2.2 Click on "Edit Settings" and whitelist your Redirect URI for the Spotify login

Don't have a domain? You could either go without logins all together and still use most of botify's features or use your router's public ip and setup port forwarding for your router.

3. Create a YouTube Data API project

3.1 Go to https://console.developers.google.com/ and create a project for the YouTube Data API and create and copy the credentials

4. Setup botify settings

4.1 Navigate to your cloned project and go to ./resources and open the settings.properties file and fill in the blanks, it should look like this:

4.2 To take advantage of the admin commands that can perform administrative actions, such as updating and restarting the bot, be sure to add your Discord user id to the ADMIN_USERS property. To find your Discord user id, enable Developer Mode in the App Settings > Appearance. Then go to any guild, right click your user and click "Copy ID".

4.3 For Botify to manage the YouTube API quota automatically, be sure to fill in the YOUTUBE_API_DAILY_QUOTA property; open the Google developer console and go to Library > YouTube Data API v3 > Manage > Quotas

4.4 Change the BASE_URI property to your domain or public IP (without slash at the end) and adjust REDIRECT_URI to the corresponding endpoint for Spotify logins (normaly BASE_URI + "/login")

Don't have a domain? You could either go without a web server all together and still use most of botify's features or use your router's public ip and setup port forwarding for your router to the machine where you're running botify via the port specified by the SERVER_PORT property.

###################
# server settings #
###################
SERVER_PORT=8000
BASE_URI=http://localhost:8000
REDIRECT_URI=http://localhost:8000/login
HIBERNATE_CONFIGURATION=./resources/hibernate.cfg.xml
# list IPv6 blocks to use for the lavaplayer route planner (comma separated)
IPV6_BLOCKS=
##########
# tokens #
##########
DISCORD_TOKEN=#copy your discord token here
SPOTIFY_CLIENT_ID=#copy your spotify client id here
SPOTIFY_CLIENT_SECRET=#copy your spotify client secret here
YOUTUBE_CREDENTIALS=#copy your youtube credentials here
#################
# contributions #
#################
PLAYLISTS_PATH=./resources/playlists.xml
GUILD_PLAYLISTS_PATH=./resources/%splaylists.xml
GUILD_SPECIFICATION_PATH=./resources/guildSpecifications.xml
COMMANDS_PATH=./resources/xml-contributions/commands.xml
COMMAND_INTERCEPTORS_PATH=./resources/xml-contributions/commandInterceptors.xml
HTTP_HANDLERS_PATH=./resources/xml-contributions/httpHandlers.xml
STARTUP_TASKS_PATH=./resources/xml-contributions/startupTasks.xml
LOGIN_PAGE_PATH=./resources/html/login.html
LIST_PAGE_PATH=./resources/html/playlist_view.html
ERROR_PAGE_PATH=./resources/html/default_error_page.html
QUEUE_PAGE_PATH=./resources/html/queue_view.html
EMBED_DOCUMENTS_PATH=./resources/xml-contributions/embedDocuments.xml
GUILD_PROPERTIES_PATH=./resources/xml-contributions/guildProperties.xml
CRON_JOBS_PATH=./resources/xml-contributions/cronJobs.xml
WIDGETS_PATH=./resources/xml-contributions/widgets.xml
VERSIONS_PATH=./resources/versions.xml
###############
# preferences #
###############
# replace this value with your YouTube API Quota: open the Google developer console and go to Library > YouTube Data API v3 > Manage > Quotas
YOUTUBE_API_DAILY_QUOTA=1000001
MODE_PARTITIONED=true
QUEUE_SIZE_MAX=10000
# playlists per guild (if mode_partitioned = true, else playlist total)
PLAYLIST_COUNT_MAX=50
PLAYLIST_SIZE_MAX=5000
ADMIN_USERS=#define user ids (comma separated) that may access admin commands. These users can always use each command irregardless of access configurations
#######################################
# discordbots.org settings (optional) #
#######################################
#DISCORD_BOT_ID=#copy your discord client id here
#DISCORDBOTS_TOKEN=#copy your discordbots.org token here

5. Setup database

5.1 Setup hibernate configuration

Navigate to ./resources/hibernate.cfg.xml and adjust the settings, if you use a local postgres server and name your database "botify_playlists" you can leave it like this:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE hibernate-configuration PUBLIC
    "-//Hibernate/Hibernate Configuration DTD 3.0//EN"
    "http://www.hibernate.org/dtd/hibernate-configuration-3.0.dtd">

<hibernate-configuration>
  <session-factory>
    <!-- hibernate config -->
    <property name="hibernate.connection.driver_class">org.postgresql.Driver</property>
    <property name="hibernate.connection.url">jdbc:postgresql://localhost:5432/botify_playlists</property>
    <property name="hibernate.connection.username">postgres</property>
    <property name="hibernate.connection.password">postgres</property>
    <property name="hibernate.dialect">org.hibernate.dialect.PostgreSQL94Dialect</property>
    <property name="show_sql">false</property>
    <property name="hibernate.hbm2ddl.auto">update</property>
    <property name="hibernate.current_session_context_class">thread</property>
    <!-- C3P0 config -->
    <property name="hibernate.c3p0.min_size">5</property>
    <property name="hibernate.c3p0.max_size">20</property>
    <property name="hibernate.c3p0.timeout">1800</property>
    <property name="hibernate.c3p0.max_statements">50</property>
    <!-- ehcache -->
    <property name="hibernate.cache.use_query_cache">true</property>
    <property name="hibernate.cache.use_second_level_cache">true</property>
    <property name="hibernate.cache.region.factory_class">org.hibernate.cache.jcache.JCacheRegionFactory</property>
    <property name="hibernate.javax.cache.provider">org.ehcache.jsr107.EhcacheCachingProvider</property>
    <property name="hibernate.javax.cache.missing_cache_strategy">create</property>
    <!-- annotated classes -->
    <mapping class="net.robinfriedli.botify.entities.Playlist"/>
    <mapping class="net.robinfriedli.botify.entities.Song"/>
    <mapping class="net.robinfriedli.botify.entities.Video"/>
    <mapping class="net.robinfriedli.botify.entities.UrlTrack"/>
    <mapping class="net.robinfriedli.botify.entities.Artist"/>
    <mapping class="net.robinfriedli.botify.entities.PlaylistItem"/>
    <mapping class="net.robinfriedli.botify.entities.CommandHistory"/>
    <mapping class="net.robinfriedli.botify.entities.PlaybackHistory"/>
    <mapping class="net.robinfriedli.botify.entities.Preset"/>
    <mapping class="net.robinfriedli.botify.entities.GuildSpecification"/>
    <mapping class="net.robinfriedli.botify.entities.AccessConfiguration"/>
    <mapping class="net.robinfriedli.botify.entities.GrantedRole"/>
    <mapping class="net.robinfriedli.botify.entities.SpotifyRedirectIndex"/>
  </session-factory>
</hibernate-configuration>

If you need help setting up your postgres server, please refer to their official documentation: http://www.postgresqltutorial.com/

5.2 Setup liquibase properties

Go to src/main/resources/liquibase/liquibase.properties and adjust the liquibase properties according to the changes you made to the hibernate configuration above. If you left it as it is you can leave the liquibase.properties like this:

driver=org.postgresql.Driver
url=jdbc:postgresql://localhost:5432/botify_playlists
username=postgres
password=postgres
changeLogFile=src/main/resources/liquibase/dbchangelog.xml

6 Compile and run botify

Navigate to the project root directory and install botify by running mvn clean install. Then you can launch botify using the main class net.robinfriedli.botify.boot.Launcher. You can either run the bash script resources/bash/launch.sh or run java -jar target/botify-1.0-SNAPSHOT.jar or mvn exec:java -Dexec.mainClass=net.robinfriedli.botify.boot.Launcher directly. Note that this command is written for Unix-like operating systems such as macOS and Linux. For windows you might need to adjust this command to mvn exec:java -D"exec.mainClass"="net.robinfriedli.botify.boot.Launcher".