Skip to content
Matthias Ngeo edited this page Feb 28, 2020 · 51 revisions

Karus Labs' mono-repository for spigot libraries & tools.

One of the flagship features of Chimera is the command framework that provides interoperability between Mojang's native Brigadier command framework and Spigot plugins. To our knowledge, only this framework exposes Brigadier directly. Unlike other frameworks, we rely on NMS for better correctness and performance. Please see the FAQ for more information.

Please view Using Chimera Commands to get started.

Chimera also contains Scribe; a suite of tools to generate a plugin.yml at compile-time. Unlike other similar tools, Scribe also performs several additional checks to ensure the correctness of the emitted plugin.yml. Values can also be inferred from a project's pom.xml when using Scribe Maven Plugin.

Please view Using Scribe to get started.


Requires Java 11+. Why Java 11?

Travis-CI Funding Maintainability Codecov Stable Source Code Discord

Chimera Version Minecraft Version
4.5.0 1.15.2
4.4.0 1.15 - 1.15.2
4.3.0 1.14 - 1.14.4
4.2.0 1.14 - 1.14.4
4.1.0 1.13.2

Annotations - Contains general purpose annotations

releases-maven snapshots-maven javadoc

<repository>
  <id>chimera-releases</id>
  <url>https://repo.karuslabs.com/repository/chimera-releases/</url>
</repository>

<dependencies>
  <dependency>
      <groupId>com.karuslabs</groupId>
      <artifactId>annotations</artifactId>
      <version>4.5.0</version>
  </dependency>
</dependencies>

Commons - Contains the command framework and other common utilities for Spigot plugin development

releases-maven snapshots-maven javadoc

<repository>
  <id>chimera-releases</id>
  <url>https://repo.karuslabs.com/repository/chimera-releases/</url>
</repository>

<dependencies>
  <dependency>
      <groupId>com.karuslabs</groupId>
      <artifactId>commons</artifactId>
      <version>4.5.0</version>
  </dependency>
</dependencies>

Scribe Annotations - Contains annotations that other scribe projects use to generate a plugin.yml

releases-maven snapshots-maven javadoc

<repository>
  <id>chimera-releases</id>
  <url>https://repo.karuslabs.com/repository/chimera-releases/</url>
</repository>

<dependencies>
  <dependency>
      <groupId>com.karuslabs</groupId>
      <artifactId>scribe-annotations</artifactId>
      <version>4.5.0</version>
  </dependency>
</dependencies>

Scribe Standalone - Standalone annotation processor that generates a plugin.yml

releases-maven snapshots-maven javadoc

<repository>
  <id>chimera-releases</id>
  <url>https://repo.karuslabs.com/repository/chimera-releases/</url>
</repository>

<!-- Standalone annotation processor, provides scribe-annotations as a transitive dependency -->
<dependencies>
  <dependency>
      <groupId>com.karuslabs</groupId>
      <artifactId>scribe-standalone</artifactId>
      <version>4.5.0</version>
  </dependency>
</dependencies>

Scribe Maven Plugin - Maven plugin that generates a plugin.yml and infers values from a project's pom.xml

releases-maven snapshots-maven javadoc

<repository>
  <id>chimera-releases</id>
  <url>https://repo.karuslabs.com/repository/chimera-releases/</url>
</repository>

<dependencies>
  <dependency>
    <groupId>com.karuslabs</groupId>
    <artifactId>scribe-annotations</artifactId>
    <version>4.5.0</version>
  </dependency>
</dependencies>

<plugins>
  <plugin>
    <groupId>com.karuslabs</groupId>
    <artifactId>scribe-maven-plugin</artifactId>
    <version>4.5.0</version>
    <executions>
      <execution>
        <goals>
            <goal>scribe</goal>
        </goals>
      </execution>
    </executions>
  </plugin>
</plugins>
Clone this wiki locally