Youtube Music Discord Rich Presence

A simplistic rich presence for Discord that displays your song information from Youtube Music.

---

Table of Contents

1. Features
2. Getting Started
   • Prerequisites
   • Installation

Features

Features	Status
Song Name	✅
Album Cover	✅
Share Button	✅
Pausing/Unpausing	✅
Pause/Playing mini-icons	✅

Getting Started

Depending whether or not you use a Discord client modification, the way the RPC will look is different.

• Without client modification (native RPC)

• With client modification (plugin)

Prerequisites

• Node.js (v18.17.1 LTS) alongside npm
• The Typescript Compiler

  # After installing Node.js
  npm install typescript -g

• Git
• A modern browser such as Firefox or a Chromium based one

Usage

In order to use this project, you must have the server running, alongside the extension running.

To start and install each respective component in located within its section.

Installation

Note

This project has a setup script in order to streamline the installation process, the manual methods of installing and setting up the components are still available.

Before proceeding with any of the methods below for installation, you have to clone the project. Open your terminal, where you wish to store the files for the project, then run the following:

git clone https://github.com/acelikesghosts/ytm-rpc.git
cd ytm-rpc

Then proceed with one of the following:

• Server Installation
• Extension Installation
• Client Mod Installation

Setup Script

To run the setup script, you must have a bash terminal.

The accepted arguments are the following:

ALL OPTIONS ARE OPTIONAL, BUT ATLEAST ONE IS REQUIRED TO RUN THE SCRIPT

Argument	Description
--deps	Installs the dependencies required for each project.
--build	Builds the server
--client=<bd|replugged>	Specify what client modification to install

After deciding what arguments you wish to pass to the setup script, run the following:

bash ./scripts/setup.sh (your arguments)

The recommended installation script arguments are the following:

bash ./scripts/setup.sh --deps --build

Server Installation

1. Install the NPM dependencies

   npm install

2. Copy the .env.example into .env

   cp .env.example .env

3. Configure the .env file
   • If using a client mod it is required to set USING_WS to true
   • You can change the pause/play mini-icons, and more by doing so.
4. Build the server

   # this will build EVERY package
   npm run build --workspaces

Then run it using node .

Extension Installation

Chromium

1. Navigate to the respective extensions tab.
2. Turn on the Developer Mode switch (typically located in the top right of the extensions page)
3. Click on the "Load Unpacked" button
4. Browser to the project directory, and select the folder named packages/extensions

Firefox

1. Navigate to about:debugging
2. Proceed to the This Firefox tab
3. Select Load Temporary Add-on…
4. Navigate to the packages/extensions folder and select any file within it.

If you have changed the port of the server, click on the extension's icon to modify the port data is sent to.

If you have any open tabs of Youtube Music, please restart them.

Client Mod Installation

Warning

Using client modifications on Discord can result in termination, or account suspension.

Client Mod	Status
BetterDiscord	✅
Replugged	✅
Vencord	❌

BetterDiscord

1. Navigate to the packages/betterdiscord folder.
2. Install the dependencies required

npm install

3. Tranpsile the JSX to JS

npm run build

4. Move the file created in dist to your BetterDiscord plugin folder

If you have changed the port which the server runs at, change it within the plugin's settings as well.

Replugged

Prerequisites

• pnpm

  npm i pnpm -g

If you have changed the port which the server runs at, change it within the plugin's settings as well.

1. Navigate to the packages/replugged folder.
2. Install the dependenices for the project.

pnpm install

3. Build the Typescript project

pnpm run build

4. Ensure that it is in your Replugged plugins folder after building.
5. Navigate to the plugin settings within Replugged.
6. Press Load Missing Buttons, then refresh Discord.

Vencord

At the moment, it is not possible to create custom plugins for Vencord without having it merged into the base client mod, which is a big overstep for a project like this.

Follow this PR for when they allow external plugins

Updating

Updating your local version of the project is rather simple, and all you have to do is:

1. Navigate to where it is installed and update the Git repo

git pull

2. Update the required dependencies using npm:

npm install

3. Rebuild the codebase

npm run build --workspaces

4. Navigate to the browser's extension manager and press Update

5. If you are using a client modification, go to the respective installation section and proceed with the steps.