Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sogladev/wb-scout


https://github.com/sogladev/wb-scout

Last synced: about 2 months ago
JSON representation

Awesome Lists containing this project

README

        

# scout
This script will AFK scout for you and write in discord once a world boss on unitscan has been found.

This is how the demo version works: https://youtu.be/pXCjO0RzT7k

Requires keyboard control, running discord and activated wow client. So must be run in the foreground! Best used while AFKing.

## DEMO mode vs MAIN mode
The demo version sends discord message to party chat and alerts the Sogla's AHK Scout Bot Test Discord discord

https://discord.gg/FvMxSR9w2j

Do the setup once, then run demo version to try out the discord alerts and see how it works.

Then you can run the main version when scouting world bosses by changing value 1 to 0.
```
enable_demo_mode := 0 ; Sends alerts to guild chat and main discord
```

## Duo scout mode
```
global enable_duo_scout_mode:=0 ; enables/disables both scouting of 2 bosses, set to 1 to enable
```
Bot will scout for 1-2mins at first boss then swap to character down on char select screen.
Character list has to look like below
```
. Character screen
├── character at world boss - Run script here
└── character at other boss
```

## Scout in background
```
global scout_in_background:=1 ; Relogs character like duo scout mode and skips IPCP (without input from copypastelib)
```
Runs anti-afk script for your character while scouting single boss or duo boss (set with `enable_duo_scout_mode`).
Requires manually alerting discord but does not require window focus.

## Setup
This video shows the demo version and gives you an idea of how it should look like! Streamable link: https://youtu.be/pXCjO0RzT7k

Step 1. Install autohotkey
https://www.autohotkey.com/

Step 2. Install LibCopyPaste Addon
LibCopyPaste-1.0: https://www.curseforge.com/wow/addons/libcopypaste

I provided the classic `LibCopyPaste-1.0-v1.0.10-classic.zip` version in the folder.
Unzip the LibCopyPaste-1.0-v1.0.10-classic.zip and drag `/LibCopyPaste-1.0` folder into your interface/addons then **reload the game client** to load the addon.

Does it work?
Run this command ingame. If there's a prompt to accept custom scripts, click yes.
This should popup a window with some text.
```
/run local LibCopyPaste = LibStub('LibCopyPaste-1.0');LibCopyPaste:Copy('Install sucess', "LibCopyPaste installed successfully")
```

Step 3. Modify unitscan - unitscan.lua
I use a modified `unitscan.lua` file.

For simplicity sake I included my entire `/unitscan` folder so you can copy-paste replace everything!

Does it work?
Run this command ingame. If it prints "nil" it is incorrect. If it prints "no_unit_found" it works correctly!
```
/script print(unitscan_discovered_unit_name)
```

## EZ Start bot
start a `launch_live_.*.ahk`

or go into config.ahk and edit options yourself and start `scout_f12_foreground.ahk`

## (optional) Config.ahk
A. Edit config file `config.ahk` to your liking. It works out of the box!*

Each line has a comment saying what it does.

These affect functionality so change these if needed
```
global is_rogue:=1 ; if 1 it sends 1 to press stealth when logging out/in
global is_stay_logged_in:=0 ; if 1 runs AFK script after succesful scouting, if 0 closes the game client after alerting
```

## (optional) Macro setup
Set `use_macros:=1` in `config.ahk`!
Bind this macro to buttons 5 on your scout.

5. Logout
```
/p Relogging on purpose. Brb in 1min
/raid Relogging on purpose. Brb in 1min
/logout
```

## Usage
Double-click `scout_f12_foreground.ahk` to load the script! It will show a confirm message if it's loaded.

Activate your WoW client with your scout character and press `F12` to start the script.

You can press F12 to disable the script but it will finish the scout loop.

Press CTRL+F12 to exit the script immediately.

!Every 20mins or so this script will relog your character for 1min to avoid random disconnects.

If you get in combat or die the script will alert ingame/discord.

## Notes

For details what I changed in unitscan: 2 minor changes to `unitscan.lua`.
in `unitscan.lua` added
```
unitscan_discovered_unit_name = "no_unit_found"
unitscan_discovered_unit_name = name
```

*enable_demo_mode needs to be set to 0 to alert Praxis discord ;)