Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/crow-translate/crow-translate

A simple and lightweight translator that allows you to translate and speak text using Google, Yandex Bing, LibreTranslate and Lingva.
https://github.com/crow-translate/crow-translate

bing dbus-api google libretranslate lingva linux ocr qt5 translator windows yandex

Last synced: about 1 month ago
JSON representation

A simple and lightweight translator that allows you to translate and speak text using Google, Yandex Bing, LibreTranslate and Lingva.

Host: GitHub
URL: https://github.com/crow-translate/crow-translate
Owner: crow-translate
License: gpl-3.0
Archived: true
Created: 2018-02-23T11:41:36.000Z (over 6 years ago)
Default Branch: master
Last Pushed: 2024-07-04T15:06:19.000Z (4 months ago)
Last Synced: 2024-09-25T20:38:25.428Z (about 1 month ago)
Topics: bing, dbus-api, google, libretranslate, lingva, linux, ocr, qt5, translator, windows, yandex
Language: C++
Homepage: https://crow-translate.github.io/
Size: 27.1 MB
Stars: 1,818
Watchers: 31
Forks: 160
Open Issues: 106
Metadata Files:
- Readme: README.md
- License: COPYING

Awesome Lists containing this project

awesome-translations - Crow Translate - A simple and lightweight translator for Linux and Windows that allows to translate and speak text using Google, Yandex and Bing translate API. (Apps / Automated translation)
alternative-front-ends - Crow Translate - platform translator that allows translation using LibreTranslate, Lingva, Google, Bing, and Yandex, as well as text-to-speech using Google (Overview / Google Translate)

README

        > [!IMPORTANT]  

> The project has migrated under the KDE umbrella, and development will continue at https://invent.kde.org/office/crow-translate.

# ![Crow Translate logo](data/icons/app/48-apps-crow-translate.png) Crow Translate

