Custom Assets Library Plugin

Custom Assets Library Plugin

The Custom Assets Library Plugin is the successor to EAL and EAR which converts packs to use the TaleWeave Interface.

Installing With R2ModMan

This package is designed specifically for R2ModMan and Talespire. You can install them via clicking on "Install with Mod Manager" or using the r2modman directly.

Player Usage

This plugin used for players allows TaleSpire to search for TaleWeaver content in the R2Modman Directory. This will allow direct download of TaleWeaver packs via R2Modman.

Default Keyboard Shortcuts

CALP has a bunch of keyboard shortcuts for triggering additional functionality. The default keys can be reconfigured to other keys by editing the R2ModMan configuration for the CALP plugin. Keyboard shortcuts are divided into two sub-sections: functionality triggers and asset spawn modifeirs.

Functionality Triggers

Press these keys while a mini is selected to trigger the corresponding effect if supported.

+-----------------+------------------------------------------------------------------+
| Modifier Keys   | Results                                                          |
+-----------------+------------------------------------------------------------------+
+-----------------+------------------------------------------------------------------+
| LControl + 1    | Trigger Animation "Anim01"                                       |
+-----------------+------------------------------------------------------------------+
| LControl + 2    | Trigger Animation "Anim02"                                       |
+-----------------+------------------------------------------------------------------+
| LControl + 3    | Trigger Animation "Anim03"                                       |
+-----------------+------------------------------------------------------------------+
| LControl + 4    | Trigger Animation "Anim04"                                       |
+-----------------+------------------------------------------------------------------+
| LControl + 5    | Trigger Animation "Anim05"                                       |
+-----------------+------------------------------------------------------------------+
| LControl + 6    | Trigger Animation "Anim06"                                       |
+-----------------+------------------------------------------------------------------+
| LControl + 7    | Trigger Animation "Anim07"                                       |
+-----------------+------------------------------------------------------------------+
| LControl + 8    | Prompt for animation name and play it                            |
+-----------------+------------------------------------------------------------------+
| LControl + 9    | Start playing associated audio                                   |
+-----------------+------------------------------------------------------------------+
| LControl + 0    | Stop playing animation and audio                                 |
+-----------------+------------------------------------------------------------------+

Asset Spawn Modifiers

When selecting an asset from the Talespire Library the asset will be loaded based on the kind specified in the asset bundle or as a creature if the asset does not specify the kind in its info.txt file. However, it is possible to override the kind indicated in the asset bundle with a different kind by holding down the corresponding modifier key while selecting it from the library and when placing it down (if applicable). The following tables show what modifier keys select what kind:

+-----------------+------------------------------------------------------------------+
| Modifier Keys   | Resulting Kind                                                   |
+-----------------+------------------------------------------------------------------+
+-----------------+------------------------------------------------------------------+
| None            | Uses kind specified in asset bundle or creature if not specified |
+-----------------+------------------------------------------------------------------+
| Left Shift      | Processes spawn as if the kind was creature                      |
+-----------------+------------------------------------------------------------------+
| Right Shift     | Processes spawn as if the kind was transform                     |
+-----------------+------------------------------------------------------------------+
| Left Control    | Processes spawn as if the kind was effect                        |
+-----------------+------------------------------------------------------------------+
| Right Control   | Processes spawn as if the kind was aura                          |
+-----------------+------------------------------------------------------------------+
| Left Alt        | Processes spawn as if the kind was audio                         |
+-----------------+------------------------------------------------------------------+
| Right Alt       | Processes spawn as if the kind was filter                        |
+-----------------+------------------------------------------------------------------+

Asset Types

+-----------------+-------------------+--------------------+--------------------+----------------------------------------------------+
| Kind            | Shader            | Transparency       | Hide               | Comments                                           |
+-----------------+-------------------+--------------------+--------------------+----------------------------------------------------+
| Creature        | TS/Creature       | Not Supported      | Supported          | This is the fefault for minis                      |
+-----------------+-------------------+--------------------+--------------------+----------------------------------------------------+
| Audio           | TS/Creature       | Not Supported      | Supported          | Mini starts playing audio when place on board      |
+-----------------+-------------------+--------------------+--------------------+----------------------------------------------------+
| Auras           | From Asset Bundle | Supported          | Not Supported      | Not yet implemented in CAPL                        |
+-----------------+-------------------+--------------------+--------------------+----------------------------------------------------+
| Effect          | From Asset Bundle | Supported          | Not Supported      | Used to create minis with non-TS shaders           |
+-----------------+-------------------+--------------------+--------------------+----------------------------------------------------+
| Transform       | TS/Creature       | Not Supported      | Supported          | Not yet implemented in CAPL                        |
+-----------------+-------------------+--------------------+--------------------+----------------------------------------------------+
| Prop            | TS/Placeable      | Not Supported      | Supported          | Not yet implemented in CAPL                        |
+-----------------+-------------------+--------------------+--------------------+----------------------------------------------------+
| Tile            | TS/Placable       | Not Supported      | Supported          | Not yet implemented in CAPL                        |
+-----------------+-------------------+--------------------+--------------------+----------------------------------------------------+
| (Multi) Slab    | TS/Placable       | Not Supported      | Supported          | Not yet implemented in CAPL                        |
+-----------------+-------------------+--------------------+--------------------+----------------------------------------------------+
| Encounter       | Based On Asset    | Based On Asset     | Based On Asset     | Not yet implemented in CAPL                        |
+-----------------+-------------------+--------------------+--------------------+----------------------------------------------------+

