mirror of
https://github.com/kadeshar/mod-player-bot-level-brackets.git
synced 2026-01-13 01:08:36 +00:00
Adding new conf to limit if Guild Bots with real players should be balanced or not, Readme cleanup
This commit is contained in:
Dustin Hendrickson
93
README.md
93
README.md
@@ -8,35 +8,39 @@
|
||||
|
||||
Overview
|
||||
--------
|
||||
The Bot Level Brackets module for AzerothCore ensures an even spread of player bots across configurable level ranges (brackets). It periodically monitors bot levels and automatically adjusts them by transferring bots from overpopulated brackets to those with a deficit. During adjustments, bots will be run through the normal Playerbots Randomize function, clearing and restoring them based on their new level. Bots that are not immediately safe for level reset (for example, those in combat or engaged in other activities) are flagged for pending adjustment and processed later when they become safe. Additionally, Death Knight bots are safeguarded to never be assigned a level below 55.
|
||||
The Bot Level Brackets module for AzerothCore ensures an even spread of player bots across configurable level ranges (brackets). It periodically monitors bot levels and automatically adjusts them by transferring bots from overpopulated brackets to those with a deficit. During adjustments, bots are run through the normal Playerbots Randomize function, clearing and restoring them based on their new level. Bots that are not immediately safe for level reset (for example, those in combat or engaged in other activities) are flagged for pending adjustment and processed later when they become safe. Additionally, Death Knight bots are safeguarded to never be assigned a level below 55.
|
||||
|
||||
Features
|
||||
--------
|
||||
- **Configurable Faction-Specific Level Brackets:**
|
||||
Define nine distinct level brackets for Alliance and Horde bots with configurable lower and upper bounds:
|
||||
- 1-9 , 10-19 , 20-29 , 30-39 , 40-49 , 50-59 , 60-69 , 70-79 , 80
|
||||
- 1-9, 10-19, 20-29, 30-39, 40-49, 50-59, 60-69, 70-79, 80
|
||||
|
||||
- **Desired Percentage Distribution:**
|
||||
Target percentages can be set for the number of bots within each level bracket. The sum of percentages for each faction must equal 100. If it does not, the system will try to balance out the remaining percentages itself.
|
||||
Target percentages can be set for the number of bots within each level bracket. The sum of percentages for each faction must equal 100. If it does not, the system will balance out the remaining percentages automatically.
|
||||
|
||||
- **Dynamic Bot Adjustment:**
|
||||
Bots in overpopulated brackets are automatically adjusted to a random level within a bracket with a deficit. Adjustments include resetting XP, removing equipped items, trade skills, learned spells, quests, and active auras, and dismissing pets.
|
||||
|
||||
- **Death Knight Level Safeguard:**
|
||||
Bots of the Death Knight class are enforced a minimum level of 55, ensuring they are only assigned to higher brackets.
|
||||
Death Knight bots are enforced a minimum level of 55, ensuring they are only assigned to higher brackets.
|
||||
|
||||
- **Support for Random Bots:**
|
||||
The module applies exclusively to bots managed by RandomPlayerbotMgr.
|
||||
The module applies exclusively to bots managed by the RandomPlayerbotMgr.
|
||||
|
||||
- **Dynamic Distribution Toggle:**
|
||||
Enable or disable the dynamic recalculation of bot distribution percentages based on the number of non-bot players in each level bracket via the `BotLevelBrackets.UseDynamicDistribution` option.
|
||||
|
||||
|
||||
- **Dynamic Real Player Weighting with Inverse Scaling:**
|
||||
When dynamic distribution is enabled, the module uses a configurable weight multiplier (set via `BotLevelBrackets.RealPlayerWeight`) to boost each real player's contribution to the desired distribution. This weight is further scaled inversely by the total number of real players online, ensuring that when few players are active, each player's impact on the bot distribution is significantly increased.
|
||||
**Note:** The `RealPlayerWeight` option only takes effect when `BotLevelBrackets.UseDynamicDistribution` is enabled.
|
||||
|
||||
- **Guild Bot Exclusion:**
|
||||
When enabled via the new configuration option `BotLevelBrackets.IgnoreGuildBotsWithRealPlayers` (default enabled), bots that are in a guild with at least one real (non-bot) player online are excluded from bot bracket calculations. These bots are not counted in the totals, nor are they subject to level changes or flagged for pending reset.
|
||||
> **NOTE:** At this time Guild Bot Exclusion only works with **online** real players. I'm investigating how to accomplish the same thing even if the real player is offline.
|
||||
|
||||
- **Debug Mode:**
|
||||
An optional debug mode provides detailed logging for monitoring bot adjustments and troubleshooting module operations.
|
||||
Optional debug modes (full and lite) provide detailed logging for monitoring bot adjustments and troubleshooting module operations.
|
||||
|
||||
### Minimum and Maximum Bot Level Support
|
||||
|
||||
@@ -50,13 +54,6 @@ This module now supports setting a minimum and maximum level for random bots via
|
||||
|
||||
> **Warning:** If you configure the maximum bot level to a value below 55, ensure that Death Knight bots are disabled. The module enforces a minimum level of 55 for Death Knight bots; therefore, setting the maximum level under 55 would conflict with this safeguard and could lead to unintended behavior and Death Knight bots not moving brackets.
|
||||
|
||||
### Dynamic Real Player Weighting and Scaling
|
||||
|
||||
When dynamic distribution is enabled (`BotLevelBrackets.UseDynamicDistribution`), the module recalculates the desired bot percentages for each level bracket based on the number of non-bot players present.
|
||||
|
||||
The total weight across all brackets is computed, and each bracket’s desired percentage is derived from its share of that total. This ensures that while more players in a bracket increase its weight, each additional player contributes progressively less.
|
||||
|
||||
|
||||
Installation
|
||||
------------
|
||||
1. **Clone the Module**
|
||||
@@ -89,56 +86,60 @@ Customize the module’s behavior by editing the `mod_player_bot_level_brackets.
|
||||
|
||||
### Global Settings
|
||||
|
||||
Setting | Description | Default | Valid Values
|
||||
------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------|---------|--------------------
|
||||
BotLevelBrackets.DebugMode | Enables detailed debug logging for module operations. | 0 | 0 (off) / 1 (on)
|
||||
BotLevelBrackets.CheckFrequency | Frequency (in seconds) for performing the bot bracket distribution check. | 300 | Positive Integer
|
||||
BotLevelBrackets.CheckFlaggedFrequency | Frequency (in seconds) at which the bot level reset is performed for flagged bots that failed safety checks initially. | 15 | Positive Integer
|
||||
BotLevelBrackets.RealPlayerWeight | Multiplier applied to each real player's contribution in their level bracket. This value is further scaled inversely by the total number of real players online. **Only active if dynamic distribution is enabled.** | 1.0 | Floating point number
|
||||
BotLevelBrackets.UseDynamicDistribution | Enables dynamic recalculation of bot distribution percentages based on the number of non-bot players in each bracket. | 0 | 0 (off) / 1 (on)
|
||||
Setting | Description | Default | Valid Values
|
||||
---------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------|---------|--------------------
|
||||
BotLevelBrackets.Enabled | Enables the module. | 1 | 0 (off) / 1 (on)
|
||||
BotLevelBrackets.FullDebugMode | Enables full debug logging for the Bot Level Brackets module. | 0 | 0 (off) / 1 (on)
|
||||
BotLevelBrackets.LiteDebugMode | Enables lite debug logging for the Bot Level Brackets module. | 0 | 0 (off) / 1 (on)
|
||||
BotLevelBrackets.CheckFrequency | Frequency (in seconds) at which the bot level distribution check is performed. | 300 | Positive Integer
|
||||
BotLevelBrackets.CheckFlaggedFrequency | Frequency (in seconds) at which the bot level reset is performed for flagged bots that initially failed safety checks. | 15 | Positive Integer
|
||||
BotLevelBrackets.UseDynamicDistribution | Enables dynamic recalculation of bot distribution percentages based on the number of non-bot players present in each bracket. | 0 | 0 (off) / 1 (on)
|
||||
BotLevelBrackets.RealPlayerWeight | Multiplier applied to each real player's contribution in their level bracket. **Active only if dynamic distribution is enabled.** | 1.0 | Floating point number
|
||||
**BotLevelBrackets.IgnoreGuildBotsWithRealPlayers** | When enabled, bots in a guild with at least one real (non-bot) player online are excluded from bot bracket calculations and will not be level changed or flagged. | 1 | 0 (disabled) / 1 (enabled)
|
||||
|
||||
### Alliance Level Brackets Configuration
|
||||
*The percentages below must sum to 100.*
|
||||
|
||||
Setting | Description | Default | Valid Values
|
||||
-------------------------------------------|---------------------------------------------------------------|---------|--------------------
|
||||
BotLevelBrackets.Alliance.Range1Pct | Desired percentage of Alliance bots within level range 1-9. | 12 | 0-100
|
||||
BotLevelBrackets.Alliance.Range2Pct | Desired percentage of Alliance bots within level range 10-19. | 11 | 0-100
|
||||
BotLevelBrackets.Alliance.Range3Pct | Desired percentage of Alliance bots within level range 20-29. | 11 | 0-100
|
||||
BotLevelBrackets.Alliance.Range4Pct | Desired percentage of Alliance bots within level range 30-39. | 11 | 0-100
|
||||
BotLevelBrackets.Alliance.Range5Pct | Desired percentage of Alliance bots within level range 40-49. | 11 | 0-100
|
||||
BotLevelBrackets.Alliance.Range6Pct | Desired percentage of Alliance bots within level range 50-59. | 11 | 0-100
|
||||
BotLevelBrackets.Alliance.Range7Pct | Desired percentage of Alliance bots within level range 60-69. | 11 | 0-100
|
||||
BotLevelBrackets.Alliance.Range8Pct | Desired percentage of Alliance bots within level range 70-79. | 11 | 0-100
|
||||
BotLevelBrackets.Alliance.Range9Pct | Desired percentage of Alliance bots at level 80. | 11 | 0-100
|
||||
Setting | Description | Default | Valid Values
|
||||
--------------------------------------------|---------------------------------------------------------------|---------|--------------------
|
||||
BotLevelBrackets.Alliance.Range1Pct | Desired percentage of Alliance bots within level range 1-9. | 12 | 0-100
|
||||
BotLevelBrackets.Alliance.Range2Pct | Desired percentage of Alliance bots within level range 10-19. | 11 | 0-100
|
||||
BotLevelBrackets.Alliance.Range3Pct | Desired percentage of Alliance bots within level range 20-29. | 11 | 0-100
|
||||
BotLevelBrackets.Alliance.Range4Pct | Desired percentage of Alliance bots within level range 30-39. | 11 | 0-100
|
||||
BotLevelBrackets.Alliance.Range5Pct | Desired percentage of Alliance bots within level range 40-49. | 11 | 0-100
|
||||
BotLevelBrackets.Alliance.Range6Pct | Desired percentage of Alliance bots within level range 50-59. | 11 | 0-100
|
||||
BotLevelBrackets.Alliance.Range7Pct | Desired percentage of Alliance bots within level range 60-69. | 11 | 0-100
|
||||
BotLevelBrackets.Alliance.Range8Pct | Desired percentage of Alliance bots within level range 70-79. | 11 | 0-100
|
||||
BotLevelBrackets.Alliance.Range9Pct | Desired percentage of Alliance bots at level 80. | 11 | 0-100
|
||||
|
||||
### Horde Level Brackets Configuration
|
||||
*The percentages below must sum to 100.*
|
||||
|
||||
Setting | Description | Default | Valid Values
|
||||
-------------------------------------------|---------------------------------------------------------------|---------|--------------------
|
||||
BotLevelBrackets.Horde.Range1Pct | Desired percentage of Horde bots within level range 1-9. | 12 | 0-100
|
||||
BotLevelBrackets.Horde.Range2Pct | Desired percentage of Horde bots within level range 10-19. | 11 | 0-100
|
||||
BotLevelBrackets.Horde.Range3Pct | Desired percentage of Horde bots within level range 20-29. | 11 | 0-100
|
||||
BotLevelBrackets.Horde.Range4Pct | Desired percentage of Horde bots within level range 30-39. | 11 | 0-100
|
||||
BotLevelBrackets.Horde.Range5Pct | Desired percentage of Horde bots within level range 40-49. | 11 | 0-100
|
||||
BotLevelBrackets.Horde.Range6Pct | Desired percentage of Horde bots within level range 50-59. | 11 | 0-100
|
||||
BotLevelBrackets.Horde.Range7Pct | Desired percentage of Horde bots within level range 60-69. | 11 | 0-100
|
||||
BotLevelBrackets.Horde.Range8Pct | Desired percentage of Horde bots within level range 70-79. | 11 | 0-100
|
||||
BotLevelBrackets.Horde.Range9Pct | Desired percentage of Horde bots at level 80. | 11 | 0-100
|
||||
BotLevelBrackets.Horde.Range1Pct | Desired percentage of Horde bots within level range 1-9. | 12 | 0-100
|
||||
BotLevelBrackets.Horde.Range2Pct | Desired percentage of Horde bots within level range 10-19. | 11 | 0-100
|
||||
BotLevelBrackets.Horde.Range3Pct | Desired percentage of Horde bots within level range 20-29. | 11 | 0-100
|
||||
BotLevelBrackets.Horde.Range4Pct | Desired percentage of Horde bots within level range 30-39. | 11 | 0-100
|
||||
BotLevelBrackets.Horde.Range5Pct | Desired percentage of Horde bots within level range 40-49. | 11 | 0-100
|
||||
BotLevelBrackets.Horde.Range6Pct | Desired percentage of Horde bots within level range 50-59. | 11 | 0-100
|
||||
BotLevelBrackets.Horde.Range7Pct | Desired percentage of Horde bots within level range 60-69. | 11 | 0-100
|
||||
BotLevelBrackets.Horde.Range8Pct | Desired percentage of Horde bots within level range 70-79. | 11 | 0-100
|
||||
BotLevelBrackets.Horde.Range9Pct | Desired percentage of Horde bots at level 80. | 11 | 0-100
|
||||
|
||||
Debugging
|
||||
---------
|
||||
To enable detailed debug logging, update the configuration file:
|
||||
|
||||
BotLevelBrackets.DebugMode = 1
|
||||
|
||||
This setting outputs logs detailing bot level adjustments, percentages and distribution to the server console.
|
||||
BotLevelBrackets.FullDebugMode = 1
|
||||
BotLevelBrackets.LiteDebugMode = 1
|
||||
|
||||
Choose one of these debug modes to output logs detailing bot level adjustments, percentages, and distribution to the server console.
|
||||
|
||||
Troubleshooting
|
||||
---------
|
||||
> **Bots are not randomizing their levels within the ranges brackets.** Make sure in your `playerbots.conf` that `AiPlayerbot.DisableRandomLevels` = false. Otherwise bots will be all reset to the set level in your playerbots config.
|
||||
---------------
|
||||
> **Bots are not randomizing their levels within the range brackets.**
|
||||
> Ensure that in your `playerbots.conf` the option `AiPlayerbot.DisableRandomLevels` is set to false. Otherwise, bots will be reset to the fixed level specified in your Playerbots configuration.
|
||||
|
||||
License
|
||||
-------
|
||||
|
||||
Reference in New Issue
Block a user