[Mod Request] -> Prison Escape Mod Script

[Snakeman33]

Hey everyone,

I tried creating a script for a mod on my own, but I gave up since I’m still a beginner at modding. I’d love some help or collaboration!

The Idea

The goal is to create a simple mod where, if your character gets imprisoned (specifically in Act 1 or Act 3), they will be forced into a kneeling position with their hands cuffed.

• The script will trigger an automatic rescue throw.
• If the throw succeeds, the character is freed.
• If it fails, they remain in the restrained position and either:
  • Try another rescue throw after a certain amount of time.
  • Rely on their companions to break them out.

What I’ve Found So Far

• No custom animations or conditions are needed—everything required for this mod already exists in the game.
• There’s a status condition called "shackled", which can be applied using bg3se. It automatically plays the animation, removes control, etc.
  • This can be done with:
    ApplyStatus(GetHostCharacter(), "GOB_GOBLINPRIEST_CHAINS", -1)
• There's an Osiris query called QRY_CRIME_Prison_IsInAnyPrison that checks whether a character is in prison. More details can be found here:
  IsInAnyPrison

Where I’m Stuck

• I don’t know how to actually write the script and turn it into a working mod.
• I haven’t figured out how to implement the dice roll for the rescue throw. The only reference I found is this:
  data "Boosts" "AbilityFailedSavingThrow(Strength);AbilityFailedSavingThrow(Dexterity);CriticalHit(AttackTarget,Success,Always,3);CriticalHit(AttackTarget,Failure,Never,3);Advantage(AttackTarget);ActionResourceBlock(Movement);DetectDisturbancesBlock(true);" data "RemoveConditions" "SavingThrow(Ability.Wisdom, SourceSpellDC())"

  See here
  But I don’t understand how to apply this to my idea.

Looking for Help!

If anyone is experienced with modding and can either make this mod or guide me through it, I’d be really grateful! I’d love to work on this together if possible.

Hope to hear from someone soon—thanks in advance!

Have a great day!