sex framework [Mod]Sugar Cake Animation Framework (SCake) [Animation and Stat Framework]

[Spirit_Shard]

View File

Sugar Cake Animation Framework (SCake) [Animation and Stat Framework]

---

(_) Sugar Cake Animation Framework - Palworld Sex and Stats Framework (_)

 

Created and Maintained by : Michael "Spirit Shard" Stanich

Discord - The Broken Chatbox - https://discord.gg/h3vB7S4FEw
Website - https://www.michaelpstanich.com/

TBC Thread - https://forum.thebrokenchatbox.com/d/26-project-sugar-cake-scake-palworld-mod

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 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 ^.-).

 

 

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

 

 

 

(_) Notice! (_)

 

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 DEV 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, so UniPalUI must be installed to use keybinds and the menu!

 

With the default bindings for UniPalUI v0.1DEV, use Shift+Y to open the menu and select "Project Sugar Cake" 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 (Use Shift+K to start viewing a non-player involved anim)

 

J : Touch Self

 

--- 
Debug Controls

(Currently enabled by default)

---

J with Debug : Select Self for Animation
Hold J with Debug : Touch Self

 

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

 

 

 

(_) How to install the SCake framework (_)

 

Note : When SCake is installed and running, a notification will show up on the 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.

 

- Download both Sugar Cake Animation Framework and UniPalUI, then unzip the archives and from inside the folder for your platform, copy LogicMods and ~mods folder into "[Palworld Install]/Pal/Content/Paks"

 

