Perfectly Balanced Horses: Make horses great again!

Why?

Horses in Minecraft are often overlooked due to their lack of utility compared to other types of transportation, such as
elytra or boats. This plugin aims to make horses more useful by enhancing the breeding process, allowing players to
breed horses with improved stats. By modifying attributes such as movement speed, jump strength, and health, players can
create exceptionally fast, high-jumping, and healthy horses that are more competitive with other forms of
transportation.

And it is just fun to breed horses and see what you get!

Installation

Download the version of the plugin you need from Modrinth.
Place the downloaded JAR file in the plugins directory of your server.
Start or reload your server. (It is recommended to restart the server to ensure the plugin is loaded correctly.)
Configure the plugin to your liking by editing the config.yml file in the plugins/PerfectlyBalancedHorses directory.
Reload the plugin using the /pbhreload command or by restarting the server.
Enjoy breeding perfectly balanced horses!

[!TIP]
It is recommended to use the Horse Power client-side mod to view the horse's stats. This mod displays the
horse's speed, jump height, and health in the horse's inventory screen. It is available at the following link:
Horse Power.

Description

PerfectlyBalancedHorses is a Minecraft plugin that enhances horse breeding by allowing players to breed horses with
improved stats. It modifies attributes such as movement speed, jump strength, and health, enabling the creation of
exceptionally fast, high-jumping, and healthy horses.

The plugin is also designed to be highly configurable, allowing server owners to customize the breeding process to suit
their server's needs. This includes the ability to adjust each attribute's maximum value, as well as the range of values
that can be inherited by offspring. The configuration options cover movement speed, jump strength, and health, with
additional settings to control whether excess or deficit attribute values should be ignored.

Screenshots

Breeding 1
Breeding 2

Configuration

The plugin's configuration file, config.yml, is located in the plugins/PerfectlyBalancedHorses directory. It is
divided into three sections, each corresponding to a different attribute: speed, jump, and health. Each section
contains the following settings:

modify: A boolean value that determines whether the attribute should be modified during breeding.
multiplier: A double value that determines how much the attribute should be multiplied by when breeding.
offspringRange: A range of double values that determine the value that is applied to the parent's attribute value
when breeding. The range is defined by a start and end value. If the start value is greater than 0, the
offspring will inherit a value that is always greater than the parent's attribute average. Note that the end value
must be greater than the start value. The math is as follows:
- parentAverage + (parentDifference + rangeBuffer) * randomFactor
- randomFactor is a random value between the start and end values.
- rangeBuffer is 0.3 * the difference between the maximum (vanilla or custom) and vanilla minimum attribute value.
- parentDifference is the absolute difference between the parent's attribute values.
ignoreExcess: A boolean value that determines whether excess attribute values should be ignored.
ignoreDeficit: A boolean value that determines whether deficit attribute values should be ignored.

The use-vanilla-offspring-attribute-range setting controls whether to use Minecraft's default offspring attribute
range. Set it to true for balanced attributes. If set to false, the offspringRange in the config file will be
used, which can result in very high or low attributes that can result in an unbalanced breeding system without steady
progression. It is recommended to set this to true for balanced gameplay.

Here is an example configuration file:

use-vanilla-offspring-attribute-range: true
attributes:
  movement-speed:
    modify: true
    multiplier: 150.0
    offspring-attribute-range:
      start: -0.5
      end: 0.5
    ignore-excess: false
    ignore-deficit: false
  jump-strength:
    modify: true
    multiplier: 150.0
    offspring-attribute-range:
      start: -0.5
      end: 0.5
    ignore-excess: false
    ignore-deficit: false
  health:
    modify: true
    multiplier: 150.0
    offspring-attribute-range:
      start: -0.5
      end: 0.5
    ignore-excess: false
    ignore-deficit: false

[!IMPORTANT]
The multiplier setting is a percentage value. For example, a multiplier of 150.0 will increase the attributes
max value by 50%.

Commands

The plugin provides the following commands:

/pbhreload: Reloads the plugin's configuration file. Requires the pbh.reload permission.

Bugs and Suggestions

Discord Community

Need help with minor concerns or have questions? Join our supportive community on the Discord server. Our friendly members and staff are here to assist you!

GitHub Issues

For bugs or suggestions, please submit them via the GitHub Issue Tracker. Kindly use the provided templates and include all relevant details to ensure we can resolve your issue quickly. Your cooperation is greatly appreciated!

Contribution Guidelines

We welcome contributions from the community! Please read our Contribution Guidelines to get started.

Security

If you discover a security vulnerability within this project, please refer to the SECURITY.md file for
more information on how to report it.

Please do not disclose security-related issues publicly.

[!WARNING]
This project is under AGPL-3.0 license, which means there is no warranty for this software. Use at your own risk.
See the LICENSE for more details.

LICENSE

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program. If not, see https://www.gnu.org/licenses/.

Perfectly Balanced Horses is developed and maintained by Lyzev. Thank you for using Perfectly Balanced Horses!

Perfectly Balanced Horses

📖About Perfectly Balanced Horses