diff --git a/README.MD b/README.MD new file mode 100644 index 0000000..b07778f --- /dev/null +++ b/README.MD @@ -0,0 +1,116 @@ +

Silk Fly Launcher

+

+ — A Silksong mod manager — +

+ +

+ Release + Stars + Forks + License +
+ + Maintained + Written In +

+ +--- + +Silk Fly Launcher is an open-source mod manager for Hollow Knight: Silksong, designed to simplify installing and managing Nexus Mods. + +Built with Electron, it provides a clean UI, secure Nexus API integration, and seamless switching between vanilla and modded gameplay. + +

+ +

+ +
+More screenshots (click me) +

+ + + + + + + +

+
+ +## 🌟 Features + +- Install / Uninstall / Backup BepInEx for Silksong. +- Automatically detect Silksong installation path for Steam on Windows +- Browse and download Nexus mods directly in the app +- Multiple themes inspired by Silksong +- Launch Silksong in Vanilla or Modded without deleting the mods +- Securely store your Nexus API key on your device using Electron's safeStorage, and then additionally encrypt it with an AES key (provided at build time) via Electron Store. +- Works on Windows (Linux coming soon) + +## 💻 Compatibility + +- ✅ Windows x64 +- 🛠 Linux (Comming in v1.0.0) +- ❌ macOS (need a tester) + +## 🚀 Installation & Usage + +1. Download the app in your desired format from the [GitHub Releases](https://github.com/Gabi-Zar/Silk-Fly-Launcher/releases) page or build it from [source](#how-to-build). + +2. Install it and follow the in-app guide + +## How to build + +1. Install [Git](https://git-scm.com/) and [Node JS](https://nodejs.org) +2. Clone the repo `git clone https://github.com/Gabi-Zar/Silk-Fly-Launcher ` +3. Go into the repository `cd Silk-Fly-Launcher ` +4. Install npm dependencies `npm install ` +5. Start the app with `npm run start ` +6. Build the app with `npm run make:options ` +7. Available Build options are + +``` +none - build all +zip - Make a zip for Windows x64 +msi - Make a msi build for Windows x64 +``` + +## ✅ Todo + +#### For release 1.0.0 + +- [x] BepInEx support +- [x] Nexus support +- [ ] Disable / Enable Individual mods +- [ ] Support for offline mods +- [ ] Auto Download Mods Dependencies +- [ ] Linux support +- [ ] Automatic update + +#### For Later + +- [ ] Automatically detect Silksong installation path on other platforms +- [ ] Multiple mods profiles +- [ ] Support for MelonLoader +- [ ] Support for Thunderstore +- [ ] French translation +- [ ] macOS support (need a tester) + +## 🤝 Contributing + +Pull requests are welcome. +For major changes, please open an issue first to discuss what you would like to change. + +## 📜 License and credit + +This project is licensed under the [GPL-3.0 license](LICENSE). +This product uses third-party modules or assets under open source [third-party](THIRD-PARTY-LICENSES) licenses + +> [!CAUTION] +> Some assets came from Hollow Knight: Silksong. +> Hollow Knight: Silksong is property of Team Cherry. +> This project is not affiliated with or endorsed by Team Cherry. + +--- + +

If you like this app, consider giving it a ⭐ on GitHub!

