System-wide character-picker: emoji and unicode shell extensions for rofi
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

README.md 5.3KB

2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283
  1. # rofiemoji-rofiunicode
  2. Inspired by [fdw/**rofimoji**](https://github.com/fdw/rofimoji) and forked from its script version [nkoehring/**rofiemoji**](https://github.com/nkoehring/rofiemoji), **rofiemoji-rofiunicode** is a character-picker that combines two scripts to search and copy emojis or unicode characters directly from [davatorium/**rofi**](https://github.com/davatorium/rofi).
  3. It comes with an example configuration file and theme that should make it ready to use without user configuration, even for those who never used rofi before. When using the recommended procedure, unicode and emoji lists show up as separate tabs when rofi is invoked:
  4. ![rofiemoji-rofiunicode1](https://github.com/Kabouik/rofiemoji-rofiunicode/blob/master/rofiemoji-rofiunicode1.png?raw=true)
  5. ![rofiemoji-rofiunicode2](https://github.com/Kabouik/rofiemoji-rofiunicode/blob/master/rofiemoji-rofiunicode2.png?raw=true)
  6. The two underlying scripts, `rofiemoji.sh` and `rofiunicode.sh`, will try to download the lists of emoji and unicode characters if they are missing, but this should already been taken care of when cloning this repository. The list of emojis is fetched from www.unicode.org while the unicode list was created by [/u/fe80c0ffee](https://www.reddit.com/r/unixporn/comments/7zqkov/oc_i_mad_a_rofi_emoji_picker_and_i_feel_bad_about/duqls53?utm_source=share&utm_medium=web2x).
  7. ## Prerequisites
  8. * `rofi` from [davatorium/**rofi**](https://github.com/davatorium/rofi) but probably available in your package manager as well.
  9. * `xsel` to copy the selection to the clipboard. You should find it in your package manager.
  10. * An emoji capable font, *e.g.*, [Noto Emoji](https://www.google.com/get/noto/#emoji-zsye) or [Noto Color Emoji](https://www.google.com/get/noto/#emoji-zsye-color).
  11. ## Installation
  12. 1. Clone this repository into `~/.config`:
  13. ```bash
  14. cd ~/.config # Using this path is important for next steps
  15. git clone https://github.com/Kabouik/rofiemoji-rofiunicode.git
  16. ```
  17. 2. (Optional) Apply the [recommended configuration](https://github.com/Kabouik/rofiemoji-rofiunicode#recommended-configuration):
  18. ```bash
  19. mv $HOME/.config/rofi/config $HOME/.config/rofi/config.back
  20. cp $HOME/.config/rofiemoji-rofiunicode/config.example $HOME/.config/rofi/config
  21. mkdir -p $HOME/.local/share/rofi/themes
  22. cp $HOME/.config/rofiemoji-rofiunicode/sidetab-adapta.rasi $HOME/.local/share/rofi/themes/
  23. ```
  24. 3. **If step 2 was completed**, add a custom keybinding using your window-manager settings for the following command:
  25. ```sh
  26. rofi -show windowcd -theme-str '#window{width: 30%;}' # See the rofi documentation for details
  27. ```
  28. 3. **If step 2 was skipped**, use a command containing at least the following arguments:
  29. ```sh
  30. rofi -show unicode -modi 'unicode:~/.config/rofiemoji-rofiunicode/rofiunicode.sh,emoji:~/.config/rofiemoji-rofiunicode/rofiemoji.sh' -theme-str '#window{width: 30%;}'
  31. ```
  32. ## Usage
  33. 1. Invoke rofi using the keybinding you set and navigate through tabs using `Ctrl+Tab` (default).
  34. 2. Type a keyword in the emoji or unicode tabs and press `Return` to copy the highlighted character to the clipboard and close rofi.
  35. ## Recommended configuration
  36. Users who already configured rofi to their own taste before may prefer to skip installation step 2 to keep their custom changes.
  37. However, for users new to rofi, applying the recommended configuration (installation step 2) should facilitate the setup by configuring everything as in the screenshots. This will move/rename the supplied `config.example` file and the `sidetab-adapta.rasi` theme (originally taken from the [davatorium/**rofi-themes**](https://raw.githubusercontent.com/davatorium/rofi-themes/master/User%20Themes/sidetab-adapta.rasi) collection) into the adequate folders.
  38. | Make sure you review `config.example` to check if custom changes will work on your machine. While most of them should be system-agnostic, some settings are tailored to my own use or preferences and may not work on all systems. |
  39. | --- |
  40. For instance, the supplied `config.example` file makes rofi work with gnome-terminal, but default rofi values might work better when using other terminals. In the latter case, it is best to edit `config.example` before installation step 2 (or `~/.config/rofi/config` after step 2) to update it according to your specific system requirements, or simply to disable each of the following lines by prepending them with `!`:
  41. Before:
  42. ```sh
  43. rofi.terminal: gnome-terminal
  44. rofi.ssh-command: {terminal} -- {ssh-client} {host}
  45. rofi.run-shell-command: {terminal} -- bash -c "{cmd}; bash"
  46. ```
  47. After:
  48. ```sh
  49. ! rofi.terminal: gnome-terminal
  50. ! rofi.ssh-command: {terminal} -- {ssh-client} {host}
  51. ! rofi.run-shell-command: {terminal} -- bash -c "{cmd}; bash"
  52. ```
  53. ## Alternative emoji- and unicode-picker
  54. [kabouik/**rofimoji**](https://github.com/Kabouik/rofimoji) is an alternative based on the original [fdw/**rofimoji**](https://github.com/fdw/rofimoji) instead of the [nkoehring/**rofiemoji**](https://github.com/nkoehring/rofiemoji) script version, but still with the addition of unicode characters. It allows multiple selection of emojis or unicode characters, as well as direct input without prior clipboard step, but the customization possibilities are more limited and there is no visual unification with your main rofi instance.
  55. ![Kabouik/rofimoji](https://github.com/Kabouik/rofimoji/raw/master/screenshot-fork.png?raw=true)