add neftet README with variables and nav route docs
All checks were successful
/ test (push) Successful in 21s
All checks were successful
/ test (push) Successful in 21s
This commit is contained in:
parent
f33c631c25
commit
f37af1e63c
1 changed files with 76 additions and 0 deletions
76
neftet/README.md
Normal file
76
neftet/README.md
Normal file
|
|
@ -0,0 +1,76 @@
|
|||
# Neftet Hunting Meta
|
||||
|
||||
Merged leader/follower VTank meta for Neftet hunting. One `.met` file handles both roles based on variables set before loading.
|
||||
|
||||
## Required Plugins
|
||||
|
||||
- VTank (Virindi Tank)
|
||||
- UtilityBelt
|
||||
|
||||
## Variables
|
||||
|
||||
These must be set before loading the meta (e.g. via launcher or `/ub setvar`):
|
||||
|
||||
| Variable | Required | Role | Description |
|
||||
|---|---|---|---|
|
||||
| `isLeader` | Yes | Both | `1` for leader, `0` for follower |
|
||||
| `followTarget` | Yes (follower) | Follower | Leader's character name |
|
||||
| `navRoute` | Yes (leader) | Leader | Main hunting nav route name (e.g. `neftet_route`) |
|
||||
| `navRoute2` | No | Leader | Alternate route after flower/prickly pickup |
|
||||
| `navWaitFollow` | Yes | Both | Return-to-start nav route name (e.g. `neftet_wait_follow`) |
|
||||
|
||||
## Auto-Detected Variables
|
||||
|
||||
These are set automatically at startup in the `Default` state:
|
||||
|
||||
| Variable | Values | Description |
|
||||
|---|---|---|
|
||||
| `ammoType` | `0` = mage/none, `1` = xbow, `2` = bow | Detected from inventory (Quarrelshafts vs Arrowshafts) |
|
||||
| `pickFlowers` | `1` = on, `0` = off | Leader picks up Desert Flowers (default: on) |
|
||||
| `pokePricklys` | `1` = on, `0` = off | Leader picks up Prickly Pears (default: on) |
|
||||
| `pickupRange` | distance | Range for flower/prickly detection (default: 10) |
|
||||
|
||||
## Required Nav Routes
|
||||
|
||||
These nav files must exist in VTank's nav directory:
|
||||
|
||||
| Nav Route | Used By | Description |
|
||||
|---|---|---|
|
||||
| `navRoute` (variable) | Leader | Main hunting route |
|
||||
| `navWaitFollow` (variable) | Both | Return to rendezvous point |
|
||||
| `neftet_quests` | Both | Quest turn-in route |
|
||||
| `ah_recomp` | Both | Recomp route (tapers) |
|
||||
| `ah_give_keys` | Both | Give keys route |
|
||||
| `recomp_gilly` | Both | Mana scarab recomp route |
|
||||
| `recomp_laurana` | Both | Missile ammo recomp route |
|
||||
| `anekshey_tokens_to_proms` | Both | A'nekshay token turn-in route |
|
||||
| `nav_nalicana` | Both | Route to Nalicana (luminance auras) |
|
||||
| `nav_nalicanareset` | Both | Reset position near Nalicana |
|
||||
| `nav_liamofgelid` | Both | Route to Liam of Gelid (seer auras) |
|
||||
|
||||
## Fellowship
|
||||
|
||||
- Fellowship name: `Sawato Rockstyle` (hardcoded)
|
||||
- Leader auto-creates fellowship on startup
|
||||
- Follower auto-requests recruitment by sending `#alexgillarkillar` tell to leader every 5s when not in fellowship
|
||||
- Leader auto-recruits via `/ub fellow recruit` when receiving the passphrase
|
||||
|
||||
## Chat Commands
|
||||
|
||||
Say these in fellowship chat to toggle features (leader only):
|
||||
|
||||
| Command | Effect |
|
||||
|---|---|
|
||||
| `#toggle_flowers` | Toggle Desert Flower pickup on/off |
|
||||
| `#toggle_pricklys` | Toggle Prickly Pear pickup on/off |
|
||||
|
||||
## Features
|
||||
|
||||
- **Auto-restock**: Tapers (<=100), Mana Scarabs (<=10), missile ammo (<=10 bundles)
|
||||
- **Auto-lum auras**: Buys cheapest Nalicana aura when luminance >= 1.5M and any aura not maxed
|
||||
- **Auto-seer auras**: Buys Destruction/Retribution auras from Liam of Gelid after all standard auras hit rank 5
|
||||
- **A'nekshay token turn-in**: Auto turns in tokens at 1000 count
|
||||
- **Key management**: Goes to give keys when inventory slots <= 4
|
||||
- **Death recovery**: Pauses, then routes to quest turn-in
|
||||
- **Follower leader-leave detection**: If leader leaves fellowship, follower quits and goes to turn-in
|
||||
- **Stuck recovery**: Watchdog timers throughout, falls back to turn_in_quests
|
||||
Loading…
Add table
Add a link
Reference in a new issue