Skip to content

Latest commit

 

History

History
107 lines (92 loc) · 5.85 KB

cmi-rules.md

File metadata and controls

107 lines (92 loc) · 5.85 KB
Raw

FAQ - How do I configure CMI for /rules?

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.

Note: Since CMI version 9.0.3.x you can create your own .yml files and store them in the ~/plugins/CMI/CustomAlias/ directory.

A dynamic and flexible way of displaying /rules.

ℹ️ CMI can handle custom /rules

  • Inside the plugins/CMI/CustomText/ directory there is already a file called rules.txt, you should go through this and adjust it to your server rules.

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 /rules command. A lot of servers have it, and you can then refer to it in Automated msgs, warnings, etc.

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 rules and press enter. Then click on the new green + to add a command, which should be: cmi ctext rules. (Note: The command will work, but shows red until you restart the server)

  • Optionally, if you want to give first-time players some extra rules attention, you can customize the eventCommands.yml file at this section:
firstJoinServer:
  Enabled: true
  Commands:
  - cmi ctext rules [playerName]
  • Optionally, you could go through config.yml and adjust warnings to say Warning received, please play within our /rules, or you could adjust schedules.yml to include a repeating rules-reminder. For example:
RulesReminder:
  Enabled: true
  MinPlayers: 1
  Delay: 1500
  Repeat: true
  Randomize: true
  Feedback: false
  Commands:
  - broadcast! &3 Reminder »&b Please play by the /rules
  • And finally; /stop the server, and start it up again to guarantee that everything's working properly.