Skip to content

Latest commit

 

History

History
122 lines (102 loc) · 6.76 KB

cmi-chatrooms.md

File metadata and controls

122 lines (102 loc) · 6.76 KB
Raw

FAQ - How do I setup CMI Chat for chatrooms?

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 Chat Rooms feature (information, commands, permissions, etc)

The CMI Chat feature allows players to create public and private chat rooms that people can join, away from the global chat.

Commands: (CMI works best if you properly configure your config.yml and your permissions.)

/cmi chat
You can toggle it to true in alias.yml so you can use /chat

Syntax:
/cmi chat [create/join/leave/list/invite/kick] (chatName/playerName) (-private) (-locked) (-persistent)

Permissions: (LuckPerms allows you to grant and negate permissions per user, group, rank, world, etc.)

cmi.command.chat.kick - Allows to kick players from chat room
cmi.chat.rangebypass - Allows to send messges over greater distances
cmi.command.chat.create - Allows to create chatroom
cmi.command.chat.invite - Allows to intite player into chatroom
cmi.chatgroup.[groupnumber] - Defines player custom chat group for public message format
cmi.chat.shout - Allows to send messges over greater distances
cmi.command.chat.create.private - Allows to create private chatrooms
cmi.command.chat.list - Allows to list players in chat room
cmi.command.chat.joinbypass - Allows to join private chat room without invitation
cmi.command.chat - Create and join chat rooms
cmi.command.chat.listrooms - Allows to list all chat rooms

Some information from the changelogs:

By default, if nobody's left in a chat room it will delete itself after about an hour.

Permission cmi.command.chat.joinbypass allows you to join a private chat room without an invitation.

Command /cmi listroom will display basic information about the available chat rooms. Requires permission cmi.command.chat.listrooms (private rooms are still protected and you will need invitation or bypass permission)

You can create private chat rooms by adding -private. (Players will require an invitation to join private chat rooms)

Players who got invitation to private chat room can rejoin chat room as many times as he wants, until he gets kicked from it.

-private will make chat room accessible only with invites from room creator

-locked will prevent players from leaving chat room

-persistent creates room which remains after server restart

Note: To remove a persistent room, you have to delete it manually from the chatRooms.yml file. Then /cmi reload, make sure to kick people out of the room first.