Skip to content

Instantly share code, notes, and snippets.

@ngld ngld/FAQ.md
Last active Jan 16, 2020

Embed
What would you like to do?
FFXIV ACT FAQ

FFXIV ACT FAQ

Current stuff

The following information is accurate as of 2020-01-06 / patch 5.18:

  • Is ACT broken right now?
    No. Make sure you have the latest FFXIV plugin by going to the About tab and clicking Check Version Now. It will most likely update your FFXIV plugin after which you'll have to restart ACT.

    If it doesn't update automatically, go to your Plugins tab and select the FFXIV_ACT_Plugin.dll, and check the FileVersion: on the right side. If it doesn't say 2.0.4.13, you have an outdated version. Try manually updating by downloading the plugin from Ravahn's repo.

TOC

Troubleshooting stuff

My ACT isn't showing any numbers. What can I do?

Go to Plugins > FFXIV Settings and click Test game connection.

  • It complains about the firewall. What should I do?
    Make sure you have a firewall exception for ACT. Also make sure that the .exe file (visible under Details) and network type are correct.

    If you're sure the firewall exception is correct, disable the firewall. If that fixes your problem, your exception is not correct. If that doesn't fix your problem, come to the Discord and mention that your parser doesn't work even when your firewall is disabled.

  • It complains about memory signatures/addresses. What should I do?
    This usually means your parser doesn't work with your game version. Check the plugin page for updates. If you already have the latest version, you'll probably see a notice at the top of this FAQ that an update is being worked on.

    If you got this error with the latest parser and the game hasn't been updated in the last several days, go to the Discord and ask for help.

  • It complains that it can't find the game process.
    Make sure you're running the correct ACT .exe. Advanced Combat Tracker.exe for the game in DirectX 11 mode (the default) and ACTx86.exe for the game in DirectX 9 mode.

  • It complains that no recent network traffic has been received.
    Check if your firewall is interfering with the parser or if your VPN is causing problems.

    If you use a VPN, try disabling the "High performance network parser". Disabling it means ACT will cause more CPU load but it might fix your problem.

My overlay isn't updating / not showing

First, you'll have to know which plugin version you have. If you have 0.3.4.0 or older, you're using the hibiyasleep version. Make sure you update to 0.3.4.0 if you're having issues with an earlier version.
Newer versions indicate that you use the ngld OverlayPlugin (which should work as well).

Make sure that ACT is showing DPS info on the Main tab. If that doesn't work, you'll have to fix ACT / the parser first. See the above section for more information about that.

Next, check the overlay log if it contains any of the following messages. The overlay log is the area below your overlay settings.

  • System.NullReferenceException - Object reference not set to an instance of an object.
    If this appears in the log or as a message box, you most likely downloaded the wrong version. Go to the download page and read the notice about x86 vs x64 and make sure you downloaded the correct version.

  • Could not load type 'RainbowMage.OverlayPlugin.EventSourseBase' from assembly 'OverlayPlugin.Core, ...'
    You tried to use an addon or plugin which requires the ngld OverlayPlugin with the hibiyasleep version.

    You either have to look for a different download / build of the addon/plugin you're trying to use or switch to the ngld OverlayPlugin.

  • System.TypeLoadException - Could not load type 'System.ValueTuple``3' from assembly 'System.ValueTuple, ...
    Update your .NET framework to 4.7.1 or newer.

Finally, here are some typical issues which can lead to an overlay showing up but not updating:

  • Most DPS overlays (Kagerou, MopiMopi, RainbowMage, rdmty, ...) have to be added using the MiniParse type.
    You can see the type you're currently using in the overlay list on the left.
  • If you're using ngld's OverlayPlugin, load it directly after the FFXIV_ACT_Plugin.dll or as the very first plugin to make sure no other plugin conflicts with it.
  • If you're trying to use MopiMopi or SkillDisplay with the ngld version, make sure you check the ACTWS checkbox.
    If you're using any other overlay, uncheck that box since it can break overlays which don't support ACTWS (like Cactbot).
  • If you're using Cactbot, make sure you select the correct type (Cactbot for hibiyasleep and MiniParse for ngld).
  • Certain overlays like MopiMopi don't work with the hibiyasleep version.

My overlay only shows if I'm out of the game / alt-tabbed

