Tekkit Customizer

Use this plugin to ban items and blocks for Bukkit, Tekkit, and FTB servers using the Bukkit API. TekkitCustomizer removes banned items from the world and player inventories. It is easy to configure, can be applied retroactively, and automatically logs confiscated items. It requires no permissions plugin unless exceptions are need for certain players. The plugin settings default to commonly-banned Tekkit items.

Because every story that starts with "We decided to start up a Server..." 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.

Configuration

An entry in the config file (config.yml) to ban ALL wool looks like this:

35:*:wool:because pink wool is for girls
  1. The first part is the material ID.
  2. The second part is the data value. Some blocks have the same ID, but a different data value. For instance, white wool is 35:0, while pink wool is 35:6. If you put an asterisk, that means ban ALL data values for the given material ID.
  3. The third part is for your reference. It will appear in the logs to shorthand what the various IDs and data values mean.
  4. The fourth part is the reason for the ban. It will be shown to players at useful times such as when a player tries to craft a banned item. If you don't fill in the reasons for your bans, you will be constantly asked why various items are banned.

After you edit your ban list, use /ReloadBannedItems to update the bans in-game. If your config.yml file "resets itself", that means you made a formatting mistake while editing the file. NotepadPlusPlus is a free file editor perfect for editing YAML files

A full list of Block IDs will help you add banned items. You can also get the block IDs and Data Values by using /blockinfo (requires /op or tekkitcustomizer.blockinfo permission). This tells you the information about the item you're holding and the one you're pointing at in the world. Some items have a different values in your inventory as opposed to ones place in the world (eg. a door item in the inv vs a placed door in the world).

Making Ban Exceptions

A player who has /op automatically ignores bans as with any player with permission:

tekkitcustomizer.*

You can make individual ban exceptions to give some players to generally banned items through permission nodes. Here are various examples, which should help you understand without further explanation.

- tekkitcustomizer.35.*.use
- tekkitcustomizer.35.6.place
- tekkitcustomizer.35.*.craft
- tekkitcustomizer.35.6.own
- tekkitcustomizer.35.6.*
- tekkitcustomizer.35.*.*

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 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 a crafting ban or ownership ban to prevent players from getting those items at all.

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.

Crafting Bans

This ban 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. The contraband scanner will help you identify the existence of workarounds by creating log messages each time it takes an item out of a player's inventory.

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. Any items which are actually found in a player's inventory which the player doesn't have permission for will trigger a log entry, so you can follow-up with an investigation to find out how the player managed to get the item in the first place.

Placement Bans

This ban prevents a player from building a block in the world. 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 is recommend to place most or all placement ban items to your crafting 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.

World Bans

This ban will retroactively remove the placed block from the world through the contraband scanner. 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.

Similar to the ownership ban, this ban will trigger a log message when a contraband block is removed, along with its location so that you may investigate to find out how the block got there in the first place.

Notes

Download the correct CraftBukkit version for your server as labelled on the uploaded files as major Bukkit API changes occurred between 1.2.5 to 1.4.7.

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.

The following features are planned for the next release:

  1. Vastly improved performance (Confirmed)
  2. Add configurable scanner settings (Confirmed, in progress)
  3. Change in config file structure (Confirmed, in progress)
  4. Change in permission nodes (Tentative, investigating)
  5. Consolidate Usage Bans and Placement Bans (Tentative, investigating)
  6. Consolidate Ownership Bans and Crafting Bans (Tentative, investigating)
  7. Dropped 1.2.5 support (Tentative)
  8. Dropped explosion prevention support (Confirmed)

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!


Comments

  • To post a comment, please or register a new account.
Posts Quoted:
Reply
Clear All Quotes

About This Project

  • Project ID
    43923
  • Created
    Aug 27, 2012
  • Last Released File
    Feb 15, 2013
  • Total Downloads
    56,075
  • License

Categories

Members

Recent Files

Bukkit

  • 1.6
    Feb 15, 2013