Android.EweSticker/README.md

<img src="metadata/en-US/images/featureGraphic.png" alt="Feature Graphic" width="">

[![GitHub top language](https://img.shields.io/github/languages/top/FredHappyface/Android.EweSticker.svg?style=for-the-badge&cacheSeconds=28800)](../../)
[![Issues](https://img.shields.io/github/issues/FredHappyface/Android.EweSticker.svg?style=for-the-badge&cacheSeconds=28800)](../../issues)
[![License](https://img.shields.io/github/license/FredHappyface/Android.EweSticker.svg?style=for-the-badge&cacheSeconds=28800)](/LICENSE.md)
[![Commit activity](https://img.shields.io/github/commit-activity/m/FredHappyface/Android.EweSticker.svg?style=for-the-badge&cacheSeconds=28800)](../../commits/master)
[![Last commit](https://img.shields.io/github/last-commit/FredHappyface/Android.EweSticker.svg?style=for-the-badge&cacheSeconds=28800)](../../commits/master)
[![GitHub all releases](https://img.shields.io/github/downloads/FredHappyface/Android.EweSticker/total?style=for-the-badge&cacheSeconds=28800)](../../releases)
[![Weblate project translated](https://img.shields.io/weblate/progress/ewesticker.svg?style=for-the-badge&cacheSeconds=28800)](https://hosted.weblate.org/engage/ewesticker/)

<!-- omit in toc -->
# Android.EweSticker

EweSticker is an Android sticker keyboard application, specifically designed for sharing a wide variety of custom stickers in supported messaging apps. This project draws inspiration from the uSticker project and is a fork of the woosticker repository.

- [Features](#features)
- [Dark Theme](#dark-theme)
- [Light Theme](#light-theme)
- [Documentation](#documentation)
- [Installation](#installation)
- [Application compatibility](#application-compatibility)
	- [Working](#working)
	- [Known Issues/ Workarounds](#known-issues-workarounds)
- [Gradle tasks](#gradle-tasks)
- [Kotlin and Android Version](#kotlin-and-android-version)
- [Building From Source](#building-from-source)
	- [Git Clone](#git-clone)
		- [Using The Command Line](#using-the-command-line)
		- [Using GitHub Desktop](#using-github-desktop)
	- [(or) Download Zip File](#or-download-zip-file)
	- [Download Android Studio](#download-android-studio)
- [Community Files](#community-files)
	- [Licence](#licence)
	- [Changelog](#changelog)
	- [Code of Conduct](#code-of-conduct)
	- [Contributing](#contributing)
	- [Security](#security)
	- [Support](#support)
	- [Development Info](#development-info)

## Features

The EweSticker Android app offers the following key features to enhance your messaging experience:

- **Wide Range of Custom Stickers Supported**: EweSticker supports a diverse set of sticker formats, ensuring that users can share their creativity in various ways. Supported formats include image/gif, image/png, image/webp, image/jpeg, image/heif, video/3gpp, video/mp4, video/x-matroska, and video/webm.

- **Seamless Sticker Sharing**: Easily send stickers within messaging apps that support custom media sharing using image/png as a fallback.

- **Customizable Scrolling**: Use either vertical or horizontal scrolling to navigate through your sticker collection.

- **Display Options**: adjust the number of rows and the sticker preview size, tailoring the viewing experience to your liking and device screen dimensions.

- **Search your Sticker library**: Use a qwerty keyboard to search stickers by file name to ease discovery

- **Integration with System Theme**: EweSticker seamlessly integrates with the system's theme, ensuring that the app's appearance aligns with your device-wide design choices.

- **Sticker Preview on Long Press**: To facilitate sticker selection, you can long-press on a sticker to reveal a preview to help you quickly decide which sticker to share without the need to open the sticker collection separately.

EweSticker brings a wide range of customization options, diverse format support, and integration with messaging apps. Whether users are sharing static images, animated GIFs, or even short videos, the app aims to provide an engaging and expressive way to communicate using custom stickers.

## Dark Theme

<p>
<img src="metadata/en-US/images/phoneScreenshots/dark-1.png" alt="Dark 1" width="200">
<img src="metadata/en-US/images/phoneScreenshots/dark-2.png" alt="Dark 2" width="200">
<img src="metadata/en-US/images/phoneScreenshots/dark-3.png" alt="Dark 3" width="200">
<img src="metadata/en-US/images/phoneScreenshots/dark-4.png" alt="Dark 4" width="200">
<img src="metadata/en-US/images/phoneScreenshots/dark-5.png" alt="Dark 5" width="200">
<img src="metadata/en-US/images/phoneScreenshots/dark-6.png" alt="Dark 6" width="200">
</p>

## Light Theme

<p>
<img src="metadata/en-US/images/phoneScreenshots/light-1.png" alt="Light 1" width="200">
<img src="metadata/en-US/images/phoneScreenshots/light-2.png" alt="Light 2" width="200">
<img src="metadata/en-US/images/phoneScreenshots/light-3.png" alt="Light 3" width="200">
</p>

## Documentation

A high-level overview of how the documentation is organized organized will help you know
where to look for certain things:

- [Tutorials](/documentation/tutorials) take you by the hand through a series of steps to get
  started using the software. Start here if you’re new.
- The [Technical Reference](/documentation/reference) documents APIs and other aspects of the
  machinery. This documentation describes how to use the classes and functions at a lower level
  and assume that you have a good high-level understanding of the software.
- The [Help](/documentation/help) guide provides a starting point and outlines common issues that you
  may have.

## Installation

You can install the app using the following methods, Follow the link to the listing on your
preferred store by clicking on one of the badges below, then download/install:

[<img src="readme-assets/badges/badge_obtainium.png" alt="Get it on Obtainium" height="80">](https://intradeus.github.io/http-protocol-redirector?r=obtainium://add/github.com/fredhappyface/Android.ewesticker)
[<img src="readme-assets/badges/badge_fdroid.png" alt="Get it on F-Droid" height="80">](https://f-droid.org/en/packages/com.fredhappyface.ewesticker/)
[<img src="readme-assets/badges/badge_gplay.png" alt="Get it on Google Play" height="80">](https://play.google.com/store/apps/details?id=com.fredhappyface.ewesticker)
[<img src="readme-assets/badges/badge_github.png" alt="Get it on GitHub" height="80">](../../releases)

## Application compatibility

### Working

I've tested EweSticker with the various apps I have installed. Please note that it will likely be
compatible with other applications as well.

| app              | id                                | webp | animated |
| ---------------- | --------------------------------- | ---- | -------- |
| Android Messages | com.google.android.apps.messaging | ✔    | ✔        |
| WhatsApp         | com.whatsapp                      | ✔    | ✖        |
| Telegram         | org.telegram.messenger            | ✔    | ✖        |
| Signal           | org.thoughtcrime.securesms        | ✔    | ✖        |
| Discord          | com.discord                       | ✔    | ✔        |
| Fair Email       | eu.faircode.email                 | ✔    | ✔        |
| Element          | im.vector.app                     | ✔    | ✔        |
| Moshidon         | org.joinmastodon.android.moshinda | ✔    | ✔        |
| Google Keep      | com.google.android.keep           | ✔    | ✖        |
| Twitter          | com.twitter.android               | ✔    | ✖        |

### Known Issues/ Workarounds

| app         | id                                        | Workaround                                             |
| ----------- | ----------------------------------------- | ------------------------------------------------------ |
| WeChat      | com.tencent.mm                            | \[Unknown]                                             |
| Notion      | notion.id                                 | Displays the share sheet, can upload to a new note     |
| Gmail       | com.google.android.gm                     | Displays the share sheet, added to a new email         |
| Reddit      | com.reddit.frontpage                      | Displays the share sheet, added to a new post          |
| Google Docs | com.google.android.apps.docs.editors.docs | Displays the share sheet, cannot add to google docs :( |

<!-- omit in toc -->
### Build from Source

Follow the steps in the [Building from Source](#building-from-source) section.

## Gradle tasks

- ktlintCheck (`gradlew ktlintCheck`): run ktlint over the codebase
- genDocs (`gradlew genDocs`): generate the api reference using dokka

## Kotlin and Android Version

This app has been written in Kotlin 1.9.0 with the Android Studio IDE.

- The target SDK version is 34 (Android 14)
- The minimum SDK version is 26 (Android 8 Oreo)

## Building From Source

1. Download or clone this GitHub repository
2. (If downloaded) Extract the zip archive
3. In Android Studio click File > Open and then navigate to the project file
(Android studio defaults to the directory of the last opened file)

### Git Clone

#### Using The Command Line

1. Press the Clone or download button in the top right
2. Copy the URL (link)
3. Open the command line and change directory to where you wish to
clone to
4. Type 'git clone' followed by URL in step 2

	```bash
	git clone https://github.com/FredHappyface/Android.EweSticker
	```

More information can be found at
https://help.github.com/en/articles/cloning-a-repository

#### Using GitHub Desktop

1. Press the Clone or download button in the top right
2. Click open in desktop
3. Choose the path for where you want and click Clone

More information can be found at
https://help.github.com/en/desktop/contributing-to-projects/cloning-a-repository-from-github-to-github-desktop

### (or) Download Zip File

1. Download this GitHub repository
2. Extract the zip archive
3. Copy/ move to the desired location

### Download Android Studio

Download the Android Studio IDE from <https://developer.android.com/studio/>.
For Windows, double click the downloaded .exe file and follow the instructions
provided by the installer - it will download the Android emulator and the
Android SDK. Additional information can be found at
<https://developer.android.com/studio/install>

## Community Files

### Licence

MIT License
(See the [LICENSE](/LICENSE.md) for more information.)

### Changelog

See the [Changelog](/CHANGELOG.md) for more information.

### Code of Conduct

Our project welcomes individuals from diverse backgrounds and perspectives.
We are committed to providing a friendly, safe and welcoming environment for all. Please see the
[Code of Conduct](https://github.com/FredHappyface/.github/blob/master/CODE_OF_CONDUCT.md)
for more information.

### Contributing

Your contributions are valuable and help improve the project for everyone, please see the
[Contributing Guidelines](https://github.com/FredHappyface/.github/blob/master/CONTRIBUTING.md)
for more information.

### Security

If you discover a security vulnerability, we appreciate your responsible disclosure. Please see the
[Security Policy](https://github.com/FredHappyface/.github/blob/master/SECURITY.md)
for more information.

### Support

Thank you for using this project, I hope it is of use to you. Please keep in mind that
the folks working on this project are enthusiasts with various commitments such as work,
family, and other passions. See the
[Support Policy](https://github.com/FredHappyface/.github/blob/master/SUPPORT.md)
for more information.

### Development Info

Serves as a guide to various aspects of project development, including versioning, style guidelines, and recommended practices. Please see
[Development Info](https://github.com/FredHappyface/.github/blob/master/DEVELOPMENT_INFO.md)
for more information.