uetools 0.2.1

Tools for Unreal Engine

uetools implements a set of tools to make it easier to work with Unreal Engine projects and automate common tasks.

Get Started

pip install uetools

# Saves common paths
uecli init --engine C:/opt/UnrealEngine/Engine --projects C:/opt/Projects
uecli engine-add --version src --engine C:/opt/UnrealEngine/Engine
uecli engine-add --version 5.1 --engine C:/EpicGames/UE_5.1/Engine
uecli engine-add --version 5.0 --engine C:/EpicGames/UE_5.0/Engine

# Install the plugin VoxelPlugin to the RTSGame project
uecli install RTSGame https://github.com/Phyronnaz/VoxelPlugin

# Rebuild the RTSGame project
uecli build RTSGame

# Open the project (located in C:/opt/Projects/RTSGame)
uecli open RTSGame
uecli --engine-version 5.1 open RTSGame
uecli --engine-version 5.0 open RTSGame

# Cook the project
uecli cook RTSGame

# Start a server
uecli server RTSGame --dedicated --port 8123

# start a client
uecli client RTSGame --address 127.0.0.1 --port  8123

# Turn a blueprint Project into a C++ project
uecli cpp RTSGame

Make your own command

You can extend uetoosl for your organization by creating plugins. A template is provided to help you get started.

Help Example

$ uecli ml --help
usage:

description:
   Launch a game setup for machine learning

positional arguments:
   str                       Name of the the project to open
   str                       Name of the map to open

optional arguments:
   -h, --help                show this help message and exit
   --dry                     Print the command it will execute without running it (default: False)

Arguments ['ml']:
   Launch a game setup for machine learning

      Attributes
      ----------
      project: str
         Name of the the target to build (UnrealPak, RTSGame, RTSGameEditor, etc...)

      Examples
      --------

      .. code-block:: console

         uecli ml RTSGame

         # Launch your agent script that will connect and make the agents play the game

   --resx int                resolution width (default: 320)
   --resy int                resolution height (default: 240)
   --fps int                 Max FPS (default: 20)
   --windowed bool           Window mode (default: True)
   --usefixedtimestep bool   Block until the ML agent replies with an action (default: True)
   --game bool               (default: True)
   --unattended bool         Close when the game finishes (default: True)
   --onethread bool          Run on a single thread (default: False)
   --reducethreadusage bool  (default: False)
   --nosound bool            Disable sound (default: False)
   --nullrhi bool            Disable rendering (default: False)
   --deterministic bool      Set seeds ? (default: False)
   --debug bool              (default: False)
   --mladapterport int       RPC server listen port (default: 8123)

Features

• Windows & Linux

• Open projects

• Build

• Run automated tests

• Cook

• Generate localization files for internationalization

• Run the editor

• multi version support

It also implements common recipes such as

• Install project plugins from a repository

• Disable plugins

• Add dedicated server targets

• Automatically configure project settings for Python

• Works on both Linux & Windows seamlessly

• Add Doxygen to your project

Rational

Unreal engine has 222 comandlets, 83 commands and more than 1237 command line parameters hidden inside its code, very few are documented.

uetools identifies the useful arguments and bundle them inside a command line utility, forming groups/set of arguments with a singular purpose.