diff --git a/README.MD b/README.MD index 9938cc6..999b2e4 100644 --- a/README.MD +++ b/README.MD @@ -1,7 +1,4 @@

Silk Fly Launcher

-

- — A Silksong mod manager — -

Release @@ -16,95 +13,93 @@ --- -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. +Silk Fly Launcher is an open-source mod manager for Hollow Knight: Silksong built with Electron, it download mods from Nexus Mods (Thunderstore comming in stable v1.0.0).

- +

-More screenshots (click me) -

- - - - - - - -

+ More screenshots (click me) +

+ + + + + + + +

-## 🌟 Features +## 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. +- Securely store your Nexus API key on your device using Electron's safeStorage, and then encrypt it with an AES key (provided at build time) via Electron Store. - Works on Windows (Linux coming soon) -## 💻 Compatibility +## Compatibility -- ✅ Windows x64 -- 🛠 Linux (Comming in v1.0.0) -- ❌ macOS (need a tester) +- [x] Windows x64 +- [ ] Linux (Comming in v1.0.0) +- [ ] macOS (need a tester) -## 🚀 Installation & Usage +## 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) to have the latest features. +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 to have the latest features. -2. Install it and follow the in-app guide +2. Install it and follow the in-app guide. -## ⚙️ How to build +## 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 +6. Optionnal dependencies: + - [Wix toolset v3](https://github.com/wixtoolset/wix3/releases/tag/wix3141rtm) for msi windows build +7. Build the app with `npm run make:options ` +8. Available Build options: + - none - build all + - zip - Make a zip for Windows x64 + - msi - Make a msi build for Windows x64 -``` -none - build all -zip - Make a zip for Windows x64 -msi - Make a msi build for Windows x64 -``` +## Todo -## ✅ Todo - -#### For release 1.0.0 +#### For stable release 1.0.0 - [x] BepInEx support - [x] Nexus support - [ ] Disable / Enable Individual mods +- [ ] Automatic update +- [ ] Support for Thunderstore +- [ ] Linux support - [ ] Support for offline mods - [ ] Auto Download Mods Dependencies -- [ ] Linux support -- [ ] Automatic update -#### For Later +#### 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 +##### Todo list sorted by importance -Pull requests are welcome. -For major changes, please open an issue first to discuss what you would like to change. +## Contributing -## 📜 License and credit +This is my first Electron project, I will love any feedback. Just open an issue or make a pull request. -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 +## 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. @@ -113,4 +108,4 @@ This product uses third-party modules or assets under open source [third-party]( --- -

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

+

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