Skip to content

Commit 9d1aaac

Browse files
authored
Updating!
1 parent 724a6c1 commit 9d1aaac

File tree

1 file changed

+31
-175
lines changed

1 file changed

+31
-175
lines changed

README.md

Lines changed: 31 additions & 175 deletions
Original file line numberDiff line numberDiff line change
@@ -1,186 +1,42 @@
1+
## Aimmy Arduino Edition!
2+
Aimmy 1.5.2... but with Arduino support!
3+
Wish I could add this to Aimmy 2.0, but unfortunately, it's closed source and I'm not an official dev for Aimmy.
14

2-
> [!NOTE]
3-
> If you enjoy Aimmy, please consider giving us a star ⭐! We appreciate it! :)
4-
<p>
5-
<a href="https://aimmy.dev/" target="_blank">
6-
<img width="100%" src="https://raw.githubusercontent.com/Babyhamsta/Aimmy/master/readme_assets/AimmyV2Banner.png"></a>
7-
</p>
5+
Star this repo to support me, but to support Aimmy's development donate to Babyhamsta via the attached sponsor link!
86

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.
7+
**DO NOT ASK FOR HELP ON DISCORD. ONLY DM ME IF YOU WANNA ADD HOST SHIELD SUPPORT.**
108

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.
9+
Tags: Arduino AI Aim, AI chair, AI Aim Assist, AI undetected, Undetected bot, Fortnite Bot Undetected, Fortnite Arduino
1210

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.
11+
## Features and Advantages
12+
- **HID Communication:** Utilizes HID instead of COM port communication, reducing detection risks in most games.
13+
- **Easy Setup:** Straightforward script upload process to your Arduino. Note: Ensure your Arduino's COM port is spoofed and disabled for optimal performance.
14+
- **Undetected Gameplay:** Offers undetected operation in most games including R6, CoD, Apex, and Fortnite. Detected in Valorant and CS2 FaceIt.
1415

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+
## Limitations
1617

17-
Please do not confuse Aimmy as an open-source project, we are not, and we have never been one.
18+
- **USB Host Shields:** Does not support USB Host Shields. Community contributions for this feature are welcome. Plug your mouse into your PC instead of the shield if you are using one.
19+
- **Chip Compatibility:** Specifically designed for Arduinos with an ATmega32U4 chip, such as the Leonardo R3. Other Arduinos might work by installing HoodLoader2 but the autospoofer won't work with those.
1820

