https://github.com/rhygg/drpc
📦 A discord rich presence package in the cli!
https://github.com/rhygg/drpc
cli desktop discord discord-presence discord-rpc discord-status drpc rpc-application timestamp
Last synced: 14 days ago
JSON representation
📦 A discord rich presence package in the cli!
- Host: GitHub
- URL: https://github.com/rhygg/drpc
- Owner: rhygg
- License: mit
- Created: 2021-05-27T14:08:15.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2021-05-28T04:40:40.000Z (almost 5 years ago)
- Last Synced: 2025-10-11T23:15:20.714Z (7 months ago)
- Topics: cli, desktop, discord, discord-presence, discord-rpc, discord-status, drpc, rpc-application, timestamp
- Language: JavaScript
- Homepage:
- Size: 78.1 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: Readme.md
- License: LICENSE
Awesome Lists containing this project
README
# DRPC
```bash
________ ________ ________ ________ ________ ___ ___
|\ ___ \|\ __ \|\ __ \|\ ____\ |\ ____\|\ \ |\ \
\ \ \_|\ \ \ \|\ \ \ \|\ \ \ \___| \ \ \___|\ \ \ \ \ \
\ \ \ \\ \ \ _ _\ \ ____\ \ \ \ \ \ \ \ \ \ \ \
\ \ \_\\ \ \ \\ \\ \ \___|\ \ \____ \ \ \____\ \ \____\ \ \
\ \_______\ \__\\ _\\ \__\ \ \_______\ \ \_______\ \_______\ \__\
\|_______|\|__|\|__|\|__| \|_______| \|_______|\|_______|\|__|
```
**Drpc** is a robust discord rich precence client on the command line, you can save a preset, delete it and configure it, easily!
## Installation
```
npm install -g drpc-cli
```
## Documentation
To configure a preset you must create a `drpc-settings.json` file, in the current working directory i.e., the directory you are currently working on it.
For example: if you create a `drpc-settings.json` file on the Desktop, the cli must run in the desktop folder.
Here's a example settings file,
```json
{
"client_id":"",
"large_image_key":"",
"large_image_text":"",
"small_image_key":"",
"small_image_text":"",
"description":"",
"state":"",
"show_timestamp": ,
"buttons":[
{"label":"", "url":""},
{"label":"", "url":""}
]
}
```
The following is a full template, fill all the information correctly to yield the result!
## API
**client_id**
The client id of the rpc application.
required: `true`
**large_image_key**
The key(name) of the large image as set in the rpc application.
required: `true`
**large_image_text**
The text that would show off when a user hovers over the image.
required: `false`
**small_image_key**
The key(name) of the small image as set in the rpc application.
required: `false`
**small_image_text**
The text that would show off when a user hovers over the image.
required: `false`
**description**
The rpc description.
required: `true`
**state**
The rpc state description.
required: `false`
**show_timestamp**
(Bool) if you want to show the timestamp.
required: `false`
**buttons**
(Array) Buttons on the Rich Presence.
Array takes: two `objects`
Example Object:
```json
{"label":"Something", "url":"https://something.com"},
{"label":"anothersomething","url":"https://example.com"}
```
Min buttons: `1`,
Max buttons: `2`,
required: `false`
## CLI
```
DRPC CLI
----------------------------------------------------
MAIN COMMANDS
-------------
--help | -h --- Shows you the following menu
--run --- Starts a process.
--delete | -del --- delete a configuration. (required args -> )
--list | -l --- Check the list of saved presets.
SUB-COMMANDS
------------
RUN
------
--save --- Run a configuration while simultaneously saving it. (required args -> )
--preset --- Run a preset instead of a configuration file in the current working dir.
```
## FAQs
**How to save a rpc preset?**
```
drpc --run --save
```
**Must the rpc config file be in the cwd while saving the preset?**
Yes.
If you're going to save the preset you want to run using:
```
drpc --run --save
```
The configuration you want to run and save must be in the same current working directory.
## Example
```
drpc --list
```
```
┌──────┬─────────────────────┬─────────────────────────┐
│ No. │ Name │ ClientID │
├──────┼─────────────────────┼─────────────────────────┤
│ 1 │ node.json │ 781004595546816522 │
└──────┴─────────────────────┴─────────────────────────┘
```
```
drpc --help
```
```
DRPC CLI
----------------------------------------------------
MAIN COMMANDS
-------------
--help | -h --- Shows you the following menu
--run --- Starts a process.
--delete | -del --- delete a configuration. (required args -> )
--list | -l --- Check the list of saved presets.
SUB-COMMANDS
------------
RUN
------
--save --- Run a configuration while simultaneously saving it. (required args -> )
--preset --- Run a preset instead of a configuration file in the current working dir.
```
```
drpc --run --save example
```
```
________ ________ ________ ________ ________ ___ ___
|\ ___ \|\ __ \|\ __ \|\ ____\ |\ ____\|\ \ |\ \
\ \ \_|\ \ \ \|\ \ \ \|\ \ \ \___| \ \ \___|\ \ \ \ \ \
\ \ \ \\ \ \ _ _\ \ ____\ \ \ \ \ \ \ \ \ \ \ \
\ \ \_\\ \ \ \\ \\ \ \___|\ \ \____ \ \ \____\ \ \____\ \ \
\ \_______\ \__\\ _\\ \__\ \ \_______\ \ \_______\ \_______\ \__\
\|_______|\|__|\|__|\|__| \|_______| \|_______|\|_______|\|__|
Client has sucessfully Started!
Like this project? Please consider starring it On on github! (https://github.com/rhydderchc/drpc)
Data has been saved with the preset name example
```
```
drpc --list
```
```
┌──────┬─────────────────────┬─────────────────────────┐
│ No. │ Name │ ClientID │
├──────┼─────────────────────┼─────────────────────────┤
│ 1 │ example.json │ 781004595546816522 │
├──────┼─────────────────────┼─────────────────────────┤
│ 2 │ node.json │ 781004595546816523 │
└──────┴─────────────────────┴─────────────────────────┘
```
```
drpc --delete example
```
```
✔ The preset example has been deleted sucessfully!
```
```
drpc --list
```
```
┌──────┬─────────────────────┬─────────────────────────┐
│ No. │ Name │ ClientID │
├──────┼─────────────────────┼─────────────────────────┤
│ 1 │ node.json │ 781004595546816522 │
└──────┴─────────────────────┴─────────────────────────┘
```