Skip to content

Commit 31f273c

Browse files
committed
Added Migrator
1 parent 321b510 commit 31f273c

File tree

11 files changed

+956
-3
lines changed

11 files changed

+956
-3
lines changed

.docs/guides/AdvancedTopics/EmbeddingLibrary.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Embedding the library is the process of making a functional copy of the library
99

1010
If you're planning to make a shader to publish it's important to do this as fist step, since there are going to be some differences applied to the embedded library compared to the base one.
1111

12-
Luckily for you there's an editor window dedicated to this, and can be found in `VRLabs > Modular Shader > Embed Library`.
12+
Luckily for you there's an editor window dedicated to this, and can be found in `VRLabs > Modular Shader > Tools > Embed Library`.
1313

1414
## Embed Library Window
1515

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
uid: adv-MigratingAssets
3+
title: Migrating Assets
4+
---
5+
6+
# Migrating Assets
7+
8+
If you embed the library for your specific project, you're quickly going to notice that all shaders, modules and templates you're made are still dependent on the original Modular Shader System installation, and not your newly embedded one.
9+
10+
You could theoretically just remake the modules and shaders, and changing the extensions of the templates and collections, but it is quite annoying to do that, especially considering that you're going to have to reassign all asset references.
11+
12+
For this reason there's a tool included that lets you import and export assets from the library to a generic format and back, and can be found in `VRLabs > Modular Shader > Tools > Migrator`.
13+
14+
## Migrator
15+
16+
The migrator is a tool divided into 2 tabs: `Export` and `Import`:
17+
18+
![window](/images/docs/AdvancedTopics/2.png)
19+
![window](/images/docs/AdvancedTopics/3.png)
20+
21+
The export section will let you select the assets you want to migrate, and by pressing the `Save` button. you can save them into a file.
22+
23+
On the other hand the import section will let you to read and import the mentioned file, restoring the previously selected modules in the same path under the library the migrator window belongs to.
24+
You will always import all the assets contained into the migration files
25+
26+
> [!IMPORTANT]
27+
> Import and export are always dependent on which library said window is from.
28+
> `VRLabs > Modular Shader > Tools > Migrator` is where the default one is, meanwhile your embedded version depends on the embed settings.
29+
> So to convert a modular shader from base library to your embedded library you have to open the default library migrator, export the assets you want, and then open the migrator of your embedded version and import the file from there.
30+
31+
> [!WARNING]
32+
> Beware that if you have default texture overrides in some properties, you have to complete the migration process within the same editor session, otherwise the references to those textures will be lost. This is also a good reason to not use the migrator as a "quick share" tool
33+
34+
35+
36+
37+

.docs/guides/toc.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,4 +31,6 @@
3131
- name: Modular Shader Generator Deep Dive
3232
href: AdvancedTopics/ModularShaderDive.md
3333
- name: Embedding The Library
34-
href: AdvancedTopics/EmbeddingLibrary.md
34+
href: AdvancedTopics/EmbeddingLibrary.md
35+
- name: Migrating Assets
36+
href: AdvancedTopics/MigratingAssets.md

0 commit comments

Comments
 (0)