Skip to content

Jacob-Noah/koel-electron-discord-rpc

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Koel Desktop via Electron with Discord RPC

Description

This is just a really simple Electron wrapper around the Koel Music Server web client that sends the current track info to Discord Rich Presence. I love Koel and this helps me with my personal use-case for it. Hopefully this helps you too since you found yourself here 🤝❤️ and I encourage you to go show your support to Phan An for making such a great music service.

There are 3 states to this client reflected in Discord RPC: idle browsing, actively playing, and a paused timeout. The default timeout is 1 minute, because I figure if it's paused over 1 minute you probably don't want to be showing it in Discord anymore. You can change this in the config.

Now supports "Listening to" Discord RPC and timeline progress. When paused, the timeline will change to a timer until idle timeout.

Examples

Example 1

Album title tooltip as expected Example 2

Example 3

Usage

  1. Create an application in the Discord Developer Portal to get your client ID and secret.
  2. Clone this repository and, assuming you have Node.js installed, run npm install to install the dependencies.
  3. Copy config.example.json to create config.json and copy your Koel web client URL and Discord application strings to it respectively. Put your preferred callback URL in both the config and your Discord application settings - it is required by RPC via OAuth but unused by this application so it can be anything.
  4. Run npm start to test the application is working correctly.
  5. Run npm run build to package the application for Windows x64. You can modify the build script in package.json to change the target.

The packaged application will be in the /builds directory. You can run the executable or create a shortcut to it for desktop / start menu / taskbar pinning.

That's it ❤️ happy listening!

About

Koel music player Electron wrapper to use as a desktop app and make use of Discord RPC.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors