Application
Table of Contents
Interfaces
- HubLocatorInterface
- Creates Unity Hub processes for a concrete platform or discovery strategy.
Classes
- ExecutableBase
- Base strategy for Farah executables that return XML result documents.
- HelpExecutable
- Exposes Unity Hub help output as a Farah executable asset.
- InstallExecutable
- Creates a temporary Unity project with a local package installed.
- InstallParameters
- Defines Farah URL parameters for package installation requests.
- PackageExecutableBase
- Base strategy for Farah executables that operate on Unity packages.
- BuildExecutable
- Runs a Unity player build for a project asset request.
- BuildParameters
- Defines Farah URL parameters for project build requests.
- MethodExecutable
- Executes a Unity editor method for a project asset request.
- MethodParameters
- Defines Farah URL parameters for editor method requests.
- ModuleExecutable
- Installs Unity editor modules for a project asset request.
- ModuleParameters
- Defines Farah URL parameters for editor module installation requests.
- ProjectExecutableBase
- Base strategy for Farah executables that operate on Unity projects.
- SettingExecutable
- Reads a Unity project setting into an XML document.
- SettingParameters
- Defines Farah URL parameters for project setting lookup requests.
- TestsExecutable
- Runs Unity Test Runner modes for a project asset request.
- TestsParameters
- Defines Farah URL parameters for Unity Test Runner requests.
- VersionExecutable
- Reads or writes a Unity project's bundle version.
- VersionParameters
- Defines Farah URL parameters for project version requests.
- TestResult
- Builds process result XML for executable asset runs.
- Settings
- Creates DocFX configuration, templates, and table-of-contents files for Unity projects.
- FormatLog
- Converts dotnet format JSON reports into XML documents.
- ExecutionError
- Represents a Unity automation failure with process output that can be exported as JUnit-style XML.
- GitProject
- Wraps git command execution for historical automation workflows.
- JsonUtils
- Loads and saves JSON files used by Unity project and package metadata.
- JUnit
- Formats dates for JUnit-compatible XML reports.
- LocateHubFromCommand
- Locates Unity Hub through a configured command line.
- LocateHubFromWindowsRegistry
- Locates Unity Hub from the Windows registry.
- LocateHubNull
- Null object hub locator used when Unity Hub cannot be discovered.
- MailboxAccess
- Reads verification codes from an IMAP mailbox for external service logins.
- MLContext
- Manages a legacy ML-Agents Python environment for Unity training runs.
- MLParameters
- Parses legacy ML-Agents training parameters and renders shell arguments.
- MLTraining
- Coordinates legacy ML-Agents training runs for Unity projects.
- AppBuild
- Builds Steam app build VDF files for SteamCMD uploads.
- SteamCMD
- Automates SteamCMD login, including optional Steam Guard code retrieval.
- UnityBuildTarget
- Maps logical build targets to Unity editor modules, output names, and batchmode arguments.
- UnityEditor
- Wraps one Unity Editor installation and executes batchmode commands.
- UnityEnvironment
- Reads Unity automation environment variables and formats process log output.
- UnityHub
- Process-wide facade for Unity Hub discovery, editor installation, and project/package lookup.
- UnityLicensor
- Signs Unity manual activation files through Unity's browser-based license flow.
- UnityPackage
- Represents a Unity package and creates temporary projects that install it locally.
- UnityPackageInfo
- Reads and writes Unity package metadata from package.json.
- UnityProject
- Represents a Unity project and exposes editor automation operations for it.
- UnityProjectInfo
- Reads and writes Unity project metadata from ProjectSettings and Packages files.