Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/angeloanan/lyrics-finder
🎤 | Search the lyrics to your music with Lyrics Finder
https://github.com/angeloanan/lyrics-finder
discord-bot discord-js discordapp discordbot genius genius-api lyrics lyrics-finder
Last synced: about 2 months ago
JSON representation
🎤 | Search the lyrics to your music with Lyrics Finder
- Host: GitHub
- URL: https://github.com/angeloanan/lyrics-finder
- Owner: angeloanan
- License: gpl-3.0
- Created: 2020-04-08T09:15:52.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-03-16T14:56:10.000Z (6 months ago)
- Last Synced: 2024-05-02T04:05:06.839Z (5 months ago)
- Topics: discord-bot, discord-js, discordapp, discordbot, genius, genius-api, lyrics, lyrics-finder
- Language: TypeScript
- Homepage:
- Size: 1.27 MB
- Stars: 19
- Watchers: 3
- Forks: 5
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-made-by-indonesian - Lyrics Finder - `Search the lyrics to your music with Lyrics Finder` *by [Angelo](https://github.com/angeloanan)* (L)
- made-in-indonesia - Lyrics Finder - `Search the lyrics to your music with Lyrics Finder` *by [Angelo](https://github.com/angeloanan)* (L)
README
Lyrics Finder
[](https://discord.gg/mFvDvHc)
[](https://github.com/angeloanan/lyrics-finder/issues)
[](https://github.com/angeloanan/lyrics-finder/pulls)
[](/LICENSE)
---
🤖 A Discord bot which specializes on lyrics searching
## 📝 Table of Contents
+ [About](#about)
+ [Demo / Working](#demo)
+ [How it works](#working)
+ [Usage](#usage)
+ [Getting Started](#getting_started)
+ [Built Using](#built_using)
+ [TODO](../TODO.md)
+ [Contributing](../CONTRIBUTING.md)
+ [Authors](#authors)
+ [Acknowledgments](#acknowledgement)
## 🧐 About
Lyrics Finder is a Discord bot which searches for Lyrics on Genius. It supports all song language, as long as it's listed on Genius. If you don't know the song title, you can search the song by using its lyrics.
If you display your current Spotify song as your Discord status, it can automatically search the song by using a command. Feeling like singing to your song? There's also a mode to search every song you're playing on Spotify.
## 🎥 Demo / Working
The bot uses the [Genius API](https://genius.com/developers) to search the lyrics of a song. When searching using Spotify, the bot grabs the User presence and forms the search query by ` `, otherwise using the user's input.
After fetching the Genius API, it takes the first search result and scrape the lyrics page. This is complicated since Genius doesn't give the lyrics using their API and scraping the page tends to be very inconsistent.
The scrape result gets feed into a Regex filter, which then gets feed into a function, forming the Discord Embed fields.
The entire bot is written using [Typescript](https://typescriptlang.org) with [Discord.JS](https://discord.js.org) as the framework
To use the bot, you will need to [**add the bot by clicking this link**](https://discord.com/oauth2/authorize?client_id=559265456008200222&permissions=314432&scope=bot).
Once done, you can display the help command by sending:
```
~!help
```
## 🏁 Getting Started
These instructions will get you a copy of the bot up and running on your local machine for development and testing purposes.
### Prerequisites
You will need to install [NodeJS](https://nodejs.org) version 14 or higher and the `node-gyp` build tool ([info](https://github.com/nodejs/node-gyp#installation)). [Yarn](https://yarnpkg.com) is recommended to install the project's dependency.
### Installing
You will need to clone the repo to your machine
```
$ git clone https://github.com/angeloanan/lyrics-finder.git
$ cd lyrics-finder
```
Install the dependencies
```
// Using NPM
$ npm install
// Using Yarn
$ yarn install
```
You will need to create a `.env` file or edit the system environment variable
Example environment variable is available on `.env.example`
```
$ mv .env.example .env
$ nano .env
```
#### Compiling and running
To compile (transpile) the code back to Javascript, you will need to do the following
```
$ tsc .
```
The compiled code will be available on the `targets` folder. Now, you can run the index file to run the bot.
#### Running with ts-node
You can skip compiling / transpiling the code by using a package called `ts-node`
```
// Using NPM
$ npm i -g ts-node
// Using Yarn
$ yarn global add ts-node
```
After it's installed, you can start the bot by doing the following
```
// Using NPM
$ npm start
// Using Yarn
$ yarn start
```
## ⛏️ Built Using
+ [Discord.js](https://discord.js.org) - Discord API wrapper
+ [Genius](https://genius.com/developer) - Provides lyrics and API
+ [Typescript](https://typescriptlang.org) - A typed superset of JavaScript
## ✍️ Authors
+ [@angeloanan](https://github.com/angeloanan) - Idea & Initial work
See also the list of [contributors](https://github.com/angeloanan/lyrics-finder/contributors) who participated in this project.