Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
p-hennessy committed Mar 27, 2024
1 parent 2a1b1b8 commit 957f36f
Showing 1 changed file with 30 additions and 13 deletions.
43 changes: 30 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,38 +4,54 @@
![GitHub License](https://img.shields.io/github/license/p-hennessy/Substance-VTF-Exporter-Plugin?style=flat-square)


> [!WARNING]
> [!CAUTION]
> This plugin is still in very early alpha / active development. I make no gaurentees of stability or reverse compatibility.
A plugin for Substance 3D Designer that allows one to do bulk exporting of materials into the Source Engine's VTF format
A plugin for [Substance 3D Designer](https://www.adobe.com/products/substance3d-designer.html) that allows one to do bulk exporting of materials into the Source Engine's VTF format.

The goal of this plugin is to speed up the workflow for texture artists using Substance Designer for Source Games.

---

# Installing

1. Find the latest release: https://github.com/p-hennessy/Substance-VTF-Exporter-Plugin/releases
2. Download the vtf_exporter.sdplugin file
2. Download the `vtf_exporter.sdplugin` file
3. In Substance Designer, open the Tools Menu and click on "Plugin Manager"
4. Use the "Install..." button and find the sdplugin file
5. If it installed correctly there should now be a "VTF Exporter" dock. If it does not appear automatically you can find it by looking in the "Windows" menu.


# Features

- [x] Export bulk textures to VTF format
- [x] Saves settings per graph.
- [ ] Export VMT's along with textures
- [ ] Support for multiple VTF compression formats
- [ ] Import VTF as Bitmap node
- [ ] Export a single texture directly to VTF
- [ ] Output animated VTF driven by input variables


# Usage

This plugin works through Substance Designer Presets.
This plugin works through Substance Designer [Parameter Presets](https://helpx.adobe.com/substance-3d-designer/substance-compositing-graphs/exposing-a-parameter/parameter-presets.html).

You will need to define at least one preset for it to work.

For each preset, it will export each of the outputs in your graph. You must have at least one output in the graph.
For each preset, it will export each of the outputs in your graph. You must have at least one [output](https://helpx.adobe.com/substance-3d-designer/substance-compositing-graphs/nodes-reference-for-substance-compositing-graphs/atomic-nodes/output.html) node in the graph.

The plugin outputs at the texture resolution that the final output node has. If you want a smaller resolution texture then it needs to be scaled down before the output node.

The naming pattern it follows is:
The naming pattern is as follows:
`{graph_name}_{preset_name}_{output_name}.vtf`

#### Example:
Graph name: "brick001"
Presets: "red" "yellow" and "blue"
Outpus: "diffuse" and "normal"
- Graph name: "brick001"
- Presets: "red" "yellow" and "blue"
- Outpus: "diffuse" and "normal"

It would output:
Outputs:
- brick001_red_diffuse.vtf
- brick001_red_normal.vtf
- brick001_yellow_diffuse.vtf
Expand All @@ -50,9 +66,9 @@ These config's are stored at:

- Windows: `C:/Users/<USER>/AppData/Roaming/Allegorithmic/Substance Designer/vtf_exporter/`
- Linux: `/home/<USER>/.local/share/vtf_exporter`
- OSX: ` /Users/<USER>/Library/Application Support/vtf_exporter`
- OSX: `/Users/<USER>/Library/Application Support/vtf_exporter`

Graph's configurations will use SD's built in UUID's as their filenames.
Graph's configurations will use Substance Designer's built in UUID's as their filenames.

### Global Configuration
<details>
Expand All @@ -62,8 +78,9 @@ This is needed so the plugin can convert to VTF format.
This vtex program comes with any source game.

Mine is located here: `C:/Program Files (x86)/Steam/steamapps/common/Team Fortress 2/bin/vtex.exe`
</details>

More info on vtex: https://developer.valvesoftware.com/wiki/VTEX_(Source)/en
</details>

### Graph Configuration
<details>
Expand Down

0 comments on commit 957f36f

Please sign in to comment.