ZareMate
f6aa6cd626
Add installation scripts for Windows and Linux, and update README for usage instructions
80 lines
1.7 KiB
Markdown
80 lines
1.7 KiB
Markdown
# ESP32 Discord Controller
|
|
|
|
This project allows you to control Discord mute and deafen status using an ESP32 device. The script captures the screen to detect the status and communicates with the ESP32 via a serial connection.
|
|
|
|
## Installation
|
|
|
|
### Prerequisites
|
|
|
|
- Python 3.x
|
|
- pip (Python package installer)
|
|
- An ESP32 device
|
|
- A USB cable to connect the ESP32 to your computer
|
|
|
|
### Clone the Repository
|
|
|
|
Clone this repository to your local machine:
|
|
|
|
```sh
|
|
git clone https://github.com/yourusername/ESP32-discord.git
|
|
cd ESP32-discord
|
|
```
|
|
|
|
### Windows Installation
|
|
|
|
Run the following batch file to set up the virtual environment and install the required Python packages:
|
|
|
|
```sh
|
|
install_windows.bat
|
|
```
|
|
|
|
### Linux Installation
|
|
|
|
Run the following shell script to set up the virtual environment and install the required Python packages:
|
|
|
|
```sh
|
|
./install_linux.sh
|
|
```
|
|
|
|
## Usage
|
|
|
|
### Running the Script
|
|
|
|
You can run the script with the following command:
|
|
|
|
#### Windows
|
|
|
|
```sh
|
|
start.bat
|
|
```
|
|
|
|
#### Linux
|
|
|
|
```sh
|
|
./start.sh
|
|
```
|
|
|
|
### Specifying the COM Port
|
|
|
|
You can specify the COM port directly when running the script:
|
|
|
|
```sh
|
|
pythonw main.pyw -com=COM3
|
|
```
|
|
|
|
### Hiding the Console Window
|
|
|
|
If the COM port is specified, the script will hide the console window and run in the system tray. You can quit the application from the tray icon.
|
|
|
|
### GUI
|
|
|
|
The script now includes a GUI that looks like Windows 11 dark mode. It will automatically hide the console window and show the GUI.
|
|
|
|
## Notes
|
|
|
|
- Ensure that your ESP32 device is connected to your computer via USB.
|
|
- The script captures a small region of the screen to detect the mute and deafen status. Adjust the coordinates and dimensions in the script if necessary.
|
|
|
|
## License
|
|
|
|
This project is licensed under the MIT License. |