[hr]

1. Overview

ProSewers is a procedural sewer generation plugin for Minecraft Paper servers.

It allows administrators to create sewer nodes on the surface of a city and connect them underground. The plugin automatically generates large walkable tunnels, access shafts, manholes, underground chambers, water canals, pipes, leaks, dirty walls and decorative details.

The main goal is to create playable underground areas for roleplay servers.

Players can use these sewers for:

• Police chases
• Escapes
• Secret routes
• Criminal hideouts
• Rat-infested areas
• Maintenance worker roleplay
• Exploration
• Events

[hr]

2. Requirements

• Server software: Paper
• Minecraft version: 1.21.1
• Java version: Java 21
• Dependencies: None
• Recommended: Use WorldEdit or backups before generating large city networks

[hr]

3. Installation

1. Download the plugin JAR.
2. Place it inside your server's /plugins folder.
3. Start or restart the server.
4. The plugin will create its folder:
   
   Code (Text):

   plugins/ProSewers/
5. Edit the configuration:
   
   Code (Text):

   plugins/ProSewers/config.yml
6. Reload the plugin:
   
   Code (Text):

   /prosewers reload

[hr]

4. Files

The plugin uses these files:

config.yml
Main configuration file. Controls generation, materials, depth, tunnel size, pipes, lighting, history and language.

nodes.yml
Stores all sewer nodes and their connections.

messages_es.yml
Spanish messages.

messages_en.yml
English messages.

[hr]

5. Basic Concept

A sewer network is made of nodes.

A node is created on the surface, usually on a road, sidewalk, street corner or city point.

Each node stores:

• World
• Surface X, Y, Z
• Depth
• Generated sewer Y position
• Connections to other nodes

The underground sewer position is calculated like this:

Default depth:

Example:

This means the manhole is on the surface, but the sewer chamber is generated 30 blocks below it.

[hr]

6. First Steps

Create a node where you are standing:

Create another node:

Connect both nodes and generate the tunnel:

Teleport to the underground sewer of a node:

Teleport to the surface position of a node:

[hr]

7. Commands

General Commands

Shows the command list.

Reloads the configuration and language files.

Reverts the last generation action.

Restores the last undone generation action.

[hr]

Node Commands

Creates a sewer node at your current location.

Example:

With custom depth:

Deletes a node from storage.

Example:

Lists all created nodes.

Example:

Shows detailed information about a node.

Example:

Teleports you to a node.

Examples:

Changes the depth of an existing node.

Example:

[hr]

Connection Commands

Connects two nodes.

Example without generation:

Example with generation:

Removes a connection between two nodes.

Example:

Automatically connects a node to nearby nodes within the configured or provided range.

Example:

[hr]

Generation Commands

Generates the underground chamber, manhole and access shaft for a node.

Example:

Generates the tunnel between two connected nodes.

Example:

Generates all nodes and all existing connections.

[hr]

8. Permissions

Gives access to every ProSewers command.

Recommended for:

• Owners
• Administrators
• Builders
• Developers

[hr]

9. Default Configuration Example

[hr]

10. Generation Details

Large Tunnels

By default, tunnels are large enough for roleplay movement.

They include:

• Side walkways
• Central water canal
• High ceiling
• Decorated walls
• Support columns
• Lighting
• Pipes
• Dirty details

Node Chambers

Each node creates an underground chamber below the surface point.

These chambers are useful as:

• Intersections
• Meeting points
• Escape points
• Combat areas
• Maintenance rooms
• Mob encounter areas

Pipes and Water Leaks

The plugin can generate side pipes connected to the sewer walls.

These pipes simulate:

• Drainage systems
• Water coming from buildings
• Broken city pipes
• Dirty underground infrastructure

Some pipes can leak water into the sewer.

Slopes and Height Differences

Nodes can be created at different surface heights.

Example:

With default depth 30:

The plugin creates a tunnel path that can go up and down to connect both sewer levels.

This prevents broken connections when the city terrain has different heights.

[hr]

11. Recommended Workflow

1. Walk through your city streets.
2. Create one node at each important road point.
3. Use short and clear node IDs.
4. Connect nearby nodes first.
5. Generate one link and inspect it.
6. Adjust tunnel width, height and materials if needed.
7. Use /prosewers undo if a generation does not look good.
8. Generate the rest of the network.

Example city workflow:

[hr]

12. Undo and Redo

ProSewers stores generated block changes in memory.

Use:

To revert the latest generation.

Use:

To restore it.

This is useful when:

• A tunnel generated too close to another build.
• You want to test a different width or height.
• A connection was generated in the wrong area.
• You want to preview different styles.

Important: Undo/redo history is stored in memory and may reset after a server restart.

[hr]

13. Performance Tips

For large cities, avoid generating everything at once until your configuration is final.

Recommended:

• Generate one node first.
• Generate one connection first.
• Inspect the result.
• Use backups before generating a full network.
• Keep batch size reasonable.
• Use /prosewers generate all only after testing.

Recommended batch settings:

If your server has lag, lower the batch size:

[hr]

14. Spanish Guide / Guía en Español

ProSewers permite crear redes de alcantarillado subterráneas para ciudades modernas de roleplay.

El sistema funciona creando nodos en la superficie. Cada nodo se proyecta hacia abajo según la profundidad configurada. Por defecto, la alcantarilla se genera 30 bloques debajo de la superficie.

Ejemplo:

Luego puedes conectar nodos para generar túneles subterráneos.

[hr]

Comandos principales en español

Crear un nodo:

Crear un nodo con profundidad personalizada:

Conectar dos nodos y generar el túnel:

Teletransportarse a la alcantarilla:

Teletransportarse a la superficie:

Generar una conexión:

Generar todo:

Deshacer la última generación:

Rehacer la última generación:

[hr]

Ideas para roleplay

Puedes usar las alcantarillas para:

• Rutas de escape de criminales.
• Persecuciones policiales bajo la ciudad.
• Zonas infestadas de ratas.
• Misiones de mantenimiento.
• Bases ocultas.
• Entradas secretas.
• Eventos de terror.
• Túneles abandonados.
• Zonas de contrabando.
• Accesos ocultos a edificios.

[hr]

15. Troubleshooting

The tunnel generated too small.

Increase:

The tunnel generated too deep or too high.

Change:

Or set a custom depth per node:

The generation caused unwanted terrain damage.

Use:

I changed config but nothing changed.

Use:

Then generate again.

Old config does not include new options.

Stop your server, rename the old config and restart:

The plugin will generate a fresh configuration.

[hr]

16. Final Notes

ProSewers is designed for builders and roleplay administrators who want their city to feel alive above and below ground.

Use it to create a hidden underground layer full of routes, danger, secrets and opportunities for player stories.