From 758842a0f487c88e64a2d703d1191c395782b6a8 Mon Sep 17 00:00:00 2001 From: Tim Brooks Date: Tue, 8 Oct 2019 21:24:35 +0100 Subject: [PATCH] Update readme with native messaging migration --- Cargo.lock | 2 +- Cargo.toml | 2 +- README.md | 28 ++++++++++++++++++---------- 3 files changed, 20 insertions(+), 12 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index 14d4c68..036d48f 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -46,7 +46,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index" [[package]] name = "wmc-win" -version = "0.2.1" +version = "0.2.2" dependencies = [ "inputbot 0.4.0 (registry+https://github.com/rust-lang/crates.io-index)", ] diff --git a/Cargo.toml b/Cargo.toml index 4ecbc52..60ea282 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -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 "] edition = "2018" diff --git a/README.md b/README.md index d2ce3b4..7c93d0b 100644 --- a/README.md +++ b/README.md @@ -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) @@ -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.