Skip to content

A server for exposing Plover engine events and functionality

License

Notifications You must be signed in to change notification settings

nsmarkop/plover_websocket_server

Repository files navigation

Plover WebSocket Server

A WebSocket server for exposing Plover events.

This is currently under development and has the following known issues / limitations:

  • The host and port are not currently configurable and will always try to be on localhost:8086
  • Client connections may not be gracefully closed

Installation

TODO: This will be true once released. For now, you can only pip install this from source which requires running Plover from source to use.

Download the latest version of Plover for your operating system from the releases page. Only versions 4.0.0.dev8 and higher are supported.

  1. Open Plover
  2. Navigate to the Plugin Manager tool
  3. Select the "plover-websocket-server" plugin entry in the list
  4. Click install
  5. Restart Plover

The same method can be used for updating and uninstalling the plugin.

How to Use

TODO: Enable it in Configure -> Plugins then just connect to http://localhost:8086/websocket with your client and get the data pushed to you as event: data formatted JSON. Sending 'close' disconnects you. Will add more details and the exact APIs later in development.

About

A server for exposing Plover engine events and functionality

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages