How to report a bug - FAForever/fa GitHub Wiki

Traces of the bug

In this section we try to retrieve the error message that is usually accompanied by a bug. You can open the logs during a game by pressing f9. You can also find the logs after the game has finished through the client.

image

Navigate into the logs folder. Usually we're interested in logs of the game. An example is game_16964063.log. We're interesting in the warning or the error keywords. An example of an error:

warning: Error running lua script: ...ogramdata\faforever\gamedata\lua.nx2\lua\aibrain.lua(577): bad argument #1 to `getn' (table expected, got no value)
         stack traceback:
         	[C]: in function `getn'
         	...ogramdata\faforever\gamedata\lua.nx2\lua\aibrain.lua(577): in function <...ogramdata\faforever\gamedata\lua.nx2\lua\aibrain.lua:563>
         	...ogramdata\faforever\gamedata\lua.nx2\lua\aibrain.lua(604): in function `TransferUnitsToHighestBrain'
         	...ogramdata\faforever\gamedata\lua.nx2\lua\aibrain.lua(686): in function <...ogramdata\faforever\gamedata\lua.nx2\lua\aibrain.lua:525>

Once you have found a warning that appears related to your issue then we can continue to the next section.

Sandboxing the bug

In this section you try to isolate the bug. By isolating you create an environment where you can reproduce the bug on demand. You can do this by:

  • Hosting a lobby that has cheats enabled
  • Using the cheat window (alt + f2) to create units
  • Use the units in question to reproduce the bug

If you manage to reproduce the issue then we can continue to the next section.

Origin of the bug

In this section you try to confirm the origin of the bug. A mod or a map can make the game more prone to errors. Disable all mods, including UI mods and try to reproduce the bug again using your sandbox setup or by playing the game as usual. If you can still reproduce or encounter the bug then we can continue to the next section. If you do not manage to reproduce it anymore then it is likely related to one of your (UI) mods. It is best to contact the author of the mod.

Reporting the bug

In this section you try to inform the developers team about the bug.

  • A description of the bug
  • A description of the intended behavior
  • A screenshot of the bug, if applicable
  • Logs of the bug
  • A replay where the bug occurred
  • A sandbox setup to reproduce the bug
  • Anything else that you deem relevant

You can report the bug at the following places:

We prefer if you report the bug on Github.

Editors note: do not change the title of this wiki page. It changes the URL. The URL is baked into the game.