simeonradivoev/gameflow-deck
simeonradivoev/gameflow-deck
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

doc: Updated readme

Browse source
This commit is contained in:
Simeon Radivoev 2026-03-15 17:23:45 +02:00
parent c86e8cd197
commit acadfe04ad
Signed by: simeonradivoev
GPG key ID: C16C2132A7660C8E
1 changed files with 24 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

39
README.md
View file

@ -1,27 +1,34 @@
# Gameflow Deck # Gameflow Deck
A Cross-Platform Retro gaming frontend designed for handheld and controllers. A Cross-Platform open source Retro gaming frontend designed for handheld and controllers.
Focused on building a simple user experience and intuitive UI. Focused on building a simple user experience and intuitive UI as a curated community driven experience.
> [!WARNING] > [!WARNING]
> This app is actively in development, it doesn't have most of its critical features implemented yet. > This app is actively in development, it doesn't have most of its major features implemented yet.
> It will have an opinionated design and will be used as an experiment in discovering a good UX. > It will have an opinionated design and will be used as an experiment in discovering a good UX.
## Features ## Features
- **Cross Platform**: Can run on multiple platforms. Built with web technologies and bun backend. ### Integrations
- **[Romm](https://github.com/rommapp/romm) Support**: Has integration with romm. - **[ROMM](https://github.com/rommapp/romm)** - download, sync and update roms and platforms.
- **Lightweight**: It uses the existing system browser to launch the front end, so no need to include a whole web browser. - **[Emulator JS](https://github.com/EmulatorJS/EmulatorJS)** - play your games with emulator js right within the app. Uses RetroArch cores.
### Store
- **Emulators** - (WIP) Download and install emulators and automatically configure them
- **Free Curated Games** - Download free curreted games and homebrew roms without ever leaving the app
### Others
- **Cross Platform** - Can run on multiple platforms. Built with web technologies and bun backend.
- **Steam Deck Support** - Extensively tested with the steam deck. It can use flatpak installed browsers.
- **Lightweight** - It uses the existing system browser to launch the front end, so no need to include a whole web browser.
- On Windows it first uses webview2 then your browser - On Windows it first uses webview2 then your browser
- On linux it uses WebKitGTK or a browser even from flatpak - On linux it uses WebKitGTK or a browser even from flatpak
- Not tested on Mac yet - Not tested on Mac yet
- **Steam Deck Support**: Extensively tested with the steam deck. It can use flatpak installed browsers. - **Great for Controllers** - The UI is inspired by the switch and works great with joysticks and dpads.
- Automatic Keyboard prompts - **Automatic Downloads** - Downloads roms from ROMM automatically
- **Great for Controllers**: The UI is inspired by the switch and works great with joysticks and dpads. - **Automatic Emulator Discovery** - Using the configs of the excellent ES-DE to discover installed emulators and launch games.
- **Automatic Download** Downloads roms from ROMM automatically
- **Automatic Emulator Discovery** Using the configs of the excellent ES-DE to discover installed emulators and launch games.
- Easy fallback configuration with built in file browser. - Easy fallback configuration with built in file browser.
- **Responsive Layout** Optimized mainly for the steam deck with responsive layout support and dynamic switching of inputs. - **Responsive Layout** - Optimized mainly for the steam deck with responsive layout support and dynamic switching of inputs.
## Screenshots ## Screenshots
@ -33,9 +40,10 @@ Focused on building a simple user experience and intuitive UI.
## Goals ## Goals
I want to build an open and free platform where you can play and discover new hidden gems from the past. - I want to build an open and free platform where you can play and discover new hidden gems from the past.
I plan to add a free store where you can download all your needed emulators, the goal is to not have to leave the UI for anything. - I plan to add a free store where you can download all your needed emulators, the goal is to not have to leave the UI for anything.
I really want to add matrix chat support in the app for engaging with your favorite community. Having access to so many nodejs libraries would make it quite straight forward. - I really want to add matrix chat support in the app for engaging with your favorite community. Having access to so many nodejs libraries would make it quite straight forward.
- I'm sick of closed source and private store fronts, and want a way to share community currated free experiences. I'm also sick of the profit driven nature of games and promotions.
## Development ## Development
@ -77,3 +85,4 @@ I really want to add matrix chat support in the app for engaging with your favor
- [Tanstack](https://tanstack.com/) router and query for navigation and data - [Tanstack](https://tanstack.com/) router and query for navigation and data
- [elysia](https://elysiajs.com/) for the APIs - [elysia](https://elysiajs.com/) for the APIs
- [webview](https://github.com/webview/webview) for launching existing system webviews instead of full browser if possible. - [webview](https://github.com/webview/webview) for launching existing system webviews instead of full browser if possible.
- [emulatorjs](https://emulatorjs.org/) for playing lots of roms inside the app without having to deal with external emulators