Skip to content

Latest commit

 

History

History
193 lines (134 loc) · 11.4 KB

cmi-running.md

File metadata and controls

193 lines (134 loc) · 11.4 KB
Raw

FAQ - Running CMI on Spigot / Paper 1.19.x

FAQ Menu

• CMI and Bungeecord info-, • Chance example, • CMI Chat manager, • Chat format info, • Chat filter, • Chat rooms, • CMI Commands info, • Custom Join and Leave, • CMI Economy manager, • Event commands, • Extending commands, • Getting started with CMI, • Glow info, • Create custom /help, • CMI Hex colors, • Importing data into CMI, • CMILib library info, • Customizing CMI Locale, • CMI Chat with LuckPerms prefix, • Migrate to MySQL database, • Player stuck in Mode?, • User-moderation info, • More message commands, • MOTD, • Parameters explained, • Ranks info, • Create custom /rules, • Running CMI, • Safety tips, • Specialized commands info, • Toggle example, • Trash example, • CMI Vote manager, • Worth info.

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.20.x and CMI 9.6.x.x or newer.
  • The mrfdev Github page is not an official resource, we're building up our knowledge base as a courtesy.
  • I am an admin on the Zrips Discord, this does not mean what I share on here is official.

This page should help explain what I personally think is the way to run CMI on Spigot-, and Paper 1.19.

ℹ️ Note ahead.

The latest version of CMILib is required. Zrips' libraries and other resources are linked below.

ℹ️ 1.19.x

  • Is there a build for 1.19.4? Yes, CMI 9.5.x.x can be used on 1.19.4.
  • Will there be a build for 1.20? Future versions are likely to get an update, yes.
  • Do I need to buy a new license to upgrade? No.
  • Can I upgrade from an older version of CMI to the build for 1.19.x? Yes, latest CMI and CMILib jars will achieve this.
  • CMILib will be required? Yes. CMILib 1.2.5.x or newer is required for 1.19.4
  • So where do I download it? spigotmc.org (link below)

ℹ️ Backup

  • First, I strongly recommend before making any changes to your live server to take it offline with /stop and make a complete backup of the full directory, do not forget to backup your MySQL databases if you use any.

ℹ️ Test setup

  • Before you actually update your live server it's recommended to have a test instance you can try stuff out on. This way you can detect issues and concerns early and learn to address those.

ℹ️ Before we start to install and/or upgrade CMI 9

  • /stop your server. Do the backup thing, and make a test server.

  • Go to SpigotMC and buy CMI if you haven't yet. And use BuildTools.jar from SpigotMC to build the latest version of Spigot 1.19.x or download Paper 1.19.x from their site, and get the latest release of CMI 9, here is the link: https://www.spigotmc.org/resources/3742/

cmi-download-jar-from-spigot-01

  • If you are not yet running CMILib then it will automatically download it. If this isn't the case due to firewalls or whatever reason, you can also manually download it here: https://www.spigotmc.org/resources/87610/

  • Now that we have the latest files and are installing or upgrading from an older version to a new version, and we have a backup. It's time to replace any existing jars.

ℹ️ First time Installalation

If you already are running CMI, you can skip this and go straight to Upgrading (see below).

  • Put the downloaded CMI .jar in the ~/plugins/ directory.

  • Put the downloaded CMILib .jar in the ~/plugins/ directory as well.

  • Start the server and let it complete loading.

  • Keep an eye on the console, the latest.log will also have all the details. If something goes wrong, take note. And try to figure out what is up and try again.

  • If you spot any bugs, confirm them, and report them to Zrip's Github as a new issue.

  • When the server has started, CMI will automatically download languages, CMILib and you're ready to proceed to the Finish step (below).

ℹ️ Upgrading CMI

If you are installing it for the first time, go to the Installing steps above and skip the upgrading steps.

  • Keep the existing plugins/CMI/ folder, do not delete it.

  • Keep the existing plugins/CMILib/ folder, do not delete it.

  • If you don't have the CMILib folder, don't worry, CMI will create it for you.

  • If you have the old CMILib version, don't worry, CMI will auto-upgrade it, and we will clean up after.

  • Remove the old CMI .jar you're using from the plugins/ directory.

  • Put the freshly downloaded CMI .jar in the plugins/ directory.

  • Put the freshly downloaded CMILib .jar in the plugins/ directory as well.

  • Start the server and let it complete loading.

  • Keep an eye on the console, the latest.log will also have all the details. If something goes wrong, take note. And try to figure out what is up and try again.

  • When the server has started, CMI will automatically download languages, CMILib and you're ready to proceed to the Finish step (below).

  • If your plugins/ directory has the old CMILib .jar files, it is okay to remove them now. Keep the new .jar of course.

ℹ️ Finishing up.

Okay, you've backed everything up, you've made a test setup, and you've either fresh installed or upgraded CMI. Just one more thing before you can play with this test setup that is now running.

  • This test setup has to /stop and restart once. This way any new languages, converted data, and updated libraries can be put to use.

  • And now you can start it again. Keep an eye on the console (or latest.log) again and make sure there's no weird errors.

And that's it! You're done.

What a list huh, okay, now you have experience, you have tested, and you can do it again: but on the live server! Have fun with CMI.

ℹ️ What about 1.16.5?

CMI will not run on 1.16.0 or 1.16.1, but 1.16.5 is supported. You can use the latest cmi and CMILib jars on 1.16.5. I always recommend to stay current for each family branch.

The same goes for other older versions, use the latest build for the branch you're using, so not 1.8.0, but 1.8.8, so not 1.12.0 but 1.12.2.

ℹ️ Resources

SpigotMC's Buildtools.jar can be found here https://hub.spigotmc.org/jenkins/job/BuildTools/

These are for CMI 9.x: CMI Vault Economy-compile for best results https://www.zrips.net/wp-content/uploads/2020/07/Vault-1.7.3.jar

CMI Injector Use your own Vault? Use this economy injector https://www.zrips.net/wp-content/uploads/2020/07/CMIEInjector1.0.2.3.jar

CMI Bungee Basic bungee chat support https://www.zrips.net/cmi/bungeecord/

CMILibrary Base Library https://www.spigotmc.org/resources/CMILib.87610/

Spigot website This is where you can get buildtools and make a latest Spigot jar https://hub.spigotmc.org/jenkins/job/BuildTools/

Paper website This is where you can get Paper's latest jar https://papermc.io/downloads