You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: PORTING.md
+9-6Lines changed: 9 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -84,20 +84,23 @@ You can combine any of them by defining the appropriate `RG_GAMEPAD_*_MAP` in yo
84
84
This file is used by ESP-IDF to build the code for the ESP32 itself.
85
85
86
86
Retro-Go, for the most part, doesn't care about the sdkconfig and its content will depend entirely the chip/board used. But there are things that you should keep in mind:
87
-
- The main task stack size has to be at least 8KB for retro-go
88
-
- The CPU frequency should be set to the maximum possible and power management be disabled
89
-
- SPIRAM should be enabled and configured correctly for your device
87
+
- The main task stack size has to be at least 8KB for retro-go ([CONFIG_ESP_MAIN_TASK_STACK_SIZE](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-reference/kconfig-reference.html#config-esp-main-task-stack-size))
88
+
- The CPU frequency should be set to the maximum possible and power management be disabled ([CONFIG_ESP_DEFAULT_CPU_FREQ_MHZ](https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/kconfig-reference.html#config-esp-default-cpu-freq-mhz), [CONFIG_PM_ENABLE](https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/kconfig-reference.html#config-pm-enable))
89
+
- SPIRAM should be enabled and configured correctly for your device ([CONFIG_SPIRAM_\*](https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/kconfig-reference.html#esp-psram))
90
+
- Flash and SPIRAM speed should be set to the maximum supported by your device ([CONFIG_ESPTOOLPY_FLASHFREQ](https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/kconfig-reference.html#config-esptoolpy-flashfreq), [CONFIG_SPIRAM_SPEED](https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/kconfig-reference.html#config-spiram-speed))
91
+
- Long filenames support should be enabled in FATFS ([CONFIG_FATFS_LFN_HEAP](https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/kconfig-reference.html#config-fatfs-long-filenames))
92
+
- UTF-8 support should be enabled in FATFS ([CONFIG_FATFS_API_ENCODING_UTF_8](https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/kconfig-reference.html#config-fatfs-api-encoding))
90
93
91
-
ESP-IDF provides a tool to edit it, namely `menuconfig`, but to use it in retro-go you must follow the following steps:
94
+
ESP-IDF provides a tool to edit it, namely `idf.py menuconfig`, but to use it in retro-go you must follow the following steps:
92
95
93
96
1. Build the launcher for your target (this will make sure you have the correct ESP32 board selected and generate a default sdkconfig)
94
97
-`./rg_tool.py clean`
95
-
-`./rg_tool.py --targetmy-target build launcher`
98
+
-`./rg_tool.py --target=my-target build launcher`
96
99
2. Enter the launcher directory: `cd launcher`
97
100
3. Run `idf.py menuconfig` and make the changes that you need. Make sure to save the changes and exit.
98
101
4. Optionally test the app with the new config (but do NOT run `rg_tool.py clean` at this point, your new config will be deleted)
99
102
-`cd ..`
100
-
-`./rg_tool.py --targetmy-target run launcher`
103
+
-`./rg_tool.py --target=my-target run launcher`
101
104
5. When you're satisfied, copy the `sdkconfig` file from the launcher to the target folder, so that it's used by all apps
0 commit comments