Deep Cave Spiders

For PaperMC 1.18.1+.

Today in "Plugins Nobody Asked For", I am proud to introduce "Deep Cave Spiders", a mechanics plugin which causes cave spiders to spawn deep underground!

Why? Just... why?

Ask yourself: When was the last time you really felt like you had to prepare before delving deep under the surface? When did you last feel that doing so was actually dangerous?

This plugin lets you have a small taste of that as you dig deeper into your world. Was that spider you heard just a spider... or could it be a cave spider jockey? Am I about to get poisoned?

Caving has rarely been so toxic!

Features

Naturally-spawned cave spiders: Sometimes when a spider spawns between the configured minY and maxY range, it will be replaced by a cave spider! The chances of this can be adjusted per-world-difficulty in the configuration file using the spawnChances section!
Baby zombie jockeys: On Hard difficulty, there is a chance that naturally and egg spawned cave spiders can spawn ridden by a baby zombie! The chance of this is configurable using jockeyChances in the configuration file.
Configurable range: Minimum and maximum Y values can be set to limit the range in which cave spiders will spawn!
Configurable biomes: Choose what biomes cave spiders are allowed to spawn in!
Configurable environments: If you have a way to spawn spiders naturally in the end or nether, you can configure int what environments cave spiders can replace natural spiders as well!

Metrics

This plugin uses bStats to collect some analytics about your current system setup and plugin configuration. You can see the metrics collected here: https://bstats.org/plugin/bukkit/Deep%20Cave%20Spiders/14026

Metrics collection is optional. If you installed a previous version of the plugin, you are already opted-out of metrics collection. If you want to opt-out on version 1.3.0 or higher, set the "metrics" option in the configuration file to "false", or comment or remove the line. Thanks!

In-Depth Configuration

Tweak to your heart's content with in-depth configuration options, from spawn ranges to spawn chances, jockey chances, biome switches, and environments!

Expand to view the default configuration file:

# The locale to use while translating chat messages.
# Default value: en_US.
locale: "en_US"
# Options for spawning the cave spiders.
spawnOptions:
 # Spawning height range.
 range:
 # The minimum Y level that cave spiders will spawn.
 # Default value: -64
 minY: -64
 # The maximum Y level that cave spiders will spawn.
 # Default value: -8
 maxY: -8
 # Allow spiders to spawn below the minimum Y height.
 # This is useful for customizing the spawn distribution ramp function; spawns below the minimum Y value are
 # guaranteed to use a constant spawn chance as set in the chances section below.
 # Defaults to false.
 allowSpawnsBelowMinY: false
 # Spawn distribution function. Affects how often cave spiders spawn in the world.
 # Valid values are constant, hyperbolic, linear, and logarithmic
 # In order of slowest to quickest ramp-up speed:
 # - Hyperbolic distribution ramps up slowly at first but increases in likelihood the further down you go.
 # - Linear distribution ramps up at a constant rate the further down you go.
 # - Logarithmic distribution ramps up very quickly at first but slows down the further down you go.
 # - Constant distribution is the same no matter what depth the spider is spawning at.
 # Defaults to constant.
 distribution: constant
 # Chances that a cave spider will replace a normal spider within the given range.
 # Settings are between 0 and 1, separated by difficulty level.
 chances:
 # Easy mode spawn rates.
 # Default value: 0.05, or 1 in 20.
 easy: 0.05
 # Normal mode spawn rates.
 # Default value: 0.1, or 1 in 10.
 normal: 0.1
 # Hard mode spawn rated.
 # Default value: 0.5, or 1 in 2.
 hard: 0.5
 # Chance for a cave spider to spawn a baby zombie as a rider.
 # Only applies on Hard difficulty.
 # Values are between 0 and 1.
 # Defaults to 0.1, or 1 in 10 cave spiders.
 jockeyChance: 0.1
# Biomes in which the cave spiders will spawn.
# Valid values: https://papermc.io/javadocs/paper/1.18/org/bukkit/block/Biome.html
biomes:
 - badlands
 - bamboo_jungle
 - birch_forest
 - dark_forest
 - desert
 - flower_forest
 - forest
 - grove
 - jagged_peaks
 - jungle
 - meadow
 - plains
 - savanna
 - savanna_plateau
 - sparse_jungle
 - stony_peaks
 - sunflower_plains
 - swamp
 - windswept_forest
 - windswept_gravelly_hills
 - windswept_hills
 - windswept_savanna
 - wooded_badlands
# The environments in which cave spiders will spawn.
# By default, only affects NORMAL environments.
# Valid values: https://papermc.io/javadocs/paper/1.18/org/bukkit/World.Environment.html
environments:
 - normal
# A list of all of the entity types that cave spiders can replace.
# Defaults to include only spiders.
# Only replaces natural spawns.
# Valid values: https://papermc.io/javadocs/paper/1.18/org/bukkit/entity/EntityType.html
replaceEntities:
 - spider

Does the plugin support /reload?

Unfortunately, since the use of the /reload command is inadvisable, the plugin's functionality after a server reload is undocumented and untested.

Instead, please use the /deepcavespiders reload command to reload and reapply configuration.

Commands

The following commands are provided by this plugin:

/deepcavespiders - Used to print information about the plugin. The "reload" subcommand can be used to reload the plugin's configuration files.

Permissions

The following permissions are provided by this plugin:

deepcavespiders.admin - Allows a user or group to use the /deepcavespiders reload subcommand and reload the plugin's configuration files.

Issues?

If you encounter any issues with the plugin, report them on the GitHub issue tracker. Select a template and fill out the required sections please!