|
| 1 | +[](https://github.com/retro-esp32/RetroESP32/releases/tag/v.1.1.0-Font-Size-Fix) |
| 2 | +[](https://github.com/retro-esp32/RetroESP32/releases) |
| 3 | +[]() |
| 4 | +------ |
| 5 | +#### Buy Us A Coffee |
| 6 | +> It's Not Mandatory, But Much [Appreciated](https://www.paypal.me/32teeth/1.99USD) |
| 7 | +
|
| 8 | +We work tirelessly to bring you the best **Odroid GO** and **Retro ESP32** user experience. |
| 9 | + |
| 10 | +Everything we provide is free to use, Feedback is always welcome. |
| 11 | + |
| 12 | +If you like what you see, and feel like giving us additional support, we accept **PayPal** donation of $1.99 USD, that's like, 1 coffee. But fee free to change the amount. We won't shy away! |
| 13 | + |
| 14 | +*Thank You* |
| 15 | +Retro ESP32 Team |
| 16 | + |
| 17 | +------ |
| 18 | + |
1 | 19 | #  |
2 | | -> Retro ESP32 is a turbo charged Odroid Go Launcher, Emulator and ROM Manager |
| 20 | +> Software Branch |
| 21 | +
|
| 22 | +## Launcher |
| 23 | + |
| 24 | +This branch contains the specific modification for the Odroid Go hardware to use the 320x240 ILI9342 2.6" and 240x320 ILI9341 display |
| 25 | + |
| 26 | +- [x] Odroid Go - [Firmware](https://github.com/OtherCrashOverride/odroid-go-firmware) |
| 27 | +- [x] ROM Management |
| 28 | +- [x] Config for both ILI9341/2 |
| 29 | + |
| 30 | +## Supported Emulators |
| 31 | +> What else do you need to know, there are 11 currently supported |
| 32 | +
|
| 33 | +- [x] Nintendo Entertainment System |
| 34 | +- [x] Nintendo Game Boy |
| 35 | +- [x] Nintendo Game Boy Color |
| 36 | +- [x] Sega Master System |
| 37 | +- [x] Sega Game Gear |
| 38 | +- [x] Colecovision |
| 39 | +- [x] Sinclair Zx Spectrum 48k |
| 40 | +- [x] Atari 2600 |
| 41 | +- [x] Atari 7800 |
| 42 | +- [x] Atari Lynx |
| 43 | +- [x] PC Engine |
| 44 | +- [ ] Commodore 64 |
| 45 | +- [ ] Nintendo Game & Watch |
| 46 | + |
| 47 | +# Usage |
| 48 | +> How To |
| 49 | +
|
| 50 | +Clone the Software Branch of the [Official Retro ESP32](https://github.com/retro-esp32/RetroESP32/) |
| 51 | + |
| 52 | +```shell |
| 53 | +git clone -b Software --single-branch git@github.com:retro-esp32/RetroESP32.git --recursive |
| 54 | + |
| 55 | +cd RetroESP32 |
| 56 | + |
| 57 | +git submodule update --init --recursive |
| 58 | + |
| 59 | +git submodule foreach git pull origin master |
| 60 | + |
| 61 | +chmod -R 777 Scripts |
| 62 | + |
| 63 | +cd Scripts |
| 64 | + |
| 65 | +./installer |
| 66 | +``` |
| 67 | +It will take a while since we run a few ```git submodule``` inside the repository |
| 68 | + |
| 69 | +# Setup Toolchain |
| 70 | +> You will need the xtensa esp32 toolchain |
| 71 | +
|
| 72 | +### Guides |
| 73 | + |
| 74 | +***Note:*** You only need to install the xtensa toolchain. The esp-idf is included in this repository. |
| 75 | + |
| 76 | +- [Linux](https://docs.espressif.com/projects/esp-idf/en/latest/get-started/linux-setup.html) |
| 77 | +- [Mac OS](https://docs.espressif.com/projects/esp-idf/en/latest/get-started/macos-setup.html) |
| 78 | +- [Windows](https://docs.espressif.com/projects/esp-idf/en/latest/get-started/windows-setup-scratch.html) |
| 79 | + |
| 80 | + |
| 81 | +# Bash Scripts |
| 82 | +> Some tools to help you along your way |
| 83 | +
|
| 84 | +Navigate to you newly cloned repository and execute the following |
| 85 | +``` |
| 86 | +chmod -R 777 Scripts |
| 87 | +cd Scripts |
| 88 | +``` |
| 89 | + |
| 90 | +***Note:*** All bash scripts **MUST** be executed from the Scripts folder. |
| 91 | + |
| 92 | + |
| 93 | +### Submodule Branches |
| 94 | +> Make sure all the submodules are on the right branches |
| 95 | +
|
| 96 | +``` |
| 97 | +./branches |
| 98 | +``` |
| 99 | + |
| 100 | +### Replace files for ILI9342 drivers |
| 101 | +> Copy relevant files for ILI9342 TFT LCD |
| 102 | +
|
| 103 | +``` |
| 104 | +./replace |
| 105 | +``` |
| 106 | + |
| 107 | +### ESP32 Environment Installer |
| 108 | +> Install all thing necessary (NIX/OS X) *Windows Coming Soon* |
| 109 | +
|
| 110 | +``` |
| 111 | +./installer |
| 112 | +``` |
| 113 | + |
| 114 | +### Environmanet Variables |
| 115 | +> Set all your paths |
| 116 | +Be sure to run installer first |
| 117 | + |
| 118 | +``` |
| 119 | +source ./helpers/paths |
| 120 | +``` |
| 121 | + |
| 122 | +### Build Firmware |
| 123 | +> Follow Onscreen Prompts |
| 124 | +> if this is your first time running the executable, answer **Y** to the options |
| 125 | +
|
| 126 | +``` |
| 127 | +./firmware |
| 128 | +``` |
| 129 | + |
| 130 | +You will now have a file called **Retro ESP32.fw** in the Firmware/Release folder. |
| 131 | + |
| 132 | +You can copy this onto your *SD Card* into the ***odroid/firmware*** folder |
| 133 | + |
| 134 | +##### Enabling new firmware |
| 135 | +> Insert the sd card into your Retro ESP32 / (Odroid Go) and follow the prompts |
| 136 | +
|
| 137 | +| List | Selection | Verification | Write | Reboot | |
| 138 | +| ----------------------------------------- | -------------------------------- | ---- | ---- | ---- | |
| 139 | +|  |  |  |  |  | |
| 140 | + |
| 141 | +### Build and Load OTA |
| 142 | +> Follow Onscreen Prompts |
| 143 | +> if this is your first time running the executable, answer **Y** to the applicable options |
| 144 | +
|
| 145 | +### OTA |
| 146 | +> Flash directly to ESP32 |
| 147 | +
|
| 148 | +This is the easiest option, simple follow the onscreen prompts! |
| 149 | + |
| 150 | +``` |
| 151 | +./ota |
| 152 | +``` |
| 153 | + |
| 154 | +*note:* |
| 155 | + |
| 156 | +You will need to set the SPI ram for the emulators |
| 157 | + |
| 158 | +| Screen Grab | Instructions | |
| 159 | +| ---- |---- | |
| 160 | +|  | Answer **Y** | |
| 161 | +|  | Answer **N** | |
| 162 | +|  | Answer **Y** (This is IMPORTANT) | |
| 163 | +|  | Navigate to ```Component config -->``` | |
| 164 | +|  | Navigate to ```ESP32-specific -->``` | |
| 165 | +|  | Navigate to ```SPI RAM config -->``` | |
| 166 | +|  | Navigate to ```Type of SPI RAM chip in use (some value) -->``` | |
| 167 | +|  | Select ```Auto-detect``` | |
| 168 | + |
| 169 | + |
| 170 | + |
| 171 | +### Erase |
| 172 | + |
| 173 | +> Erase flash and storage from ESP32 |
| 174 | +
|
| 175 | +``` |
| 176 | +./erase |
| 177 | +``` |
| 178 | + |
| 179 | +### Arduino |
| 180 | +> Create Firmware from Arduino ```.ino.bin``` file |
| 181 | +
|
| 182 | +``` |
| 183 | +./arduino |
| 184 | +``` |
| 185 | + |
| 186 | +You will now have a ```.fw``` file in Arduino/firmware folder. |
| 187 | + |
| 188 | +You can copy this onto your *SD Card* into the ***odroid/firmware*** folder |
| 189 | + |
| 190 | + |
| 191 | +###  |
| 192 | +# Retro ESP32 |
| 193 | +> Software Branch |
| 194 | +
|
| 195 | +Finally a new launcher for your Odroid-Go |
| 196 | + |
| 197 | +``` |
| 198 | +cd Launchers/retro-esp32 |
| 199 | +make menuconfig |
| 200 | +``` |
| 201 | + |
| 202 | +1. Select ```Restro ESP32 Configuration```  |
| 203 | + |
| 204 | +2. Select your options |
| 205 | + * *Select* **LCD Driver Chip** |
| 206 | + * *Select* **MENU Key Options** |
| 207 | + * *Select* **In Game Menu** |
| 208 | + |
| 209 | +3. Run ```./ota``` (see above) |
3 | 210 |
|
4 | | -### Launcher Features |
5 | | -[](https://github.com/retro-esp32/RetroESP32/releases) |
| 211 | +| Splash | Navigation | ROM State Management | Run | |
| 212 | +| ---- | ---- | ---- | ---- | |
| 213 | +|  |  |  |  | |
0 commit comments