alleycat-link 0.4.4

Plover plugin for communication with AlleyCAT

AlleyCAT is a free, open-source computer-aided transcription (CAT) system for stenographers. It lets you write and edit documents such as court transcripts and translation dictionaries on both web and desktop. AlleyCAT originated as a free alternative to professional CAT software, which is proprietary and very expensive.

It is not intended to replace or compete with Plover, the open-source stenography engine; instead, it connects to Plover to leverage its existing ecosystem, such as the ability to use several brands of hobbyist, student, and professional steno writers, and plugins contributed by the community.

What even is a CAT system?

TL;DR: Think of it as like a word processor, but with steno integration.

CAT software allows you to write documents, usually court transcripts, using stenography. Each steno stroke is stored in the document alongside the text it translates to. The CAT system also lets you modify the document's layout, fix spelling errors or mistranslations, create cover pages and indexes, and more.

When you write into a CAT system with a steno writer, the steno notes are immutably linked with the translations, so that even when you go back and edit the document, the original steno notes remain intact. This is especially important for court reporters, since the steno notes are considered the primary source of truth.

While CAT software is primarily used by court reporters, some of these features could still be useful to students and hobbyists: for example, having all of your notes in one document linked to the original steno is great for identifying areas of improvement after a practice session.

Why "AlleyCAT"?

She's a free-range CAT: "no owner, no home, no rules." — @stenowitch, January 2022

Installation

Pre-built binaries for the latest stable version are available on the releases page. Download the corresponding package for your platform: .msi for Windows, .dmg for macOS, and .AppImage for Linux.

You can also build a bleeding-edge version of AlleyCAT from the source code. See the Development section below for more information.

If you just want to try AlleyCAT without installing, a web version is also available at alleycat.sammdot.ca. There are couple of caveats to this:

• Files can only be saved into your web browser's downloads folder
• AlleyCAT will not be able to connect to the Plover instance running on your computer, for security reasons [^1]

[^1]: Remote websites running inside a browser environment are typically blocked from connecting to anything running locally. I had originally implemented this using a WebSocket, but that only works when the website is also local.

Design

AlleyCAT is a hybrid web-desktop application built with Tauri, React, and TipTap. The majority of the application's code is written in TypeScript, and a smaller portion of it in Rust and Python. The core of AlleyCAT is a React application, wrapped in Tauri in order to allow it to run on a desktop. The Tauri side also allows it to perform platform-specific operations such as saving files to the disk.

AlleyCAT can talk to Plover with AlleyCAT Link (or Link for short), which is a Plover plugin that sends stroke and translation data over a local connection, either a Unix domain socket on macOS and Linux, or TCP port 2228[^2] on Windows.[^3] This lets AlleyCAT leverage Plover's existing ecosystem -- you can write into AlleyCAT with any machine Plover can support, in any system Plover can support, with your own dictionaries, and using any other plugins you may have installed. Link can be installed through pip or Plover's plugins manager.

[^2]: ACAT on a phone keypad :smile: [^3]: Windows does support named pipes, and more recent versions of Windows also support Unix domain sockets, but the tooling for working with both asynchronously (asyncio on the Python side, and Tokio on the Rust side) is not nearly as developed.

Development

Building the desktop app from source requires Node v16+ and Rust v1.64+; the web version requires only Node. Ensure yarn (and cargo on desktop) are installed before proceeding.

In order to connect AlleyCAT with Plover, you will also need a full Plover 4.0.0-dev10+ installation.

Project Structure

The repository has four main parts:

alleycat (this repository)
 ├─ alleycat_link
 ├─ app
 │   └─ src
 ├─ public
 └─ src

• /alleycat_link: Plover plugin
• /app/src: Tauri application (desktop only)
• /public: Static assets
• /src: React application (web and desktop)

Building from Source

Clone the repository:

$ git clone https://github.com/sammdot/alleycat.git
$ cd alleycat

Install all the dependencies, including TypeScript, React, and the Tauri CLI:

$ yarn install

On Linux, you will also need to install additional dependencies:

$ sudo apt-get update
$ sudo apt-get install -y libgtk-3-dev webkit2gtk-4.0 libappindicator3-dev librsvg2-dev patchelf

Development

To start a development server for just the web version:

$ yarn start

To start the desktop version for development:

$ yarn startapp

Both of these start a web server on localhost:3000. You should be able to access the web version from a browser even when running the desktop version.

To install the Plover plugin locally:

$ plover -s plover_plugins install -e .

where plover is the path to the main Plover binary (or plover_console.exe on Windows), then make sure to enable the alleycat_link extension in Plover, and allow network connections if needed.

Production

To build the web version for production:

$ yarn build

The generated files for the web version will be in the /build directory. These files can be served statically, and should also work offline.

To build the desktop version on your machine's platform:

$ yarn buildapp

The generated files for the desktop version will be in the /app/target/release directory. This may include a standalone application binary, an application bundle, and/or an installer package, depending on the platform. These files can be installed on your system or distributed.