From 022445f32e952eefbbdb0a0f7297301141aa4340 Mon Sep 17 00:00:00 2001 From: Doriel Rivalet <100863878+DorielRivalet@users.noreply.github.com> Date: Tue, 13 Feb 2024 18:44:10 -0300 Subject: [PATCH] docs: update to velopack --- .gitignore | 4 ++-- README.md | 23 ++++++++--------------- docs/cicd.md | 2 +- docs/deployment.md | 12 ++++++------ docs/libraries.md | 2 +- splash.gif | Bin 0 -> 2845 bytes 6 files changed, 18 insertions(+), 25 deletions(-) create mode 100644 splash.gif diff --git a/.gitignore b/.gitignore index dfa37add..a272ba36 100644 --- a/.gitignore +++ b/.gitignore @@ -4,7 +4,7 @@ scripts/input/ # composer vendor/ -# ignore Clowd.Squirrel exe +# ignore Clowd.Squirrel / Velopack exe Update.exe # ignore claudiaIDE @@ -153,7 +153,7 @@ DocProject/Help/*.hhp DocProject/Help/Html2 DocProject/Help/html -# Click-Once directory and Clowd.Squirrel +# Click-Once directory and Clowd.Squirrel / Velopack publish/ # Publish Web Output diff --git a/README.md b/README.md index 513d3dd9..f92ea6c3 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,6 @@ - [Monster Hunter Frontier Z Overlay](#monster-hunter-frontier-z-overlay) - [About](#about) - - [Requirements](#requirements) - [System Requirements](#system-requirements) - [Minimum](#minimum) - [Recommended](#recommended) @@ -59,18 +58,13 @@ The overlay is highly configurable, with a wide range of options available to su We hope you find this overlay useful and enjoyable, and we welcome any feedback or suggestions you may have. Happy hunting! -## Requirements - -- [.NET Desktop Runtime 6.0 x64](https://dotnet.microsoft.com/en-us/download/dotnet/thank-you/runtime-desktop-6.0.7-windows-x64-installer). -- [.NET Desktop Runtime 6.0 x86](https://dotnet.microsoft.com/en-us/download/dotnet/thank-you/runtime-desktop-6.0.8-windows-x86-installer). - ## System Requirements ### Minimum - OS: Windows 10 (64-bit) - Processor: Intel® Core™ i3-4130 or Core™ i5-3470 -- Memory: 8 GB RAM +- Memory: 6 GB RAM - Storage: 500 MB available space - Additional Notes: 1080p/30fps when refresh rate is set to 1. System requirements subject to change during software development. @@ -78,22 +72,21 @@ We hope you find this overlay useful and enjoyable, and we welcome any feedback - OS: Windows 10 (64-bit) - Processor: Intel® Core™ i5-4460 or better -- Memory: 8 GB RAM +- Memory: 6 GB RAM - Storage: 500 MB available space - Additional Notes: 1080p/30fps when refresh rate is set to 30. System requirements subject to change during software development. Please note that these system requirements are estimates and may vary based on your specific hardware configuration. If you encounter any performance issues or have different hardware specifications, please provide feedback or send an issue for assistance. We appreciate your input in helping us improve the overlay's compatibility with a wider range of hardware setups. -If you record and/or stream with the overlay, the recommended RAM is 16 GB and the recommended processor is Intel® Core™ i7 or better. +If you record and/or stream with the overlay, the recommended processor is Intel® Core™ i7 or better. ## Installation -1. [Get **ALL** of the requirements](#requirements). -2. [Download the latest version from the *Releases*](https://github.com/DorielRivalet/mhfz-overlay/releases/latest/download/MHFZ_OverlaySetup.exe). -3. Make sure *Windows* or your antivirus did not delete the file (because it reads the game's memory, *Windows* might detect it as a trojan, so you might have to get it out of quarantine). -4. Run `MHFZ_OverlaySetup.exe` **as Administrator**. -5. [Bonk monsters!](https://c.tenor.com/60Tr3Zeg6RkAAAAd/fumo-bonk.gif) -6. [Be sure to leave some feedback here!](https://forms.gle/hrAVWMcYS5HEo1v7A) +1. [Download the latest version from the *Releases*](https://github.com/DorielRivalet/mhfz-overlay/releases/latest/download/MHFZ_Overlay-win-Setup.exe). +2. Make sure *Windows* or your antivirus did not delete the file (because it reads the game's memory, *Windows* might detect it as a trojan, so you might have to get it out of quarantine). +3. Run `MHFZ_OverlaySetup.exe` **as Administrator**. +4. [Bonk monsters!](https://c.tenor.com/60Tr3Zeg6RkAAAAd/fumo-bonk.gif) +5. [Be sure to leave some feedback here!](https://forms.gle/hrAVWMcYS5HEo1v7A) > [!NOTE]
> It's recommended to start the overlay when you are done loading into Mezeporta. diff --git a/docs/cicd.md b/docs/cicd.md index cce973cb..184e1ad9 100644 --- a/docs/cicd.md +++ b/docs/cicd.md @@ -29,7 +29,7 @@ Our development process follows the best practices of Continuous Integration and - **Version Control**: *Git* with commitlint and *CircleCI* for enforcing commit message style. - **Build and Automation**: *GitHub Actions* for building and testing the software automatically. - **Code Integrity/Quality**: *SonarCloud* for code analysis, code coverage and quality checks. *Dependabot* alerts for vulnerability issues mainly relating to package-lock.json. -- **Packaging**: *clow.squirrel* for creating installers/packages. +- **Packaging**: *Velopack* for creating installers/packages. - **Testing**: *XUnit* for writing and executing unit tests. - **Release Management**: *GitHub Releases* for creating versioned releases with release notes and documentation. - **Development Environment**: C# with *Visual Studio* and .NET 6.0 for developing the software. diff --git a/docs/deployment.md b/docs/deployment.md index edd37c59..d84aa383 100644 --- a/docs/deployment.md +++ b/docs/deployment.md @@ -11,7 +11,7 @@ ## Overview -The following steps outline the process for releasing and deploying the software using clowd.squirrel, after making changes and testing in-game. +The following steps outline the process for releasing and deploying the software using Velopack, after making changes and testing in-game. ### Repository branch structure @@ -60,12 +60,12 @@ If you are working on fixes, test your fixes before working on something else. T 6. Update CHANGELOG.md: Run `npm run release` to automatically update the CHANGELOG.md file with the changes made. When prompted for the tag name, follow Semver's specifications and prefix with a `v`. Answer `Yes` to all except the last question ("Create a Release on GitHub?"). 7. Merge release branch into main: **Recommended to send a Pull Request to the main branch**. Otherwise, run `git checkout main` to switch to the main branch and do `git pull origin main` to pull the latest remote changes, then run `git merge release` to merge the release branch into the main branch, and finally `git push origin main`. 8. Verify GitHub Actions: Verify that the GitHub Actions workflow has been triggered and completed successfully. If something is wrong, go back to step 1 and fix any issues without modifying the git history (no rebases and no squashes). -9. Publish in Visual Studio: Open the solution in Visual Studio then switch from Build configuration to Release configuration. Publish the software's project using Visual Studio. -10. Update packVersion with Clowd.Squirrel: Open the command prompt in the `C:\Users\Name\.nuget\packages\clowd.squirrel\x.x.xx\tools` folder, then run the following command, replacing the appropriate paths and version number (replace the packVersion flag with the actual version number): - - `Squirrel.exe pack --packId "MHFZ_Overlay" --packDirectory "ABSOLUTE_PATH\MHFZ_Overlay\MHFZ_Overlay\bin\Release\net6.0-windows\publish" --framework net6.0-x86 --packTitle="Monster Hunter Frontier Z Overlay" --packAuthors="DorielRivalet" --splashImage="ABSOLUTE_PATH\MHFZ_Overlay\splash.png" --icon="ABSOLUTE_PATH\MHFZ_Overlay\img\icon\mhfzoverlayicon256.ico" --appIcon="ABSOLUTE_PATH\MHFZ_Overlay\img\icon\mhfzoverlayicon256.ico" --packVersion "0.13.0"` -11. Add to GitHub Releases: Create a new release on GitHub with the appropriate version number, release notes, and documentation. Lastly, attach all of the files in the generated Releases folder separately. +9. Open terminal in `MHFZ_Overlay` project directory and run `dotnet publish -c Release --self-contained -r win-x86 -o publish`. +10. Update packVersion with Velopack: Install `vpk` from Velopack if you don't have it, then run the following command, replacing the packVersion flag with the new version number): + - `vpk pack --packId MHFZ_Overlay --packDir publish --mainExe "MHFZ_Overlay.exe" --splashImage ../splash.gif --icon mhfzoverlayicon256.ico --packAuthors "DorielRivalet" --packTitle "Monster Hunter Frontier Z Overlay" --packVersion 0.36.0` +11. Add to GitHub Releases: Create a new release on GitHub with the appropriate version number, release notes, and documentation. Lastly, attach all of the files in the generated Releases folder separately (`assets.win.json not needed`). -By following these steps, the software can be releasified and deployed using clowd.squirrel, ensuring that the latest changes are packaged and released to users efficiently and reliably. Also, you are allowed to make feature branches and merge them into the release branch. +By following these steps, the software can be releasified and deployed using Velopack, ensuring that the latest changes are packaged and released to users efficiently and reliably. Also, you are allowed to make feature branches and merge them into the release branch. ### Merging via command line diff --git a/docs/libraries.md b/docs/libraries.md index bc6c7e1e..0b2f2f72 100644 --- a/docs/libraries.md +++ b/docs/libraries.md @@ -2,7 +2,7 @@ The following libraries have been utilized in the development of this software: -- [Clowd.Squirrel](https://github.com/clowd/Clowd.Squirrel): Used for installation process. +- [Velopack](https://github.com/velopack/velopack): Used for installation process. - [DiscordRichPresence](https://github.com/Lachee/discord-rpc-csharp): Used for Discord rich presence integration. - [WPF UI](https://github.com/lepoco/wpfui): Used for UI design. - [Memory.dll](https://github.com/erfg12/memory.dll): Used for reading game addresses. diff --git a/splash.gif b/splash.gif new file mode 100644 index 0000000000000000000000000000000000000000..29f1850bedddcd01360516b5d564ada0db4e1d3e GIT binary patch literal 2845 zcmc)M`#)6q9|!QyIcKiSjAM-4IT&(pibShAGvhL@2}w!~D{0%>NouFI&6ydONiIVa z8W~Y8sTC?AI~1a_M7t$hqt#`rZ>!Sf+m^oV_owfF@O?jCKfHf<|Mq_U@C*tL^zluU z0x9T^1rP+mUjjo20wV}QLJ$KgnaN@s8d_MenLJ~rg@vW1g_(`DwYLrGWM|8@ci=l1 zxx2cBx|(`>dItC`ThDDwK3FN7R-%}U6ZzIX>pj# z#tn(`wcLH{0@cyHgJRbc@t)tNZp%wqv2pi`vQ+N(TPj)3wQj|hl~7V;wl7J2Xx2moOFZxT5fWB|7>`f3 z{DMMNQSqUY(!)o}$}5hlE00xas*l&yo;X=o-_Urf>GYYOn$Nbhww*hFq5Wb@Gm2yH^;{NNu;9NxALLi0Sx7k=!}OCQ7X8rn#e+3g)3gY zG^S2vL&(!-xePNQK;T(Sg94hFUref2XYB>)ZE;pHj943Fy~`2P1!lRmr* zB1?rSaLg12kt$cNi&Tfa$;r=sozg!u@_PCVm_r@Py-HxgtrpXTtZG8io9);$Yugd% z1QcX8w?u!$qfg!`Rj^*-kg`yp5mwIiO(mB9h(hfST=P+AC*Trsvcp%a)Ke}}>ANDg z)r9LjTH}L?7=mo#!j*(_D=7v>ZgFKgv5Xki1unSQoOm*S0?tSmOK?Et*s_!IKaOTY zj9MVp2M}q3tgh1fsHPs}S$b~J%;>b*C&HNLBO7qO)x(}u=!jOq^4Nz%v=ybLqZt(> zl@{iR03b^gfK@8U=kgtl`u^tJjB3jJuaiVI=z>X zW^|>uAdThRm5E)iVmK>f&DQJqRBGGU6(jp^c*6Z28flfjL!1WRk^`Ex#rVZ(u-{{n zx2}XO#pM)^rt}eNqE!Y1SWJU=!{Np%W{2TT62}7QdJcHC&%n7$CWCq<3+CME7EiROubknL*#Yv@o;g0gg5(Z!NGwySg!E$kw> zlUn1ejC_omIqAl+vi)r^sj>Q;JDHWKQcymNk8H1FyEWq{3Q%!ei`iV0xAmUyQ?#ab zVT1%w^Ow84V$7fH6p)S8Bso=BOR7y4rt5&d`Fn18(Y#WZo}IZs3j{BqT#x>CcQLRF z2Yea1*Siv-nw0J0(--kHV;rld-HtN;r{;92>3zo$y{}GDS1rj-K+`peMnA?N2k_Be z^2=;wfY4KFREvq^yyL&Ez}ub+-#=|?=n zzy$ao>x>2p`3jq?=GbzuKuvy!3!>RL1r|_0W88 zLUS>g59))H2Zmywj}M$nbq|jBIj$}ALt%Y1>&L(k{39VFhnVUi*w+b)vn(PR^yAbe zn&{OYC}f`ZlZY{X%>bXNYZ^%=&#O5=YT0G=adtSO*dCqRt~0^V9-0rKO%tC}I@aod zwHVr@p01{~{M+TqabuJFC%r-s57aTbs@j}4-w@X5Dix{V0i zx+5=$f{9^kjTp`dNm}hUhe6@Nsgb7=gIOs%&y-GUyvLpu>x+P#Dbl1_lo6C)7b~5> zl&WZke?I<|;r2?LS`&{Uf9!xJXuR;4;3A5$t-*Fgv&wgO2EcRjFrCkZ7^cP30dWuo$KKT5#uN7wPgs)kdmK1{`dU={9@^&%R=WHfR z1TfEreCoy-8B_YKtO%0*g-v){)awv4QyCw61er?!?9S_Dy&8n#*>b%~-q$v*QLYwO zoHN6d#e#{!b2d^jq$lDVmFX1b>$NafqkS`nlP%rEJ}2vCe-%hL(k2WFiFYY4h+yMoC<(2O^eYm5tOyuu-_Qtf92NtXQ3dn)viw{)bosrc5XD8 zyxQvRr{qV_rp`8-htS)(0nB4rM@uWR7Jq5No#ks>67Th&_?A1?&h2jHgwL zZ6bko9)2H57uP3kl9Rl2@{eJ<4x7{x+G6KB*1y=1>1Y}?cSN2pBD$ax1e}U>pg@Pj zmS_!Bsy|LoXyClIEE14Fzl9}I*|%{!k6nN{>F=xlLrYPo-btL$)}BLqDU_v3E+^6O zmCS{{h>!>NVIlt4(RtN57Ot1&?T19JOWja6bEPg}UL>@s_-LQ8GH^|QJDY*NmRn3> zB*Vy_CmuxKZVDOE?$;tZ_-xW#n5}wtPmex#hHqf0iAWioIQhBEBXd{@JB!>FmJtZu zQkQ_@0~eO0pG-BDbolQabZu?Ot8}p?Tf{9i-KsPu2Cs~gYG@Tx@J=wvnhw857>%C_`uJr2pI;$n-I4iP~c=41Ta$7dUBqMa}P9zR` z#^})N6GkxYNb3jt?uIvKe)#lEY|wdoAmVMy(NE7)S9VVPHvIN{=cj*33OgqsN4)E} z`{{-Bm(F|dhTnDnP5Q)^{f~zXfHfck$`=nA6A(~eVo07 GSN{P_NWlvL literal 0 HcmV?d00001