Skip to content

A cross platform mod manager for Hollow Knight written in Avalonia.

License

Notifications You must be signed in to change notification settings

luizzeroxis/Lumafly

 
 

Repository files navigation

Lumafly

build test website
GitHub all releases contributors
discord

This is a cross platform mod manager for Hollow Knight which is fully localized in English, Spanish, Portugese, French, Chinese, Russian and Polish.

Formerly known as Scarab+

Usage

  • Download the latest version from the automatic download link or the releases page.
  • Search through and download the mods you like.
  • Mods appear in the top left corner of the game title screen after installation.
  • Enable/Disable mods from affecting the game using the toggle and update outdated mods using the orange update button.
  • If you are unable to connect to the internet, Lumafly can be launched in offline mode where you can toggle mods/api.

Screenshot: What Lumafly looks like

info demo

Features

  • Automatically downloads the Modding API which is required for mods to load. It also allows switching between modded and vanilla via the Toggle API button.
  • Loads its modlist from the official modlinks but that can be changed by providing a custom modlinks URI in the settings tab or via a command.
  • Search through the 300+ mods available and narrow down the search by the mod's tags and authors. Also allows searching through mod descriptions and searching by dependency.
  • Display mods that were updated or newly released recently (within the last week/month).
  • For mods not in official modlinks, lumafly provides a manually install button which can correctly install it.
  • Pin mods by right clicking on a mod to ensure lumafly never deletes it.
  • Share links that run commands in lumafly see commands for more info.
  • Open a mod's global settings file to edit its settings.

If you want to see what features changed between versions please see the changelog.

Features Explanation

Here are a list of explanations of features that require more information.

Commands

Lumafly allows you to use shareable links to open and run commands in lumafly. You can use the commands website to view and create the links.

General Commands

The main shareable commands that anyone can use.

  • Download Mod: Share links to open Lumafly and download mods using this command. Sharing a link such as this will open Lumafly and download the mod "Satchel".

  • Share modpack: Used to share a modpack link with others.

  • Custom Modlinks - Open Lumafly and load its mod list from a custom modlinks.

  • Launch Game - Open Lumafly and launch Hollow Knight.

Support Commands

Commands that can be used to help fix problems with Lumafly or Hollow Knight Mods

  • Reset - Opens Lumafly and reset its persistent settings. Equivalent to downloading and opening Lumafly for the first time.
  • Force Update All - Opens Lumafly and reinstalls all mods. Could help fix issues that happened because mods are not downloaded correctly.
  • Remove All Mods Global Settings - Opens Lumafly and removes all global settings of mods from saves folder.
  • Use Official Modlinks - Opens Lumafly and loads its mod from offcial modlinks.

Other Commands

  • Redirect link You can use this link to redirect to any lumafly command.

Search by Dependency

Lumafly allows you to search for mods that are dependent or integrated with a specific mod. For example if you want to see Randomizer 4 connections you can search by dependency of randomizer 4 and you will see mods like RandoMapMod, RandoPlus, and BenchRando.

Settings

There are currently 4 settings that can be changed in Lumafly

  • Automatically remove unused dependencies (Default: No) - Do you want lumafly to remove mods that are listed as dependencies of mods that are now being uninstalled.
  • Warn before removing a dependent mod (Default: Yes) - Do you want lumafly to warn before disabling or uninstalling a mod that is listed as a required dependency of an installed and enabled mod which could cause it to not function correctly.
  • Use custom modlinks (Default: No) - Do you want Lumafly to load its mod list from another source other than the official modlinks. Enabling this will give you the prompt for the custom modlinks URI.
  • Game Path - Which install of the game do you want Lumafly to modify.
  • Low Storage Mode (Default: False) - Do you want lumafly to not cache mod downloads for faster installs and quicker switching between packs.

Tools for mod developers

  • You can mark a mod as a custom build of the mod by right clicking the mod and clicking on "Register as not in modlinks"
  • Pinning a not in modlinks mod ensures Lumafly will never automatically replace it.
  • To test if you mod installs correctly, create a fork of modlinks and in your fork add your mod's manifest in ModLinks.xml. Then open Lumafly and in the settings tab give Lumafly the link to the ModLinks.xml and reload Lumafly.

Contributions

If you want to suggest a feature or report a bug, report it on the issues page.
If you want to contribute to Lumafly, feel free to. You can see what features are currently requested over here

Some open issues you can help with

  • #29 - Translate Lumafly to more languages

Credits

Programming

Translations

Art

About

A cross platform mod manager for Hollow Knight written in Avalonia.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • C# 98.5%
  • Python 1.2%
  • Other 0.3%