- In the ~mods folder, enter the "AnimJSON" folder and run the "__Create_Load_List__.bat" file to auto-fill the load list (You'll need to run this any time you install new animation .json files)

 

[ + If the .bat file fails to run or says "Access Denied" you can try moving the entire AnimJSON folder to your desktop, running the .bat file, then placing it back. Remember to check if it actually filled the _LoadList.json with the .json names. If it still failed you'll just have to enter in the .json file name for each animation pack you have installed manually into the _LoadList.json in JSON format (so like "AnimPak1","AnimPak2","","" ect, use https://jsoneditoronline.org/ to help with formatting). ]

 

- Install the proper version of UE4SS (Latest version with updated Palworld) - https://github.com/UE4SS-RE/RE-UE4SS

 

[ + Ensure inside the UE4SS install, inside the "mods" folder, open the "mod.txt" and make sure "BPModLoaderMod" is set to 1 ]

 

[ + If your game starts crashing after installed UE4SS, open the UE4SS-settings.ini file that is within the UE4SS install and set "bUseObjectArrayCache" to false ]

 

[Optional, sort of]
- Must install animation packs (Detailed below)

 

- Remember to run the "__Create_Load_List__.bat" file every time you install new animations with .json files! (If the .bat file doesn't run, you can enter the .json file names for animations you want to load in-game manually into the _LoadList.json file)

 

 

 

(_) 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/AnimJSON/" and run the "__Create_Load_List__.bat" in the same folder (if the .bat isn't working for you, you can enter in the names of the .json files manually instead, can also try moving the AnimJSON folder to the desktop before running the .bat then moving it back)

 

- Now it should load in-game the next time .json animations are registered!

 

 

 

(_) How to add and create animation packs (_)

 

For a full guide you can read it over on my website at https://www.michaelpstanich.com/article/SCake_HowToMakeAnimsGuide.html 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_TemplateWithExplainations.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 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 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 : Not yet, in a peer-to-peer game you can have the host start animations but no other player will see or be able to start animations. If you want to play multiplayer with SCake you'll have to wait for multiplayer to be properly supported! (join the discord and listen in for when we're doing multiplayer tests if you want to help out!)

 

 

 

(_) 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! (_)

 

 

 

 > - > - > - > - < - < - < - <

 

 

Some links to Animation Paks on LoversLab! (These are some I know about, if more show up please let me know!)

Lemonlord's Animation Pack

 

Lurker's Animation Pack

 

TemTemLover's Animations

 

 

Spirit's SCake Animations

 

 

You can find more animations over on our Discord (There's a couple of in-progress animation packs, so they may not have been posted elsewhere yet!) and more across LoversLab!

 

Thank you everyone for being awesome and making great stuff! Hopefully more can join us in our creatively lewd adventure and make more awesome Palworld content!

---

• Submitter
  Spirit_Shard
• Submitted
  04/14/2024
• Category
  Palworld

 

[Encon4]

wow, this is getting shaped sooner than expected.

there's already a good chunk of content. really nice!

[Mizunose]

This is great! It works perfectly, Loving everything so far!!
One question though. Is there any chance this framework gets converted to work with Mod Organizer 2?

[Spirit_Shard]

3 minutes ago, Mizunose said:

This is great! It works perfectly, Loving everything so far!!
One question though. Is there any chance this framework gets converted to work with Mod Organizer 2?

Didn't know MO2 properly supported Palworld (I exclusively use MO2 for Skyrim lol). I'm unfamiliar with the requirements there, is there a guide or How-To somewhere for supporting different games?

[Mizunose]

1 hour ago, Spirit_Shard said:

Didn't know MO2 properly supported Palworld (I exclusively use MO2 for Skyrim lol). I'm unfamiliar with the requirements there, is there a guide or How-To somewhere for supporting different games?

I'm not too sure. Honestly I too enjoy MO2 so just assumed it wasn't being used for it. hopefully Mod Organizer 2 Devs will also allow Palworld compatibility for it.

[beanman2122]

UE4SS seems to crash my game each time I try launching a world.

[PrimoSensei]

UE4SS did the exact same thing to me it just kept crashing. I eventually just got rid of it and only used Pak files and that's worked so far but it's really limiting what I can do I'd wanna know if anyone had similar problems and managed to fix it?

[TemtemLover]

5 hours ago, beanman2122 said:

UE4SS seems to crash my game each time I try launching a world.

 

3 hours ago, PrimoSensei said:

UE4SS did the exact same thing to me it just kept crashing. I eventually just got rid of it and only used Pak files and that's worked so far but it's really limiting what I can do I'd wanna know if anyone had similar problems and managed to fix it?

> \Palworld\Pal\Binaries\Win64

> UE4SS-settings.ini

bUseUObjectArrayCache = false;

Change from true to false.

[~♥~Lith~♥~]

getting "failed to load jason" message. 

[TemtemLover]

4 hours ago, ~♥~Lith~♥~ said:

getting "failed to load jason" message. 

Do you still have the 190+ animations loaded? If yes then
Redownload my anim pack if you used all in one install, there was a type in json. Or open the _loadList.json and fix it yourself.

 

If not, then make sure the _LoadList.json is located in `Content\Paks\~mods\AnimJSON`

Edited April 16, 2024 by TemtemLover

[beanman2122]

9 hours ago, TemtemLover said:

 

> \Palworld\Pal\Binaries\Win64

> UE4SS-settings.ini

bUseUObjectArrayCache = false;

Change from true to false.

That worked, thanks.

[bmt12354]

Hi, I must be having a brain fart. How do we fuck?

 

[VAAlucard]

All I have to say is keep up the great work. I'm glad that there is final a framework being curated for this game. I have an idea for a plugin to work on once this progresses a bit further and once I figure out how to possibly add zones(cells) that would essentially be breeding dens that the player could consensually enter for either work or to have any captured pals/humans work at (which I would essentially consider to be con/non-con considering that captured pal or human willingly listen to the player).

[Jaysteyner]

hello for me nothing works from the mod i did all the steps put all the files in the listed places but nothing in my world changed not even the listed inputs.is there a possible program i need to use this mod? is so can someone tell me if not im not sure what the problem is i dont use mods very much so all of this is still new to me

 

[Jaysteyner]

got no clue how any of this is meant to work

[Adraya]

On 4/22/2024 at 4:27 PM, Jaysteyner said:

got no clue how any of this is meant to work

Seconded. I THINK I installed everything correctly, though I find it odd how small the downloaded files were given what they contain. As far as I know it's all installed right, but no key (I think it said 'u' up above, opens any menu.

[dracometeo]

6 hours ago, Adraya said:

Seconded. I THINK I installed everything correctly, though I find it odd how small the downloaded files were given what they contain. As far as I know it's all installed right, but no key (I think it said 'u' up above, opens any menu.

Did you download an UE4SS and put it to your \Pal\Binaries\Win64\ or \Pal\Binaries\WinGDK\ folder?

[ThatFennecGuy]

On 4/22/2024 at 3:40 PM, Jaysteyner said:

hello for me nothing works from the mod i did all the steps put all the files in the listed places but nothing in my world changed not even the listed inputs.is there a possible program i need to use this mod? is so can someone tell me if not im not sure what the problem is i dont use mods very much so all of this is still new to me

 

If you go to Spirit Shard's discord, you can get help much more quickly. He's very active there.

[ant_9484]

let me know when there is M human on F pals animations.

[Adraya]

15 hours ago, dracometeo said:

Did you download an UE4SS and put it to your \Pal\Binaries\Win64\ or \Pal\Binaries\WinGDK\ folder?

Mmhmm, it's there, unless other mods conflict with it. I'll try disabling everything else and try again soon. ((The other mods work, so I know UE4SS is installed right)

[Spirit_Shard]

New update for Project Sugar Cake 0.2 DEV is up with a ton of additions! Blazed through a ton of stuff and did way more than initially intended, but that's defiantly a good thing here!

 

!!! IMPORTANT NOTICE !!!

This update changed the .json format for importing animations! Make sure to update all your packs! (I know the updated .json files are already updated on our Discord) There were some changes I had the opportunity to make to both optimize the JSON files while also making it a bit easier for people to format and use them, so I took the chance while there's not much out there to download yet. This should mean we don't have to break anything later as we can have backwards compatibility stuff set up if necessary, but this change was fundamental enough it required the change.

 

SubscribeStar Post - https://subscribestar.adult/posts/1268560

 

General Announcement

"

Some major changes made it into this update thanks to some fun discoveries. Let’s start with the first major change, the .json format has been updated and old .json files will fail to load so they need to be updated (I’ll be distributing my own updated .json files and have even updated the old ScakeBasics pak specifically for this, since I haven’t gotten the new animation back going yet). I’ve already spoken with those I know of who’ve made animation packs available so this isn’t ‘sudden’ or unexpected (I even asked for feedback on the changes! ^-^) and they should be updating their packs officially when they can.

Ok, so quickly, let’s run down the new major features list, Persistence is figured out! So now SCake creates save files in the .json format within the AnimJSON folder, which was the main feature planned for this update. Inside the AnimJSON folder of the install is a new “__Create_Load_List__.bat” file that automatically fills the _LoadList.json so you can just run this and no longer need to manually fill the list (hoping this reduces people being confused by a good amount, but probably not X.x). New custom stat tracking system is fully in-place with new methods allowing tracking of characters that are not even active in-game. New “Sexual Heat” system, heat builds up over time and makes characters aroused with affect on sexual pleasure during erotic animations, toggles between rising and falling depending on recent activities, such as having an orgasm will switch heat to begin resetting back to zero. Support for Morph Targets which integrates into the new Heat system; this requires models to support it but if a Morph Target on the mesh is called “Aroused” then SCake will automatically change that Morph Target depending on Heat and for Animation Events. Added a new animation progression mode, “Pleasure Progression Mode” allows animations to progress through stages depending on the average Sexual Pleasure of participants! I also quickly added the changing of eyes/mouths displayed on pals during Animation Events! Quite a hefty update!

"

 

 

On 4/19/2024 at 2:12 PM, VAAlucard said:

..once I figure out how to possibly add zones(cells) that would essentially be breeding dens that the player could consensually enter for either work or to have any captured pals/humans work at (which I would essentially consider to be con/non-con considering that captured pal or human willingly listen to the player).

 

Sounds interesting, looking forward to see what you make! SCake does have a working SDK/API that allows a decent amount of stuff already and I'm taking requests on what to add to it. If there's anything you may need in there let me know! ^-^

 

 

13 hours ago, ant_9484 said:

let me know when there is M human on F pals animations.

https://www.loverslab.com/files/file/33129-scake-pack-temtemlovers-animations-mesh-pack/

[beesilver]

when i go to run __Create_Load_List__.bat its says "access is denied"

 

_LoadList.json created at C:\Program Files (x86)\Steam\steamapps\common\Palworld\Pal\Content\Paks\~mods\AnimJSON\\_LoadList.json
Press any key to continue

 

did i do something wrong?

[TemtemLover]

Just now, beesilver said:

when i go to run __Create_Load_List__.bat its says "access is denied"

 

_LoadList.json created at C:\Program Files (x86)\Steam\steamapps\common\Palworld\Pal\Content\Paks\~mods\AnimJSON\\_LoadList.json
Press any key to continue

 

did i do something wrong?

yeaah, since you are using that folder, it is likely locked by admin rights..
This is the concerns I had with bat files lol

 

Rightclick bat file and launch with admin rights.

[Adraya]

EDIT Update fixeed most of the issues, but now during the animations, I'm not noticing any model swapping? My poor direwolf is a ken doll =(

Edited April 25, 2024 by Adraya

[TemtemLover]

1 hour ago, Adraya said:

EDIT Update fixeed most of the issues, but now during the animations, I'm not noticing any model swapping? My poor direwolf is a ken doll =(

models dont swap during animations, nor SCake even does anything about that in terms of meshes.

 

Check if you have OK installed properly if you are using my meshpack.

Edited April 25, 2024 by TemtemLover