Willy/windows_usbkill
Willy
/
windows_usbkill
1
0
Fork 0
Code Issues Releases 3 Activity

Simplified readme

This commit is contained in:
Willy 2023-11-25 19:29:14 -05:00
parent 32e913b8d3
commit 86daa51ea3
1 changed files with 30 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

76
README.md
View File

@ -1,47 +1,31 @@
# windows_usbkill
This script is my version of <https://github.com/hephaest0s/usbkill> for Windows 11 and 10 which runs in the system tray. The script will shutdown your Windows machine if it detects a device that gets plugged into your computer's USB ports, which will be logged to a .txt file. There is also a pause/unpause feature in the event you need to plug in a USB device.
This script has been tested on Windows 11 22H2.
## Install (Python)
1. Install Python 3 for Windows.
2. ```git clone https://git.willys.zone/Willy/windows_usbkill.git```
3. ```cd .\windows_usbkill\```
4. ```pip install -r requirements.txt```
5. ```python3 windows_usbkill.py```
To make the script start when any user logs in:
1. Edit ```python launcher.bat``` and set the directory of the ```windows_usbkill.py``` file.
2. Press windows-key + R then type "shell:common startup".
3. Drop ```python launcher.bat``` inside of the folder.
4. Reboot and check your system tray.
You may also use [Non-sucking Service Manager](https://nssm.cc/) to run the script as a Windows service.
## Install (.exe)
**Notice**: Python executables made with pyinstaller are sometimes falsely flagged as viruses by anti-viruses; if the AV is causing issues, I recommend using the python method above. Keep in mind that since this executable is unsigned, you will get a one-time "unrecognized app" prompt. Press "More Info" and then "Run Anyway.".
1. Download the latest version from the "Releases" page.
2. Create a shortcut of the executable.
3. Press windows-key + R then type "shell:common startup".
4. Drop the executable inside of the folder.
5. Reboot and check your system tray.
## Uninstall
1. Press windows-key + R, then type "shell:common startup".
2. Delete the .bat file or the shortcut file inside the folder.
3. Reboot.
## Build
1. Install Python 3 for Windows.
2. ```git clone https://git.willys.zone/Willy/windows_usbkill.git```
3. ```cd .\windows_usbkill\```
4. ```pip install -r requirements.txt```
5. ```pip install pyinstaller```
6. ```pyinstaller.exe .\windows_usbkill.spec```
## Notice
# windows_usbkill
This script is my version of <https://github.com/hephaest0s/usbkill> for Windows 11 and 10 which runs in the system tray. The script will shutdown your Windows machine if it detects a device that gets plugged into your computer's USB ports, which will be logged to a .txt file. There is also a pause/unpause feature in the event you need to plug in a USB device.
This script has been tested on Windows 11 22H2.
## Install (Python)
1. Install Python 3 for Windows.
2. ```git clone https://git.willys.zone/Willy/windows_usbkill.git```
3. ```cd .\windows_usbkill\```
4. ```pip install -r requirements.txt```
5. ```python3 windows_usbkill.py```
I recommend using [Non-sucking Service Manager](https://nssm.cc/) to run the script as a Windows service.
## Install (.exe)
**Notice**: Python executables made with pyinstaller are sometimes falsely flagged as viruses by anti-viruses; if the AV is causing issues, I recommend using the python method above. Keep in mind that since this executable is unsigned, you will get a one-time "unrecognized app" prompt. Press "More Info" and then "Run Anyway.".
1. Download the latest version from the "Releases" page.
2. Run executable.
## Build
1. Install Python 3 for Windows.
2. ```git clone https://git.willys.zone/Willy/windows_usbkill.git```
3. ```cd .\windows_usbkill\```
4. ```pip install -r requirements.txt```
5. ```pip install pyinstaller```
6. ```pyinstaller.exe .\windows_usbkill.spec```
## Notice
This script will shutdown your system if a USB device is plugged in. You will loose **ALL** unsaved progress/data. Use this script at your own risk. The author is not liable for lost data.