Skip to content

Commit 48e0f17

Browse files
Update README.md
1 parent c37c717 commit 48e0f17

File tree

1 file changed

+47
-11
lines changed

1 file changed

+47
-11
lines changed

README.md

Lines changed: 47 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -30,21 +30,57 @@ ArduinoStrike is a program designed to control the recoil of weapons in **Counte
3030
- **Hardware**: Arduino Leonardo (or compatible board with native USB HID support)
3131
- **Software**: Arduino IDE, Counter-Strike 2
3232

33-
### Installation
33+
### Installation
34+
35+
#### Option 1: Using PlatformIO (Recommended)
36+
3437
1. **Clone the Repository**
35-
```bash
36-
git clone https://github.com/DeniedAccessLife/ArduinoStrike.git
37-
cd ArduinoStrike
38-
```
38+
```bash
39+
git clone https://github.com/DeniedAccessLife/ArduinoStrike.git
40+
cd ArduinoStrike
41+
```
42+
43+
2. **Upload the Firmware**
44+
- Navigate to the `PlatformIO` folder:
45+
46+
```bash
47+
cd PlatformIO
48+
```
49+
- Run the `upload.bat` script for Windows.
50+
- The script will automatically compile and upload the firmware to your connected Arduino board.
51+
- Ensure the correct board and port are specified in the `platformio.ini` file.
52+
53+
3. **Adding Support for Custom HID-Compatible Boards**
54+
- If you plan to use a custom board with HID emulation, update the `platformio.ini` file located in the `PlatformIO` folder with the appropriate configurations for your board.
55+
- Modify the `upload.bat` script in the same folder to support additional options.
56+
57+
---
58+
59+
#### Option 2: Using Arduino IDE
60+
61+
1. **Clone the Repository**
62+
```bash
63+
git clone https://github.com/DeniedAccessLife/ArduinoStrike.git
64+
cd ArduinoStrike
65+
```
66+
67+
2. **Locate the Sketch File**
68+
- The sketch file is located in the `PlatformIO/src` folder as `ArduinoStrike.cpp`.
69+
70+
3. **Convert the Sketch for Arduino IDE**
71+
- Rename `ArduinoStrike.cpp` to `ArduinoStrike.ino`.
72+
- Create a new folder named `ArduinoStrike` in the `Arduino` projects directory on your system.
73+
- Move the renamed file into the newly created `ArduinoStrike` folder.
3974

40-
2. **Open the Project in Arduino IDE**
41-
Open the `ArduinoStrike.ino` file located in the `ArduinoSketch` folder in the repository.
75+
4. **Open the Project in Arduino IDE**
76+
- Launch the Arduino IDE and open the newly created `ArduinoStrike.ino` file.
4277

43-
3. **Connect and Configure Arduino**
44-
Connect Arduino board to your computer. In the Arduino IDE, select the appropriate **Board** (`Arduino Leonardo`) and **Port**.
78+
5. **Connect and Configure Arduino**
79+
- Connect your Arduino board to your computer.
80+
- In the Arduino IDE, select the appropriate **Board** (e.g., `Arduino Leonardo`) and **Port**.
4581

46-
4. **Upload the Firmware**
47-
Click the **Upload** button in the Arduino IDE to flash the `ArduinoStrike` firmware to your board. Once uploaded, your Arduino will function as an HID device, controlling mouse movements according to the code logic.
82+
6. **Upload the Firmware**
83+
- Click the **Upload** button to flash the firmware onto your board.
4884

4985
# Configuration
5086
If the `Settings.cfg` file is not found when launching the program, you will be prompted to enter the following settings into the console:

0 commit comments

Comments
 (0)