Skip to content

Latest commit

 

History

History
105 lines (74 loc) · 3.32 KB

README.md

File metadata and controls

105 lines (74 loc) · 3.32 KB
Raw

jText

A Spigot library parse/send/manipulate text

jText gives an API to replace text between given tags in a very efficiency and optimized way. It also comes with support for legacy ampersand minecraft colors, visual components to style your text and support for hex colors and gradients.

Here is an example of the API;

JTextBuilder builder = JText.builder()                // By default, the tag <> is enabled
        .withTag("\\{", "\\}")                       // Add your custom tag
        .withTemplate(Template.of("shop", "drops"))  // The first value is the text to replace
        .withTemplate("item", "dirt")                // and the second is the replacer
        .parseHexColors();                          // Enable hex colors parse

        String toParse = "You bought 1 of {item} of {shop}"
        String parseString = builder.parse(toParse);   // Expected: You bought 1 of dirt of drops

PlaceholderAPI

PlaceholderApi is supported natively, you just have to call parsePlaceholderAPI() on the builder and pass a player on the parse() function, just like this:

JTextBuilder builder = JText.builder()
        .parsePlaceholderAPI();

        builder.parse(str, parse);

Components

Components are a more visual way to style your text. Everything you do will be defined with tags. Tags have a start tag and an end tag (example: <bold>Hello).

All the values of the legacy style can be represented with components, you can see all the values here. Bukkit's colors are also supported and Java colors too. Examples:

    not_enough_money: '<gray>Ey, You dont have <red><bold>enough money <gold>to buy this item!'
    inventory_full: '<gray>Ey, You don't have <magic>enough space <dark_green>in your inventory!'
    not_enough_items: '<pink><italic>You dont have this item or the proper amount to sell it'

Hex colors

Hex colors are also supported via components, for example <#ffc0db>This is hex colors!

Instalation

To get the jar, either download it from the releases tab either here on GitHub or build it locally.

With Jitpack:

Gradle:

repositories {
        maven { url 'https://jitpack.io' }
}

dependencies {
        compileOnly 'com.github.divios:jText:Tag'
}

Maven:

<repository>
        <id>jitpack.io</id>
        <url>https://jitpack.io</url>
</repository>
<dependency>
        <groupId>com.github.divios</groupId>
        <artifactId>jText</artifactId>
        <version>Tag</version>
        <scope>provided</scope>
</dependency>

Replace Tag with a release tag for jText. Example: 1.5. You can also use master as the tag to get the latest version, though you will have to clear your maven caches in order to update it.

Build locally:

For Windows, use Git Bash. For Linux or OSX, just ensure you have Git installed. Navigate to the directory where you want to clone the repository, and run:

git clone https://github.com/divios/jText
cd Jtext
./gradlew jar

After running these commands, the jar will be at build/libs/jText.jar. You may also need to add the jar to your classpath. After that, you should be good to go!