Skip to content

Latest commit

 

History

History
95 lines (81 loc) · 5.66 KB

cmi-help.md

File metadata and controls

95 lines (81 loc) · 5.66 KB
Raw

FAQ - How do I use CMI to make a custom /help command?

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.

A dynamic and flexible way of displaying /help.

ℹ️ CMI can handle custom /help

  • Inside the ~plugins/CMI/CustomText/ directory you can put a file called help.txt.

Of course, you can use the CMI Custom Text features to expand on this, using pagination, other placeholders, clickable events, etc. More information here: https://www.zrips.net/cmi/custom-text/

  • Next, you can make a /help command. To achieve this go in-game and create a new custom alias using: /cmi aliaseditor and click the green + to add a new command, type in the name help and press enter. Then click on the new green + to add a command, which should be: cmi ctext help.

  • Optionally, if you want to give different groups additional text, you can customize the alias to different .txt files and use perm:custom.help.groupname! cmi ctext help2 [playerName] (note that help2 refers to help2.txt, it can be whatever you want and have created)

Example

- cmi ctext help2 [playerName]
- asConsole! perm:custom.help.vip! cmi ctext helpvip [playerName]
- asConsole! perm:custom.help.staff! cmi ctext helpstaff [playerName]
  • And finally; /stop the server, and start it up again to guarantee that everything's working properly.