Skip to content

README.md

Latest commit

 

History

History
87 lines (74 loc) · 2.79 KB

README.md

File metadata and controls

87 lines (74 loc) · 2.79 KB

Mechanics Core

Download Version Wiki License

Spigot library plugin including:

  • Adventure for messages
  • Jorel's CommandAPI for command handling
  • FoliaScheduler for Folia support
  • xSeries for serialization

With unique features:

  • Advanced config deserialization with human-readable error messages
  • Custom NBT serialization for String[]
  • EntityEquipmentEvent for armor, hand, and offhand item changes
  • Fake Entities
  • Fake Blocks
  • Modular Mechanic system for configurable actions at events (sounds, particles, etc.)
  • Registry handling

How to (Server Owners)

You might need this plugin if you are using any of my other plugins, such as:

How to (Developers)

See Contributing for information on how to contribute to the project.

Maven

MechanicsCore is available on Maven Central. TO use it, add the following to your pom.xml:

<dependencies>
    <dependency>
        <groupId>com.cjcrafter</groupId>
        <artifactId>mechanicscore</artifactId>
        <version>4.1.0</version>
        <scope>provided</scope>
    </dependency>
</dependencies>

Gradle

Add the following into your build.gradle.kts:

repositories {
    mavenCentral()
}

dependencies {
    implementation("com.cjcrafter:weaponmechanics:4.1.0")
}

Snapshots

Snapshots for MechanicsCore are available on Sonatype's snapshot repository.

<repositories>
    <repository>
        <id>sonatype-snapshots</id>
        <url>https://central.sonatype.com/repository/maven-snapshots/</url>
        <releases>
            <enabled>false</enabled>
        </releases>
        <snapshots>
            <enabled>true</enabled>
        </snapshots>
    </repository>
</repositories>

or for Gradle:

repositories {
    maven(url = "https://central.sonatype.com/repository/maven-snapshots/")
}

Donate

Supporting the developers helps to keep the project alive and allows us to continue improving it.