yrtria/mod-gold-rush
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: clarify mod-playerbots dependency

Browse source
This commit is contained in:
Scarecr0w12 2026-04-01 13:47:04 -04:00
parent 83559df790
commit 060b77c48c
2 changed files with 20 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

1
CHANGELOG.md
View file

@ -7,6 +7,7 @@ All notable changes to `mod-gold-rush` will be documented in this file.
### Added ### Added
- 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.
### 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

24
README.md
View file

@ -6,6 +6,17 @@ eligible open-world zone, anchors on a live player, spawns temporary resource
nodes near the hotspot, announces the event to the server, and can route nodes near the hotspot, announces the event to the server, and can route
playerbots into the area to create a PvPvE scramble. playerbots into the area to create a PvPvE scramble.
## Requirements
> **Required dependency:** `mod-playerbots` must be installed and enabled.
> Gold Rush includes direct playerbot integration and will not work correctly
> without the Playerbots module.
- Requires AzerothCore.
- Requires `mod-playerbots`.
- Gold Rush bot routing, hotspot pressure, and related behavior depend on
Playerbots APIs.
## Features ## Features
- Schedules Gold Rush events on a random interval. - Schedules Gold Rush events on a random interval.
@ -30,12 +41,13 @@ playerbots into the area to create a PvPvE scramble.
## Installation ## Installation
1. Place `mod-gold-rush` inside the AzerothCore `modules/` directory. 1. Make sure `mod-playerbots` is already installed in your AzerothCore setup.
2. Re-run CMake so AzerothCore detects the module. 2. Place `mod-gold-rush` inside the AzerothCore `modules/` directory.
3. Build and install/update your server. 3. Re-run CMake so AzerothCore detects the module.
4. Copy `conf/gold_rush.conf.dist` to your generated module config directory as 4. Build and install/update your server.
5. Copy `conf/gold_rush.conf.dist` to your generated module config directory as
`gold_rush.conf` if you want local overrides. `gold_rush.conf` if you want local overrides.
5. Restart `worldserver`. 6. Restart `worldserver`.
## Configuration ## Configuration
@ -67,6 +79,8 @@ Important options:
- Event locations are announced approximately, not with exact coordinates. - Event locations are announced approximately, not with exact coordinates.
- Hotspots are temporary and despawn at event end. - Hotspots are temporary and despawn at event end.
- Eligible anchors must be in open-world, non-city, non-sanctuary zones. - Eligible anchors must be in open-world, non-city, non-sanctuary zones.
- `mod-playerbots` is required because Gold Rush actively routes random bots to
the event hotspot.
- Blacklisted zones and zone/area pairs are excluded from selection. - Blacklisted zones and zone/area pairs are excluded from selection.
- Node selection alternates between ore-like and herb-like entries when - Node selection alternates between ore-like and herb-like entries when
possible. possible.