docs: add compatibility notes for playerbots setups
This commit is contained in:
parent
060b77c48c
commit
ebef50d438
2 changed files with 14 additions and 0 deletions
|
|
@ -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
|
||||
|
|
|
|||
12
README.md
12
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.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue