Skip to content

Latest commit

 

History

History
121 lines (96 loc) · 7.04 KB

cmi-library.md

File metadata and controls

121 lines (96 loc) · 7.04 KB

FAQ - CMI Library

FAQ Menu

• Bungeecord-Info, • Chance-Example, • Chat-Format, • Chat-Manager, • Chat-Filter, • Chat-Rooms, • Commands-Manager, • Custom-Join-Leave, • Economy-Manager, • Extending-Commands, • Getting-Started, • Glow, • Custom-Help, • Hex-Colors, • Importing-Data, • CMILib, • LuckPerms-Prefix, • Migrate-Database, • Mode-Stuck, • More-Msg-Commands, • MOTD, • Parameters, • Ranks, • Custom-Rules, • Running-CMI, • Safety-Tips, • Social-Addon, • Specialized-Cmds, • Toggle-Example, • Trash, • Vote-Manager, • Worth.

Official Zrips Links
  • Zrips Website 
    https://www.zrips.net/
    The official website, wiki/documentation/information
  • Zrips Discord 
    https://discord.gg/dDMamN4
    The official Discord community server with member-driven support
  • Zrips Github 
    https://github.com/Zrips
    The place for bug reports and feature suggestions
Prerequisites
  • Buy and Download CMI (premium plugin) 
    https://www.spigotmc.org/resources/3742/
    Get the CMI plugin if you haven't already, and then Install it on all your servers
  • Also Download CMILib (free library) (more info) 
    https://www.spigotmc.org/resources/87610/
    All Zrips plugins require the CMILib .jar file. Get it and also put it on all your servers.
  • All my FAQ pages have been written for Spigot / Paper 1.18.1 and CMI 9.1.1.1 or newer.
  • The mrfdev github page is not an official resource, we're sharing our knowledge as a courtesy.
  • I am a team member on the Zrips Discord, this does not mean what I share on here is official.

This page is a quick introduction to the CMI Library.

ℹ️ What is CMI Library (CMILib)

It's a plugin helper that can deal with frequently used phrases, hex colors, etc. which all of zrips' plugins can use. This adds consistancy among the various plugins.

You can see the CMI Lib page here: https://www.zrips.net/cmilib/ You can find the CMI LIb download here: https://www.spigotmc.org/resources/cmilib.87610/

ℹ️ Which plugins use this?

The full list as of February 11th, 2022

  • CMI version 9.1.1.2
  • Selection Visualizer version 3.1.0.0
  • TryMe version 7.0.0.2
  • Mob Farm Manager version 2.0.1.2
  • Residence version 5.0.1.3
  • Jobs-Reborn version 5.0.1.3
  • BottledExp version 3.0.1.2
  • ReCount version 3.5.1
  • TradeMe version 6.1.1.1

These currently support Spigot-, and Paper 1.18.1 and lower, and require the CMILib version 1.1.1.0 or newer to properly operate.

ℹ️ How do I get it?

Upon starting of any of these listed plugins it will try to automatically download it. If this fails, it will let you know where you can download the library .jar file from.

ℹ️ I have to restart

Yes, the first time a plugin or CMILib has loaded and converted any data. It's ready to be used after a server restart.

ℹ️ Backing up and testing?

Yep, I strongly recommend to always back up you whole server before making changes, such as plugin updates. Test the upgrade with CMI Lib first. If it fails you can at least roll back to your back up like nothing happened.

ℹ️ Mismatching versions!

OMG, I had CMI with Lib 1.0.0.2 Then TryMe with Lib 1.0.1.0 And now Residence with Lib 1.0.2.3

Don't panic, the latest version can be used by all the plugins. Once you're ready for that final restart, before you start it up, keep the latest, and delete older versions.

From CMI Library version 1.0.2.4 onwards it should automatically clean-up older lib jars. If it does not, you can stop the server, manually remove the older jars and start the server again.

ℹ️ I keep deleting this CMILib jar and it keeps coming back!

Yes, Zrips plugins require the latest CMI Lib to properly work, you need it, don't delete it.