General Introduction
Bathing in Skyrim is back from its figurative zombified state. This overdue update supersedes all previous incarnations. It is further amplified by a multitude of bug fixes for the contemporary modding scene. Imagine that!

BISR, or BiS 2.0, involves a comprehensive underlying overhaul not limited to script refactoring, cleaning, and optimizing. BISR is released under and forwards FOSS permissions.

Degenerates and voyeurs, germaphobes with a finer taste—this is the mod you've all been waiting for.




WASHABLE BLOOD - For the first time ever, wash your blood off with a bathing mod! This is not the same implementation as Jayserpa's Dirt & Blood and Just Blood. BISR uses an SPE function in the vein of PO3's Wash That Blood Off 2. Basically, we're removing the decal directly; there's no strict need for other mods and effect shaders.

DIRTIFUL DIRT - BISR bundles a 2k version of Zaki's amazing dirt overlays. Look your best, even with all that dirt on you. But don't stop there; get the higher resolution versions and UBE conversions from the links below!

CUSTOM ANIMATIONS - No need for extra downloads. BISR comes packaged with male animations by Tweens and female animations by BakaFactory and Krzp. And, should you desire it, BISR smartly detects and opens its interface for JVraven's excellent Malignis Bathing animations. Don't want to deal with animation injectors like FNIS? Fret not. BISR's vanilla-based bathing idles will work just fine.

UNIQUE SOAP - You can craft soap bars at a cooking pot using vanilla materials or buy them from general merchants with SkyPatcher. See LE's listing for recipes. Each soap type has its own benefits and reasons to use. If you don't want a strict dependency on soap, just clean yourself with an easily craftable linen wash rag.

AUTOMATIC FREECAM - Following other animation frameworks for Skyrim, BISR brings a first to bathing mods by including an auto freefly camera option. You'll be able to freely ogle your character whenever you bathe. This addition is merely one out of an expanded feature set!

SAFER UNDRESSING - Correctly-tagged equipment are filtered and removed safely via SPE functions. These native functions prevent any unwanted behavior in your game when BISR un-equips items from your character for animation events.

UNPARALLELED CUSTOMIZATION - Peek and tweak with a revamped MCM: Find full support for differentiated shower and bathing animations; Define your own animation frequencies; Separate follower and player animation settings; Choose what you want unequipped when bathing, down to the single individual slot. It's all up to you.

FULL FOLLOWER SUPPORT - Your followers will bathe with you if they have a soap bar or wash rag in their inventory. You can enable dirt tracking per actor. You can also initiate dialogue with followers via an immersive dialogue prompt. Remember: Bathing is always better with the family!

FASTER SCRIPT EXECUTIONS - A versatile use of PapyrusUtil, PO3's Papyrus Extender, and Scrab's Papyrus Extender allows BISR to execute its functions with high efficacy without compromising on performance, features, and stability. Out of the box, BISR affords you a higher limit than ever before.

INCREDIBLE COMPATIBILITY - BISR uses PO3's Papyrus Extender and, optionally, either of Loki's Wade in Water or Sink or Swim to detect your submergence states. The installer includes patches that use Description Framework for item descriptions and SkyPatcher for leveledlist additions. Furthermore, BISR bundles integration support for the following mods: Devious Devices, FadeTattoos, FrostFall, OCum Ascended, OStim Standalone, Pee & Fart, and SexLab Framework. See below for further compatibility notes.



BiS is the ol' reliable player-focused bathing mod with debilitating dirt effects. Yes, other bathing mods on the market boasted instead with simplicity and/or performance. And, those that released in the era of Skyrim SE/AE leveraged modern affordances from the ground-up in mod creation. Caiglee uploaded a BiS SE conversion in 2019, with most patches arriving and ending around 2021. Still, where vanilla BiS maintained its niche is in soap buffs and dirt incremental debuffs, but it also has a specific niche through inherited familiarity. Thanks to these benefits, we can allow BISR a coexistence on the modern stage.

BISR grants you my authorial contributions and a subset of integration capabilities that other bathing mods lack. BISR further improves processing speed and implements player-centric feature parities with its peers. Modern dependencies allow BISR to offer more for less. BISR may even be superior to SE mods that have yet to use the same exposed functions. Besides some removed survival integrations in exchange, this version of BiS can only be superior for prospective, present, and past BiS users. For these users, there's zero reason not to use BISR for your next playthrough.

Breaking Changes

• ESL-flagged, ESPFE.
  
  • Mods or patches that depend on BiS Unofficial Conversion's 1.43 Form IDs are not compatible and will need to be updated.
    
• Removed interfaces with Realistic Needs and Diseases, iNeed, Zaz Animation Pack, and FISS.
• Changed dirt textures to apply via Racemenu.
  
  • Previously, default textures apply via an interchangeable pair: "DirtFX.dds", "FilthFX.dds".
  • BISR uses a default set of four textures: "DirtFXBody.dds", "DirtFXHands.dds", "DirtFXFeet.dds", "DirtFXFace.dds".
    
• Changed dirt texture default location from parent folder to "Set1" folder.
  

BISR should not be installed on playthroughs already running BiS and its line of tweaks. Texture files can be renamed, but mods depending on Form IDs and script properties should be assumed incompatible unless specifically made for BISR. Be aware that some mods not directly adapted into BISR may still have been rendered redundant.

Adapted Contributions
The following patches were adapted into BISR. They are not used verbatim, and are incompatible with BISR.

