ffbeAuto Z Continued! Auto farming, chaining, arena & more!

EDIT - THIS IS NO LONGER BEING DEVELOPED AS THE ANKULUA AUTHOR HAS CHOSEN NOT TO OFFER SUPPORT FOR MATCHING USING IMAGES WITH TRANSPARENCY AND BECAUSE I NO LONGER PLAY THE GAME. FEEL FREE TO FORK MY CODE AT github.com/NonceCents/FFBEAutoZContinued IF YOU WISH TO CONTINUE SUPPORTING THIS PROJECT.

THANK YOU FOR YOUR INTEREST!

---

Hey everyone! Some of you may be familiar with Sikat's ffbeAuto Z, which is an excellent fork of tinotk's ffbeAuto. However, Sikat has had to step back from the project and so the torch has passed to me for the time being. I will attempt to continue to support the project further, and I encourage others with coding experience to contribute as well.

I've copy-pasted most of what is below below from Sikat's thread and will continue to add to it as he did. A quick word of warning; my Z20a build is very much an Alpha. I'm fairly new to coding in LUA, and my free time for finding and fixing issues is very limited. Please let me know of any issues you're experiencing and I'll try to get it addressed as my availability permits.

Originally made by tinotk
Modified by Sikat
Modified further by NonceCents

Features:

• Self-updating; enable Network Functions in AnkuLua settings and bug-fixes / improvements / new images will be downloaded and applied within seconds of launch.
• Earth Shrine TMR farming with/without Lapis refresh.
• Chain Helper function allows you to configure at any time while battling a set of precise delays in which to activate your units abilities. This allows for near-perfect ability chaining with ease.
• Automatic Arena battle; script looks for available (non-banned) AoE abilities to cast onto the enemy team, or you can manually configure abilities to use.
• Dungeon Finder, able to automatically find any dungeons or raid battles and farm them repeatedly.
• Custom ability casting for dungeons / raids allows you to define the abilities for your units to cast during several stages of battle, including detection of boss battles with a separate set of abilities to use. This can be mixed with automatic functions where the script will look for an available ability that meets your criteria. Custom ability time delays allows skills to be timed for effective ability chaining and damage efficiency. This allows high-difficulty raids or event battles to be farmed.
• Exploration farming, script is able to farm select exploration nodes and optionally farm encounters for max unit experience.
  
• Free Farm, used for manual exploration farming, will attempt to move back and forth to find battles for you.
  
• Can dim screen while farming (AnkuLua PRO only), can farm for a specific number of runs or infinite, provides feedback on number of battle success/failures when script ends, can optionally use Lapis refresh for any battle type.
  
• Comprehensive error / connection / dialog box handling.
  
• All 16:9 and 16:10 resolutions supported. Not sure about the others as I can't test them properly.

How to Install:
Simply extract all contents to AnkuLua's folder (default is in AnkuLua folder in the Internal Storage of your device). Overwrite files when necessary.

Recommended settings are to run in Nox 5.0.0.x emulator on High Performance setting, 600 width, 960 height, 160 DPI, OpenGL renderer, 60 FPS.
Using DirectX renderer in Nox may cause the script to confuse the numbers 5 and 6.

Most phones / tablets should work at other aspect ratios / resolutions. Please report any that do not.
The exception currently are Samsung Galaxy "Edge" devices (such as the S8) which are not working due to the extra unused screen space breaking aspect ratio mathematics used when finding and comparing images.

Enable Network Functions in AnkuLua before running the script and it will check for / apply any new updates!

How to use:
- If you're using an actual device and not an emulator, please be aware that some AMOLED screens will exhibit burn in when left on for prolonged time with FFBE. Search for AMOLED burn in in Google. IPS screens are better for this purpose. Also, your device will most likely be emitting lots of heat and your battery will take a hit (this goes for every prolonged game session). Your device also needs to stay awake (this can be done with Developer Settings - stay awake while charging) as AnkuLua needs the screen to be on at all times.
- Open your maps selection screen and start the script.
- Important : If you are using any superuser root app, make sure to turn off Toast notifications as they interfere with the button matching.
- Always start from Quest selection screen.

