docs: Updated readme and added gif screenshot
This commit is contained in:
parent
c23521bf94
commit
79b627ed31
2 changed files with 18 additions and 3 deletions
BIN
.github/screenshots/iunZbvYEGp-ezgif.com-optimize.gif
(Stored with Git LFS)
vendored
Normal file
BIN
.github/screenshots/iunZbvYEGp-ezgif.com-optimize.gif
(Stored with Git LFS)
vendored
Normal file
Binary file not shown.
18
README.md
18
README.md
|
|
@ -4,7 +4,7 @@ A Cross-Platform open source Retro gaming frontend designed for handheld and con
|
||||||
Focused on building a simple user experience and intuitive UI as a curated community driven experience.
|
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 is contantly chaning and improving.
|
> This app is actively in development, it is constantly changing and improving.
|
||||||
> 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
|
||||||
|
|
@ -19,7 +19,7 @@ Focused on building a simple user experience and intuitive UI as a curated commu
|
||||||
### Store
|
### Store
|
||||||
|
|
||||||
- **Emulators** - (WIP) Download and install emulators and automatically configure them from a list of supported in the store. Some even come with advanced features like cloud saves.
|
- **Emulators** - (WIP) Download and install emulators and automatically configure them from a list of supported in the store. Some even come with advanced features like cloud saves.
|
||||||
- **Free Curated Games** - Download free curreted games and homebrew roms without ever leaving the app
|
- **Free Curated Games** - Download free curated games and homebrew roms without ever leaving the app
|
||||||
|
|
||||||
### Others
|
### Others
|
||||||
|
|
||||||
|
|
@ -48,15 +48,27 @@ Focused on building a simple user experience and intuitive UI as a curated commu
|
||||||
<img src=".github/screenshots/zEQxtzhPGx.png" title="Store Emulators in dark mode" width="25%"></img>
|
<img src=".github/screenshots/zEQxtzhPGx.png" title="Store Emulators in dark mode" width="25%"></img>
|
||||||
<img src=".github/screenshots/MMeJxl4IXr.png" title="Store Emulators in light mode" width="25%"></img>
|
<img src=".github/screenshots/MMeJxl4IXr.png" title="Store Emulators in light mode" width="25%"></img>
|
||||||
<img src=".github/screenshots/EWPHmIBEE5.png" title="Platform Grouping List" width="25%"></img>
|
<img src=".github/screenshots/EWPHmIBEE5.png" title="Platform Grouping List" width="25%"></img>
|
||||||
|
<img src=".github/screenshots/iunZbvYEGp-ezgif.com-optimize.gif" title="Platform Grouping List" width="76%"></img>
|
||||||
|
|
||||||
## 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.
|
- I'm sick of closed source and private store fronts, and want a way to share community curated free experiences. I'm also sick of the profit driven nature of games and promotions.
|
||||||
- Being self contained, I want to avoid writing as little as possible to system and contain and manage settings in a custom changeable directory. This was mainly a side-effect of having the low storage steam deck and always running out of space on my internal hard drive.
|
- Being self contained, I want to avoid writing as little as possible to system and contain and manage settings in a custom changeable directory. This was mainly a side-effect of having the low storage steam deck and always running out of space on my internal hard drive.
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
There are currently 2 ways of getting games. One is logging in through romm and importing your games from there. The other is the store (it's a bit limited right now). I might add local import of roms since IGDB login is already implemented.
|
||||||
|
|
||||||
|
The app created a default folder in your home folder. You can move it. It stores everything there. From downloaded roms, emulators and configs.
|
||||||
|
|
||||||
|
## Existing Setups
|
||||||
|
|
||||||
|
The game should work pretty well with existing emulators one has installed. It uses the ES-DE config to find installed emulators. Only downside is more advanced integrations won't work, as they are mainly used for store emulators where the app has more control over, plus I don't want to mess up existing setups.
|
||||||
|
But given it's an existing setup, say from emudeck it won't matter much as it's already configured say for the steam deck.
|
||||||
|
|
||||||
## Development
|
## Development
|
||||||
|
|
||||||
1. Install dependencies:
|
1. Install dependencies:
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue