A simplistic rich presence for Discord that displays your song information from Youtube Music.
Features | Status |
---|---|
Song Name | :white_check_mark: |
Album Cover | :white_check_mark: |
Share Button | :white_check_mark: |
Pausing/Unpausing | :white_check_mark: |
Pause/Playing mini-icons | :white_check_mark: |
Depending whether or not you use a Discord client modification, the way the RPC will look is different.
# After installing Node.js
npm install typescript -g
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.
[!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:
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
npm install
.env.example
into .env
cp .env.example .env
.env
file
USING_WS
to true# this will build EVERY package
npm run build --workspaces
Then run it using node .
packages/extensions
This Firefox
tabLoad Temporary Add-on…
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.
[!WARNING] Using client modifications on Discord can result in termination, or account suspension.
Client Mod | Status |
---|---|
BetterDiscord | :white_check_mark: |
Replugged | :white_check_mark: |
Vencord | :x: |
npm install
npm run build
dist
to your BetterDiscord plugin folderIf you have changed the port which the server runs at, change it within the plugin's settings as well.
Prerequisites
npm i pnpm -g
If you have changed the port which the server runs at, change it within the plugin's settings as well.
pnpm install
pnpm run build
Load Missing Buttons
, then refresh Discord.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 your local version of the project is rather simple, and all you have to do is:
Navigate to where it is installed and update the Git repo
git pull
Update the required dependencies using npm:
npm install
Rebuild the codebase
npm run build --workspaces
Navigate to the browser's extension manager and press Update