/gbfr-logs

GBFR Logs lets you track damage statistics with a nice overlay DPS meter for Granblue Fantasy: Relink.

Primary LanguageRustMIT LicenseMIT

gbfr-logs

GitHub Release GitHub Downloads Discord GitHub License

Buy Me A Coffee

Overlay DPS parser/meter for Granblue Fantasy: Relink, based initially on the reverse engineering work from naoouo/GBFR-ACT.

How to install

  • Go to Releases
  • Download the latest .msi installer and run it.
  • Open GBFR Logs after the game is already running.

Screenshots

DPS Overlay

Meter

Skill Tracking

Meter

Historical Logs

Logs

DPS Charts

Charts

SBA Tracking

SBA Tracking

Equipment Tracking

Equipment Loadouts

Multi-language Support

Simplified Chinese

Frequently Asked Questions

Q: I closed the meter, but it's still running?

When you close the windows, GBFR Logs continues to run in your task tray in the bottom right of your desktop.

This task tray functionality is meant to give you more options for customizing:

  • This lets you close the logs window, but be able to reopen it again later.
  • You can toggle clickthrough of the overlay as well.

Q: The meter isn't updating or displaying anything.

Try running the program after the game has been launched. Be sure to run the program as admin.

Q: The application is not working / launching.

GBFR Logs uses your built-in Microsoft Edge Webview2 Runtime to run the application. This keeps the app relatively small as we don't have to package in a browser.

However, you may have an out-of-date or missing "Webview2 Runtime":

Q: Is this safe? My antivirus is marking the installation as a virus / malware.

As always, this is up to you to trust GBFR Logs. The program can trigger false positive flags. There are reasons why it can give such alerts:

  • GBFR Logs does code DLL injection into the running game process which can look like a virus-like program.
  • GBFR Logs reads game memory and modifies game code at runtime in order to receive parser data.
  • I recommend adding an exception / whitelisting for the installation folder so that your anti-virus does not delete it while your game is running, but you may not need to do so if you haven't ran into this issue.

See how to add an exclusion to Windows Defender.

Q: How do I update?

Launching the application will automatically check for new updates!

Same as with installing, you can download the latest release and run the installer again and it will update over your old installation.

Q: How do I uninstall?

You can uninstall GBFR Logs the normal way through the Control Panel or by running the uninstall script in the folder where you installed it to. You may also want to remove these folders.

  • %AppData%\gbfr-logs

Q: How do I add/edit my language?

Read src-tauri/lang/README.md for more information on how to add/edit language support!

Q: My issue isn't listed here, or I have a suggestion.

Feel free to create a new GitHub issue or join the Discord server.

For Developers

  • Install nightly Rust (rustup.rs) + Node.js.
  • Install NPM dependencies with npm install
  • npm run tauri dev

Under the hood

This project is split up into a few subprojects:

  • src-hook/ - Library that is injected into the game that broadcasts essential damage events.
  • src-tauri/ - The Tauri Rust backend that communicates with the hooked process and does parsing.
  • protocol/ - Defines the message protocol used by hook + back-end.
  • src/ - The JS front-end used by the Tauri web app

Supporting the Project

GBFR Logs will always be kept free and open-source (MIT). However, if you want to support me directly, you can buy me a coffee! 🙇

Credits

This project would not have been possible without the following folks:

  • nyaoouo/GBFR-ACT for the original reverse engineering work.
  • Harkain for their work on formatting and translating skills to friendly English names.

Disclaimer

Please keep in mind that this tool is meant to improve the experience that Cygames has provided us and is not meant to cause them or anyone other players damage. GBFR Logs modifies your running game client and is not guaranteed to work after game patches, in which case you may experience instability or crashes.