Options:

- Device Lag Multiplier: this setting is intended to use on slower devices or emulators, if your device lags, you might wanna set this to 2.0 or 2.5 or higher. tinotk (original author) have successfully run Phantom Forest all night long on a 5 year old laptop with 2.5 lag multiplier. I recommend you to start with 1.0-1.5, adjust when necessary. Explorations may require higher lag multiplier to be safe. For reference, I use 1.0 in my Snapdragon 821-powered phone. 1.3-1.5 should be the starting point for emulators on explorations, less on dungeons, depending on how many instances you run and your processor you may have to increase this. I don't recommend running multiple instances of emulators in the same computer if you want to do explorations.
- Dungeon Finder: as you can tell from the name: it will find all available dungeons on screen and give you a list to choose from. As of now, this option can be used to farm any dungeon, yes any dungeon including those in vortex.
- Dim screen (Pro): dim your screen while running. Note that if you use AnkuLua free it will limit playing to 5 minutes if you use this option.
- Free Farm: activate this when you're inside exploration, the script will keep going in your chosen direction and find battle until you stop it.
- Bonus Unit companion: Will try to use units marked as bonus first, useful for Mog King events.
- Use esper: Script will try to use esper whenever available.
- Max depart count: Script will stop playing after this many departs. Useful if you want to wake up with energy left but not waste any. Input 99999 for infinite (previous version behavior)
- Retry on Game Over: If checked script will continue on game over, this is the default behavior of the previous versions.

Custom ability cast times:
- One of the most recent additions in Z19 is custom ability cast times. This can be used directly via the Chain Helper function or enabled or disabled for farming under the Custom battle mode for dungeons.
- This feature allows you to cast certain abilities before others with precision, allowing you to ensure before activating an ability that a target has a break applied, your units have a buff activated, or for those who are familiar, abilities to be chained together.
- Times are considered in terms of frames, assuming 60 frames per second (which the game is designed to run at). Thus, delaying an ability for 60 frames waits 1 second before casting.
- Abilities cast with 0 frames of delay will be cast immediately. Attempting to cast too many abilities at the same time in this manner may be problematic on slow emulators or phones. If this happens, try adding short delays of a few frames between those ability casts. Also note that this may interact with the "Magnification Gestures" trick.
- To determine the proper delay with which to cast abilities, use a database like www.exvius.gamepedia.com to look up your units and mouse over the number in the Hits column. The Attack Frames will show at which frames the hits from the ability will land on the target. In this manner, two units with similar frame delays between chained attacks but different delays before the skill is cast can be adjusted to chain their abilities together, or if a finisher is being used, the delay for that unit's attack could be timed to land at the end of a chain when it will do the most damage. 
- See the Chain Mechanics page and resources like The Art of Chaining for further details.
EDIT - This tool is extremely useful for simulating how units will chain together: ffbe-chain.com/chain

