A guide to making whimsical presentations with Obsidian and OBS. Combine Obsidian, OBS, Zoom, Javascript and automation tools to create presentations to entertain and engage your audience.
This repo includes an Obsidian Vault and Plugin and an OBS Scene Collection.
The examples in this repository feature the javaScript libraries P5.js and Cables.gl. Both are free and open source tools for making beautiful interactive content.
Table of Contents
- UUhimsy Features
- Required Software
- Setup Obsidian
- Setup OBS
- Keyboard and Mouse Visual Overlay
- Get User Media
- Using F13 - F24 keys in Windows
-
Trigger OBS automation with Reveal.js Slides, Zoom meeting actions, Midi Devices, Game Controllers, MediaPipe and more.
-
A "Teleprompter" for scrolling slide notes
-
Screen Share
- Mouse visual overlay
- Keyboard Overlay
- Follow Mouse
- Zoom in on mouse
To use all the features enabled by UUhimsy, first install the required Apps and Plugins All the required software is free to download and use.
| Obsidian |
|---|
| Obsidian plugins are downloaded in app |
| 🔌 UUhimsy (Included in this repo, not yet available as a Community Plugin) |
| 🔌 Slides Extended |
| 🔌 Templater |
| 🔌 Dataview |
| 🔌 Kanban |
| OBS |
|---|
| OBS |
| OBS plugins |
| 🔌 Source Dock |
| 🔌 Source Clone |
| 🔌 Move Transition |
| 🔌 Advanced Scene Switcher |
| 🔌 Advanced Mask |
| 🔌 Composite Blur |
| 🔌 Stroke Glow Shadow |
| 🔌 Stroke Glow Shadow |
| Optional Plugins |
| 🔌 Downstream Keyer |
| 🔌 mac-background removal |
| 🔌 LocalVocal |
JavaScripts Libraries used by UUhimsy
The JavaScript libraries used by UUhimsy are included in this repo.
P5js,
cables,
Revealjs,
teleprompter
Download and Install Obsidian and the required Community Plugins.
Connect to OBS
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 |
The UUhimsy Plugin features a command to open OBS.
Open the command palette and enter "Open OBS"
OBS should launch with the choosen parameters
UUhimsy uses slide tags to automate actions when a slide transitions. For example, use a slide to change scenes in OBS when a slide transition starts.
In the UUhimsy settings, click the "Add UUhimsy scripts to Slides Extended Template" button.
Slide tags are created with commands. Open the Command Palette and choose a UUhimsy action.
| 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 "uuhimsy". 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. UUhimsy includes an OSC to WebSocket interface. |
In a Slides Extended slide, position the cursor above the slide break indicator "---". Open the command palette, and choose "Insert slide exit tag" or "Insert slide entrance tag".
[!NOTE] Tag Types 'Exit' tags run when a slide transition starts 'Entrance' tags run when a slide transition ends
After choosing to insert a tag, then a list of tags appear in the command palette. Select the tag to insert
Download OBS and the required plugins.
Note
macOS Installing plug-in note:
- After Downloading a plug-in, expand the .zip file and in the expanded folder click to open the installer for your Mac.
- A warning will appear that Apple could not verify the plug-in. Click the "Done" button
- Go to System Settings,
- choose Privacy & Security settings.
- scroll to the bottom of the settings page.
- click "Open Anyway"
In Obsidian, use the Templater command "Open insert template modal". In the modal window select "Open Get User Media Page"
This will open the "Get User Media Page" using the Slides Extended local server.
PowerToys Keymanager file location "%USERPROFILE%\AppData\Local\Microsoft\PowerToys\Keyboard Manager\default.json" replace the default.json file's content with the key mapping file in this repo.