Code Monkey home page Code Monkey logo

cmus-rich-presence's Introduction

cmus-rich-presence

External Discord Rich Presence provider for the C* music player. Linux only. Preview

If you prefer Rust, I've got you covered now: cmusrp-rust

Usage

  • Download a prebuilt jar from Releases
  • Start the program by executing java -jar cmus-rich-presence-x.x.jar

Options

  • --debug -d: Disables rich presence functionality and shows more verbose console output
  • --interval [value] -i [value]: Changes polling interval, in ms. Default: 1000
  • --quiet -q: Disables console output
  • --help -h: Shows the help screen and then exits
  • --top [value] -t [value]: Sets the top format string. It's recommended to change this in the cmusrp.conf file. Default: "%artist - %title"
  • --bottom [value] -b [value]: Sets the bottom format string. It's recommended to change this in the cmusrp.conf file. Default: "from %album (%year)"

Note that command line arguments have priority over the cmusrp.conf configuration file.

Configuration file

This program creates a configuration file when it doesn't already exist in the same directory as the jar file.

It was made as an easier way to customize how this tool behaves and displays information. By default, it looks like this:

DEBUG=false
QUIET=false
INTERVAL=1000
TOP_FORMAT="%artist - %title"
BOTTOM_FORMAT="from %album (%date)"

The syntax should be pretty straight forward. See the Options paragraph for more information about the different values.

You can customize the top and bottom format using these placeholders: - %artist - %title - %album - %date

Comments are supported by starting a line with the '#' character.

**Note: ** If you don't like the way this program handles its configuration file, please continue using version 1.8 and wait for 2.0 to come out, where I will put the config file in more appropriate places (or even custom ones). As of now, this is only an admittedly janky solution to finally have this functionality implemented.

Build and development dependencies

cmus-rich-presence's People

Contributors

pascalpuffke avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

cmus-rich-presence's Issues

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.