Sugar Cake Animation Framework

What is Sugar Cake? (SCake for short)

Sugar Cake Animation Framework is a sex animation and gameplay stats framework for Palworld focused on providing the baseline for adult content in Palworld. SCake allows animators to import their animations into Palworld, then animators and users can use those individual animations to create Animation Events (effectively entire scenes) for customized playback of complex animations. (More on this below) SCake also adds additional stat tracking to create dynamic stats that don't fit within the game's native structure (such as some naughty stats ^.-).

Notices!

All versions of Sugar Cake from 0.5 DEV forward will require UniPalUI! SCake uses UniPalUI for the UI and input handling, without it technically SCake can still play animations and function but you may lack any meaningful way to customize or trigger animations depending on your configuration, and you won't get the on-screen adjustment UI and customizations or FreeCam support... (Just get UniPalUI ^-^ - https://www.michaelpstanich.com/?mode=modhack&view=2024-10-16_Palworld_UniPalUI)

Sugar Cake 0.6.19 TEST Changed the JSON Config format! Animation packs will need to update their packs with new JSON config files to function properly!

Known Critical Issues

Triggering animations isn't tested in every possible scenario, so if you start animations in weird conditions stuff may break! If you find something that breaks with anims, please report it so a work-around/fix/validation can be made for it!

Features List

Custom Animation Player
A fully custom Animation Player built with erotic animations in mind. The system allows animators and scene creators to define stages with automatic climax and post climax support. Users get access to various advanced settings to customize their experience with SCake to their preference!

Custom JSON importer for Animations
Sugar Cake features a fully customizable and dynamic way to import animations through JSON files which both animators and users can fully customize in any plain text editor! Create either simple Animation Events with easy to understand data, or go full scene master with advanced settings and crazy potential! (You can even share your customized events by sharing your own JSON file with others, all without ever needing to animate!)

Integrations with UniPalUI for Custom UI, Input, and FreeCam
Uses UniPalUI to implement a simple to use user interface for customizing settings and adjusting animations while also using UniPalUI's input functions for easy debug controls and FreeCam during animations! Also comes with a set of custom UI elements specifically tailored for SCake and its functions!

Pal Stat Tracking
Tracking for custom stats that can be used either by animations or through external mods using the SCake SDK called modules! SCake handles the rising/lowering and tracking without requiring any input from the user!

Custom Sex Equips System for Genders
While Palworld may only have Male/Female internally, with SCake's additional tracking and systems we can register more! SCake features an SEquip tags systems where instead of being stuck to pre-defined genders, characters can have specific Sex Equipment defined on their character for compatibility checking!

Preference Settings
May not sound like a big deal at first, but let's say you're not into a specific kind of animation or combination? Instead of having to sift through all your animations and manually disable/remove them, instead you can change your preference settings to block certain anims from playback!

Full Persistence
SCake has its own save system for additional data unique to the mod! These saves are in .json format (so you can edit them externally) and save per-world save! You can also use "Adjust Profiles" to customize how characters position during animations, and "Setting Profiles" to customize settings, and since these save as a JSON file like other saved data, they persist and are share-able!

Oh, did I mention this is a Framework? We have an API and SDK!
Provided along-side SCake is the SCake SDK as well as documentation on the various functions you can call within SCake. This allows you to create modules for SCake through Blueprints with all the powers UE5 provides! (May require a palworld modding kit set-up for proper use)

Inputs

SCake uses UniPalUI for input handling. With the default bindings for UniPalUI v0.1DEV, use Shift+Y to open the menu and select "Sugar Cake Animation Framework" using the mouse to edit settings and preferences.

("With Debug" means "Enable Debug Controls" is enabled in settings, this is currently enabled by default until more gameplay mods are made)

Default Key Bindings...

Shift+Y : Open UniPalUI menu for setting/preference adjustments

Shift+K : View/control target's playing Animation Event Hold Shift+K : View/Control summoned pal's playing Animation Event

R while viewing anim : Open Animation Adjust/Control Menu

Hold J : Touch Self

WASD+QE : Camera controls while viewing/controlling an animation and in Free-Cam mode

--- Debug Controls (Enable in Settings) ---

J with Debug : Select Self for Animation

G with Debug : Select target for animation
Hold G with Debug : Select summoned pal for animation

H with Debug : Clear selected animation targets
Hold H with Debug : start animation with selected targets

Shift+[ with Debug : Increase Sex Heat of targets

Shift+] with Debug : Decrease Sex Heat of targets

Requirements

• UniPalUI - https://spiritshard.com/?mode=gamemod&view=Palworld_UniPalUI
• UE4SS (Experimental Latest) - https://github.com/UE4SS-RE/RE-UE4SS/releases/tag/experimental-latest

How to install the SCake framework

Note : When SCake is installed and running, a notification will show up on the top left part of the game screen, saying it's either installed (title screen) or running (in-game). Use this to determine if the mod has been installed correctly.

• Install UE4SS, only the official UE4SS releases are supported (Custom forks may not work properly or cause your game to crash)
• Install UniPalUI and ensure it's working properly
• Extract the Sugar Cake archive and from inside the folder for your platform (Either Steam or XBox), copy the Pal folder info your palworld install (Should merge with the existing Pal folder)

[ + Ensure inside the UE4SS install, inside the "mods" folder, open the "mods.txt" and make sure "BPModLoaderMod" is set to 1 ] [ + If your game starts crashing after installing UE4SS, open the UE4SS-settings.ini file that is within the UE4SS install and set "bUseObjectArrayCache" to false, which may solve some crashing issues ]

• Note : Sugar Cake doesn't come with many animations, you'll want to install additional animation packs for a more complete experience

How to install animation packs

~ For .json installs ~

• Follow their provided instructions if they say where to install the .pak file, otherwise place this is in Pal/Content/Paks/~Mods
• Place the provided .json file in Pal/Content/Paks/~Mods/AnimConfig/
• Now it should load in-game the next time .json animations are registered! (Note : Animations may not register while on the title screen, load into a save to see animations register)