Skip to content

TheChilliPL/textcomponentserialization

Repository files navigation

TextComponent serialization

GitHub top language GitHub issues GitHub closed issues GitHub last commit

MPL 2.0 JitPack

TextComponent serializer library for Spigot!

How to include

Repository

You need to add the JitPack repository.

Gradle
repositories {
  // ...
  maven { url 'https://jitpack.io' }
}
Maven
<repositories>
  <!-- ... -->
  <repository>
    <id>jitpack.io</id>
    <url>https://jitpack.io</url>
  </repository>
</repositories>

Dependency

Then add the dependency to the project.

Gradle
dependencies {
  // ...
  implementation 'me.patrykanuszczyk:textcomponentserialization:VERSION'
}
Maven
<dependencies>
  <!-- ... -->
  <dependency>
    <groupId>me.patrykanuszczyk</groupId>
    <artifactId>textcomponentserialization</artifactId>
    <version>VERSION</version>
  </dependency>
</dependencies>

VERSION must be replaced with a valid version tag, e.g. 1.0, or, if you wish to use an unpublished version, using short commit hash or branch-SNAPSHOT.
For more information, check out JitPack documentation.

Shading bStats

Shading copies all the necessary classes to your plugin, when building it, and relocates the library to another package to avoid conflicts between versions, etc.
You can do it, using shading plugins for maven or gradle.

Gradle
plugins {
  id 'com.github.johnrengelman.shadow' version '5.2.0'
}

shadowJar {
  relocate 'me.patrykanuszczyk.textcomponentserialization', 'YOUR.PACKAGE'
}
Maven
<build>
  <plugins>
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-shade-plugin</artifactId>
      <version>3.2.0</version>
      <configuration>
        <relocations>
          <relocation>
            <pattern>me.patrykanuszczyk.textcomponentserialization</pattern>
            <shadedPattern>YOUR.PACKAGE</shadedPattern>
          </relocation>
        </relocations>
      </configuration>
      <executions>
        <execution>
          <phase>package</phase>
          <goals>
            <goal>shade</goal>
          </goals>
        </execution>
      </executions>
    </plugin>
  </plugins>
</build>

YOUR.PACKAGE must be replaced with the package you want to move the library to when building. I suggest setting it to a subpackage of your plugin.

About

TextComponent serializer library for spigot

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages