05057ae9b5
# Fix bot mount behavior when master dismounts ## Summary Improves bot mount/dismount logic to ensure better coordination with the master player. The bot now remains mounted when closing distance to a recently dismounted master and mounts up to assist the master in combat. The changes have been tested using the testcases described in the second half of the PR description, which provide some directions on how this PR can be tested and verified. Closes: #1660 ## Changes - Add masterInCombat variable to track master combat state - Modify target-based logic to consider master combat state - Change mount priority when bot is not in combat to favor master-following - Remove combatReach from distance calculations (duplicate) ## Implementation Added two methods: - `StayMountedToCloseDistance()` - prevents premature dismounting when the master dismounts - `ShouldMountToCloseDistance()` - determines when to mount for master assistance, even if master is not mounted at this time Modified Execute() method: - Target-based shouldMount/shouldDismount considers the master's combat state - Combat assistance logic separated from general following - Mount when master in combat, but the bot is not Distance logic: - Combat: dismount at CalculateDismountDistance() (18-25 yards) - Non-combat: dismount at 10 yards - Mount threshold: 21+ yards ## Result - Bots mount to assist masters in combat - Bots stay mounted longer during travel - Different dismount distances based on context - Existing mount selection logic unchanged # Mount Behavior Testing ## Prerequisites 1. Add a test bot: `.playerbots bot add <charactername>` or `.playerbots bot addclass <class>` 2. Test in a level-appropriate outdoor area (mobs should not die with one hit, as this makes testing combat assistance impossible) 3. Both master and bot must have mounts available ## Test 1: Combat Assistance Mounting **Objective**: Verify bot mounts to assist the master in combat **Detailed Steps**: 1. Position both master and bot dismounted 2. Command bot to stay: `/w <botname> stay` 3. Move master 35+ yards away from bot 4. Target a nearby mob and attack the mob 5. Command bot to assist: `/w <botname> follow` **Expected Results**: - Bot immediately mounts up (within 1-2 seconds cast time) - Bot rides toward master while mounted - Bot dismounts at ~18-25 yards from master/mob - Bot engages in combat to assist **Failure Indicators**: - Bot runs dismounted (old behavior) - Bot never mounts despite distance - Bot mounts but doesn't dismount at proper assist range ## Test 2: Non-Combat Dismount Distance **Objective**: Verify bot stays mounted longer during peaceful travel **Detailed Steps**: 1. Both master and bot start dismounted 2. Mount up: use any mount 3. Verify bot also mounts: `/w <botname> follow` 4. Travel together for 10+ seconds to establish following 5. While moving, dismount master but continue running 6. Observe bot behavior as you move away **Expected Results**: - Bot stays mounted while master runs dismounted - Bot only dismounts when within ~10 yards of master ## Test 3: Target Interference Prevention **Objective**: Verify target selection doesn't prevent mounting when master needs help **Detailed Steps**: 1. Position bot 35+ yards from master: `/w <botname> stay` then move away 2. Find a mob visible to both master and bot 3. Target the mob (do not attack): click on mob to select it 4. Verify bot can see the target: `/w <botname> attack` (bot should respond about target) 5. Cancel bot attack: `/w <botname> follow` 6. Now attack the mob yourself (master enters combat) 7. Observe bot behavior immediately after master engages **Expected Results**: - Bot mounts up despite having the same target selected - Bot rides toward combat area while mounted - Bot dismounts at assist range (~18-25 yards) - Target selection does not prevent proper mount behavior **Failure Indicators**: - Bot runs dismounted toward target (target interference) - Bot doesn't mount because it's "focused on target" ## Test 4: Basic Mount Following **Objective**: Verify fundamental mount matching still works **Detailed Steps**: 1. Start both master and bot dismounted 2. Ensure bot is following: `/w <botname> follow` 3. Mount up on any available mount 4. Wait 2-3 seconds and observe bot 5. Test different mount speeds if available (60%, 100%, 280% speed) 6. Test dismounting and remounting **Expected Results**: - Bot mounts within 2-3 seconds of master mounting - Bot uses appropriate mount speed to match master - Bot dismounts when master dismounts (basic following) - No regression in basic mount following behavior ## Test 5: Distance-Based Mounting Threshold **Objective**: Verify bot mounts at efficient distance threshold (21+ yards) **Detailed Steps**: 1. Both master and bot start dismounted in safe area (no mobs) 2. Command bot to stay: `/w <botname> stay` 3. Record starting position: `.gps` 4. Walk exactly 15 yards away (short distance) 5. Command bot to follow: `/w <botname> follow` 6. Observe: bot should run dismounted (distance too short) 7. Command bot to stay again: `/w <botname> stay` 8. Walk to 25+ yards away from bot 9. Record new position: `.gps` 10. Command bot to follow: `/w <botname> follow` **Expected Results**: - At 15 yards: Bot runs dismounted (inefficient to mount) - At 25+ yards: Bot mounts up immediately (efficient distance) - Distance threshold should be ~21 yards based on mount cast time efficiency **Distance Calculation**: Use coordinates from `.gps` to verify exact distances ## Test 6: Druid Form Integration (Druid Master Required) **Objective**: Verify druid form compatibility with mount system **Detailed Steps**: 1. Master must be druid with travel form available 2. Start both dismounted: `/w <botname> follow` 3. Shift master to travel form 4. Observe bot response (should mount or shift if druid) 5. Travel together for 10+ seconds 6. Shift master to normal form while moving 7. Observe bot dismount behavior 8. If available, test flight form in appropriate zones **Expected Results**: - Druid bot: matches master's form (travel form) - Non-druid bot: uses equivalent mount speed - Form changes trigger appropriate bot responses - Speed matching works between forms and mounts ## Test 7: Battleground Mount Behavior **Objective**: Verify mount behavior works in PvP environments **Detailed Steps**: 1. Queue for battleground with bot in party 2. Enter battleground together 3. Test basic mount following in BG 4. Test flag-carrying restrictions (WSG/EotS) 5. Test mounting during BG combat scenarios **Expected Results**: - Bot mounts appropriately in battlegrounds - Flag carrying prevents mounting - Combat assistance mounting still works in PvP
Playerbots Module
mod-playerbots is an AzerothCore module that adds player-like bots to a server. The project is based off IKE3's Playerbots.
Features include:
- The ability to log in alt characters as bots, allowing players to interact with their other characters, form parties, level up, and more
- Random bots that wander through the world, complete quests, and otherwise behave like players, simulating the MMO experience
- Bots capable of running most raids and battlegrounds
- Highly configurable settings to define how bots behave
- Excellent performance, even when running thousands of bots
We also have a Discord server where you can discuss the project, ask questions, and get involved in the community!
Installation
Supported platforms are Ubuntu, Windows, and macOS. Other Linux distributions may work, but may not receive support.
All mod-playerbots installations require a custom branch of AzerothCore: mod-playerbots/azerothcore-wotlk/tree/Playerbot. This branch allows the playerbots module to build and function. Updates from the upstream are implemneted regularly to this branch. Instructions for installing this required branch and this module are provided below.
Cloning the Repositories
To install both the required branch of AzerothCore and the mod-playerbots module from source, run the following:
git clone https://github.com/mod-playerbots/azerothcore-wotlk.git --branch=Playerbot
cd azerothcore-wotlk/modules
git clone https://github.com/mod-playerbots/mod-playerbots.git --branch=master
For more information, refer to the AzerothCore Installation Guide and Installing a Module pages.
Docker Installation
Docker installations are considered experimental (unofficial with limited support), and previous Docker experience is recommended. To install the mod-playerbots on Docker, first clone the required branch of AzerothCore and this module:
git clone https://github.com/mod-playerbots/azerothcore-wotlk.git --branch=Playerbot
cd azerothcore-wotlk/modules
git clone https://github.com/mod-playerbots/mod-playerbots.git --branch=master
Afterwards, create a docker-compose.override.yml file in the azerothcore-wotlk directory. This override file allows for mounting the modules directory to the ac-worldserver service which is required for it to run. Put the following inside and save:
services:
ac-worldserver:
volumes:
- ./modules:/azerothcore/modules:ro
Additionally, this override file can be used to set custom configuration settings for ac-worldserver and any modules you install as environment variables:
services:
ac-worldserver:
environment:
AC_RATE_XP_KILL: "1"
AC_AI_PLAYERBOT_RANDOM_BOT_AUTOLOGIN: "1"
volumes:
- ./modules:/azerothcore/modules:ro
For example, to double the experience gain rate per kill, take the setting Rate.XP.Kill = 1 from woldserver.conf, convert it to an environment variable, and change it to the desired setting in the override file to get AC_RATE_XP_KILL: "2". If you wanted to disable random bots from logging in automatically, take the AiPlayerbot.RandomBotAutologin = 1 setting from playerbots.conf and do the same to get AC_AI_PLAYERBOT_RANDOM_BOT_AUTOLOGIN: "0". For more information on how to configure Azerothcore, Playerbots, and other module settings as environment variables in Docker Compose, see the "Configuring AzerothCore in Containers" section in the Install With Docker guide.
Before building, consider setting the database password. One way to do this is to create a .env file in the root azerothcore-wotlk directory using the template. This file also allows you to set the user and group Docker uses for the services in case you run into any permissions issues, which are the most common cause for Docker installation problems.
Use docker compose up -d --build to build and run the server. For more information, including how to create an account and taking backups, refer to the Install With Docker page.
Documentation
The Playerbots Wiki contains an extensive overview of AddOns, commands, raids with programmed bot strategies, and recommended performance configurations. Please note that documentation may be incomplete or out-of-date in some sections, and contributions are welcome.
Bots are controlled via chat commands. For larger bot groups, this can be cumbersome. Because of this, community members have developed client AddOns to allow controlling bots through the in-game UI. We recommend you check out their projects listed in the AddOns and Submodules page.
Contributing
This project is still under development. We encourage anyone to make contributions, anything from pull requests to reporting issues. If you encounter any errors or experience crashes, we encourage you report them as GitHub issues. Your valuable feedback will help us improve this project collaboratively.
If you make coding contributions, mod-playerbots complies with the C++ Code Standards established by AzerothCore. Each Pull Request must include all test scenarios the author performed, along with their results, to demonstrate that the changes were properly verified.
We recommend joining the Discord server to make your contributions to the project easier, as a lot of active support is carried out through this server.
Please click on the "⭐" button to stay up to date and help us gain more visibility on GitHub!
Acknowledgements
mod-playerbots is is based off ZhengPeiRu21/mod-playerbots and celguar/mangosbot-bots. We extend our gratitude to @ZhengPeiRu21 and @celguar for the continued efforts in maintaining the module.
Also, a thank you to the many contributors who've helped build this project: