About This File
OStimLab - OStim to Sexlab Event Bridge
OStimLab acts as an Event Bridge from the OStim API to the Sexlab Animation Framework. It recieves events from the OStim API, and Forwards those events to Sexlab with a Dummy Sexlab State for Sexlab based mods to consume.
This Makes it possible for Sexlab based mods to react to OStim scenes without a requiring a patch.
Some examples of The types of things that this can be used for:
- Have Wet Function Redux apply Wet effects during OStim Scenes
- Use Spank That Ass to add additional Flavor and sound effects during OStim Scenes
- Decrease your Willpower in Devious Followers from being in an Agressive OStim scene.
THIS IS AN EARLY RELEASE. SAVE OFTEN.
Due to the nature of this mod, which spoofs and interacts with internal Sexlab state, its very possible for it to cause havok in certain mods. I am hoping to start getting some people to use this in there setup to catch any mods that explode from the sexlab state that OStimLab spoofs.
Requirements
Installation
Just install like any other mod
UnInstallation
Shouldnt require any additional steps beyond removing from your load order
Configuration
Within the MCM menu you can Enable/Disable Specific Events to be broadcast.
By default it will Broadcast on Animation Start/End and Orgasm (both SLSO and non-slso supported)
This seems to be what the majority of mods react too, But I also added the option for on AnimationChange (But off by default)
How Does It Work
When an OStim scene begins, a new Sexlab thread is created and populated with relevant information from OStim (Actors, Aggressive, etc...) This Thread is then kept in a
"making" state during the duration of OStim Scene. This means that Sexlab will not process the thread and attempt to do animations on the involved actors, however Mods that query sexlab for actor/scene state are able to do that and use that information.
As an OStim scene progresses, OStimLab keeps track of what Actions are performed and mantains a "Transient" animation associated with the dummy sexlab thread that contains the tags of performed actions. I pasted the mapping below as far as what Tags are Populated on the sexlab thread.
This means when an orgasm occurs or the scene ends, the Animation in Sexlab has all the tags that occured within the scene, so that mods can know what occured.
When an OStim scene ends, the thread and transient animation is stopped and will shortly be cleaned up.
Potential Issues / Things To Be Worked On
Sexlab is a mighty beast, and I may not be populating certain parts of state that certain mods rely on. In that case I would need to update OStimLab to ensure that state is properly populated.
The internal Excitment system is not properly handled. It is fairly complicated, expecially with SexLab Separate Orgasm making a lot of changes to how that system works, so there might be some funkyness with mods that rely on that data. I will need to spend some more time Thinking about best way to handle that.
Tags are accumulated throughout an OStim scene. That means if you do Oral, Vaginal, and Anal, the resulting Sexlab anim will have all those tags, which might confuse some mods/leave unexpected results.
Any mods that integrate with both Sexlab and OStim will recieve both events. So for ex. If a Pregnancy mod is listening to both, you could theoretically have twice the likely hood of getting pregnant as its running checks twice, once for ostim and once for sexlab. Its best to disable the OStim integration within that mod so it will only recieve the spoofed sexlab events.
When an OStim Scene Ends, I make a request to the Sexlab Stats system to update the internal stats (ie. sex journal), but may be missing certain features (like excitement/relation) which may cause unexpected behavior with mods that use those fields.
What Information im hoping to gather
Due to the nature of this mod, Its difficult to plan for every way a mod can use Sexlab Events, so it would help a ton for people who care about this to share their load order and if they run into any issues with certain mods not properly responding to ostim scenes. This way I can prioritize the mods people who are using this are actually using.
For OArousal/SL Arousal support please use my OSL Arousal framework which is backwards compatible with both arousal mods, and is a native solution to bridging OStim and SexLab
Thanks For anyone who checks this out. Hopefully other people can find this useful.
Edited by ozooma10
