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
- The first part is the material ID.
- 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.
- The third part is for your reference. It will appear in the logs to shorthand what the various IDs and data values mean.
- 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:
- Vastly improved performance (Confirmed)
- Add configurable scanner settings (Confirmed, in progress)
- Change in config file structure (Confirmed, in progress)
- Change in permission nodes (Tentative, investigating)
- Consolidate Usage Bans and Placement Bans (Tentative, investigating)
- Consolidate Ownership Bans and Crafting Bans (Tentative, investigating)
- Dropped 1.2.5 support (Tentative)
- 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!
@X7Darkness
The most common issue is using TAB to indent instead of spaces. Sometimes when you press enter at the end of a line, your text editor automatically inserts a tab for you at the beginning of the next line.
My config file keeps resetting and I've triple checked it for formatting errors and haven't found anything out of the ordinary. Any suggestions on what it might be?
@bigscary
good to hear, and hope you do :-)
Published source code.
https://github.com/ryanhamshire/TekkitCustomizer/
@zlepper
Let me think on it, I might implement that suggestion. :)
Feature idea:
The usage ban should also prevent people from using already placed items, this will prevent some of the workarounds people find, so even if they manage to make the condensor, or the like, they stilll wouldn't be able to use, thus wasting their time, and hopefully make them understand why the bans are in place.
I often encounter new players on my server who have a condensor, even though it's banned until you have played 50 hours. yes both on my ownership ban and my placement ban. some of my other players just place it for them, and then the ban i completely nullified. This make for quite a headache, as i have that limitation in place for a reason.
think it could be implimented? or is this outside of the range of things bukkit can do?
@essofhonor
It must be a formatting mistake with your YAML. Try using a free YAML editor like notepadplusplus to find your mistake. The most common mistake is using TAB instead of spaces to indent a line.
I want to ban 128:1:Energy Condenser But it keeps resetting the config file to default went I ban it. Not sure why.
@WTFNoMoreUsernames
Well, I don't get any complaints. And I run it on my own server without issues. :)
This PlugIn looks amazing. I just came from Tekkit Restrict as I found it was causing my random crashes every 8 hours, world chunk reloading, and not doing half the things it said it could. I run a large tekkit server, can anyone verify this is at least half as buggy as TR. Id appreciate it, and I am really looking forward to testing this out.
1.5.2 Update!
@CitrusLimonium
Even if it were triggerable with a slash command, that wouldn't fix your problem because the scan can only afford to scan loaded chunks. It won't scan generated chunks that aren't currently loaded due to no player being nearby. :\
@JDBNeFN
Ah, then I see your point. I think 20 minutes should be all that you need, please tell me if you notice any issue. I did test this carefully myself, and saw the banned blocks disappear, so I feel confident you won't have a problem. :)
EDIT: Use /blockinfo while pointing at the banned block in the world, it's possible that you've banned the ITEM, which could have a different ID and data value from the BLOCK by the same name.
@bigscary
I was trying to remove all chunk loading blocks so that cant be the problem ill try again and let it run all day.
Is there a way to force the contraband scanned to run? I ran into a problem with world generation that was spawning dark matter pedestals everywhere, and I need them banned ASAP. I changed the config file to ban them and the 'Unnamed Item' that they spawned as, but the scan doesn't seem to have gotten them, or the scan hasn't triggered yet.
@extrea
It's on the ban list because it will make banned items. Then those items will be confiscated, so the player loses his ingredients. If you're comfortable with some players who aren't well aware of the ban list's content losing some items, then by all means remove it from your ban list by removing that line from the config file.
@leelawd93
Yep, I'm going to add tank carts in the next version. :) Thanks for reminding me.
@stilleraben
What are you using to craft the banned items? Many tekkit crafting blocks (like the project table) will craft banned items, which is why they are themselves banned by default. Try using a standard crafting table to test your crafting bans.
@JDBNeFN
Only loaded chunks are scanned, and a complete scan takes 20 minutes. It has to be done this way to avoid lagging the server. So it means that all the world banned blocks will be eventually removed, assuming players play in the area where they're located (if players don't play in that area, then there's no harm in leaving those blocks because they're not doing any harm).
The world bans don't seem to do anything I placed a few things on the world banned list and they are still there. How long does it take for them to get removed?
@jwa1
if u are using PEX try formatting it for "per world" permissions and adding the item banned exempt nodes there, should work like a charm.
hi, i am currently having issues with the recent build for this plugin, i have the config pretty much defaulted, the plugin is loaded, but i decided i wanted to test it, so i dropped my rank to guest (most limited) deoped myself, and restarted my client. i can still craft the banned items and place anything or own anything on the ban list.
help please? <note: after first failed i have copied everything in the ownership banned and applied it to world, placement, and usage banned n still nothing>
i dont think this is on the default list, but just to warn people, On my server i recently came across a couple of dupers within their first hour of playing. they got red matter armor. i went to investigate it and found that they were using a bug with the Tank Carts to get instant stacks from just having 1 of each item. so just to warn everyone that Tank Carts CAN Dupe items and they are very easy to get a hold of. so watch out and i suggest you ban this item till something fixes it
Is the project table (put as 173:3) wrong on the banned list or am I imagining things O.o