• Bathing in Skyrim - Tweaked by Monoman1
• Bathing in Skyrim - Improved Animations by SavageDomain
• Bathing in Skyrim - Haz Improved Water Detection by Hazarduss
• Bathing in Skyrim - Male Animations by Tweens
• Bathing in Skyrim - Seamless Soap Texture by Xtudo
• Baka Misc Motions - Bathing Animation Replacer by BakaFactory
  

Highlighted Differences (compared to all predecessors; not exhaustive)

• General Feature Improvements
  
  • Improve water detection via PO3E functions. Now speedy. No need for water patches!
  • Improve waterfall detection via Haz's method. Higher efficacy.
  • Improve compatibility with SexLab, Devious Devices.
  • Improve bathing animations and animation randomization.
  • Apply dirt textures via Racemenu overlays specific to each body part.
    
• Quality-of-Life Adjustments
  
  • Prevent BiS from closing Inventory Menu unless the player actually begins bathing.
  • Prevent erroneous bathing attempts while player is underwater or swimming.
  • Simplify MCM options for end-user clarity.
  • Disallow wash rag from robbing the actor of any still-valid soap bonuses and increasing their dirt level under certain conditions.
  • Save settings with PapyrusUtil.
    
• Bug Fixes
  
  • Fix control freeze after showering with Baka's animations.
  • Fix de-sync between bathe quest and wash animation spell papyrus threads.
  • Fix possible missing Dirt Accumulation spell on new character creation, which required a restart via the MCM.
  • Fix dialogue conditions.
  • Fix float inaccuracy when assigning slotmask for equipment removal.
    

Strictly for BISR's purposes, "updating" refers to exchanging one version of a mod for a newer version. Meanwhile, "upgrading" refers to the act of updating objects that a save file is dependent on. Mod Versions are updated whereas Save Files are upgraded as a result of said update.

Upgrading save files from mzin's BiS (1.0) to BISR (2.0) is not recommended and will not be supported.

Upgrading save files from any past version of BISR requires an in-game restart via the MCM in most cases. This mod makes use of MGEF (Magic Effect) scripts that are cached by your game. Quest scripts aren't comparatively as baked-in, for reference. Properties and functions related to BISR's MGEF scripts must be flushed for version updates to action new changes.

This mod uses Semantic Versioning. Mod authors should pay attention to API differences between minor versions.



Hard Dependencies

• PapyrusUtil
• PO3's Papyrus Extender
• RaceMenu
• Scrab's Papyrus Extender
  

Soft Dependencies

• Description Framework
• Fuz Ro D'oh
• Pandora Behaviour Engine Plus (or Nemesis or FNIS)
• SkyPatcher
  

Situational Dependency

• Backported Extended ESL Support (if game version < 1130)
  

Animation Packs

• Malignis Animations
  

Texture Packs

• Zaki 8K-4K Dirt Overlays (BHUNP)
• Zaki 8K-4K Dirt Overlays (CBBE 3BA)
• Zaki 8K-4K Dirt Overlays (UBE)
  

FAQ
"Blood? But I need more blood!" — Don't worry. BISR is compatible with Enhanced Blood Textures, Just Blood, and Wash That Blood Off 2. In fact, BISR washes off both EBT and vanilla decals, neither of which any other bathing mod can do without SPE.

"Can I use this mod with my other bathing mod?" — You can certainly choose to use BISR with mods like Dirt & Blood and Keep it Clean. However, our mods will be competing for attention and duplicating dirt application. Our mods each have their own benefits - I suggest you consider the pros and cons of your options before disregarding any one bathing mod for extraneous reasons. Alternatively, disable those mods' dirt functions to allow BISR priority.

"I'm passive and need your opinion." — Do you want to say hello to actual good-looking dirt? Do you want to say goodbye to redundant water patches? Do you want everything in the feature list above, all of which are unique to BISR? Me thinks you won't find anything better than BISR at the time of this posting.

"How does BISR detect water?" — Most native functions take only a split-second to return, which is why papyrus extenders are popular and used where possible. There is no better script-based method to detect water than through IsActorInWater(). In the event this function fails, however, BISR can use Wade in Water or Sink or Swim as a fallback. If one of these mods is installed, my mod checks if you have a slowness effect active while not swimming.

"So... Do I need a water patch?" — No.

"How lightweight is this mod?" — About as lightweight as it can get. BISR uses native functions where possible. More heavyweight functions of a quest-and-papyrus mix run only when necessary. BISR doesn't use any method particularly foreign compared to peer mods, but nonetheless endeavors to distribute its functions over multiple threads without overloading your virtual memory. In reality, the worry of script bottlenecks is largely irrelevant in SE because of how the updated engine handles papyrus threads. And this benefit is on top of Engine Fixes and Papyrus Tweaks.

"Can you include integration with [x] mod?" — Maybe, if you ask nicely. But limiting certain types of integration support means a simpler SDK and a lower chance of compatibility issues from conflicting files within said SDK. If you've got the knack for scripting, you're free to publish your own patch for BISR.

Note for Mod Authors
Scripts are governed by GNU GPL. All other assets not contributed or changed by me, if not unlicensed FOSS, may be affected by additional permission requirements. Consequently, the release package is governed by its own permissive guidelines; please see file credits for more information. Regardless, by independently releasing BISR or a BISR-related file in any degree, modified or not, you accept full responsibility over any resulting issues, legal, technical, or otherwise.

Artists, your files must follow BISR's new file directories and naming schemes. Coders, please pay careful attention to where BISR's script interface differs from predecessors.