Skip to content

Commit c095eba

Browse files
Update readme
1 parent 4c5cae6 commit c095eba

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

readme.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -62,16 +62,18 @@ Inspired by [tryptech](https://github.com/tryptech)'s [obs-zoom-and-follow](http
6262
* **More Info**: Show this text in the script log
6363
* **Enable debug logging**: Show additional debug information in the script log
6464

65-
1. If you have [ljsocket.lua](https://github.com/BlankSourceCode/obs-zoom-to-mouse-remote) in the same directory as `obs-zoom-to-mouse.lua`, the following settings will also be available:
65+
1. In OBS, open File -> Settings -> Hotkeys
66+
* Add a hotkey for `Toggle zoom to mouse` to zoom in and out
67+
* Add a hotkey for `Toggle follow mouse during zoom` to turn mouse tracking on and off (*Optional*)
68+
69+
### Dual Machine Support
70+
1. The script also has some **basic** dual machine setup support. By using my related project [obs-zoom-to-mouse-remote](https://github.com/BlankSourceCode/obs-zoom-to-mouse-remote) you will be able to track the mouse on your second machine
71+
1. When you have [ljsocket.lua](https://github.com/BlankSourceCode/obs-zoom-to-mouse-remote) in the same directory as `obs-zoom-to-mouse.lua`, the following settings will also be available:
6672
* **Enable remote mouse listener**: True to start a UDP socket server that will listen for mouse position messages from a remote client
6773
* **Port**: The port number to use for the socket server
6874
* **Poll Delay**: The time between updating the mouse position (in milliseconds)
6975
* For more information see [obs-zoom-to-mouse-remote](https://github.com/BlankSourceCode/obs-zoom-to-mouse-remote)
7076

71-
1. In OBS, open File -> Settings -> Hotkeys
72-
* Add a hotkey for `Toggle zoom to mouse` to zoom in and out
73-
* Add a hotkey for `Toggle follow mouse during zoom` to turn mouse tracking on and off (*Optional*)
74-
7577
### More information on how mouse tracking works
7678
When you press the `Toggle zoom` hotkey the script will use the current mouse position as the center of the zoom. The script will then animate the width/height values of a crop/pan filter so it appears to zoom into that location. If you have `Auto follow mouse` turned on, then the x/y values of the filter will also change to keep the mouse in view as it is animating the zoom. Once the animation is complete, the script gives you a "safe zone" to move your cursor in without it moving the "camera". The idea was that you'd want to zoom in somewhere and move your mouse around to highlight code or whatever, without the screen moving so it would be easier to read text in the video.
7779

0 commit comments

Comments
 (0)