LordAshes-RetexturePlugin icon

RetexturePlugin

Allows mini or effect to be retextured at runtime.

Last updated 5 months ago
Total downloads 4825
Total rating 2 
Categories Tweaks Client-side Networked Tools Integration Assets Minis
Dependency string LordAshes-RetexturePlugin-2.5.1
Dependants 0 other packages depend on this package

This mod requires the following mods to function

bbepisTaleSpire-BepInExPack-5.4.10 icon
bbepisTaleSpire-BepInExPack

Unified BepInEx all-in-one modding pack - plugin framework, detour library

Preferred version: 5.4.10
brcoding-SetInjectionFlagPlugin-2.3.0 icon
brcoding-SetInjectionFlagPlugin

Allows players to flag mods are installed

Preferred version: 2.3.0
LordAshes-FileAccessPlugin-1.5.1 icon
LordAshes-FileAccessPlugin

Provides standardized methods for accessing both local file and url resources. Automatically handles searching local folders for assets.

Preferred version: 1.5.1
LordAshes-AssetDataPlugin-3.4.1 icon
LordAshes-AssetDataPlugin

Dependency plugin for subscription/notification based data storage and message exchange.

Preferred version: 3.4.1

README

Retexture Pack

This unofficial TaleSpire pluigin allows mini and effects to be retextured allowing the same asset to be used without different textures. Great for situations such as turning minis into statues, apply colours to signify conditions such as stealth, and for applying situation specific texture to signs, flags, etc.

While the plugin does not come with the flag pack, it can be downloaed separately and this plugin can be used to change the contents of the flag.

Change Log

2.5.1: Fix for BR Seats update
2.5.0: Fix for BR Taleweaver update
2.3.0: Migrated from Stat Messaging To Asset Data Plugin
2.2.0: Added video material support (implemented by Hollo)
2.1.0: Improved hierarchy traversing code to work with different asset structures
2.0.0: Fix for BR HF Integration update
1.0.1: Added subscribe on start so that RCTRL+Y is not necessary if making a new board
1.0.0: Initial release

Install

Use R2ModMan or similar installer to install this asset pack.

Usage

  1. Click on a mini
  2. Activate the Re-texture feature using the corresponding keyboard shortcut (default RCTRL+X)
  3. In the dialog that opens, enter the name of the alternate texture (including extension)

If the mini has a effect applied, the texture is retextured. If the mini does not have a effect applied, the mini is retextured instead. If the target (mini or effect) has a material called RETEXTURE_MAT then this material texture is replaced. If the target does not have a material with this name then the default material is retextured.

Supported image textures: Can be most format (such as PNG, BMP, JPG, etc) Supported video textures: .mp4, .mov, .webm, .wmv

Retexturing Minis

Most TS core minis use a single texture and thus are compatible with the Retexture plugin using the default material texture. However, some core TS mini use multiple textures in which case they will not be fully compatilble with the Retexture plugin (i.e. only part of the mini texture may be changed).

Retexturing Effects

If an effect uses a single texture then nothing special needs to be done when creating the effect in order to allowing the Retecture plugin to retexture the material. However, if the effect uses multiple materials then desired material for Retextuirng needs to be called RETEXTURE_MAT. In this way, the asset tells the Retexture plugin which material texture to change.

Limitations

Due to the removal of Effect kind in CALP in favor of using the SHIV Transparency Trick, the transparent features of the Retexture plugin will only work with assets that properly implement the SHIV Transparency Trick to hide the part of the asset that is transparent from core TS.

Currently the Flat Token pack has not been updated to the SHIV Transparency Trick and thus the transparent version of the flat tokens will not work. However, the solid flat token (and the coin) can be retextured.