@rbxts/canim v0.3.1

canim

canim is a roblox-ts library that allows you to have more control over your animations. Documentation is available at https://blackshibe.github.io/canim/

why this exists

I had to edit animations at runtime to implement bipods, and I wanted to layer animations on top of each other, which the default animator doesn't let you do. Canim is designed for an FPS game as a result, but will work as a general animator in most cases.

This library is very verbose in terms of API, is designed for typescript, and will generally not work with animations made in Studio.

import { Canim } from "@rbxts/canim";

// R15 default dummy
let character = game.GetService("Workspace").WaitForChild("dummy") as Model;
let animator = new Canim();
animator.assign_model(character);

// loading poses is the same, but only the 1st keyframe is used.
let animation = animator.load_animation("dance", 1, "rbxassetid://507771019");
animation.finished_loading.Wait();

// the animation will play with lowered rotation and with unaffected position
animation.looped = true;
animation.bone_weights.__CANIM_DEFAULT_BONE_WEIGHT = [
	// x y z
	[1, 1, 1],
	// rx ry rz
	[0.5, 0.5, 0.5],
];

animation.keyframe_reached.Connect((name) => {
	print("marker reached:", name);
});

animation.started.Connect(() => {
	print("started");
});

animation.finished.Connect(() => {
	print("finished");
});

animator.play_animation("dance");
game.GetService("RunService").RenderStepped.Connect((delta_time) => {
	animator.update(delta_time);
});