diff --git a/INSTALL.md b/INSTALL.md index 8f641ed..3a959cd 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -1,17 +1,14 @@ # Install guide -Here you can find out how to install minigotchi on the ESP8266. Installing on the Pico is not possible as the code is meant for the ESP8266. - -**For building on an ESP32, see [this](https://github.com/Pwnagotchi-Unofficial/minigotchi-ESP32/blob/development/INSTALL.md). Don't use this repository for the ESP32.** - ## Building using Arduino IDE ### Step 1: Configuration + - Download the latest release [here](https://github.com/Pwnagotchi-Unofficial/minigotchi/releases). - Unzip the file -- Navigate to the `config.cpp` file in the unzipped folder, and open it up with the text editor of your choice. Configurations are always controlled here. +- Navigate to the `config.cpp` file in the unzipped folder, and open it up with the text editor of your choice. Configurations are always controlled here. - At the set of lines that says: @@ -21,9 +18,9 @@ bool Config::deauth = true; bool Config::advertise = true; ``` -From here, you can turn off deauthing or advertising. Since this is the main feature of the minigotchi, I highly recommend you don't turn either of these off. +From here, you can turn off deauthing or advertising. Since this is the main feature of the minigotchi, I highly recommend you don't turn either of these off. -- After that, there should be a line that states the buad rate. +- After that, there should be a line that states the buad rate. ```cpp // baud rate @@ -49,7 +46,7 @@ Replace the `"fo:od:ba:be:fo:od"` with your actual BSSID(in the quotations), and std::string Config::whitelist[] = {"fo:od:ba:be:fo:od", "fo:od:ba:be:fo:od", "fo:od:ba:be:fo:od"}; ``` -This defines our whitelist. The minigotchi will not deauth these access points. We can have up to ten values here. Three were added as an example, you can remove those. +This defines our whitelist. The minigotchi will not deauth these access points. We can have up to ten values here. Three were added as an example, you can remove those. - Here, we set the channels we hop from time to time. @@ -60,22 +57,18 @@ int Config::channels[3] = {1, 6, 11}; Usually this shouldn't be changed as these are the best channels for IOT boards such as an ESP8266. -- Save and exit the file when you have configured everything to your liking. Note you cannot change this after this is flashed onto the board. +- Save and exit the file when you have configured everything to your liking. Note you cannot change this after this is flashed onto the board. ### Step 2: Building and flashing - Download the [Arduino IDE](https://https://www.arduino.cc/en/software), preferably the latest version. -- In the IDE, go to `File` > `Preferences`, then in the `Additional board manager URLS`, paste the link `https://arduino.esp8266.com/stable/package_esp8266com_index.json` to add the ESP8266 board(s) to the board manager - -- Click `Ok` and plug the board into your computer. It should blink, make sure it is receiving the correct amount of voltage, too much will burn it(I learned that the hard way) - -- Open up the minigotchi folder through the IDE by pushing `Ctrl+O`, or by going to `File` > `Open`, then selecting the folder the .ino is in. If other tabs don't show up, along with `minigotchi.ino`, make sure to copy and paste the files into the same directory/folder as that lone `.ino` file. It won't be able to compile if that happens. +- Open up the minigotchi folder through the IDE by pushing `Ctrl+O`, or by going to `File` > `Open`, then selecting the folder the .ino is in. If other tabs don't show up, along with `minigotchi.ino`, make sure to copy and paste the files into the same directory/folder as that lone `.ino` file. It won't be able to compile if that happens. -- Install the following dependancies with the library manager: `ArduinoJson`, etc with all with their dependancies(Please install all of them for them to work correctly). +- Install the following dependencies with the library manager: `ArduinoJson`, etc with all with their dependancies(Please install all of them for them to work correctly). -- Select the board as `ESP8266 WEMOS(LOLIN) D1 mini Lite`, and select the port it is plugged into(if you haven't already, plug in the board) -- Click on the upload button(arrow pointing to the left). +- Select the board as the name of your ESP32 board(most of them should be supported by Arduino, but usually a google helps), and select the port it is plugged into(if you haven't already, plug in the board) +- Click on the upload button(arrow pointing to the left). **OR** @@ -85,7 +78,7 @@ Usually this shouldn't be changed as these are the best channels for IOT boards ### Step 3: Post Install -- You can click on the *Serial Monitor* button on the top bar to see the serial monitor output. Make sure the baud rate is `115200`. You can also use https://serial.huhn.me/ as a serial monitor, I also recommend using this! +- You can click on the *Serial Monitor* button on the top bar to see the serial monitor output. Make sure the baud rate is `115200`. You can also use https://serial.huhn.me/ as a serial monitor, I also recommend using this! - Happy hacking! diff --git a/README.md b/README.md index adb12c0..89ecd99 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ ### Intro -Due to a surge in people asking for ESP32 support, I have created this fork. Fundamentally the ESP8266 and ESP32 can perform similar functions, although the ESP32 has more features, memory, computing power, etc. +Due to a surge in people asking for ESP32 support, I have created this fork. Fundamentally the ESP8266 and ESP32 can perform similar functions, although the ESP32 has more features, memory, computing power, etc. Development may be a bit slower as I am still working on the actual [Minigotchi](https://github.com/Pwnagotchi-Unofficial/minigotchi). As soon as this project is finished, I will start working on porting! ### Install guide