Pathinator

Pathinator is a Minecraft plugin that allows you to quickly and easily create paths based on the block you are currently standing on.

For example, if you are standing on a block of OAK_PLANKS and you issue a command to create a path of 50 blocks, Pathinator will replace all the blocks in the direction you are facing with OAK_PLANKS out to a distance of 50 blocks. If you also requested with lights Pathinator will add a light (configurable, defaults to TORCH) every N^* blocks to the side of the path.

Available on PaperMC! (Only tested on Paper, but should work fine on Spigot and Bukkit servers too.)

Creative vs Survival

In Survival mode, you must have enough material in your inventory to cover the distance requested. Additionally, in Survival each relevant tool in your inventory will take 1 damage for each block you replace (including the clearance space above if carving through a mountain). For example, if you have a shovel and a pickaxe and you create a path 10 blocks long through 6 blocks of dirt and 4 blocks of stone, your shovel will take 6 damage and your pickaxe will take 4 damage. If you have more than one tool of the same type, Pathinator will take the damage from the tool with the least remaining durability (taking tool damage is configurable).

Additionally you can configure Pathinator to require the correct tools in order to automatically mine the blocks as well as retain the mined material in your inventory.

In Creative mode, you can place as many blocks of any type as you want, with no inventory restrictions or damage to tools.

Usage

Basic

path:basic <distance> [with lights] where <distance> is the number of blocks to place, and [with lights] is an optional boolean true|false whether to place a light every N^* number of blocks.

For example: path:basic 25 true to create a path 25 blocks long with lights, or path:basic 25 where [with lights] defaults to false for no lights.

Tracks

path:tracks <distance> [with power] [with lights] where <distance> is the number of blocks to place, and [with power] is an optional boolean true|false whether to place a powered rail every N^* number of blocks. [with lights] is another optional boolean whether to place a light every N^* number of blocks.

^* N is configurable in /plugins/Pathinator/config.yml

Examples

Configuration

Once loaded on the server, you can edit /plugins/Pathinator/config.yml to adjust the default values.

clearance:
  height: 3
  material: AIR

lighting:
  interval: 12
  stack: [TORCH]

survival:
  enabled: true|false
  requireTool: true|false
  toolDamage: true|false
  keepMaterial: true|false

tracks:
  powerInterval: 34

Building from Source

Run mvn clean package shade:shade from the root directory. This will create target/Pathinator-<version>.jar which you can then drop in your plugins folder.

Metrics

I use bStats to collect anonymous usage data which helps me decide where to focus development effort. The metrics are publicly available here.

The metrics can be disabled in config.yml if you really want, but please consider leaving them on as this allows me to keep track of usage.

Future Updates

• Add option to create a path with rail tracks path:tracks ... (v1.1.0)
• Add option to customize aspects of the path (height, width, material, etc...) path:custom ...
• Add option to follow the natural terrain instead of laying it all on the same Y value.
• Add permissions management with LuckPerms

License

Pathinator is licensed under the permissive MIT license. Please see LICENSE for more info.