enObsidian

A StreamDock plugin which could help you open notes, run obsidian commands, search notes, switch workspace and tabs, or navigate through daily and weekly notes by date.

🌟 Highlight

1. Support both keypad and dial function.
2. Cold launch any note, any vault.
3. Run all the obsidian commands you want.
4. Visible validation, all the critical parameters have a notice.
5. Beautiful and elegant icon pack design.
6. Multiple languages support.

📦 Installation

1. Download from MiraBox Space

1. Install Local-REST-API, Advanced URI, Periodic Notes plugin on Obsidian.
2. Download obsidian-for-streamdock directly from MiraBox Space.

2. Manual Installation

1. Install Local-REST-API, Advanced URI, Periodic Notes plugin on Obsidian.
2. Download the .sdPlugin file from the release page.
3. Double click it to install.

🚀 Usage

Tip

• You could get the API Key from local-REST-API setting page.
• For enObsidian v2.x, see README_v2.md.

Plugin Setting

1. Add a Plugin Setting action, select a Vault ID, then fill in Vault Name / API Key / Port / HTTPS and click Save.
2. In other actions, select the same Vault ID to reuse those values.
3. Most actions no longer require entering Vault Name directly; it is resolved from the selected Vault ID.

Keypad

Open Daily Note

1. The action will open your daily note directly even if obsidian did not open.
2. With Auto Mode enabled, the plugin opens the daily note in a new pane and focuses it if it is already open.

Check In

1. Enter the property name that you want to check.
2. The action will set the property to True.
3. This can be useful for habit check.

Unique Note

1. Enable the Unique note creator core plugin.
2. Select where to open the note via Pane Type.
3. This action requires obsidian v1.13.3.

Open Note

2. Enter the unique note name, or note relative path to Note Path, the plugin will auto encode it.

3. Files that aren't in .md format must have an extension.

4. Support open note when the obsidian did not open.

5. When Auto Mode is enabled, the plugin opens the note in a new pane and focuses on it if it's already open.

   See showcase for inspiration.

Vault Switcher

1. The action will open the Obsidian vault switcher window.

Open Vault

1. Select the Vault you want to open.
2. This is helpful when you have multiple vaults.
3. Support cold launch.

Note Finder

1. Choose the type you want to search (all, tag, task, file, path, property). If you select task, you can also specify a task status to match.
2. Enter the search query, or provide a property name and value if you've selected property. Note that hashtag(#) is not required for tag searches.

Web Viewer

1. This function requires Obsidian version v1.8 or later. Additionally, you need to enable the Web Viewer plugin in the Obsidian settings.

Web Searcher

2. This function requires Obsidian version v1.8 or later. Additionally, you need to enable the Web Viewer plugin in the Obsidian settings.
3. Recommend using AI search engines like https://metaso.cn/?q=%s.

Run Command

1. Enter the Command ID. You can get the ID from Local REST API for Obsidian.

   See showcase for inspiration.

Toggle Color Scheme

1. Toggle Obsidian's color scheme between Light and Dark.
2. The action icon and title will auto change to fit the current color scheme.
3. Use the Switch button if you find the color scheme not match.

Load Workspace

1. This is useful when you have multiple workspace.
2. This function requires Obsidian Advanced URI plugin, install it before use.

Settings Navigator

2. Enter the plugin ID. You could get it from community plugin list.

3. You could use this function to open community plugins setting quickly.

4. This function requires Obsidian Advanced URI plugin, install it before use.

   See showcase for inspiration.

Dial

Switch Tab

2. Use the dial to switch between tabs.

Web Zoom

2. Use the dial to zoom in, zoom out or reset zoom in Web Viewer.

Zoom

2. Use the dial to zoom in, zoom out or reset zoom.

Note Navigator

1. Select the note type to navigate (Daily/Weekly), the title will automatically updates based on it.
2. Use the dial to navigate through daily and weekly notes by date.
3. This function relies on the Obsidian plugin Periodic Notes for navigation. Make sure to install and enable it.

🤝 Credits

Thanks to @data-enabler, his streamdeck-web-requests served as the base for this plugin.