Skip to content

Latest commit

 

History

History
158 lines (138 loc) · 7.04 KB

cmi-hexcolors.md

File metadata and controls

158 lines (138 loc) · 7.04 KB

FAQ - How do I use Hex Colors 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.

How to use CMI to deal with Hex color support. More information on the official site zrips.net here


ℹ️ CMI can handle Hex Colors

Expected format: {#8b4726}

  • Set-up CMI to handle the chat. In Settings/Chat.yml, find the following, set to true:
Chat:
  ModifyChatFormat: true
  ClickHoverMessages: true
  • Then, make sure CMI is properly configured for your server, so please read and go through the Colors: section and adjust accordingly. In Settings/Chat.yml, find the following, set to true:
    PublicMessage: true
    PrivateMessage: true
    Me: true
  • Optionally, if you wish to use Hex colors in your custom join/leave messages or other features, you must enable their CMI Module: In Settings/Modules.yml, find them and set them to true:
customMessages: true
firstJoinMessages: true
bossbarmsgs, holograms, tablist, etc.
  • A bunch of things that have CMI Hex color support:
/cmi itemname
/cmi itemlore
tablist.yml
/cmi nick
/cmi ctellraw
holograms
bossbarmsg
actionmsg
titlemsg
/cmi broadcast
in-game chat
private msgs
chat room msgs
/cmi dye
/cmi anvil (item naming)
... basically anything that CMI controls.
  • A bunch of things that do not have hex color support:
/cmi glow
  • Commands: (Note: If you want /command, instead of /cmi command, then set the command to true in Alias.yml)
In-game or on the console, type:
cmi checkcommand color
  • CMI Permissions: (Note: The zrips.net hex colors page explains color permissions in detail.)
In-game or on the console, type:
cmi checkperm color
  • Note: You can use any valid {#hexcolor}, but the 1500 from CMI can't be customized.

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


Other HEX formats

If your CMILib and CMI are both up to date, you will be able to set true for these settings to use janky alternative hex. Find this in: cmilib/config.yml

Colors:
  # When enabled plugin will try to detect simplified hex color codes like #f6f6f6 or #ff6 in addition to {#f6f6f6} and {#red}
  # Keep in mind that this adds extra checks and the simplified format will not support gradients or named colors so you will still need to use a more complex format for those
  OfficialHex: false
  # When enabled plugin will try to detect quirky hex color codes like &#f6f6f6 or &#ff6 in addition to {#f6f6f6} and {#red}
  # Keep in mind that this adds extra checks and the quirky format will not support gradients or named colors so you will still need to use a more complex format for those
  QuirkyHex: false