README.md

JKaleidolib

JKaleidolib is a Java library providing different style additions for command line applications. This might sound pretty useless in the first place (probably because it is), but there might be some cases, where colors actually come in handy.

---

Table of Contents

• About
• Features
• Installation
• Usage
• Contributing
• License
• Contact

---

About

JKaleidolib is a java library providing different style additions for command line applications. This might sound pretty useless in the first place (probably because it is), but there might be some cases, where colors actually come in handy.

---

Features

• ✅ Colors for Text in your CLI-Application
• ✅ Textstyles for Text in your CLI-Application
• ✅ Wrapper-Methods for easy usage

---

Installation

Download the latest version

To start off, please head to the releases page and download a pre-built jar.

If you don't trust me for some reason, feel free to download the latest released source code and build it your self.

Import the library to your IDE/project

This process depends on the IDE, so just do it as it is done with your's.

---

Usage

Using colors

Colors can be used like this:

System.out.println(TextColors.red + "Look at what I can do!" + TextColors.reset);
System.out.println(TextColors.bgred + "Look at what I can do!" + TextColors.reset);

Using styles

Styles can be used like this:

System.out.println(TextStyles.bold + "Look at what I can do!" + TextStyles.reset);
System.out.println(TextColors.underline + "Look at what I can do!" + TextColors.reset);

Alternatively, you can use JKaleidolib's wrapper methods:

Colors:

System.out.println(Color.blue("Ciao!"));

Backgrounds:

System.out.println(Background.red("Sain bainuu!"));

Formatting:

System.out.println(Formatting.bold("Halo!"));

Lining:

System.out.println(Lining.underline("Silaw!"));

This way, you can combine several stylings at once very easily:

System.out.println(Background.green(Lining.underline(Color.blue("Ndêwó!"))));
System.out.println(Lining.strikethrough(Color.purple("Yassou!")));

---

Contributing

Contributions are welcome! Please follow these steps:

1. Fork the repository
2. Create a new branch (git checkout -b feature-name)
3. Commit your changes (git commit -m 'Add some feature')
4. Push to the branch (git push origin feature-name)
5. Open a pull request

---

License

This project is licensed under the MIT License.

---

Contact

• druffko - @druffko - hi@druffko.gg
• Project Link - https://github.com/druffko/jkaleidolib

Feel free to reach out if you have any questions or suggestions!