Clean up Readme & Update Files

.github/workflows/dotnet-desktop.yml

@@ -57,7 +57,7 @@ jobs:
 
     # Upload the MSIX package: https://github.com/marketplace/actions/upload-a-build-artifact
     - name: Upload build artifacts
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       with:
         name: aimmyidk
         path: Aimmy2\bin\x64\Release\

ModelUpload.md

@@ -0,0 +1,44 @@
+## How do I upload my model to the "Downloadable Models" menu?
+
+If you are not aware already, Aimmy contains a "Downloadable Models" tab that allows you to download models developed and shared by the Aimmy Community.
+
+<img src="readme_assets/DownloadableModels.png">
+
+Aimmy pulls these models from the [Aimmy repository](https://github.com/Babyhamsta/Aimmy/tree/master/models), this means **anyone can upload models to the "Downloadable Models" tab by making a pull request**.
+
+To start, please note that if you would like to be credited for your work, name your model as:
+**[Game Name/Model Name]** by **[The Creator]**
+
+If you would like to stay anonymous however, you may only list the Game Name/Model Name.
+
+Now, fork the Aimmy Repository
+<img src="readme_assets/DT1.png">
+<img src="readme_assets/DT2.png">
+
+After that, go to your fork's model folder
+<img src="readme_assets/DT3.png">
+
+Press "Add File"
+<img src="readme_assets/DT4.png">
+
+Drag your model onto the area that contains the text "Drag additional files here to add them to your repository"
+<img src="readme_assets/DT5.png">
+
+and press "Commit Changes" when the green progress bar disappears
+<img src="readme_assets/DT6.png">
+
+Now go to the "Pull requests" tab
+<img src="readme_assets/DT7.png">
+
+Create a new pull request
+<img src="readme_assets/DT8.png">
+
+Create the pull request
+<img src="readme_assets/DT9.png">
+
+Create the pull request (again)
+<img src="readme_assets/DT10.png">
+
+You are done! We will review your pull request and your model will be added in 24-48 hours. If you would like to remove your model from the "Downloadable Models" tab, you may make another pull request or contact us on the Issues tab.
+
+For anyone who does this, thank you so much =D, Aimmy genuinely thrives with community contributions and support, and making and sharing your Aimmy models genuinely means a lot to us! Thank you!

README.md

@@ -3,7 +3,7 @@
 > If you enjoy Aimmy, please consider giving us a star ⭐! We appreciate it! :)
   <p>
     <a href="https://aimmy.dev/" target="_blank">
-      <img width="100%" src="https://raw.githubusercontent.com/Babyhamsta/Aimmy/master/readme_assets/AimmyV2Banner.png"></a>
+      <img width="100%" src="readme_assets/AimmyV2Banner.png"></a>
   </p>
 
 Aimmy is a universal AI-Based Aim Alignment Mechanism developed by BabyHamsta, MarsQQ & Taylor to make gaming more accessible for users who have difficulty aiming.
