Skip to content

Latest commit

 

History

History
204 lines (169 loc) · 10.1 KB

cmi-trash.md

File metadata and controls

204 lines (169 loc) · 10.1 KB
Raw

FAQ - How do I create a trash feature in 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.

ℹ️ CMI Dispose (Trash)

Introducetion to Dispose CMI has a dispose feature, we can use this to dispose of items, if you want a trash bin, trash command, or both, this FAQ entry will walk through it. This is meant as an example to learn how to create your own features using CMI, without the need of other plugins, etc.

What we wish to achieve is a sign that players can right click that opens the menu, and a command like /trash that they can type that opens it. Optionally control permissions, configure the dispose command, etc.

Permissions If you want to control it through asConsole! you can skip the Alias.yml and Permissions customization, but for completion I will include it.

In the console you could type:

> cmi checkperm dispose
 1. cmi.command.dispose.others - Dispose of unneeded items
---->When command is used on another player<----
Base command required
 2. cmi.command.dispose - Dispose of unneeded items

And we see that in order to give players access to /cmi dispose that we need cmi.command.dispose you could add this through LuckPerms (permission manager) like so:

lp group default permission set cmi.command.dispose true

Optionally you could give the admin group the .others permission to manage disposing items on another player. But I doubt you really ever need that. Oh, and no need to restart or reload anything, LuckPerms permission updates are basically instant.

Alias.yml If you want to have this base command be accesiable without the /cmi prefix, so /cmi dispose becomes /dispose, then open the Settings/Alias.yml file and set the value for /dispose to true, and of course the same for /trash, like this:

  # /cmi dispose $1-
  /dispose:
    Enabled: true
    Tab: true
  /trash:
    Enabled: true
    Tab: true
  #

You can save the file and either restart the server or at least do a /cmi reload

Okay, the command will be live right away, especially after a /cmi reload, it will remain Red until you restart the server (so it can properly register the new command).

Trash Sign If you also want players to type [trash] on a sign that turns it into a trash bin for them to right click (which will then open the gui to cmi dispose) then go in-game and type this:

/cmi ic new trash

An in-game chat interface comes up, click on [Not Public] which changes it to a Public sign so everybody can use it using a particular permission.

If you want it 100% public, click on the green [ReqPerm] will remove the permission requirement. It should now show a grey text saying 'ReqPerm' instead of a green one.

Then click on the green + with hover text 'add block you are looking at', you should see particles around the sign now.

Now click on the orange exclamation ! with hover text 'switch to command editor', you should get a new + and ! in the chat.

Click on the green + with hover text 'add new', and as command, enter:

click:rightclick! asConsole! cmi dispose [playerName]

And again, please note that if you wish to check per group for those permissions, maybe just use cmi dispose instead.

Okay, we're basically done. But let's help the user identify they're using an official server trash bin by changing the text on the sign. There's a button in orange called 'EditSignLines', click that.

Click on the first line, there should be 4 max. [Empty Line], and type:

{#magenta}[trash]

And maybe click on the second line saying Empty Line, and type

~ ~ ~

And maybe the third and fourth one can be to give them a warning:

{#orange}Warning:
{#black}There's no undo!

Okay, we're basically done. The sign should work right away now. If you didn't make it public you might need to grant the appropriate groups the permission cmi.interactivesign.trash to give them access to make these trash signs.

To double-check your configuration, you could open Saves/interactiveCommands.yml and find the trash: section, it should look something like this:

trash:
  Locations:
  - world;12032.0;65.0;19098.0
  - world;-12601.0;63.0;-12149.0
  Commands:
  - click:rightclick! asConsole! cmi dispose [playerName]
  SignLines:
  - '{#magenta}[trash]'
  - ' ~ ~ ~ '
  - '{#orange}Warning:'
  - '{#black}There's no undo!'
  Public: true
  ReqPerm: false

Note: The world and xyz location obviously looks differently.

RegEx config

Okay, before they can start using [trash] on a sign, we have to make an adjustment to the cmi config.yml file. Changing it away from [ic:trash]. Open the yml file and find the follow section: InteractiveCommands: and set the regex value to this:

InteractiveCommands:
  # Regex used in recognizing public interactive commands used in signs
  # Default format is [ic:[icName]] in example [ic:trash]
  # If you want clean format use regex like: (\[([a-zA-Z0-9]+)\])
  SignRegex: (\[([a-zA-Z0-9]+)\])

Save the config.yml file and do a /cmi reload, you can now have a player test this if you want.

Done!

Okay, we're done. Players can now use:

/cmi dispose
/cmi trash
/dispose
/trash
and trash signs!

They get a GUI where they can dump their inventory in to dispose of their items.

And they can now also place a sign and type [trash] on it. Then it should change the way the sign looks to those lines we've set. And when they right click on the sign it should open the dispose interface.