Manage Files and Folders in Unreal Engine 5
Utilize features such as folder existence checking, file filtering, permission checks, recursive file listing, file and folder creation and deletion, asynchronous file reading and execution, as well as opening folders in the file explorer.
Description
The FolderUtilityPlugin offers comprehensive file and folder management functions directly within Unreal Engine. It enables developers to seamlessly perform filesystem operations through Blueprint nodes, including reading, writing, deleting, and verifying files and directories.
- Existenzprüfung von Ordnern
- Spezifische Dateisuche
- Zugriffsrechte prüfen
- Erstellen & Löschen von Ordnern und Dateien
- Ordner im Explorer via Blueprint öffnen
- Ausführen von exe, sh und bat Dateien
Play Video about Folder Utility Plugin - Manage Folders, execute and read Files
Folder Utility Plugin: Showcase
The FolderUtilityPlugin is an Unreal Engine plugin that provides a range of useful functions for working with files and directories. It enables developers to perform filesystem operations directly from Blueprints, including reading, writing, deleting, and verifying files and folders.
Documentation & News
Erste Schritte
- Download the FolderUtility plugin and place it in the Plugins folder of your Unreal Engine project.
- Navigate to Edit > Plugins and activate Folder Utility.
- Restart the editor once to apply the changes.
- Download the FolderUtility plugin from the FAB Marketplace and import it into your Unreal Engine project.
- Navigate to Edit > Plugins and activate Folder Utility.
- Restart the editor once to apply the changes.
Available Functions
Check Folder Existence
- Category:
Folder Utility - Description: Checks whether a specific folder path exists.
- Inputs:
Folder Path(String): The folder path to check.
- Outputs (return):
Exists(Boolean): Indicates whether the folder exists.Valid Path(String): Returns the valid path if the folder exists.
Get Filtered Files
- Category:
Folder Utility - Description: Lists all files in a folder that have specific file extensions.
- Inputs:
Folder Path(String): The path to the folder.File Extensions(String Array): A list of file extensions (e.g.,.txt,.jpg).
- Outputs (return):
Filtered Files(String Array): A list of found files with the specified extensions.
Check Folder Permissions
- Category:
Folder Utility - Description: Checks the read and write permissions for a folder.
- Inputs:
Folder Path(String): The path to the folder.
- Outputs (return):
Can Read(Boolean): Indicates whether the folder can be read.Can Write(Boolean): Indicates whether the folder can be written to.Permission Message(String): A message regarding the permissions.
Get All Files Recursively
- Category:
Folder Utility - Description: Lists all files in a folder and its subfolders.
- Inputs:
Folder Path(String): The path to the folder.
- Outputs (return):
All Files(String Array): A list of all found files.
Create Folder
- Category:
Folder Utility - Description: Creates a new folder.
- Inputs:
Folder Path(String): The path where the folder should be created.
- Outputs (return):
Success(Boolean): Indicates whether the folder was successfully created.Message(String): A message in case of an error.
Delete Folder
- Category:
Folder Utility - Description: Deletes an existing folder.
- Inputs:
Folder Path(String): The path of the folder to be deleted.
- Outputs (return):
Success(Boolean): Indicates whether the folder was successfully deleted.Message(String): A message in case of an error.
Create File
- Category:
Folder Utility - Description: Creates a new file with content.
- Inputs:
File Path(String): The path of the file to be created.Content(String): The content to be written to the file.
- Outputs (return):
Success(Boolean): Indicates whether the file was successfully created.Message(String): A message in case of an error.
Delete File
- Category:
Folder Utility - Description: Deletes an existing file.
- Inputs:
File Path(String): The path of the file to be deleted.
- Outputs (return):
Success(Boolean): Indicates whether the file was successfully deleted.Message(String): A message in case of an error.
Open Folder in Explorer
- Category:
Folder Utility - Description: Opens a folder in the operating system’s file explorer.
- Inputs:
Folder Path(String): The path to the folder to open.
- Outputs (return):
Success(Boolean): Indicates whether the folder was successfully opened.Message(String): A message in case of an error.
Read File Content Async
- Category:
Folder Utility - Description: Asynchronously reads the content of a text file.
- Inputs:
File Path(String): The path to the file.
- Outputs (return):
Success(Boolean): Indicates whether the file was successfully read.Content(String): The read content.Message(String): A message in case of an error.
Execute File Async
- Category:
Folder Utility - Description: Asynchronously executes an executable file, such as exe, bat, and sh.
- Inputs:
File Path(String): The path to the executable file.Parameters(String): Optional parameters for execution.Show Window(Boolean): Indicates whether the application’s window should be displayed.
- Outputs (return):
Success(Boolean): Indicates whether the file was successfully executed.Message(String): A message in case of an error.
Examples
Check Folder Existence
- Drag the “Check Folder Existence” node into your Blueprint.
- Enter the path of the folder to be checked.
- Use the outputs
ExistsandValid Pathfor further logic.
Read File Content Async
- Drag the “Read File Content Async” node into your Blueprint.
- Connect the inputs and bind the
Completedevent. - In the
Completedevent, you can process the read content.
Notes
- Security Checks: The plugin includes protection mechanisms to prevent the deletion of system files or folders. However, it is your responsibility what you do with the plugin.
- Platform Support: The plugin theoretically supports Windows, MacOS, Linux, Android, and iOS. However, the Open File Explorer function likely only works on Mac, Windows, and Linux.
- Asynchronous Functions: Use asynchronous functions for time-consuming operations to improve your application’s performance.
Troubleshooting & Common Issues
Faulty Folder Paths: If a folder path does not work, check if the path is correct and try changing the syntax; for example, from C:\ to C:/. Avoid umlauts or special characters.
Roadmap
Current - v1.0
Customer Suggestions
Current - v1.0
Initial Release.
- Folder Existence Check: Easily verify if a folder exists.
- File Filtering: Retrieve files with specific extensions.
- Folder Permissions Check: Check read/write access to folders.
- Recursive File Listing: Get all files within a folder and its subfolders.
- File and Folder Creation and Deletion: Create or delete files and folders.
- Open Folder in Explorer: Open folders in the system’s file explorer.
- Read File Content Async: Asynchronously read the content of text files.
- Execute File Async: Asynchronously execute files like .bat, .sh, or .exe.
Customer Suggestions
No Entries.