ItemRestrict
Use this plugin to ban items and blocks for Bukkit, Tekkit, and FTB servers using the Bukkit API. ItemRestrict removes banned items from the world and player inventories. It is easy to configure, can be applied retroactively, and automatically removes the items. It requires no permissions plugin unless exceptions are need for certain players. It is compatible with 1.2.5, 1.3.2, 1.4.7, 1.5.2, 1.6.4, 1.7.10.
Because every story that starts with "We decided to make a change..." shouldn't end with "...so we had to reset the world."
Installation
Copy the .jar file into your plugins folder to install the plugin. Then restart the server or use a plugin manager to load the plugin.
Commands
Use the command "/ires reload" to reload the config file.
Command | Permission Node | Description |
---|---|---|
/ires reload | itemrestrict.reload | Reload the config |
/ires ban <banType> <id-datavalue> | itemrestrict.ban | Add item to the ban list |
/ires unban <banType> <id-datavalue> | itemrestrict.ban | Remove item from the ban list |
Configuration
There are 4 major sections in the cofig file (config.yml). Enabled worlds are listed under Worlds. World Ban scanner settings is under Scanner. Ban settings are under Bans. Notification settings to the player are under Messages. A default config for Tekkit was generously created by BigScary.
Worlds listed in the Worlds section are enabled worlds which will be checked by the plugin. You can name normal worlds, dimensions, and mystcraft worlds by using the world's folder name. Add the case sensitive world called "All" to bypass the world check.
The Scanner settings indicate the percentage chance (from 0 to 1) that it scans a loaded player or a loaded chunk.
You can specify the items you wish to ban under the Bans section. Take a look at the different types of bans below. An entry with only the item id (32) will specify ALL wool (all datavalues). An entry with the item id and datavalue separated by a dash (32-2) specifies MAGENTA wool (datavalue 2). Some items have a different values in your inventory as opposed to ones place in the world (eg. a door item in the inventory versus a placed door in the world). A full list of Block IDs will help you add banned items.
The label gives the item a name when notifying the player. The reason provides the reason of why the item was banned for them. You can use colour with both the label and the reason by using the escape character "&" and a hex number corresponding to the minecraft colour.
Permissions
Making Ban Exceptions
You can make individual ban exceptions to give some players to generally banned items through permission nodes. A player who has /op automatically ignores bans. Specifying the item ID without the datavalue means all data values (-*). Here are various examples, which should help you understand without further explanation.
- ItemRestrict.bypass.usage.35 - ItemRestrict.bypass.ownership.35-6
You can't prevent a specific player's placed block from being removed from the world as this plugin does not track who owns placed blocks in the world.
Types of Bans
Usage Bans
This ban prevents players from using an item, which means left-click or right-click while the item is in-hand. This ban also prevents players from right clicking a block specified by this ban. This ban also prevents a player from building a block in the world. This works well for items like the Mining Laser, but won't stop players from using items which benefit from passive use (eg. modded armors, Talisman of Repair, etc.). You will need an ownership ban to prevent players from getting those items at all. A player that already has an item which is later placement-banned can still trade it with another player or break it down into energy (EE mod) to get some value out of it.
It's not possible for any plugin to prevent a player from using an item when it is activated by a keystroke (eg. R, G, C, etc.), which are common especially for Equivalent Exchange items. This is why many EE items are on the default ownership bans list even though their functions are not all really ban-worthy.
It is recommend to place most or all usage ban items to your ownership ban list. This will prevent your players from unknowingly spending their resources to craft a block which they then can't place in the world like they planned leading to them feeling cheated and likely complaining. The only exception you might make to this rule is for an item which can't be placed, but is still useful because it's an ingredient in another recipe for an item you haven't banned.
Ownership Bans
This ban prevents player from picking up an item from the ground or from a container (eg. a chest). If a player doesn't have permission to own an item, they won't be able to craft it. The contraband scanner will search each player's inventory for ownership-banned items and actually remove them without warning, notification, or compensation.
This ban also prevents players from crafting an item. When the player tries to craft the item, they get a message that they can't. This is the most player-friendly approach to preventing players from getting banned items. Forge mods don't always hook into Bukkit, meaning its possible for players to get banned items through some automatic or non-crafting approach (eg. alchemy). When you crafting-ban an item, test for workarounds, which may lead you to ban additional items to prevent those workarounds.
World Bans
This ban will retroactively remove the placed block from the world through the Asynchronous World Scanner (AWS). This is great if you need to ban an item, but also know it's in the world (eg. energy collectors and world anchors). This will help clean up newly-banned items without having to search your entire world for them. There are exceptions to this removal as the scanner can't determine who owns the block.
Notes
This plugin uses the idea from BigScary's TekkitCustomizer. However all components in his code have been replaced with high performing and simple implementations. As a server administrator, I care about performance as much as you. Thus no code is actually used from the TekkitCustomizer plugin and the source code can be found here.
The default ban list is made for Classic Tekkit based on hands on testing done by BigScary. Before deciding to remove items from this list, be sure to read the reasons for default bans to understand why it was originally removed. If you are running FTB, Tekkit Lite, or other mod packs, do your own research for what you want banned and change the config file accordingly.
Save yourself some time! Check our Frequently Asked Questions page for the answer to your question. If you found a bug, make a ticket and include your config file.
Reviews
Spanish
Supporters
Thank you to piritacraft for testing each ticketed issue. Thank you to excavator5 for testing the plugin.
Thank you to our contributers that have helped contribute to this project:
- Slind14 from mineyourmind.net
- maxmar628
Thank you to our supporters that have generously donated to ItemRestrict:
- Thundercoyote
Donations
Unlike other players who have a choice to play the game, my commitment to development and administration usually means I cannot and I'm fine with that choice. A lot of my free time is actually spent designing, developing, testing, and fixing plugins like this one to make Minecraft more enjoyful for all players. If you like this plugin, please consider sending me a donation by clicking the button below :) Thanks!
@natedog1177
same here the plugin is buggy
Hi, I am using this plugin on my 1.6.4 FTB dw20 server the plugin is not working
http://pastebin.com/H5Nd06fV
Leaving the config the way it is as its loaded by default, none of the items are banned that are listed to be so in the config. anyclue on what could be wrong. I loaded a test account on my server and it could still use/interact with bedrock and sponges.
I apologize for the inactivity in fixing issues in this plugin. I have been inactive to finish off the final year of my University degree. I will be resuming development within a week!
sorry posted to wrong one
@signition
you would set it up in your permissions on a per world basis ban them outright, but in world X give them a bypass permission for item D
and so on and so on
Is it possible to separate bans between worlds? For example, I want to ban mining laser in entire world, and only want to ban some equippable bags in tutorial world. Is it possible to set different ban list for different worlds? If then, how do i do it?
Got this plugin to work but it drops items instead of deleting them...
that's a problem because people just pick up the banned item and soon they start juggling them
Amazing plugin!
Use it on all 3 of my servers :)
@Nanakisan
"/ires reload" is the only command I've ever used. Make sure to check console for messages reporting config errors if any.
You may try "/ires ban {action} {id}" & "/ires unban {action} {id}" where action is usage, equip, crafting, ownership or world.
@Nl_crafter
World ban defaults to 0.1 meaning there's only 10% change of it to check for bans when loading a chunk. When banning new blocks you might want to temporary set it to 1.0 to sacrifice your TPS to actually cleanup the world. Remember to turn it back down afterward to reduce the lag.
@TonyVS
No can do
@poncjusz
you probably have twice the same ban in your config.
@bunnyhop100
you can set the % change of it to scan globally to all worlds. Mystcraft ages are known to be laggy due to their randomness (having crazy amount of entities or instability can kill your server pretty bad). Also some mods don't like certain combination of worldgen, notably void island style.
Works just fine and way better than others in MC1.5
@Nanakisan
This is exactly true. I'd just use the Tekkit customizeer.. this things entirely ripped from it.. It says "based upon" but it auctually means even the explanation is copy pasted from the other plugin..even the motto is stolen. even the banning pink wool has been jacked from other plugin.... lol.
This plugin does not work, like at all. Waste of time to even download sadly, and there's been no reply since Dec.12 from the creator so I'm gunna assume this died.
Sad... looked so promising. = :3
This plugin doesn't work
Is there any concise documentation on this plugin? A video perhaps? The description is lacking extremely in command syntax. Every attempt to use the in-game help results in it saying /ires. Nothing else nothing more.
The world ban is not working for me. Blocks are not getting retroactivly deleted from the world. I am trying it with itemducts from thermal expension, chunkloaders from chickenchunks and bookbinders from mystcraft and they all won't get deleted. Can anyone help me?
Hello, I am new to this plugin but based on the name I am hoping it will do what I need. How do I restrict the number of items vs just banning them all together, Take buildcraft quarries for example, I would like to ban it on the overworld but restrict it to 1 per person in mystcraft ages (to keep the loaded chunks down.) I at first though - ItemRestrict.bypass.ownership.35-6 meant item 35 restricted to 6 of them, now I know you mean pink wool (cause it is too awesome for you) that made me chuckle. Thanks
How can I set in label section a universal description of all objects on the banned list?? Ex: Label - "An extraordinary item". Reason - "Stupid idea..."
Another problem - a message after player try craft banned item on crafting table is doubled (repeating). So, its take 4 lines, not 2 (baned,reason, baned reason insted just baned, reason).
Is there a way to disable itemrestrict from operating the world scanner component? I believe it's causing some problems for my mcpc+ mystcraft worlds.
will it block the item damage too? the sword,axe,something like that,i want block that
Is it possible to ban certain items for 1 world, and then other items for another world?