19-
Want to connect with us? Join our Discord Server: https://discord.gg/aimmy
21+
## Setup Tutorial
22+
- [Video Tutorial](https://streamable.com/oknd08) NOTE: If you have problems compiling the Arduino script, scroll down and see the troubleshooting steps!
23+
- Download and install [Arduino IDE 1.8.19](https://downloads.arduino.cc/arduino-1.8.19-windows.exe)
24+
- Download [Aimmy Arduino Edition Download](https://github.com/Seconb/Aimmy-Arduino-Edition/releases/tag/v2) and extract it
25+
- Run arduinospoofer.exe **AS ADMIN**
26+
- Once that finishes, open MouseInstructArduino.ino
27+
- In that window, press CTRL+SHIFT+I. Search HID-Project and install it
28+
- Next, click the upload button (the arrow pointing to the right in the top left of the Arduino IDE), wait one second, then press the red RESET button on your Arduino in real life
29+
- If it says "Done Uploading.", you're set to continue, otherwise try again or fix whatever error it gave you.
30+
- Run Discord_protected.exe as admin (You can also run Discord.exe, but it's less safe against anticheats because it isn't packed with Themida)
2031

21-
If you want to share Aimmy with your friends, our website is: https://aimmy.dev/
32+
**DO NOT ASK ME FOR HELP ON DISCORD**
2233

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-
- [What is the Web Model?](#what-is-the-web-model)
31-
- [How do I train my own model?](#how-do-i-train-my-own-model)
32-
- [How do I upload my model to the "Downloadable Models" menu](#how-do-i-upload-my-model-to-the-downloadable-models-menu)
34+
## Troubleshooting
35+
- If your script doesn't compile, spoof your Arduino again using the Arduino spoofer and then go to %programfiles(x86)%\Arduino\hardware\arduino\avr\ by copy and pasting that into the Windows Search bar. Then, copy the boards.txt from there to %localappdata%\Arduino15\packages\arduino\hardware\avr\1.8.6 by copy and pasting it into the Windows Search bar. Next, right click the boards.txt files, go to properties, and check "Read-only". Save that. If you need to spoof your Arduino again, uncheck "Read-only" on both boards.txt files before doing so. It's really important that both boards.txt files are the same so confirm that they are and both are spoofed.
36+
- If you have any other issue consider watching the video extra carefully and redoing it. If all else fails idk what to tell you because I don't want to help you on Discord. This isn't for some inexperienced users this is for people who desperately need Arduino for Aimmy before it ever becomes an official update.
3337

38+
## Credits:
3439

35-
36-
## What is the purpose of Aimmy?
37-
### Aimmy was designed for Gamers who are at a severe disadvantage over normal gamers.
38-
### This includes but is not limited to:
39-
- Gamers who are physically challenged
40-
- Gamers who are mentally challenged
41-
- Gamers who suffer from untreated/untreatable visual impairments
42-
- Gamers who do not have access to a seperate Human-Interface Device (HID) for controlling the pointer
43-
- Gamers trying to improve their reaction time
44-
- Gamers with poor Hand/Eye coordination
45-
- Gamers who perform poorly in FPS games
46-
- Gamers who play for long periods in hot environments, causing greasy hands that make aiming difficult
47-
48-
## How does Aimmy Work?
49-
```mermaid
50-
flowchart LR
51-
A["Playing Game System"]
52-
C["Screen Grabbing Functionality"]
53-
B["YOLOv8 (DirectML + ONNX) Recognition"]
54-
D{Making Decision}
55-
DA["X+Y Adjustment"]
56-
DB["FOV"]
57-
E["Triggering Functionality"]
58-
F["Mouse Cursor"]
59-
60-
A --> E--> C --> B --> D --> F
61-
DA --> D
62-
DB --> D
63-
64-
```
65-
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.
66-
67-
## Features
68-
1. Full Fledged UI
69-
- Aimmy provides a well designed and full-fledged UI for easy usage and game adjustment.
70-
2. DirectML + ONNX + YOLOv8 AI Detection Algorithm
71-
- The use of these technologies allows Aimmy to be one of the most accurate and fastest Aim Alignment Mechanisms out there in the world
72-
3. Dynamic Customizability System
73-
- 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
74-
4. Dynamic Visual System
75-
- 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.
76-
5. Adjustable Anti-Recoil
77-
- 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
78-
6. Mouse Movement Method
79-
- Aimmy grants you the right to switch between 5 Mouse Movement Methods depending on your Mouse Type and Game for better Aim Alignment
80-
7. Hotswappability
81-
- Aimmy lets you hotswap models and configurations on the go. There is no need to reset Aimmy to make your changes
82-
8. Model and Configuration Store with Repository Support
83-
- 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
84-
85-
## Setup
86-
- 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)
87-
- Download and Install the x64 version of [Visual C++ Redistributable](https://aka.ms/vs/17/release/vc_redist.x64.exe)
88-
- Download Aimmy from [Releases](https://github.com/BabyHamsta/Aimmy/releases) (Make sure it's the Aimmy zip and not Source zip)
89-
- Extract the Aimmy.zip file
90-
- Run Aimmy.exe
91-
- Choose your Model and Enjoy :)
92-
93-
## How is Aimmy better than similar AI-Based tools?
94-
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.
95-
96-
![Example of Model switching](https://github.com/Babyhamsta/Aimmy/blob/master/readme_assets/UI.gif?raw=true)
97-
98-
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.
99-
100-
Aimmy comes pre-bundled with 2 well trained AI models with thousands of images each.
101-
1. Phantom Forces
102-
2. Universal Model
103-
104-
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.
105-
106-
## How the hell is Aimmy free?
107-
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.
108-
109-
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.
110-
111-
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)
112-
113-
## What is the Web Model
114-
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.
115-
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.
116-
117-
You can visit MakeSense here: https://www.makesense.ai
118-
You then can simply load all of your images in and select Object Detection.
119-
120-
![image](https://github.com/MarsQQ/Aimmy/assets/22938086/35046774-b70b-4264-8c26-eba5fe0b6b9e)
121-
122-
123-
Then run the AI locally, select YOLOv5, and upload all the web model files.
124-
125-
![image](https://github.com/MarsQQ/Aimmy/assets/22938086/78e6329d-0b55-453e-baf1-47186020b2b8)
126-
![image](https://github.com/MarsQQ/Aimmy/assets/22938086/0f13a664-0d0e-41aa-84b2-9d7f96daea1c)
127-
![image](https://github.com/MarsQQ/Aimmy/assets/22938086/f0896522-954d-4120-926f-b691673c802a)
128-
129-
130-
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:
131-
132-
![image](https://github.com/MarsQQ/Aimmy/assets/22938086/f1288009-5e7a-4360-a1c5-bee9faf7f387)
133-
134-
Once you are finished labeling you'll want to export the labels for AI training:
135-
136-
![image](https://github.com/MarsQQ/Aimmy/assets/22938086/1af932c3-adde-4138-86f5-1c59934afae7)
137-
![image](https://github.com/MarsQQ/Aimmy/assets/22938086/05cc8837-8131-4035-897c-722301a0233b)
138-
139-
## How do I train my own model
140-
Please see the video tutorial bellow on how to label images and train your own model. (Redirects to Youtube)
141-
[![Watch the video on Youtube](https://img.youtube.com/vi/i98wF4218-Q/maxresdefault.jpg)](https://youtu.be/i98wF4218-Q)
142-
143-
## How do I upload my model to the "Downloadable Models" menu?
144-
145-
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.
146-
147-
<img src="https://raw.githubusercontent.com/MarsQQ/Aimmy/master/readme_assets/DownloadableModels.png">
148-
149-
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**.
150-
151-
To start, please note that if you would like to be credited for your work, name your model as:
152-
**[Game Name/Model Name]** by **[The Creator]**
153-
154-
If you would like to stay anonymous however, you may only list the Game Name/Model Name.
155-
156-
Now, fork the Aimmy Repository
157-
<img src="https://raw.githubusercontent.com/MarsQQ/Aimmy/master/readme_assets/DT1.png">
158-
<img src="https://raw.githubusercontent.com/MarsQQ/Aimmy/master/readme_assets/DT2.png">
159-
160-
After that, go to your fork's model folder
161-
<img src="https://raw.githubusercontent.com/MarsQQ/Aimmy/master/readme_assets/DT3.png">
162-
163-
Press "Add File"
164-
<img src="https://raw.githubusercontent.com/MarsQQ/Aimmy/master/readme_assets/DT4.png">
165-
166-
Drag your model onto the area that contains the text "Drag additional files here to add them to your repository"
167-
<img src="https://raw.githubusercontent.com/MarsQQ/Aimmy/master/readme_assets/DT5.png">
168-
169-
and press "Commit Changes" when the green progress bar disappears
170-
<img src="https://raw.githubusercontent.com/MarsQQ/Aimmy/master/readme_assets/DT6.png">
171-
172-
Now go to the "Pull requests" tab
173-
<img src="https://raw.githubusercontent.com/MarsQQ/Aimmy/master/readme_assets/DT7.png">
174-
175-
Create a new pull request
176-
<img src="https://raw.githubusercontent.com/MarsQQ/Aimmy/master/readme_assets/DT8.png">
177-
178-
Create the pull request
179-
<img src="https://raw.githubusercontent.com/MarsQQ/Aimmy/master/readme_assets/DT9.png">
180-
181-
Create the pull request (again)
182-
<img src="https://raw.githubusercontent.com/MarsQQ/Aimmy/master/readme_assets/DT10.png">
183-
184-
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.
185-
186-
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!
40+
- [MouseInstruct Repository](https://github.com/khanxbahria/MouseInstruct) for their amazing HID library. Made mouse movement via Arduino easy.
41+
- Seconb (me)
42+
- The Aimmy Developers, because this is just Aimmy with some mods.

0 commit comments

Comments
 (0)