Skip to content

Commit

Permalink
docs: Update README with new FAQ info
Browse files Browse the repository at this point in the history
  • Loading branch information
false-spring committed Mar 21, 2024
1 parent cfe8883 commit aff50fa
Showing 1 changed file with 28 additions and 5 deletions.
33 changes: 28 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,13 +43,30 @@ Experimental overlay DPS meter for Granblue Fantasy: Relink, based on the revers

## 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":

- Install the latest one from Microsoft: https://developer.microsoft.com/en-us/microsoft-edge/webview2/?form=MA13LH#download (Evergreen Bootstrapper should work here)

> Q: Is this safe? My antivirus is marking the installation as a virus / malware.
You can ignore these as false positives.
You can ignore these as false positives. There are reasons why it can give alerts:

- GBFR Logs does code injection into the running game process which can look like a virus-like program.
- GBFR Logs reads game memory and initializes code hooks in order to receive damage data.
Expand All @@ -59,6 +76,8 @@ Windows Defender: https://support.microsoft.com/en-us/windows/add-an-exclusion-t

> Q: How do I update?
Launching the application will automatically check for new updates!

Same as with installing, you can download the [latest release](https://github.com/false-spring/gbfr-logs/releases) and run the installer again and it will update over your old installation.

> Q: How do I uninstall?
Expand All @@ -67,14 +86,14 @@ You can uninstall GBFR Logs the normal way through the Control Panel or by runni

- `%AppData%\gbfr-logs`

> Q: My issue isn't listed here, or I have a suggestion.
Feel free to create a [new GitHub issue](https://github.com/false-spring/gbfr-logs/issues) or [join the Discord server](https://discord.gg/GR4r9zrqJj).

> Q: How do I add/edit my language?
Read [src-tauri/lang/README.md](./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](https://github.com/false-spring/gbfr-logs/issues) or [join the Discord server](https://discord.gg/GR4r9zrqJj).

## For Developers

- Install nightly Rust ([rustup.rs](https://rustup.rs/)) + [Node.js](https://nodejs.org/en/download).
Expand All @@ -90,6 +109,10 @@ This project is split up into a few subprojects:
- `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!](https://www.buymeacoffee.com/false.spring) 🙇

## Credits

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

0 comments on commit aff50fa

Please sign in to comment.