Skip to content

Installation

lokka30 edited this page Jul 13, 2021 · 19 revisions

Welcome to LevelledMobs! Here's how to install & update the plugin.

Server Requirements

Before you install the plugin, ensure that your server meets the criteria for LM to run on it:

  1. Must be running Minecraft 1.14.x to 1.17.x. In most cases: the newer, the better.
  2. Your server software must be based off of Bukkit. Popular examples are SpigotMC, PaperMC, Tuinity and Purpur. We highly recommend you use PaperMC. LM can also run on CraftBukkit, although not with full feature support.

Installation Instructions

Once you've sorted out the plugin's requirements of your server and what dependencies you may want to install alongside it, here is how to install LevelledMobs!

To update the plugin, simply delete the older version's file and follow the installation steps below. If you're downloading for the first time, follow the installation steps below.

  1. Download LevelledMobs.
  2. If you wish to see LevelledMobs nametags, you must also download ProtocolLib.
  3. Move the downloaded file(s) into your server's /plugins/ directory.
  4. Stop your server if it is already running. Afterwards, start it back up to let LevelledMobs generate its configuration files.
  5. Go to your server's /plugins/LevelledMobs/ folder and edit the configuration files to your liking.
  6. Save your edits and run /lm reload to apply your changes to the configuration files.
  7. Done, we hope you enjoy LevelledMobs! :)

Optional Dependencies

The following plugins can be installed at your choice to improve LevelledMobs' functionality. Ensure you get the correct plugin version for your Minecraft version, as the latest versions of some of these plugins don't work with older versions.

  • ProtocolLib allows LM to display custom nametags above the levelled mobs' heads. Most server owners would want this. Highly recommended.
  • WorldGuard allows you to restrict if levelled mobs can spawn in defined regions of your worlds, and optionally what min/max level they are allowed to have there. Perfect for creating dungeons or special zones in your worlds!
  • PlaceholderAPI will allow you to use LM placeholders in other PAPI-enabled plugins and will also allow you to use PAPI-enabled plugins in LevelledMobs 3.1+'s player-levelling system.
  • NBT API will allow you to specify NBT data in the custom drops system.

Updating LevelledMobs

How do I check for updates?

We recommend checking your Spigot alerts every week (less is better, a little over a week is fine), as LevelledMobs receives updates around every one to three weeks.

Ensure that once you have downloaded LevelledMobs, you are 'watching' the resource (should be below the download button). This means you will receive alerts every time an update is released.

I see an update was released!

Prior to hitting the Download button on the update, please read the 'important notes' part of the changelog, if it is specified. Small updates are unlikely to include this. We also recommend you read the rest of the changelog so you are aware of what we have adjusted, although this is not required.

Layout of the Update Notes

Update notes are provided with each update entry. These contain the following sections:

  1. Important Notes (sometimes not included)
  • If there is a highly important change or announcement we must make with an update, then it will be included here, at the top of the page.
  • Please carefully read this section. If you don't understand something, please contact us on our Discord server.
  • Example: 'Drastic change has been made to Custom Drops, please adapt the Custom Drops config after you run the new update.'
  1. Notes
  • Things which may be of interest to you.
  • Example: 'settings.yml has been modified, but the Migrator will automatically update your old settings file.'
  1. Changelog
  • All of the changes that the developers of the update have recorded of the new version.
  • Example: 'Improved performance; code clean-up; fixed minor bugs regarding Spawn Distance Levelling.'

... and that's all. We try our best to make the important information easily accessible to server administrators so that they aren't surprised (in a negative way) when they update the plugin. πŸ˜ƒ

I have downloaded an update - how do I install it?

  1. Download the latest stable version of the plugin from the SpigotMC resource page.
  2. Stop your server if it is already running. If your server is not running, proceed to Step 3.
  3. Remove the old version of the LevelledMobs plugin (the .jar file, NOT the LevelledMobs folder), which is in your /plugins/ folder.
  4. Move the new version of the plugin into your server's /plugins/ directory.
  5. Start the server back up when you are ready. LevelledMobs will automatically update any of your old config files if the new version has changed them.
  6. If any new settings were stated in the update notes, you can edit them in the configuration files in the /plugins/LevelledMobs/ folder.
  • If you make any edits, you should save the files, and then run /lm reload to make LevelledMobs apply the new changes (or re-start your server).
  1. You're all updated! πŸ˜„
Clone this wiki locally