ItemRestrict

Icon

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.

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.

CommandPermission NodeDescription
/ires reloaditemrestrict.reloadReload the config
/ires ban <banType> <id-datavalue>itemrestrict.banAdd item to the ban list
/ires unban <banType> <id-datavalue>itemrestrict.banRemove 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.

Supporters

Thank you to piritacraft for testing each ticketed issue.

Thank you to our contributers that have helped contribute to this project:

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!

donate!

You must login to post a comment. Don't have an account? Register to get one!

  • Avatar of krisdestruction krisdestruction Oct 03, 2013 at 16:48 UTC - 0 likes

    Sounds like an interesting idea. Please make an "Enhancement" ticket for it.

  • Avatar of ajay01281990 ajay01281990 Oct 03, 2013 at 15:30 UTC - 0 likes

    i got good idea to add in game command to ban items

    ~AjayCraft~

  • Avatar of krisdestruction krisdestruction Sep 30, 2013 at 01:30 UTC - 0 likes
  • Avatar of krisdestruction krisdestruction Sep 29, 2013 at 01:33 UTC - 0 likes

    @Garrash: Go

    I'm curious about 1.2.5 and 1.4.7, but I expect at least 1.4.7 to work. While I do build against the latest bukkit API, I currently test against 1.5.2 so that's covered. The modpack/set shouldn't matter as long as it's compatible with the Bukkit version. Let me know if there are any issues :)

    Last edited Sep 29, 2013 by krisdestruction
  • Avatar of Garrash Garrash Sep 29, 2013 at 01:19 UTC - 0 likes

    I'm curious to hear from people using 1.2.5, 1.4.7, and 1.5.2 on if it has any backwards compatibility issues. If you have a server with one of those (Classic/Lite/Hexxit in that order) and you don't have any issues I'd love to hear from you before I take the plunge.

    http://www.connectwithtech.com/tc/GroupBanner.jpg

  • Avatar of krisdestruction krisdestruction Sep 28, 2013 at 15:53 UTC - 0 likes

    @Thundercoyote: Go

    Thanks! Shoot me a feature request if you got an idea :)

  • Avatar of Thundercoyote Thundercoyote Sep 28, 2013 at 14:54 UTC - 0 likes

    Great plugin a lot better then tekkitcustomizer lot easier to understand

    keep up the good work

  • Avatar of krisdestruction krisdestruction Sep 28, 2013 at 01:56 UTC - 0 likes

    Hey guys,

    I accidentally typed the permission exclude nodes as "ItemRepair" instead of "ItemRestrict" in the project description. Please use "ItemRestrict". Enjoy!

    Last edited Sep 28, 2013 by krisdestruction
  • Avatar of krisdestruction krisdestruction Sep 27, 2013 at 15:46 UTC - 0 likes

    @JPTech234: Go

    That it is :)

  • Avatar of JPTech234 JPTech234 Sep 27, 2013 at 13:29 UTC - 0 likes

    Oh? A completely new plugin? Interesting, will give it a shot!

    Last edited Sep 27, 2013 by JPTech234

    http://img818.imageshack.us/img818/221/50383150.png

What permissions plugin do you use while using ItemRestrict?

  1. Choice:

  1. Results
  2. 1 comment

Facts

Date created
Sep 22, 2013
Categories
Last update
Oct 07, 2013
Development stage
Release
License
GNU General Public License version 3 (GPLv3)
Curse link
ItemRestrict
Downloads
4,274
Recent files

Authors