[![GitHub (pre-)release](https://img.shields.io/github/release/crow-translate/crow-translate/all.svg)](https://github.com/crow-translate/crow-translate/releases)

[![Crowdin](https://badges.crowdin.net/crow-translate/localized.svg)](https://crowdin.com/project/crow-translate)

**Crow Translate** is a simple and lightweight translator written in **C++ / Qt** that allows you to translate and speak text using Google, Yandex, Bing, LibreTranslate and Lingva translate API.

You may also be interested in my library [QOnlineTranslator](https://github.com/crow-translate/QOnlineTranslator "A library for Qt5 that provides free usage of Google, Yandex, Bing, LibreTranslate and Lingva translate API.") used in this project.

## Content

- [Screenshots](#screenshots)

- [Features](#features)

- [Default keyboard shortcuts](#default-keyboard-shortcuts)

- [CLI commands](#cli-commands)

- [D-Bus API](#d-bus-api)

- [Global shortcuts in Wayland](#global-shortcuts-in-wayland)

- [Dependencies](#dependencies)

- [Icons](#icons)

- [Installation](#installation)

- [Building](#building)

- [Localization](#localization)

## Screenshots

**Plasma**



  



**Plasma Mobile**



  



**Windows 10**



  



## Features

- Translate and speak text from screen or selection

- Support 125 different languages

- Low memory consumption (~20MB)

- Highly customizable shortcuts

- Command-line interface with rich options

- D-Bus API

- Available for Linux and Windows

## Default keyboard shortcuts

You can change them in the settings. Some key sequences may not be available due to OS limitations.

Wayland does not support global shortcuts registration, but you can use [D-Bus](#d-bus-api) to bind actions in the system settings. For desktop environments that support [additional applications actions](https://specifications.freedesktop.org/desktop-entry-spec/desktop-entry-spec-latest.html#extra-actions) (KDE, for example) you will see them predefined in the system shortcut settings. You can also use them for X11 sessions, but you need to disable global shortcuts registration in the application settings to avoid conflicts.

### Global

| Key                                             | Description                        |

| ----------------------------------------------- | ---------------------------------- |

| Ctrl + Alt + E | Translate selected text            |

| Ctrl + Alt + S | Speak selected text                |

| Ctrl + Alt + F | Speak translation of selected text |

| Ctrl + Alt + G | Stop speaking                      |

| Ctrl + Alt + C | Show main window                   |

| Ctrl + Alt + I | Recognize text in screen area      |

| Ctrl + Alt + O | Translate text in screen area      |

### In main window

| Key                                               | Description                             |

| ------------------------------------------------- | --------------------------------------- |

| Ctrl + Return               | Translate                               |

| Ctrl + R                    | Swap languages                          |

| Ctrl + Q                    | Close window                            |

| Ctrl + S                    | Speak source / pause text speaking      |

| Ctrl + Shift + S | Speak translation / pause text speaking |

| Ctrl + Shift + C | Copy translation to clipboard           |

## CLI commands

The program also has a console interface.

**Usage:** `crow [options] text`

| Option                     | Description                                                                                                         |

| -------------------------- | ------------------------------------------------------------------------------------------------------------------- |

| `-h, --help`               | Display help                                                                                                        |

| `-v, --version`            | Display version information                                                                                         |

| `-c, --codes`              | Display language codes                                                                                              |

| `-s, --source `      | Specify the source language (by default, engine will try to determine the language on its own)                      |

| `-t, --translation ` | Specify the translation language(s), splitted by '+' (by default, the system language is used)                      |

| `-l, --locale `      | Specify the translator language (by default, the system language is used)                                           |

| `-e, --engine `    | Specify the translator engine ('google', 'yandex', 'bing', 'libretranslate' or 'lingva'), Google is used by default |

| `-p, --speak-translation`  | Speak the translation                                                                                               |

| `-u, --speak-source`       | Speak the source                                                                                                    |

| `-f, --file`               | Read source text from files. Arguments will be interpreted as file paths                                            |

| `-i, --stdin`              | Add stdin data to source text                                                                                       |

| `-a, --audio-only`         | Print text only for speaking when using `--speak-translation` or `--speak-source`                                   |

| `-b, --brief`              | Print only translations                                                                                             |

| `-j, --json`               | Print output formatted as JSON                                                                                      |


**Note:** If you do not pass startup arguments to the program, the GUI starts.

## D-Bus API

    io.crow_translate.CrowTranslate

    ├── /io/crow_translate/CrowTranslate/Ocr

    |   └── method void io.crow_translate.CrowTranslate.Ocr.setParameters(QVariantMap parameters);

    └── /io/crow_translate/CrowTranslate/MainWindow

        |   # Global shortcuts

        ├── method void io.crow_translate.CrowTranslate.MainWindow.translateSelection();

        ├── method void io.crow_translate.CrowTranslate.MainWindow.speakSelection();

        ├── method void io.crow_translate.CrowTranslate.MainWindow.speakTranslatedSelection();

        ├── method void io.crow_translate.CrowTranslate.MainWindow.playPauseSpeaking();

        ├── method void io.crow_translate.CrowTranslate.MainWindow.stopSpeaking();

        ├── method void io.crow_translate.CrowTranslate.MainWindow.open();

        ├── method void io.crow_translate.CrowTranslate.MainWindow.copyTranslatedSelection();

        ├── method void io.crow_translate.CrowTranslate.MainWindow.recognizeScreenArea();

        ├── method void io.crow_translate.CrowTranslate.MainWindow.translateScreenArea();

        ├── method void io.crow_translate.CrowTranslate.MainWindow.delayedRecognizeScreenArea();

        ├── method void io.crow_translate.CrowTranslate.MainWindow.delayedTranslateScreenArea();

        |   # Main window shortcuts

        ├── method void io.crow_translate.CrowTranslate.MainWindow.clearText();

        ├── method void io.crow_translate.CrowTranslate.MainWindow.cancelOperation();

        ├── method void io.crow_translate.CrowTranslate.MainWindow.swapLanguages();

        ├── method void io.crow_translate.CrowTranslate.MainWindow.openSettings();

        ├── method void io.crow_translate.CrowTranslate.MainWindow.setAutoTranslateEnabled(bool enabled);

        ├── method void io.crow_translate.CrowTranslate.MainWindow.copySourceText();

        ├── method void io.crow_translate.CrowTranslate.MainWindow.copyTranslation();

        ├── method void io.crow_translate.CrowTranslate.MainWindow.copyAllTranslationInfo();

        └── method void io.crow_translate.CrowTranslate.MainWindow.quit();

For example, you can show main window using `dbus-send`:

```bash

dbus-send --type=method_call --dest=io.crow_translate.CrowTranslate /io/crow_translate/CrowTranslate/MainWindow io.crow_translate.CrowTranslate.MainWindow.open

```

Or via `qdbus`:

```bash

qdbus io.crow_translate.CrowTranslate /io/crow_translate/CrowTranslate/MainWindow io.crow_translate.CrowTranslate.MainWindow.open

# or shorter

qdbus io.crow_translate.CrowTranslate /io/crow_translate/CrowTranslate/MainWindow open

```

## Global shortcuts in wayland

Wayland doesn't provide API for global shortcuts and you need to register them by yourself. 

### KDE

KDE have a convenient feature to define shortcuts in .desktop file and import them in settings. These shortcuts are already enabled and should work by default.

### GNOME

For GNOME you need to manually set D-Bus commands as global shortcuts. For example, to translate selected text use the following:

```bash

qdbus io.crow_translate.CrowTranslate /io/crow_translate/CrowTranslate/MainWindow translateSelection

```

You can set a hotkey for this command in GNOME system settings.

## Dependencies

### Required

- [CMake](https://cmake.org) 3.16+

- [Extra CMake Modules](https://github.com/KDE/extra-cmake-modules)

- [Qt](https://www.qt.io) 5.9+ with Widgets, Network, Multimedia, Concurrent, X11Extras (Linux), DBus (Linux) and WinExtras (Windows) modules

- [Tesseract](https://tesseract-ocr.github.io) 4.0+

- [Png2Ico](https://www.winterdrache.de/freeware/png2ico) or [IcoTool](https://www.nongnu.org/icoutils) for generating executable icon (Windows)

### Optional

- [KWayland](https://invent.kde.org/frameworks/kwayland)

### External libraries

This project uses the following external libraries, which included as git submodules:

- [QOnlineTranslator](https://github.com/crow-translate/QOnlineTranslator) - provides free usage of Google, Yandex and Bing translate API.

- [QGitTag](https://github.com/crow-translate/QGitTag) - uses the GitHub API to provide information about releases.

- [QHotkey](https://github.com/Skycoder42/QHotkey) - provides global shortcuts for desktop platforms.

- [QTaskbarControl](https://github.com/Skycoder42/QTaskbarControl) - to create a taskbar/launcher progress for all desktop platforms.

- [SingleApplication](https://github.com/itay-grudev/SingleApplication) - prevents launch of multiple application instances.

## Icons

[Fluent](https://github.com/vinceliuice/Fluent-icon-theme) icon theme is bundled to provide icons on Windows and fallback icons on Linux.

[circle-flags](https://github.com/HatScripts/circle-flags "A collection of 300+ minimal circular SVG country flags") icons are used for flags.

## Installation

Downloads are available on the [Releases](https://github.com/crow-translate/crow-translate/releases/latest) page. Also check out the [website](https://crow-translate.github.io/#installation) for other installation methods.

**Note:** On Linux to make the application look native on a non-KDE desktop environment, you need to configure Qt applications styling. This can be done by using [qt5ct](https://github.com/RomanVolak/qt5ct) or [adwaita-qt5](https://github.com/FedoraQt/adwaita-qt) or [qtstyleplugins](https://github.com/qt/qtstyleplugins). Please check the appropriate installation guide for your distribution.

**Note:** Windows requires [Microsoft Visual C++ Redistributable 2019](https://support.microsoft.com/en-us/topic/the-latest-supported-visual-c-downloads-2647da03-1eea-4433-9aff-95f26a218cc0) to work.

## Building

### Building executable

You can build **Crow Translate** by using the following commands:

```bash

mkdir build

cd build

cmake .. # Or `cmake -D CMAKE_BUILD_TYPE=Release ..` for single-configuration generators such as Ninja or GNU Make

cmake --build . # Or `cmake --build . --config Release` for multi-config generators such as Visual Studio Generators or Xcode

```

You will then get a binary named `crow`.

### Building a package using CPack

CMake can create [specified package types](https://cmake.org/cmake/help/latest/manual/cpack-generators.7.html) automatically.

If you use Makefile, Ninja, or Xcode generator you can use [package](https://cmake.org/cmake/help/latest/module/CPack.html#targets-package-and-package-source) target:

```bash

mkdir build

cd build

cmake -D CMAKE_BUILD_TYPE=Release -D CPACK_GENERATOR=DEB .. # You can specify several types of packages separated by semicolons in double quotes, for example: `CPACK_GENERATOR="DEB;ZIP;NSIS"`

cmake --build . --target package

```

Or you can use [CPack](https://cmake.org/cmake/help/latest/module/CPack.html) utility for any generators:

```bash

mkdir build

cd build

cmake .. # Or `cmake -D CMAKE_BUILD_TYPE=Release ..` for single-configuration generators such as Ninja or GNU Make

cpack -G DEB # Or `cpack -G DEB -C Release` for multi-config generators such as Visual Studio Generators or Xcode

```

On Windows you need [VCPKG](https://github.com/microsoft/vcpkg) to bundle all necessary DLLs.

### Build parameters

- `WITH_PORTABLE_MODE` - Enable portable functionality. If you create file named `settings.ini` in the app folder and Crow will store the configuration in it. It also adds the “Portable Mode” option to the application settings, which does the same.

- `WITH_KWAYLAND` - Find and use KWayland library for better Wayland integration.

Build parameters are passed at configuration stage: `cmake -D WITH_PORTABLE_MODE ..`.

## Localization

To help with localization you can use [Crowdin](https://crowdin.com/project/crow-translate) or translate files in `data/translations` with [Qt Linguist](https://doc.qt.io/Qt-5/linguist-translators.html) directly. To add a new language, write me on the Crowdin page or copy `data/translations/crow-translate.ts` to `data/translations/crow-translate__.ts`, translate it and send a pull request.