CMILib

Introduction

This plugin helper, or library, is a handy tool that allows us to easily manage common phrases, hex colours and more. Instead of each plugin having to write its own code for these features, this library allows them to share this functionality, as well as providing an API for other developers to extend their own plugin features.

This reduces the overall size of other plugins, and makes updating and maintaining plugins much easier and more consistent.

NOTE: This library is required by ALL Zrips' plugins.

Library Releases and Updates

It's heavily recommended to always keep this library up to date. You can download the latest builds from:

Installation Instructions

As with all plugin changes, make sure to /stop your server and make a full backup first.

Download the latest version of the library from a release website mentioned in the Library Releases Section, and place it in your server's plugins/ directory.

To avoid conflicts, it is recommended to load this library without the plugins that depend on it first, this will ensure that any issues that arise aren't related to the library itself but rather with the dependent plugin, you should then report it to its developer so they update it to match the library changes.

Your Server should start with no issues. After the first startup, a new folder called CMILib will be created in your server's plugins/ folder. This folder contains the library's configuration files. You can edit these files to your liking, but it's not required. If you're working on translations, please make sure to send a pull request to this repository.

At this stage, you should run another /stop to add the plugins that depend on this library and proceed with their setup as required.

Support

If you have encountered an issue with this Library, please check the Contributing Section below for information on how to report it.

Before asking questions, please make sure to read our Frequently Asked Questions.

You can also request support and discuss issues with Community Members on the Zrips Community Discord.

Contributing

You're free to clone this repository and make a pull request to offer bug fixes and/or suggestions.

You can also report bugs and/or make suggestions in the form of a New Issue, but please check if what you're submitting isn't a duplicate within the Issues Tab or hasn't been already addressed in a Pull Request.

Plugins That Require This Library

Have you developed a plugin that uses this library? Let us know and we'll add it to the list!

Note: Clicking on a link will open it on this page due a Markdown limitation. To open it in a new tab, right click and select "Open in new tab".

Plugin Name (Spigot Link)	From Version	Up To Version	Plugin Author
BottledExp	3.x	latest	Zrips
CMI	9.X	latest	Zrips
JobsReborn	5.X	latest	Zrips
MobFarmManager	2.X	latest	Zrips
Recount	3.5.X	latest	Zrips
Residence	5.X	latest	Zrips
SelectionVisualizer	3.0.4.X	latest	Zrips
TradeMe	6.1.X	latest	Zrips
TryMe	7.X	latest	Zrips

Maven

Add the JitPack repository to your pom.xml:

<repositories>
    <repository>
        <id>jitpack.io</id>
        <url>https://jitpack.io</url>
    </repository>
</repositories>

Then, add the dependency:

<dependency>
    <groupId>com.github.Zrips</groupId>
    <artifactId>CMILib</artifactId>
    <version>1.4.7.4</version>
</dependency>

Gradle

Add the JitPack repository to your build.gradle file:

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