https://github.com/drhelius/gearlynx
Atari Lynx emulator and debugger for macOS, Windows, Linux, BSD and RetroArch.
https://github.com/drhelius/gearlynx
atari bsd emulator libretro linux lynx macos raspberry-pi raspberrypi
Last synced: 16 days ago
JSON representation
Atari Lynx emulator and debugger for macOS, Windows, Linux, BSD and RetroArch.
- Host: GitHub
- URL: https://github.com/drhelius/gearlynx
- Owner: drhelius
- License: gpl-3.0
- Created: 2025-01-24T09:23:13.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-10-04T10:16:57.000Z (6 months ago)
- Last Synced: 2025-10-04T12:14:56.268Z (6 months ago)
- Topics: atari, bsd, emulator, libretro, linux, lynx, macos, raspberry-pi, raspberrypi
- Language: C
- Homepage: https://x.com/drhelius
- Size: 10.3 MB
- Stars: 20
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Gearlynx
[](https://github.com/drhelius/Gearlynx/actions/workflows/gearlynx.yml)
[](https://github.com/drhelius/Gearlynx/releases)
[](https://github.com/drhelius/Gearlynx/commits/main)
[](https://github.com/drhelius/Gearlynx/graphs/contributors)
[](https://github.com/sponsors/drhelius)
[](https://github.com/drhelius/Gearlynx/blob/main/LICENSE)
[](https://x.com/drhelius)
Gearlynx is a cross-platform Atari Lynx emulator written in C++ that runs on Windows, macOS, Linux, BSD and RetroArch.
This is an open source project with its ongoing development made possible thanks to the support by these awesome [backers](backers.md). If you find it useful, please consider [sponsoring](https://github.com/sponsors/drhelius).
Don't hesitate to report bugs or ask for new features by [opening an issue](https://github.com/drhelius/Gearlynx/issues).
## Downloads
- **Dev Builds**: [GitHub Actions](https://github.com/drhelius/Gearlynx/actions/workflows/gearlynx.yml)
## Features
- Very accurate 65C02 core.
- Compressed rom support (lnx, lyx, and zip).
- Configurable low-pass audio filter.
- Internal database for automatic rom detection and hardware selection if `Auto` options are selected.
- Supported platforms (standalone): Windows, Linux, BSD and macOS.
- Supported platforms (libretro): Windows, Linux, macOS, Raspberry Pi, Android, iOS, tvOS, PlayStation Vita, PlayStation 3, Nintendo 3DS, Nintendo GameCube, Nintendo Wii, Nintendo WiiU, Nintendo Switch, Emscripten, Classic Mini systems (NES, SNES, C64, ...), OpenDingux, RetroFW and QNX.
- Full debugger with just-in-time disassembler that can handle self-modifying code, CPU breakpoints, memory access breakpoints, code navigation (goto address, JP JR and JSR double clicking), debug symbols, automatic labels, memory editor, Suzy and Mikey register viewer, audio inspector and framebuffer preview.
- Windows and Linux *Portable Mode*.
- ROM loading from the command line by adding the ROM path as an argument.
- ROM loading using drag & drop.
- Support for modern game controllers through [gamecontrollerdb.txt](https://github.com/mdqinc/SDL_GameControllerDB) file located in the same directory as the application binary.
## Tips
### Basic Usage
- **BIOS**: Gearlynx requires a BIOS to work. It is possible to load any BIOS but the original with md5 ```fcd403db69f54290b51035d82f835e7b``` is recommended.
- **Portable Mode**: Create an empty file named `portable.ini` in the same directory as the application binary to enable portable mode.
### Debugging Features
- **Docking Windows**: In debug mode, you can dock windows together by pressing SHIFT and dragging a window onto another.
- **Multi-viewport**: In Windows or macOS, you can enable "multi-viewport" in the debug menu. You must restart the emulator for the change to take effect. Once enabled, you can drag debugger windows outside the main window.
- **Debug Symbols**: The emulator automatically tries to load a symbol (.sym) file when loading a ROM. For example, for ```path_to_rom_file.rom``` it tries to load ```path_to_rom_file.sym```. You can also load symbol files using the GUI or the CLI. It supports *cc65* (VICE label file), *lyxass* (EQU) and *mads* (lab and hea) file formats.
### Command Line Usage
```
gearlynx [options] [rom_file] [symbol_file]
Options:
-f, --fullscreen Start in fullscreen mode
-w, --windowed Start in windowed mode with menu visible
-v, --version Display version information
-h, --help Display this help message
```
## Build Instructions
### Windows
- Install Microsoft Visual Studio Community 2022 or later.
- Open the Gearlynx Visual Studio solution `platforms/windows/Gearlynx.sln` and build.
### macOS
- Install Xcode and run `xcode-select --install` in the terminal for the compiler to be available on the command line.
- Run these commands to generate a Mac *app* bundle:
``` shell
brew install sdl2
cd platforms/macos
make dist
```
### Linux
- Ubuntu / Debian / Raspberry Pi (Raspbian):
``` shell
sudo apt install build-essential libsdl2-dev libgtk-3-dev
cd platforms/linux
make
```
- Fedora:
``` shell
sudo dnf install @development-tools gcc-c++ SDL2-devel gtk3-devel
cd platforms/linux
make
```
- Arch Linux:
``` shell
sudo pacman -S base-devel sdl2 gtk3
cd platforms/linux
make
```
### BSD
- FreeBSD:
``` shell
su root -c "pkg install -y git gmake pkgconf SDL2 lang/gcc gtk3"
cd platforms/bsd
gmake
```
- NetBSD:
``` shell
su root -c "pkgin install gmake pkgconf SDL2 lang/gcc gtk3"
cd platforms/bsd
gmake
```
### Libretro
- Ubuntu / Debian / Raspberry Pi (Raspbian):
``` shell
sudo apt install build-essential
cd platforms/libretro
make
```
- Fedora:
``` shell
sudo dnf install @development-tools gcc-c++
cd platforms/libretro
make
```
## Contributors
Thank you to all the people who have already contributed to Gearlynx!
[](https://github.com/drhelius/gearlynx/graphs/contributors)
## License
Gearlynx is licensed under the GNU General Public License v3.0 License, see [LICENSE](LICENSE) for more information.