GithubHelp home page GithubHelp logo

lukeleppan / obsidian-discordrpc Goto Github PK

View Code? Open in Web Editor NEW
61.0 2.0 9.0 51 KB

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

License: MIT License

TypeScript 95.45% JavaScript 4.55%
obsidian obsidian-md obsidian-plugin discord discord-rpc discord-rich-presence

obsidian-discordrpc's Introduction

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.

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

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.