Giter Club home page Giter Club logo

emote's Introduction

Emote

Emote is a modern emoji picker for Linux ๐Ÿš€. Written in GTK3, Emote is lightweight and stays out of your way.

Launch the emoji picker with the configurable keyboard shortcut Ctrl+Alt+E, and select one or more emojis to have them be automatically pasted into your currently focused app.

  • ๐Ÿพ Built as a popup: quick invocation, and disappears when not needed, does not stay as a standalone window
  • ๐Ÿซ  Provide a large and up-to-date list of emojis retrieved from openmoji.org
  • ๐Ÿง  Shows the last used emojis by default
  • ๐Ÿ”Ž Search text box automatically focused and ready to type when invoked
  • โŒจ๏ธ Can use shortcuts to navigates and select emojis
  • โœ’๏ธ Selected emoji automatically pasted to your currently focused app (on X11 only)

โ„น๏ธ Note:

  • โšก๏ธ Emote shows up faster when invoked using the built-in keyboard shortcut (Ctrl+Alt+E by default), than when using a manually registered keyboard shortcut.
  • ๐ŸชŸ Emote under Wayland cannot automatically paste the emoji into other apps, and also requires manual registering of a global keyboard shortcut - Hotkey In Wayland. This is due to intentional restrictions in the design of Wayland itself.

๐Ÿ“ฅ๏ธ Installation

Emote can be installed using various popular package managers:

๐Ÿ“ฆ๏ธ Install with Flatpak (preferred)

Download on Flathub

or

flatpak install com.tomjwatson.Emote

๐Ÿฆœ Install with Snap

Get it from the Snap Store

or

sudo snap install emote

๐Ÿง Unofficial installation methods

An unofficial build of Emote is also available in the AUR : https://aur.archlinux.org/packages/emote.

๐Ÿ“– Guide

๐Ÿš€ Launching

Emote runs in the background and automatically starts when you log in.

The emoji picker can be opened with either the keyboard shortcut, or by clicking the app icon again.

โ„น๏ธ Usage

Select an emoji to and have it be pasted to your currently focused app. The emoji will also be copied to your clipboard, so you can then paste the emoji wherever you need.

You can select multiple emojis by selecting them with right click.

โŒจ๏ธ Keyboard Shortcuts

Open Emoji Picker: Ctrl+Alt+E (configurable)

Select Emoji: Enter

Add Emoji to Selection: Shift+Enter

Focus Search: Ctrl+F

Next Emoji Category: Ctrl+Tab

Previous Emoji Category: Ctrl+Shift+Tab

๐Ÿง‘โ€๐Ÿ’ป Development

Build package

๐Ÿ“ฅ๏ธ Requirements

Install development libraries:

sudo apt install xdotool libgtk-3-dev libgirepository1.0-dev python3-venv gir1.2-keybinder-3.0 libkeybinder-dev desktop-file-utils
# or with dnf
sudo dnf install xdotool gtk3-devel keybinder3-devel libgirepository1.0-dev desktop-file-utils gobject-introspection-devel flatpak-builder

sudo dnf install libffi-devel

Install pipenv:

sudo pip3 install pipenv

Install dependencies:

make install

๐Ÿ›ฉ๏ธ Running

Run the development version:

make dev

๐Ÿ”„ Update emojis

To update the list of emojis to the latest available on openmoji.org, run:

make update-emojis

๐Ÿž Debugging GTK3 with GtkInspector

Enable debug keybinding:

gsettings set org.gtk.Settings.Debug enable-inspector-keybinding true

Launch app in debug mode with interactive inspector:

make dev-debug

๐Ÿšข Publishing

Releasing a new version

  1. Bump the version number in snapcraft.yaml for snap and in meson.build for flatpak.
  2. Add a release entry to the com.tomjwatson.Emote.metainfo.xml.

๐Ÿ“ฆ๏ธ Package with Flatpak

To develop locally you will need to have flatpak installed.

Install

Install flatpak-builder, the GNOME SDK, and flatpak-pip-generator:

make flatpak-install

Optionally re-generate the flatpak/python3-requirements.json if the dependencies in the Pipfile have been changed:

make flatpak-requirements

Build

Build the flatpak package and install it locally:

make flatpak

Run Emote with flatpak (can also be done from the desktop entry):

flatpak run com.tomjwatson.Emote

Debug

In case you are facing issues with the cache not properly updating, or need to reset user data, you can clean the cache with:

make flatpak-clean

To see potential error messages of the flatpak app you can use journalctl:

journalctl -f -n 50

Run the command below if you want to access inside the containerized flatpak app to debug.

flatpak run --command=sh --devel com.tomjwatson.Emote

Publish to Flathub

Emote is published to Flathub using the repository github.com/flathub/com.tomjwatson.Emote.

Flathub builds can be monitored at buildbot.flathub.org/#/apps/com.tomjwatson.Emote

To update the version published to Flathub:

  1. In the com.tomjwatson.Emote.yml manifest of the flathub/com.tomjwatson.Emote repo: change the commit hash to the commit of the Emote repository you want to publish
  2. Flathub checks the GitHub repo every few minutes, and will start a build if a change has been detected. If the build succeeds, it is published automatically after 3 hours. You can use the Flathub BuildBot web UI to monitor, start or publish builds manually (click the Publish button at the top of a successful build page).

More documentation for maintaining a Flathub package is available at docs.flathub.org/docs/for-app-authors/maintanance.

๐Ÿฆœ Package with Snap

Ensure you have snapcraft installed:

sudo snap install --classic snapcraft

Create a packaged .snap file:

make snap

Clean the cache:

make snap-clean

Publishing

First, ensure a git tag for the current version has been pushed.

Ensure you are logged in to snapcraft:

snapcraft login

Push the packaged snap to the edge channel on the snap store.

snapcraft push --release=edge <path to .snap>

๐Ÿค Attribution

Emoji data is sourced from https://raw.githubusercontent.com/hfg-gmuend/openmoji/master/data/openmoji.csv which is compiled by the lovely people at https://openmoji.org ๐Ÿซ .

emote's People

Contributors

tom-james-watson avatar vemonet avatar lkrms avatar dobicinaitis avatar gagangulyani avatar 0x4c4a avatar plnech avatar waldyrious avatar abgita avatar sonjoonho avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.