67 lines
1.3 KiB
Markdown
67 lines
1.3 KiB
Markdown
# Gitmoji Picker for Albert
|
|
|
|
A fast and efficient C++ implementation of the Gitmoji picker for Albert launcher.
|
|
|
|
## Features
|
|
|
|
- Search gitmojis by name or description
|
|
- Copy either emoji or gitmoji code to clipboard
|
|
- Configurable copy format via settings
|
|
- Fast indexing and fuzzy search
|
|
- Native Albert C++ plugin
|
|
- Gitmoji data embedded as Qt resource (no external files needed)
|
|
|
|
## Installation
|
|
|
|
### Building from source
|
|
|
|
```bash
|
|
mkdir build && cd build
|
|
cmake ..
|
|
cmake --build .
|
|
```
|
|
|
|
### Installation
|
|
|
|
Copy the built library to your Albert plugins directory:
|
|
|
|
```bash
|
|
# Local installation
|
|
cp build/gitmoji.so ~/.local/lib/albert/
|
|
|
|
# Or system-wide
|
|
sudo cp build/gitmoji.so /usr/lib/albert/
|
|
```
|
|
|
|
Restart Albert to load the plugin.
|
|
|
|
## Usage
|
|
|
|
Trigger the plugin with `gm ` followed by your search query.
|
|
|
|
Examples:
|
|
- `gm bug` - Search for bug-related gitmojis
|
|
- `gm *` - Show all gitmojis
|
|
- `gm deploy` - Search for deployment-related gitmojis
|
|
|
|
## Configuration
|
|
|
|
Access plugin settings in Albert to choose what to copy:
|
|
- **Emoji**: Copy emoji character (e.g., 🎨)
|
|
- **Gitmoji code**: Copy code (e.g., :art:)
|
|
|
|
Settings are persisted using QSettings.
|
|
|
|
## Development
|
|
|
|
This plugin uses:
|
|
- Albert C++ API
|
|
- Qt6 framework with embedded resources
|
|
- CMake build system
|
|
- IndexQueryHandler for efficient search
|
|
- BackgroundExecutor for async indexing
|
|
|
|
## License
|
|
|
|
MIT
|