Skip to content

Commit e2e8da2

Browse files
32teeth32teeth
committed
Wed May 13 10:33:29 EDT 2020 - cleanup
2 parents a7a8c08 + d1b6c20 commit e2e8da2

File tree

4 files changed

+65
-170
lines changed

4 files changed

+65
-170
lines changed

‎.gitattributes‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
2+
*.* linguist-language=C

‎.github/.DS_Store‎

6 KB
Binary file not shown.

‎Assets/.DS_Store‎

6 KB
Binary file not shown.

‎README.md‎

Lines changed: 63 additions & 170 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,43 @@
1+
12
# ![Retro ESP32](Assets/logo.jpg)
2-
> Software Branch
3+
> Retro ESP32 is a turbo charged Odroid Go Launcher, Emulator and ROM Manager
34
45
[![Release](https://img.shields.io/github/v/release/retro-esp32/RetroESP32?style=for-the-badge)](https://github.com/retro-esp32/RetroESP32/releases/latest)
5-
[![Downloads](https://img.shields.io/github/downloads/retro-esp32/RetroESP32/total?style=for-the-badge&color=hotpink&logo=data:image/gif;base64,R0lGODlhYgB3AKIFAMwAAN9fX/THx88PD////////wAAAAAAACH/C1hNUCBEYXRhWE1QPD94cGFja2V0IGJlZ2luPSLvu78iIGlkPSJXNU0wTXBDZWhpSHpyZVN6TlRjemtjOWQiPz4gPHg6eG1wbWV0YSB4bWxuczp4PSJhZG9iZTpuczptZXRhLyIgeDp4bXB0az0iQWRvYmUgWE1QIENvcmUgNS42LWMxMzggNzkuMTU5ODI0LCAyMDE2LzA5LzE0LTAxOjA5OjAxICAgICAgICAiPiA8cmRmOlJERiB4bWxuczpyZGY9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkvMDIvMjItcmRmLXN5bnRheC1ucyMiPiA8cmRmOkRlc2NyaXB0aW9uIHJkZjphYm91dD0iIiB4bWxuczp4bXA9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC8iIHhtbG5zOnhtcE1NPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvbW0vIiB4bWxuczpzdFJlZj0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL3NUeXBlL1Jlc291cmNlUmVmIyIgeG1wOkNyZWF0b3JUb29sPSJBZG9iZSBQaG90b3Nob3AgQ0MgMjAxNyAoTWFjaW50b3NoKSIgeG1wTU06SW5zdGFuY2VJRD0ieG1wLmlpZDpCOUQzNzMwM0RENzcxMUU5ODg0M0IzRDNEM0E3MUNENSIgeG1wTU06RG9jdW1lbnRJRD0ieG1wLmRpZDpCOUQzNzMwNERENzcxMUU5ODg0M0IzRDNEM0E3MUNENSI+IDx4bXBNTTpEZXJpdmVkRnJvbSBzdFJlZjppbnN0YW5jZUlEPSJ4bXAuaWlkOkI5RDM3MzAxREQ3NzExRTk4ODQzQjNEM0QzQTcxQ0Q1IiBzdFJlZjpkb2N1bWVudElEPSJ4bXAuZGlkOkI5RDM3MzAyREQ3NzExRTk4ODQzQjNEM0QzQTcxQ0Q1Ii8+IDwvcmRmOkRlc2NyaXB0aW9uPiA8L3JkZjpSREY+IDwveDp4bXBtZXRhPiA8P3hwYWNrZXQgZW5kPSJyIj8+Af/+/fz7+vn49/b19PPy8fDv7u3s6+rp6Ofm5eTj4uHg397d3Nva2djX1tXU09LR0M/OzczLysnIx8bFxMPCwcC/vr28u7q5uLe2tbSzsrGwr66trKuqqainpqWko6KhoJ+enZybmpmYl5aVlJOSkZCPjo2Mi4qJiIeGhYSDgoGAf359fHt6eXh3dnV0c3JxcG9ubWxramloZ2ZlZGNiYWBfXl1cW1pZWFdWVVRTUlFQT05NTEtKSUhHRkVEQ0JBQD8+PTw7Ojk4NzY1NDMyMTAvLi0sKyopKCcmJSQjIiEgHx4dHBsaGRgXFhUUExIREA8ODQwLCgkIBwYFBAMCAQAAIfkEAQAABQAsAAAAAGIAdwAAA/9YtNz+MMpJq3Xq6s27/2AojmRpnmiqrmzrvnAsz7Ra3Hiu73zv/z0XcEgsEoXGpLKIXDqfuSZ0qpRSr0MrdsvTcr83L5grHmPLZio6DV2zne53tSX/xutMOv4MEgQGAQIRe3wfAQCIAYOEaiADiAADi4xtIIeJk5RwfX+BmZpzLKBPd6M6paY4qKkZoqxGq6mxprOjtaC3mrmUu4y9hL97wXjDdcVyx2/JbMtpzWbPY9Fg03Z6r0fX2EDVZNrbPt1b4oUr4Fnf5zvkV+yNrupBGq019RL09vkMYfr9C/z+8qkKaC8KwXoGD8pYpzBGl4ZoIJqLR7GixYsYM2rcyLGoo8ePIL3tC1npXrsJ2yycNMlq3hQKrzi8RCmrQ8lPumySoklL5yaWuD7sBJrTw1CcvoT+RApMqbwT5Qg8NBoOxUyiVKtCPQo061MTXHl6nQp2iUyAF9BtTZLVJTeroTYk5Pl2LSyfaCHctZttbF6zcPfiHRc4j19ldK8ORpb45llhjR2nTUpUsVvIlSWrpMw0LExekS2HZpz53WjSnUVjIMmVtevXSRIAADs=)](https://github.com/retro-esp32/RetroESP32/releases/latest)
6+
[![Downloads](https://img.shields.io/github/downloads/retro-esp32/RetroESP32/total?style=for-the-badge&color=hotpink&logo=data:image/gif;base64,R0lGODlhYgB3AKIFAMwAAN9fX/THx88PD////////wAAAAAAACH/C1hNUCBEYXRhWE1QPD94cGFja2V0IGJlZ2luPSLvu78iIGlkPSJXNU0wTXBDZWhpSHpyZVN6TlRjemtjOWQiPz4gPHg6eG1wbWV0YSB4bWxuczp4PSJhZG9iZTpuczptZXRhLyIgeDp4bXB0az0iQWRvYmUgWE1QIENvcmUgNS42LWMxMzggNzkuMTU5ODI0LCAyMDE2LzA5LzE0LTAxOjA5OjAxICAgICAgICAiPiA8cmRmOlJERiB4bWxuczpyZGY9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkvMDIvMjItcmRmLXN5bnRheC1ucyMiPiA8cmRmOkRlc2NyaXB0aW9uIHJkZjphYm91dD0iIiB4bWxuczp4bXA9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC8iIHhtbG5zOnhtcE1NPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvbW0vIiB4bWxuczpzdFJlZj0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL3NUeXBlL1Jlc291cmNlUmVmIyIgeG1wOkNyZWF0b3JUb29sPSJBZG9iZSBQaG90b3Nob3AgQ0MgMjAxNyAoTWFjaW50b3NoKSIgeG1wTU06SW5zdGFuY2VJRD0ieG1wLmlpZDpCOUQzNzMwM0RENzcxMUU5ODg0M0IzRDNEM0E3MUNENSIgeG1wTU06RG9jdW1lbnRJRD0ieG1wLmRpZDpCOUQzNzMwNERENzcxMUU5ODg0M0IzRDNEM0E3MUNENSI+IDx4bXBNTTpEZXJpdmVkRnJvbSBzdFJlZjppbnN0YW5jZUlEPSJ4bXAuaWlkOkI5RDM3MzAxREQ3NzExRTk4ODQzQjNEM0QzQTcxQ0Q1IiBzdFJlZjpkb2N1bWVudElEPSJ4bXAuZGlkOkI5RDM3MzAyREQ3NzExRTk4ODQzQjNEM0QzQTcxQ0Q1Ii8+IDwvcmRmOkRlc2NyaXB0aW9uPiA8L3JkZjpSREY+IDwveDp4bXBtZXRhPiA8P3hwYWNrZXQgZW5kPSJyIj8+Af/+/fz7+vn49/b19PPy8fDv7u3s6+rp6Ofm5eTj4uHg397d3Nva2djX1tXU09LR0M/OzczLysnIx8bFxMPCwcC/vr28u7q5uLe2tbSzsrGwr66trKuqqainpqWko6KhoJ+enZybmpmYl5aVlJOSkZCPjo2Mi4qJiIeGhYSDgoGAf359fHt6eXh3dnV0c3JxcG9ubWxramloZ2ZlZGNiYWBfXl1cW1pZWFdWVVRTUlFQT05NTEtKSUhHRkVEQ0JBQD8+PTw7Ojk4NzY1NDMyMTAvLi0sKyopKCcmJSQjIiEgHx4dHBsaGRgXFhUUExIREA8ODQwLCgkIBwYFBAMCAQAAIfkEAQAABQAsAAAAAGIAdwAAA/9YtNz+MMpJq3Xq6s27/2AojmRpnmiqrmzrvnAsz7Ra3Hiu73zv/z0XcEgsEoXGpLKIXDqfuSZ0qpRSr0MrdsvTcr83L5grHmPLZio6DV2zne53tSX/xutMOv4MEgQGAQIRe3wfAQCIAYOEaiADiAADi4xtIIeJk5RwfX+BmZpzLKBPd6M6paY4qKkZoqxGq6mxprOjtaC3mrmUu4y9hL97wXjDdcVyx2/JbMtpzWbPY9Fg03Z6r0fX2EDVZNrbPt1b4oUr4Fnf5zvkV+yNrupBGq019RL09vkMYfr9C/z+8qkKaC8KwXoGD8pYpzBGl4ZoIJqLR7GixYsYM2rcyLGoo8ePIL3tC1npXrsJ2yycNMlq3hQKrzi8RCmrQ8lPumySoklL5yaWuD7sBJrTw1CcvoT+RApMqbwT5Qg8NBoOxUyiVKtCPQo061MTXHl6nQp2iUyAF9BtTZLVJTeroTYk5Pl2LSyfaCHctZttbF6zcPfiHRc4j19ldK8ORpb45llhjR2nTUpUsVvIlSWrpMw0LExekS2HZpz53WjSnUVjIMmVtevXSRIAADs=)](https://github.com/retro-esp32/RetroESP32/releases)
67
[![Last Commit](https://img.shields.io/github/last-commit/retro-esp32/RetroESP32/Software?style=for-the-badge&logo=github)]()
7-
------
88

9-
## Launcher
9+
| Retro ESP32 In Action | Summary |
10+
| ----------------------------- | ------------------------------------------------------------ |
11+
| <img src="Assets/animated.gif" alt="Teaser" width="320"> | ![Retro ESP32](Assets/logo.jpg)<br/><br/>**Retro ESP32** is the ultimate feature packed [Odroid Go](https://www.hardkernel.com/shop/odroid-go/) Launcher. <br/><br/>Includes color schemes and theming. <br/>Drawing inspiration from the popular [RetroArch](https://www.retroarch.com/) emulator front end of choice. <br/>We packed 11 (current count) prebundled emulators including ROM / Game manager. <br/>Additionally each emulator includes an in game menu for further management.<br/><br/>**[Get Your Copy Today](https://github.com/retro-esp32/RetroESP32/releases)** |
12+
| <img src="https://raw.githubusercontent.com/wiki/retro-esp32/RetroESP32/Assets/Tindie/PCB-000.jpg" alt="Retro ESP32 MGB-001" width="320"> | Looking for a Game Boy Pocket drop in solution? [Get Yours Today](https://www.tindie.com/products/game-boy-pocket/retro-esp32/)<br/><br/> Exculsively at: <br/>[<img src="https://d2ss6ovg47m0r5.cloudfront.net/images/tindie-logo.png" alt="Tindie">](https://www.tindie.com/products/game-boy-pocket/retro-esp32/)|
13+
14+
## Preperation
15+
> Update Odroid Go Firmware
16+
17+
This only applies to owners of the Hardkernel [Odroid Go](https://www.hardkernel.com/shop/odroid-go/) *NOT the Retro ESP32*
18+
19+
**If you have purchased a Retro ESP32 from us, you can skip this step.**
20+
21+
[Get the latest Retro Odroid Go Frimware](https://github.com/retro-esp32/Retro-Odroid-Go-Firmware)
22+
23+
24+
25+
## Installation
26+
> Copy, Mount, Flash
27+
28+
We kept installation of Retro ESP32 super simple.
29+
1. Downloads the latest [release](https://github.com/retro-esp32/RetroESP32/releases)
30+
2. Unzip the file
31+
3. Copy **RetroESP32.fw** to the **odroid/firmware** folder of your prepared [SD card](https://github.com/retro-esp32/RetroESP32/blob/Software/SD%20Card/SDCARD.zip)
32+
4. Mount the SD Card back into your Odroid Go
33+
5. Restart Holding the **B** button
34+
6. Select **Retro ESP32** from the firmware list
35+
7. Sit back and relax while your Odroid Go flashes the new firmware
1036

11-
This branch contains the specific modification for the Odroid Go hardware to use the 320x240 ILI9342 2.6" and 240x320 ILI9341 display
1237

13-
- [x] Odroid Go - [Firmware](https://github.com/OtherCrashOverride/odroid-go-firmware)
14-
- [x] ROM Management
15-
- [x] Config for both ILI9341/2
1638

1739
## Supported Emulators
18-
> What else do you need to know, there are 11 currently supported
40+
> What else do you need to know
1941
2042
- [x] Nintendo Entertainment System
2143
- [x] Nintendo Game Boy
@@ -28,182 +50,53 @@ This branch contains the specific modification for the Odroid Go hardware to use
2850
- [x] Atari 7800
2951
- [x] Atari Lynx
3052
- [x] PC Engine
31-
- [ ] Commodore 64
32-
- [ ] Nintendo Game & Watch
33-
34-
# Usage
35-
> How To
36-
37-
Clone the Software Branch of the [Official Retro ESP32](https://github.com/retro-esp32/RetroESP32/)
38-
39-
```shell
40-
git clone -b Software --single-branch [email protected]:retro-esp32/RetroESP32.git --recursive
41-
42-
cd RetroESP32
43-
44-
git submodule update --init --recursive
45-
46-
git submodule foreach git pull origin master
47-
48-
chmod -R 777 Scripts
49-
50-
cd Scripts
51-
52-
./installer
53-
```
54-
It will take a while since we run a few ```git submodule``` inside the repository
55-
56-
# Setup Toolchain
57-
> You will need the xtensa esp32 toolchain
58-
59-
### Guides
60-
61-
***Note:*** You only need to install the xtensa toolchain. The esp-idf is included in this repository.
62-
63-
- [Linux](https://docs.espressif.com/projects/esp-idf/en/latest/get-started/linux-setup.html)
64-
- [Mac OS](https://docs.espressif.com/projects/esp-idf/en/latest/get-started/macos-setup.html)
65-
- [Windows](https://docs.espressif.com/projects/esp-idf/en/latest/get-started/windows-setup-scratch.html)
66-
67-
68-
# Bash Scripts
69-
> Some tools to help you along your way
70-
71-
Navigate to you newly cloned repository and execute the following
72-
```
73-
chmod -R 777 Scripts
74-
cd Scripts
75-
```
76-
77-
***Note:*** All bash scripts **MUST** be executed from the Scripts folder.
7853

54+
## Features
55+
> What makes Retro ESP32 different
7956
80-
### Submodule Branches
81-
> Make sure all the submodules are on the right branches
57+
- [x] Configurator
58+
- [x] Themes (color pack and icons)
59+
- [x] RetroArch like GUI experience
60+
- [x] In game HUD menu
61+
- [x] **Recently Played** *(First in Launchers Community)*
62+
- [x] **Favorites List** *(Another First)*
63+
- [x] **3** Scale levels for *'Core'* Emaulators *(Original, Box, Full Screen)*
8264

83-
```
84-
./branches
85-
```
65+
## Have your say!
66+
> Don't be shy, our team is here
8667
87-
### Replace files for ILI9342 drivers
88-
> Copy relevant files for ILI9342 TFT LCD
68+
*Have a great idea? Want to see a feature? Ran into a problem?*
69+
Use our [Project](https://github.com/retro-esp32/RetroESP32/projects/1) and [Issue](https://github.com/retro-esp32/RetroESP32/issues) sections to have your say.
8970

90-
```
91-
./replace
92-
```
9371

94-
### ESP32 Environment Installer
95-
> Install all thing necessary (NIX/OS X) *Windows Coming Soon*
72+
## Authors
9673

97-
```
98-
./installer
99-
```
74+
* **Eugene Yevhen Andruszczenko** - *Initial and Ongoing Work* - [32teeth](https://github.com/32teeth)
75+
* **Fuji Pebri** - *Espressif IOT Consultant* - [pebri86](https://github.com/pebri86)
10076

101-
### Environmanet Variables
102-
> Set all your paths
103-
Be sure to run installer first
77+
### License
10478

105-
```
106-
source ./helpers/paths
107-
```
79+
This project is licensed under the Creative Commons Attribution Share Alike 4.0 International - see the [LICENSE.md](LICENSE.md) file for details
10880

109-
### Build Firmware
110-
> Follow Onscreen Prompts
111-
> if this is your first time running the executable, answer **Y** to the options
81+
### Acknowledgments
11282

113-
```
114-
./firmware
115-
```
83+
* [othercrashoverride](https://github.com/othercrashoverride)
84+
* [pelle7](https://github.com/pelle7)
85+
* [pebri86](https://github.com/pebri86)
86+
* [hardkernel](https://github.com/hardkernel)
87+
* [ducalex](https://github.com/ducalex/)
11688

117-
You will now have a file called **Retro ESP32.fw** in the Firmware/Release folder.
118-
119-
You can copy this onto your *SD Card* into the ***odroid/firmware*** folder
120-
121-
##### Enabling new firmware
122-
> Insert the sd card into your Retro ESP32 / (Odroid Go) and follow the prompts
123-
124-
| List | Selection | Verification | Write | Reboot |
125-
| ----------------------------------------- | -------------------------------- | ---- | ---- | ---- |
126-
| ![Power on your hardware](Assets/IMG_1081.jpg) | ![Firmware List](Assets/IMG_1082.jpg) | ![Firmware Selection](Assets/IMG_1083.jpg) | ![Firmware Verification](Assets/IMG_1089.jpg) | ![Firmware Write](Assets/IMG_1090.jpg) |
127-
128-
### Build and Load OTA
129-
> Follow Onscreen Prompts
130-
> if this is your first time running the executable, answer **Y** to the applicable options
131-
132-
### OTA
133-
> Flash directly to ESP32
134-
135-
This is the easiest option, simple follow the onscreen prompts!
136-
137-
```
138-
./ota
139-
```
140-
141-
*note:*
142-
143-
You will need to set the SPI ram for the emulators
144-
145-
| Screen Grab | Instructions |
146-
| ---- |---- |
147-
| ![Assets/SPI/001.jpg](Assets/SPI/001.jpg) | Answer **Y** |
148-
| ![Assets/SPI/002.jpg](Assets/SPI/002.jpg) | Answer **N** |
149-
| ![Assets/SPI/003.jpg](Assets/SPI/003.jpg) | Answer **Y** (This is IMPORTANT) |
150-
| ![Assets/SPI/004.jpg](Assets/SPI/004.jpg) | Navigate to ```Component config -->``` |
151-
| ![Assets/SPI/005.jpg](Assets/SPI/005.jpg) | Navigate to ```ESP32-specific -->``` |
152-
| ![Assets/SPI/006.jpg](Assets/SPI/006.jpg) | Navigate to ```SPI RAM config -->``` |
153-
| ![Assets/SPI/007.jpg](Assets/SPI/007.jpg) | Navigate to ```Type of SPI RAM chip in use (some value) -->``` |
154-
| ![Assets/SPI/007.jpg](Assets/SPI/008.jpg) | Select ```Auto-detect``` |
155-
156-
157-
158-
### Erase
159-
160-
> Erase flash and storage from ESP32
161-
162-
```
163-
./erase
164-
```
165-
166-
### Arduino
167-
> Create Firmware from Arduino ```.ino.bin``` file
168-
169-
```
170-
./arduino
171-
```
172-
173-
You will now have a ```.fw``` file in Arduino/firmware folder.
174-
175-
You can copy this onto your *SD Card* into the ***odroid/firmware*** folder
176-
177-
178-
### ![Retro ESP32](Assets/retro-esp32/logo.jpg)
179-
# Retro ESP32
180-
> Software Branch
181-
182-
Finally a new launcher for your Odroid-Go
183-
184-
```
185-
cd Launchers/retro-esp32
186-
make menuconfig
187-
```
188-
189-
1. Select ```Restro ESP32 Configuration``` ![Restro ESP32 Configuration](Assets/menuconfig.png)
89+
-----
19090

191-
2. Select your options![Options](Assets/driver.png)
192-
* *Select* **LCD Driver Chip**
193-
* *Select* **MENU Key Options**
194-
* *Select* **In Game Menu**
91+
## Support
92+
> We Love Coffee!
19593
196-
3. Run ```./ota``` (see above)
94+
Did you know, you can support us in a few way? We offer multiple sposorship tiers, with different rewards!
19795

198-
| Splash | Navigation | ROM State Management | Run |
199-
| ---- | ---- | ---- | ---- |
200-
| ![](Assets/launcher/splash.jpg) | ![](Assets/launcher/games.jpg) | ![](Assets/launcher/manager.jpg) | ![](Assets/launcher/run.jpg) |
96+
Take a *look*.
97+
See what *fits*.
20198

202-
-----
99+
[![Support](https://raw.githubusercontent.com/retro-esp32/RetroESP32/master/Assets/sponsor.jpg)](https://github.com/sponsors/retro-esp32)
203100

204-
> ## Although we do this for 💕 of 🕹️
205-
> **We Also Like Coffee!**
206-
> *Please Consider Supporting*<br>
207-
> [![Support](https://raw.githubusercontent.com/retro-esp32/RetroESP32/master/Assets/sponsor.jpg)](https://github.com/sponsors/retro-esp32)
101+
**Thank You**
208102

209-
-----

0 commit comments

Comments
 (0)