Code Monkey home page Code Monkey logo

elisa-rpc's Introduction

Elisa-RPC

MajorGamerJay

screenshot

elisa-rpc is a program that shows your currently playing song in Elisa music player to discord. Uses D-Bus to communicate with the Elisa music player and then show music information to Discord.

How to use it

To use it, copy the config file template (config_template.json) from the root directory to the /src directory as config.json

Get required dependencies!

  1. pip install -r requirements.txt

Create an application to represent the RPC

  1. Go to: https://discord.com/developers/applications
  2. Create new application

Put required info in config file

  1. Copy Client ID and put it in "id" field in config.json
  2. Go to Rich Presence
  3. Upload your art assets
  4. In place of image_keys in config.json, place the name of your art assets
  5. Add description for your art asset in config.json

Run the script!

  1. cd into the directory, cd ./src
  2. Run the script, python3 elisa-rpc.py

Other tips

Check whether the program is working

By default, this program is daemonized (meaning this will run in background). If the program isn't working, just open your process monitor and search for elisa-rpc.py. If it does not exist, then the program is not working.

Paste the program's log files from ~/.local/share/elisa-rpc/ and open an issue. I will try my best to reply as soon as possible.

States of the program

All states of the RPC is updated every 5 seconds.

  • When Elisa is not playing a song (at stopped), then the program will display Stopped: <songname> at Discord RPC for 5 seconds and it will clear
  • When it is playing, a song: it will show information about that song in RPC
  • If the song is paused: It will show the song is paused within the RPC

Want to contribute?

Just make a pull request however you want lol. But I would appreciate if your code is well commented and more understandable. :)

This program is created under MIT License.

elisa-rpc's People

Contributors

majorgamerjay avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar

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.