Add README.md

README.MD

@@ -0,0 +1,116 @@
+<h1 align="center">Silk Fly Launcher</h1>
+<h3 align="center">
+  — A Silksong mod manager —
+</h3>
+
+<p align="center">
+    <img alt="Release" src="https://img.shields.io/github/v/release/Gabi-Zar/Silk-Fly-Launcher">
+    <img alt="Stars" src="https://img.shields.io/github/stars/Gabi-Zar/Silk-Fly-Launcher?color=magenta">
+    <img alt="Forks" src="https://img.shields.io/github/forks/Gabi-Zar/Silk-Fly-Launcher?color=purple">
+    <img alt="License" src="https://img.shields.io/github/license/Gabi-Zar/Silk-Fly-Launcher?color=BB0000">
+    <br>
+    <a href="https://github.com/Gabi-Zar"><img title="Developer" src="https://img.shields.io/badge/developer-GabiZar-blue"></a>
+    <img alt="Maintained" src="https://img.shields.io/badge/Maintained-Yes-009900">
+    <img alt="Written In" src="https://img.shields.io/badge/Written%20In-Javascript-yellow?logo=javascript">
+</p>
+
+---
+
+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.
+
+<p align="center">
+  <img src="assets/github/about.png">
+</p>
+
+<details>
+<summary>More screenshots (click me)</summary>
+<p align="center">
+  <img src="assets/github/online-mods.png">
+  <img src="assets/github/settings.png">
+  <img src="assets/github/about-steel.png">
+  <img src="assets/github/search-citadel.png">
+  <img src="assets/github/installed-mods-cradle.png">
+  <img src="assets/github/about-greyroot.png">
+  <img src="assets/github/latest-mods-abyss.png">
+</p>
+</details>
+
+## 🌟 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.
+
+---
+
+<p align="center">If you like this app, consider giving it a ⭐ on GitHub!</p>

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)

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/,

renderer/index.html

@@ -68,7 +68,7 @@
                     <img src="assets/logo.png" alt="Silk Fly Launcher Logo" class="big-logo-img" />
                     <div>
                         <h3>Silk Fly Launcher</h3>
-                        <p class="transparent-text">v1.0.0</p>
+                        <p class="transparent-text" id="version-text"></p>
                     </div>
                 </div>
                 <div class="horizontal-div">

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;
 

renderer/welcome.html

@@ -84,6 +84,7 @@
 
         <template id="tutorial-template">
             <h1 class="title">Tutorial to download mod from nexus</h1>
+            <p>After clicking on "Download," a Nexus Mods window will pop up. Please log in, then click on "Download with Mod Manager."The Nexus window should close, and the mod will start downloading.</p>
         </template>
 
         <script src="renderer.js"></script>