Skip to content

Latest commit

 

History

History
104 lines (87 loc) · 7.52 KB

cmi-eventcommands.md

File metadata and controls

104 lines (87 loc) · 7.52 KB

FAQ - CMI Event Commands Information

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.

ℹ️ CMI EventCommands.yml Introduction

A file you can find in the ~/plugins/CMI/Settings/ directory, it's called eventCommands.yml and has a set amount of events that you can use to run commands, even with conditions, to extend the functionality and management of your Minecraft server. It is very dynamic and flexible, but do be aware that the more events and commands you add, the more time the server will need to process it all. Be mindful of the potential performance impact.

Custom Join / Leave Messages

You can use CMI to turn off the default join/leave messages via config.yml, and you can indeed use eventCommands.yml, but personally since I use the CMI CHAT feature of CMI anyway as chat manager, I do prefer (and recommend) to use this method instead: faq.cmi.support/joinleave

A note to make here is that it is really cool how dynamic CMI is, you can use the above method for custom join/leave messages, and on top you can still use the event commands feature to extend it. For example, add a custom message to first time players, or a special announcement when a founder or donator joins. Or maybe a private message that only a staff or team member would see.

For example, in combination with LuckPerms you can check against the highest group and send out a broadcast to everybody when a player in the VIP group has joined:

joinServer:
  Enabled: true
  Commands:
  - delay! 0.4
  - check:%luckperms_in_group_vip%==yes! broadcast! {#Denim>} OMG, a &lVIP
    player{#Cerulean<>} just joined!!{#Denim<}\n&r

Pro tip; to better control the join event and when a message shows up, I do suggest to consider using a tiny delay of 0.3 or 0.4 with the join event. Giving the welcomeMessage some time to display, as well as the custom message to show after the regular joined-server message. Every server configuration is different; test!

Message of the Day (welcomeMessage.txt, /motd)

The welcome message you can send players when they join the server can be handled by 'Settings/EventCommands.yml', but personally since it's a built-in feature of CMI, I do prefer (and recommend) to use that instead. All you have to do is make a ctext (custom text) file called welcomeMessage.txt and put it in the CustomText/ directory (and /cmi reload). More about this, and how to add the old familiar /motd command, is all explained here. faq.cmi.support/motd

ℹ️ Misc

You can find the default file here in case you need it: Settings/EventCommands.yml

And here's an alternative version by me that has all the events enabled, handy for debugging: eventCommands-debug.yml, by the way, here are some screenshots of how that looks