MaterialEditor Tag Generator

A Unity Editor script for automatically generating tags for AI-Shoujo / HS2 MaterialEditor. This could make it convenient in scripting manifest.xml in a newly built shader mod.

How to Use

1. Drag and drop the code file, ME_Tag_Generator.cs on the Release page, into Asset/Editor/ folder in your project directory. If you don't have such an Editor folder, just create one in the Asset folder.
2. Edit your shader file by a coding tool.
3. Move to the bottom of the codes, then you see a script like FallBack "Diffuse", or FallBack "Unlit" or something begins with "FallBack". Add a new line below this "FallBack" and put the following script in this new line:

CustomEditor "ME_Tag_Generator.CustomShaderInspector"

So, the bottom of code now can be like:

FallBack "Diffuse"
CustomEditor "ME_Tag_Generator.CustomShaderInspector"

Then, save this shader file. 3. Back to Unity Editor's Project window. Select the material using your shader, and you can see a button, namely "Generate Tags for AI/HS2 MaterialEditor", on the Inspector window of this material.

4. Press this button, and it will automatically read the properties in your shader and generate tags for MaterialEditor. The tags will be saved in a new .xml file, namely manifest_ShaderName.xml, created in a folder "manifest", which will be also created if not yet exists. Now you've got the tags, but it still need to check:

• The attributes, Asset and AssetBundle, in a <Shader> tag will be filled blank, and you need to revise them to the correct values.

• The attribute DefaultValue for a Texture type <Property> tag is the texture file name of the default map set in this shader, NOT the map set in this material. If it's not assigned in this shader, its DefaultValue will remain empty.

• The attribute, DefaultValueAssetBundle, for a Texture type <Property> tag will be empty, if it has be assigned to a default map. You need to revise it to the correct value.

• As you see, <AI_MaterialEditor> and <HS2_MaterialEditor> tags are both generated. This is for the compatibility across AI-Shoujo and HoneySelect2.

Tip

There is a way helping to fill the Asset, AssetBundle and DefaultValueAssetBundle attributes. Please move to: Make a Preset?.

Supplement

Make a Preset?

As mentioned above, the attributes such like AssetBundle or DefaultValueAssetBundle, will not be filled with the actual values since the Generator doesn't know what .unity3d files you're suppose to pack up. The guide above suggests you to manually fill them one by one and time by time as the tags are updated.

There comes a new way making it convenient since the Generator got updated to v1.0.1, allowing to make a shader preset. The steps are listed as:

1. In the folder of the material from which you suppose to generate tags, create a .xml file as a shader preset and give it a name exactly same as your shader name. Suppose the name in my shader file is "Test/Test_for_ME_Tag_Generator", this .xml file can be named: Test_for_ME_Tag_Generator.

2. Script the tags, into the shader preset file, that you would like the Generator transfer to the generated tag file. The tags have to be between <Shader></Shader> tags, and <Shader> tag has to be between <MaterialEditor></MaterialEditor>, <AI_MaterialEditor></AI_MaterialEditor> or <HS2_MaterialEditor></HS2_MaterialEditor>. For instance:

<AI_MaterialEditor>
  <Shader Name="Test/Test_for_ME_Tag_Generator" AssetBundle="xxxx" Asset="1111">
    <Property Name="MainTex" Type="Texture" DefaultValue="fff" DefaultValueAssetBundle="vfvbverer" />
    <Property Name="Fresnel" Type="Float" Range="0,1" DefaultValue="355" />
  </Shader>
</AI_MaterialEditor>

3. Since the name of shader preset file is exactly same to the shader name, the generated tags will at first check the preset, and duplicate the <Shader> and <Property> tags that have same names as in the .shader file. So the duplicates will appear in the generated tags, and for the other properties without scripted in tags in the preset file, the Generator still do its job based on the shader file.

If the preset file is successfully involved in the generation, the Console will give a message like:

Successfully generated ME tags at: Assets\Editor\ME Tag Generator\Test_for_ME_Tag_Generator_ME tags.xml.

Shader Preset was involved at: Assets\Editor\ME Tag Generator\Test_for_ME_Tag_Generator.xml.

Otherwise:

Successfully generated ME tags at: Assets\Editor\ME Tag Generator\Test_for_ME_Tag_Generator_ME tags.xml.

Shader Preset was not involved. Please check if it is named correct like: Assets\Editor\ME Tag Generator\Test_for_ME_Tag_Generator.xml.

4. If the shader preset file is not named by using correct shader name, the Generator can also check if a namely shader.xml file exists in the current folder to read.

In Addition

Besides a shader preset, you can use a mod.xml or mod.sxml file as mod preset in the current folder to duplicate the mod information tags, such like <guid>, into the generated xml file. Such this file is the setting document of mod building designated by hooh Modding Tools.

After the v1.0.3 update, you can choose to put shader preset tags into mod.xml or mod.sxml file, and it could be like:

<packer>
    <guid>id.qui.mollit</guid>
    <name>ME Tag Generator</name>
    <version>0.0.2</version>
    <author>Bl@ke</author>
    <description>ME_Tag_Generator</description>
    <bundles>
        <folder auto-path="prefabs" from="output" filter="*.?\.prefab" />
    </bundles>
    <build />

    <MaterialEditor>
    <Shader Name="Test/Test_for_ME_Tag_Generator" AssetBundle="" Asset="">
      <Property Name="Color" Type="Color" DefaultValue="1, 1, 1, 1" />
    </Shader>
  </MaterialEditor>
</packer>