Store Page

Starbound

All Discussions Screenshots Artwork Broadcasts Videos Workshop News Guides Reviews

Starbound > Workshop > Lonaasan's Workshop

62 ratings

[oSB] Animis Avatar Suite

Description Discussions0 Comments13 Change Notes

Award

Character Improvements, Mechanics, Miscellaneous

File Size

Posted

Updated

75.752 KB

4 Jul @ 12:11pm

1 Oct @ 10:55am

9 Change Notes ( view )

7,622	Unique Visitors
588	Current Subscribers
258	Current Favorites

Subscribe to download
[oSB] Animis Avatar Suite

Subscribed

Unsubscribe

Description

Animis Avatar Suite - Multiplayer compatible - Requires OpenStarbound

This mod allows you to animate your characters directives based on the player-state (and bindable loop states!)

To use this mod without it overwriting your files on updates, we recommend downloading the Animis Patcher [github.com]!

Please consider starring the Animis repository on github! Pull requests and reporting issues are also welcome there!

To the github repo [github.com]

Current version on the workshop: 2.4.1 - Added Fullloop with in / outro, changing clientdetection
Nightly builds and the sourcecode are available on github (link above)

How to Use

Animis can be quite difficult to understand at the beginning, so i will tell you the basics:

For Animis to work, you have to edit and / or add files to it. The most important file for you to edit is: animis/playerconfig.json

inside of there you currently find a exampleconfig:

{ "1234567890abcdef1234567890abcdef" : { "facial_hair" : { "enabled": true, "idleLoop": false, "loungeIdleLoop": false, "swimIdleLoop": false, "crouchIdleLoop": false, "maxFrames": 9, "speed": 10, "maxRandomValue": 5000, "maxRandomTrigger": 1, "group": "hair", "type": "fem12" } } }

The long string, 1234567890abcdef1234567890abcdef, is the player UUID of your character. you can easily get the UUID by copying the name of your player file in your storage/player folder

The UUID holds an object, in this case facial_hair, which is one of 5 layers you can animate with Animis. The full list is:

body
emote
hair
facial_hair
facial_mask

All of these have different benefits and usecases. For the example, you want to animate facial_hair. This is a layer that renders on top of your hair, so it would be perfect for ears or similar usecases!

Inside facial_hair, you see different properties. We will go through them one by one.

enabled: tells Animis if the directive should be used or not. Helpful for debug purposes.
idleLoop: if you want your idle animation to loop over multiple directives instead of staying at your choosen personality index, you can set this to true
loungeIdleLoop: if you want your lounge idle animation to loop over multiple directives, you can set this to true
swimIdleLoop: if you want your swimming idle animation to loop over multiple directives, you can set this to true
crouchIdleLoop: if you want your crouch animation to loop over multiple directives, you can set this to true
maxFrames: the max number of frames animis will loop through. Mostly just there to stop people from making too many frames. You can also remove this property if you want to use the default in animis/config.json
speed: the speed at which animis goes through your directives. Higher numbers are faster. You can also remove this property if you want to use the default speed in animis/config.json
maxRandomValue: the maximum value from 1 to x to generate numbers, which the random state will use for its likelyhood. You can also remove this property if you want to use the default in animis/config.json
maxRandomTrigger: the maximum value from 1 to x at which the random state will trigger. You can also remove this property if you want to use the default in animis/config.json
group & type: some layers equire a group and type to display properly. You can remove these properties for the body and emote directives, as they work without them

Now you have set up your playerconfig, but where do you add in the directives for your layers?

For that you have to create a folder named after your player UUID into the animis folder. In our case: 1234567890abcdef1234567890abcdef. Into that folder you create json files that are named like the layers we just set up, so lets make facial_hair.json.

Our example file has the base structure how such a layerfile can look like:

