Skip to content

Commit 5b25432

Browse files
drheliusdrhelius
committed
Update readme
1 parent 3167d41 commit 5b25432

File tree

1 file changed

+139
-9
lines changed

1 file changed

+139
-9
lines changed

‎platforms/shared/README.txt‎

Lines changed: 139 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,147 @@
1-
.:: Gearlynx ::.
1+
____ _
2+
/ ___| ___ __ _ _ __| |_ _ _ __ __ __
3+
| | _ / _ \/ _` | '__| | | | | '_ \\ \/ /
4+
| |_| | __/ (_| | | | | |_| | | | |> <
5+
\____|\___|\__,_|_| |_|\__, |_| |_/_/\_\
6+
|___/
7+
28
-----------------------------------------------------
3-
Instructions and tips at:
4-
https://github.com/drhelius/Gearlynx
9+
10+
Gearlynx is a very accurate cross-platform Atari Lynx emulator written in C++
11+
that runs on Windows, macOS, Linux, BSD and RetroArch, with an embedded MCP
12+
server for debugging and tooling.
13+
14+
This is an open source project with its ongoing development made possible
15+
thanks to the support by awesome backers. If you find it useful, please
16+
consider sponsoring at https://github.com/sponsors/drhelius
17+
18+
Instructions and tips at: https://github.com/drhelius/Gearlynx
19+
Follow me on Twitter for updates: http://twitter.com/drhelius
20+
521
-----------------------------------------------------
6-
Gearlynx is in development.
7-
Please, consider sponsoring (https://github.com/sponsors/drhelius) and following me on Twitter (http://twitter.com/drhelius) for updates.
22+
Downloads:
23+
-----------------------------------------------------
24+
25+
Latest release: https://github.com/drhelius/Gearlynx/releases
26+
27+
Windows:
28+
- Desktop x64 and ARM64
29+
- MCPB x64 and ARM64
30+
- May need Visual C++ Redistributable and OpenGL Compatibility Pack
31+
32+
macOS:
33+
- Homebrew: brew install --cask drhelius/geardome/gearlynx
34+
- Desktop Apple Silicon and Intel
35+
- MCPB x64 and ARM64
36+
37+
Linux:
38+
- Desktop Ubuntu 24.04 and 22.04 (x64 and ARM64)
39+
- MCPB x64 and ARM64
40+
- May need libsdl3
41+
42+
RetroArch:
43+
- Libretro core available for all platforms
44+
- Documentation: https://docs.libretro.com/library/gearlynx/
45+
46+
Dev Builds:
47+
- GitHub Actions: https://github.com/drhelius/Gearlynx/actions/workflows/gearlynx.yml
48+
849
-----------------------------------------------------
950
Features:
51+
-----------------------------------------------------
52+
53+
- Very accurate emulation supporting the entire commercial Atari Lynx catalog
54+
and most homebrew and demos
55+
- User selectable Lynx I or Lynx II emulation
56+
- Compressed and homebrew rom support (lnx, lyx, o, and zip)
57+
- Save states with preview
58+
- Very accurate audio emulation with configurable low-pass filter (mimics
59+
original Lynx audio hardware)
60+
- VGM recorder
61+
- Internal database for automatic rom detection and hardware selection if
62+
Auto options are selected
63+
- Bank switching (BANK1 + AUDIN) and EEPROM
64+
- Save files (EEPROM and NVRAM)
65+
- Supported platforms (standalone): Windows, Linux, BSD and macOS
66+
- Supported platforms (libretro): Windows, Linux, macOS, Raspberry Pi, Android,
67+
iOS, tvOS, PlayStation Vita, PlayStation 3, Nintendo 3DS, Nintendo GameCube,
68+
Nintendo Wii, Nintendo WiiU, Nintendo Switch, Emscripten, Classic Mini systems
69+
(NES, SNES, C64, ...), OpenDingux, RetroFW and QNX
70+
- Full debugger with just-in-time run-ahead disassembler that can handle
71+
self-modifying code, CPU and memory breakpoints, code navigation (goto address,
72+
JP JR and JSR double clicking), debug symbols, automatic labels, memory editor,
73+
memory search, Suzy and Mikey register viewer, audio channels, UART, cartridge
74+
and video inspector
75+
- MCP server for AI-assisted debugging with GitHub Copilot, Claude, ChatGPT and
76+
similar, exposing tools for execution control, memory inspection, hardware
77+
status, and more
78+
- Windows and Linux Portable Mode
79+
- ROM loading from the command line by adding the ROM path as an argument
80+
- ROM loading using drag & drop
81+
- Support for modern game controllers through gamecontrollerdb.txt file located
82+
in the same directory as the application binary
1083

1184
-----------------------------------------------------
12-
Gearlynx is licensed under the GNU General Public License v3.0 License:
85+
Tips:
86+
-----------------------------------------------------
87+
88+
Basic Usage:
89+
- BIOS: Gearlynx requires a BIOS to work. It is possible to load any BIOS but
90+
the original with md5 fcd403db69f54290b51035d82f835e7b is recommended
91+
- Mouse Cursor: Automatically hides when hovering over the main output window
92+
or when Main Menu is disabled
93+
- Portable Mode: Create an empty file named portable.ini in the same directory
94+
as the application binary to enable portable mode
95+
96+
Debugging Features:
97+
- Docking Windows: In debug mode, you can dock windows together by pressing
98+
SHIFT and dragging a window onto another
99+
- Multi-viewport: In Windows or macOS, you can enable "multi-viewport" in the
100+
debug menu. You must restart the emulator for the change to take effect.
101+
Once enabled, you can drag debugger windows outside the main window
102+
- Debug Symbols: The emulator automatically tries to load a symbol (.sym) file
103+
when loading a ROM. It supports cc65 (VICE label file), lyxass (EQU) and
104+
mads (lab and hea) file formats
105+
106+
MCP Server:
107+
- Gearlynx includes a Model Context Protocol (MCP) server that enables
108+
AI-assisted debugging through AI agents like GitHub Copilot, Claude, ChatGPT
109+
and similar. The server provides tools for execution control, memory
110+
inspection, breakpoints, disassembly, hardware status, sprite viewing, and
111+
more. See MCP_README.md for complete setup instructions
112+
113+
Command Line Usage:
114+
gearlynx [options] [game_file] [symbol_file]
115+
116+
Arguments:
117+
[game_file] Game file: accepts ROMs (.pce, .sgx, .hes),
118+
CUE (.cue) or ZIP (.zip)
119+
[symbol_file] Optional symbol file for debugging
120+
121+
Options:
122+
-f, --fullscreen Start in fullscreen mode
123+
-w, --windowed Start in windowed mode with menu visible
124+
--mcp-stdio Auto-start MCP server with stdio transport
125+
--mcp-http Auto-start MCP server with HTTP transport
126+
--mcp-http-port N HTTP port for MCP server (default: 7777)
127+
-v, --version Display version information
128+
-h, --help Display this help message
129+
130+
-----------------------------------------------------
131+
License:
132+
-----------------------------------------------------
133+
134+
Gearlynx is licensed under the GNU General Public License v3.0 License.
13135

14136
Copyright (C) 2024 Ignacio Sanchez
15-
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or any later version.
16-
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
17-
You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/
137+
138+
This program is free software: you can redistribute it and/or modify it under
139+
the terms of the GNU General Public License as published by the Free Software
140+
Foundation, either version 3 of the License, or any later version.
141+
142+
This program is distributed in the hope that it will be useful, but WITHOUT
143+
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
144+
FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
145+
146+
You should have received a copy of the GNU General Public License along with
147+
this program. If not, see http://www.gnu.org/licenses/

0 commit comments

Comments
 (0)