Metadata-Version: 2.4
Name: plover-windows-input-method
Version: 0.3.0
Summary: Windows Text Input Processor (TIP) plugin for Plover
Home-page: https://github.com/sam0737/plover-windows-input-method
Author: Sam
License: GPL-2.0-or-later
Keywords: plover plover_plugin
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Plugins
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: GNU General Public License v2 or later (GPLv2+)
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: plover>=4.0.0
Dynamic: license-file

# plover-windows-input-method

A [Plover](https://github.com/openstenoproject/plover) plugin for Windows that sends stroke output through a Text Input Processor (TIP) using [Text Services Framework (TSF)](https://learn.microsoft.com/en-us/windows/win32/tsf/text-services-framework), instead of Plover’s default `SendInput` path.

**Why:** On Windows, stock Plover output relies on `SendInput` (key/backspace storms). That path is unreliable in many apps—wrong caret behavior, dropped or duplicated characters, and broken undo of previous output. This project replaces that with real TSF composition into the focused window, so updates and undos go through the input method like a normal IME.

It does **not** change Plover core. You install a small native tip (DLL) plus a Python plugin.

## Install and use

You need both pieces: the **native tip** (once, elevated) and the **Python plugin** (into Plover).

### 1. Install the native tip

Download the MSI from the latest [GitHub Release](https://github.com/sam0737/plover-windows-input-method/releases) and run it. The wizard explains what the tip is for; click Install and approve UAC when Windows asks. That installs `PloverTip.dll`, registers it with Windows, and adds **Plover** to your input methods. Pick **Plover** with Win+Space / the language bar when you want composition. The finish page reminds you about the Python plugin.

Installing a newer MSI automatically removes any previous TIP MSI first. If the DLL is still loaded (tip active in an app), close those apps or run `plover_tip_register.exe --deactivate`, then retry.

### 2. Install the Python plugin

In Plover: **Tools → Plugins Manager** → install **`plover-windows-input-method`** (from PyPI), then restart Plover if prompted.

### 3. Enable and configure

1. **Configure → Plugins** → enable **Windows input method**.
2. Choose a machine:
   - **Hardware steno** (Gemini, etc.): keep your usual machine; the extension only routes composition over the tip.
   - **QWERTY as steno via the tip:** **Configure → Machine → Windows Input Method Keyboard**.
3. Focus an app that supports TSF (e.g. Notepad) and select **Plover Tip** as the input method for that window.
4. Optional: **Tools → Windows Input Method Settings** (composition options, Steno/Normal defaults, Shift / Ctrl+Space toggles, Normal typing layout).

With the tip active, the extension enabled, and output on, strokes should appear as composition in the focused app—not as a `SendInput` backspace storm. The tip starts each app in **Normal** mode by default (language-bar **N**); switch to **Steno** with Shift alone, Ctrl+Space, or the language-bar button. Disable **Windows input method** under Plugins to fall back to stock `SendInput`.

## Documentation

- [docs/development.md](docs/development.md) — build tip from source, register, local MSI, harness
- [docs/deployment.md](docs/deployment.md) — cut a release (version bump on `main`, PyPI + GitHub)
- [windows/tip/README.md](windows/tip/README.md) — native TIP details (pipe protocol, harness gates, DLL-lock COM retarget)
- [windows/installer/README.md](windows/installer/README.md) — WiX MSI for the tip binaries

## License

[GNU GPL v2 or later](LICENSE) (same family as upstream Plover).
