Richcord

A customizable Discord Rich Presence application powered by a custom cross-platform IPC core.

📖 Overview

Richcord is a customizable Discord Rich Presence application that provides fine-grained control over your Discord activity without unnecessarily complicating the user experience.

Richcord uses a custom, platform-agnostic IPC implementation to communicate directly with the Discord desktop client.

✨ Features

• 🔌 Cross-platform Discord IPC
• 🎮 Rich Presence activity configuration
• 🔄 Automatic reconnection
• 💾 Persistent configuration
• 🖥️ Interactive CLI
• 🔍 GitHub-based update checking
• 🧩 Reusable Core API
• 📦 npm package
• 🖥️ Standalone Linux and Windows executables

---

📦 Installation

Richcord can be installed either through npm or by downloading a standalone executable from the GitHub Releases.

Requirements

• Discord Desktop
• Node.js 20 or newer — only required when installing through npm

Option 1 — npm

The npm package provides both the Richcord Core API and the Richcord CLI.

Install the CLI globally

npm install -g richcord
Copy

Verify the installation:

richcord --version
Copy

You can then use Richcord directly from your terminal:

richcord --help
Copy

Install Core as a dependency

If you are building an application on top of Richcord Core:

npm install richcord
Copy

Then import the Core API:

import { RichcordClient } from "richcord";
Copy

Richcord is an ES modules only package.

Option 2 — Windows executable

Download the latest richcord.exe from the GitHub Releases.

The executable is self-contained and does not require Node.js to be installed.

You can place the executable somewhere on your system and add its directory to your PATH to use the richcord command globally.

Verify the installation:

richcord --version
Copy

Option 3 — Linux executable

Download the latest richcord-linux-x64 executable from the GitHub Releases.

The executable is self-contained and does not require Node.js to be installed.

Make it executable:

chmod +x richcord-linux-x64
Copy

You can then run it directly:

./richcord-linux-x64 --version
Copy

To use the richcord command globally, place or symlink the executable into a directory included in your PATH.

For example:

sudo install richcord-linux-x64 /usr/local/bin/richcord
Copy

Then:

richcord --version
Copy

---

🚀 Quick Start

The following examples assume that Richcord is available as the richcord command through either the npm installation or a standalone executable.

1. Configure your Discord Application

Create an application through the Discord Developer Portal and copy its Application ID / Client ID.

Then run:

richcord config
Copy

2. Configure your Rich Presence

richcord set
Copy

This interactively configures your activity, including:

• Activity type
• Details and state
• Timestamps
• Images/assets
• Buttons
• Other Rich Presence properties

3. Start Rich Presence

richcord start
Copy

4. Check status

richcord status
Copy

5. Stop Richcord

richcord stop
Copy

To clear the currently active Rich Presence without deleting your saved configuration:

richcord clear
Copy

---

⌨️ CLI Commands

Command	Description
richcord	Display basic information
richcord help	Display available commands
richcord version	Display the installed version
richcord config	Configure Richcord
richcord set	Configure Rich Presence
richcord start	Start Rich Presence
richcord stop	Stop the running instance
richcord clear	Clear the active Rich Presence
richcord reset	Reset saved configuration
richcord status	Show current status
richcord update	Check for a newer release

Global options:

-h, --help       Show help
-V, --version    Show version
Copy

---

🏗️ Architecture

Richcord consists of two primary layers:

┌───────────────────────┐
│          CLI          │
│   User-facing app     │
└───────────┬───────────┘
            │
            ▼
┌───────────────────────┐
│         Core          │
│   Public API + IPC    │
└───────────┬───────────┘
            │
            ▼
┌───────────────────────┐
│   Discord Desktop     │
│      IPC Client       │
└───────────────────────┘
Copy

The Core handles Discord IPC, transports, handshaking, serialization, validation, connection management, and the public API.

The CLI consumes the Core's public API and contains no Discord IPC implementation.

The Core is frontend-independent and can be consumed by other applications through the npm package.

---

🛠️ Development

Clone the repository:

git clone https://github.com/SpoiledUnknown/Richcord.git
cd Richcord
Copy

Install dependencies:

npm install
Copy

Build the project:

npm run build
Copy

Check the project:

npm run check
Copy

Run the CLI during development:

npm run dev
Copy

Generate API documentation:

npm run build:docs
Copy

The project is written in TypeScript and consists of a reusable Core and a CLI frontend. The CLI consumes the Core's public API rather than implementing Discord IPC itself.

---

📚 Documentation

For complete API documentation:

📖 Read the Richcord Documentation

For downloads and previous releases:

📦 View GitHub Releases

For the published npm package:

📦 View Richcord on npm

---

📄 License

Richcord is licensed under the MIT License.