diff --git a/README.md b/README.md index 96787c7..9aa228c 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,22 @@ -# ![logo](https://mxdev.ovh/wp-content/uploads/2025/09/mxdev-1.png) +![logo](https://mxdev.ovh/wp-content/uploads/2025/09/mxdev-1.png) ## Jsarus -Official MxIcarus Modding Tool for Icarus. +Official MxIcarus Modding Tool for Icarus. ## Features - * Extract json data from your client. - * Mod your extracted json data according to the settings.json config. - * Create a pak file, ready to use on your client/server. - * Can copy the created pak file to a user specified list of path. \ No newline at end of file +* Extract json data from your client. +* Mod your extracted json data according to the settings.json config. +* Create a pak file, ready to use on your client/server. +* Can copy the created pak file to a user specified list of path. + +## How-To + 1. Download the latest release. (https://mxgit.ovh/Icarus/Jsarus/releases) + 2. Copy the archive content in an empty folder on your disk. + 3. Open "settings.json" and edit the "ModName" and "GameContentPath". + 4. IMPORTANT: Escape "\" in your game content path with "/". Ex.: "C:\/SteamLibrary\/steamapps\/common\/Icarus\/Icarus\/Content" + 5. Save the "settings.json" file and run "Jsarus.exe". + 6. Jsarus will extract your game data, press "y" when asked to mod it and generate a mod pak. + 7. Copy the created pak file from the "Paks" folder to your game "mods" folder. + 8. "mods" location exemple: "C:\SteamLibrary\steamapps\common\Icarus\Icarus\Content\Paks\mods" + 9. If you don't have a "mods" folder, create one first. + 10. Voila! \ No newline at end of file