Skip to content

Latest commit

 

History

History
116 lines (85 loc) · 5.26 KB

README.md

File metadata and controls

116 lines (85 loc) · 5.26 KB
Raw

Chuu

Chuu is a Discord bot that integrates Last.fm with Discord. Highly customizable at the user and server level. It also has some unique integrations with RateYourMusic.com. There are a ton of available commands like:

  • Your top of albums that were released in a given year
  • Image charts of both albums and artists
  • Play and scrobble music directly from Discord using Youtube,Bandcamp,Soundcloud,Twitch...
  • Artist, albums and songs leaderboards (crowns)
  • Unique artists within a server
  • Genre information about your artist/albums
  • 200+ more commands!
  • Full support for slash commands

Invite Link

You can invite the bot to your discord server using this link:

There is also a support server if you want to ask any questions directly. Join here:

Set-Up

You can also build the bot and install it on your own. In order to do that you need:

  • Java 19+

  • MariaDB 10.5+

  • Postgresql 14+

  • A Discogs developer account

    • DC_KY
    • DC_SC

  • A Spotify developer account

    • client_ID
    • client_Secret

  • A last.fm developer account

    • LASTFM_APIKEY
    • LASTFM_APISECRET (If you want to enable scrobbling)
    • LASTFM_BOT_SESSION_KEY (If you want to log what the bot scrobbles to a last.fm account)

  • A Discord developer account

    • DISCORD_TOKEN

  • OS

    • WALLPAPER_FOLDER (Directory with images to source backgrounds)
    • CACHE_FOLDER (Where to cache images)
    • IPV6_BLOCK (A ipv6 block used to avoid getting ip banned by YT)

  • OTHER

    • MODERATION_CHANNEL_ID (A discord channel where the bot will dump some info)
    • MODERATION_CHANNEL_2_ID (Another discord channel where the bot will dump some info)

Then you should set all those properties in the file all.properties

In MariaDB you should first create a database within MariaDB, and then inside that database run first the following SQL script, and then all the sql scripts under migrations sequentially

Finally adjust the datasource.properties with the corresponding properties.

For Postgres first check the Musicbrainz section. Once that is done you should run the following SQL script and adjust the mbiz.properties with the corresponding properties.

If you are interested in posting info of the bot to a given botlist, fill the file botlists.properties. The keys are specified in BotLists.java

Musicbrainz Database

For Postgresql I would recommend you to use mbdata to set up the musicbrainz database. Then adjust the mbiz.properties with the corresponding properties. WARNING: It's like a 30GB database, so take note. It's recommended to set normal and lowercase indexes on artist and album names to optimize some queries. Also, the pg_trgm extension should be enabled.

You have two options if you don't want to set up the whole musicbrainz instance:

Both this options will result on a lot of commands misbehaving and these options are not fully supported and a lot of errors can be produced because of that so please be aware of that!.

Running

After all that is installed you can run the task shadowjar of gradle and then you can execute, with executable being the name of the jar that is on build/libs

java -jar executable.jar

and the bot should begin running.

Test

Currently not working

If you were to do testing you should also fill the equivalent all.properties of the test module and also fill the tester.properties with a new Discord bot token that will be used for testing, the ID of the Discord server where the testing will take place and the ID of a user present in that server.