README_EN.md
A cross-platform translator application (Telegram Group)
<hr/> <div align="center"> <h3><a href='./README.md'>中文</a> | English | <a href='./README_KR.md'> 한글 </a></h3> <table> <tr> <td> <td> <td> </table>
| 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 |
More Services see Plugin System
More Services see Plugin System
More Services see Plugin System
More Services see Plugin System
<div align="center">The built-in services are limited. But you can expand the app's functionality through the plugin system.
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.
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.
The Template section in the Plugin List provides plugin development templates for various plugins. Please check the corresponding template repo for specific documentation.
<div align="center">winget install Pylogmon.pot
Download the installation package ending in .exe from the Latest Release page.
pot_{version}_x64-setup.exepot_{version}_x86-setup.exepot_{version}_arm64-setup.exeDouble 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.
brew tap pot-app/homebrew-tap
brew install --cask pot
brew upgrade --cask pot
.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)"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.
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.
[!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=1environment variable to/etc/environment(or other places where environment variables are set) to turn off the use of DMABUF.
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
archlinuxcn, you can install directly using pacman:sudo pacman -S pot-translation
<a href='https://flathub.org/apps/com.pot_app.pot'> </a> <div align="center">[!WARNING] The tray icon is missing in Flatpak version.
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.
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
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"
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.
$CACHE/com.pot-app.desktop/pot_screenshot_cut.png127.0.0.1:port/ocr_recognize?screenshot=false to call
$CACHEis the system cache dir, e.g.C:\Users\{username}\AppData\Local\com.pot-app.desktop\pot_screenshot_cut.pngon Windows.
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"
Starry is still in the development stage, so you can only compile him manually
Github: ccslykx/Starry
<div align="center">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.
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
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.
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.
Node.js >= 18.0.0
pnpm >= 8.5.0
Rust >= 1.80.0
Clone the repository
git clone https://github.com/pot-app/pot-desktop.git
Install dependencies
cd pot-desktop
pnpm install
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
Development (Optional)
pnpm tauri dev # Run the app in development mode
Build
pnpm tauri build # Build into installation package