Skip to content

Nix-main/Cogfly

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
    • Linux users will need to change their file type to "All Files" in the file dialog
    • 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.
    • The "Copy Log To Clipboard" button is currently broken for Linux.

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.

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

The latest CI build can be retreived from https://ambershadow.dev/cogfly/download-ci/ but for those that want to build manually, it's very simple.

Windows: .\gradlew.bat clean shadowJar

Unix/OSX ./gradlew clean shadowJar

The output will be in /build/libs

Credits

Anything not listed here was very likely done by Nix herself.

  • 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
    • jakobhellermann
      • Fix game startup on macOS when arch or sh are shadowed
      • Improved error showcasing

About

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

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages