Skip to content

Latest commit

 

History

History
182 lines (153 loc) · 10.3 KB

cmi-import.md

File metadata and controls

182 lines (153 loc) · 10.3 KB
Raw

FAQ - How can I import from other plugins into 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 can import data from EssentialsX

  • Configure CMI to your liking.

  • Then turn on Maintenance mode:

/cmi maintenance true Working on the server, back later
/stop

  • Start the server again. You will do this quite a few times, hence why I recommend enabling maintenance mode, and to do the rest from console.

  • Do not let anybody, including yourself, login to the server. Work from console.

  • First I would import old users into CMI, if possible: Note: When it's done, do a little save-all, stop, and start the server again.

cmi importoldusers
save-all
stop

  • Start the server again.

  • EssentialsX does not need to be loaded to import data to CMI. The only thing that is needed is the plugin's folder. Read up on this page first: https://www.zrips.net/cmi/faq/

  • Now to import from EssentialsX, and still from console. Note: After each imported bit of data, do a save-all, stop the server, and then start the server again. Next, confirm the imported data is there, if possible.

cmi importfrom essentials home
save-all
stop
  • Start the server again. If the data was successfully imported:
cmi importfrom essentials logoutlocation
save-all
stop
  • Start the server again. If the data was successfully imported:
cmi importfrom essentials mail
save-all
stop
  • Start the server again. If the data was successfully imported:
cmi importfrom essentials money
save-all
stop
  • Start the server again. If the data was successfully imported:
cmi importfrom essentials nick
save-all
stop
  • Start the server again. If the data was successfully imported:
cmi importfrom essentials warp
save-all
stop

  • Although this is annoying, some servers may have issues doing it all at once. This is what worked for me. Going through it one by one, and checking the data in between. If something worked, I would make a backup, so that I have a copy I can roll back to and try again in case anything goes wrong.

  • Next, CMI also has a worth.yml file. You can simply drop the Saves/Worth.yml file from EssentialsX into the CMI folder, and it will overwrite CMI's worth file.

  • CMI doesn't have a kit importer, but, you can create the kits in-game using /cmi kiteditor, give yourself the kit from EssentialsX, then put those items in the CMI kit, and you're set.

  • World management addons from EssentialsX are not 100% in CMI, but most features are, and even more so GriefDefender, Zrips' Residence, or WorldGuard, all have world management features that do exactly that anyway.

ℹ️ CMI can import data from HolographicDisplays

  • Configure CMI to your liking.

  • Then turn on Maintenance mode:

/cmi maintenance true Working on the server, back later
/stop

  • Start the server again. You will do this quite a few times, hence why I recommend enabling maintenance mode, and to do the rest from console.

  • Do not let anybody, including yourself, login to the server. Work from console.

  • HolographicDisplays does not need to be loaded to import data to CMI. The only thing that is needed is the plugin's folder. Read up on this page first: https://www.zrips.net/cmi/faq/

  • Now to import from HolographicDisplays, and still from console. Note: After you have imported the data to CMI, do a save-all, stop the server, and then start the server again. Next, confirm the imported data is there, if possible.

cmi importfrom hd
save-all
stop

  • Start the server again. If the data was successfully imported:

  • Check the FAQ here, to see how to get started using CMI, for example how to setup CMI as a chat manager and an economy manager, how to setup BungeeCord chat, custom /help, custom /rules, deal with NuVotifier votes, hex colors, how to setup custom alias commands or configure CMI's base commands, etc. https://github.com/mrfdev/CMI/tree/master/Resources/FAQ

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

ℹ️ Unofficial Import Tool

Someone recently made me aware of this import tool. Please note that I did not review the code, or the provided jar file. Please vet it before using it yourself. It's not an official tool, using it is at your own risk. But I think it's worth mentioning. This should help servers with loads of kits to maybe do the bigger part of the import work, after which they can clean things up.

ℹ️ FAQ

  • How can I use all the EssentialsX commands and aliases?

A lot of them are in the Settings/Alias.yml file of CMI. I would recommend going through them. I also have an Alias_true.yml file on my GitHub repository, under Resources > Alternatives > Alias_true.yml, where all of the commands are set to true.

Although some of the EssentialsX commands and aliases are there, you may notice that not all of them are there. If you want to be able to use all of EssentialsX's commands and aliases in CMI, you can use this addon that I've made, that manually adds all the missing commands and aliases from EssentialsX to CMI. Read the information before downloading, and be sure to backup your data before using it.