Skip to content

Commit

Permalink
Update readme with native messaging migration
Browse files Browse the repository at this point in the history
  • Loading branch information
brookst committed Oct 8, 2019
1 parent 54422d9 commit 758842a
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 12 deletions.
2 changes: 1 addition & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name = "wmc-win"
description = "Windows native application for controlling media playback within web browsers via the web-media-controller extension"
homepage = "https://github.com/brookst/wmc-win#web-media-controller-windows-wmc-win"
license-file = "LICENSE"
version = "0.2.1"
version = "0.2.2"
authors = ["Tim Brooks <[email protected]>"]
edition = "2018"

Expand Down
28 changes: 18 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,15 @@
# Web Media Controller Windows (wmc-win)

wmc-win is a native Windows application for controlling media playback within web browsers.
It uses the [Web Media Controller](https://github.com/f1u77y/web-media-controller) browser extension to interface with Firefox ([Mozilla Add-on](https://addons.mozilla.org/en-US/firefox/addon/web-media-controller/)).
wmc-win is a native Windows extension for controlling media playback within web browsers.
It uses the [Web Media Controller](https://github.com/f1u77y/web-media-controller) browser extension to interface with Firefox ([Mozilla Add-on](https://addons.mozilla.org/en-US/firefox/addon/web-media-controller/)) and Chrome/Chromium.

## Installation
A Windows MSI package is available on the [GitHub releases page](https://github.com/brookst/wmc-win/releases/latest).
Run the MSI to install wmc-win and configure web browsers to find it.
Don't forget to install [Web Media Controller](https://github.com/f1u77y/web-media-controller) into your browser!

## Usage
wmc-win is a console application that should be started before your browser.
wmc-win is a native extension started by [Web Media Controller](https://github.com/f1u77y/web-media-controller) in the web browser.
Currently, wmc-win listens for the following keys:

* [`VK_MEDIA_NEXT_TRACK`](https://referencesource.microsoft.com/windowsbase/R/5069862b166d95f1.html)
Expand All @@ -14,13 +19,16 @@ Currently, wmc-win listens for the following keys:

## Notes

### Native Messaging
web-media-controller currently uses websockets on Windows, to support the rainmeter plugin.
These are some notes on native messaging, in case a native messaging adapter is added for Windows.
### Continuous Integration
[![AppVeyor](https://ci.appveyor.com/api/projects/status/github/brookst/wmc-win?branch=master&svg=true)](https://ci.appveyor.com/project/brookst/wmc-win)
PRs, `master` and tags are built on [Appveyor](https://ci.appveyor.com/project/brookst/wmc-win).
Tags get packaged with [`cargo-wix`](https://github.com/volks73/cargo-wix) and deployed to the [GitHub release page](https://github.com/brookst/wmc-win/releases/latest).

Firefox locates native messaging binaries from the Windows registry, via JSON manifests.
Set the appropriate registry key with the following:
### Native Messaging
Firefox and Chrome/Chromium locate native messaging binaries from the Windows registry, via JSON manifests.
Set the appropriate registry keys with the following:

reg add HKEY_CURRENT_USER\SOFTWARE\Mozilla\NativeMessagingHosts\me.f1u77y.web_media_controller /t REG_SZ /d C:\Users\user\dev\wmc-win\manifests\me.f1u77y.web_media_controller.firefox.json
reg add HKEY_CURRENT_USER\SOFTWARE\Mozilla\NativeMessagingHosts\me.f1u77y.web_media_controller /t REG_SZ /d C:\Users\user\AppData\Local\wmc-win\me.f1u77y.web_media_controller.firefox.json
reg add HKEY_CURRENT_USER\SOFTWARE\Google\Chrome\NativeMessagingHosts\me.f1u77y.web_media_controller /t REG_SZ /d C:\Users\user\AppData\Local\wmc-win\me.f1u77y.web_media_controller.chromium.json

Make sure the path in the JSON manifest does point to the binary location.
Make sure the `path` in the JSON manifest does point to the binary location.

0 comments on commit 758842a

Please sign in to comment.