# JColorfulConsole is a console color library. [![](https://jitpack.io/v/Anas-Elgarhy/JColorfulConsole.svg)](https://jitpack.io/#Anas-Elgarhy/JColorfulConsole) [![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=Anas-Elgarhy_JColorfulConsole&metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=Anas-Elgarhy_JColorfulConsole) [![Duplicated Lines (%)](https://sonarcloud.io/api/project_badges/measure?project=Anas-Elgarhy_JColorfulConsole&metric=duplicated_lines_density)](https://sonarcloud.io/summary/new_code?id=Anas-Elgarhy_JColorfulConsole) [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=Anas-Elgarhy_JColorfulConsole&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=Anas-Elgarhy_JColorfulConsole) [![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=Anas-Elgarhy_JColorfulConsole&metric=sqale_index)](https://sonarcloud.io/summary/new_code?id=Anas-Elgarhy_JColorfulConsole) [![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=Anas-Elgarhy_JColorfulConsole&metric=ncloc)](https://sonarcloud.io/summary/new_code?id=Anas-Elgarhy_JColorfulConsole) [![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=Anas-Elgarhy_JColorfulConsole&metric=code_smells)](https://sonarcloud.io/summary/new_code?id=Anas-Elgarhy_JColorfulConsole) [![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=Anas-Elgarhy_JColorfulConsole&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=Anas-Elgarhy_JColorfulConsole) [![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=Anas-Elgarhy_JColorfulConsole&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=Anas-Elgarhy_JColorfulConsole) [![Bugs](https://sonarcloud.io/api/project_badges/measure?project=Anas-Elgarhy_JColorfulConsole&metric=bugs)](https://sonarcloud.io/summary/new_code?id=Anas-Elgarhy_JColorfulConsole) ## Features: - Support text color. - Support background color. - Support 256 colors (RGB). - Support ANSI colors. - Support indexed colors. - Support text style. - Lightweight and fast. - Easy to use. ## How to add this library into your project ### Maven **Step 1**. Add the JitPack repository to your build file ```xml jitpack.io https://jitpack.io ``` **Step 2**. Add the dependency ```xml com.anas.jcolorfulconsole jcolorfulconsole 1.0.2 ``` #### Gradle: **Step 1**. Add the JitPack repository to your build file
*Add it in your root build.gradle at the end of repositories:* ```gradle allprojects { repositories { ... maven { url 'https://jitpack.io' } } } ``` **Step 2**. Add the dependency ```gradle dependencies { implementation 'com.github.Anas-Elgarhy:JColorfulConsole:1.0.2' } ``` # Usage: ```java public class Example1 { public static void main(String[] args) { ColoredString hello = new ColoredString("Hello, "); hello.setForegroundColor(TextColor.ANSI.BLUE); // Set text color to blue hello.setBackgroundColor("magenta"); // Set background color to magenta hello.addStyle(TextStyle.BOLD); // Add bold style ColoredString world = new ColoredString(); world.setStr("World!"); // Set string to "World!" world.setForegroundColor("#542413"); // Set text color world.setBackgroundColor(new TextColor.RGB(34, 139, 34)); // Set background color world.addStyle(TextStyle.ITALIC); // Add italic style System.out.print(hello); // Print colored string System.out.print(world); // Print colored string } } ``` ![Result of example 1](./Screenshots/1.0.1-example1.png) ```java public class Example2 { public static void main(String[] args) { new Thread(() -> { while (true) { System.out.println(new ColoredString("Hi", new TextColor.RGB((int) (Math.random() * 255), (int) (Math.random() * 255), (int) (Math.random() * 255)), new TextColor.RGB((int) (Math.random() * 255), (int) (Math.random() * 255), (int) (Math.random() * 255)), TextStyle.values()[(int) (Math.random() * TextStyle.values().length)])); try { Thread.sleep(1000); } catch (InterruptedException e) { e.printStackTrace(); } } }).start(); } } ``` ![Result of example 2](./Screenshots/1.0.1-example2.gif) ## Requirements for development: - Maven - jdk 17 - IntelliJ IDEA (not required but recommended) ## TODO - [ ] Add Tests - [ ] Add Formatter - [ ] Add Documentation - [ ] Add more examples ### Available in [![GitHub](https://img.shields.io/badge/GitHub-Main%20repo-brightgreen?style=for-the-badge&logo=GitHub)](https://github.com/Anas-Elgarhy/JColorfulConsole) [![GitLab](https://img.shields.io/badge/GitLab-Mirror%20repo-brightgreen?style=for-the-badge&logo=GitLab)](https://gitlab.com/Anas-Elgarhy/JColorfulConsole) [![BitBucket](https://img.shields.io/badge/BitBucket-Mirror%20repo-brightgreen?style=for-the-badge&logo=BitBucket)](https://bitbucket.org/anas_elgarhy/jcolorfulconsole) [![Codeberg](https://img.shields.io/badge/Codeberg-Mirror%20repo-brightgreen?style=for-the-badge&logo=Codeberg)](https://codeberg.org/anas-elgarhy/JColorfulConsole) [![Quality gate](https://sonarcloud.io/api/project_badges/quality_gate?project=Anas-Elgarhy_JColorfulConsole)](https://sonarcloud.io/summary/new_code?id=Anas-Elgarhy_JColorfulConsole) [![SonarCloud](https://sonarcloud.io/images/project_badges/sonarcloud-black.svg)](https://sonarcloud.io/summary/new_code?id=Anas-Elgarhy_JColorfulConsole) ![License: GPL-3.0](https://img.shields.io/badge/License-GPL%203.0-blue.svg)