Arena mode:
- Arena mode can run fully automatically; the script will find non-banned AoE spells with a specified MP minimum or higher and cast them. It can also "Just Use Repeat", which will use the repeat button to continue the last set of actions you performed in Arena. You may also configure a custom ability selection, with optional alternative set of casts for when the enemy strikes first (use recovery / defensive spells here, and the next round your offensive set will be used). Just be sure you have selected skills that are not banned. You may also select automatic ability selection in this mode on a per-unit basis.
- You may select to engage either a high-Ratio opponent, or a low-Ratio one (if you're looking for easier pickings).

How to define a custom exploration path:
map_name:direction,steps|direction,steps|direction,steps|direction,steps|.......|direction,steps
map_name: you name it with whatever you like, this name will show up on the selection list with a "custom_" prefix.

direction:

up, down, left, right
ul: go up-left (North West)
ur: go up-right (North East)
dl: go down-left
dr: down-right

(Note that diagonal directions can sometimes get stuck on a wall, I personally don't use them)

steps: anything <20 will be single step (trust me you don't need more than 20), anything above that will be ms (milliseconds).

Rule of thumb: one map per line
. Make sure that you put all directions on a single line separated direction by a | (pipe).

Direction example:
up,5: go up 5 steps

up,5000: go up 5s

left,1000: go left 1s
ul,1500: go up-left 1.5s
Below is an example of my water shrine path taken from the script:

water_shrine:right,700|up,2000|right,2500|up,1800|down,1800|left,1|down,1200|left,1950|up,700|left,5|up,3000|up,2100|right,1500|down,3|right,1500|battle,lr,4820,right|right,4000|left,1|up,2700|down,4|right,1200|right,8500|down,1|left,9000|down,3000|left,3000|up,1200|left,4|up,2500|left,2000|right,1|up,2000|down,4|left,4500|right,3|up,2000|up,2300|right,4000|battle,lr,11188,right|right,8000|left,17|up,3000|up,3000

Special settings for custom path:
If you read my custom water shrine path above you will notice the extra battle part. This setting is used for the Find Battle option, see below for syntax:
battle,[battle_direction],[gil_cap],[exit_direction]

battle_direction: either "ud" for up-down or "lr" for left-right
Gil cap: amount of gil to check, if > this amount, the script will exit battle and continue exploration. How to get this? Either manually battle yourself or check here: exviuswiki.com/
Exit direction: direction to go next after done battle.

For those of you who used the original ffbeAuto, there are some minor differences between the format, and your explorations will still be compatible. However, it now disregards findmove command as findmove is now always used in every step.

New pathing commands added in Z6 :
wait,7000 : will wait for x ms (for elevators and such, I use it on Invincible Interior for example)

leaveafterboss : will immediately leave after boss battle. Use it anywhere before boss battle, preferably use it at the start of exploration (does not delay anything)

bosscheck, 20 : will do bosschecks after this many moves. Set this to 2 moves before boss battle for stability reasons. If you don't set it or set it lower than 20 it will auto-adjust the value after a successful run, so successive runs will be faster. Bosschecks takes a lot of time, and a proper bosscheck value speeds up explorations noticeably.

battleex : similar to find battle above, but with more settings. It's now battleex,[battle_direction],[gil_cap],[battle_count_cap],[steps],[exit_direction]
        battle_count_cap : Will exit finding battles when above this battle counted from the start of exploration.
        steps : Just like exploration steps, define how many ms to swipe up/down or left/right. Useful to prevent excessive bumping into walls situation which wastes a lot of time.

Old paths will continue to be compatible with this version, no need to do anything if you don't want to.

How to define a good path:
Below are few tips that I've learned from doing those exploration paths:
- Try to always bump
into walls, if you can't then use single steps. However, try to minimize single steps if possible. Single steps take more time due to the fact that the script will wait and check for any battle encounter after each step.
- For any of your calculated ms, add 500 to it.
- Minimum 500ms, don't go below that.

Community-submitted custom Explorations:
Wolfsfang Peak exploration by zenkrye
Dwarves Forge exploration by eleck
Timber Tracks exploration by eleck

How to report a bug:
Please take a screenshot of your script config (like the first picture above), and advise what you were trying to do to produce that bug. A video and/or logfile would be much appreciated. The log is located on the script's folder.

Version history:

Z20 - Out of Beta! This release fixes Chain Helper manual mode and adds auto-update functionality
Z20b3 - Further improvements to auto-skill selection, team-cast skill handling, search scrolling efficiency, fixed a bug with Auto-Arena falling back to a prompt for MP.
Z20b2 - Arena auto battle is fixed, fixed some issues with other resolutions.
Z20b - Major changes to the way unit detection is addressed; now allows for custom Arena battles (which are now fixed) and Chain Helper to be used where not all party members are ready or are K.O. Added option for Arena battles to use a separate set of skills when the enemy goes first (so you can cast recovery etc). THIS MAY HAVE BROKEN THE SCRIPT ON NON-NATIVE RESOLUTIONS. Please provide feedback as I haven't had time to test it. Manual Chain Helper and Arena Auto battle are still not working properly.
Z20a - Overhauled UI, added Chain Helper function. Added first pass at custom Arena battles; still buggy. Added ability Gamble.
Z19a - Added a "Just Press Repeat" option as well as the ability to have skills cast with custom delay times in frames per second. Added abilities Imperil, Sentinel, Resist. Added ability for companion units to use Single Target damage abilities. Cleaned up end-of-turn handling (should be a little bit more reliable).

Sikat's builds (see his thread for download links):
Z18 - Fixed speedmode stuck in request companion screen, added Ruggles Underground Pass exploration (does not support find battle function yet).
Z17a - Fix for banned skills in arena, adjusted some arena parameters.
Z16 - Fix for various errors. Added icon check to Any Attack and Any AoE Attack.
Z15 - Added Alterna, Any Attack, Any AoE Attack as options for custom battle. Added an option to let companions use AoE attacks at the beginning of battle. Added Arena mode (Please read first!). Fixed some bugs on Earth Shrine Speed mode.
Z15 BETA 2 - Fixed custom battle mp issues.
Z15 BETA - Slowed down first run of speed mode to better learn the locations, a fix for wrong MP number (5 read as 6) - needs testing.
Z14 - Simple fix for Bahamut Raid. Use dungeon_finder for the raid.
Z13 - Fixed enchanted maze.
Z12 - Fixed custom battle when going in without full party. Added help for custom battle function in the script itself.
Z12 BETA3 - Added Earth Shrine Speed Mode for quicker TM farming. Added Meteor custom action. Changed companion skills to use damage only skills. Optimized some custom battle functions.
Z12 BETA2 - Revamped interface, Added Provoke, Sing, Dance, Ultima to custom actions. Added use companion skills to boss battles, selecting only by MP. Fixed a bug with Bonus friends selection.
Z12 BETA1 - Another round of optimization, custom battle feature. Please test the custom battle as it is brand new.
Z11 - Major optimizations and compatibility fixes. Much faster after a successful run as it will learn the buttons' location.
Z10 - Fixed Game Over bugs, added a new "select highest ATK companion" feature. Added results on script stop.
Z9 - Bugfixes due to the new version, mainly towards explorations.
Z8 - Added basic built-in help. Changed fire shrine pathing to something more reliable. Fixed a bug with continue battle after boss clicking the wrong thing. Fixed a bug with exploration battles clicking. Water shrine bug fixed.
Z7 - Fixed problems with pathing on Invincible Interior, fixed a bug with Esper-enabled exploration battles that causes it to not click Auto. Slightly slowed down exploration due to choppiness of emulators which leads to the script not recognizing that it's in battle. Added fire shrine exploration. Re-styled the debug messages, they now appear on the top bar because Toasts often interferes with image matching.
Z6 - Fixed problems with companion selection bug, optimized explorations and added more functions for pathing, added invincible interior and wind shrine exploration. 
Z5 - Changed skills/magic to esper only (way faster), can now be used in explorations. Modified and optimized explorations for upcoming event. Added water shrine exploration. Added depart cap and continue on Game Over options. Some speed improvements in the results screen, also stability fixes for explorations.
Z4 - Speed improvements. Removed v0.51 version reference.
v0.51 Z3 - Added Raid compatibility (use dungeon_finder), Major stability fixes for unstable connection, everything from vortex farming, future King Mog farming, and explorations should be way more resistant to network problems.
v0.51 Z2 - Major code optimization for everything, explorations runs much faster and more stable. Handles all errors including the new unit data has changed error.
v0.51 Z1 - Beginning to fix everything to conform to FFBE version 2.0, priority to normal battles. Added skills/magic use.

Download link :

Z20 - github.com/NonceCents/FFBEAutoZContinued/archive/master.zip

I'm using GitHub now! The above download link will always be up-to-date. However, once you download this version, future versions will download automagically as I update and improve the code, so you won't have to worry about checking back here for updates. It'll also download any new images I add!


Video examples :





Mandatory Disclaimer: I take no responsibilities whatsoever for any and all damages caused by this script, however I do my best to erase or warn you about potential problems.

Warning: Use of this script likely constitutes a breach of the TOS for Final Fantasy Brave Exvius. You use this script at your own risk. 

Donate to Sikat