Skip to content

Repository files navigation

Cogfly

discord GitHub all releases

A cross-platform mod manager for Hollow Knight: Silksong. Currently only supports English.

Usage

  • Download the latest version here
  • Select game path if not automatically found
    • Xbox Games users will need to change their file type to "All Files" in the file dialog if the game is not automatically found
      • They must also select a non-exe file in their game folder to avoid file permission issues
      • The game installs by default to C:\XboxGames\Hollow Knight Silksong\Content. If your game is installed here, it should auto-detect.
  • Confirm profile path
  • Create a profile (onboarding should guide you)
  • Click the profile's icon to manage it and install mods to it
  • Click 'Launch' to launch the modded profile

Additional info

  • If you rely on Steam controller compatability or would like to keep your save files, you can either:
    • Launch with steam enabled
    • Set Launch With Steam in Settings to true
  • Linux users must have Zenity or Kdialog installed for file and folder pickers to work properly. Cogfly will fall back to manual input fields if neither is found.

Contributions & Bug Reports

Contributions can be submitted here:
https://github.com/nix-main/Cogfly/pulls
All contributions must be written in either Java or Kotlin, as Cogfly is a Java program. It's preferred that pull requests do not add additional libraries/dependencies, but doing so does not immediately disqualify them.
Please disclose usage of generative ai in pull requests.

Bug reports can be submitted here:
https://github.com/nix-main/Cogfly/issues
Please submit actual information about the bug experienced. Please also submit your log file. There is an "Open Logs Folder" button on the info page.

Building

If you're just looking for a jar file, it can be found in the release artifacts. The latest CI build can be retrieved from the workflow, but building manually is basic.

Windows:
To build Cogfly on Windows, you'll need both GCC and G++ in your PATH, as they are invoked to compile the Windows file dialog libraries.
I personally use https://www.mingw-w64.org/
.\gradlew.bat clean shadowJar

Unix/OSX:
If you have GCC and G++ on PATH, the windows DLLs will be built so that your jar works on Windows. If not, the build will still succeed, but not work properly on Windows.
./gradlew clean shadowJar

The output will be in /build/libs

Credits

Nix herself very likely did anything not listed here.

  • Art
    • Jngo - Main icon on the info page
  • Contributions
    • Hien Ngo
      • RPM build in the workflow
      • Nicer info page icons
      • Fix dialog positions
    • FabBeyond
      • Profile icon switching
      • "Show installed mods on top" setting
      • Bug fixes
      • Hover Color Change & Profile Loading fixes
    • jakobhellermann
      • Fix game startup on macOS when arch or sh are shadowed
      • Improved error showcasing
      • Fix profile creation crash when no icon is selected
    • elijw
      • Fixing #35
      • Fixed an issue where profiles could be created before BepInEx was available
      • Cleaned up some swing UI behavior

About

Cross-platform mod manager and mod installer for Hollow Knight: Silksong

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages