XSeries - GitLite

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #go #golang #android #docker #macos #java #windows #awesome #kubernetes #ios

XSeries

(★ 533)

Library for cross-version Minecraft Bukkit support and various efficient API methods.

파일 탐색기

최종 버전 다운로드 (.zip)

- - bug-report.md
  - feature-request.md
- - maven-publish.yml
- pom.xml
- pom.xml
- pom.xml
- pom.xml
- pom.xml
.gitattributes
.gitignore
.travis.yml
CONTRIBUTING.md
jitpack.yml
LICENSE.txt
pom.xml
README.md
TODO.md

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/CryptoMorin/XSeries

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd XSeries

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Maven (Java)

보통 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
JDK (Java) Java 프로젝트를 빌드/실행하려면 필요합니다.
Maven mvn 명령어를 쓰기 위한 빌드 도구입니다.

cd commons

이 프로젝트의 관련 파일이 하위 폴더 안에 있어서, 먼저 그 폴더로 이동합니다.

mvn clean install

Maven으로 의존성 설치와 빌드를 진행합니다.

✅ BUILD SUCCESS 메시지가 뜨면 성공입니다. target/ 폴더에 결과물이 생성됩니다.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

![XSeries Logo](https://github.com/user-attachments/assets/4b179b17-3f2b-4640-bc50-df2275300bcb)

# XSeries

[![Minecraft](https://img.shields.io/badge/Minecraft-26.1.2-dark_green.svg)](https://shields.io/)
[![Java](https://img.shields.io/badge/Java-8-dark_green.svg)](https://shields.io/)
[![Build Status](https://api.travis-ci.com/CryptoMorin/XSeries.svg?branch=master)](https://app.travis-ci.com/github/CryptoMorin/XSeries)
![maven-central](https://img.shields.io/maven-central/v/com.github.cryptomorin/XSeries)
[![CodeFactor](https://www.codefactor.io/repository/github/cryptomorin/xseries/badge)](https://www.codefactor.io/repository/github/cryptomorin/xseries)

Library mainly designed to provide cross-version support for Minecraft Bukkit plugins,
but it also includes numerous extra methods to help developers design their plugins easier and efficiently.
Some utilities are completely unrelated to cross-version support such as NoteBlockMusic.

> [!IMPORTANT]
> Don't forget to add `api-version: "1.13"` to your **plugin.yml**.
> This will not prevent your plugin from working even if the server is not using Minecraft v1.13
> This is only required if you want to use one of the XBase/XModule classes.

> [!CAUTION]
> Make sure to [shade](https://github.com/CryptoMorin/XSeries?tab=readme-ov-file#shading)
> the library to prevent conflicts with other plugins that also use XSeries.

This project aims to provide quality utilities with high performance using the latest, yet efficient techniques.
Although support for old versions (like 1.8) will still remain for future updates, I highly encourage all developers
drop support for anything below 1.12

### Links

This project was mainly posted in [SpigotMC](https://www.spigotmc.org/threads/378136/)\
Most of the updates and news will be announced there.

### Getting Started

When compiling your plugin you should be using the latest version that your plugin is going to support.\
Which means, at least you have to use 1.13 (for cross-version support utilities only)
You can clone the project using: `git clone https://github.com/CryptoMorin/XSeries.git`

All the methods are explained in the JavaDocs. Please read them before using a method.
It's quite common to miss the whole purpose of cross-version support and the efficiency
of the utility by using the wrong methods.

You can use some of these utilities individually or use the maven dependency.
Most of the utilities are intended to be independent. However, some
utilities such as [XParticle](core/src/main/java/com/cryptomorin/xseries/particles/XParticle.java) are intended to use
another class ([ParticleDisplay](core/src/main/java/com/cryptomorin/xseries/particles/ParticleDisplay.java)).
All XBase/XModule classes also depend on these base classes and
also [XRegistry](core/src/main/java/com/cryptomorin/xseries/base).

#### Maven ![maven-central](https://img.shields.io/maven-central/v/com.github.cryptomorin/XSeries)

```xml

<dependency>
    <groupId>com.github.cryptomorin</groupId>
    <artifactId>XSeries</artifactId>
    <version>version</version>
</dependency>
```

> [!NOTE]
> If you want to use XSkull and you use `spigot-api` dependency you need the following:
> ```xml
> <repository>
>     <id>minecraft-libraries</id>
>     <name>Minecraft Libraries</name>
>     <url>https://libraries.minecraft.net/</url>
> </repository>
> ```
> ```xml
> <dependency>
>     <groupId>com.mojang</groupId>
>     <artifactId>authlib</artifactId>
>     <version>6.0.54</version>
>     <scope>provided</scope>
> </dependency>
> ```

Gradle

```kotlin
repositories {
    mavenCentral()
}
dependencies {
    implementation("com.github.cryptomorin:XSeries:version")
}
```

You shouldn't worry if the reflection or other classes are going to use your memory with heavy useless static cache.
As long as you don't use them anywhere in your code, they won't initialize.
The memory usage of these utilities are extremely enhanced.

# Shading

DO NOT extract the JAR into your project if you're using maven. You have to shade the library,
otherwise your plugin or other plugins will break due to version mismatch.
To shade the library, add the following under your maven plugins:

### [Apache Maven Shade Plugin](https://maven.apache.org/plugins/maven-shade-plugin/)

```xml

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-shade-plugin</artifactId>
    <version>3.6.0</version>
    <configuration>
        <relocations>
            <relocation>
                <pattern>com.cryptomorin.xseries</pattern>
                
                <shadedPattern>my.plugin.utils</shadedPattern>
            </relocation>
        </relocations>
        
        
        
        
        <filters>
            <filter>
                <artifact>*:*</artifact>
                <excludes>
                    <exclude>com/cryptomorin/xseries/XBiome*</exclude>
                    <exclude>com/cryptomorin/xseries/NMSExtras*</exclude>
                    <exclude>com/cryptomorin/xseries/NoteBlockMusic*</exclude>
                    <exclude>com/cryptomorin/xseries/SkullCacheListener*</exclude>
                </excludes>
            </filter>
        </filters>
    </configuration>
    <executions>
        <execution>
            <phase>package</phase>
            <goals>
                <goal>shade</goal>
            </goals>
        </execution>
    </executions>
</plugin>
```

### [Gradle Shadow plugin](https://gradleup.com/shadow/)

Gradle (Kotlin DSL)

```kotlin
plugins {
    java
    id("com.github.johnrengelman.shadow") version ("8.1.1")
}

tasks {
    shadowJar {
        relocate("com.cryptomorin.xseries", "my.plugin.utils")
    }
}
```

Gradle (Groovy)

```groovy
plugins {
    id 'com.github.johnrengelman.shadow' version '8.1.1'
    id 'java'
}

tasks {
    shadowJar {
        relocate 'com.cryptomorin.xseries', 'my.plugin.utils'
    }
}
```

### Contributing

There's always room for improvement. If you know better ways of doing things,
I really appreciate it if you can share it with me,
but please make sure you know what you're doing and tested the project on different versions.
Any new ideas are welcome as long as they're useful; not just for you, but for everyone else.\
Please refer to [contributing guidelines](CONTRIBUTING.md) for more info.