This is a plugin for Obsidian (https://obsidian.md).
This project integrates Obsidian, OBS, Zoom and automation tools to create whimsical experiences.
UUhimsy includes an Obsidian view and commands to add tags to slides created in the Slides Extended Plugin. Tags trigger automation actions. For example, a "scene" tag will change scenes in OBS when transitioning between slides.
There are many creative possibilties with UUhimsy.
The UUhimsy vault contains example for getting started.
This plugin has the following features.
- A settings page to configure OBS, OBS webSocket Server and an OSC Server
- A command to open the OBS app with launch parameters.
- A view and commands to add "Tags" to slides
- Creates a websocket connection between OBS and Apple Shortcuts
- Creates a websocket connection between OBS and ZoomOSC
- Creates a websocket connection between OBS and UVC-Util CLI
In the UUhimsy settings tab, configure the OBS launch parameters. The settings will be used in the "Open OBS" command.
| Settings | Value |
|---|---|
| IP | 'localhost' or the host machines IP |
| PORT | default 4455. |
| Password | set a secure password. |
| Settings | Value |
|---|---|
| Name | If multiple instances of OBS are installed enter the custom OBS name. |
| Folder Path | Windows Only. Enter the Folder Path to the OBS executable |
| Collection | Enter an OBS Scene Collection name |
| OBS Debug Port | OBS Browser Sources can be debugged at https://localhost:{Port}. Default Port = 9222 |
After configuring the settings, use the "UUhimsy: Open OBS" command to open OBS.
OBS should launch with the choosen parameters
- Command line executed by "Open OBS"
- MacOS:
open -n -a "{Name}" --args --collection "{Collection}" --remote-debugging-port={Debugging Port} --remote-allow-origins=http://localhost:{Debuggin Port} --websocket_port "{WSS Port}" --websocket_password "{WSS Password} --multi"
- Windows:
{App Name} --args --collection "{Collection}" --remote-debugging-port={Debugging Port} --remote-allow-origins=http://localhost:{Debugging Port} --websocket_port "{WSS Port}" --websocket_password "{WSS Password} --multi"
Once OBS opens, use the command "UUhimsy: Start OBS Connection"
Empty note files are stored in the "_slide_Tags" folder that represent tags.
The note file name format is "{Type} - {tagName}"
Open the Command Palette and choose a tag source.
| Slide tag | Command | Notes |
|---|---|---|
| OBS Scenes | "Get OBS Scene tags" | - A tag is made for each Scene starting with "scene|||" and - A tag is made for each Source in the "Input Camera" scene |
| Apple Shortcut | "Get Apple Shortcuts Tags" | - A tag is made for each Shortcut starting with "uu". MacOS only feature. |
| USB Camera: Pan, Tilt, Zoom | "Start sending camera PTZ position to OBS" | The utility application UVC-Util is included to retrieve Pan, Tilt, Zoom (PTZ) data from USB PTZ cameras. MacOS only feature. |
| ZoomOSC | "Start OSC to OBS Websocket connection" | ZoomOSC is a client by Zoom with an OSC interface. |
In a Slides Extended slide, position the cursor at the beginning of the slide. The insertion point on the first slide begins after the front matter. All other slides position the sursor after the slide break indicator, which is "---" by default.
Slide tags are inserted with the UUhimsy view or commands.
[!NOTE] Tag Types 'Exit' tags run when a slide transition starts 'Entrance' tags run when a slide transition ends
Inserting Tags with the UUhimsy View
Open the command palette, and choose "Insert slide exit tag" or "Insert slide entrance tag".
After choosing to insert a tag, then a list of tags appear in the command palette. Select the tag to insert
In the UUhimsy settings, click the "Add UUhimsy scripts to Slides Extended Template" button.
This plugin is a part of the UUhimsy system. The UUhimsy repo combines the 3 tools
