You are viewing a potentially older version of this package. View all versions.
Ashiepaws-Patchwork-2.1.1 icon

Patchwork

A custom asset mod for Hollow Knight: Silksong with particular attention to ease of creation.

Date uploaded a month ago
Version 2.1.1
Download link Ashiepaws-Patchwork-2.1.1.zip
Downloads 525
Dependency string Ashiepaws-Patchwork-2.1.1

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

README

Patchwork

A custom asset mod for Hollow Knight: Silksong with particular attention to ease of creation.

Features

  • Sprite replacement with individual sprite image files, including proper names, rotations & sizing - no more bulky spritesheets
  • Ability to replace (at least almost) every sprite in the game
  • Support for Texture2D Sprites (which previously required Silksong Customizer + CustomizerT2D)
  • Full compatibility with spritesheet-based skins
  • Automatic reloading of sprites when files change, so you can see your sprites ingame immediately
  • Built-in sprite dumping functionality

Configuration

General

  • DumpSprites: Enables sprite dumping, which saves sprites for any loaded scene into the "Patchwork/Dumps" folder. These files can be used to make new texture packs. DO NOT enable this during normal gameplay, as it slows down loading the game by a lot. If this is enabled, the mod will also let you dump textures from all scenes in the game by pressing the button configured under "Keybinds/FullDumpKey" (Default: F6)
  • LoadSprites: On by default, lets you disable custom textures if you would like that for whatever reason.

Reloading

  • ReloadSceneOnChange: Disabled by default, watches sprite files for changes and automatically reloads the area you're in within the game whenever any changes happen. This lets you see your new sprites ingame immediately. WARNING: Depending on where you are in the game, this may cause instability or crashes.
  • EnableForceReload: Disabled by default, lets you reload the area you're in ingame with a button press configured under "Keybinds/ForceReloadKey" (Default: F5)

Logging

Enables/disables various types of logging. Only relevant for troubleshooting or development, you'll most likely not need these.

Texture Creation Guide

  1. If you'd like to see your changes update live while the game is running, set the ReloadSceneOnChange config option to "true".
    • It's a little unstable right now, you get the best results by loading into the game and going through at least one loading zone before modifying sprites.
  2. Dump the textures you want to modify, or download the full set of modifiable game sprites from this mods download page.
    • For dumping textures yourself, enable the "DumpSprites" option in the mod config, boot up the game and enter the areas where the sprites you want to modify are loaded. You can also press the "Full Dump" key (Default: F6) to dump all sprites, but this takes quite a while!
  3. Put your modified sprites into "Patchwork/Sprites" in your game folder.
    • You can put them into as many subfolders as you want, but the names of the last two folders MUST be the same as in the dump (for example: "Patchwork/Sprites/HUD Cln/atlas0" is fine, so is "Patchwork/Sprites/SomeTexturePack/HUD Cln/atlas0"
  4. Enjoy!

Publishing Packs on Thunderstore

Patchwork is structured in a way that lets creators publish their packs as plugins on Thunderstore! In order to be automatically installed correctly when players download them, make sure to follow the following structure with your plugins:

YourName-PackName.zip
 \- icon.png
 \- manifest.json
 \- README.md
 \- plugins
     \- Patchwork
         |- Sprites
         |   \- <your files here...>
         \- Spritesheets
             \- <your files here...>

Links

GitHub Repository: https://github.com/Ashiepaws/silksong-patchwork

Discord: https://discord.gg/DeCtHA84AM (originally meant for my little Twitch community, but I'd be happy to chat and hang out! :3)

Ko-Fi Donations: https://ko-fi.com/ashiepaws

CHANGELOG

v2.3.3

  • Fixed custom sprites not appearing for some enemy sprites that include Hornet

v2.3.2

  • Fixed some custom sprites reverting to default sprites after death
  • Removed LoadSprites config option

v2.3.1

  • Fixed sprite loading breaking in certain areas
  • Fixed non-statically loaded audio not being replaced

v2.3.0

  • Implemented the Patchwork Animation Controller:
    • Freeze the in-world locations of game objects for easier testing
    • Pause animations and step through them frame by frame ingame
    • Force-play animations ingame, selectable through a dropdown menu
    • "Edit Current Sprite" button, which automatically dumps the currently shown sprite and opens it for editing

v2.2.4

  • Added support for all Unity-supported audio formats

v2.2.3

  • Fixed crash on sound file change

v2.2.2

  • Added support for even more sounds

v2.2.1

  • Fix occasional pop sound at the end of custom sounds
  • Added support for more sounds

v2.2.0

  • Added support for AudioClip replacement
  • Implemented seamless sprite reloading (Sprite changes no longer reload the entire area)

v2.1.2

  • Fixed crashes when auto-reloading certain sprites

v2.1.1

  • Fixed plugin crash when using plugin pack with missing folders

v2.1.0

  • Support for plugin packs
  • Thunderstore release

v2.0.1

  • Fixed an issue with dumping of certain rotated sprites

v2.0.0

  • Massive performance improvements by moving texture workload to GPU
  • Texture2D replacement support
  • Moved Patchwork folder to BepInEx/plugins for future mod manager support

v1.0.2

  • Added automatic resizing + warning log messages for incorrectly sized sprites

v1.0.1

  • Fixed a plugin crash during initialization if Patchwork folders didn't already exist

v1.0.0

  • Initial release! 🎉