Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/asintotoo/colorlib
A Color API for Minecraft Spigot Plugins
https://github.com/asintotoo/colorlib
api color colors hexcode hexcolor java library message minecraft minecraft-api minecraft-library minecraft-plugin paper-plugin papermc spigot spigot-api spigot-plugin spigotmc
Last synced: 4 months ago
JSON representation
A Color API for Minecraft Spigot Plugins
- Host: GitHub
- URL: https://github.com/asintotoo/colorlib
- Owner: Asintotoo
- Created: 2024-05-14T15:36:17.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-05-16T08:01:20.000Z (9 months ago)
- Last Synced: 2024-10-11T03:40:45.597Z (4 months ago)
- Topics: api, color, colors, hexcode, hexcolor, java, library, message, minecraft, minecraft-api, minecraft-library, minecraft-plugin, paper-plugin, papermc, spigot, spigot-api, spigot-plugin, spigotmc
- Language: Java
- Homepage:
- Size: 25.4 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## ColorLib - A Color API for Minecraft Spigot Plugins
How to include the API with Maven
```xml
jitpack.io
https://jitpack.io
com.github.Asintotoo
ColorLib
1.0.0
compile
```
**Note**: ColorLib uses external Libraries that requires Shading in order to be used in your Minecraft Plugin, please include the following in your *pom.xml*
```xml
org.apache.maven.plugins
maven-shade-plugin
3.1.0
package
shade
```
# Usage
The Main Java method to process a String is *ColorLib.setColors("your message here");*
To add a *Gradient* use the tag:
```java
ColorLib.setColors("This is a Gradient Text");
```
To add a *Rainbow* text use the tag:
```java
ColorLib.setColors("This is a Rainbow Text");
```
The number after RAINBOW represents the saturation
```java
ColorLib.setColors("This is a Rainbow Text");
```
To set a simple *Solid* color use the tag:
```java
ColorLib.setColors("This is a Solid Text");
```
**Note:** If your server is running a version before 1.16 the resulting color will be the nearest supported one (This also applies to gradient)
Normal Chat Color Codes works too:
```java
ColorLib.setColors("&5This is a Simple Text");
```
# Advanced Usage
The API comes with some additional method that you may want to use:
Get a processed text with the addition of inserting all PlaceholderAPI's placeholders refering to a given player:
```java
ColorLib.setColorsAndPlaceholders(Bukkit.getPlayer("Maggiollo"), "Ciao %player_name%");
```
Get a processed text given a YamlConfiguration path:
```java
ColorLib.getColoredStringFromConfig((YamlConfiguration) plugin.getConfig(), "messages.example");
```
this will format the following text:
```yml
messages:
example: "This is an Example"
```
Get a processed text given a YamlConfiguration path and insert all PlaceholderAPI's placeholders refering to a given player:
```java
ColorLib.getColoredStringFromConfigWithPlaceholders((YamlConfiguration) plugin.getConfig(), Bukkit.getPlayer("Maggiollo"), "messages.example-papi");
```
this will format the following text replacing %player_name% with "Maggiollo":
```yml
messages:
example-papi: "Hello %player_name%"
```
**Note**: All the method using the "Player" class are also compatible with the "OfflinePlayer" class.
**Note**: All the methods that use PlaceholderAPI's Placeholders requires PlaceholderAPI to be installed on the server, you can download it from [here](https://www.spigotmc.org/resources/placeholderapi.6245/)