Animated Custom Sprites

If you liked this item, please rate it up on Steam Workshop page.

Author: DK

Last revision: 10 Dec, 2025 at 13:01 UTC (2)

File size: 308.13 KB

On Steam Workshop

Description:
Animated Custom Sprites

Allows the usage of animated sprites for custom characters and items.




(padoru credit to Drakeny)

To create custom characters and items, you can use Custom Whatever Loader to simplify the process.

Animation Clip

To create a clip, simply name each frame with `id_acs_name#interval_index`.

For example, a custom character with id `boxchicken`, you should prepare the following sprites in the Texture folder:

  • `boxchicken.png`, base sprite, that gets loaded as a still image, used everywhere in the game.
  • `boxchicken_acs_idle#66_1.png`, 1st frame of clip "idle", which is used when card is idling, with an interval of 66ms.
  • repeat and follow the same convention to create frames for clip "idle".
  • `boxchicken_acs_combat#66_1.png`, 1st frame of clip "combat", which is used when card is in combat, with an interval of 66ms.
  • repeat and follow the same convention to create frames for clip "combat".
  • Note that combat clip is not required.
  • `boxchicken_acs_customClipName#66_0.png`, 1st frame of clip "customClipName", this clip needs to be played manually by using Animated Custom Sprites API.
  • repeat and follow the same convention to create frames for clip "customClipName"…

However, you can also create a horizontal spritesheet, with the index being begin-end, such as `boxchicken_acs_combat#66_0-9.png`:

API

If you don’t need advanced control over clips, then simply set Animated Custom Sprites as a dependency on steam workshop and you are good.

By referencing `AnimatedCustomSprites.dll`, you gain access to the entire `ACS.API` namespace, with the following extension methods:

// clip control card.StartAcsClip(clipName) card.StartAcsClip(clipType) card.StopAcsClip() // clip access card.GetAcsClip(clipName) card.GetAcsClip(clipType) card.GetAcsClips(clipName) card.GetAcsClips(clipType) card.GetAllAcsClips() // clip creation card.CreateAcsClip(sprites[], clipName, clipType, interval) card.CreateAcsClips(sprites[])

If using API via referencing dll, please do not ship the AnimatedCustomSprites.dll with your mod.

Having a Problem?

Want to request new animation conditions without needing to mess with API? New features? Bugs? Need of assistance? Feel free to leave comments or reach my at Elona Discord @freshcloth.
sauce[github.com]

Download
Required items:

Click the title to search on this site.


(Nightly) Custom Whatever LoaderSteam Workshop
(Stable) Custom Whatever LoaderSteam Workshop
Revisions:

Old revisions of this mod are available below. Click the link to download.