Skip to content
This repository has been archived by the owner on Dec 3, 2024. It is now read-only.
/ jkaleidolib Public archive

JKaleidoLib - Color for your Java Commandline Applications.

License

Notifications You must be signed in to change notification settings

massimo-rnd/jkaleidolib

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Repo-Image

JKaleidolib

License Issues Forks Stars Last Commit GitHub release (latest by date including pre-releases)

🚀 Overview

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!")));

🚧 Roadmap

  • Implement customizable Colors

Check out the open issues for more.

🤝 Contributing

Contributions, issues, and feature requests are welcome!
Feel free to check the issues page.

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

See CONTRIBUTING.md for more details.

📜 License

This project is licensed under the MIT License. See the LICENSE file for details.

📊 Repository Metrics

Repo Size Contributors Commit Activity


📞 Contact

For any inquiries, feel free to reach out: