ExcellentCrates Minecraft Plugin
By Dalton Whalen
Obtaining items is a staple part of Minecraft servers, whether they are used for survival, decoration, or other crafting materials. Oftentimes, owners will provide systems to allow players to gain more items through tasks or rewards. One of the most common ways to achieve this is with a plugin like ExcellentCrates. With this 1.17 and up plugin, you can create and modify nearly every aspect of your custom crates. Use any block, customize cost, and much more. Installing plugins is streamlined with our Apex Hosting panel, so we have created this tutorial to help you get started.
- Ability to make any block or inventory item a crate
- Unlimited rewards per crate
- Supports any custom item as a reward
- Configure limits and cooldowns on various rewards
- Customize particle effects around each crate
- Adjust required keys, currency, or exp for crates
- Compatible with Holographic Displays and Citizens
- Visit the ExcellentCrates Spigot Page.
- Press the blue
Download Nowbutton in the top-right.
- When prompted, save the .jar file to a safe location.
- Afterwards, proceed to the NexEngine plugin GitHub.
- Click the
NexEngine.jarfile, then save it to your computer.
If you wish to download a specific release of ExcellentCrates, enter the
Version History tab, then press
Download next to the desired version.
- Navigate to your Apex Server panel, then stop the server.
- Scroll down to the
Game Filesection and make note of the version.
- Ensure it is plugin-compatible, such as Spigot or PaperMC.
- Afterwards, enter the
FTP File Accesson the left-hand menu.
- Locate or create the
pluginsfolder, then enter it.
Uploadin the top-left, then drag + drop the .jar files.
- Once at 100%, return to the main panel page.
- Restart the server to load up ExcellentCrates for use.
How to Get Started
Now that the plugins are installed, you can begin creating your desired crates. There are plenty of options to customize for each one:
Creating a New Crate
Once you are ready, start by using the /crate editor command from in-game. This will open a GUI menu, allowing you to click the chest item to manage crates. Afterwards, press the anvil to create a new crate.
You will then be prompted to enter a unique crate identifier, which is its ID. Enter any name you deem applicable, such as “Test”, in the chat bar. Once entered, your new crate will now be available within the GUI menu.
Modifying your Crate
From the crates manager, select your specific crate to open the editor menu. These will have a large amount of options to modify to your liking. This is useful for adding animations, the rewards, and other aesthetics. Some additional options will be available, but they will require extra plugins such as Holographic Displays or Citizens.
|Permissions Requirement||Toggles whether or not a permission is required to open the crate.|
|Display Name||The crate name that appears in chat messages.|
|Attached Citizens NPC||Adds an NPC as a crate. (Requires Citizens plugin)|
|Animation and Preview Config||Sets the layout for previews and opening animations.|
|Inventory Item||Set the crate item that displays in menus and can be opened from an inventory.|
|Keys||Sets which key(s) can be used to open the crate.|
|Reward Manager||Create and manage the potential crate rewards.|
|Open Cooldown||Adds or disables a cooldown between opening the crate.|
|Block Hologram||Allows text to appear above the crate. (Requires Holograms plugin)|
|Block Effect||Customizable particle effects to appear around the crate.|
|Open Cost||Select the currency or exp level requirement to open the crate.|
|Block Pushback & Locations||Place the crate within your world or toggles pushback.|
|Delete Crate||Deletes the crate entirely. (Requires shift-click to confirm)|
Before you can place your crate down, you must first add some rewards. To do this, enter your crate options menu from earlier, press the emerald symbol, then press New Reward. Similar to previously, you will be asked to enter an identifier for your reward. You can now open the rewards editor and access more options.
|Display Name||The reward name used in messages.|
|Preview Item||Which item is represented in rewards and holograms.|
|Win Chance||Sets the chance that the reward will be selected.|
|Reward Items||Customizes which item(s) can be won.|
|Reward Commands||Which commands are activated when the player earns this reward.|
|Broadcast||Toggles whether or not a broadcast message is displayed when won.|
|Win Limits||How often/how many times this reward can be won by a player.|
In addition to programming rewards, it is also recommended to program some crate keys. Once added, it means that you can only open the crate once you have the desired key.
To get started, go to the /crate editor menu, but enter the Key Manager instead. Just like before, create a new key, then enter an ID for it. If desired, adjust the key options to change the name, item, and whether or not the key is digital.
Add the Key to a Crate
With your key created, you can now add it to your crate for use. Enter the options menu for your crate, then click the “Keys” option. From here, enter the ID for your key, or select one of the suggested values in the chat.
Placing the Crate
You are now finally ready to place your crate! It can be added to any block, whether it is a chest, lectern, and more. To start, place your desired crate block within your world. Then enter the options menu for your crate. Click the chest icon, then right-click the desired block.
Just like that, your new crate will be accessible to anyone that has a key! This is a great option to give players something to work towards or as a reward for server activities like voting. The options are entirely customizable, allowing players to open crates with currency or exp and gain specific rewards if they are lucky. It is recommended to create a variety of crates, each with their own purpose and rewards.
The plugin commands are not working:
If none of the plugin commands seem to be working, try to use the /plugins command from in-game. If no plugins are listed, ExcellentCrates has not been installed correctly. Return to the FTP File Access and ensure that the both .jar files have been uploaded directly into the plugins folder. If the dependency is missing or the files are in another location, they will not be read by the server. Once fixed, restart and try it once again.
I don’t have permission to use commands:
In order to use any of the commands provided by the plugin, you must ensure you have access to commands. To gain access to all commands, simply op your player. For specific permissions, consider using a plugin such as LuckPerms. Once either option has been achieved, continue the configuration as normal.