Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/GEROGIANNIS/Limoji

Turning your favorite emojis into the world of ASCII ※\(^o^)/※
https://github.com/GEROGIANNIS/Limoji

ascii bash bash-script linux-shell unicode

Last synced: about 2 months ago
JSON representation

Turning your favorite emojis into the world of ASCII ※\(^o^)/※

Host: GitHub
URL: https://github.com/GEROGIANNIS/Limoji
Owner: GEROGIANNIS
License: gpl-3.0
Created: 2022-09-01T15:05:21.000Z (almost 2 years ago)
Default Branch: main
Last Pushed: 2022-12-26T13:40:00.000Z (over 1 year ago)
Last Synced: 2024-01-27T11:01:18.437Z (5 months ago)
Topics: ascii, bash, bash-script, linux-shell, unicode
Language: Shell
Homepage:
Size: 111 KB
Stars: 14
Watchers: 2
Forks: 3
Open Issues: 4
Metadata Files:
- Readme: README.md
- License: LICENSE

Lists

cli-apps - Limoji - Limoji is an open source tool that makes it easy to choose between hundreds of cool ASCII emoticons and share them with your friends. (<a name="funny"></a>Funny tools)
awesome-cli-apps - Limoji - Limoji is an open source tool that makes it easy to choose between hundreds of cool ASCII emoticons and share them with your friends. (<a name="funny"></a>Funny tools)

README

        


    |==========================================|

 ██╗     ██╗███╗   ███╗ ██████╗      ██╗██╗

 ██║     ██║████╗ ████║██╔═══██╗     ██║██║

 ██║     ██║██╔████╔██║██║   ██║     ██║██║

 ██║     ██║██║╚██╔╝██║██║   ██║██   ██║██║

 ███████╗██║██║ ╚═╝ ██║╚██████╔╝╚█████╔╝██║

 ╚══════╝╚═╝╚═╝     ╚═╝ ╚═════╝  ╚════╝ ╚═╝

|==========================================|

    

    Turning your favorite emojis into the world of Unicode

    

    

        

    

    

        

    

    

        

    

    

        

    

    

        

    






# 📖 Introduction

Limoji is an open source tool that makes it easy to choose between hundreds of cool Unicode emoticons and share them with your friends, all done using the terminal!

All you have to do is pick the right one or let Limoji choose it for you!

# Features

* Hundreds of available emoticons to choose from

* Automatic copy to the clipboard

* Random emoticon generator

* 100% free and open source

* Lightweight and responsive

* Wayland support

* Tiny footprint (less than 30KB!)

# ⬇️ Installation

## Debian / Ubuntu-based distributions (Officially supported)

    Repository

    Automatic Updates

    How to install

    

	    GitHub

	    ❌

	    

		    Download the .deb file

	    

    

    

        GitHub (deb-get)

	    ✔️

	    

		    Follow the instructions below

	    

    

        

	    Gemfury

	    ✔️

	    

		    Follow the instructions below

	    

    

### APT repository (Gemfury):

Run the following commands to add it:

```sh

# Add the repository

echo "deb [trusted=yes] https://apt.fury.io/lefterisgar/ * *" | sudo tee /etc/apt/sources.list.d/limoji.list

# Update the package indexes

sudo apt update

# Install Limoji

sudo apt install limoji

```

### Installation using deb-get:

* Download and install [deb-get](https://github.com/wimpysworld/deb-get).

* Run `deb-get install limoji`

*Note: deb-get is 3rd party software, not to be associated with apt-get.*

## Other GNU/Linux distributions

#### Requirements:

* xclip (X11) or wl-clipboard (Wayland)

* git

#### To install it:

Depending on your session type (X11 or Wayland) you will need the appropriate package for copying items to the clipboard. It is recommended that you install both.

xclip (X11):

```bash

# Arch:

sudo pacman -S xclip

# Fedora:

sudo dnf install xclip

```

wl-clipboard (Wayland):

```bash

# Arch Linux:

sudo pacman -S wl-clipboard

# Fedora:

sudo dnf install wl-clipboard

```

Clone this repository:

```bash

git clone https://github.com/GEROGIANNIS/Limoji ~/Limoji

```

Add Limoji's directory to your path (NOTE: You must restart your session after that):

```bash

echo export PATH="~/Limoji:$PATH" | tee -a ~/.bashrc

```

You can update Limoji using:

```bash

cd ~/Limoji && git pull

```

# 📄 Usage

```bash

limoji 

```

Example:

```bash

$ limoji happy

  [✓] happy was copied to the clipboard successfully:

  :‑)

```

## Available commands

    

        -e, --emoticons

        Show a list of the available emoticons

    

    

        -h, --help

        Show this list

    

    

        -i, --info

        Show info about the project

    

    

        -r, --random

        Print a random emoticon

    

    

        -v, --version

        Display Limoji's version

    

By default, `limoji --version` will query GitHub's API to check if a new version is available. If you wish to disable this check, use the `--no-update-check` flag:

```bash

$ limoji --version --no-update-check

# Shortened version:

$ limoji -v -nu

```

# 🔨 Development

## Contributing to the project

1. Fork Limoji

2. Apply your proposed changes to the fork

3. Open a pull request

## Deployment

When everything is ready for a release, the version number needs to be incremented:

```bash

# Limoji 1.0.0

limoji_version="1.0.0"

```

Then run publish.sh:

```bash

./publish.sh

```

This script will automatically do the following:

* Generate a changelog for the new release

* Create the release commit

* Tag the new release

* Push everything to GitHub

GitHub actions is configured to build the package afterwards and draft a release.

# 💬 Todo:

- [ ] Localization

- [ ] Search Command

- [ ] Emoticon Creator

- [ ] Chrome OS Support

- [x] Packaging

- [x] Help Page

- [x] Update README.md

- [x] Make A Release

- [x] Add Option To Receive Another Emoticon

- [x] Add Info Command