cmclark00/retro-imager
1
0
Fork 0
mirror of https://github.com/cmclark00/retro-imager.git synced 2025-05-17 23:45:21 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
The home of Retro Imager, a user-friendly tool for creating bootable media for retro handheld gaming devices.
782 commits 7 branches 4 tags 56 MiB
Find a file
cmclark00 2342facc6e
Update os_list.json
2024-11-26 22:03:22 -05:00
.github Update build-arm64-mac.yml 2024-10-15 14:33:56 -04:00
debian debian/postinst: Add missing newline 2024-10-07 11:21:14 +01:00
doc doc: Add example os_list sublist JSON 2023-11-10 18:55:28 +00:00
embedded embedded: Change how buildroot patch is applied 2024-06-25 10:10:55 +01:00
src Update os_list.json 2024-11-26 22:03:22 -05:00
tests Add integration tests 2022-11-19 23:49:43 +01:00
.gitignore gitignore: Hide more debuild artefacts 2024-10-07 11:21:14 +01:00
appimagecraft.yml more name changes 2024-10-13 20:53:32 -04:00
license.txt Fix copyright file 2022-10-11 16:15:49 +02:00
README.md Update README.md 2024-10-15 20:48:04 -04:00

README.md

Retro-Imager

Retro-Imager is a fork of the official Raspberry Pi Imager, specially tailored for retro gaming handhelds and the custom firmwares that power them. This project simplifies the process of flashing custom firmware images to your retro handheld devices, allowing you to quickly get set up and start gaming.

Supported Devices & Custom Firmwares

At present, Retro-Imager supports: muOS and Rocknix. More devices and firmwares will be added in future releases!

Features

  • Easy-to-use interface: Retro-Imager retains the familiar look and feel of Raspberry Pi Imager, making it accessible to anyone.
  • Handheld Focus: Tailored specifically for retro handheld gaming devices, eliminating unnecessary options for general-purpose single-board computers.
  • Custom Firmware Support: Flash custom OS images like muOS and Rocknix quickly and easily.
  • Firmware Recommendations: The top-most firmware option for each device is our recommended choice, ensuring optimal performance and compatibility.

Getting Started

Prerequisites

  • A computer running Linux (x86_64) or Windows (x86_64)
  • A microSD card reader
  • A microSD card (at least 8GB, though larger is recommended)

Installation

  1. Download the most recent release from the GitHub releases page.
  2. Extract the files (if necessary) and run the application on your system:
    • For Linux: Make the file executable and run it. 
      chmod +x retro-imager.AppImage
./retro-imager.AppImage
    • For Windows: Double-click the .exe file.

Using Retro-Imager

  1. Launch Retro-Imager.
  2. Select your device from the list (e.g., RG35XX Plus, RG28XX, RGB30).
  3. Choose the custom firmware you would like to install. The top-most option is the recommended firmware for your selected device.
  4. Insert your microSD card into your computer.
  5. Select the correct device from the list and click "Write".
  6. Safely remove the microSD card and insert it into your retro gaming handheld.

Contributing

We welcome contributions! Whether you're improving code, fixing bugs, or expanding firmware support, your help is appreciated.

To contribute:

  1. Fork the repository.
  2. Create a new branch: 
    git checkout -b feature/YourFeature
  3. Commit your changes: 
    git commit -m "Add some feature"
  4. Push to the branch: 
    git push origin feature/YourFeature
  5. Open a Pull Request.

License

This project is licensed under the MIT License. See the LICENSE file for details.