{"id":49730157,"url":"https://github.com/otaviocastejon/pocket-emulator","last_synced_at":"2026-05-09T06:01:34.419Z","repository":{"id":356656321,"uuid":"1233505618","full_name":"otaviocastejon/pocket-emulator","owner":"otaviocastejon","description":"A Gameboy/Gameboy Colour Emulator that I coded in Rust for fun, fully functional.","archived":false,"fork":false,"pushed_at":"2026-05-09T04:50:27.000Z","size":6325,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-05-09T05:40:27.582Z","etag":null,"topics":["emulators","gameboy","gameboy-color","rust"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/otaviocastejon.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-05-09T03:14:18.000Z","updated_at":"2026-05-09T05:06:13.000Z","dependencies_parsed_at":null,"dependency_job_id":"da498dac-d014-4606-b5f3-d61c8fe7247f","html_url":"https://github.com/otaviocastejon/pocket-emulator","commit_stats":null,"previous_names":["otaviocastejon/pocket-emulator"],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/otaviocastejon/pocket-emulator","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/otaviocastejon%2Fpocket-emulator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/otaviocastejon%2Fpocket-emulator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/otaviocastejon%2Fpocket-emulator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/otaviocastejon%2Fpocket-emulator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/otaviocastejon","download_url":"https://codeload.github.com/otaviocastejon/pocket-emulator/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/otaviocastejon%2Fpocket-emulator/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32809147,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-08T08:22:46.396Z","status":"online","status_checked_at":"2026-05-09T02:00:06.633Z","response_time":123,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["emulators","gameboy","gameboy-color","rust"],"created_at":"2026-05-09T06:00:43.292Z","updated_at":"2026-05-09T06:01:34.404Z","avatar_url":"https://github.com/otaviocastejon.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# PocketEmulator\n\n## About\n\n**PocketEmulator** is a **Game Boy (DMG) and Game Boy Color (GBC)** emulator. You get a **desktop launcher** to manage your ROM library, profiles, and save files, plus a **native gameplay window** with scaling, filters, and keyboard controls. The CPU and PPU are emulated in Rust; **audio is not implemented yet** (APU stubbed).\n\nThis project **does not** emulate Game Boy Advance.\n\n---\n\n## Tech stack\n\n| Layer | Details |\n|--------|---------|\n| **Core emulator** | Rust — CPU (SM83), PPU, cartridges (MBC0/1/3/5), timers, serial (experimental link). |\n| **Gameplay window** | `pixels` + `winit` — framebuffer, input, HUD. |\n| **Launcher shell** | **Tauri 2** — desktop WebView hosting the UI. |\n| **Launcher UI** | **React**, **TypeScript**, **Vite**. |\n| **IPC** | Tauri commands between the UI and Rust (ROM library, settings, saves). |\n| **Packaging** | Tauri bundler — `.app` on macOS, NSIS / `.exe` on Windows. |\n\n---\n\n## Quick start (downloads)\n\nPrebuilt builds are attached to **[GitHub Releases](https://github.com/otaviocastejon/pocket-emulator/releases)** for **macOS** and **Windows**. Pick the latest version and download the artifact for your OS.\n\n### macOS\n\n1. Download **`PocketEmulator-macos.zip`** from the release and unzip it so **`PocketEmulator.app`** exists (for example in **`~/Downloads`**).\n2. Follow **[Run the downloaded app on macOS](#run-the-downloaded-app-on-macos)** below — you usually need **`xattr`** once because the app is not signed/notarized.\n3. Later launches: double‑click **`PocketEmulator.app`** in Finder. Optional CLI: `open ~/Downloads/PocketEmulator.app` or run **`PocketEmulator.app/Contents/MacOS/PocketEmulator`** for flags (e.g. `--menu`).\n\n### Run the downloaded app on macOS\n\nDownloads from GitHub are **quarantined** and **unsigned**, so Gatekeeper may block a normal double‑click or show **“damaged”**—that is usually quarantine, not a broken file.\n\nIf **`PocketEmulator.app`** is in your **Downloads** folder, open **Terminal** and run:\n\n```bash\nxattr -cr ~/Downloads/PocketEmulator.app\nopen ~/Downloads/PocketEmulator.app\n```\n\n- **`xattr -cr`** clears extended attributes (including quarantine) on the app bundle so macOS will allow it to run.\n- **`open`** starts the app.\n\nIf the `.app` lives somewhere else, replace the path (for example `~/Desktop/PocketEmulator.app`). After the first successful launch, you can open it from Finder like any app.\n\n**Alternatives if you prefer the GUI:** **System Settings → Privacy \u0026 Security → Open Anyway**, or **right‑click the app → Open**.\n\n### Windows\n\n1. Download the **Windows** asset from the same release page (installer **`.exe`** from NSIS and/or portable **`PocketEmulator.exe`**, depending on what was uploaded).\n2. Run the **installer** and follow the prompts, **or** run **`PocketEmulator.exe`** directly.\n3. If SmartScreen warns about an **unknown publisher**, choose **More info → Run anyway** (unsigned builds).\n\n---\n\n## Using the app\n\n- The **launcher** opens by default: **My Games** (library), **Saves**, **Settings**, **Get ROMs** (catalog link).\n- Supported ROM types: **`.gb`** / **`.gbc`** only.\n- **Gameplay:** keyboard — D‑Pad arrows, **Z** (A), **X** (B), **Enter** (Start), **Shift** (Select), **Space** (fast‑forward hold), **Esc** quit. **F5** quick save, **F9** reload save, **F2** pick another ROM, **F12** screenshot (PPM in app data).\n\n### Where data is stored\n\n| OS | Path |\n|----|------|\n| **macOS** | `~/Library/Application Support/com/pocketemulator/pocketemulator` |\n| **Windows** | `%LOCALAPPDATA%\\com\\pocketemulator\\pocketemulator` |\n| **Linux** (from source) | `~/.local/share/com/pocketemulator/pocketemulator` |\n\nThere you’ll find `state.json`, `saves/*.sav`, and screenshots.\n\n---\n\n## Building from source\n\n### Prerequisites\n\n- **Rust** (stable), **Node.js 20+**, repo cloned locally.\n\n### Launcher + bundled app (recommended)\n\n```bash\nnpm ci --prefix frontend\n./build-app macos      # macOS → ./PocketEmulator.app\n./build-app windows    # run on Windows → PocketEmulator.exe at repo root\n```\n\n### CLI only (game window / headless flows)\n\n```bash\ncargo build --release\ncargo run --release -- path/to/game.gb\ncargo run --release -- --menu          # open the launcher flow (see src/main.rs)\n```\n\nCommon flags: `--scale N` (default `4`), `--info`, `--no-autosave`, `--package` (copy binary to `dist/`), `--regression`.\n\n---\n\n## Development\n\n- **Test ROMs (optional):** place open ROMs under `roms/tests/` (gitignored). See [Blargg’s GB tests](https://github.com/retrio/gb-test-roms), [dmg-acid2](https://github.com/mattcurrie/dmg-acid2). Run `cargo test`.\n- **Opcode tables:** after editing generators:\n  ```bash\n  python3 tools/gen_cpu_opcodes.py\n  python3 tools/gen_cb.py\n  ```\n\n### Layout\n\n- `src/cpu/` — SM83 core (`opcodes_gen.rs`, `cb_gen.rs`)\n- `src/ppu.rs` — LCD / tiles / sprites\n- `src/cartridge/` — MBC + `.sav`\n- `src/frontend/desktop/` — native game window\n- `frontend/` — launcher UI\n\n---\n\n## Legal\n\nYou must supply your own ROM dumps. This repository does not distribute copyrighted games.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fotaviocastejon%2Fpocket-emulator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fotaviocastejon%2Fpocket-emulator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fotaviocastejon%2Fpocket-emulator/lists"}