diff --git a/CHANGELOG.md b/CHANGELOG.md index 78f4c0e..c22e22c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,6 +8,8 @@ All notable changes to `mod-gold-rush` will be documented in this file. - Standalone repository documentation in `README.md`. - Initial `CHANGELOG.md` for tracking module releases. - Clear documentation that `mod-playerbots` is a required dependency. +- Added a compatibility section describing the AzerothCore + Playerbots + expectations for this module. ### Changed - Loosened Gold Rush hotspot selection so events can fall back to eligible diff --git a/README.md b/README.md index 7512484..38ae35a 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,18 @@ playerbots into the area to create a PvPvE scramble. - Gold Rush bot routing, hotspot pressure, and related behavior depend on 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 - Schedules Gold Rush events on a random interval.