-
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, more configurable interface and expands the number of supported systems and features.
TreeFrogUI includes a lightweight game browser, 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 get started is with the TreeFrogUI Installer.Manual installation is also available through the Installation Guide.
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 | โ SupportedTreeFrogUI is maintained independently, and supporting new handheld models often requires access to physical hardware for development and testing.
โก๏ธ Support TreeFrogUI on Ko-fi
TreeFrogUI combines multiple open-source components, and each component retains its respective license.
โก๏ธ License and Attribution
Welcome to TreeFrogUI. ๐ธ๐ฎ
Enjoy your handheld, explore the available systems, customize the interface, and help improve TreeFrogUI by sharing your experience and reporting issues.
# ๐ธ 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, more configurable interface and expands the number of supported systems and features.
TreeFrogUI includes a lightweight game browser, 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 get started is with the [TreeFrogUI Installer](https://github.com/tzubertowski/TreeFrogUI-installer/releases).
Manual installation is also available through the [Installation Guide](https://github.com/tzubertowski/TreeFrogUI/blob/main/install.md).
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 you are using a supported device and the correct installation method.
The recommended way to install TreeFrogUI is by using the official TreeFrogUI Installer.
The installer guides you through the process and handles the required device-specific setup.
It 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/preinstalled system may cause issues such as:
- missing or broken audio;
- incorrect controls;
- display problems;
- crashes;
- boot failures.
Whenever possible, keep a backup of your original SD card before making any changes.
Using a separate, good-quality SD card for TreeFrogUI is strongly recommended.
- Identify your exact device model.
- Back up your original SD card.
- Prepare a fresh SD card.
- Download the [TreeFrogUI Installer](https://github.com/tzubertowski/TreeFrogUI-installer/releases).
- Follow the installer instructions and select the appropriate device.
- Insert the prepared SD card into your console.
- Boot TreeFrogUI.
- Add your games and any required BIOS files.
For advanced or unsupported installation scenarios:
โก๏ธ [Manual Installation Guide](https://github.com/tzubertowski/TreeFrogUI/blob/main/install.md)
TreeFrogUI provides a complete frontend and emulation environment designed for supported handhelds.
Supported systems 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 Amiga
- Commodore 64
- MSX
- ZX Spectrum
- DOS / PC
- PICO-8
- Doom
- Quake
- Cave Story
- Arduboy
- and many more
โก๏ธ [Supported Systems and Cores](https://github.com/tzubertowski/TreeFrogUI/blob/main/cores.md)
TreeFrogUI includes features such as:
- configurable emulator options;
- 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 your SD card.
The folder name determines which system or emulator TreeFrogUI uses.
Example:
roms/
โโโ FC/
โ โโโ Super Mario Bros.nes
โโโ SFC/
โ โโโ Super Mario World.sfc
โโโ GBA/
โ โโโ Advance Wars.gba
โโโ gb/
โ โโโ Tetris.gb
โโโ MD/
โ โโโ Sonic.md
โโโ PS/
โโโ Game.bin
โโโ Game.cue
Common folders:
| 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 |
โก๏ธ [Full ROM Folder and Emulator Mapping](https://github.com/tzubertowski/TreeFrogUI/blob/main/README.md#rom-folder-setup)
Arcade emulators generally require ROM sets matching the specific emulator/core version.
In most cases, arcade .zip files should remain zipped.
Using an incompatible ROM set may result in games failing to launch, missing files, graphical or audio problems, or crashes.
โก๏ธ [Arcade Setup Documentation](https://github.com/tzubertowski/TreeFrogUI/blob/main/docs/cores/arcade.md)
Some systems require additional BIOS or firmware files.
Examples include:
- PlayStation 1
- Game Boy Advance
- Sega CD
- Famicom Disk System
- Neo Geo
- Commodore Amiga
- Atari ST
- Odysseyยฒ / Videopac
- PC-FX
- PC-88
BIOS files are typically stored in:
cubegm/bios/
Some emulator cores may have different requirements.
TreeFrogUI does not provide proprietary BIOS files, commercial ROM sets, or copyrighted game data that must be supplied by the user.
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 supports:
- color themes;
- menu styles;
- system icon packs;
- background themes;
- per-system backgrounds;
- wallpapers;
- fonts;
- box art;
- screenshots;
- title-screen artwork;
- display scaling.
โก๏ธ [Customization Guide](https://github.com/tzubertowski/TreeFrogUI/blob/main/theme.md)
Artwork can be placed alongside ROM collections using .res directories.
Example:
roms/GBA/Advance Wars.gba
roms/GBA/.res/Advance Wars.png
TreeFrogUI can use a FAT32 USB / OTG drive as a separate game library on supported hardware.
A typical external drive looks like:
roms/
โโโ GBA/
โโโ FC/
โโโ SFC/
โโโ PS/
โโโ ...
โก๏ธ [USB / OTG Storage Guide](https://github.com/tzubertowski/TreeFrogUI/blob/main/docs/otg-storage.md)
Depending on the device and emulator, TreeFrogUI provides scaling options such as:
- Integer scaling
- Native scaling
- Fill
- Aspect-ratio scaling
Display capabilities vary between device families.
โก๏ธ [Display Scaling Guide](https://github.com/tzubertowski/TreeFrogUI/blob/main/docs/display-scaling.md)
TreeFrogUI supports offline updates on compatible installations.
Typically:
- Download the official
update.zip. - Copy it to the root of the SD card.
- Safely eject the card.
- Insert it into the console.
- Boot the device.
- Allow TreeFrogUI to verify and apply the update.
Updates are designed to preserve personal content including ROMs, BIOS files, saves, save states, screenshots, favourites, recent games, play-time data, and 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 verify that:
- your device is supported;
- the correct device was selected during installation;
- the SD card was prepared correctly;
- TreeFrogUI was not installed over the factory/preinstalled system;
- required BIOS files are present;
- ROMs are stored in the correct folders;
- the SD card is working correctly.
To enable diagnostic logging:
- Power off the console.
- Insert the SD card into your computer.
- Create an empty file named:
log.txt
at the root of the SD card.
- Boot the device.
- Reproduce the problem.
- Inspect
/log.txt.
Delete log.txt afterwards to disable logging again.
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 boot integration;
- device-specific patches and configuration.
Developers interested in building, porting, testing, debugging, or contributing can use:
โก๏ธ [TreeFrogUI Repository](https://github.com/tzubertowski/TreeFrogUI) โก๏ธ [Developer Documentation](https://github.com/tzubertowski/TreeFrogUI/tree/main/docs/dev)
Found a bug or have an idea?
โก๏ธ [Open a GitHub Issue](https://github.com/tzubertowski/TreeFrogUI/issues) โก๏ธ [TreeFrogUI Discord](https://discord.gg/JYFsmBYFBd)
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.
TreeFrogUI is maintained independently, and supporting new handheld models often requires access to physical hardware for development and testing.
โก๏ธ [Support TreeFrogUI on Ko-fi](https://ko-fi.com/proszty)
TreeFrogUI combines multiple open-source components, and each component retains its respective license.
โก๏ธ [License and Attribution](https://github.com/tzubertowski/TreeFrogUI/blob/main/LICENSE.md)
Welcome to TreeFrogUI. ๐ธ๐ฎ
Enjoy your handheld, explore the available systems, customize the interface, and help improve TreeFrogUI by sharing your experience and reporting issues.