Skip to content

Latest commit

 

History

History
104 lines (87 loc) · 6.64 KB

cmi-gettingstarted.md

File metadata and controls

104 lines (87 loc) · 6.64 KB
Raw

FAQ - How do I get started with CMI?

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.

ℹ️ Get Started with CMI

Note: This is perhaps important to mention. CMI is a big package, it covers a lot of server management topics, from kicks and msgs, to warps, kits, and custom commands. It's dynamic and flexible. And since every server is different: The approach to start might differ per server.

  • Don't forget to put the REQUIRED CMILib .jar in the ~/plugins/ directory as well!

  • Put the latest CMI .jar in the ~/plugins/ directory. Start the server back up and let CMI install.

(Upgrading? Then the instructions are basically the same, stay current, backup, test, etc.)

  • /stop the server and go through the following files:
config.yml (main configuration file, nitpick on features here)
Settings/Modules.yml (allowing you to globally turn on/off about 50 bigger features)
Decide if you want to use CMI for economy and as chat manager, and follow the steps in the economy and chat FAQ.
Go to the zrips.net -> cmi -> website and figure out which commands you don't want to give players, give them the base permissions cmi.commands, and then negate the ones they shouldn't have. 
Then find out which commands you want them to certainly have, and grant them these permissions. 
Setup homes, kits, warps, and start testing all the features.

  • By just using the website for commands and permissions, you will slowly learn what does what and how to do this.

  • For CMI permissions, I recommend LuckPerms as permission manager.

  • For the Economy, I recommend using CMI's custom compile of Vault 1.7.3.

  • For Chat, I recommend setting up groups, ranks, and their prefixes through CMI and Luckperms.

  • For importing data rom old EssentialsX to modern CMI? I recommend this guide.

  • And finally; /stop the server, and start it up again to guarantee that everything's working properly.