Installing a Plugin using Multicraft Control Panel

A general guide for installing and configuring CraftBukkit plugins. Covers both JAR files and archives (eg .zip).

Plugin Files

A plugin file is a Java Archive (JAR) containing files and run-time code that is in a format recognised by the CraftBukkit Server. They are used to over-ride or extend the functionality of a Minecraft server. The most common used plugin type are concerned with managing player permissions, letting server owners have control over what players can and can't do. World protection plugins that manage building and demolition rights in specific areas are probably the next most popular, some even support the ability rewind block changes made by TNT, fire, water or a specific player. Most Plugins have an entry over at Bukkit.org, have a browse to see what else is possible.

How CraftBukkit Identifies and Attempts to Load Plugins

When CraftBukkit launches it will open the plugins directory on your server and look for files with a .jar extension. In each JAR file it will look for a plugin.yml file. This is a configuration file that tells CraftBukkit firstly that it is a plugin so that its contents can be copied into memory, it also tells CraftBukkit which file needs to be run first. The next pieces of important information plugin.yml contains are any server/chat commands that the plugin adds, definitions for permissions to functions of the plugin, and a list of any other plugins that this plugin is dependant upon. The plugin.yml also contains other useful meta-information such as the plugin name, the version number, the plugin's author.

Using all this information, CraftBukkit can decide upon an order in which to load the plugins and add their commands and permissions to the server.

Adding a Plugin from the Plugin List in Multicraft

Installing a JAR file Plugin

  1. Log into Multicraft
  2. Browse to your Server
  3. Click on the 'Plugins' link in the navigation column on the left
  4. Locate the plugin you wish to install in the list
  5. Click on the 'Install' link in the right-most column. The JAR file will be copied to the /plugins folder on your server
  6. If successful the 'Install' Link will change to 'Remove' and the icon will change to a brick with a green plus sign
  7. CraftBukkit will attempt to load the plugin the next time the server is started. You can confirm that it has loaded by checking the Console when the server starts


Installing an Archive file Plugin

Some plugins need to install more than one file. In this case the files and their file structure are preserved within an archive file, typicall in a ZIP format. Multicraft is capable of extracting these archives to the /plugins folder.

  1. Log into Multicraft
  2. Browse to your Server
  3. Click on the 'Plugins' link in the navigation column on the left
  4. Locate the plugin you wish to install in the list
  5. Click on the 'Unpack' link in the right-most column. The archive will be extracted to the /plugins folder on your server
  6. NOTE: Multicraft does not check if the plugin files all unpack correctly, icons and links in the Plugins page will not change
  7. CraftBukkit will attempt to load the plugin the next time the server is started. You can confirm that it has loaded by checking the Console when the server starts


Locating and Editing Config Files

Many plugins offer the abilty to change how they function by making changes to configuration files. Multicraft lets you find and edit these files as long as they have a .txt .csv .xml or .yml extension and are located in the \plugins folder or one of its sub-folders.

 

  1. Log into Multicraft
  2. Browse to your Server
  3. Click on the 'Config Files' link in the navigation column on the left
  4. You will be given a list of all the files Multicraft finds and their location, config files for a particular plugin will typically be located in a sub-folder named after the plugin
  5. Click on the link in the first column to open the file in a plaintext editor
  6. Once you have finished editing the file, click the 'Save' button to commit your changes
  7. Changes will not take effect until the server is restarted. However, some plugins may have a command to reload the config files

For files not located in the /plugins folder you will have to use FTP to gain access to them, check out our FTP guide.

Take care when editing these files, it's possible to make changes that prevent a plugin, or even the server itself, from loading. Take particular care when editing .yml files, they have a hierarchy dependant upon line indents. Copy the text into a tool like Notepad++ or the Online YAML Parser to help you validate the file.

Further Reading/External Links

 

  • 15 Users Found This Useful

Was this answer helpful?

 Print this Article

Also Read

Installing and Updating Plugins Using the BukGet Tool

As of version 1.8.0 of Multicraft you can now use the BukGet tool to download and install any...

How to Install Tekkit Classic Plugins & Plugin List

If you want to install Bukkit plugins on your Tekkit Classic server then the latest versions will...

Updating your Plugins using Multicraft Control Panel

Every time CraftBukkit server is updated plugin developers normally update their plugin to be...

Installing a Minecraft Plugin using FTP

Plugin Files A plugin file is a Java Archive (JAR) containing files and run-time code that is in...