Sugar Cake Animation Framework - Palworld Sex and Stats Framework

Created and Maintained by : Michael aka "Spirit Shard"

Discord - The Broken Chatbox - https://discord.gg/h3vB7S4FEw
Website - https://www.spiritshard.com/
v (Donations! =^-^=) v
SubscribeStar - https://subscribestar.adult/michaelpstanich

---

What is Sugar Cake? (SCake for short)

Sugar Cake Animation Framework is a sex animation and gameplay 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 ^.-) as well as several gameplay oriented features which other modders can hook and replace for more dynamic systems.

< - > Self Promotion < - >

I'm never really great at asking for donations, but if you never mention it people may not even know about it! So here I am, letting you know I have a SubscribeStar! - https://subscribestar.adult/michaelpstanich (SCake is completely free with no paywalls, but Subscribers do get a special role on Discord and other benefits regarding other projects of mine!) If you can't help support the project financially, that's ok! I appreciate any little bit of help, whether that's just in giving feedback and bug reports, or by just sending a politely worded message!

---

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://spiritshard.com/?mode=gamemod&view=Palworld_UniPalUI)

Sugar Cake 0.6.19 TEST Changed the JSON Config format to SCML's 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!

---

Framework 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!

Palicious!

• Sugar Cake comes with a built-in gameplay module called Palicious! All gameplay affecting features are completely optional and disabled by default. Better yet, other modders can hook and even fully replace these systems for maximum capabilities!
• Radiant Experience : Grants EXP surrounding Erotic Scenes!
• Combat Submission : Offers chances for Erotic Scenes within combat with new Stability mechanic for the player. Combat Submission works for both the player, NPCs, and Pals!~
• Lustful Engagements : Adds ways to start scenes by taking certain actions or for reaching certain stat values. Start a solo Scene and maybe a pal will notice...
• And more...!

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)

No Generative AI!
Sugar Cake and its first party dependencies contain no AI Generated code or assets! Sugar Cake is created with Human Skill and Creativity, to help other Humans express their Skill and Creativity! This also applies to the included animations, we make them 'the old fashioned way' with custom animation rigs and set-ups in Blender!~ (Though I wish I could afford a motion tracking setup... Q.Q)

---

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 Options" which can be enabled in Sugar Cake's settings)

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)

---

How to add and create animation packs

For a full guide you can read it over on my website at https://spiritshard.com/?mode=article&view=2024-03-27_SCake_HowToMakeAnimsGuide or follow the links on our Discord!

To add more animations you just need to (correctly) import the animations into UE5.1 with the correct file path (Content/Mods/YourModName), convert the animation into an animation montage (right click the animation sequence and it will show up in that list), ensure you do what ever edits are required for your montage/animation to look and function correctly (Remember for looping animations to open your montage, go to the "montage sections" tab, and tickmark where it should loop! If you have no sections, just click the 'default' checkbox and it will loop the full animation.).

Once you have the animation montage you can export the .pak file and place it in ~mods, note the file-paths you had in UE5.1 as we'll need these to register the animation properly.
Open the appropriate templates provided in the AnimJSON folder from SCake and enter in the correct metadata for your animation, delete any sections/data you're not using for your animation. (Note: You can check the "Sugar Cake - Metadata.txt" provided with SCake for a description of the parameters, the "_SCake_TemplateWithExplanations.json" has sections explaining each parameter and may be a good place to start reading while using other .json files as a reference to create your own)

With your .json file complete, rename it to match your pack name and include it with your .pak when distributing your animation pack! I recommend testing the pack before distribution, so install it like any other pack by placing the .json file to the AnimJSON folder and adding the file name to the "_loadlist.json" file, then load up in-game and trigger the animations.

---

Permissions / Usage Rights

These Permissions and Usage Rights apply to all content related to the Sugar Cake Animation Framework, whether made by a first or third party.

All content must be provided free of charge, with no paywalls or exchange requirements

• No paywalls, paid early access, subscription requirements, restricted access, premium versions, etc.
• Does not apply to source files used in the creation process not required for full and expected functionality

Configuration/External files are freely available with no restrictions on edits or distribution

• Everyone is allowed to discuss, customize/edit, share, distribute/re-distribute, re-use any and all configuration files provided by any mod or user
• Everyone is allowed to reference any asset from any mod, package, or asset without restriction or retaliation
• This also applies to any templates or files that interact with the Sugar Cake Animation Framework provided by any mod or user
• Applies regardless of format/extensions/method

Do not intentionally sabotage or perform malicious behavior

• Do not intentionally cause a user's save to break, user's game to brick, crash, or other malicious actions
• Do not intentionally cause another mod to stop functioning or overwrite their author information without permission
• Do not include or hide content, without warning, which may be harmful

As a recommendation, please clearly label your content with descriptive names, tags, and IDs while separating different fetish content into different configuration files. This will allow users to customize what they see and interact with during the installation process and will prevent you from accidentally (or intentionally) hiding content which may cause psychological harm. Please be considerate of others in the community and how they may want to use your pack, not everyone will find a sudden surprise animation to be all that pleasant!

---

Questions and Answers (FAQ)

Question : I installed everything and it doesn't work!
Answer : Install everything PROPERLY and it'll work! Read the install section carefully and follow things step by step, copying files isn't complicated! Also make sure you're not using Vortex mod manager, it can break your install and doesn't install mods like SCake properly!

Question : Does SCake work in Multiplayer?
Answer : Mostly, though things can be buggy! Use SCake only in consenting multiplayer servers/sessions! (Using SCake while joining a server without SCake support may cause issues)

---

Want to implement more animations? Feel free to contact me or interact with our Discord! We're a community thriving on creativity and would be really glad to help!