diff --git a/README.md b/README.md index 26b3f68..0cf444e 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,61 @@ -# SPTinstaller. -## EFT - SPT-AKI. - 2.3.1 +# SPT-AKI Installer made for EFT. -### New implementation of an Installer for SPT-AKI. -- uses Spectre Console for a cleaner look -- copies files from registry logged GamePath to new location, -- extracts, runs and deletes patcher with minor user input, -- extracts Aki -- static: FileHelper, ZipHelper, LogHelper -- nonStatic: ProcessHelper, PreCheckHelper, StringHelper +![Finished Installer](https://cdn.discordapp.com/attachments/976519592119762994/976845998930419732/unknown.png) -### plans: -- maybe download right version for EFT patcher and server -- maybe make a cool UI :OWO: -- delete patcher zip and aki zip -- progressBar for CopyDirectory -- add figlet for SPT-AKI INSTALLER -- locales, language selection -- fix PreCheckHelper.AkiCheck currently being hardcoded for 2.3.1 -- get waffle to add exit code on patcher to remove the need for user input bar errors \ No newline at end of file +## New implementation of an Installer for SPT-AKI. + +### Spectre Console for a cleaner look: +- Added "SPT-AKI Installer" as Figlet title, + +![Figlet Picture](https://cdn.discordapp.com/attachments/976519592119762994/976845245553717248/unknown.png) + +- progress bars for extracting and copying of files. + +![Progress Bars](https://cdn.discordapp.com/attachments/976519592119762994/976845443831070790/unknown.png) + +### Pre install checks: +- Checks if EFT is installed, +- Checks installer is not in OG game directory, +- Checks install folder does not have game files already in it, +- Checks if gameversion matches aki version, if so skip patcher process, +- Checks both zips are there, other than when the above match, patcher isnt checked for. + +### Installer Processes: +- Copies files from registry logged GamePath to new location, +- Extracts, runs and deletes patcher with no user input, +- Extracts Aki, +- Deletes both Patcher and AKI zips at the end. + +### Plans: +- Maybe download right version for EFT patcher and server, +- Locales, Language selection. + +---- + +# Setup: + +1. Visual Studio > File > Open > Project/Solution `\SPT_AKI Installer.sln` +2. Visual Studio > Build > Publish Selection > Publish +3. Check your folder for the project `\bin\Debug\net6.0\publish\` +4. In here should be an .Exe and a .pdb +- Only the .exe is needed. + +# Debug: + +- The project has PreProccessor Directives for the location to test installing too, +- If you want to change the location for this under L18 make this the path you desire, +- You have to be in Debug for this to be used. + +#### Run Debug: + +- Make sure Visual Studio is in Debug mode. + +![Debug Mode](https://cdn.discordapp.com/attachments/976519592119762994/976850003521835058/unknown.png) + +1. Visual Studio > Debug > Start Debugging or the F5 shortcut Key + +# Dependencies: + +- .net 6.0 +- SharpCompress +- SpectreConsole