Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

App Submission: RomM #2020

Merged
merged 15 commits into from
Feb 17, 2025
Merged

App Submission: RomM #2020

merged 15 commits into from
Feb 17, 2025

Conversation

mateosilguero
Copy link
Contributor

@mateosilguero mateosilguero commented Jan 7, 2025

App Submission

romm

romm (Rom Manager) is a web based retro roms manager integrated with IGDB. Also it has an embebed emulator

256x256 SVG icon
https://raw.githubusercontent.com/zurdi15/romm/a700aa98429b0ec96ec8d9d32ffa01c989d3569f/romm.svg

Gallery images
Captura de pantalla 2023-08-29 a la(s) 09 43 19

I have tested my app on:
Umbrel dev environment
Umbrel OS on a Raspberry Pi 4
Custom Umbrel install on Linux

@jimbrend
Copy link
Contributor

Thank you for your work here and to re-open mateosilguero.
I really appreciate it, making mental note, cool!

@dennysubke
Copy link
Contributor

The app is published in my Community AppStore and can be used in the meantime. 😎

ba04f2b009bf1aa58ad02b29c151f22ddf6cbba9_2_1380x774.jpeg

https://github.com/dennysubke/dennys-umbrel-app-store

Copy link
Contributor

@al-lac al-lac left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @mateosilguero for the submission!

Added some comments on what needs to be changed.

There is still the issue that the IGDB_CLIENT data cannot be set in the Web UI. So metadata for roms will not load unless you set it manually in the docker-compose.yml.

Also I was only able to upload roms after I hosted the site behind nginx with enabled websocket support.
Still aligning with @nmfretz on how we could tackle this.

Copy link

⚠️   Linting finished with 1 warning   ⚠️

Thank you for your submission! This is an automated linter that checks for common issues in pull requests to the Umbrel App Store.

Please review the linting results below and make any necessary changes to your submission.

Linting Results

Severity File Description
⚠️ romm/umbrel-app.yml "icon" and "gallery" needs to be empty for new app submissions:
The "icon" and "gallery" fields must be empty for new app submissions as it is being created by the Umbrel team.

Legend

Symbol Description
Error: This must be resolved before this PR can be merged.
⚠️ Warning: This is highly encouraged to be resolved, but is not strictly mandatory.
ℹ️ Info: This is just for your information.

@nmfretz nmfretz changed the title Feat/add romm App Submission: RomM Feb 17, 2025
@nmfretz
Copy link
Contributor

nmfretz commented Feb 17, 2025

Thanks for submitting RomM again @mateosilguero! And thanks for reviewing @al-lac. I have accepted @al-lac's changes and finalized with a few more commits that you can follow along with if curious.

Also I was only able to upload roms after I hosted the site behind nginx with enabled websocket support.
Still aligning with @nmfretz on how we could tackle this.

We tracked this down to an IGDB credentials error if the env var is included without proper credentials:

 erroring on the igdb credentials: httpx.LocalProtocolError: Illegal header value b'Bearer ' 

The original submission had these uncommented placeholders:

- IGDB_CLIENT_ID=IGDB_CLIENT_ID
- IGDB_CLIENT_SECRET=IGDB_CLIENT_SECRET

Which we have commented out in the compose file.

I'm super glad this can come to the official app store now that rom upload via the app's UI has now been implemented. Also, with the new umbrelOS Files feature (in beta) users can easily upload roms because they can access the data directory for specific apps:

romm.mp4

Gallery assets have been prepared and we are good to go live!

image

@nmfretz nmfretz merged commit 9dbcbef into getumbrel:master Feb 17, 2025
1 check passed
@mateosilguero
Copy link
Contributor Author

Thank you @nmfretz !

@gantoine
Copy link

gantoine commented Feb 23, 2025

Hey @mateosilguero, thanks for the submission (and @nmfretz for accepting it)! The team wasn't familiar with Umbrel until we found this PR and the app on the community page. We're planning to release version 3.8 very soon, and it'll likely require some changes to these files (plus a new logo and screenshots). Everything should be in the release notes once it's out, but don't hesitate to ping me if anything comes up!

@nmfretz
Copy link
Contributor

nmfretz commented Feb 24, 2025

Hey @gantoine, thanks very much for the heads up! RomM is a wonderful app. Is the ability to input/modify api credentials for IGDB etc through RomM's UI on your roadmap/radar by chance? If that was ever implemented, it would make this app truly one-click install and then users could add credentials through the app's UI instead of needing to modify environment variables outside of the app.

We'll keep our eyes out for the release. Good luck with the continued alpha and beta testing!


Also, if you ever end up wanting to showcase that RomM is available on the umbrelOS app store, there are badges available via our app store preview site that you can use:

The general url for an app-specific badge is:

https://apps.umbrel.com/api/app/<app-id>/badge-<light-or-dark>.svg

So, for RomM,

Dark badge:
app-dark-badge

Light badge:
app-light-badge

Or you can also just use a generic, non-app-specific badge:

https://apps.umbrel.com/badge-<light-or-dark>.svg

Dark:
dark-badge

Light:
light-badge

@gantoine
Copy link

Is the ability to input/modify api credentials for IGDB etc through RomM's UI on your roadmap/radar by chance?

Not at the moment, as we tend to define options as container-wide vs user specific, and these fall under container wide since they're used by all admin users. A counter example would be RetroAchievements credentials (when we finally finish that PR...), which need to pull data for each user.

And thanks for posting the badges! I've added it to our app templates repo, and it'll likely make its way into the main site when we rework it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants