docs: add compatibility notes for playerbots setups

This commit is contained in:
Scarecr0w12 2026-04-01 13:51:38 -04:00
parent 060b77c48c
commit ebef50d438
2 changed files with 14 additions and 0 deletions

View file

@ -8,6 +8,8 @@ All notable changes to `mod-gold-rush` will be documented in this file.
- Standalone repository documentation in `README.md`. - Standalone repository documentation in `README.md`.
- Initial `CHANGELOG.md` for tracking module releases. - Initial `CHANGELOG.md` for tracking module releases.
- Clear documentation that `mod-playerbots` is a required dependency. - Clear documentation that `mod-playerbots` is a required dependency.
- Added a compatibility section describing the AzerothCore + Playerbots
expectations for this module.
### Changed ### Changed
- Loosened Gold Rush hotspot selection so events can fall back to eligible - Loosened Gold Rush hotspot selection so events can fall back to eligible

View file

@ -17,6 +17,18 @@ playerbots into the area to create a PvPvE scramble.
- Gold Rush bot routing, hotspot pressure, and related behavior depend on - Gold Rush bot routing, hotspot pressure, and related behavior depend on
Playerbots APIs. Playerbots APIs.
## Compatibility
- Built for AzerothCore-based setups that include `mod-playerbots`.
- Not compatible with a stock AzerothCore setup that does not have
`mod-playerbots` installed.
- Gold Rush directly includes Playerbots headers and uses Playerbots runtime
APIs for routing bots to event hotspots.
- If `mod-playerbots` is missing, Gold Rush should be expected to fail to
build or fail to function correctly.
- Best fit: the same Playerbot-oriented AzerothCore environment this module is
being developed and tested against.
## Features ## Features
- Schedules Gold Rush events on a random interval. - Schedules Gold Rush events on a random interval.