Giter VIP home page Giter VIP logo

ytm-discord's Introduction

YTM-Discord

A Rich Presence client (extension) and server for Youtube Music.

Requirements

  • Node.JS

That's it. Seriously. (You should probably use a recent version, too.)

Usage

First of all, you'll need to clone the repo.

git clone https://github.com/protogendelta/ytm-discord.git
cd ytm-discord

Building and Installing the Extension

cd client
npm i
npm run build

Then, head to chrome://extensions. Ensure that the Developer Mode toggle is on, then select Load Unpacked. Navigate to the client/dist folder and click Select Folder.

Running the Discord RPC Server

Heads Up! If you're still in the client directory, you should move up a level before continuing. (cd ..)

cd server
npm i
npm run discord

Advanced: Creating a Discord Application

If you want to use your own API application instead of the one provided, you'll need to update the clientId in the server's index.ts.

To work with the application as-is, your application should have the following rich presence assets:

  • paused: An icon (small image) to be shown when paused
  • playing: An icon (small image) to be shown when playing
  • ytm_logo: A fallback image (by default, the YT Music Logo) for unavailable or missing album art.

For convenience, some compatible images can be found in the media folder.

Running the Web (Now Playing) Server

cd server
npm i
npm run web

Then, visit left.html or right.html. The relevant files are in server/web, if you want to make any tweaks to the layout or styling.

To-Do

  • Debugging
  • Comments (for readability)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.