README.md

Important

This software is currently in an alpha state. It can break quite a lot, and it doesn't yet have a polished, foolproof UX.

Contributions are welcome!

Please, if you got into some trouble with it, just create a new issue, or contact us on Telegram and Discord.

RetroPlus

A simple ROM downloader

Join the Telegram/Discord! — Don't forget to star the repo if you are enjoying the project!

---

🤡 Disclaimer

This content does not endorse or encourage any form of piracy. Engaging in piracy is illegal and can result in severe legal consequences. Users are advised to respect copyright laws, support lawful content distribution, and obtain materials through legal channels. The creators of this content disclaim any responsibility for the misuse or illegal activities related to piracy.

---

📦️ Alternative installation methods

Warning The main installation method is Flatpak from Flathub

None

---

🏗️ Building from source

Requirements

• git
• ninja
• meson >= 0.62.0
• gtk4
• libadwaita >= 1.4
• json-glib
• libsoup
• desktop-file-utils
• libgee

Fedora

1. Install all dependencies:

   sudo dnf install \
     git \
     ninja-build \
     meson \
     gtk4-devel \
     libadwaita-devel \
     json-glib-devel \
     libsoup3-devel \
     desktop-file-utils \
     libgee-devel

2. Clone the GitHub repo and change to repo directory:

   git clone https://github.com/Vysp3r/RetroPlus.git && \
     cd RetroPlus

3. Build the source:

   meson build --prefix=/usr && \
   cd build && \
   ninja

4. (Optional) Install application:

   ninja install

5. Start application:

   cd src && \
   ./com.vysp3r.RetroPlus

Flatpak Builder

1. Install the distro dependencies using your package manager (apt, dnf, pacman, etc):

   sudo <insert your distro package manager and install options here> \
     git \
     flatpak \
     flatpak-builder

2. Add the flathub repo to your user if not added before:

   flatpak --user --if-not-exists remote-add \
     flathub https://flathub.org/repo/flathub.flatpakrepo

3. Install the needed runtimes for flatpak:

   flatpak --user install \
     runtime/org.gnome.Sdk/x86_64/43 \
     runtime/org.gnome.Platform/x86_64/43

4. Clone the GitHub repo and change to repo directory:

   git clone https://github.com/Vysp3r/RetroPlus.git && \
     cd RetroPlus

5. Build the source inside the "build-dir" in the repo directory and install for the current user:

   flatpak-builder --user --install --force-clean \
     build-dir \
     com.vysp3r.RetroPlus.json

6. Start application:

   flatpak --user run \
     com.vysp3r.RetroPlus

---

🙌 Contribute to RetroPlus

Please read our Contribution Guidelines

All contributions are highly appreciated.

---

✨️ Contributors

---

💝 Acknowledgment

This README is based on the README from Gradience by Gradience Team

⤴️ Back to Top