Improve Usage Documentation

[draptik]

I can use this so (from my laptop, hooked up to TV via HDMI):

wl-present mirror eDP-1

Then I move the new window to the TV-screen. Working in Sway.

Can some power users share there configs, because my usage seems sub-par.

[Ferdi265]

Hi! I personally use the wl-present config snippet from the README:

• I first connect a TV or projector and enable it in sway.
• Then I move the focus over to the external monitor.
• Then I press $mod+P followed by M to start mirroring.
• Then I select the internal monitor with slurp by clicking on it.
• This then opens wl-mirror on the external monitor, which I then manually fullscreen.
• (You can add a window rule to your sway config to automatically fullscreen. I haven't tested it, but for_window [app_id="at.yrlf.wl-mirror"] fullscreen should work)

If you use wl-present, you can then do additional things such as press $mod+P followed by R and then select a region on your screen by clicking and dragging a rectangle that is then mirrored to the other screen.

Sometimes I also mirror the other way round (create a floating wl-mirror window on my internal screen that shows the TV / projector screen). That way I can have notes next to / below the wl-mirror window on my internal screen, which other people following the presentation don't see.

I know the usage is a bit clunky still, and if people have good ways to automate things as configs or scripts, I would like to incorporate ideas into wl-present or the example config, or ship additional scripts.

[draptik]

Thanks for the detailed description! 2 things were missing for me: I had to patch my kanshi config, and more importantly, going into fullscreen mode after selecting the newly created mirrored window. I still have to move the new mirror to the external monitor manually, but your setup works like a charm otherwise! Thanks!

[Ferdi265]

Technically I think you can make a kanshi profile that automatically creates a wl-mirror window on the correct output using exec in the profile:

Since I think a few commits, wl-present has the option to pass extra arguments after the mirror subcommand: for example wl-present mirror eDP-1 --fullscreen --fullscreen-output HDMI-A-1. This would make wl-mirror open in fullscreen automatically on the HDMI output, mirroring the eDP-1 output.

If you have that, you can probably very easily switch to mirroring with something like kanshictl switch mirror-hdmi or whatever your profile is called.

[Ferdi265]

I think I need to release the wl-present changes still, that isn't in 0.16.3 yet, maybe I'll make an 0.16.4 in the next few days.

you can probably hack it in current wl-present with wl-present mirror eDP-1 & sleep .5; wl-present fullscreen-output HDMI-A-1; wl-present fullscreen

[Ferdi265]

I added an example kanshi configuration to the README.

Hi! I personally use the wl-present config snippet from the README:

* I first connect a TV or projector and enable it in sway.

* Then I move the focus over to the external monitor.

* Then I press `$mod+P` followed by `M` to start mirroring.

* Then I select the internal monitor with slurp by clicking on it.

* This then opens wl-mirror on the external monitor, which I then manually fullscreen.

* (You can add a window rule to your sway config to automatically fullscreen. I haven't tested it, but `for_window [app_id="at.yrlf.wl-mirror"] fullscreen` should work)

If you use wl-present, you can then do additional things such as press $mod+P followed by R and then select a region on your screen by clicking and dragging a rectangle that is then mirrored to the other screen.

Sometimes I also mirror the other way round (create a floating wl-mirror window on my internal screen that shows the TV / projector screen). That way I can have notes next to / below the wl-mirror window on my internal screen, which other people following the presentation don't see.

I know the usage is a bit clunky still, and if people have good ways to automate things as configs or scripts, I would like to incorporate ideas into wl-present or the example config, or ship additional scripts.

@draptik Do you think a short usage explanation such as this one could be a good addition to the README? Would a USAGE.md with multiple different use-cases and guiding screenshots be even better?

I think the README might also need the --help output from wl-present, since that is currently completely missing.

[draptik]

sorry for the late reply @Ferdi265 Yes, this helped me, so it might also help other people ;-)

[Ferdi265]

Alright, then I'll keep this open until I have expanded the documentation accordingly.