diff --git a/THIRD-PARTY-LICENSES b/THIRD-PARTY-LICENSES index 249d26b..b4af203 100644 --- a/THIRD-PARTY-LICENSES +++ b/THIRD-PARTY-LICENSES @@ -1,3 +1,13 @@ +HOLLOW KNIGHT: SILKSONG ASSETS +All rights reserved. + +Copyright (c) 2025 Team Cherry + +Some assets came from Hollow Knight: Silksong. +Hollow Knight: Silksong is property of Team Cherry. +This project is not affiliated with or endorsed by Team Cherry. + + 7zip-bin 5.2.0 MIT The MIT License (MIT) diff --git a/assets/github/about-greyroot.png b/assets/github/about-greyroot.png new file mode 100644 index 0000000..feacc64 Binary files /dev/null and b/assets/github/about-greyroot.png differ diff --git a/assets/github/about-steel.png b/assets/github/about-steel.png new file mode 100644 index 0000000..4c7c653 Binary files /dev/null and b/assets/github/about-steel.png differ diff --git a/assets/github/about.png b/assets/github/about.png new file mode 100644 index 0000000..8a4937f Binary files /dev/null and b/assets/github/about.png differ diff --git a/assets/github/installed-mods-cradle.png b/assets/github/installed-mods-cradle.png new file mode 100644 index 0000000..23b3e60 Binary files /dev/null and b/assets/github/installed-mods-cradle.png differ diff --git a/assets/github/latest-mods-abyss.png b/assets/github/latest-mods-abyss.png new file mode 100644 index 0000000..4bc38b4 Binary files /dev/null and b/assets/github/latest-mods-abyss.png differ diff --git a/assets/github/online-mods.png b/assets/github/online-mods.png new file mode 100644 index 0000000..114dae1 Binary files /dev/null and b/assets/github/online-mods.png differ diff --git a/assets/github/search-citadel.png b/assets/github/search-citadel.png new file mode 100644 index 0000000..40c3166 Binary files /dev/null and b/assets/github/search-citadel.png differ diff --git a/assets/github/settings.png b/assets/github/settings.png new file mode 100644 index 0000000..cd9c387 Binary files /dev/null and b/assets/github/settings.png differ diff --git a/raw_assets/silkfly.png b/assets/raw/silkfly.png similarity index 100% rename from raw_assets/silkfly.png rename to assets/raw/silkfly.png diff --git a/raw_assets/silkfly.svg b/assets/raw/silkfly.svg similarity index 100% rename from raw_assets/silkfly.svg rename to assets/raw/silkfly.svg diff --git a/forge.config.cjs b/forge.config.cjs index 42724f9..5748f5d 100644 --- a/forge.config.cjs +++ b/forge.config.cjs @@ -42,7 +42,8 @@ module.exports = { /^\/?test/, /^\/?docs/, /^\/?\.vscode/, - /raw_assets/, + /assets\/raw/, + /assets\/github/, /7zip-bin\/win/, /7zip-bin\/mac/, /7zip-bin\/linux/, diff --git a/renderer/assets/Cursor.png b/renderer/assets/cursor.png similarity index 100% rename from renderer/assets/Cursor.png rename to renderer/assets/cursor.png diff --git a/renderer/assets/hornetUITop.png b/renderer/assets/hornetUITop.png deleted file mode 100644 index 903d2b5..0000000 Binary files a/renderer/assets/hornetUITop.png and /dev/null differ diff --git a/renderer/assets/needleUIBottom.png b/renderer/assets/needleUIBottom.png deleted file mode 100644 index b3c230c..0000000 Binary files a/renderer/assets/needleUIBottom.png and /dev/null differ diff --git a/renderer/assets/silkUITop.png b/renderer/assets/silkUITop.png deleted file mode 100644 index 0063585..0000000 Binary files a/renderer/assets/silkUITop.png and /dev/null differ diff --git a/renderer/index.html b/renderer/index.html index 33d9128..a10b52f 100644 --- a/renderer/index.html +++ b/renderer/index.html @@ -68,7 +68,7 @@ Silk Fly Launcher Logo

Silk Fly Launcher

-

v1.0.0

+

diff --git a/renderer/renderer.js b/renderer/renderer.js index 93bf632..5452cdb 100644 --- a/renderer/renderer.js +++ b/renderer/renderer.js @@ -77,6 +77,8 @@ async function navigate(page) { case "home": title.innerText = "Silk Fly Launcher"; const HomeTemplateCopy = HomeTemplate.content.cloneNode(true); + versionText = HomeTemplateCopy.getElementById("version-text"); + versionText.innerText = await versions.silkFlyLauncher(); view.appendChild(HomeTemplateCopy); break; diff --git a/renderer/welcome.html b/renderer/welcome.html index 216ab54..4aa3138 100644 --- a/renderer/welcome.html +++ b/renderer/welcome.html @@ -84,6 +84,7 @@