{ "crouch": [ "?crop=0;0;1;1?multiply=0000?..." ], "idle": [ "?crop=0;0;1;1?multiply=0000?...", "?crop=0;0;1;1?multiply=0000?...", "?crop=0;0;1;1?multiply=0000?...", "?crop=0;0;1;1?multiply=0000?...", "?crop=0;0;1;1?multiply=0000?..." ], "jump": [ "?crop=0;0;1;1?multiply=0000?...", "?crop=0;0;1;1?multiply=0000?...", "?crop=0;0;1;1?multiply=0000?...", "?crop=0;0;1;1?multiply=0000?..." ], "afterJump": [ "?crop=0;0;1;1?multiply=0000?..." ], "fall": [ "?crop=0;0;1;1?multiply=0000?...", "?crop=0;0;1;1?multiply=0000?...", "?crop=0;0;1;1?multiply=0000?...", "?crop=0;0;1;1?multiply=0000?..." ], "afterFall": [ "?crop=0;0;1;1?multiply=0000?..." ], "run": [ "?crop=0;0;1;1?multiply=0000?...", "?crop=0;0;1;1?multiply=0000?...", "?crop=0;0;1;1?multiply=0000?...", "?crop=0;0;1;1?multiply=0000?...", "?crop=0;0;1;1?multiply=0000?...", "?crop=0;0;1;1?multiply=0000?...", "?crop=0;0;1;1?multiply=0000?...", "?crop=0;0;1;1?multiply=0000?..." ], "lounge": [ "?crop=0;0;1;1?multiply=0000?..." ], "swim": [ "?crop=0;0;1;1?multiply=0000?...", "?crop=0;0;1;1?multiply=0000?...", "?crop=0;0;1;1?multiply=0000?...", "?crop=0;0;1;1?multiply=0000?..." ], "swimIdle": [ "?crop=0;0;1;1?multiply=0000?..." ], "walk": [ "?crop=0;0;1;1?multiply=0000?...", "?crop=0;0;1;1?multiply=0000?...", "?crop=0;0;1;1?multiply=0000?...", "?crop=0;0;1;1?multiply=0000?...", "?crop=0;0;1;1?multiply=0000?...", "?crop=0;0;1;1?multiply=0000?...", "?crop=0;0;1;1?multiply=0000?...", "?crop=0;0;1;1?multiply=0000?..." ], "switch1": [ "?crop=0;0;1;1?multiply=0000?...", "?crop=0;0;1;1?multiply=0000?..." ], "switch2": [ "?crop=0;0;1;1?multiply=0000?...", "?crop=0;0;1;1?multiply=0000?..." ], "loop1": [ "?crop=0;0;1;1?multiply=0000?...", "?crop=0;0;1;1?multiply=0000?..." ], "loop2": [ "?crop=0;0;1;1?multiply=0000?...", "?crop=0;0;1;1?multiply=0000?..." ], "once1": [ "?crop=0;0;1;1?multiply=0000?...", "?crop=0;0;1;1?multiply=0000?..." ], "once2": [ "?crop=0;0;1;1?multiply=0000?...", "?crop=0;0;1;1?multiply=0000?..." ], "looponce1": [ "?crop=0;0;1;1?multiply=0000?...", "?crop=0;0;1;1?multiply=0000?..." ], "looponce2": [ "?crop=0;0;1;1?multiply=0000?...", "?crop=0;0;1;1?multiply=0000?..." ], "random": [ "?crop=0;0;1;1?multiply=0000?...", "?crop=0;0;1;1?multiply=0000?..." ] }

Inside, you see each state with an array of directives. You can add / remove directives or even delete a state if you dont want it.

Custom Loops!

As you can see, this file has some states that are not present in vanilla. these are custom loop states! You can set up the binds for them in the mod binds of OpenSB

To add directives, i would recommend using "Air Fryer" from Kae on Discord. You give it an image, and it creates a directive you can paste in, pretty easy!

Add air fryer to your discord! [discord.com]

After you filled in your desired directives, you are done. Congratulations!

13 Comments

< >

Skele_HD 12 Dec @ 4:08am

That's fair, but I do see the potential for this.
Custom animations and more is a really nice thing to add, even if a tad complicated.
I will definitely look into this more one day once I find the time and urge to play SB again.

Lonaasan [author] 11 Dec @ 1:47pm

welcome to my mods xD sorry for the headaches :P i made this mod mostly for my own usecase and cleaned it up a bit for public use

Skele_HD 11 Dec @ 7:03am

Came over from persona to check out what this animation stuff is all about...

What rabit hole did I just stumbe into?...
(Probably an awesome one, but this stuff seems quite advanced)

Lonaasan [author] 18 Aug @ 7:28am

cheetah ear movement should be possible, if you had any issues with using the mod i am happy to get feedback :3 Yee, as i said in the description and here in the comments, its a bit of a learning curve for new people just getting into the game and want to mod. Hope u still had fun trying it out!

Super Brasilis 17 Aug @ 4:25pm

Looks simple in theory, but not for me on pratice, I am very good to have ideas but not much of taking it out the paper or blueprint if you prefer.

Super Brasilis 17 Aug @ 4:22pm

I liked that ears flicks lol, that should be good if the feline humanoid race do that too, I wanted it to be simillar to cheetahs but who made didn't made it possible, but you made a good job with thay ear movement, very cute! Good vibes!

Lonaasan [author] 9 Aug @ 5:29am

I don’t know if my mod is compatible with modded character origins yet, to test that, you would have to:
- add your uuid into the playerconfig.json with the layers and settings you would like (in the mod description text)
- add a new folder in animis with you uuid as name
- then add the layer you specified in the playerconfig as a json file
- and in there add your drawables to the relevant state you want. (in the mod description text)

Many steps i know, but animis does not animate ur player out of the box, to prevent possible incompatibility and also it is not intended to edit your character from the start. You will need to know fundamentals on what directives are and how to make them, to make animis a tool for your character animations.

Purr-ple cat 8 Aug @ 7:53pm

i apologize in advancce, but how do i get this to work ^^' the downloading and enabling of the animations (i just want my neki to have cute ear flickz x-x) im not very good with this stuff

Lonaasan [author] 7 Jul @ 9:19am

currently not, sorry... i will keep it in mind if its doable for vanilla players to see still.

BITney, The Pixel Heister 7 Jul @ 4:05am

I was talking more about the humanoid breathing, dynamics and vapor trail

< >

Starbound

Subscribe to download[oSB] Animis Avatar Suite

Edit links

Subscribe to download
[oSB] Animis Avatar Suite