diff --git a/README.md b/README.md index 71efbd4ea5d..677552adafe 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,38 @@ -# Flipper Zero - Pokemon Trading in Game Boy +# 🐬 Flipper Zero - Pokemon Trading in Game Boy

Flipper Zero - Pokemon Trading Game Boy +

-## Introducción +[![FlipC.org](https://flipc.org/EstebanFuentealba/Flipper-Zero-Game-Boy-Pokemon-Trading/badge?branch=main)](https://flipc.org/EstebanFuentealba/Flipper-Zero-Game-Boy-Pokemon-Trading?branch=main) +## Introduction -Esta es una aplicación de intercambio de Pokemon's desde de Flipper Zero a Game Boy [(Generación I)](https://bulbapedia.bulbagarden.net/wiki/Generation_I). Flipper Zero emula un Game Boy "Esclavo" conectado a **Cable Game Link** para poder intercambiar cualquier Pokemon de la Primera Generación (Red, Blue, Yellow) a un Game Boy Real. +This is a Pokemon exchange application from Flipper Zero to Game Boy [(Generación I)](https://bulbapedia.bulbagarden.net/wiki/Generation_I). Flipper Zero emulates a "Slave" Game Boy connected to a Game Link Cable to be able to exchange any Pokemon from the First Generation (Red, Blue, Yellow) to a real Game Boy. -Es una Prueba de concepto (POC) para utilizar vistas, GPIO y FURI (Flipper Universal Registry Implementation). +It is a Proof of Concept (POC) for using views, GPIO, and FURI (Flipper Universal Registry Implementation). ## Instrucciones de instalación -Este proyecto está destinado a ser superpuesto encima de un repositorio de firmware existente, en mi caso la versión **Release 0.79.1**. +This project is intended to be overlayed on top of an existing firmware repo, in my case the **Release 0.79.1** version. -- Clona el [Repositorio del firmware de Flipper Zero](https://github.com/flipperdevices/flipperzero-firmware). Consulta este [tutorial](https://github.com/jamisonderek/flipper-zero-tutorials/tree/main/firmware/updating/README.md) para actualizar el firmware. -- Copia la [carpeta "pokemon"](..) en la carpeta `/applications_user/pokemon` del firmware que clonaste. -- Corre el comando `fbt launch_app` para correr en tu Flipper Zero. +- Clone the [Flipper Zero firmware repository](https://github.com/flipperdevices/flipperzero-firmware). Refer to [this tutorial](https://github.com/jamisonderek/flipper-zero-tutorials/tree/main/firmware/updating/README.md) for updating the firmware. +- Copy the "pokemon" folder into the `/applications_user/pokemon` folder in your firmware. +- Run the command `fbt launch_app` to run it on your Flipper Zero. ```bash ./fbt launch_app APPSRC=pokemon ``` -- NOTA: Si sólo quieres generar el archivo `fap` debes correr el siguiente comando. +- NOTE: If you only want to generate the fap file, you must run the following command. ```bash ./fbt fap_pokemon ``` -y usa [**qFlipper**](https://flipperzero.one/update) para copiar el archivo **pokemon.fap** generado a la carpeta `SD Card/apps/Game Boy`. +And use [**qFlipper**](https://flipperzero.one/update) to copy the generated **pokemon.fap** file to the `SD Card/apps/Game Boy` folder.


