This is a forkekd version of bover87's LabMem branch, which adds additional integration to trgKai's Soulbreak Tracker/Search companion site. bover78's original readme can be found below.
This is a slightly modifed version of HughJeffner's original LabMem bot for FFRK. It is built to run with FFRK JP, with various changes made by mendicant and further modified by bover87. This version may contain bugs. I will try my best to fix any issues, but my knowledge of coding is extremely limited. If you find bugs and know how to fix them, please feel free to create a fork.
Full automation for labyrinth dungeons on Android FFRK and Windows using a proxy server and adb
Built using Visual Studio 2022 Community, Installer using Inno Setup 6, pre-compiled binaries provided on the releases page
Note: button tap locations were calculated as a percentage of a 720 x 1280 screen, this may not work on other screen sizes, more testing needed
| Android Version | JP FFRK Version | Compatible |
|---|---|---|
| Android (Any) | 6.x and lower | Not Supported |
| Android 5 (Lollipop) | 7.0.0+ | Yes |
| Android 6 (Marshmallow) | 7.0.0+ | Yes |
| Android 7 (Nougat) | 7.0.0+ | Yes (root) |
| Android 8 (Oreo) | 7.0.0+ | Yes (root) |
| Android 9 (Nougat) | 7.0.0+ | Yes (root) |
| Android 10 + | 7.0.0+ | No (maybe?) |
All compatible versions using FFRK 7.0.0+ must install a certificate
- Go to the releases page and find the lastest release
- Under 'Assets' dropdown download
FFRK-LabMem-x.x.x-Beta-Installer.exefile and download, run, and follow the steps. (Or you can manually install by downloading and extracting the .zip file instead) - Start Emulator / Connect device to USB
- Turn on 'Developer Mode' in android settings see here
- Activate USB debugging in developer settings
- Start application FFRK-LabMem.exe (it has a treasure-chest icon)
- Press
Cto open the configuration - Update ADB host if using emulator
- Restart the bot when prompted
- Go back into the configuration, Under proxy settings, enable Auto-configure
- Restart the bot when prompted
- Restart your device/emulator when prompted
- Follow any on-screen instructions to install the certificate
- (Optional) If you want to see Japanese characters, change the font to MS Mincho. More information about displaying Japanese characters is give here
- Launch FFRK
- On the home screen (not title screen) auto-detect screen offsets
Alt+O('o' for offsets) - Start a lab or enter one in-progress
Use the installer or extract all files from the .zip file to a folder
Double-click FFRK-LabMem.exe it and it will run in the window. At any time as it is running you can press D to disable, E to enable, Ctrl+X to exit, and H to minimize to system tray.
Press C to open configuration options
For this to work correctly, the following must be set up:
- Network proxy settings
- ADB connection
- Install trusted CA certificate
- Screen top and bottom offsets
- Team 1 must be able to beat anything, even at 10 fatigue
This varies by device and every network is different. Typically with android devices you would go into the wifi settings, change proxy to manual then enter the IP address of the windows system running the app for the hostname, 8081 for the proxy port, and the following for the proxy bypass:
127.0.0.1,lcd-prod.appspot.com,live.chartboost.com,android.clients.google.com,googleapis.com,ssl.sp.mbga-platform.jp,ssl.sp.mbga.jp,app.adjust.io
Tip: you can press
Ctrl+Bto copy the proxy bypass to the clipboard or use the button in the GUI configuration
Tip: for most android emulators if you can view the device ip address for example
10.0.x.xyou can simply use10.0.x.2for the loopback to the host system.
If you are going to use a physical device or an emulator on another system, please make sure to open port 8081 in the firewall to allow incoming connections. On Windows, it usually prompts you on first run to create the proper firewall rule.
This allows the application to interact with the android device. First you'll need to enable developer options in the device settings and enable USB debugging. There are many tutorials online that cover this.
If you are connecting an acutal device via USB, you may need the proper drivers. See here -OR- here
Connecting to an emulator works over TCP. You can set up TCP with a physical device as well but this is beyond scope. Android emulators seem to use different TCP port numbers, you'll have to look this up. The default host and port number configured in FFRK-LabMem.exe.config is 127.0.0.1:7555 which is for running MuMu app player on the local machine.
Known Emulator host/ports
| Emulator | Host/Port | Other Possible Ports? |
|---|---|---|
| MuMu | 127.0.0.1:7555 | |
| Nox (5) | 127.0.0.1:62001 | 62025,62026,62027 |
| MeMu | 127.0.0.1:21503 | 21513, 21523 (based on instance id) |
| LDPlayer | 127.0.0.1:5555 | See here |
If the proxy root CA certificate isn't installed the bot will copy it to the device and switch to the settings screen and offer guidance on installing it. The root CA certificate is auto-generated on startup in a file called rootCert.pfx with a 10-year lifetime (so you only have to install it once). Addtionally, the .pfx file contains the private key corresponding to the root CA public key contained in the certificate that is installed on the device.
This certificate is only used to decrypt traffic to URLs used by FFRK to run, all other traffic is tunneled through the proxy with no inspection.
(Note: This section is optional. Any font that supports Japanese output, such as MS Mincho which was previously recommended, will work, but I now recommend MS Gothic because it's easier to set up and frankly looks better.)
The bot now supports Japanese text; however, the default font will not display it correctly. If you want to see Japanese characters, you will need to use a font that supports Japanese characters; my recommendation is MS Gothic. You can do this by clicking the treasure chest icon in the top-left corner of the window (next to the bot's name), clicking Properties, and going to the Font tab. Once there, select MS Mincho from the list and click OK. (If you get an error saying the shortcut cannot be modified, close LabMem, then right-click the shortcut and select Run as Administrator, then change the font and it will remember it for future launches.) Alternatively, you can simply change the default font (Defaults on the same menu where you select Fonts), although this will change every other console-based application to that font.
If MS Gothic does not appear, you'll need to install it. On Windows 10/11, click Start, then Settings, then Personalization, then Fonts. Here, on the right side of the screen, click Download Fonts for All Languages and it will be installed. Once installed (this may take a minute or two), MS Gothic will show up in the font list.
From version 0.9.10 and higher, screen offsets can be automatically detected using Alt+O when on FFRK title screen.
All of these settings can be accessed by pressing C
Show Options
| Property | Description | Default |
|---|---|---|
| console.timestamps | Show timestamps in console | true |
| console.debug | Show general program debugging information | false |
| adb.path | Path to ADB executeable, it's included | adb.exe |
| adb.host | TCP host to connect to ADB, if using, ignored if connected via USB | 127.0.0.1:7555 |
| proxy.port | TCP port to listen for proxy requests | 8081 |
| proxy.secure | Enable https proxy (FFRK 8.0.0) | true |
| proxy.blocklist | Path to a file which domains should be blocked. One domain name per line | |
| proxy.autoconfig | Configure android device system proxy via Adb | false |
| proxy.connectionPooling | Experimental feature | false |
| lab.configFile | Lab config file path, see below | Config/lab.balanced.json |
| lab.watchdogHangMinutes | Number of minutes to check for a hang, 0 to disable | 3 |
| lab.watchdogCrashSeconds | Number of seconds to check for a crash, 0 to disable | 30 |
| screen.topOffset | Number of pixels of the gray bar at the top of FFRK, 0 for none, -1 to prompt auto-detect | -1 |
| screen.bottomOffset | Number of pixels of the gray bar at the bottom of FFRK, 0 for none, -1 to prompt auto-detect | -1 |
| updates.checkForUpdates | Checks the releases page for new versions | true |
| updates.includePrerelease | Includes pre-release (testing) versions when checking for new releases | false |
| datalogger.enabled | When enabled, logs various data to files in the DataLog directory | false |
| counters.dropCategories | Bit flags for filtering drops | 15 |
| counters.logDropsToTotal | Set to true to count drops in all-time (may grow large) | false |
Four different lab config files are provided: Balanced (default), Farm, Full, and Quick
Configuring the lab walker behavior and all the various options is documented here
Not enabled by default, set Enable data logging in general program options. This will create the DataLog folder with the various csv files. Data file formats can be found here
Press S to show the statistic counters
If you previously installed using the installer .exe, Press Alt+U and confirm the download. The installer should download (to app directory) and automatically run.
If you upgrade a manual install (extract .zip) the automatic upgrade will install the new version in your My Documents folder.
Verson codes are in the format (major.minor.patch)
For a minor or patch release copy the main executeable to your install folder (and .pdb file if you want accurate error stack traces).
For a major release copy all files. You can optionally keep your configuration files (any missing settings will use defaults and any unused settings will be ignored)
Please keep your rootCert.pfx file, or you will have to re-install the certificate on the android device
Check https://github.com/HughJeffner/FFRK-LabMem/wiki/Common-Issues-FAQ
Many, many thanks to HughJeffner for creating this amazing tool. Also, special thanks to mendicant for his modifications to the original project which served as the basis for this version of the bot.