flax-auto-import-resources-plugin's Introduction

Auto Import Resources Plugin

Automagically imports everything from the Assets folder into Content/Imported. Whenever you change something, it re-imports it.

Want to contribute?

Check out the documentation on Flax plugins. This one is an editor plugin.

Clone the project and open it in Flax. Then, check out the code in Source/Editor. It currently has 4 files

ResourcePlugin.cs simply sets up the plugin
AssetFolderSynchronizer.cs implements the actual logic. It looks at the Assets folder and (re)imports the new files into Content/Imported. It does so once at the beginning and then again every time something changes.
FileSystemEventBuffer.cs is a wrapper around a FileSystemWatcher. It debounces the usually quite chaotic filesystem events.
ContentItemExtensions.cs has a single extension methods to get all children of a ContentFolder

flax-auto-import-resources-plugin's People

Contributors

Stargazers

Watchers

flax-auto-import-resources-plugin's Issues

Only run when Editor is in foreground

When the editor isn't focused, pause the actual re-importing.

Folder Sync

Currently it only keeps the files in sync. Ideally, it would also synchronize the folder structure.

SynchronizeFolders Reimport if newer

https://github.com/stefnotch/flax-auto-import-resources-plugin/blob/42bff5c7ad281b5cf8a126899357e7a1c61f678b/Source/Editor/ResourcePlugin.cs#L99

Ignore files

Sometimes there are files in the Assets folder that really shouldn't get imported. For example, a Readme.md file.

Change folder to Content/Assets

Currently the target folder is Content/Imported. A neater folder would be Content/Assets.

Import and Resources folder creation/deletion

Currently, it only checks for the existence of the said folders on startup. It would be better if it always checked for their existence.
https://github.com/stefnotch/flax-auto-import-resources-plugin/blob/42bff5c7ad281b5cf8a126899357e7a1c61f678b/Source/Editor/ResourcePlugin.cs#L59

Change file structure

So, basically we've (my gamedev team) dropped the idea to separate models like this.
And currently using something like this:
Content/Assets/Characters/Knight/
Models/KnightModel.flax
Textures/KnightBodyDiffuse.flax
Materials/...
TPVKnightPrefab.flax
KnightSettings.flax
Content/Assets/Weapons/LongSword1/
Models/LongSword1Model.flax
Textures/LongSword1Diffuse.flax
Materials/...
TPVLongSword1Prefab.flax
LongSword1Settings.flax
Where Content is the Flax's default root dir.
-- Erdroy

One thing the plugin could automatically do would be name-prefixing. So you could have
Knight/Textures/Body Diffuse.png and it would turn into Knight/Textures/Knight Body Diffuse.flax

Optimisations

A bunch of things could be optimized a lot.

https://github.com/stefnotch/flax-auto-import-resources-plugin/blob/42bff5c7ad281b5cf8a126899357e7a1c61f678b/Source/Editor/ResourcePlugin.cs#L88

https://github.com/stefnotch/flax-auto-import-resources-plugin/blob/42bff5c7ad281b5cf8a126899357e7a1c61f678b/Source/Editor/ResourcePlugin.cs#L255

No popup on reimport

Currently, when reimport is called, the importing popup still pops up.

Currently, when you import a file (say .png), you'll end up with a binary .flax file. This file stores the image and the import settings.
Combined with an auto importer, the .flax file is a partially auto-generated file. So, I was wondering if it's possible to only store the import settings in a GitHub repository and how you would go about doing so?

It seems like it could work like this (names are subject to change)

/Source/Assets: Original files
Somewhere: Import settings?
/Content/Imported: Imported files

It could be added to the .gitignore, however that requires super deterministic importers that don't change across versions.

flaxcommunityprojects / flax-auto-import-resources-plugin Goto Github PK