Why P.U.M.P. ?

Fluids and pipes are fun and all. But the more complex layout can be blueprinted and copied. Unfortunately, due to the random nature of how oil wells are found on the map, you're left with a significant chunk of manual labor for each oil field you claim. After a while placing pumpjacks gets old...

P.U.M.P. (Prevent Unwanted Manual Pump-placement) adds a selection-tool with which you can select oil wells (or other liquid resources from mods), and then plans the layout of pumpjacks, pipes and electric-poles for you.

If you want P.U.M.P. to insert modules as well. Install Module Inserter and configure which modules you want. If you already have Module Inserter but don't want P.U.M.P. to insert modules, you can disable it in the settings.

How to use

• Press the P.U.M.P. button on the the short-cut bar to activate the selection tool.
• With the P.U.M.P. selection tool in hand; drag-select the oil-wells
• Choose which buildings to plan with. If you have other mods installed that add additional pumps, pipes, or power poles, P.U.M.P. should include those in the menu.

Don't want the menu every time?

You can untick the checkbox at the bottom of the menu.
- P.U.M.P. will remember the previous chosen options and use those.
- It will still offer the menu if new options are available since last usage.
- You can also hold SHIFT while making a selection to one-time show the menu again.
- The checkbox can also be ticked again from the game's mod-settings menu.

Compatibility with other mods

P.U.M.P. should work with any fluid resource, for which a pump/miner is available that has a pipe output. So far it can do so without any specific mod exceptions.

If P.U.M.P. does not work with a particular mod, and you think that it should, please let me know. If I can adjust P.U.M.P. in a way that won't require mod-specific exception I probably will take the effort.

Some self-imposed limitations are:
- Miners/pumps need to be square;
- Pipes must be 1x1 in size, and must have similarly named "-to-ground" option for the underground segments;
- Power poles must either be 1x1 or 2x2 in size;

This is so, to keep the math/code simpler initially. If there's demand, I'll look into expanding the logic to support more exotic shapes and sizes.

Planning routine

The mod attempts to split the field in smaller chunks until it is able to connect all the pumps in straight lines to any of the splits. This way the pipe-layout is neat and tidy.

Due to the nature of finding those splits, if the oil field is too tightly packed, or if obstructions (water or other buildings) are in the way, P.U.M.P. might not be able to find a layout connecting all the pumpjacks in the selection. In which case P.U.M.P. will prompt it's not able to do its job. In this case, try to plan the field in parts instead of all at once.

Found a bug?

P.U.M.P. should store pump_planner_input.json in the script-output folder within the user folder. It'd be helpful if you could provide it to me. Note that the file will be replaced each time you make a selection. So double check the timestamp of the file if it was generated at the same time as the bug occurred.