ryuka_labs-LuckOnKill icon

LuckOnKill

Gain Luck whenever an enemy dies in SULFUR. Fully compatible with Better Luck Control.

Last updated 2 days ago
Total downloads 23
Total rating 0 
Categories Mods
Dependency string ryuka_labs-LuckOnKill-1.0.2
Dependants 0 other packages depend on this package

This mod requires the following mods to function

BepInEx-BepInExPack-5.4.2100 icon
BepInEx-BepInExPack

BepInEx pack for Mono Unity games. Preconfigured and ready to use.

Preferred version: 5.4.2100

README

Luck On Kill

A Luck reward mod for SULFUR.

This mod gives the player Luck whenever an enemy dies.

By default, each enemy death grants one minute worth of Luck recovery, based on your current Stat_LuckGain.

Compatibility

Luck On Kill is fully compatible with Better Luck Control.

When both mods are installed:

  • Luck On Kill adds Luck when enemies die.
  • Better Luck Control can further modify that added Luck through its recovery multiplier, flat bonus, or override settings.
  • Both mods can be used together safely.

Example:

Luck On Kill adds +5 Luck
Better Luck Control has RecoveryMultiplier = 2
Final Luck gain becomes +10

If you do not want Better Luck Control to affect kill rewards, change this setting:

ApplyThroughModifyStatus = false

What it does

SULFUR has two internal Luck values:

  • Stat_LuckGain: Luck recovery amount per minute
  • Status_Luck: current stored Luck value

By default, SULFUR periodically adds Stat_LuckGain to Status_Luck once per minute.

Luck On Kill adds an extra Luck gain when an enemy dies.

Default behavior:

Enemy dies
-> Read current Stat_LuckGain
-> Add that amount to Status_Luck

Example:

Base Luck recovery = 3/min
Enemy death grants +3 Luck

Four-leaf Clover + Santa Hat = 5/min
Enemy death grants +5 Luck

Features

  • Gain Luck when enemies die
  • Reward is based on current Stat_LuckGain
  • Configure reward multiplier
  • Add a flat bonus to each kill reward
  • Override kill reward with a fixed value
  • Optional enemy filtering
  • Optional debug logging
  • Fully compatible with Better Luck Control

Configuration

After launching the game once with the mod installed, a config file will be generated:

BepInEx/config/kumo.sulfur.luck_on_kill.cfg

Settings

[General]
EnableMod = true

[Reward]
RewardMultiplier = 1
RewardFlatBonus = 0
RewardOverride = -1

[Compatibility]
ApplyThroughModifyStatus = true

[Filter]
RequireHostileToPlayer = true
RewardOnlyExperienceUnits = false
RewardCivilians = false
RewardBreakables = false

[Safety]
PreventDuplicateRewards = true

[Debug]
LogRewards = true

RewardMultiplier

Multiplier for Luck gained on enemy death.

The base reward is your current Stat_LuckGain.

Example:

RewardMultiplier = 2

If your current Luck recovery is 5/min, each enemy death grants:

5 * 2 = 10 Luck

RewardFlatBonus

Flat bonus added to each kill reward after multiplier.

Example:

RewardMultiplier = 1
RewardFlatBonus = 3

If your current Luck recovery is 5/min, each enemy death grants:

5 * 1 + 3 = 8 Luck

RewardOverride

If set to 0 or higher, this replaces the kill reward with a fixed value.

Example:

RewardOverride = 10

Each enemy death grants:

10 Luck

Set it to -1 to disable override mode.

ApplyThroughModifyStatus

Controls compatibility with other Luck mods.

Default:

ApplyThroughModifyStatus = true

This means Luck On Kill adds Luck through the game's normal Status_Luck modification method.

When Better Luck Control is also installed, Better Luck Control can modify this reward.

Example:

Luck On Kill reward = +5
Better Luck Control RecoveryMultiplier = 2
Final reward = +10

If set to false:

ApplyThroughModifyStatus = false

Luck On Kill directly sets the new Luck value, so Better Luck Control will not modify the kill reward.

Filters

RequireHostileToPlayer

Default:

RequireHostileToPlayer = true

Only hostile units grant Luck.

RewardOnlyExperienceUnits

Default:

RewardOnlyExperienceUnits = false

If true, only units with ExperienceOnKill greater than 0 grant Luck.

RewardCivilians

Default:

RewardCivilians = false

If true, civilian units can grant Luck.

RewardBreakables

Default:

RewardBreakables = false

If true, breakable objects can grant Luck.

Recommended: keep this false.

Recommended settings

Vanilla-style

RewardMultiplier = 1
RewardFlatBonus = 0
RewardOverride = -1
ApplyThroughModifyStatus = true

Stronger kill reward

RewardMultiplier = 2
RewardFlatBonus = 0
RewardOverride = -1
ApplyThroughModifyStatus = true

Fixed reward per enemy

RewardMultiplier = 1
RewardFlatBonus = 0
RewardOverride = 10
ApplyThroughModifyStatus = true

Installation

Install with a Thunderstore-compatible mod manager, or manually place the DLL into:

BepInEx/plugins/LuckOnKill/

Notes

This mod does not directly force enemies to drop items.

Instead, it adds to the game's existing Luck economy:

Enemy death -> stored Luck increases -> valuable loot can consume stored Luck

For configuring Luck recovery and Luck consumption, use the companion mod:

Better Luck Control

Changelog

1.0.0

  • Initial experimental release

1.0.1

  • Switched to Unit.Die-based enemy death detection
  • Improved duplicate reward prevention

1.0.2

  • Improved player Stats detection
  • Added fallback player lookup methods
  • Improved compatibility with Better Luck Control