Skip to content

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

License

Notifications You must be signed in to change notification settings

AhmedMohamedAbdelaty/obsidian-discordrpc

 
 

Repository files navigation

Obsidian Discord Rich Presence Plugin

GitHub Workflow Status GitHub release (latest by date) GitHub All Releases

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

Rich Presence Preview

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.

New Feature: Note Sharing Link

Note Sharing Link Screenshot

  • Adds a button with the text "Note Link" to the Discord Rich Presence if the current file contains a share_link tag and the public_note tag is set to "true". Screenshot
  • This feature is useful for sharing notes publicly using the Share Note plugin. If a note is shared, the link will be displayed in the Discord status, making it easier for others to access the shared note directly.
    • The public_note tag is used to determine whether the note is shared or not (you should set it to "true" manually if you want to share the note).

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/.

About

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

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 95.6%
  • JavaScript 4.4%