Rofi Applets

Bundle of easy to configure useful Rofi Applets
Developed by Umutcan Sevdi

Table of Contents

1. Project
2. Installation
3. How To Use
4. Customization
5. License
6. Contact

1- Project

Rofi is an amazing tool to create pop-ups and small applications. Here I built a CLI and bunch of useful applets.

2- Installation

This project requires Rofi. It's a very powerful pop-up/switcher that allows anyone to create powerful menus. You can download it from the package manager of your choice.

$sudo dnf install rofi

You can then clone this repository any directory of your choice.

$git clone https://github.com/umutsevdi/rofi-applets.git

By default the applet CLI checks the $HOME/.dotfiles/applets directory for available applets. However you can change this by overwriting the ROFI_APPLETS_PATH variable.

$export ROFI_APPLETS_PATH=/path/to/rofi-applets

Now link the CLI to a directory where your binaries are.

$ln -s /path/to/rofi-applets/applet ~/bin

You are ready to go! You can now run any applet either by calling their launchers directly or by using the CLI.

3- How To Use

After installation run the applet command.

    $applet
    applet.sh - Applet Launcher Interface
    ──────────────────────────────────────────────
    Command line interface to run Rofi Applets

    Syntax: [-r]
    Options:
    ┌────────────────────────────────────────────┐
    │ -h/--help          Prints this menu.       │
    │ -r/--run $app      Runs selected applet    │
    └────────────────────────────────────────────┘
     Available Applets:
    - emoji
    - filebrowser
    - launcher
    - player
    - powermenu
    - tab

If the applet can not detect any applet, it will prompt an error like this. It means you made a mistake while defining the ROFI_APPLETS_PATH variable.

$applet
ls: cannot access '/home/user/applets/*/': No such file or directory
error: No applet were found at /home/user directory.
Either move applets to the /home/user or define $ROFI_APPLETS_PATH at .bashrc
applet.sh - Applet Launcher Interface
──────────────────────────────────────────────
Command line interface to run Rofi Applets

If there are no errors you can simply run any available applet using applet -r.

4- Customization

You can customize or build new applets easily.

• All applets read color values from applets/global.rasi. Editing color hexcodes will update all existing applets.
• You can make your own applets with following logic. Create a directory at ROFI_APPLETS_PATH. Then open two files. config.rasi and launch.sh. Instead of defining your own color values, import all of them from global.rasi for consistency. Develop rest like any other rofi applet. Write your launch script to the launch.sh. Applet CLI will automatically recognize your applet on the next run.

5- License

Distributed under the MIT License. See LICENSE for more information.

6- Contact

You can contact to me for any suggestion or information.

Project: umutsevdi/rofi-applets

Developed by Umutcan Sevdi