Skip to content

Commit c662118

Browse files
committed
Wed 9 Oct 2019 13:08:35 EDT - release v.1.1.1-Gameboy-Palette
2 parents 6df2142 + 2ac2395 commit c662118

File tree

1 file changed

+56
-141
lines changed

1 file changed

+56
-141
lines changed

README.md

Lines changed: 56 additions & 141 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
1-
[![Release](https://img.shields.io/github/v/release/retro-esp32/RetroESP32?style=for-the-badge)]()
2-
[![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=)]()
1+
[![Release](https://img.shields.io/github/v/release/retro-esp32/RetroESP32?style=for-the-badge)](https://github.com/retro-esp32/RetroESP32/releases/tag/v.1.1.0-Font-Size-Fix)
2+
[![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)
33
[![Last Commit](https://img.shields.io/github/last-commit/retro-esp32/RetroESP32/Software?style=for-the-badge&logo=github)]()
4+
45
------
56
#### Buy Us A Coffee
67
> It's Not Mandatory, But Much [Appreciated](https://www.paypal.me/32teeth/1.99USD)
@@ -17,17 +18,26 @@ Retro ESP32 Team
1718
------
1819

1920
# ![Retro ESP32](Assets/logo.jpg)
20-
> Software Branch
21+
> An ESP32 Wrover based Game Boy Pocket
22+
23+
### Launcher Features
24+
[![Launcher Features](Assets/launcher.jpg)](https://github.com/retro-esp32/RetroESP32/releases)
25+
26+
[Download Firmware TODAY](https://github.com/retro-esp32/RetroESP32/releases)
27+
28+
### Branches and Releases
29+
30+
| Hardware | Software | Release |
31+
| :----------------------------------------------------------: | :----------------------------------------------------------: | :----------------------------------------------------------: |
32+
| [![Hardware](Assets/hw.png)](https://github.com/retro-esp32/RetroESP32/tree/Hardware) | [![Software](Assets/sw.png)](https://github.com/retro-esp32/RetroESP32/tree/Software) | [![Firmware](Assets/fw.png)](https://github.com/retro-esp32/RetroESP32/releases) |
2133

22-
## Launcher
2334

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

26-
- [x] Odroid Go - [Firmware](https://github.com/OtherCrashOverride/odroid-go-firmware)
27-
- [x] Odroid Go - [Go Play Emulators](https://github.com/OtherCrashOverride/go-play)
28-
- [x] Launcher based on [GoGo](https://bitbucket.org/odroid_go_stuff/gogo/src/master/) Launcher
29-
- [x] ROM Management
30-
- [x] Config for both ILI9341/2
36+
## Welcome
37+
38+
Based on the popularity of:
39+
- [Gaboze Pocaio](https://github.com/32teeth/GabozePocaio-Round1)
40+
- [Gaboze Pocaio Round 2](https://github.com/32teeth/GabozePocaio-Round2)
3141

3242
## Supported Emulators
3343
> What else do you need to know, there are 11 currently supported
@@ -46,158 +56,63 @@ This branch contains the specific modification for the Odroid Go hardware to use
4656
- [ ] Commodore 64
4757
- [ ] Nintendo Game & Watch
4858

49-
# Usage
50-
> How To
51-
52-
Clone the Software Branch of the [Official Retro ESP32](https://github.com/retro-esp32/RetroESP32/)
53-
54-
```shell
55-
git clone -b Software --single-branch git@github.com:retro-esp32/RetroESP32.git --recursive
56-
57-
cd RetroESP32
58-
59-
git submodule update --init --recursive
60-
61-
git submodule foreach git pull origin master
62-
63-
chmod -R 777 Scripts
64-
65-
cd Scripts
66-
67-
./installer
68-
```
69-
It will take a while since we run a few ```git submodule``` inside the repository
70-
71-
# Setup Toolchain
72-
> You will need the xtensa esp32 toolchain
73-
74-
### Guides
75-
76-
***Note:*** You only need to install the xtensa toolchain. The esp-idf is included in this repository.
77-
78-
- [Linux](https://docs.espressif.com/projects/esp-idf/en/latest/get-started/linux-setup.html)
79-
- [Mac OS](https://docs.espressif.com/projects/esp-idf/en/latest/get-started/macos-setup.html)
80-
- [Windows](https://docs.espressif.com/projects/esp-idf/en/latest/get-started/windows-setup-scratch.html)
81-
82-
83-
# Bash Scripts
84-
> Some tools to help you along your way
85-
86-
Navigate to you newly cloned repository and execute the following
87-
```
88-
chmod -R 777 Scripts
89-
cd Scripts
90-
```
91-
92-
***Note:*** All bash scripts **MUST** be executed from the Scripts folder.
93-
94-
95-
### Submodule Branches
96-
> Make sure all the submodules are on the right branches
97-
98-
```
99-
./branches
100-
```
101-
102-
### Replace files for ILI9342 drivers
103-
> Copy relevant files for ILI9342 TFT LCD
104-
105-
```
106-
./replace
107-
```
108-
109-
### ESP32 Environment Installer
110-
> Install all thing necessary (NIX/OS X) *Windows Coming Soon*
111-
112-
```
113-
./installer
114-
```
115-
116-
### Environmanet Variables
117-
> Set all your paths
118-
Be sure to run installer first
119-
120-
```
121-
source ./helpers/paths
122-
```
123-
124-
### Build Firmware
125-
> Follow Onscreen Prompts
126-
> if this is your first time running the executable, answer **Y** to the options
127-
128-
```
129-
./firmware
130-
```
59+
We have assemebled a team to pursue the development of:
13160

132-
You will now have a file called **Retro ESP32.fw** in the Firmware/Release folder.
61+
* [**Software Branch**](https://github.com/retro-esp32/RetroESP32/tree/Software)
62+
* Including Custom Launcher:
63+
* Themable
64+
* Include Atari 2600, Atari 7800 and Commodor 64
13365

134-
You can copy this onto your *SD Card* into the ***odroid/firmware*** folder
66+
| Splash | Navigation | ROM State Management | Run |
67+
| ------------------------------- | ------------------------------ | -------------------------------- | ---------------------------- |
68+
| ![](Assets/launcher/splash.jpg) | ![](Assets/launcher/games.jpg) | ![](Assets/launcher/manager.jpg) | ![](Assets/launcher/run.jpg) |
13569

136-
##### Enabling new firmware
137-
> Insert the sd card into your Retro ESP32 / (Odroid Go) and follow the prompts
13870

139-
| List | Selection | Verification | Write | Reboot |
140-
| ----------------------------------------- | -------------------------------- | ---- | ---- | ---- |
141-
| ![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) |
71+
* [**Hardware Branch**](https://github.com/retro-esp32/RetroESP32/tree/Hardware)
14272

143-
### Build and Load OTA
144-
> Follow Onscreen Prompts
145-
> if this is your first time running the executable, answer **Y** to the options
73+
### Hardware
74+
> Testing FTDI Solution
14675
147-
**NOTE:** This will flash your device
148-
```
149-
./ota
150-
```
76+
Thanks to a recent contribution, we will be testing out the replacement of the CP2104 USB to UART bridge IC with an FTDI FT232RL IC
15177

152-
### OTA
153-
> Flash directly to ESP32
78+
The FTDI IC is more hand solder friendly than the CP210x QFN series
15479

155-
This is the easiest option, simple follow the onscreen prompts!
80+
Here is a teaser of what we are testing
15681

157-
```
158-
./ota
159-
```
82+
| Top Layout | Bottom Layout |
83+
| ---------------------------------------- | ---------------------------------------------- |
84+
| ![Retro ESP32 Top](Assets/black-top.png) | ![Retro ESP32 Bottom](Assets/black-bottom.png) |
16085

161-
### Erase
162-
> Erase flash and storage from ESP32
86+
16387

164-
```
165-
./erase
166-
```
88+
A **new** *Game Boy Pocket* footprint based on the [ESP32 Wrover](https://www.espressif.com/en/products/hardware/esp32/overview) from [Espressif Systems](https://www.espressif.com)
16789

168-
### Arduino
169-
> Create Firmware from Arduino ```.ino.bin``` file
90+
### Why?
17091

171-
```
172-
./arduino
173-
```
92+
We love [Hard Kernel](https://www.hardkernel.com/) and their amazing product base including the [Odroid GO](https://www.hardkernel.com/shop/odroid-go/)
17493

175-
You will now have a ```.fw``` file in Arduino/firmware folder.
94+
We wanted to design, build and solution on trusted ***<abbr title="System on a Chip"><u>SoC</u></abbr>***. The ESP32 Wrover was selected for ease of use and extensive build tools available across all development platforms
17695

177-
You can copy this onto your *SD Card* into the ***odroid/firmware*** folder
96+
### What?
17897

98+
The **Gaboze Express** is intended as an educational *'toy'* for the world of **Makers**
99+
A low barrier to entry and NO soldering experience needed, AT ALL, there is NOTHING to solder, plug in and go!
179100

180-
### ![Retro ESP32](Assets/retro-esp32/logo.jpg)
181-
# Retro ESP32
182-
> Software Branch
101+
It has full support for
183102

184-
Finally a new launcher for your Odroid-Go
103+
- [x] ESP-ISP Dev Toolchain
104+
- [x] Arduino Toolchain
105+
- [x] Whatever else you want to throw at it
185106

186-
```
187-
cd Launchers/retro-esp32
188-
make menuconfig
189-
```
107+
### More Soon
108+
> Stay Tuned
190109
191-
1. Select ```Restro ESP32 Configuration``` ![Restro ESP32 Configuration](Assets/menuconfig.png)
110+
* Be sure to **Star** or **Fork** the repo as it will be updated often
192111

193-
2. Select your options![Options](Assets/driver.png)
194-
* *Select* **LCD Driver Chip**
195-
* *Select* **MENU Key Options**
196-
* *Select* **In Game Menu**
112+
* Pull Requests are welcome
197113

198-
3. Run ```./ota``` (see above)
114+
* Join the [Organization](https://github.com/gaboze-express)
199115

200-
| Splash | Navigation | ROM State Management | Run |
201-
| ---- | ---- | ---- | ---- |
202-
| ![](Assets/launcher/splash.jpg) | ![](Assets/launcher/games.jpg) | ![](Assets/launcher/manager.jpg) | ![](Assets/launcher/run.jpg) |
116+
* *Once you have forked or starred one of the repositories, you will receive an invite to join*
203117

118+

0 commit comments

Comments
 (0)