Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/SrejonKhan/AnotherFileBrowser
Just another File Dialog for Unity, with easy implementation.
https://github.com/SrejonKhan/AnotherFileBrowser
file-browser file-dialog file-explorer ookii-dialogs unity
Last synced: 3 months ago
JSON representation
Just another File Dialog for Unity, with easy implementation.
- Host: GitHub
- URL: https://github.com/SrejonKhan/AnotherFileBrowser
- Owner: SrejonKhan
- License: mit
- Created: 2020-12-07T17:47:12.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-02-10T18:47:08.000Z (12 months ago)
- Last Synced: 2024-08-03T05:15:56.621Z (6 months ago)
- Topics: file-browser, file-dialog, file-explorer, ookii-dialogs, unity
- Language: C#
- Homepage:
- Size: 1.58 MB
- Stars: 42
- Watchers: 3
- Forks: 7
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# AnotherFileBrowser
Just another File Dialog for Unity, with easy implementation. Using Ookii Dialogs Winforms. Rather than putting everything in .dll, i've done this simply with a class, so you can extend it based on Ookii Dialogs Winforms.
# Getting Started
Open Package Manager in Unity and Click on Plus Icon -> Add package from git URL, paste following link `https://github.com/SrejonKhan/AnotherFileBrowser.git` and click Add.
After importing, change **Change API Compatibility Level** to **_.NET 4.x_**, from `Project Settings -> Player -> Other Settings`. And, change **Scripting Backend** to **_Mono_**.
For example, go to `Packages -> Another File Browser -> Example` in Project View, then import `Example.unitypackage`.
# Implementation
Implementation is quite easy, but before implementing let's know about **BrowserProperties** constructor.
**BrowserProperties**
```csharp
public class BrowserProperties
{
public string title; //Title of the Dialog
public string initialDir; //Where dialog will be opened initially
public string filter; //aka File Extension for filtering files
public int filterIndex; //Index of filter, if there is multiple filter. Default is 0.
public bool restoreDirectory = true; //Restore to last return directory
public BrowserProperties() { }
public BrowserProperties(string title) { this.title = title; }
}
```
Make sure to define `AnotherFileBrowser.Windows` namespace.
### Picking a Single File
```csharp
var bp = new BrowserProperties();
bp.filter = "txt files (*.txt)|*.txt|All Files (*.*)|*.*";
bp.filterIndex = 0;
new FileBrowser().OpenFileBrowser(bp, path =>
{
//Do something with path(string)
Debug.Log(path);
});
```
### Picking Multiple File(s)
```csharp
var bp = new BrowserProperties();
bp.filter = "txt files (*.txt)|*.txt|All Files (*.*)|*.*";
bp.filterIndex = 0;
new FileBrowser().OpenMultiSelectFileBrowser(bp, path =>
{
//Do something with path(string[])
string s = "";
for (int i = 0; i < path.Length; i++)
{
s += path[i] + "\n";
}
});
```
### Picking Folder Path
```csharp
var bp = new BrowserProperties();
bp.filter = "txt files (*.txt)|*.txt|All Files (*.*)|*.*";
bp.filterIndex = 0;
new FileBrowser().OpenFolderBrowser(bp, path =>
{
//Do something with path(string)
Debug.Log(path);
});
```
### Picking Path for Saving File
```csharp
var bp = new BrowserProperties();
bp.filter = "txt files (*.txt)|*.txt";
bp.filterIndex = 0;
new FileBrowser().SaveFileBrowser(bp, "test", ".txt", path =>
{
//Do something with path(string)
Debug.Log(path);
});
```
### Picking and Loading Image
```csharp
var bp = new BrowserProperties();
bp.filter = "Image files (*.jpg, *.jpeg, *.jpe, *.jfif, *.png) | *.jpg; *.jpeg; *.jpe; *.jfif; *.png";
bp.filterIndex = 0;
new FileBrowser().OpenFileBrowser(bp, path =>
{
//Load image from local path with UWR
StartCoroutine(LoadImage(path));
});
//Load Image from Local
IEnumerator LoadImage(string path)
{
using (UnityWebRequest uwr = UnityWebRequestTexture.GetTexture(path))
{
yield return uwr.SendWebRequest();
if (uwr.isNetworkError || uwr.isHttpError)
{
Debug.Log(uwr.error);
}
else
{
var uwrTexture = DownloadHandlerTexture.GetContent(uwr);
//placeholderImage is an Image Component of Unity UI
placeholderImage.sprite = Sprite.Create(uwrTexture, new Rect(0, 0, uwrTexture.width, uwrTexture.height), new Vector2(0, 0));
}
}
}
```
#### Pro-Tips
Use preprocessor for [Platform Dependent Compilation](https://docs.unity3d.com/Manual/PlatformDependentCompilation.html), so there won't be any issue while building for other platforms.
#### IL2CPP Support
I'm facing crashes if try to open dialog from il2cpp build. If you want to try in il2cpp, you need to add `Mono.Posix` & `Mono.WebBrowser` from `C:\Program Files\Unity\Editor\Data\MonoBleedingEdge\lib\mono\gac` to `\Plugins` folder.
There must be a workaround, you can check crash logs after crash. I will try to fix it, if you already fixed it, open a PR, it would be highly appreciated.
# Android / iOS Support
This is only for Windows. You can check out [UnityNativeFilePicker](https://github.com/yasirkula/UnityNativeFilePicker) by Yasirkula. There are plenty of native plugins, but this one support iOS too.
# Contacts
### Srejon Khan
Indie Game Programmer
**Mail:** [email protected]