@@ -38,13 +40,13 @@ y usa [**qFlipper**](https://flipperzero.one/update) para copiar el archivo **po ## Instrucciones de Uso -Estas instrucciones asumen que está comenzando en el escritorio de Flipper Zero. De lo contrario, presione el botón Atrás hasta que esté en el escritorio. +These instructions assume that you are starting at the Flipper Zero desktop. Otherwise, press the Back button until you are at the desktop. -- Presione el botón `OK` en el flipper para abrir el menú principal. -- Elija `Aplicaciones` en el menú. -- Elija `Game Boy` en el submenú. -- Elija `Pokemon Trading` -- El Flipper Zero debe mostrar la selección de Pokemon que se desea intercambiar y por defecto parece bulbasaur. +- Press the `OK` button on the Flipper to open the main menu. +- Choose `Aplicaciones` from the menu. +- Choose `Game Boy` from the submenu. +- Choose `Pokemon Trading` +- The Flipper Zero should show the selection of Pokemon that you want to trade, and by default, it appears as bulbasaur.


@@ -52,107 +54,110 @@ Estas instrucciones asumen que está comenzando en el escritorio de Flipper Zero

-- Pulse los botones `IZQUIERDA`/`DERECHA` para paginar de 1 en 1 la selección de Pokemon. -- Pulse los botones `ARRIBA`/`ABAJO` para paginar de 10 en 10 la selección de Pokemon. -- Pulse el botón `OK` para seleccionar el Pokemon a Intercambiar. +- Press the `LEFT`/`RIGHT` buttons to paginate the selection of Pokemon by 1. +- Press the `UP`/`DOWN` buttons to paginate the selection of Pokemon by 10. +- Press the `OK` button to select the Pokemon to trade.



-- En el Flipper Zero se muestra la vista para conectar el Game Boy. +- The Flipper Zero will display the view to connect the Game Boy.



-- En tu Game Boy debes conectar el **Cable Game Link** al Game Boy, en el juego dirigirte a un **Centro Pokémon** que tengas más cercano. +- On your Game Boy, you should connect the **Game Link Cable** to the Game Boy and in the game, go to the nearest **Pokemon Center**.



-- Habla con la chica que está en el mostrador de la derecha. La chica nos dirá que para poder jugar antes tendremos que salvar el juego, le contestaremos que _SI_ pulsando el botón _A_. +- Talk to the girl at the counter on the right. The girl will tell us that we have to save the game before playing, we will answer **YES** by pressing the **A** button. + +.



-- El Flipper Zero nos mostrará que estámos conectados. +- The Flipper Zero will show that we are connected.



-- En el Game Boy nos preguntará que opción queremos y Seleccionamos **CENT. CAMBIO**. +- On the Game Boy, we will be asked which option we want, and we select **TRADE CENTER**.



-- Entrarás a la sala de Intercambio donde debes presionar el botón A del Game Boy en el lado de tu mesa. +- You will enter the Trade Center where you must press the A button on the Game Boy on your side of the table.



-- Flipper Zero quedará en una pantalla de espera con el Pokemon que seleccionaste. +- Flipper Zero will remain on a waiting screen with the Pokemon you selected.



-- Se te mostrarán tus Pokemon y el Pokemon que seleccionaste en el Flipper Zero, en este Caso **Mew**. Debes seleccionar el pokemon que quieres intercambiar y presionar **TRATO**. +- You will see your Pokemon and the Pokemon you selected on the Flipper Zero, in this case, `Mew`. You must select the Pokemon you want to trade and press **TRADE**.



-- Debes confirmar el intercambio seleccionado **TRATO**. +- You must confirm the selected trade by selecting **TRADE**.



-- Flipper Zero quedará en una pantalla de espera con el Pokemon que seleccionaste. +- Flipper Zero will remain on a waiting screen with the Pokemon you selected.



-- Finalmente comenzará el intercambio de Pokemon desde **Flipper Zero** al **Game Boy**. +- Finally, the Pokemon exchange will start from **Flipper Zero** to the **Game Boy**.



-- **NOTA**: Si al final del Intercambio se te bloquea el Flipper Zero debes Rebootear presionando la combinación de teclas IZQUIERDA + ATRAS + + If the Flipper Zero gets stuck at the end of the exchange, you must reboot it by pressing the LEFT + BACK key combination.



-## ¿Cómo trabaja? +## How does it work? -El método utilizado para comunicar 2 Game Boy se basa en el protocolo SPI, que es un protocolo de comunicación serial muy simple en el que un dispositivo maestro se comunica con uno o más dispositivos esclavos. El protocolo es bidireccional y sincrónico, y utiliza tres señales básicas: +The method used to communicate 2 Game Boys is based on the SPI protocol, which is a very simple serial communication protocol in which a master device communicates with one or more slave devices. The protocol is bidirectional and synchronous, and uses three basic signals: -- Una señal de reloj (CLK). -- Una señal de salida (Serial Out o SO). -- Una señal de entrada (Serial In o SI). +- A clock signal (CLK). +- An output signal (Serial Out or SO). +- An input signal (Serial In or SI). -En el Game Boy, los juegos almacenan los datos en un registro de cambio interno que se utiliza para enviar y recibir información. El protocolo SPI utilizado por el Game Boy utiliza la señal de reloj para indicar cuándo se transfieren los datos. +In the Game Boy, games store data in an internal shift register that is used to send and receive information. The SPI protocol used by the Game Boy uses the clock signal to indicate when data is being transferred. -El protocolo de enlace de Game Boy es síncrono y requiere que el dispositivo esclavo responda al mismo ritmo que el dispositivo maestro. El dispositivo maestro suministra un reloj de 8KHz (velocidad de transferencia de datos de 1KB/s). La ventana de tiempo para responder es de solo **~120μs**. Sin embargo, el dispositivo esclavo no tiene restricciones y puede responder cuando recibe los datos. El reloj puede variar y no hay un límite inferior. +The Game Boy link protocol is synchronous and requires the slave device to respond at the same rate as the master device. The master device supplies an 8KHz clock (data transfer rate of 1KB/s). The time window for responding is only **~120μs**. However, the slave device has no restrictions and can respond when it receives data. The clock can vary and there is no lower limit.



-_Una transferencia de ejemplo de GB SPI. Aquí, el maestro envía 0xD9 (217) y el esclavo envía 0x45 (69)._ +_An example GB SPI transfer. Here, the master sends 0xD9 (217) and the slave sends 0x45 (69)._
-Se puede conocer mas al respecto en el siguiente Video [**Analyzing the Different Versions of the Link Cable**](https://youtu.be/h1KKkCfzOws?t=151). +You can learn more about it in the following video. [**Analyzing the Different Versions of the Link Cable**](https://youtu.be/h1KKkCfzOws?t=151). -## Placa para Flipper Zero +## Board for Flipper Zero. -Para la placa del Fipper Zero se utilizó un [PortData EXT Link](https://es.aliexpress.com/item/1005004116983895.html) y una [place de prototipo](https://es.aliexpress.com/item/32478242317.html) de 2x8. +For the Flipper Zero board, a [PortData EXT Link](https://es.aliexpress.com/item/1005004116983895.html) and a 2x8 [prototype board](https://es.aliexpress.com/item/32478242317.html) were used.



-_PortData EXT Link para Game Boy Color, Game Boy Pocket, GBC, GBP, GBL._ +_PortData EXT Link for Game Boy Color, Game Boy Pocket, GBC, GBP, GBL._


@@ -163,9 +168,9 @@ _PortData EXT Link para Game Boy Color, Game Boy Pocket, GBC, GBP, GBL._

-## Conexión: Flipper Zero GPIO - Game Boy +## Connection: Flipper Zero GPIO - Game Boy -Se deben conectar los Pines de la siguiente manera +The pins should be connected as follows:


@@ -189,17 +194,16 @@ Se deben conectar los Pines de la siguiente manera ## GUI -Para generar la Interfaz gráfica se utilizó la herramienta [**FUI-Editor**](https://ilin.pt/stuff/fui-editor/). -Además se utilizaron los sprites originales del juego _Pokemon Yellow_ que se encuentran en el repositorio [**Disassembly of Pokemon Yellow**](https://github.com/pret/pokeyellow/tree/master/gfx/pokemon/front). +To generate the graphical interface, the [**FUI-Editor**](https://ilin.pt/stuff/fui-editor/) tool was used. Additionally, the original sprites from the game Pokemon Yellow, which are found in the [**Disassembly of Pokemon Yellow**](https://github.com/pret/pokeyellow/tree/master/gfx/pokemon/front) repository, were used. -De cada imagen se transformó el color `#aaa` a `#fff` para que Flipper Zero la renderizara bien. Para eso se utilizó un **Batch** para [Photopea](https://www.photopea.com/), el editor de imagenes online. +For each image, the color `#aaa` was transformed to `#fff` so that Flipper Zero would render it correctly. To do this, a batch process was used in [Photopea](https://www.photopea.com/), the online image editor. -## TODO -- [ ] Refactorizar el código -- [ ] Al salir de la app el botón `OK` deja de funcionar por lo que hay que reiniciarlo 🤔 -- [ ] Setear a cada pokemon sus características, ataques, niveles por defecto -- [ ] Mejorar animaciones +## TODO +[ ] Refactor the code +[ ] The OK button stops working when exiting the app, so it needs to be restarted 🤔 +[ ] Set each Pokemon's characteristics, attacks, and default levels +[ ] Improve animations ## Links @@ -215,5 +219,5 @@ De cada imagen se transformó el color `#aaa` a `#fff` para que Flipper Zero la



-Desde Talcahuano 🇨🇱 con ❤ +From Talcahuano 🇨🇱 with ❤

diff --git a/README_es.md b/README_es.md new file mode 100644 index 00000000000..41bd9ba889f --- /dev/null +++ b/README_es.md @@ -0,0 +1,224 @@ +# 🐬 Flipper Zero - Pokemon Trading in Game Boy + +

+ + Flipper Zero - Pokemon Trading Game Boy +
+

+ +[![FlipC.org](https://flipc.org/EstebanFuentealba/Flipper-Zero-Game-Boy-Pokemon-Trading/badge?branch=main)](https://flipc.org/EstebanFuentealba/Flipper-Zero-Game-Boy-Pokemon-Trading?branch=main) + +## Introduction + +This is a Pokemon exchange application from Flipper Zero to Game Boy [(Generación I)](https://bulbapedia.bulbagarden.net/wiki/Generation_I). Flipper Zero emulates a "Slave" Game Boy connected to a Game Link Cable to be able to exchange any Pokemon from the First Generation (Red, Blue, Yellow) to a real Game Boy. + +It is a Proof of Concept (POC) for using views, GPIO, and FURI (Flipper Universal Registry Implementation). + +## Instrucciones de instalación + +This project is intended to be overlayed on top of an existing firmware repo, in my case the **Release 0.79.1** version. + +- Clone the [Flipper Zero firmware repository](https://github.com/flipperdevices/flipperzero-firmware). Refer to [this tutorial](https://github.com/jamisonderek/flipper-zero-tutorials/tree/main/firmware/updating/README.md) for updating the firmware. +- Copy the "pokemon" folder into the `/applications_user/pokemon` folder in your firmware. +- Run the command `fbt launch_app` to run it on your Flipper Zero. + +```bash +./fbt launch_app APPSRC=pokemon +``` + +- NOTE: If you only want to generate the fap file, you must run the following command. + +```bash +./fbt fap_pokemon +``` + +And use [**qFlipper**](https://flipperzero.one/update) to copy the generated **pokemon.fap** file to the `SD Card/apps/Game Boy` folder. + +

+
+

+ +## Instrucciones de Uso + +These instructions assume that you are starting at the Flipper Zero desktop. Otherwise, press the Back button until you are at the desktop. + +- Press the `OK` button on the Flipper to open the main menu. +- Choose `Aplicaciones` from the menu. +- Choose `Game Boy` from the submenu. +- Choose `Pokemon Trading` +- The Flipper Zero should show the selection of Pokemon that you want to trade, and by default, it appears as bulbasaur. + +

+
+ +
+

+ +- Press the `LEFT`/`RIGHT` buttons to paginate the selection of Pokemon by 1. +- Press the `UP`/`DOWN` buttons to paginate the selection of Pokemon by 10. +- Press the `OK` button to select the Pokemon to trade. +

+
+
+

+- The Flipper Zero will display the view to connect the Game Boy. +

+
+
+

+- On your Game Boy, you should connect the **Game Link Cable** to the Game Boy and in the game, go to the nearest **Pokemon Center**. +

+
+
+

+- Talk to the girl at the counter on the right. The girl will tell us that we have to save the game before playing, we will answer **YES** by pressing the **A** button. + +. +

+
+
+

+- The Flipper Zero will show that we are connected. +

+
+
+

+- On the Game Boy, we will be asked which option we want, and we select **TRADE CENTER**. +

+
+
+

+- You will enter the Trade Center where you must press the A button on the Game Boy on your side of the table. +

+
+
+

+- Flipper Zero will remain on a waiting screen with the Pokemon you selected. +

+
+
+

+- You will see your Pokemon and the Pokemon you selected on the Flipper Zero, in this case, `Mew`. You must select the Pokemon you want to trade and press **TRADE**. +

+
+
+

+- You must confirm the selected trade by selecting **TRADE**. +

+
+
+

+- Flipper Zero will remain on a waiting screen with the Pokemon you selected. +

+
+
+

+- Finally, the Pokemon exchange will start from **Flipper Zero** to the **Game Boy**. +

+
+
+

+ + If the Flipper Zero gets stuck at the end of the exchange, you must reboot it by pressing the LEFT + BACK key combination. +

+
+
+

+ +## How does it work? + +The method used to communicate 2 Game Boys is based on the SPI protocol, which is a very simple serial communication protocol in which a master device communicates with one or more slave devices. The protocol is bidirectional and synchronous, and uses three basic signals: + +- A clock signal (CLK). +- An output signal (Serial Out or SO). +- An input signal (Serial In or SI). + +In the Game Boy, games store data in an internal shift register that is used to send and receive information. The SPI protocol used by the Game Boy uses the clock signal to indicate when data is being transferred. + +The Game Boy link protocol is synchronous and requires the slave device to respond at the same rate as the master device. The master device supplies an 8KHz clock (data transfer rate of 1KB/s). The time window for responding is only **~120μs**. However, the slave device has no restrictions and can respond when it receives data. The clock can vary and there is no lower limit. + +

+
+
+

+ +_Una transferencia de ejemplo de GB SPI. Aquí, el maestro envía 0xD9 (217) y el esclavo envía 0x45 (69)._ + +
+ +Se puede conocer mas al respecto en el siguiente Video [**Analyzing the Different Versions of the Link Cable**](https://youtu.be/h1KKkCfzOws?t=151). + +## Placa para Flipper Zero + +Para la placa del Fipper Zero se utilizó un [PortData EXT Link](https://es.aliexpress.com/item/1005004116983895.html) y una [place de prototipo](https://es.aliexpress.com/item/32478242317.html) de 2x8. + +

+
+
+

+ +_PortData EXT Link para Game Boy Color, Game Boy Pocket, GBC, GBP, GBL._ + +

+
+
+

+

+
+
+

+ +## Conexión: Flipper Zero GPIO - Game Boy + +Se deben conectar los Pines de la siguiente manera + +

+
+
+

+ + + + + Connect Flipper Zero GPIO to Game Boy Pins + + +| Cable Game Link (Socket) | Flipper Zero GPIO | +| ------------------------ | ----------------- | +| 6 (GND) | 8 (GND) | +| 5 (CLK) | 7 (C3) | +| 3 (SI) | 6 (B2) | +| 2 (SO) | 5 (B3) | + +## GUI + +Para generar la Interfaz gráfica se utilizó la herramienta [**FUI-Editor**](https://ilin.pt/stuff/fui-editor/). +Además se utilizaron los sprites originales del juego _Pokemon Yellow_ que se encuentran en el repositorio [**Disassembly of Pokemon Yellow**](https://github.com/pret/pokeyellow/tree/master/gfx/pokemon/front). + +De cada imagen se transformó el color `#aaa` a `#fff` para que Flipper Zero la renderizara bien. Para eso se utilizó un **Batch** para [Photopea](https://www.photopea.com/), el editor de imagenes online. + +## TODO + +- [ ] Refactorizar el código +- [ ] Al salir de la app el botón `OK` deja de funcionar por lo que hay que reiniciarlo 🤔 +- [ ] Setear a cada pokemon sus características, ataques, niveles por defecto +- [ ] Mejorar animaciones + +## Links + +- [Flipper Zero firmware source code](https://github.com/flipperdevices/flipperzero-firmware) +- Adan Scotney's pokemon [trade protocol specification](http://www.adanscotney.com/2014/01/spoofing-pokemon-trades-with-stellaris.html) and implementation +- Derek Jamison - [Youtube Channel](https://www.youtube.com/@MrDerekJamison) +- Matt Penny - [GBPlay Blog](hhttps://blog.gbplay.io/) +- [Pokémon data structure (Generation I)]() +- [Disassembly of Pokemon Yellow](https://github.com/pret/pokeyellow) +- [Arduino-Spoofing-Gameboy-Pokemon-Trades](https://github.com/EstebanFuentealba/Arduino-Spoofing-Gameboy-Pokemon-Trades) +- [🎮 Gameboy link cable breakout PCB](https://github.com/Palmr/gb-link-cable) + +

+
+
+Desde Talcahuano 🇨🇱 con ❤ +