# Regenerator 2000

![Rust](https://github.com/ricardoquesada/regenerator2000/actions/workflows/rust.yml/badge.svg)
[![Crates.io Version](https://img.shields.io/crates/v/regenerator2000)](https://crates.io/crates/regenerator2000)
[![discord](https://img.shields.io/discord/775177861665521725.svg)](https://discord.gg/r5aMn6Cw5q)

![logo](docs/regenerator2000_logo.png)

A 6502 disassembler with a TUI. A modern take on [Regenerator][regenerator].

[regenerator]: https://csdb.dk/release/?id=247992

## Features

Regenerator 2000 brings modern conveniences to 6502 disassembly:

- **Disassembly**: Full 6502 support including undocumented opcodes.
- **Hex Dump**:
  - Side-by-side view with disassembly.
  - Synchronized or independent navigation.
  - Unshifted or Shifted PETSCII and Screencode charset.
- **Sprites**:
  - Side-by-side view with disassembly.
  - Multicolor or Single Color
- **Bitmap**:
  - Side-by-side view with disassembly.
  - High-Resolution (320x200) and Multicolor (160x200).
  - Uses quadrant-block rendering for full resolution in TUI.
- **Charset**:
  - Side-by-side view with disassembly.
  - Multicolor or Single Color
- **Blocks**:
  - Side-by-side view with disassembly.
- **Debugger**: Connect to VICE for live disassembly, breakpoints, run/step (F2–F9); Debugger panel in the right pane.
- **Platforms**: Supports Commodore 8-bit machines like C64, C128, Plus/4, etc.
- **Import**: Load `.prg`, `.crt`, `.d64`, `.d71`, `.d81`, `.t64`, `.vsf`, `.bin`, `.raw`, and
  `.regen2000proj` files.
  - D64: 35/40-track disk images
  - D71: 70-track double-sided disk images
  - D81: 80-track disk images
  - CRT: Cartridge images with bank selection support
- **Export**: Generate compatible assembly source code for:
  - **64tass**
  - **ACME**
  - **Kick Assembler**
  - **ca65**
- **Project Management**: Save and load your work with `.regen2000proj` files.
- **Analysis**: Auto-analysis to identify code and data regions.
- **Editing**:
  - **Labels**: Add, edit, and remove local and global labels.
  - **Comments**: Add side comments and line comments.
  - **Origin**: Change the load address/origin of the binary.
  - **Data Types**: Convert regions to Code, Byte, Word, Address, Lo/Hi Address, Hi/Lo Address, PETSCII Text,
    Screencode Text, External file or Unknown.
  - **Undo/Redo**: Full history support for all actions.
- **Navigation**:
  - **Jump**: Go to specific addresses, specific line numbers, or follow
    operands.
  - **X-Ref**: Inspect cross-references for labels/addresses.
  - **History**: Navigate back to previous locations.
- **Customization**:
  - Configure document settings (max x-refs, platform, assembler).
  - Customizable display options (show/hide all labels, etc.).
- **TUI**:
  - Text User interface
  - Everything can be done from the keyboard
  - **Visual Mode**: Vim-like selection for batch operations.
- **MCP Server**:
  - Model Context Protocol (MCP) server support for programmatic access
  - HTTP and stdio transport modes
  - Tools for disassembly manipulation, memory search, block operations
  - Resources for accessing binary data and views
- **Fast**:
  - Extremely fast

![hexdump screenshot](docs/regenerator2000_hexdump_screenshot.png)
![charset screenshot](docs/regenerator2000_charset_screenshot.png)
![sprites screenshot](docs/regenerator2000_sprites_screenshot.png)
![bitmap screenshot](docs/regenerator2000_bitmap_screenshot.png)
![blocks screenshot](docs/regenerator2000_blocks_screenshot.png)

## Requirements

### Recommended Terminals

To ensure the best experience, especially regarding keyboard shortcuts and rendering, we recommend using a modern
terminal.

| Platform    | Recommended Terminals                              |
| :---------- | :------------------------------------------------- |
| **Windows** | Windows Terminal, Alacritty, WezTerm               |
| **macOS**   | iTerm2, Ghostty, Alacritty, kitty, WezTerm         |
| **Linux**   | Ghostty, Alacritty, kitty, WezTerm, GNOME Terminal |

## Installation

### From Crates.io

```bash
cargo install regenerator2000
```

### From Source

```bash
git clone https://github.com/ricardoquesada/regenerator2000.git
cd regenerator2000
cargo install --path .
```

## Usage

Start the application with an optional file to load:

```bash
regenerator2000 [OPTIONS] [path/to/file.prg]
```

## CLI Options

-   `--help`: Print help message
-   `--version`: Print version information
-   `--import_lbl <PATH>`: Import VICE labels from the specified file
-   `--export_lbl <PATH>`: Export labels to the specified file (after analysis/import)
-   `--export_asm <PATH>`: Export assembly to the specified file (after analysis/import)
-   `--headless`: Run in headless mode (no TUI), useful for batch processing
-   `--mcp-server`: Run MCP server (HTTP on port 3000)
-   `--mcp-server-stdio`: Run MCP server via stdio

Supported file formats: `.prg`, `.crt`, `.d64`, `.d71`, `.d81`, `.t64`, `.vsf`, `.bin`, `.raw`, and `.regen2000proj`.

## Keyboard Shortcuts

All the keyboad shortcuts are documented here: [keyboard_shorcuts](https://regenerator2000.readthedocs.io/en/latest/keyboard_shortcuts/)


## Support and Documentation

- [Documentation](http://regenerator2000.readthedocs.io/)
- [Support in Discord][discord] (join the #regenerator2000 channel, under "Misc Projects")

[discord]: https://discord.gg/r5aMn6Cw5q

## Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

## Acknowledgements

- [Regenerator][regenerator]: The original 6502 disassembler for Windows.
- [64tass][64tass], [ACME][ACME], [Kick Assembler][Kick Assembler], [ca65][ca65] : Supported assemblers.

[64tass]: https://tass64.sourceforge.net/
[ACME]: https://sourceforge.net/projects/acme-crossass/
[Kick Assembler]: http://www.theweb.dk/KickAssembler/
[ca65]: https://cc65.github.io/

## License

Dual license: MIT and Apache 2
