-
Notifications
You must be signed in to change notification settings - Fork 7
Home
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.
Resource | Link -- | -- ๐งฐ Installer | TreeFrogUI Installer โฌ๏ธ Latest Release | Download TreeFrogUI ๐ Manual Installation | Installation Guide ๐ฎ Supported Systems | Cores Reference ๐งช PS1 Compatibility | Reported PS1 Performance ๐ ๏ธ Development Ideas | Areas of Interest ๐ Issues | GitHub Issues ๐ฌ Community | TreeFrogUI Discord
TreeFrogUI is maintained independently, and supporting additional hardware often requires access to physical devices for development and testing.
โก๏ธ Support TreeFrogUI on Ko-fi
TreeFrogUI combines multiple open-source components, each retaining its respective license.
โก๏ธ License and Attribution
Welcome to TreeFrogUI. ๐ธ๐ฎ
# ๐ธ 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](https://github.com/tzubertowski/TreeFrogUI-installer/releases).
| Resource | Link |
|---|---|
| ๐งฐ Installer | [TreeFrogUI Installer](https://github.com/tzubertowski/TreeFrogUI-installer/releases) |
| โฌ๏ธ Latest Release | [Download TreeFrogUI](https://github.com/tzubertowski/TreeFrogUI/releases/latest) |
| ๐ Manual Installation | [Installation Guide](https://github.com/tzubertowski/TreeFrogUI/blob/main/install.md) |
| ๐ฎ Supported Systems | [Cores Reference](https://github.com/tzubertowski/TreeFrogUI/blob/main/cores.md) |
| ๐งช PS1 Compatibility | [Reported PS1 Performance](https://github.com/tzubertowski/TreeFrogUI/wiki/List-of-PS1-games-and-their-reported-performance) |
| ๐ ๏ธ Development Ideas | [Areas of Interest](https://github.com/tzubertowski/TreeFrogUI/wiki/Development-Ideas-%26-Areas-of-Interest) |
| ๐ Issues | [GitHub Issues](https://github.com/tzubertowski/TreeFrogUI/issues) |
| ๐ฌ Community | [TreeFrogUI Discord](https://discord.gg/JYFsmBYFBd) |
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.
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)
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 problems such as:
- missing or broken audio;
- incorrect controls;
- display problems;
- crashes;
- boot failures.
Whenever possible:
- keep a backup of your original SD card;
- use a separate, good-quality SD card for TreeFrogUI;
- verify that you selected the correct device during installation.
For users who need to perform the installation manually:
โก๏ธ [Manual Installation Guide](https://github.com/tzubertowski/TreeFrogUI/blob/main/install.md)
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 the complete Supported Systems and Cores list](https://github.com/tzubertowski/TreeFrogUI/blob/main/cores.md)
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.
Additional applications include:
- ๐ Ebook reader
- ๐ฌ Video player
- ๐ต Music player
- ๐ผ๏ธ Image viewer
- ๐ง Rockbox support
Games are stored inside the roms/ directory on the SD card.
The folder containing a game determines which system or emulator TreeFrogUI launches.
Common examples include:
| Folder | System |
|---|---|
FC |
NES / Famicom |
SFC |
SNES / Super Famicom |
GBA |
Game Boy Advance |
gb |
Game Boy / Game Boy Color |
MD |
Mega Drive / Genesis |
GG |
Game Gear |
PS |
PlayStation 1 |
pce |
PC Engine |
amiga |
Commodore Amiga |
c64 |
Commodore 64 |
m2k |
MAME 2000 |
pico8 |
PICO-8 |
โก๏ธ [View the complete ROM Folder and Emulator Mapping](https://github.com/tzubertowski/TreeFrogUI/blob/main/README.md#rom-folder-setup)
Some systems require additional BIOS or firmware files. Arcade systems may also require ROM sets matching a particular emulator or core version.
โก๏ธ [Core-specific Setup Guides](https://github.com/tzubertowski/TreeFrogUI/tree/main/docs/cores)
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.
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](https://github.com/tzubertowski/TreeFrogUI/blob/main/theme.md)
TreeFrogUI can use compatible USB / OTG storage as an additional game library on supported hardware.
Support and behavior may vary between devices, adapters, and storage hardware.
โก๏ธ [USB / OTG Storage Guide](https://github.com/tzubertowski/TreeFrogUI/blob/main/docs/otg-storage.md)
Available display-scaling options depend on the device and emulator.
Options may include:
- Integer scaling
- Native scaling
- Fill
- Aspect-ratio scaling
โก๏ธ [Display Scaling Guide](https://github.com/tzubertowski/TreeFrogUI/blob/main/docs/display-scaling.md)
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;
- personal media.
โก๏ธ [Latest TreeFrogUI Release](https://github.com/tzubertowski/TreeFrogUI/releases/latest) โก๏ธ [Release Notes](https://github.com/tzubertowski/TreeFrogUI/blob/main/release-notes.md)
If TreeFrogUI does not boot or behaves unexpectedly, first 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.
TreeFrogUI can generate diagnostic information using log.txt.
To enable logging:
- Power off the console.
- Insert the SD card into your computer.
- Create an empty file named
log.txtat the root of the SD card. - Insert the card back into the console.
- Boot TreeFrogUI.
- Reproduce the problem.
- Inspect
/log.txt.
Delete log.txt afterwards to disable diagnostic logging.
Compatibility may differ depending on the game, emulator, hardware revision, BIOS, ROM format, and TreeFrogUI version.
Community test results can help identify games with known issues and possible emulator improvements.
A dedicated compatibility database is being built from reported PlayStation 1 test results.
โก๏ธ [List of PS1 Games and Their Reported Performance](https://github.com/tzubertowski/TreeFrogUI/wiki/List-of-PS1-games-and-their-reported-performance)
TreeFrogUI continues to evolve through experimentation, testing, development, and community contributions.
Some ideas and technical topics that have been discussed are documented separately. These should be understood as areas of interest rather than fixed commitments or development priorities.
Topics currently being explored or discussed include:
- USB and Wi-Fi exploration;
- PSP emulation;
- USB OTG improvements;
- FrogShell and developer tools;
- multi-language support;
- PlayStation 1 compatibility improvements.
โก๏ธ [Development Ideas & Areas of Interest](https://github.com/tzubertowski/TreeFrogUI/wiki/Development-Ideas-%26-Areas-of-Interest)
TreeFrogUI is open source and includes several 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) โก๏ธ [Developer Documentation](https://github.com/tzubertowski/TreeFrogUI/tree/main/docs/dev)
Found a bug or unexpected behavior?
โก๏ธ [Open a GitHub Issue](https://github.com/tzubertowski/TreeFrogUI/issues)
When reporting a device-specific issue, please include whenever possible:
- exact device model;
- hardware revision;
- TreeFrogUI version;
- installation method;
- expected behavior;
- actual behavior;
- reproduction steps;
-
log.txt, when applicable.
You can also discuss TreeFrogUI with the community:
โก๏ธ [Join the TreeFrogUI Discord](https://discord.gg/JYFsmBYFBd)
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)
TreeFrogUI combines multiple open-source components, each retaining its respective license.
โก๏ธ [License and Attribution](https://github.com/tzubertowski/TreeFrogUI/blob/main/LICENSE.md)
Welcome to TreeFrogUI. ๐ธ๐ฎ