Skip to content

Repository files navigation

retsurf — a gamepad-first web browser for retro handhelds

Latest release Downloads CI

retsurf is a web browser written in Rust and built with Servo and SDL2. It aims to provide a full-featured web experience while staying lightweight and portable. It targets handheld devices while also working on PCs, offering flexible, remappable controls for comfortable web browsing and gaming using only a gamepad or keyboard.

Install on a PortMaster handheld, a Miyoo Mini, Android, Linux, Windows, or macOS.

Work in progress. Early development — expect bugs.

Demos

Powkiddy RGB30 Miyoo Mini Flip
retsurf held in both hands on a Powkiddy RGB30, scrolling an image-heavy news site retsurf on a Miyoo Mini Flip, scrolling servo.org with the D-pad
OpenGL ES software build, no GPU

Screenshots

Start page Browsing Link hints Keyboard
The built-in start page: a search field over a speed-dial grid of pinned sites Hacker News rendered by Servo in its mobile layout, the toolbar above it Vimium-style hints over a Wikipedia article, each link labeled with the gamepad buttons that open it The on-screen keyboard raised under the start page's search field, which shows what has been typed
Tabs Downloads Reader mode Settings
The menu's Tabs section: open tabs by title, each with a bookmark and close button The Downloads section: one file downloading with percentage and size, one finished A Wikipedia article stripped to its text by reader mode The settings overlay on its Browser tab: home page, search URL, user agent, zoom, theme and the experimental web features

Features

  • Gamepad-first navigation
    The browser is fully navigable with a gamepad or keyboard, with a virtual cursor, Vimium-style link hints, and an on-screen keyboard (QWERTY + ЙЦУКЕН).

  • Customizable browser controls
    Every browser action can be rebound in-app, with support for tap, hold, and chord.

  • Game mode
    Hides the browser chrome and routes input to the page, with an in-app remapper that can rebind any button with multiple profiles.

  • Tabs, bookmarks, history, and downloads
    Everything lives in one full-screen menu. Downloads run in the background with progress and cancellation and a toolbar chip for active downloads.

  • Real page zoom
    Reflows the layout rather than simply magnifying it, with 50–300% zoom steps. Zoom is per-tab.

  • Reader mode
    Strips pages down to their articles using Mozilla's Readability. Runs in place, so it also works with logged-in and dynamically rendered pages.

  • Dark web pages
    Uses sites' own dark themes through prefers-color-scheme, or forces a dark appearance by inverting pages that don't provide one.

  • Ad & tracker blocking
    Network-level blocking powered by Brave's adblock-rust, using EasyList and EasyPrivacy.

  • In-app updates
    Checks GitHub for updates, displays release notes, and installs updates in place on Linux. Supports stable, beta, and nightly channels.

  • Audio and video
    A custom Servo media backend provides audio and video playback. Supports direct media files and embedded players, but not streaming sites that require MSE.

  • No display server required
    SDL2 draws through whatever video backend the firmware ships. X11 and Wayland are optional, not required.

  • Hardware or software rendering
    A custom Servo rendering backend uses OpenGL ES for GPU-accelerated rendering on supported devices, with a CPU-based software renderer for devices without a GPU.

Install

Download the latest release for your platform below. All builds are available on Releases. Nightly builds from main use the same file names under the rolling nightly tag.

Device Package Where it goes
PortMaster handhelds (ArkOS, dArkOS, EmuELEC, Knulli, muOS, ROCKNIX) retsurf-portmaster.zip ports folder, e.g. /roms/ports/
Miyoo Mini Flip and Plus on OnionOS retsurf-onionos.zip App/Retsurf/ on the SD card
Miyoo Mini Flip and Plus on Allium retsurf-allium.zip Apps/Retsurf.pak/ on the SD card
Android retsurf-android-arm64.apk sideload it
Linux retsurf-linux-x86_64.zip, retsurf-linux-aarch64.zip unpack and run
Windows retsurf-windows-x86_64.zip unpack and run
macOS retsurf-macos-aarch64.dmg open it and run Retsurf.app

On both Miyoo firmwares the app shows up in the Apps menu, and MENU quits it.

Building

cargo run, once Servo's build dependencies are installed. See Building from source for the prerequisites on each OS, the Cargo features, Android, and the handheld cross-builds.

Configuration

Files are stored in the user data directory (SDL_GetPrefPath, e.g. ~/.local/share/mxmgorin/retsurf/ on Linux). Templates with the defaults are written on first run. See Configuration & bindings for all options and the bindings reference.

How to help

If you find the project useful, here is how you can help:

  • Tell other people about it. Sharing the project helps it reach more users.
  • Report bugs and request features in Issues. If something is broken or you have an idea, let me know.
  • Star the repo. It helps the project get noticed and keeps me motivated.

Credits

About

Web browser focused on gamepad and keyboard controls, built with Servo and SDL2

Topics

Resources

Stars

56 stars

Watchers

2 watching

Forks

Releases

Contributors

Languages