Lib-Emoticon

Intention

Lib-Emoticon is a multi Maven project written in JavaFX and NetBeans IDE and provides the functionalities to use and handle easily Emoticons in your JavaFX application.

Image: Demo v0.1.0-SNAPSHOT

The current version is 0.1.0-SNAPSHOT (MM.dd.2017 / MM.dd.yyyy).

Content

• Demo
• Libraries
  • Lib-Emoticon-Core
  • Lib-Emoticon-Emoji
  • Lib-Emoticon-Emoji-Images
• Download
• Requirements
• Installation
• Contribution
• License
• Autor
• Contact

Demo

The application Lib-Emoticon-Demo shows a demonstration how to use and handle the features from the libraries in the project Lib-Emoticon.

Image: Demo application v0.1.0-SNAPSHOT

Momentary following features are shown in the demo application:

• How to load with an EmoticonLoader different sublists from an EmoticonSet.
• How to load all images from the EmojiEmoticonSet.
  • See Emoji cheat sheet for the original source - big thanks for the great work .
• How to show a Can't load image Image if the emoticon image can't loaded.

For more informations and examples plz see the ReadMe from Lib-Emoticon-Demo.

Libraries

Like I said before Lib-Emoticon is a multi Maven project which contains different sub-libraries. Which sub-libraries are the best for you depends from your requirements in your project.

To use Lib-Emoticon in your project you need minimal the library Lib-Emoticon-Core plus a concrete implementation from an EmoticonLoader which loads your own Emoticons images. How that work will be explained in the sub-project Lib-Emoticon-Demo.

Natural you can use additional libraries which contains predefined Emoticon Sets. Currently supported is Emoji cheat sheet with the libraries Lib-Emoticon-Emoji and Lib-Emoticon-Emoji-Images.

Lib-Emoticon-Core

The library Lib-Emoticon-Core provides the API to load an Emoticon as an Image with a concrete implementation from an EmoticonLoader.

For more informations and examples plz see the ReadMe from Lib-Emoticon-Core.

Lib-Emoticon-Emoji

With the library Lib-Emoticon-Emoji the developer have access to the emoticonset Emoji cheat sheet through the class EmojiEmoticonSet. Momentary that are 882 Emoticons.

For more informations and examples plz see the ReadMe from Lib-Emoticon-Emoji.

Lib-Emoticon-Emoji-Images

The library Lib-Emoticon-Emoji-Images contains all images from the emoticonset Emoji cheat sheet. Currently that are 882 images.

For more informations and examples plz see the ReadMe from Lib-Emoticon-Emoji-Images.

Download

There are different zip files as download available. Plz choose the right one in dependency from your necessities:

• TODO

Access to the downloads are here: [Download Lib-Tile]

Requirements

• On your system you need JRE 8 or JDK 8 installed.

Installation

Depends on your necessities you have different options like in the section Download is shown. Download the right zip file, extract it and include the jar file(s) into your project. That was it 😄 .

Documentation

TODO rewrite In general Lib-Emoticon and Lib-Emoticon-Demo haven't an official documentation. But you can

• read the README.md from every project and
• read the [JavaDoc] in the project and libraries.

where examples and the api are shown and explained.

Contribution

• If you find a Bug I will be glad if you could report an [Issue].
• If you want to contribute to the project plz fork the project and do a [Pull Request].

License

The project Lib-Emoticon and all sub-projects are licensed under General Public License 3.0.

Autor

The project Lib-Emoticon and all sub-projects are maintained by me, Peter Rogge. See Contact.

Contact

You can reach me under peter.rogge@yahoo.de.