Skip to content
hessiser edited this page May 7, 2026 · 71 revisions

Warning

The risk of receiving an infraction for using this and similar software is considered extremely low given server-client validation is easier to verify compared to an open-world game. However, there have been no documented reports of infractions using such softwares. While the application is implemented as a DLL that is loaded into the game process. Its function is limited to reading data.
That said, this software does not comply with the game’s Terms of Service. By using it on official servers, you acknowledge and accept any associated risks. We cannot guarantee immunity from enforcement action by the publisher.

Overview veritas GitHub Releases

Loading the Overlay

The overlay requires the DLL to be loaded into the game process.
After following the instructions in #loading, you will see an in-game notification confirming that the DLL has been successfully loaded and the server component has started.

Opening the Overlay

Press Ctrl + M to access the overlay.
A complete list of keybindings is available in #shortcuts.

Clients

Once the DLL is loaded, clients can be used for more detailed analysis.
See #clients for more information.

Troubleshooting

If you encounter any issues, crashes, or have questions, please review #troubleshooting before seeking additional support.

Loading

Caution

Never load DLLs from unknown sources.

Note

If experiencing [Error] Client is damaged, please reinstall the client. window, download this DLL and place in the game directory where StarRail.exe is as well.

Tip

Unsure what version to download? Refer to #versioning and #compatibility-check

Locating game folder

HoyoPlay

image

  1. Hover over the hamburger menu icon next to Start Game, then click Game Settings.
  2. In the popup, under the Game Directory section, you will see the exact game installation directory.

Desktop / Startup Shortcut

  1. Right-click the Honkai: Star Rail shortcut (on your desktop or in the search/start menu), then select Open file location.
  2. From there, navigate to games/Star Rail Games.

Method 1

1. Install the Loader

  1. Navigate to the releases page and download the DLL.

  2. Locate your game installation directory — this is the folder containing StarRail.exe.

  3. Extract the downloaded files directly into the same directory where StarRail.exe is located.


2. Install the Plugin

  1. Inside the same directory as StarRail.exe, create a new folder named plugins.

  2. Navigate to the plugin releases page and download the DLL.

  3. Place the downloaded .dll file inside the plugins folder you created.

Your directory structure should look similar to:

StarRail.exe
<other game files>
umpdc.dll
plugins/
    veritas.dll

Method 2

  • Download veritas.dll from Releases and rename it either to xluau.dll or astrolabe.dll and place in the game directory where StarRail.exe is. The DLL will be loaded when the game is launched.

Method 3

  • Do not put anything in the game folder; it will not work. Download veritas.dll from Releases. Download veritas-app.zip. Unzip the archive, and inside the folder, move veritas.dll there. In config.json, make sure the path value of the key game_path matches your game's path. Launch the executable, and the game will launch.

Shortcuts

  • Ctrl + M to toggle menu
  • Ctrl + H to hide the UI
  • Ctrl + + to zoom in
  • Ctrl + - to zoom out
  • Ctrl + 0 to reset zoom

Clients

image

  1. Click Connection Setting in the top headerbar.
  2. Click the Connect button, and it should display Status: Connected.

Versioning

Game versions follow the format MAJOR.MINOR.REVISION (e.g. 3.4.50).

  • REVISION = 0 → Production client
  • REVISION ≥ 50 → Beta client builds

Beta and production clients may share the same MAJOR.MINOR version but differ in REVISION.


Compatibility Check

When you launch the game, check the version string in the bottom-left corner (e.g. OSPRODWin4.2.0_...; Game: 4.2.0).

Compare the Game version with the supported version range listed in the plugin release notes.

  • If your version is within the supported range, the plugin should work.
  • If it is outside the supported range, you are using the wrong plugin version.

Troubleshooting

  • The in-game overlay is not showing.

    Disable any other apps that uses an overlay with the game (e.g. Discord) and restart the game.

  • The in-game overlay is not being recorded by Open Broadcaster Software Studio (OBS Studio).

    1. Run OBS with administrator privileges.

    2. image
      • If creating a new capture:
        In the Sources dock window, click the Add Source button and click the Game Capture menu button.
        In the Create/Select Source popup modal window, click the Ok button to go to the Properties for 'Game Capture' window.
        Configure the Mode dropdown box to your preference.

      • If modifying an existing capture:
        In the Sources dock window, click the Open Source Properties button to open the Properties for 'Game Capture' window.

    3. image

      In the Properties for 'Game Capture' window, scroll down and enable the Capture third-party overlays (such as steam) checkbox and click the Ok button to save the properties.

  • The game is not processing keyboard/mouse inputs.

    If your mouse is hovering over the overlay, it will consume all mouse inputs. If the overlay is taking keyboard inputs, it will consume all keyboard inputs as well. Either move your mouse away or click around the overlay, or use the hide UI shortcut.

  • How do I reset my graphs?

    Double-click the graph to reset. Alternatively, can delete persistence in appdata/local/veritas/data and restart.

  • Firefly Analytics is not connecting to the server.

    Try a different internet browser.

  • Can I use this on the official servers?

    You did not read/understand the #disclaimer. Please read again slowly and carefully.

  • The in-game notification says veritas has been disabled.

    That means the DLL has become incompatible with the latest game version. Let us know, if we haven't been alerted already.

  • The game just crashed.

    Do not restart the game, and attach veritas.log.debug either in the Discord or in Issues. Please use the existing issues template WITH a title. This helps provide keywords to be searched for. If you already restarted the game, try to replicate the crash and immediately attach the debug log.

  • Flagged as a virus.

    You can verify the authenticity of a release by checking the release metadata, ensuring that the login used was github-actions[bot]. That confirms the build was created from the public repository and has not been tampered with. The plugin uses techniques that are often used maliciously, which may cause it to be flagged as a virus. For your safety, only download releases from this repository or from Nushen's fork. Avoid downloading from unknown sources.

  • I don't understand. How do I-?

    We live in the 21st century and hopefully not in a region of the world where you're restricted from accessing LLMs like ChatGPT and DeepSeek. If you somehow did not resolve your issue by inputting this entire page to it or using a search engine like Google Chrome for a lower energy cost, then we'll be happy to help so long as you attempted to 😊.