Home

The Transport-Pipes plugin adds several different pipes into Minecraft. At the moment there are colored pipes, golden pipes, iron pipes, extraction pipes, void pipes and ice pipes. Similar to the BuildCraft mod, these pipes can transport any kind of item. In the following wiki you will learn how to craft and use this pipes and what the difference between those pipe types is. Also some basic information about the plugin's commands and config is described.

Dependencies

TransportPipes depends only on ProtocolLib. In order for this plugin to work, make sure a recent version of ProtocolLib is installed on your server. You can download ProtocolLib here: https://www.spigotmc.org/resources/protocollib.1997

Features

As explained above, you have to use different pipe types in different situations. Every pipe type and their purpose is listed below:

• Extraction Pipe: This pipe is the only one which can extract items from container blocks. Container blocks are blocks which hold inventories: Chests, furnaces, hoppers, shulker boxes and much more. Extraction pipe don't connect to each other but they do connect with every other pipes and with container blocks of course. One extraction pipe only has one extract direction from where it extracts items. This direction is displayed by a different connection texture. You can change the extract direction as well as the extract condition by right-clicking the pipe with a wrench and choosing the desired option. The extract condition determins when to extract items. There are three extract conditions:

  • needs redstone: the pipe only extracts items if it's powered with a redstone signal.
  • always extract: the pipe always extracts items regardless of whether it's powered with redstone or not.
  • never extract: the pipe never extracts items.

• Colored Pipe: This is the simplest pipe. Its only purpose is to transport items. Nevertheless you can color this kind of pipe. Different colored pipes behave the same but don't connect to each other. Therefore you can create complex pipe system without issues of wrong connected pipes.

• Ice Pipe: The Ice Pipe transports items as well as any other pipe. The only difference is the transport speed. Ice Pipes transport items four times faster than other pipes.

• Iron Pipe: Iron Pipes can also be called "One-Way-Pipe". It's feature is that regardless of from which direction an item comes from, it will always move into the desired output direction. You can change this output direction by right-clicking the pipe with a wrench.

• Golden Pipe: A Golden Pipe can sort items. Every output direction on the Golden Pipe has a specific color. By right-clicking this pipe with a wrench, a sorting inventory opens. You can put items in there to determine which items should go where. Every row in this inventory is referring to an output direction of the Golden Pipe. The color indicates which row refers to which output direction. By clicking on a color indicator inside this inventory, you can change the filtering mode for this output direction row. The filtering mode determines which traits to compare when calculating the desired output direction for an incoming item. The following filtering modes exist:
  In this context, type stands for the material of the item (e.g. the material of any colored wool is still wool). Damage stands for the durability of a tool item and in correlation to "not-tool" items, they determine the "damage" value (e.g. the damage value of wool is the color of the wool and the damage value of wood is the type of wood). Block all mode doesn't check any trait, it blocks the hole direction. Therefore items can only move into the Golden Pipe through a blocked direction but never out this direction

  • filter by type, damage, itemmeta
  • filter by type, damage
  • filter by type, itemmeta
  • filter by type
  • block all

In general, all pipes can put items into container blocks if they are connected to such but only extraction pipes can extract items from container blocks. Also as mentioned some times above, for some pipes you need a wrench. The crafting recipes for the wrench is given below. The wrench can be used simply by right-clicking the desired pipe.

Crafting Recipes

All crafting recipes can be changed in the config but the default ones are as follows:

Colored Pipe:

Golden Pipe:

Iron Pipe:

Extraction Pipe:

Ice Pipe:

Void Pipe:

Wrench:

Commands

• /tpipes tps - Shows some performance stats, e.g. the ticks per second of the TransportPipes thread or the amount of pipes and items currently ticking.
• /tpipes settings - Opens the player specific settings interface. Here you can change the render distance of the pipes and you can switch between Vanilla and Modelled Render System. Vanilla Render System uses Vanilla Minecraft textures and the Modelled Render System uses a custom resourcepack.
• /tpipes reload <config | pipes> - Reloads either the config files or destroys and recreates all pipes in all worlds.
• /tpipes delete - Destroys all pipes around you in the desired radius.
• /tpipes save - Saves all pipes in all worlds. Actually on every world save, the pipes get saved automatically but with this command you can save them manually.
• /tpipes creative - Opens an inventory from which you can take every pipe. This only works in creative mode.
• /tpipes update - Updates the plugin to a more recent version automatically (if possible). The updated version will be available after the next restart.

Config

There are three config files managed by the plugins. You can find them here: TransportPipes/config.yml, TransportPipes/localization.yml and TransportPipes/recipes.yml. Inside the localization.yml file you can change every text displayed to your desired language. The config.yml file has several different options:

• max_items_per_pipe - If the amount of items in one pipe exceeds this value, the pipe explodes in order to prevent lag issues.
• permissions - Determine which permissions are needed to perform the given commands.
• crafting_enabled - Disabled this option to disable all pipe crafting recipes.
• check_updates - Enable to allow for automatical update check.
• destroy_pipe_on_explosion - Whether to destroy pipes if a natural (TNT, Creeper) explosion occurs nearby.
• anticheat_plugins - List all AntiCheat plugins running on your server here. If not listed here, some players may not be able to place or break pipes due to AntiCheat detection.

By adjusting the recipes.yml, you can change the crafting recipes for all pipes and the wrench item. A recipe is specified by the following keys:

• type - The recipe type: Either shaped or shapeless.
• amount - The amount of the crafted result item.
• shape - Only if type: shaped. Every entry in this list describes a row in the crafting table. Every char describes an item.
• ingredients - if type is shaped: For every char you have to specify the item to use. (<itemID>:<itemDamage>) if type is shapeless: Just list all items (<itemID>:<itemDamage>) that are needed to craft the desired item. Just write "pipe" instead of <itemID>:<itemDamage> to use a pipe item.

API

If your a developer and you want to create your custom pipe system from another plugin, you can use the following PipeAPI:

//Simply build a pipe
PipeAPI.buildPipe(Location, PipeType, PipeColor);

//Simply destroy a pipe
PipeAPI.destroyPipe(Location);

//Returns the ticks per second of the TransportPipes thread
PipeAPI.getTPS();

//Returns the amount of pipes registered in all worlds
PipeAPI.getPipeCount();

//Returns the amount of pipes registered in the given world
PipeAPI.getPipeCount(World);

//Whether there is a pipe at the given location
PipeAPI.isPipe(Location);

//Returns a pipe object at the given location or null if there is no pipe
PipeAPI.getPipeAtLocation(Location);

//Simply destroys all pipes in the given world
PipeAPI.destroyPipes(World);

//puts any item (with an amount of 1) into the given pipe object with a moving direction of "itemDirection"
PipeAPI.putItemInPipe(Pipe, ItemData, PipeDirection);

//register a custom container block at a specific location.
//Every pipe around this block will try to extract/insert items from/into this container.
//Create your own implementation of the TransportPipesContainer interface in order to specify
//which items to extract and where inserted items should go.
PipeAPI.registerTransportPipesContainer(Location, TransportPipesContainer);

//unregisters a custom container block
PipeAPI.unregisterTransportPipesContainer(Location);

In addition to this methods, there are several events you can use to get notified about important things:

• PipeExplodeEvent - gets called when a pipe explodes due to too many items inside it. This event is not called when a pipe explodes because of a natural explosion.
• PlayerPlacePipeEvent - when a player places a pipe.
• PlayerDestroyPipeEvent - when a player destroys a pipes.
• PipeConnectionsChangeEvent - gets called when a pipe changes its connections count. For example when a container block or another pipe is placed next to it.