Skip to content

Latest commit

 

History

History
470 lines (308 loc) · 18.8 KB

README_EN.md

File metadata and controls

470 lines (308 loc) · 18.8 KB
Raw

Pot (A cute translator)

A cross-platform translator application (Telegram Group)

License Tauri JavaScript Rust Windows MacOS Linux


中文 | English

Table of Contents

Usage

Translation by selection Translate by input External calls
Select text and press the shortcut to translate Press shortcut to open translation window, translate by hitting Enter More efficient workflow by integrating other apps, see External Calls
Clipboard Listening Screenshot OCR Screenshot Translation
Click the top left icon on any translation panel to start clipboard listening. Copied text will be translated automatically. Press shortcut, select area to OCR Press shortcut, select area to translate

Features

Supported Services

Translation

More Services see Plugin System

Text Recognize

More Services see Plugin System

Text-to-Speech

More Services see Plugin System

Collection

More Services see Plugin System

Plugin System

The built-in services are limited. But you can expand the app's functionality through the plugin system.

Install Plugin

You can find plugins you need in the Plugin List, and then go to the plugin repo to download it.

The file extension of pot plugin is .potext. After downloading the .potext file, go to Preferences - Service Settings - Add External Plugin - Install External Plugin to select the corresponding .potext to install it. It will then be added to the service list and can be used like a built-in service.

Troubleshooting

  • The specified module could not be found (Windows)

    Errors like this occur because the system lacks C++ libraries，Go to here download and install it.

  • Not a valid Win32 application (Windows)

    An error like this indicates that you did not download the plugin for the corresponding system or architecture. Go to the plugin repository and download the correct plugin to solve the problem.

Develop Plugin

The Template section in the Plugin List provides plugin development templates for various plugins. Please check the corresponding template repo for specific documentation.

Installation

Windows

Install via Winget

winget install Pylogmon.pot

Install Manually

  1. Download the installation package ending in .exe from the Latest Release page.

    • 64-bit machine download pot_{version}_x64-setup.exe
    • 32-bit machine download pot_{version}_x86-setup.exe
    • arm64 machine download pot_{version}_arm64-setup.exe

  2. Double click the downloaded file to install it.

