Installation

🚀 Installation

OpenROM comes as a single file for every platform — no installer, no dependencies, no drama.

---

🪟 Windows — just unzip & run

1. Download OpenROM_Windows_Portable.zip from the latest release
2. Unzip it anywhere you like
3. Double-click OpenROM.exe

Windows might warn you with a "Windows protected your PC" popup — that's just SmartScreen being dramatic about unsigned apps. Click "More info" → "Run anyway" and you're good.

---

🐧 Linux — AppImage one-liner

1. Download OpenROM_Linux_x86_64.AppImage from the latest release

2. Make it executable:

   :::bash
   chmod +x OpenROM_Linux_x86_64.AppImage

3. Run it:

   :::bash
   ./OpenROM_Linux_x86_64.AppImage

Or just double-click it in your file manager if your distro supports AppImages.

Ubuntu 22.04+ users: if nothing happens on double-click, you might need libfuse:
bash sudo apt install libfuse2

---

🍎 macOS — drag to Applications

Apple Silicon (M1/M2/M3/M4)

Download OpenROM_macOS_arm64.dmg

Intel Mac

Download OpenROM_macOS_x86_64.dmg

Then:

1. Open the DMG file
2. Drag OpenROM to your Applications folder
3. Open it

Gatekeeper warning? macOS will say it "cannot verify the developer" — because we're indie, not Apple-certified 😅

To bypass it, open Terminal and run:
bash xattr -cr /Applications/OpenROM
Then try opening it again.

---

🤓 Running from Source

If you want to run directly from the code:

Requirements:

• Python 3.10+

• pip

  :::bash
  git clone https://github.com/M5Devs/OpenROM
  cd OpenROM
  pip install -r requirements.txt
  python main.py

Want to build your own executable?

# Windows
build.bat

# Linux
chmod +x build.sh && ./build.sh

# macOS
chmod +x build_mac.sh && ./build_mac.sh

The output lands in the dist/ folder.

---

Something not working?

→ Check [Troubleshooting]