Use file browser in Unity apps [Unity Quick Tutorials #6]

Summary

This tutorial demonstrates how to integrate a file browser into a Unity utility app for accessing system files and folders. By using a GitHub wrapper package, users can easily implement a file selection dialog with custom extensions. The video explains how to load files on the same thread or use a background thread for non-blocking behavior. Additionally, it covers displaying save file options and handling file operations using C# methods. While the plugin is cross-platform, users are advised to read the repository for platform-specific limitations.

Takeaways

• 😀 Use a GitHub wrapper package to easily access system files and folders in Unity.
• 😀 Download the package and import it into your Unity project for quick integration.
• 😀 Create a sample script or use an existing one to load files from the system.
• 😀 Use the 'SFB' directive (Unity Standalone File Browser) to filter file types in the file dialog.
• 😀 Define file extensions (e.g., .txt, .dat, .playerdata) to control the selectable files in the file explorer.
• 😀 Use the OpenFilePanel() method to trigger the file browser dialog and choose files.
• 😀 The OpenFilePanel() method requires arguments like the window title, directory, file extensions, and selection type (single/multiple).
• 😀 To prevent the app from freezing when the file browser opens, use threading to handle the file selection process asynchronously.
• 😀 Use 'System.Threading' to create a new thread and handle file selection without blocking the main app thread.
• 😀 Modify the file browser dialog to display a 'Save File' option instead of 'Open File' by changing method arguments.
• 😀 After obtaining the file path, use C#'s FileStream and File.Open methods to handle file operations.
• 😀 The plugin is cross-platform but may have some limitations, so it's essential to check the repository for platform-specific notes.

Q & A

What is the purpose of the Unity wrapper mentioned in the script?

The wrapper provides a simplified way to access system files and folders from a Unity application, handling file browsing and selection across different platforms.

How do you import the wrapper into a Unity project?

You download the package from GitHub, open your Unity project, and then import the package directly into your project's folders.

What does the SFB directive stand for and why is it used?

SFB stands for Unity Standalone File Browser. It is used to provide file browsing functionality within Unity, allowing the application to open system file explorer dialogs.

How are file types specified for selection in the file browser?

File types are defined using an extension filter set, where each filter includes a name for display and a list of file extensions like .txt, .dat, or .playerdata.

What method is used to open the file explorer window?

The OpenFilePanel() method is used. It requires arguments for the window name, current directory, file extension filters, and whether multiple files can be selected.

Why did the camera movement script stop working when the file browser opened?

The script was synchronous, meaning it blocked the main thread while the file browser was open, preventing other scripts from running simultaneously.

How can the synchronous behavior of scripts be fixed?

By using multithreading. You can create a new thread using System.Threading, run the file browser method on that thread, and then join it back to the main thread if necessary.

Can the file browser also be used to save files?

Yes, by changing the method name and some arguments, the file browser window can be configured to display a save file option instead of loading files.

What C# methods can be used to handle files after obtaining their paths?

Generic C# methods such as FileStream based on File.Open can be used to read from or write to files obtained from the file browser.

Is the Unity Standalone File Browser wrapper fully cross-platform?

It is intended to be cross-platform, but there are some limitations, so it's recommended to read the repository documentation for platform-specific details.

What argument determines whether multiple files can be selected in the file browser?

A boolean argument passed to the OpenFilePanel() method specifies whether the user can select multiple files or just one.