pi-nes

KO | EN

gitlite — search

#library #java #nodejs #database #javascript #php #ios #swift #android #python #cpp #bash

★ 26 Open GitHub ↗

An NES emulator for Pi. Play classic Nintendo games while your agent works. ROMs not included

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# pi-nes

Play NES games in your terminal. A [Pi](https://pi.dev/) extension that runs a full NES emulator with Kitty graphics support.

![pi-nes demo](https://raw.githubusercontent.com/tmustier/pi-nes/main/assets/demo.gif)

## Installation

```bash
pi install npm:@tmustier/pi-nes
```

Or from git:
```bash
pi install git:github.com/tmustier/pi-nes
```

## Updating

If you installed from npm:

```bash
pi update npm:@tmustier/pi-nes
```

Then fully restart `pi`.

### Updating from older versions

- No config migration is required.
- On Kitty-compatible terminals (Ghostty, Kitty, WezTerm), image mode now opens in pi's main custom UI instead of an overlay.
- Text mode still uses the classic overlay experience.

## Quick Start

```bash
/nes              # Pick a ROM from your library
/nes ~/roms/smb.nes   # Load a specific ROM
```

On first run, you'll be prompted to set your ROM directory and display quality. When launching `/nes` without a path, type to filter the ROM list while you navigate.

## Controls

### Game Controls

| Action | Keys |
|--------|------|
| D-pad | Arrow keys or WASD |
| A button | Z |
| B button | X |
| Start | Enter or Space |
| Select | Tab |

### Emulator Controls

| Action | Key |
|--------|-----|
| Detach (keep running) | Ctrl+Q |
| Quit | Q |

**Tip:** Detach with `Ctrl+Q` to return to pi, then run `/nes` to reattach to your game.

## Commands

| Command | Description |
|---------|-------------|
| `/nes` | Pick a ROM or reattach to running session |
| `/nes <path>` | Load a specific ROM file |
| `/nes config` | Quick setup (ROM directory + audio) |
| `/nes-config` | Toggle audio, quality, and display style + advanced options |
| `/nes debug` | Show FPS and memory stats |

## Configuration

Config is stored at `~/.pi/nes/config.json`. Use `/nes config` for quick setup (ROM dir + audio), or `/nes-config` to toggle audio/quality/style inline and access advanced options.

```json
{
  "romDir": "/roms/nes",
  "saveDir": "/roms/nes/saves",
  "renderer": "image",
  "imageQuality": "balanced",
  "videoFilter": "ntsc-composite",
  "enableAudio": false,
  "pixelScale": 1.0,
  "keybindings": {
    "up": ["up", "w"],
    "down": ["down", "s"],
    "left": ["left", "a"],
    "right": ["right", "d"],
    "a": ["z"],
    "b": ["x"],
    "start": ["enter", "space"],
    "select": ["tab"]
  }
}
```

### Options

| Option | Default | Description |
|--------|---------|-------------|
| `romDir` | `/roms/nes` | Where to look for ROM files |
| `saveDir` | `/roms/nes/saves` | Where to store battery saves (defaults to `<romDir>/saves`) |
| `renderer` | `"image"` | `"image"` (Kitty graphics) or `"text"` (ANSI) |
| `imageQuality` | `"balanced"` | `"balanced"` (30 fps) or `"high"` (60 fps) |
| `videoFilter` | `"ntsc-composite"` | `"off"`, `"ntsc-composite"`, `"ntsc-svideo"`, `"ntsc-rgb"` |
| `enableAudio` | `false` | Enable audio output (requires native core built with `audio-cpal`) |
| `pixelScale` | `1.0` | Display scale (0.5–4.0) |

`videoFilter` applies a lightweight CRT/NTSC-inspired pass (horizontal bleed + scanlines). It runs in the native core and is optional.

## Saves

Battery-backed SRAM is saved to `<saveDir>/<rom-name>-<hash>.sav` where the hash is derived from the full ROM path to avoid collisions. Old `<rom-name>.sav` files are ignored.

Saves are flushed on quit and periodically during play.

## Terminal Support

**Best experience:** a Kitty-protocol terminal like Ghostty, Kitty, or WezTerm (image protocol + key-up events).

- **Kitty-protocol terminals** — Full graphics via image protocol (shared memory or file transport). Image mode opens in pi's main custom UI instead of an overlay to avoid Ghostty black-screen rendering issues.
- **Other terminals** — Falls back to ANSI half-block characters (`▀▄`)

Set `"renderer": "text"` if you prefer the ANSI renderer or want the classic overlay experience.

## Audio after npm install or update

The published package works without audio by default. To enable audio, rebuild the native core with the `audio-cpal` feature.

First, find the installed `@tmustier/pi-nes` path:

```bash
pi list
```

Then `cd` into the printed install path plus `extensions/nes/native/nes-core`, and rebuild:

```bash
npm install
npm run build:audio
```

For a standard global npm install, that path is typically:

```bash
cd "$(npm root -g)/@tmustier/pi-nes/extensions/nes/native/nes-core"
```

Then enable audio in `/nes-config`.

If you update `@tmustier/pi-nes` later, run `build:audio` again because the native binary may be replaced during the update.

## Limitations

- **Audio is opt-in** — Requires building the native core with `audio-cpal` and setting `enableAudio: true`
- **No auto-save** — Save manually just like you would with the original NES (battery-backed SRAM)

## Vendored Dependencies

- `nes_rust` is vendored under `extensions/nes/native/nes-core/vendor/nes_rust`.
- Fork: https://github.com/tmustier/nes-rust (upstream: https://github.com/takahirox/nes-rust)
- Update helper: `scripts/update-vendor-nes-rust.sh`

---

## Building from Source

Requires Rust toolchain (cargo + rustc).

```bash
git clone https://github.com/tmustier/pi-nes
cd pi-nes
npm install

# Build the NES core (required)
cd extensions/nes/native/nes-core
npm install && npm run build

# Build the NES core with audio (optional)
npm run build:audio

# Build shared memory renderer (optional, faster on Kitty)
cd ../kitty-shm
npm install && npm run build
```

Run locally:
```bash
pi --extension /path/to/pi-nes
```

## Troubleshooting

### `/nes` or `/nes-config` shows up twice

You likely have both an npm install and a local/path install enabled.

Check installed packages:

```bash
pi list
```

Then remove the extra one:

```bash
pi remove <source>      # for entries under "User packages"
pi remove -l <source>   # for entries under "Project packages"
```

pi-nes

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README