You are viewing a potentially older version of this package. View all versions.
alexkiri-BackgroundBlurImproved-0.7.8 icon

BackgroundBlurImproved

Improves the quality of the blurred background, allows some customizations

Date uploaded 7 months ago
Version 0.7.8
Download link alexkiri-BackgroundBlurImproved-0.7.8.zip
Downloads 3030
Dependency string alexkiri-BackgroundBlurImproved-0.7.8

This mod requires the following mods to function

BepInEx-BepInExPack_Silksong-5.4.2304 icon
BepInEx-BepInExPack_Silksong

BepInEx modloader. Preconfigured and ready to use.

Preferred version: 5.4.2304
silksong_modding-ModMenu-0.7.4 icon
silksong_modding-ModMenu

API for extending Silksong Menus

Preferred version: 0.7.4

README

Background Blur Improved

A mod for Hollow Knight: Silksong that improves the quality of the blurred background, and allows some customizations.

Features

The game natively renders the background at a fixed 360p resolution. While this isn't very obvious because of the blur effect applied on top, it is noticeable and distracting when in motion, it appear flickery, as can be seen below:

Before:

https://github.com/user-attachments/assets/83eef05f-16b2-497f-8402-fe771f915fc8

After:

https://github.com/user-attachments/assets/aebc2904-8367-448e-a53f-d6d412184327

Image comparison:

https://imgsli.com/NDIyNDYx/0/2

This mod allows adjusting the blur effect by:

  • increasing the resolution
  • increasing the intensity
  • disabling the effect completely

Installation

The Simple Way

Use r2modman or Gale.

Manual

  1. Download BepInExPack Silksong and extract it to the game folder, next to the game executable
  2. Download BepinExConfigurationManager
  3. Download from github, thunderstore or nexusmods and extract it inside of <game folder>/BepInEx/plugins
    • (Windows) Run the game normally
    • (Linux/MacOS) Run run_bepinex.sh

Configuration

Use BepinExConfigurationManager (open with F1 by default) to adjust the parameters in realtime, or edit the io.github.alexkiri.backgroundblurimproved.cfg file inside <game folder>/BepInEx/config

Using a combination of these parameters can make the game look the same, but completely remove the distracting flickering.

  • Apply Presets
    • allows applying presets from the UI (BepinExConfigurationManager only)
  • RenderTextureHeight
    • increases the resolution of the render target that displays the background blur effect
    • improves the quality of the effect
    • lowers the effect intensity
    • has low impact on performance
  • PassGroupCount
    • increases the number of passes of the background blur effect
    • can increase intensity of the effect
    • has a medium / heavy impact on performance, values > 10 are not recommended
  • EnableEffect
    • can disable the background blur effect completely
    • not recommended, some source textures are low res, and without the blur effect, the background will look inconsistent
  • BloomResolution
    • resolution of the bloom effect
    • can choose between Low -> 1/4 main resolution, or High -> 1/2
  • BloomBlurIterations
    • number of iterations for the bloom effect

The main menu "Blur Quality" setting is removed from the main menu, as it no longer has any effect with this mod enabled.

TODO

  • Add / replace controls in the game's video menu screen
  • Fix the issue where the shader slightly offsets the background, the more passes you use
  • Update the background drawing logic to allow multiple background layers blurred at different intensities

CHANGELOG

Changelog

Version 0.8.1

  • Adjust enum names to look slightly better with ModMenu

Version 0.8.0

  • Add ModMenu, remove BepInExConfigurationManager thunderstore dependencies
  • Adjust descriptions to better fit on screen
  • Adjust settings to properly reload when using ModMenu

Version 0.7.8

  • Added more BlurHeight options for more granular control

Version 0.7.7

  • Add ability to change the Bloom effect settings
  • Reorganize settings menu

Version 0.7.6

  • Readme update, add url, small code cleanup, hot reload fix

Version 0.7.5

  • Rename / move some files, prepare for Thunderstore publish

Version 0.7.4

  • Reorganize ConfigEntry logic in order to work better with hot reload
  • Update to Silksong.Modding.Templates version 2.0.0

Version 0.7.3

  • Remove the "Blur Quality" setting from the video options menu screen
  • Bump dependencies

Version 0.7.2

  • Properly apply the settings even when the "Blur Quality" setting from the video menu screen is set to low

Version 0.7.1

  • Icon update
  • Set AcceptableValueRange to (1, 32), the old value is extreme and just wastes performance

Version 0.7.0

  • Initial public release
  • ArchiveContent csproj setting, setup deployment for thunderstore
  • Add presets as Buttons, code cleanup, reduce number of options
  • Readme update

Version 0.6.0

  • Code cleanup, renaming, refactoring, documentation & preparation for deployment

Version 0.5.0

  • Logic to allow disabling the effect

Version 0.4.0

  • Add PassGroupCount as configurable entry. Logic to properly reload and setup initial values

Version 0.3.0

  • Add logic to update when changing setting

Version 0.2.0

  • Configurable resolution

Version 0.1.0

  • Project setup using Silksong modding template
  • Barebone version that actually works