-
Notifications
You must be signed in to change notification settings - Fork 7
Home
# ๐ธ TreeFrogUITreeFrogUI is a free, custom retro-emulation frontend for a range of MIPS-based Hichip handhelds.
It replaces the stock game menu with a faster and more configurable interface, while expanding the number of supported systems and features.
TreeFrogUI includes emulator cores, save states, Quick Resume, configurable audio and video options, themes, artwork, media applications, USB / OTG game libraries, and more.
> New to TreeFrogUI?
> The recommended way to install TreeFrogUI is with the official TreeFrogUI Installer.
๐ฑ Supported Devices
TreeFrogUI currently supports:
Device Support R36SX v2.6 โ Supported R36SX v2.7 โ Supported R36HD / compatible R36SX clones โ Supported SF3000 โ Supported SF3000 HD โ Supported SF3100 โ Supported SF3500 โ Supported GB350 โ Supported A single TreeFrogUI release package supports multiple device families and automatically detects the appropriate hardware configuration at boot.
> Device revisions can differ internally even when the consoles look almost identical. Always make sure your device is supported before installation.
๐ Getting Started
Recommended Installation Method
The recommended way to install TreeFrogUI is with the official TreeFrogUI Installer.
The installer handles the required device-specific setup and is available for:
- Windows
- Linux
- macOS
โก๏ธ Download the TreeFrogUI Installer
โ ๏ธ Important
> Do not install TreeFrogUI over the factory/preinstalled SD-card operating system.
TreeFrogUI should be installed on a freshly prepared SD card.
Installing it directly over the factory system may result in issues such as:
- missing or broken audio;
- incorrect controls;
- display problems;
- crashes;
- boot failures.
Whenever possible, keep a backup of your original SD card and use a separate, good-quality SD card for TreeFrogUI.
For users who need to perform the process manually:
โก๏ธ Manual Installation Guide
โจ Main Features
TreeFrogUI provides a complete frontend and emulation environment designed for supported handhelds.
๐ฎ Emulation
TreeFrogUI supports a wide range of consoles, computers, arcade systems, game engines, and emulator cores.
Examples include:
- NES / Famicom
- SNES / Super Famicom
- Game Boy / Game Boy Color
- Game Boy Advance
- Mega Drive / Genesis
- Sega Master System
- Game Gear
- Sega CD
- PlayStation 1
- PC Engine / TurboGrafx-16
- Neo Geo
- Arcade systems
- Atari systems
- Commodore systems
- MSX
- ZX Spectrum
- DOS / PC
- PICO-8
- Doom
- Quake
- and more
โก๏ธ View Supported Systems and Cores
๐น๏ธ Gameplay and Interface
TreeFrogUI includes features such as:
- save states;
- automatic save/load support;
- Quick Resume;
- Recent Games;
- optional Game Switcher;
- favourites;
- play-time statistics;
- screenshots;
- fast-forward;
- rewind;
- configurable audio and video;
- multiple menu layouts;
- themes and custom artwork.
๐ต Media Applications
Additional applications include:
- ๐ Ebook reader
- ๐ฌ Video player
- ๐ต Music player
- ๐ผ๏ธ Image viewer
- ๐ง Rockbox support
๐ฎ Games and Emulation
Games are stored inside the
roms/directory on the SD card.The folder used for a game determines which system or emulator TreeFrogUI launches.
Example:
roms/ โโโ FC/ โโโ SFC/ โโโ GBA/ โโโ gb/ โโโ MD/ โโโ PS/</span></code><span aria-hidden="true" class="PDq2pG_selectionAnchor"></span></pre></div></div></div></div></div></div></div></div><div class=""><div class=""></div></div></div></div></div></div></div></div></pre> <p data-start="4775" data-end="4807">For the complete folder mapping:</p> <p data-start="4809" data-end="4930">โก๏ธ <strong data-start="4812" data-end="4930"><a data-start="4814" data-end="4928" class="decorated-link cursor-pointer" rel="noopener" target="_new">ROM Folder and Emulator Mapping</a></strong></p> <p data-start="4932" data-end="5070">Some systems require additional BIOS or firmware files, and arcade systems may require ROM sets matching a specific emulator/core version.</p> <p data-start="5072" data-end="5172">โก๏ธ <strong data-start="5075" data-end="5172"><a data-start="5077" data-end="5170" class="decorated-link cursor-pointer" rel="noopener" target="_new">Core-specific Setup Guides</a></strong></p> <hr data-start="5174" data-end="5177"> <h2 data-section-id="jxcxoq" data-start="5179" data-end="5208">๐ฎ Basic In-Game Shortcuts</h2> <p data-start="5210" data-end="5277">For most libretro-based systems, <code data-start="5243" data-end="5251">SELECT</code> acts as the function key.</p> <div class="group TyagGW_tableContainer TyagGW_tableContainerWithTableOfContents"><div tabindex="-1" class="TyagGW_tableWrapper flex flex-col-reverse w-fit"> Shortcut | Action -- | -- SELECT + START | Open the in-game menu SELECT + R2 | Save state SELECT + L2 | Load state SELECT + R1 | Fast-forward SELECT + B | Hold to rewind SELECT + L1 | Take a screenshot </div></div> <hr data-start="10444" data-end="10447"> <h2 data-section-id="licdoz" data-start="10449" data-end="10473">โ Support the Project</h2> <p data-start="10475" data-end="10620">TreeFrogUI is maintained independently, and supporting additional hardware often requires access to physical devices for development and testing.</p> <p data-start="10622" data-end="10685">โก๏ธ <strong data-start="10625" data-end="10685"><a data-start="10627" data-end="10683" class="decorated-link" rel="noopener" target="_new" href="https://ko-fi.com/proszty">Support TreeFrogUI on Ko-fi</a></strong></p> <hr data-start="10687" data-end="10690"> <h2 data-section-id="1egbv0d" data-start="10692" data-end="10721">๐ License and Attribution</h2> <p data-start="10723" data-end="10814">TreeFrogUI combines multiple open-source components, each retaining its respective license.</p> <p data-start="10816" data-end="10913">โก๏ธ <strong data-start="10819" data-end="10913"><a data-start="10821" data-end="10911" class="decorated-link" rel="noopener" target="_new" href="https://github.com/tzubertowski/TreeFrogUI/blob/main/LICENSE.md?utm_source=chatgpt.com">License and Attribution</a></strong></p> <!--EndFragment--> </body> </html># ๐ธ TreeFrogUI **TreeFrogUI** is a free, custom retro-emulation frontend for a range of MIPS-based Hichip handhelds. It replaces the stock game menu with a faster and more configurable interface, while expanding the number of supported systems and features. TreeFrogUI includes emulator cores, save states, Quick Resume, configurable audio and video options, themes, artwork, media applications, USB / OTG game libraries, and more. > **New to TreeFrogUI?** > The recommended way to install TreeFrogUI is with the official **[TreeFrogUI Installer](https://github.com/tzubertowski/TreeFrogUI-installer/releases)**. --- ## ๐ฑ Supported Devices TreeFrogUI currently supports: | Device | Support | |---|---| | **R36SX v2.6** | โ Supported | | **R36SX v2.7** | โ Supported | | **R36HD / compatible R36SX clones** | โ Supported | | **SF3000** | โ Supported | | **SF3000 HD** | โ Supported | | **SF3100** | โ Supported | | **SF3500** | โ Supported | | **GB350** | โ Supported | A single TreeFrogUI release package supports multiple device families and automatically detects the appropriate hardware configuration at boot. > Device revisions can differ internally even when the consoles look almost identical. Always make sure your device is supported before installation. --- ## ๐ Getting Started ### Recommended Installation Method The recommended way to install TreeFrogUI is with the official **TreeFrogUI Installer**. The installer handles the required device-specific setup and is available for: - Windows - Linux - macOS โก๏ธ **[Download the TreeFrogUI Installer](https://github.com/tzubertowski/TreeFrogUI-installer/releases)** ### โ ๏ธ Important > **Do not install TreeFrogUI over the factory/preinstalled SD-card operating system.** TreeFrogUI should be installed on a freshly prepared SD card. Installing it directly over the factory system may result in issues such as: - missing or broken audio; - incorrect controls; - display problems; - crashes; - boot failures. Whenever possible, keep a backup of your original SD card and use a separate, good-quality SD card for TreeFrogUI. For users who need to perform the process manually: โก๏ธ **[Manual Installation Guide](https://github.com/tzubertowski/TreeFrogUI/blob/main/install.md)** --- ## โจ Main Features TreeFrogUI provides a complete frontend and emulation environment designed for supported handhelds. ### ๐ฎ Emulation TreeFrogUI supports a wide range of consoles, computers, arcade systems, game engines, and emulator cores. Examples include: - NES / Famicom - SNES / Super Famicom - Game Boy / Game Boy Color - Game Boy Advance - Mega Drive / Genesis - Sega Master System - Game Gear - Sega CD - PlayStation 1 - PC Engine / TurboGrafx-16 - Neo Geo - Arcade systems - Atari systems - Commodore systems - MSX - ZX Spectrum - DOS / PC - PICO-8 - Doom - Quake - and more โก๏ธ **[View Supported Systems and Cores](https://github.com/tzubertowski/TreeFrogUI/blob/main/cores.md)** ### ๐น๏ธ Gameplay and Interface TreeFrogUI includes features such as: - save states; - automatic save/load support; - Quick Resume; - Recent Games; - optional Game Switcher; - favourites; - play-time statistics; - screenshots; - fast-forward; - rewind; - configurable audio and video; - multiple menu layouts; - themes and custom artwork. ### ๐ต Media Applications Additional applications include: - ๐ Ebook reader - ๐ฌ Video player - ๐ต Music player - ๐ผ๏ธ Image viewer - ๐ง Rockbox support --- ## ๐ฎ Games and Emulation Games are stored inside the `roms/` directory on the SD card. The folder used for a game determines which system or emulator TreeFrogUI launches. Example: ```text roms/ โโโ FC/ โโโ SFC/ โโโ GBA/ โโโ gb/ โโโ MD/ โโโ PS/ For the complete folder mapping: โก๏ธ ROM Folder and Emulator Mapping Some systems require additional BIOS or firmware files, and arcade systems may require ROM sets matching a specific emulator/core version. โก๏ธ Core-specific Setup Guides ๐ฎ Basic In-Game Shortcuts For most libretro-based systems, SELECT acts as the function key. Shortcut Action SELECT + START Open the in-game menu SELECT + R2 Save state SELECT + L2 Load state SELECT + R1 Fast-forward SELECT + B Hold to rewind SELECT + L1 Take a screenshot Some standalone emulators use their own menus and shortcut systems. ๐จ Customization TreeFrogUI can be customized with: color themes; menu styles; system icons; background themes; wallpapers; fonts; box art; screenshots; title-screen artwork; display scaling. โก๏ธ Customization Guide ๐ USB / OTG Storage TreeFrogUI can use compatible USB / OTG storage as an additional game library on supported hardware. โก๏ธ USB / OTG Storage Guide ๐ฅ๏ธ Display Scaling Available display-scaling options depend on the device and emulator. TreeFrogUI may provide options such as: Integer scaling Native scaling Fill Aspect-ratio scaling โก๏ธ Display Scaling Guide ๐ Updates TreeFrogUI supports offline updates on compatible installations. Updates are designed to preserve personal content such as ROMs, BIOS files, saves, save states, screenshots, favourites, recent games, play-time data, and personal media. โก๏ธ Latest TreeFrogUI Release โก๏ธ Release Notes ๐ ๏ธ Troubleshooting If TreeFrogUI does not boot or behaves unexpectedly, check: that your device is supported; that the correct device was selected during installation; that the SD card was prepared correctly; that TreeFrogUI was not installed over the factory system; that required BIOS files are present; that ROMs are stored in the correct folders; that the SD card itself is working correctly. For diagnostic logging, create an empty file named: log.txt at the root of the SD card, then reproduce the problem and inspect /log.txt. Delete the file afterwards to disable logging. ๐งญ Project Development TreeFrogUI continues to evolve through testing, experimentation, and community contributions. Some technical areas and possible future directions are documented separately: โก๏ธ Development Ideas & Areas of Interest Compatibility testing is also being collected for specific systems: โก๏ธ [PlayStation 1 Compatibility List](https://github.com/tzubertowski/TreeFrogUI/wiki/Home/List-of-PS1-games-and-their-reported-performance) ๐งโ๐ป Development and Contributions TreeFrogUI is open source and includes components such as: TreeFrogUI / FrogUI โ game browser and launcher; picoarch โ libretro frontend and hardware integration layer; libretro cores; standalone applications and emulators; device-specific integration and configuration. Developers interested in building, porting, testing, debugging, or contributing can visit: โก๏ธ [TreeFrogUI Repository](https://github.com/tzubertowski/TreeFrogUI?utm_source=chatgpt.com) โก๏ธ Developer Documentation Found a bug or have an idea? โก๏ธ Open a GitHub Issue โก๏ธ Join the TreeFrogUI Discord When reporting a device-specific issue, please include: exact device model and revision; TreeFrogUI version; installation method; expected behavior; actual behavior; reproduction steps; log.txt, when applicable. ๐ Documentation Topic Documentation Installation [TreeFrogUI Installer](https://github.com/tzubertowski/TreeFrogUI-installer/releases) Manual Installation [Installation Guide](https://github.com/tzubertowski/TreeFrogUI/blob/main/install.md?utm_source=chatgpt.com) Downloads Latest Release Supported Systems Cores Reference ROM folders ROM Folder Setup Core-specific setup Core Guides Customization Customization Guide USB / OTG OTG Storage Display scaling Display Scaling PS1 Compatibility [Compatibility List](https://github.com/tzubertowski/TreeFrogUI/wiki/Home/List-of-PS1-games-and-their-reported-performance) Development Ideas Areas of Interest Release history Release Notes Developer documentation Developer Docs โ Support the Project TreeFrogUI is maintained independently, and supporting additional hardware often requires access to physical devices for development and testing. โก๏ธ [Support TreeFrogUI on Ko-fi](https://ko-fi.com/proszty) ๐ License and Attribution TreeFrogUI combines multiple open-source components, each retaining its respective license. โก๏ธ [License and Attribution](https://github.com/tzubertowski/TreeFrogUI/blob/main/LICENSE.md?utm_source=chatgpt.com)