Set your game to run in Borderless mode. Fullscreen means the game has exclusive control of your screen and other programs can't draw over it.

Discord, Steam, etc. get around this by hooking into the game. We're trying to avoid this which is why we use windows to draw over the game.

  • But it worked before ?!
    Yeah, that was Windows doing some black magic. Essentially, it forced the game into a mode similar to Borderless. For some reason, this has been disabled in a recent Windows update.

My overlay shows over the game but stops updating

This is usually an issue with AMD's graphics driver. Make sure you disable AMD Chill or come to the Discord and ask for help there.

My overlay doesn't sort by DPS

If you're using the ngld OverlayPlugin, you have to enable sorting. Go to Plugins > MiniParseEventSource and set Sort By to DPS.

ngld OverlayPlugin failed because it couldn't download something

Go to the OverlayPlugin tab. It'll tell you more about the file it tried to download. You'll be able to retry the download or manually download the required file there.

OverlayPlugin complains that Newtonsoft.Json is outdated

Go to your ACT folder (that's where your Advanced Combat Tracker.exe is) and delete Newtonsoft.Json.dll. That file isn't part of ACT and most likely ended up there as part of a plugin. Please install plugins in %AppData%\Advanced Combat Tracker\Plugins or sub folders to avoid issues like this.

If OverlayPlugin still complains about Newtonsoft.Json even after you deleted that file, make sure that it's loaded before ACTWebSocket and Discord Triggers and any other plugin that might contain an old version of Newtonsoft.Json. If you need help locating the currently loaded version of Newtonsoft.Json, go to ACT's Plugins tab and click View Loaded Assemblies on the right side. It'll list all currently loaded assemblies and should show you the path to the currently loaded Newtonsoft.Json.dll.

Join the Discord if you need further assistance.

OverlayPlugin complains that SharpCompress is outdated

Disable ACTWebSocket or load OverlayPlugin before ACTWebSocket. If that doesn't help, check if you have a SharpCompress.dll file in your ACT folder (the folder that contains Advanced Combat Tracker.exe) and delete it. Check the above section for further info since it's the same problem just a different file.

Cactbot's config tab is empty

Check if your overlay log (the text box below your overlay settings) contains an error complaining about an outdated version of Newtonsoft.Json. If it does, follow the instructions above. If it doesn't, make sure you updated all of Cactbot's files (and not just the DLL or ui folder). If that doesn't help either, join the Discord.

General questions

How do I check my plugin versions?

Go to the Plugins tab, click on the plugin you want to check and look on the right side for FileVersion:. Next to that label, it will tell you the plugin version.

Where are the log files saved?

Go to Plugins > FFXIV Settings and look for the Log file location.

What is the difference between the ngld OverlayPlugin and hibiyasleep OverlayPlugin?

  • hibiyasleep's OverlayPlugin hasn't been updated in 2 years and thus uses an older version of Chromium to render the overlays. That probably doesn't matter to you as a user but it means that overlays which work with the hibiyasleep version can't use more recent features like modern ES JavaScript syntax, new CSS features, etc.
  • ngld's OverlayPlugin uses a single download for both x64 and x86 downloads to make installation easier.
  • ngld's OverlayPlugin integrates most of ACTWebSocket's features making the latter redundant.
  • ngld's OverlayPlugin added cutscene detection which automatically hides overlays during them. This feature can be turned off in the plugin configuration if you don't want that.
  • ngld's OverlayPlugin allows you to assign the same hotkey to several overlays and doesn't require a restart for hotkeys to become active.
  • ngld's OverlayPlugin offers more data for overlays.
  • For details check the release notes since they contain the changes for each release.

Where can I find any documentation on the log file?

Cactbot's log guide is the best we currently have. We don't have any real documentation on the parser itself but feel free to ask on Discord if you have any specific questions.

Glossary

  • ACT, Advanced Combat Tracker
    This program offers the core functionality by calculating DPS, HPS, etc. based on a log file.

  • ACTWS, ACTWebSocket
    This plugin runs a web server which accepts WebSocket connections which allows other applications to use ACT's data. Not maintained anymore. Most of the functionality has been integrated into ngld's OverlayPlugin.

  • Cactbot
    A collection of various overlays. Raidboss can show you timelines for boss fights and dungeons, the eureka overlay can show you points of interest for eureka, oopsyraidsy can show you certain mistakes and why people die.

  • FFXIV ACT plugin
    This plugin contains the FFXIV parser for ACT (there are other plugins which allow ACT to parse the data for other games). It captures the network packets sent/received by the game and additional data from memory and writes that information to a log file. ACT then reads that file and parses it with help from the plugin.

  • FFLogs
    A website that allows you to upload the raw network logs and aggregates them.

  • Hojoring, Special Spell Timers, Yukkuri, UltraScouter
    Hojoring is a collection of the following three plugins:

    • SpecialSpellTimer
      Oversee skill cooldowns, trigger notifications for enemy actions, timeline for raids, etc.
    • Yukkuri
      Replaces ACT's Text to Speech engine. Can interface with most TTS engines currently available.
    • UltraScouter
      Extended HUD. Can display enemy HP values, remaining cast time, distance and direction of hunt marks, threat visualization, etc
  • OverlayPlugin (hibiyasleep, ngld)
    This plugin is used for most overlays. It effectively runs a Chromium browser in the background to render web pages on top of the game. Various information like the current DPS values are forwarded by the plugin to the web page to display.

    For details on the difference between the two version, see above.

  • Parser
    See FFXIV ACT plugin above.

  • Triggers
    A trigger allows you to define a certain action (showing an overlay, playing a sound, starting/stopping an OBS recording, ...) that should happen whenever a certain thing happens in the game. Very powerful but requires a solid understanding of regular expressions and log lines.

  • Triggernometry
    More or less replaces ACT's Custom Triggers feature with a much more capable version. For example, variables and conditions are supported, as well as visual warnings and callouts (auras).

    The plugin is a toolbox for building your own things for whatever calls and situations you like, and as such it does not contain any triggers out of the box. You can, however, find people sharing their creations through the plugin's remote repos feature or on Triggernometry's Discord server where you will also be able to find assistance in building your own things.

Disclaimer: A few of the above plugin descriptions have been taken from the FFXIV Discord's #plugin-showcase.

Overlays

Triggernometry, SpecialSpellTimers and UltraScouter can also display additional information on top of the game.

TODO: Add updated screenshots for all of these. Would probably more useful than the text descriptions.

However, pure DPS data / DPS tables are usually displayed by one of these:

  • Kagerou, README link
    A very popular overlay displaying DPS, damage taken and HPS. Has a lot of options to customize the displayed data and overall look and feel. Works with all overlay renderers.

  • MopiMopi, README link
    Also fairly popular. Displays DPS and HPS. Doesn't group the data into tabs and instead displays both tables next to each other. Requires ngld's OverlayPlugin or ACTWebSocket.

  • a modified version of RainbowMage
    RainbowMage created OverlayPlugin and the first overlay that worked with it. Since then multiple modified versions have been created. This repo contains a pretty broad selection and additional overlays.

    Works with both hibiyasleep and ngld OverlayPlugin.

  • Ember, README link
    This overlay tries to follow FFXIV's overall UI design and offers a bunch of data.
    Works with all overlay renderers.

  • Horizoverlay, README link
    A simple horizontal damage meter overlay. It currently shows player dps, damage %, hps, encounter duration and total dps. Works with OverlayPlugin 0.3.3.13 or newer (both hibiysleep and ngld).

  • Ikegami, README link
    A simple horizontal miniparse overlay. Works with all overlay renderers.

@Zeffuro

This comment has been minimized.

Copy link

Zeffuro commented Nov 21, 2019

The plugin is more of a toolbox for building your own things for whatever calls and situations you like, and as such it does not contain any triggers out of the box.

Triggernometry has had remote repos for quite some time now so it comes with a bunch of stuff out of the box (https://i.imgur.com/ZrnXxMz.png)

My stuff in there is basically all visual (the repo name is outdated, has more then it looks like)

@ngld

This comment has been minimized.

Copy link
Owner Author

ngld commented Nov 22, 2019

I just copy&pasted Locrian Mode's description. :P
I'll mention the remote repos but I think the part that it offers no triggers out of the box is still true since just enabling Triggernometry doesn't give you any new features (as opposed to i.e. Cactbot). You still have to add / import the triggers before it does anything.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.