故障排除

  • There is no interface after startup, and there is no response when clicking the tray icon.

    Check if WebView2 is uninstalled/disabled, if so, install WebView2 manually or restore it.

    If the enterprise edition system is inconvenient to install or cannot install WebView2, please try to download the fix WebView2 version pot_{version} at [Release](https://github.com/pot-app/pot-desktop/releases/latest) _{arch}_fix_webview2_runtime-setup.exe

    If the issue persists, please try starting in Windows 7 compatibility mode.

MacOS

Install via Brew

  1. Add our tap:
brew tap pot-app/homebrew-tap
  1. Install pot:
brew install --cask pot
  1. Upgrade pot
brew upgrade --cask pot

Install Manually

  1. Download the installation package ending in .dmg from the Latest Release page. (If you are using M1, please download the installation package named pot_{version}_aarch64.dmg, otherwise download the installation package named pot_{version}_x64.dmg)
  2. Double click the downloaded file to install it.

Troubleshooting

  • "pot" can’t be opened because the developer cannot be verified.

    Click the Cancel button, then go to the Settings -> Privacy and Security page, click the Still Open button, and then click the Open button in the pop-up window. After that, there will be no more pop-up warnings when opening pot.

    If you cannot find the above options in Privacy & Security, or get error prompts such as broken files with Apple Silicon machines. Open Terminal.app and enter the following command (you may need to enter a password halfway through), then restart pot:

    sudo xattr -d com.apple.quarantine /Applications/pot.app

  • If you encounter a permission prompt every time you open it, or if you cannot perform a shortcut translation, please go to Settings -> Privacy & Security -> Supporting Features to remove pot, and then re-add pot.

Linux

Debian/Ubuntu

We provide deb packages for Linux.

Please note that: There are two deb package, universal is based on glibc2.28 and openssl-1.1, If the regular deb package can't run on your machine due to dependency problems, please download the universal package, Due to its low version dependency, it can run on most systems.

Arch/Manjaro

Warning

In newer version of Webkit2Gtk (2.42.0), Because Nvidia Proprietary drives are not fully implemented DMABUF, it will cause failure to start and crash.
Please downgrade or add the WEBKIT_DISABLE_DMABUF_RENDERER=1 environment variable to /etc/environment (or other places where environment variables are set) to turn off the use of DMABUF.

  1. View on AUR

Use aur helper：

yay -S pot-translation # or pot-translation-bin or pot-translation-git
# or
paru -S pot-translation # or pot-translation-bin or pot-translation-git
  1. If you are using archlinuxcn, you can install directly using pacman:
sudo pacman -S pot-translation

Flatpak

Warning

The tray icon is missing in Flatpak version.

Download on Flathub

External Calls

Pot provides a complete HTTP interface for integration with other software. You can call pot by sending HTTP requests to 127.0.0.1:port, where port is the listening port of pot, default to 60828, and can be changed in the app settings.

API Docs:

POST "/" => Translate given text (body is text to translate)
GET "/config" => Open settings
POST "/translate" => Translate given text (same as "/")
GET "/selection_translate" => Translate selected text
GET "/input_translate" => Open input translation
GET "/ocr_recognize" => Perform OCR on screenshot
GET "/ocr_translate" => Perform translation on screenshot
GET "/ocr_recognize?screenshot=false" => OCR without taking screenshot
GET "/ocr_translate?screenshot=false" => Translate screenshot without taking screenshot
GET "/ocr_recognize?screenshot=true" => OCR with screenshot
GET "/ocr_translate?screenshot=true" => Translate screenshot

Example:

  • Call translation by selection:

    To call pot's translation by selection, simply send a request to 127.0.0.1:port:

    E.g. using curl:

    curl "127.0.0.1:60828/selection_translate"

OCR without internal screenshot

This allows you to perform OCR/translation without using pot's internal screenshot, so you can use your own screenshot tools. It also solves the problem where pot's internal screenshot doesn't work on some platforms.

Workflow:

  1. Take screenshot using other tool
  2. Save screenshot to $CACHE/com.pot-app.desktop/pot_screenshot_cut.png
  3. Send request to 127.0.0.1:port/ocr_recognize?screenshot=false to call

$CACHE is the system cache dir, e.g. C:\Users\{username}\AppData\Local\com.pot-app.desktop\pot_screenshot_cut.png on Windows.

Example

OCR using Flameshot on Linux:

rm ~/.cache/com.pot-app.desktop/pot_screenshot_cut.png && flameshot gui -s -p ~/.cache/com.pot-app.desktop/pot_screenshot_cut.png && curl "127.0.0.1:60828/ocr_recognize?screenshot=false"

Existing Usages (Quick selection translation)

SnipDo (Windows)

  1. Download and install SnipDo in the Microsoft Store
  2. Download the SnipDo extension of pot from the Latest Release (pot.pbar)
  3. Double click the downloaded file to install it.
  4. Selection some text, you can see the pot icon in the upper right corner of the selection, click the icon to translate.

PopClip (MacOS)

  1. Download and install PopClip in the App Store
  2. Download the PopClip extension of pot from the Latest Release (pot.popclipextz)
  3. Double click the downloaded file to install it.
  4. Enable the pot extension in PopClip settings, and then you can translate by selecting text.

Starry (Linux)

Starry is still in the development stage, so you can only compile him manually

Github: ccslykx/Starry

Wayland Support

Due to the varying levels of support for Wayland among different distributions, pot itself cannot achieve perfect compatibility. However, here are some solutions to common issues that can be implemented through proper configuration, allowing pot to run flawlessly on Wayland.

Shortcut key cannot be used

Due to Tauri's lack of support for Wayland, the shortcut key scheme in the pot application cannot be used under Wayland. You can set the system shortcut and send a request with curl to call pot, see External Calls for details

Screenshot doesn't work

In some pure Wayland desktop environments/window managers (such as Hyprland), the built-in screenshot feature of pot cannot be used. In this case, you can use other screenshot tools instead. For more details, please refer to the section Not Using Built-in Screenshot.

Below is a configuration example for Hyprland using grim and slurp to achieve screenshot functionality:

bind = ALT, X, exec, grim -g "$(slurp)" ~/.cache/com.pot-app.desktop/pot_screenshot_cut.png && curl "127.0.0.1:60828/ocr_recognize?screenshot=false"
bind = ALT, C, exec, grim -g "$(slurp)" ~/.cache/com.pot-app.desktop/pot_screenshot_cut.png && curl "127.0.0.1:60828/ocr_translate?screenshot=false"

Other desktop environments/window managers also have similar operations.

The translation window follows the mouse position.

Due to the current inability of pot to obtain accurate mouse coordinates under Wayland, its internal implementation cannot function properly. For certain desktop environments/window managers, it is possible to achieve window following mouse position by setting window rules. Here we take Hyprland as an example:

windowrulev2 = float, class:(pot), title:(Translator|OCR|PopClip|Screenshot Translate) # Translation window floating
windowrulev2 = move cursor 0 0, class:(pot), title:(Translator|PopClip|Screenshot Translate) # Translation window follows the mouse position.

Internationalization(Weblate)

Contributors

Manual compilation

Requirements

Node.js >= 18.0.0

pnpm >= 8.5.0

Rust >= 1.70.0

Start compilation

  1. Clone the repository

    git clone https://github.com/pot-app/pot-desktop.git

  2. Install dependencies

    cd pot-desktop
pnpm install

  3. Install dependencies(Only Linux)

    sudo apt-get install -y libgtk-3-dev libwebkit2gtk-4.0-dev libayatana-appindicator3-dev librsvg2-dev patchelf libxdo-dev libxcb1 libxrandr2 libdbus-1-3

  4. Development (Optional)

    pnpm tauri dev # Run the app in development mode

  5. Build

    pnpm tauri build # Build into installation package

Acknowledgement