https://github.com/lukeleppan/obsidian-discordrpc

Update your Discord Status to show your friends what you are working on in Obsidian. With Discord Rich Presence.
https://github.com/lukeleppan/obsidian-discordrpc

discord discord-rich-presence discord-rpc obsidian obsidian-md obsidian-plugin

Last synced: 3 months ago
JSON representation

Update your Discord Status to show your friends what you are working on in Obsidian. With Discord Rich Presence.

• Host: GitHub
• URL: https://github.com/lukeleppan/obsidian-discordrpc
• Owner: lukeleppan
• License: mit
• Created: 2020-11-05T13:17:42.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2023-08-14T11:07:50.000Z (about 1 year ago)
• Last Synced: 2024-06-17T23:43:55.443Z (5 months ago)
• Topics: discord, discord-rich-presence, discord-rpc, obsidian, obsidian-md, obsidian-plugin
• Language: TypeScript
• Homepage:
• Size: 49.8 KB
• Stars: 59
• Watchers: 2
• Forks: 9
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - lukeleppan/obsidian-discordrpc - Update your Discord Status to show your friends what you are working on in Obsidian. With Discord Rich Presence. (TypeScript)

README

        
## Obsidian Discord Rich Presence Plugin

![GitHub Workflow Status](https://img.shields.io/github/workflow/status/lukeleppan/obsidian-discordrpc/Build%20Release?logo=github&style=for-the-badge) ![GitHub release (latest by date)](https://img.shields.io/github/v/release/lukeleppan/obsidian-discordrpc?style=for-the-badge) ![GitHub All Releases](https://img.shields.io/github/downloads/lukeleppan/obsidian-discordrpc/total?style=for-the-badge)

Update your Discord Status to show your friends what you are working on in Obsidian. With Discord Rich Presence.

![Rich Presence Preview](https://raw.githubusercontent.com/lukeleppan/obsidian-discordrpc/master/assets/presence.gif)

### Usage

After enabling the plugin in settings, your Discord status should show that you are using Obsidian.md.

If Discord isn't open, then you will see "Reconnect to Discord" at the botton of the screen. You can click that to attempt to reconnect. It will only connect if Discord is open.

You can also reconnect to discord rich presence via the `Reconnect to Discord` command in the command palette. If there is an issue.

### Features

- Updates your Discord Status with Obsidian info, **Vault Name** and/or **Current File Name**.

- Allows you to customise what info is shown.

### Settings

#### Vault Name Settings

- Toggle whether or not to show **Vault Name**

- Set a custom **Vault Name** to show publicly

#### File Name Settings

- Toggle whether or not to show **Current File Name**

- Toggle whether or not to show the current file **extension**

#### Time Settings

- Toggle Whether or not to use the total time you have been using Obsidian, instead of the time spent editing a single file.

#### Notice Settings

- Toggle whether or not to show **Connection Notices**

### Contributors

#### @leoccyao

- Added the disconnect feature

- Made the plugin much more user friendly

### Issues

If you have any issues or suggestions please create an **issue** or a **pull request**.

### Compatibility

This plugin currently requires Obsidian v0.9.10+

### Install

You can install the plugin via the Community Plugins tab within Obsidian.

#### Manually installing the plugin

- Copy over `main.js`, `manifest.json` to your vault `VaultFolder/.obsidian/plugins/your-plugin-id/`.