Datasets:
AdamCodd
/
unreal-engine-5-raw

Dataset card Data Studio Files Community
1
text
stringlengths
0
17.2k
Commands for UnrealAndroidFileTool consist of a set of parameters telling the tool what to establish a connection with, followed by a command to send to the file server. For example, the following would run the shell command on a device with a specific serial number and look at the files for a specific project:
Paths in AFS use the normal conventions for command line paths, but they also support several shortcuts for navigating the file hierarchy:
The following are some common shortcuts using ^[key]. You do not have to use these, but they are convenient.
The following parameters can be placed before a file server command to configure your connection for specific target devices and projects.
The following table is a reference for the commands you can use to get information about available devices and recognized packages, or to stop remote servers.
Any command that interacts with a file server, such as push, pull, or shell, implicitly requests for it to start, so there are no commands for starting a server.
You can use the following commands to enter and exit Interactive Mode. Interactive Mode functions similarly to ADB, opening a connection with the device and giving you a way to send multiple commands without having to run UnrealAndroidFileTool.exe for each command. UnrealAndroidFileTool will remain in Interactive Mode until you exit.
The following commands fetch information about directories and files on your device, or provide navigation for your base directory during interactive mode.
Shows the contents of the directory at the provided path. The listed specifiers designate what information to output:
-l: List permissions. -s: List size. -R: List recursive directory tree. -f: List flat.
The following commands interact with or modify files on your device.
Configuration and Setup
Manually Starting and Stopping AFS With Blueprints
UnrealAndroidFileTool
Packaging Settings
Deployment Settings (Logging and Compression)
Connection Settings
Command Reference
Use AndroidFileServer
If enabled, your project will include the embedded file server for packaged and Quick Launch builds. If disabled, AFS will not be used in your project, and Unreal Engine falls back to using ADB.
Allow Network Connection
If enabled, AFS allows WiFi connections and connections through USB. Refer to Connection Settings for more details.
Security Token
A unique string you can use to secure AFS and prevent it from being started remotely by anyone without the token. Refer to Using Security Tokens for more details.
Include in Shipping
If enabled, AFS will be included in Shipping builds. Refer to Using AFS in Shipping Builds for more details.
Allow External Start in Shipping
Paired with Include in Shipping, this allows external requests to start the file server with UnrealAndroidFileTool or for Quick Launch.
Compile AFSProject
If enabled, Unreal Engine will compile AFS as a separate APK when it packages your project. Refer to Compiling AFSProject for more information.
Use Compression (Beta)
Applies compression to data files on your file server. In UE 5.0, currently this has minimal impact on transfer time.
Log Files
Shows a list of files being pushed to the device.
Report Stats
Shows a listing of how many files are pushed to the device and the number of bytes pushed over your connection.
1>
File was sent over USB.
2>
File was sent over Wifi.
Connection Type
Determines whether to use USB, WiFi, or both to connect with your file server.
Use Manual IP Address
If enabled, the Quick Launch will use the Android device at the IP provided in the Manual IP Address field. Otherwise, it will try to discover the IP address over USB if connected.
Manual IP Address
The IP address of an Android device you want to connect to for Quick Launch. The device must be connected to your local WiFi network.
USB
Pushes files over a USB connection to your Android device.
WiFi Network
Pushes files over a WiFi connection to an Android device on the same local area WiFi network as your computer. This requires the Allow Network Connection setting to be enabled.