needle swapper

A small mod that allows you to change which Needle upgrade Hornet uses.

why?

i want to be able to downgrade my needle so bosses don't die so quickly!

(e.g. cleaning up optional bosses, Godhome)

how?

• with the Needle selected in the Inventory menu:
  • use the Sprint input (default: c; use the Attack input on controller) to "downgrade" the needle
  • use the Jump input (default: z; equivalent on controller) to "upgrade" the needle

• ranges from the following (from downgraded to upgraded):
  • unmodded needle (i.e. what you have without the mod) ← default setting
  • needle
  • sharpened needle
  • shining needle
  • hivesteel needle
  • pale steel needle

• "downgrading" all the way uses your default needle upgrade
• by default, you cannot "upgrade" past your current max upgrade level
  • e.g. if you've upgraded to Shining Needle via the Pinmaster (i.e. vanilla), you'll be capped at Shining Needle until you obtain Hivesteel Needle via the Pinmaster
    • it (should!) be safe to upgrade your needle as if this was not installed
      • e.g. if you have Hivesteel Needle but are using Sharpened Needle via the mod, Pinmaster will still unlock the Pale Steel Needle when you give him Pale Oil
  • the mod's internal tracker can still increase to the last possible upgrade, so you may need to hit the "downgrade" input multiple times to see a change
    • e.g. if you're capped at Shining Needle but have spammed "upgrade", you may need to "downgrade" multiple times before Shining Needle becomes Sharpened Needle
    • this is because the targetNeedleUpgradeLevel is shared across save files
  • you can remove this limit by setting the config option allowTargetAboveUpgradedLevel to true

• only modifies the inventory appearance and damage calculations
  • i.e. doesn't (shouldn't) affect completion percentage / game progression; non-permanent
  • note: damage calculation is complicated in Silksong because needle damage is multiplied by enemy-specific modifiers dependent on which needle upgrade you have

• this mod should be safe to install and uninstall without affecting your save file at all
  • however, you should always make a backup of your save files, just in case
  • testing was conducted, but i am only one person

issues? questions? fixes?

• open an issue on the GitHub repository!
  • bug reports
  • suggestions (e.g. README readability)

known issues

• the "Transform" button prompt for "downgrading" the needle does not update properly if switching between gamepad and keyboard
  • help needed! — open an issue on the GitHub repository if you have any info!
• the following error message will be logged when the Inventory menu is initialised:

  [Error  : Unity Log] NullReferenceException: Object reference not set to an instance of an object
  Stack trace:
  InventoryItemButtonPromptBase`1[TData].OnEnable () (at <9d3c4ed299074c2e91377d5f75e5a0ec>:0)
  UnityEngine.GameObject:AddComponent()
  PaleOilSoap.UX:InventoryItemNail_Start(InventoryItemNail)
  InventoryItemNail:DMD<InventoryItemNail::Start>(InventoryItemNail)
  

  • this is safe to ignore but there doesn't seem to be an elegant solution to avoid emitting this error

todo

• only allow at bench
  • can copy global::InventoryItemToolManager.CanChangeEquips
    • but how implement sit at bench prompt?
  • is this even desirable/necessary?