Developer Usage (Asset Creators)

Inbuilt into this package is a Binary Index writer which will generate a TaleWeaver compliant index file mimicing the interface of TaleWeaver. This is incredibly experimental and is being worked on. With CAP, EAR compliant files can be converted to TW compliance. This allows asset creators to keep their current workflow. After CALP runs, an index.json and index files will be generated with some re-organizing. In the root of index.json file will contain an assetPackId variable which can be used to copy over into TaleWeaver's Steamapps folder.

Binary index writer usage (BepInEx Dev)

the index writer as a supplied interface and method to write the pack. PackContent data structure does not use blob references or ECS upon initial construction.

CustomAssetsLibrary.CustomAssetLib.generate(folder);

After completion, the WritePack method will convert it into the ECS Blob structure and write the index file into the modpack directory.

Changelog

1.4.1: Updated documentation. No plugin change.
1.4.0: Added animation functionality
1.4.0: Added sound functionality
1.4.0: Added spawn modification keys
1.3.1: Improved logs
1.3.1: Bug Fix: Null Reference on ghosts
1.3.0: Bug Fix: Endless bases on load
1.3.0: Bug Fix: Spawn size for non-medium creatures
1.2.1: Corrected Thunderstore posting
1.2.0: Effects support trasparency.
1.2.0: Effects are restored on board load.
1.2.0: Bug Fix: AssetBundle Shader is not applied to Creature.
1.1.0: Fixed Effects support.
1.1.0: Fixed Index Out Of Bounds issue.
1.1.0: Added pre and post callbacks to implement additional features.
1.1.0: Temporarily removed dependency on Asset Data plugin.
1.0.1: Added missing Default Portrait into pack. No plugin change.
1.0.0: Official Release, CAL & CAP integrated and working.

Shoutout to Hollofoxes Patreons recognising their mighty contribution to his caffeine addiction:

• John Fuller
• Tales Tavern - MadWizard

Also checkout LordAshes donation page

Changelog

3.5.5: Added FileAccessPlugin request to reload cache after registration (since registration process renames folders)
3.5.4: Seperate Changelog
3.5.3: Update minor logging and reference settings to remove errors from CAL & CAC
3.5.2: Updated Index Compiler to v2 format to fix the Slab update. Index files will need to be recompiled
3.5.1: Corrected pack layout to fix Default Portrait error. No CALP plugin version change.
3.5.0: Attachment Point patch. No CALP plugin change.
3.4.0: CAL & CAC optimization, optional zeus file generated for content creators, removed deprecated dll. No CALP plugin version change.
3.3.2: Bug fix for hit locations on non-invariat cultures
3.3.1: Bug fix for variants preventing aura/effects
3.3.0: Added support for hit locations
3.3.0: Baby Edition: Defaults to always re-registering assets
3.3.0: Corrected namespace and guid
3.2.1: Added option to hide or not hide variants.
3.2.1: Move to a less static implementation.
3.2.0: Added new tweak support to locally modify info.txt file for assets without modifying the asset bundle
3.1.0: Updated to use memory index writing via CAC instead of index.json writing via CAL. (Performance Increase)
3.1.0: Changed Delete JSON files (no longer needed) to Create JSON reference files
3.0.0: Repack with CAL broken into different libraries
2.7.0: Re-implemented variants feature
2.6.0: Working region indepepndent version of CALP. 
2.5.6: Bug fix for default mini orientation
2.5.5: More region settings fixed
2.5.2: Corrected dependencies to use SmartConvert dependency plugin instead of local SmartConvert library
2.5.1: More localization of region setting fixes.
2.4.0: Localization of region setting fix.
2.3.1: Corrected asset pack hierarchy. No plugin or library change.
2.3.0: Bug fix for Cyberpunk update
2.2.0: Bug fix for assets without info.txt and/or portrait.png
2.2.0: Improved registration logging
2.1.0: Added SmartJsonConvert to allow plugin to work in different locale regions without needing to switch region settings before running Talespire.
2.0.0: Moved supplementary functionality to CALPIE.
1.6.0: Added Effect hide functionality.
1.6.0: Added checks for improper asset bundles with visual warning and list in the logs.
1.5.0: Added scripts for unregistering and registering for vanilla.
1.5.0: Added option to tweak index.json files.
1.4.1: Updated documentation. No plugin change.
1.4.0: Added animation functionality
1.4.0: Added sound functionality
1.4.0: Added spawn modification keys
1.3.1: Improved logs
1.3.1: Bug Fix: Null Reference on ghosts
1.3.0: Bug Fix: Endless bases on load
1.3.0: Bug Fix: Spawn size for non-medium creatures
1.2.1: Corrected Thunderstore posting
1.2.0: Effects support trasparency.
1.2.0: Effects are restored on board load.
1.2.0: Bug Fix: AssetBundle Shader is not applied to Creature.
1.1.0: Fixed Effects support.
1.1.0: Fixed Index Out Of Bounds issue.
1.1.0: Added pre and post callbacks to implement additional features.
1.1.0: Temporarily removed dependency on Asset Data plugin.
1.0.1: Added missing Default Portrait into pack. No plugin change.
1.0.0: Official Release, CAL & CAP integrated and working.