Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alex1701c/emojirunner
Search for emojis in Krunner and copy/paste them
https://github.com/alex1701c/emojirunner
c-plus-plus emoji emoji-picker kde krunner plasma5 qt5
Last synced: 6 days ago
JSON representation
Search for emojis in Krunner and copy/paste them
- Host: GitHub
- URL: https://github.com/alex1701c/emojirunner
- Owner: alex1701c
- License: gpl-3.0
- Created: 2019-07-17T14:11:18.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-11-03T16:05:05.000Z (2 months ago)
- Last Synced: 2024-12-26T12:07:17.399Z (13 days ago)
- Topics: c-plus-plus, emoji, emoji-picker, kde, krunner, plasma5, qt5
- Language: C++
- Homepage:
- Size: 287 KB
- Stars: 50
- Watchers: 3
- Forks: 7
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Emoji Runner
- Support for Plasma5 and Plasma6!
- [Search emojis](#user-content-search-for-an-emoji-by-name) and copy & paste them
- Configure [favourite emojis](#show-favourites)
- Set unicode version
- Enable/disable categories
- [Add custom emojis](#add-a-custom-emoji)
You can build this package from source or use the deb/rpm packages from [the releases page](https://github.com/alex1701c/EmojiRunner/releases).
### Required Dependencies
**Note**: If the `xdo.h` file is not at compile time available the plugin will use the `xdotool` program to paste emojis,
but having the library installed is recommended.
Debian/Ubuntu
Plasma5:
```bash install-ubuntu-plasma5
sudo apt install git cmake extra-cmake-modules build-essential gettext libkf5runner-dev qtdeclarative5-dev gettext libxdo-dev libkf5kcmutils-dev libkf5dbusaddons-bin
```
Plasma6:
```bash install-ubuntu-plasma6
sudo apt install git cmake extra-cmake-modules build-essential gettext libkf6runner-dev libxdo-dev libkf6kcmutils-dev libkf6dbusaddons-bin
```
OpenSUSE
Plasma5:
```bash install-opensuse-plasma5
sudo zypper install git cmake extra-cmake-modules ki18n-devel krunner-devel kconfigwidgets-devel kcmutils-devel gettext-tools xdotool-devel kdbusaddons-tools
```
Plasma6:
```bash install-opensuse-plasma6
sudo zypper install git cmake kf6-extra-cmake-modules kf6-ki18n-devel kf6-krunner-devel gettext-tools xdotool-devel kf6-kconfigwidgets-devel kf6-kcmutils-devel kf6-kdbusaddons-tools
```
Fedora
Plasma5:
```bash install-fedora-plasma5
sudo dnf install git cmake extra-cmake-modules gettext kf5-ki18n-devel kf5-krunner-devel kf5-kcmutils-devel libxdo-devel
```
Plasma6:
```bash install-fedora-plasma6
sudo dnf install git cmake gettext extra-cmake-modules kf6-ki18n-devel kf6-krunner-devel kf6-kcmutils-devel libxdo-devel
```
Arch (Manjaro)
```bash
sudo pacman -S cmake extra-cmake-modules xdotool kcmutils
```
*This xdotool package includes the xdo.h file*
### Build instructions
#### Option A: Easy oneliner method
```bash
curl https://raw.githubusercontent.com/alex1701c/EmojiRunner/master/install.sh | bash
```
#### Option B: Get it from the [AUR](https://aur.archlinux.org/packages/plasma6-runners-emojirunner)
#### Option C: Manual installation method
```bash
git clone https://github.com/alex1701c/EmojiRunner
cd EmojiRunner
bash install.sh
```
**Info:** The `emoji.json` file is a modified version from [gemoji](https://github.com/github/gemoji).
### Enable Shortcuts
This project has a EmojiRunnerCommands.khotkeys file.
This file contains two shortcuts (of course you can change them):
- `Ctrl` + `Alt` + `Space` Shows only EmojiRunner and favourites,
if one emoji is selected it gets pasted to the current text input (demonstrated in gif).
For this the Runner emits the `Ctrl` + `V` key combination using xdotool
- `Ctrl` + `Alt` + `Shift` + `Space` Same as above except the favourites are not shown
These shortcuts start Krunner using qdbus. For example the command to launch the favourites is:
`qdbus org.kde.krunner /App org.kde.krunner.App.querySingleRunner "emojirunner" "emoji "`
You can import them in the System Settings module "Custom Shortcuts" by clicking on edit and then import.
The feature to paste the emojis can be disabled in the config dialog.
### Screenshots:
#### Search for an emoji by name
This global search can be enabled/disabled in the config dialog.
Additionally this screenshot shows the paste action, which is a new feature.
#### Show favourites
They are configured in the config dialog
#### Search for emojis
This way you can search for emojis without search results from other plugins
#### Configure settings
You can search for emojis, set the unicode level (later versions can not be displayed) and you can enable/disable categories.
Additionally you can sort the favourites using drag and drop
#### Add a custom emoji
You must provide a name and and emoji, the description and tags are optional
This gets saved in the ~/.local/share/emojirunner/customemojis.json file.
# Issues
- If you don't have colorful emojis please try [this solution](https://github.com/alex1701c/EmojiRunner/issues/1/).
- If the emojis do not get pasted try to increase the timeout for the pasting action by adding `pasteTimeout=timeout_in_ms` to the `[Config]` group in `~/.config/krunnerplugins/emojirunnerrc`.
If you have any other issues please let me know 😄.