derrickdaking / gowon

A Last.fm Discord bot written in TypeScript

Gowon

Gowon is a Last.FM discord bot in active development.

Check out the indexing server over at jivison/gowon-indexer

Running yourself

Ensure you have Postgres and Typescript installed, and a database called gowon exists (createdb gowon). Ensure you have Redis installed (https://redis.io/download) and started

Rename config.example.json to config.json, and fill in all the fields. Then, do the same with ormconfig.example.json

yarn start will build and run the bot. To start in development mode, make sure you have nodemon installed, then run:

yarn build:watch
# and in another tab
yarn start:watch

Logging

Every command run has a log associated with it. This way if multiple commands are run at once, the logs stick to the command they were created by. Below is an example of some logs:

Commands list

You can find the source code for all the commands at /src/commands

• help, list all commands, or display help about a certain command

Lastfm

• amiscrobbling, shows you if you are scrobbling or not
• cover, shows the cover of an album
• nowplaying, shows the song you are currently listening to, along with other information
• partytime, counts down
• randomsong, picks a random song from the signed in users
• recent, shows a few of your recent tracks
• server, picks random users from the server and shows what they're listening to
• track, search or directly query a song (like a fake nowplaying)
• Account
  • login, logs you in
  • logout, logs you out
  • whoami, shows who you're logged in as
  • lastfm, links to the lastfm page of a user
  • lastfm2discord, looksup a discord user based on their last.fm username
• Crowns
  • check, checks a crown
  • checkmany, checks multiple crowns at once
  • info, displays info about a crown
  • list, lists a user's crowns
  • rank, ranks a user based on their crown count
  • dm, DMs you a list of all of a users crowns
  • contentiouscrowns, lists the crowns which have been stolen the most times
  • topcrowns, lists the crowns with the highest playcounts
  • topcrownholders, lists who has the most crowns
  • optout, opts you out of the crowns game
  • optin, opts you back into the crowns game
  • setinactiverole, set what role should be treated as the inactive role
  • setpurgatoryrole, set what role should be treated as the purgatory role
  • recentlystolen, see the crowns which were recently yoinked
  • ban/unban, bans/unbans a user from the crowns game
  • guildat, shows the crowns guild at a certain rank
  • guildaround, shows the crowns guild around you
  • crownranks, see the ranks of your crowns
  • artist/unbanartist, bans/unbans users from getting the crown for a certain artist
• External
  • rateyourmusic, searches RateYourMusic for an album
  • whosampled, searches WhoSampled for a track
  • wikipedia, searches Wikipedia for a track
• Friends
  • add, add a friend
  • remove, remove a friend :(
  • removeall, remove all friends :((((
  • list, list your friends, and see what they're playing
  • albumplays, shows how many scrobbles of an album your friends have
  • artistplays, shows how many scrobbles of an artist your friends have
  • trackplays, shows how many scrobbles of an track your friends have
  • scrobbles, shows how many scrobbles your friends have
• Info
  • artistinfo, shows info about an artist
  • albuminfo, shows info about an album
  • trackinfo, shows info about an track
  • taginfo, shows info about an track
  • toptrack, shows the top tracks for an artist
• Jumble
  • me, find an artist from your library to jumble
  • guess, make a guess for the jumble
  • hint, get a hint for the jumble
  • quit, give up on the jumble
• Library
  • albumtoptracks, shows your top tracks on an album
  • artisttoptracks, shows your top tracks for an artist
  • artisttopalbums, shows your top albums for an artist
  • lastscrobbled, shows when you last scrobbled a song
  • searchartist, search your top artists for a keyword
  • searchalbum, search your top albums for a keyword
  • searchtrack, search your top tracks for a keyword
• List
  • artistlist, shows your top artists
  • albumlist, shows your top albums
  • tracklist, shows your top tracks
• Overview
  • avgperday, shows your average scrobbles per day
  • crowns, shows stats about your crowns
  • hindx, shows your hindex
  • joined, shows when you joined
  • per, shows some "per" stats for artist/albums/tracks
  • scrobblesperartist, shows your average scrobbles per artist
  • scrobblesperalbum, shows your average scrobbles per album
  • scrobblespertrack, shows your average scrobbles per track
  • sumtop, shows the sum of your top artists
  • toppercent, shows how many artists make up 50% of your scrobbles
  • all, all of the above
  • breadth, shows your breadth rating
• Pages
  • artistpage, gives you the link to an artist's last.fm page
  • albumpage, gives you the link to an album's last.fm page
  • trackpage, gives you the link to an track's last.fm page
• Percent
  • artistpercent, shows what percentage an artist makes up of your total scrobbles
  • albumpercent, shows what percentage an album makes up of your total scrobbles of an artist
  • trackpercent, shows what percentage an track makes up of your total scrobbles of an artist
• Plays
  • artistplays, shows how many plays you have of an artist
  • albumplays, shows how many plays you have of an album
  • trackplays, shows how many plays you have of a track
  • globalartistplays, shows how many plays Last.fm has of an artist
  • globalalbumplays, shows how many plays Last.fm has of an album
  • globaltrackplays, shows how many plays Last.fm has of a track
• Playsover
  • artistplaysover, shows how many plays over a given number you have of an artist
  • albumplaysover, shows how many plays over a given number you have of an album
  • trackplaysover, shows how many plays over a given number you have of a track
  • artistplaysequal, shows how many plays equal to a given number you have of an artist
  • albumplaysequal, shows how many plays equal to a given number you have of an album
  • trackplaysequal, shows how many plays equal to a given number you have of a track
• Rank
  • artistrank, shows what rank an artist is in your top artists
  • albumrank, shows what rank an album is in your top albums
  • trackrank, shows what rank a track is in your top tracks
  • artistat, shows what artist is at a given rank
  • albumat, shows what album is at a given rank
  • trackat, shows what track is at a given rank
• Redirects
  • [disabled] add, adds a redirect
  • [disabled] remove, removes a redirect
  • [disabled] list, list all artists that redirect to another artist
• Stats
  • artistcount, counts your artists
  • albumcount, counts your albums
  • trackcount, counts your tracks
  • taste, compares your taste with another user
  • scrobbles, shows how many scrobbles you have
  • combo, shows listening streaks
  • milestone, shows you what you scrobbled at a scrobble milestone
  • goback, shows you what you scrobbled in the past
  • pace, predicts when you will hit a scrobble milestone
  • tag, shows your overlap with a tag's top artists

Admin

• disable, disable a command entirely
• enable, re-enable a disabled command
• disabled, lists all disabled commands
• permissions, control who can use what commands
  • blacklist, lets you black/whitelist commands for users/roles
  • delist, removes a user/role from the whitelist/blacklist for a command
  • help, permissions help
  • view, view permissions
• usercount, shows how many users are signed into the bot

Meta

• github, links the github repository for the bot
• issues, lists the github issues page for the bot
• latestcommit, shows the latest commit to the github repository

Special Thanks

• All my alpha testers, for breaking everything:

  • RTFL
  • Thot
  • Mex
  • DunsterJR
  • Manu
  • Himiko
  • Dana
  • Turbie
  • Mez
  • Itsuko
  • Catchy

• DunsterJR for making the (old) profile picture, and for the friends plays idea

• mypetrobot for building the Who Knows? bot, the backbone and inspiration for this bot

• Frikandel, for being a great influence and always ready to help (Go checkout .fmbot!)

• Ish, for being cool overall 😎 (Go checkout Chuu!)

• Last.fm, for making a great platform <3