|
| 1 | +#  |
| 2 | +> DIY - Build It Yourself |
| 3 | +
|
| 4 | +If you are considering / curious about the build process of the Retro ESP Launcher, you will need a few things to prepare |
| 5 | + |
| 6 | +## Preperation |
| 7 | +> Git going |
| 8 | +
|
| 9 | +Clone the **Master** [Official Retro ESP32](https://github.com/retro-esp32/RetroESP32/) repo |
| 10 | + |
| 11 | +```shell |
| 12 | +git clone -b master --single-branch [email protected]:retro-esp32/RetroESP32.git --recursive |
| 13 | +cd RetroESP32 |
| 14 | +git submodule update --init --recursive |
| 15 | +git submodule foreach git pull origin master |
| 16 | +chmod -R 777 Scripts |
| 17 | +cd Scripts |
| 18 | +./installer |
| 19 | +``` |
| 20 | + |
| 21 | +It will take a while since we run a few ```git submodule``` inside the repository |
| 22 | + |
| 23 | +## Toolchain |
| 24 | +> You will need the xtensa esp32 toolchain |
| 25 | +
|
| 26 | +***Note:*** You only need to install the xtensa toolchain. The esp-idf is included in this repository. |
| 27 | + |
| 28 | +- [Linux](https://docs.espressif.com/projects/esp-idf/en/latest/get-started/linux-setup.html) |
| 29 | +- [Mac OS](https://docs.espressif.com/projects/esp-idf/en/latest/get-started/macos-setup.html) |
| 30 | +- [Windows](https://docs.espressif.com/projects/esp-idf/en/latest/get-started/windows-setup-scratch.html) |
| 31 | + |
| 32 | + |
| 33 | +## Bash Scripts |
| 34 | +> Some tools to help you along your way |
| 35 | +
|
| 36 | +Navigate to you newly cloned repository and execute the following |
| 37 | +``` |
| 38 | +chmod -R 777 Scripts |
| 39 | +cd Scripts |
| 40 | +``` |
| 41 | + |
| 42 | +***Note:*** All bash scripts **MUST** be executed from the Scripts folder. |
| 43 | + |
| 44 | + |
| 45 | +### Submodule Branches |
| 46 | +> Make sure all the submodules are on the right branches |
| 47 | +
|
| 48 | +``` |
| 49 | +./branches |
| 50 | +``` |
| 51 | + |
| 52 | +### Replace files for ILI9342 drivers |
| 53 | +> Copy relevant files for ILI9342 TFT LCD |
| 54 | +
|
| 55 | +``` |
| 56 | +./replace |
| 57 | +``` |
| 58 | + |
| 59 | +### ESP32 Environment Installer |
| 60 | +> Install all thing necessary (NIX/OS X) *Windows Coming Soon* |
| 61 | +
|
| 62 | +``` |
| 63 | +./installer |
| 64 | +``` |
| 65 | + |
| 66 | +### Environmanet Variables |
| 67 | +> Set all your paths |
| 68 | +> Be sure to run installer first |
| 69 | +
|
| 70 | +``` |
| 71 | +source ./helpers/paths |
| 72 | +``` |
| 73 | + |
| 74 | +### Build Firmware |
| 75 | +> Follow Onscreen Prompts |
| 76 | +> if this is your first time running the executable, answer **Y** to the options |
| 77 | +
|
| 78 | +``` |
| 79 | +./firmware |
| 80 | +``` |
| 81 | + |
| 82 | +You will now have a file called **Retro ESP32.fw** in the Firmware/Release folder. |
| 83 | + |
| 84 | +You can copy this onto your *SD Card* into the ***odroid/firmware*** folder |
| 85 | + |
| 86 | +##### Enabling new firmware |
| 87 | +> Insert the sd card into your Retro ESP32 / (Odroid Go) and follow the prompts |
| 88 | +
|
| 89 | +| List | Selection | Verification | Write | Reboot | |
| 90 | +| ---------------------------------------------- | ------------------------------------- | ------------------------------------------ | --------------------------------------------- | -------------------------------------- | |
| 91 | +|  |  |  |  |  | |
| 92 | + |
| 93 | +### Build and Load OTA |
| 94 | +> Follow Onscreen Prompts |
| 95 | +> if this is your first time running the executable, answer **Y** to the applicable options |
| 96 | +
|
| 97 | +### OTA |
| 98 | +> Flash directly to ESP32 |
| 99 | +
|
| 100 | +This is the easiest option, simple follow the onscreen prompts! |
| 101 | + |
| 102 | +``` |
| 103 | +./ota |
| 104 | +``` |
| 105 | + |
| 106 | +*note:* |
| 107 | + |
| 108 | +You will need to set the SPI ram for the emulators |
| 109 | + |
| 110 | +| Screen Grab | Instructions | |
| 111 | +| ----------------------------------------- | ------------------------------------------------------------ | |
| 112 | +|  | Answer **Y** | |
| 113 | +|  | Answer **N** | |
| 114 | +|  | Answer **Y** (This is IMPORTANT) | |
| 115 | +|  | Navigate to ```Component config -->``` | |
| 116 | +|  | Navigate to ```ESP32-specific -->``` | |
| 117 | +|  | Navigate to ```SPI RAM config -->``` | |
| 118 | +|  | Navigate to ```Type of SPI RAM chip in use (some value) -->``` | |
| 119 | +|  | Select ```Auto-detect``` | |
| 120 | + |
| 121 | + |
| 122 | + |
| 123 | +### Erase |
| 124 | + |
| 125 | +> Erase flash and storage from ESP32 |
| 126 | +
|
| 127 | +``` |
| 128 | +./erase |
| 129 | +``` |
| 130 | + |
| 131 | +### Arduino |
| 132 | +> Create Firmware from Arduino ```.ino.bin``` file |
| 133 | +
|
| 134 | +``` |
| 135 | +./arduino |
| 136 | +``` |
| 137 | + |
| 138 | +You will now have a ```.fw``` file in Arduino/firmware folder. |
| 139 | + |
| 140 | +You can copy this onto your *SD Card* into the ***odroid/firmware*** folder |
| 141 | + |
| 142 | + |
| 143 | +###  |
| 144 | +# Retro ESP32 |
| 145 | +> Software Branch |
| 146 | +
|
| 147 | +Finally a new launcher for your Odroid-Go |
| 148 | + |
| 149 | +``` |
| 150 | +cd Launchers/retro-esp32 |
| 151 | +make menuconfig |
| 152 | +``` |
| 153 | + |
| 154 | +1. Select ```Restro ESP32 Configuration```  |
| 155 | + |
| 156 | +2. Select your options |
| 157 | + * *Select* **LCD Driver Chip** |
| 158 | + * *Select* **MENU Key Options** |
| 159 | + * *Select* **In Game Menu** |
| 160 | + |
| 161 | +3. Run ```./ota``` (see above) |
| 162 | + |
| 163 | +| Splash | Navigation | ROM State Management | Run | |
| 164 | +| ------------------------------- | ------------------------------ | -------------------------------- | ---------------------------- | |
| 165 | +|  |  |  |  | |
| 166 | + |
| 167 | +----- |
| 168 | + |
| 169 | +> ## Although we do this for 💕 of 🕹️ |
| 170 | +> **We Also Like Coffee!** |
| 171 | +> *Please Consider Supporting*<br> |
| 172 | +> [](https://github.com/sponsors/retro-esp32) |
| 173 | +
|
| 174 | +----- |
0 commit comments