|
8 | 8 |
|
9 | 9 | 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. |
10 | 10 |
|
11 | | -Unlike most AI-Based Aim Alignment Mechanisms, Aimmy utilizes DirectML, ONNX, and YOLOV8 to detect players, offering both higher accuracy and faster performance compared to other Aim Aligners, especially on AMD GPUs, which would not perform well on Aim Alignment Mechanisms that utilize TensorRT. |
12 | | - |
13 | | -Aimmy also provides an easy to use user-interface, a wide set of features and customizability options which makes Aimmy a great option for anyone who wants to use and tailor an Aim Alignment Mechanism for a specific game without having to code. |
14 | | - |
15 | | -Aimmy is 100% free to use. This means no ads, no key system, and no paywalled features. Aimmy is not, and will never be for sale for the end user, and is considered a source-available product, **not open source** as we actively discourage other developers from making commercial forks of Aimmy. |
16 | | - |
17 | | -Please do not confuse Aimmy as an open-source project, we are not, and we have never been one. |
18 | | - |
19 | | -Want to connect with us? Join our Discord Server: https://discord.gg/aimmy |
20 | | - |
21 | | -If you want to share Aimmy with your friends, our website is: https://aimmy.dev/ |
22 | | - |
23 | | -## Table of Contents |
24 | | -- [What is the purpose of Aimmy?](#what-is-the-purpose-of-aimmy) |
25 | | -- [How does Aimmy Work?](#how-does-aimmy-work) |
26 | | -- [Features](#features) |
27 | | -- [Setup](#setup) |
28 | | -- [How is Aimmy better than similar AI-Based tools?](#how-is-aimmy-better-than-similar-ai-based-tools) |
29 | | -- [How the hell is Aimmy free?](#how-the-hell-is-aimmy-free) |
30 | | -- [How do I train my own model?](#how-do-i-train-my-own-model) |
31 | | -- [How do I upload my model to the "Downloadable Models" menu](ModelUpload.md) |
32 | | - |
33 | | - |
34 | | - |
35 | | -## What is the purpose of Aimmy? |
36 | | -### Aimmy was designed for Gamers who are at a severe disadvantage over normal gamers. |
37 | | -### This includes but is not limited to: |
38 | | -- Gamers who are physically challenged |
39 | | -- Gamers who are mentally challenged |
40 | | -- Gamers who suffer from untreated/untreatable visual impairments |
41 | | -- Gamers who do not have access to a seperate Human-Interface Device (HID) for controlling the pointer |
42 | | -- Gamers trying to improve their reaction time |
43 | | -- Gamers with poor Hand/Eye coordination |
44 | | -- Gamers who perform poorly in FPS games |
45 | | -- Gamers who play for long periods in hot environments, causing greasy hands that make aiming difficult |
46 | | - |
47 | | -## How does Aimmy Work? |
48 | | -```mermaid |
49 | | -flowchart LR |
50 | | -A["Playing Game System"] |
51 | | -C["Screen Grabbing Functionality"] |
52 | | -B["YOLOv8 (DirectML + ONNX) Recognition"] |
53 | | -D{Making Decision} |
54 | | -DA["X+Y Adjustment"] |
55 | | -DB["FOV"] |
56 | | -E["Triggering Functionality"] |
57 | | -F["Mouse Cursor"] |
58 | | -
|
59 | | -A --> E--> C --> B --> D --> F |
60 | | -DA --> D |
61 | | -DB --> D |
62 | | -
|
| 11 | +> [!NOTE] |
| 12 | +> **I highly recommend you to use TensorRT, if your gpu is older and doesn't have Tensor Cores (Check this by googling), I suggest trying CUDA and then comparing to the regular [aimmy](https://github.com/BabyHamsta/Aimmy)**. |
| 13 | +
|
| 14 | +> [!IMPORTANT] |
| 15 | +> DOWNLOAD the **DLL INCLUDED**!!! There is **no** performance difference |
| 16 | +
|
| 17 | +> [!CAUTION] |
| 18 | +> No, CUDA/TensorRT does **NOT** work on your **AMD/INTEL GPU!!!** |
| 19 | +
|
| 20 | +## What is TensorRT? |
| 21 | +@mastere4 says, *"Pretty much an add-on for CUDA. While it does make your gameplay smoother and faster, it's a double edge sword by making your models loading time drastically slower for 1st time instances."* |
| 22 | + |
| 23 | +## Comparison between TensorRT and CUDA |
| 24 | +```diff |
| 25 | ++ TensorRT has a 5-10ms difference for me. |
| 26 | ++ TensorRT is guaranteed to optimize your model for better accuracy, and faster iteration times. |
| 27 | ++ TensorRT optimizes a model and uses precision methods for accuracy. |
| 28 | ++ TensorRT has a GPU Memory Limit |
| 29 | ++ TensorRT has INT8 Precision and FP16 Precision. |
| 30 | +- TensorRT Caching takes a lot of space if you are optimizing a lot of models. |
| 31 | +- TensorRT takes way longer to load a model (for the 1st load), 384 - 60 seconds, but after caching, it'll take about 40-9 seconds. |
| 32 | +- ONNXRuntime's caching system is difficult, being way slower than the DLL i have created, but no way to use my DLL in conjuction with ONNXRuntime. |
| 33 | +- About 560MB, and extra installation (though quite simple) |
| 34 | + |
| 35 | ++ CUDA model loadtimes are almost instantaneous |
| 36 | ++ CUDA also has a GPU Memory Limit |
| 37 | ++ CUDA can use TF32 as a Math Mode. |
| 38 | ++ CUDA is 560MB less than the TensorRT installation |
| 39 | +- CUDA does not have the optimizations that TensorRT provides |
| 40 | +- CUDA is approximately 10-5ms slower than TensorRT |
63 | 41 | ``` |
64 | | -When you press the trigger binding, Aimmy will capture the screen and run the image through AI recognition powered by your computer hardware. The result it develops will be combined with any adjustment you made in the X and Y axis, and your current FOV and will result in a change in your mouse cursor position. |
65 | | - |
66 | | -## Features |
67 | | -1. Full Fledged UI |
68 | | - - Aimmy provides a well designed and full-fledged UI for easy usage and game adjustment. |
69 | | -2. DirectML + ONNX + YOLOv8 AI Detection Algorithm |
70 | | - - The use of these technologies allows Aimmy to be one of the most accurate and fastest Aim Alignment Mechanisms out there in the world |
71 | | -3. Dynamic Customizability System |
72 | | - - Aimmy provides an interactive customizability system with various features that auto-updates the way Aimmy will aim as you customize. From AI Confidence, to FOV, to Anti-Recoil Adjustment, Aimmy makes it easy for anyone to tune their aim |
73 | | -4. Dynamic Visual System |
74 | | - - Aimmy contains a universal ESP system that will highlight the player detected by the AI. This is helpful for visually impaired users who have a hard time differentiating enemies, and for configuration creators attempting to debug their configurations. |
75 | | -5. Adjustable Anti-Recoil |
76 | | - - Aimmy offers an incredibly customizable Anti-Recoil system that's designed to be easy to use. With features like recording your Fire Rate, setting your X and Y adjustment, and Configuration Switch Keybindings |
77 | | -6. Mouse Movement Method |
78 | | - - Aimmy grants you the right to switch between 5 Mouse Movement Methods depending on your Mouse Type and Game for better Aim Alignment |
79 | | -7. Hotswappability |
80 | | - - Aimmy lets you hotswap models and configurations on the go. There is no need to reset Aimmy to make your changes |
81 | | -8. Model and Configuration Store with Repository Support |
82 | | - - Aimmy makes it easy to get any models and configurations you may ever need, and with repository support, you can get up to date with the latest models and configurations from your favorite creators |
83 | | - |
84 | | -## Setup |
85 | | -- 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) |
86 | | -- Download and Install the x64 version of [Visual C++ Redistributable](https://aka.ms/vs/17/release/vc_redist.x64.exe) |
87 | | -- Download Aimmy from [Releases](releases) (Make sure it's the Aimmy zip and not Source zip) |
88 | | -- Extract the Aimmy.zip file |
89 | | -- Run Aimmy.exe |
90 | | -- Choose your Model and Enjoy :) |
91 | | - |
92 | | -## How is Aimmy better than similar AI-Based tools? |
93 | | -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. |
94 | | - |
95 | | - |
96 | | - |
97 | | -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. |
98 | | - |
99 | | -Aimmy comes pre-bundled with 2 well trained AI models with thousands of images each. |
100 | | -1. Phantom Forces |
101 | | -2. Universal Model |
102 | | - |
103 | | -Besides those 2 models, Aimmy provides dozens of other community made models through the store, with more models being developed every day by other Aimmy users. These models vary from game to image count, making Aimmy incredibly versatile and universal for thousands of games on the market right now. |
104 | | - |
105 | | -## How the hell is Aimmy free? |
106 | | -As an AI based Aim Aligner, Aimmy does not require any sort of upkeep because it does not read any specific game data to perform it's actions. If Aimmy team stops maintaining Aimmy, even if no one pitches in to fork and maintain the project, Aimmy would still work. |
107 | | - |
108 | | -This has meant that while we do currently use out of pocket expenses to run Aimmy, those expenses have been low enough that it hasn't been a necessity for Aimmy to run on even an ad-supported model. |
109 | | - |
110 | | -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) |
111 | | - |
112 | | -## How do I train my own model |
113 | | -Please see the video tutorial below on how to label images and train your own model. (Redirects to Youtube) |
114 | | -[](https://youtu.be/i98wF4218-Q) |
115 | | - |
116 | | -## How do I upload my model to the "Downloadable Models" menu? |
117 | | -Please read the tutorial at [UploadModel.md](ModelUpload.md) |
| 42 | + |
| 43 | +## How do I check my benchmarks? |
| 44 | +Our benchmarks appear while using Debug Mode, which you will find in the settings tab. Turn it on **before** loading a model to get more information. After closing aimmy or by loading another model, inside **debug.txt** you will find a large text telling you |
| 45 | +the _ms_ times for each function. The main one you should look at is most likely the AILoop Iteration Times, which is how long it takes to iterate through everything. |
| 46 | + |
| 47 | +To get accurate Benchmarking times, play around a little in your favourite game with your favourite model. Use various confidences, etc. |
| 48 | + |
| 49 | +## Optimization |
| 50 | +While the new 2.4.x version of Regular DirectML Aimmy is great and optimized, it is better to use CUDA/TensorRT where you can. I am very proud of the improvement and performance changes I have done using OnnxRuntimes CUDA package. |
| 51 | +I highly recommend any nvidia user to use CUDA unless their GPU/Benchmarking times prove that it is not worth so. But try it at least once. |
| 52 | +You can look through my code as well and see for yourself if it has mem leaks, slow code, messy organization etc. (I will gladly fix it if you let me know) |
| 53 | + |
| 54 | +Here are some documentation proving speed of ONNX's EP's: |
| 55 | +- **[COMPARISON BETWEEN CUDA, DIRECTML, AND TENSORRT](https://nietras.com/2021/01/25/onnxruntime/#:~:text=some%20warmup%20before.-,Execution%20Provider,1.56,-DirectML)** ⭐⭐⭐⭐⭐ |
| 56 | +- [ONNX DOC](https://onnxruntime.ai/docs/execution-providers/TensorRT-ExecutionProvider.html#:~:text=With%20the%20TensorRT%20execution%20provider%2C%20the%20ONNX%20Runtime%20delivers%20better%20inferencing%20performance%20on%20the%20same%20hardware%20compared%20to%20generic%20GPU%20acceleration.) |
| 57 | +- [COMPARISON ARTICLE](https://medium.com/@sundarbalamurugan/comparision-between-tensorrt-pytorch-onnx-runtime-2842bd208d73) |
| 58 | + |
| 59 | +Beware of credibility. |
| 60 | + |
| 61 | +## Need help? |
| 62 | +Before reaching out, make sure you have the **DLL-INCLUDED**, you will know because the zip file will say that it is dll-included. Also, please check the WIKI, it has all the answers to 99.99% of your problems. |
| 63 | + |
| 64 | +Aimmy will let you know if your aimmy won't work at startup, if the cuda files are missing, tensorrt files are missing, etc. |
| 65 | + |
| 66 | +This is also just the same as Regular Aimmy, you need the basic dependencies. |
| 67 | + |
| 68 | +To run Aimmy you first need all of the dependencies which are |
| 69 | +- [.NET v7](https://download.visualstudio.microsoft.com/download/pr/e8b0aac4-7f86-4a7b-9a9a-448aa2b0f116/99a4178751b799db3d059b4b22b4451e/windowsdesktop-runtime-7.0.18-win-x64.exe) |
| 70 | +- [.NET v8](https://download.visualstudio.microsoft.com/download/pr/c1d08a81-6e65-4065-b606-ed1127a954d3/14fe55b8a73ebba2b05432b162ab3aa8/windowsdesktop-runtime-8.0.4-win-x64.exe) |
| 71 | +- [VCRedist](https://aka.ms/vs/17/release/vc_redist.x64.exe) |
| 72 | +Run "TotallyNotAimmyV2.exe". if you run "AimmyLauncher.exe" run it as admin. |
| 73 | + |
| 74 | +The reason for us asking you to use dll-included is because there can be so many difficulties making sure you have the correct versions, which is why I made it easier for all of you! |
| 75 | + |
| 76 | + |
| 77 | +**Join https://discord.gg/aimmy for extensive help, most likely in #community-support.** |
0 commit comments