:py:mod:`pycasx.cli.utils.find_fgfs`
====================================

.. py:module:: pycasx.cli.utils.find_fgfs

.. autoapi-nested-parse::

   Find FlightGear and the corresponding root data directory.



Module Contents
---------------


Functions
~~~~~~~~~

.. autoapisummary::

   pycasx.cli.utils.find_fgfs.find_fgfs



.. py:function:: find_fgfs() -> pathlib.Path
                 find_fgfs(with_root: Literal[False]) -> pathlib.Path
                 find_fgfs(with_root: Literal[True]) -> tuple[pathlib.Path, pathlib.Path]

   Find the fully resolved path to the FlightGear executable.

   :param with_root: If true, return the root data directory as well.
   :type with_root: bool

   :returns:

             The fully resolved path to the FlightGear
                 executable and the root data directory if `with_root` is
                 true.
   :rtype: Path | tuple[Path, Path]

   :raises NotImplementedError: If the platform is not supported.