@@ -27,9 +27,8 @@ If you want to share Aimmy with your friends, our website is: https://aimmy.dev/
 - [Setup](#setup)
 - [How is Aimmy better than similar AI-Based tools?](#how-is-aimmy-better-than-similar-ai-based-tools)
 - [How the hell is Aimmy free?](#how-the-hell-is-aimmy-free)
-- [What is the Web Model?](#what-is-the-web-model)
 - [How do I train my own model?](#how-do-i-train-my-own-model)
-- [How do I upload my model to the "Downloadable Models" menu](#how-do-i-upload-my-model-to-the-downloadable-models-menu)
+- [How do I upload my model to the "Downloadable Models" menu](ModelUpload.md)
 
 
 
@@ -85,15 +84,15 @@ When you press the trigger binding, Aimmy will capture the screen and run the im
 ## Setup
 - Download and Install the x64 version of [.NET Runtime 8.0.X.X](https://dotnet.microsoft.com/en-us/download/dotnet/thank-you/runtime-desktop-8.0.2-windows-x64-installer)
 - Download and Install the x64 version of [Visual C++ Redistributable](https://aka.ms/vs/17/release/vc_redist.x64.exe)
-- Download Aimmy from [Releases](https://github.com/BabyHamsta/Aimmy/releases) (Make sure it's the Aimmy zip and not Source zip)
+- Download Aimmy from [Releases](releases) (Make sure it's the Aimmy zip and not Source zip)
 - Extract the Aimmy.zip file
 - Run Aimmy.exe
 - Choose your Model and Enjoy :)
 
 ## How is Aimmy better than similar AI-Based tools?
 Aimmy is written in C# using .NET 8 and WPF utilizing pre-existing libraries like DirectML and ONNX. This has allowed us to make a very fast Aim Aligner with high compatiblity on both AMD and NVIDIA GPUs without sacrificing the end-user experience.
 
-![Example of Model switching](https://github.com/Babyhamsta/Aimmy/blob/master/readme_assets/UI.gif?raw=true)
+![Example of Model switching](readme_assets/UI.gif?raw=true)
 
 Beyond the core functionality, Aimmy also adds some amazing additional features like Detection ESP and Anti-Recoil to help you tune your gaming experience however you like it.
 
@@ -110,77 +109,9 @@ This has meant that while we do currently use out of pocket expenses to run Aimm
 
 We do not seek to make money from Aimmy, we only seek your kind words <3, and a chance to help people aim better, by assisting their aim or even to train how they aim (yes, you can use Aimmy in that way too)
 
-## What is the Web Model
-The web model is a TFJS (TensorFlow Javascript) export of the model. This allow you to use the model for image labeling, which then images can be sent to us to help further train the PF/Universal model or you can use those images to train your own YOLOv8 model.
-You may wonder, "Why is it in YOLOv5 and not YOLOv8?". This is due to us using the tool called MakeSense, it to me is one of the easiest tools and is all web based. I am sure there are other tools that may accept the YOLOv8 web model.
-
-You can visit MakeSense here: https://www.makesense.ai
-You then can simply load all of your images in and select Object Detection.
-
-![image](https://github.com/MarsQQ/Aimmy/assets/22938086/35046774-b70b-4264-8c26-eba5fe0b6b9e)
-
-
-Then run the AI locally, select YOLOv5, and upload all the web model files.
-
-![image](https://github.com/MarsQQ/Aimmy/assets/22938086/78e6329d-0b55-453e-baf1-47186020b2b8)
-![image](https://github.com/MarsQQ/Aimmy/assets/22938086/0f13a664-0d0e-41aa-84b2-9d7f96daea1c)
-![image](https://github.com/MarsQQ/Aimmy/assets/22938086/f0896522-954d-4120-926f-b691673c802a)
-
-
-You can now go through your images and click and drag to highlight any Enemies on screen and approve the auto detected enemies from the web model:
-
-![image](https://github.com/MarsQQ/Aimmy/assets/22938086/f1288009-5e7a-4360-a1c5-bee9faf7f387)
-
-Once you are finished labeling you'll want to export the labels for AI training:
-
-![image](https://github.com/MarsQQ/Aimmy/assets/22938086/1af932c3-adde-4138-86f5-1c59934afae7)
-![image](https://github.com/MarsQQ/Aimmy/assets/22938086/05cc8837-8131-4035-897c-722301a0233b)
-
 ## How do I train my own model
-Please see the video tutorial bellow on how to label images and train your own model. (Redirects to Youtube)
+Please see the video tutorial below on how to label images and train your own model. (Redirects to Youtube)
 [![Watch the video on Youtube](https://img.youtube.com/vi/i98wF4218-Q/maxresdefault.jpg)](https://youtu.be/i98wF4218-Q)
 
 ## How do I upload my model to the "Downloadable Models" menu?
-
-If you are not aware already, Aimmy contains a "Downloadable Models" tab that allows you to download models developed and shared by the Aimmy Community.
-
-<img src="https://raw.githubusercontent.com/MarsQQ/Aimmy/master/readme_assets/DownloadableModels.png">
-
-Aimmy pulls these models from the [Aimmy repository](https://github.com/Babyhamsta/Aimmy/tree/master/models), this means **anyone can upload models to the "Downloadable Models" tab by making a pull request**.
-
-To start, please note that if you would like to be credited for your work, name your model as:
-**[Game Name/Model Name]** by **[The Creator]**
-
-If you would like to stay anonymous however, you may only list the Game Name/Model Name.
-
-Now, fork the Aimmy Repository
-<img src="https://raw.githubusercontent.com/MarsQQ/Aimmy/master/readme_assets/DT1.png">
-<img src="https://raw.githubusercontent.com/MarsQQ/Aimmy/master/readme_assets/DT2.png">
-
-After that, go to your fork's model folder
-<img src="https://raw.githubusercontent.com/MarsQQ/Aimmy/master/readme_assets/DT3.png">
-
-Press "Add File"
-<img src="https://raw.githubusercontent.com/MarsQQ/Aimmy/master/readme_assets/DT4.png">
-
-Drag your model onto the area that contains the text "Drag additional files here to add them to your repository"
-<img src="https://raw.githubusercontent.com/MarsQQ/Aimmy/master/readme_assets/DT5.png">
-
-and press "Commit Changes" when the green progress bar disappears
-<img src="https://raw.githubusercontent.com/MarsQQ/Aimmy/master/readme_assets/DT6.png">
-
-Now go to the "Pull requests" tab
-<img src="https://raw.githubusercontent.com/MarsQQ/Aimmy/master/readme_assets/DT7.png">
-
-Create a new pull request
-<img src="https://raw.githubusercontent.com/MarsQQ/Aimmy/master/readme_assets/DT8.png">
-
-Create the pull request
-<img src="https://raw.githubusercontent.com/MarsQQ/Aimmy/master/readme_assets/DT9.png">
-
-Create the pull request (again)
-<img src="https://raw.githubusercontent.com/MarsQQ/Aimmy/master/readme_assets/DT10.png">
-
-You are done! We will review your pull request and your model will be added in 24-48 hours. If you would like to remove your model from the "Downloadable Models" tab, you may make another pull request or contact us on the Issues tab.
-
-For anyone who does this, thank you so much =D, Aimmy genuinely thrives with community contributions and support, and making and sharing your Aimmy models genuinely means a lot to us! Thank you!
+Please read the tutorial at [UploadModel.md](ModelUpload.md)