Skip to content

Commit 1759be2

Browse files
fpscanfpscan
authored
Merge pull request #1113 from drhelius/gearlynx
Add Gearlynx core docs
2 parents cadf9c1 + 6d4099e commit 1759be2

6 files changed

Lines changed: 202 additions & 0 deletions

File tree

‎docs/development/licenses.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,7 @@ See below for a summary of the licenses behind RetroArch and its cores:
128128
| [Gearboy](../library/gearboy.md) | [GPLv3](https://github.com/drhelius/Gearboy/blob/master/LICENSE) | |
129129
| [Gearcoleco](../library/gearcoleco.md) | [GPLv3](https://github.com/drhelius/Gearcoleco/blob/master/LICENSE) | |
130130
| [Geargrafx](../library/geargrafx.md) | [GPLv3](https://github.com/drhelius/Geargrafx/blob/master/LICENSE) | |
131+
| [Gearlynx](../library/gearlynx.md) | [GPLv3](https://github.com/drhelius/Gearlynx/blob/master/LICENSE) | |
131132
| [Gearsystem](../library/gearsystem.md) | [GPLv3](https://github.com/drhelius/Gearsystem/blob/master/LICENSE) | |
132133
| [Genesis Plus GX](../library/genesis_plus_gx.md) | [Non-commercial](https://github.com/libretro/Genesis-Plus-GX/blob/master/LICENSE.txt) | Non-commercial |
133134
| [Geolith](../library/geolith.md) | [BSD-3-Clause, MIT](https://github.com/libretro/geolith-libretro/blob/master/LICENSE) | |

‎docs/guides/core-list.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,7 @@
100100
| [Gearboy](../library/gearboy.md) | Game Boy/Color | |
101101
| [Gearcoleco](../library/gearcoleco.md) | Coleco ColecoVision | |
102102
| [Geargrafx](../library/geargrafx.md) | NEC PC Engine/SuperGrafx | |
103+
| [Gearlynx](../library/gearlynx.md) | Atari Lynx | |
103104
| [Gearsystem](../library/gearsystem.md) | Sega MS/GG/SG-1000 | |
104105
| Genesis Plus GX | Sega MS/GG/MD/CD | |
105106
| [Geolith](../library/geolith.md) | SNK Neo Geo AES/MVS | Highly accurate emulator for the Neo Geo AES and MVS Cartridge Systems |

‎docs/guides/memorymonitoring.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,12 @@ To be clear: the cores listed on this page support libretro's memory monitoring
3333

3434
### Atari
3535

36+
#### Lynx
37+
38+
| Core | Supported | Notes |
39+
|--------------------------------------------------|:---------:|:------|
40+
| [Gearlynx](https://github.com/drhelius/Gearlynx) | ✔ | |
41+
3642
#### 2600
3743

3844
| Core | Supported | Notes |

‎docs/library/gearlynx.md‎

Lines changed: 192 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,192 @@
1+
# Atari - Lynx (Gearlynx)
2+
3+
## Background
4+
5+
Gearlynx is an open source, cross-platform, Atari Lynx emulator written in C++.
6+
7+
- Very accurate emulation supporting the entire commercial Atari Lynx catalog.
8+
- Configurable low-pass audio filter.
9+
- Internal database for automatic rom detection and hardware selection if `Auto` options are selected.
10+
- 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.
11+
12+
The Gearlynx core has been authored by:
13+
14+
- [Nacho Sanchez (drhelius)](https://github.com/drhelius)
15+
16+
The Gearlynx core is licensed under:
17+
18+
- [GPLv3](https://github.com/drhelius/Gearlynx/blob/main/LICENSE)
19+
20+
A summary of the licenses behind RetroArch and its cores can be found [here](../development/licenses.md).
21+
22+
## BIOS
23+
24+
Gearlynx requires a BIOS to work.
25+
26+
Required firmware files go in the frontend's system directory.
27+
28+
!!! attention
29+
The Lynx boot ROM file is required for Gearlynx to function.
30+
31+
| Filename | Description | md5sum |
32+
|:------------:|:----------------------------:|:--------------------------------:|
33+
| lynxboot.img | Lynx Boot Image - Required | fcd403db69f54290b51035d82f835e7b |
34+
35+
## Extensions
36+
37+
Content that can be loaded by the Gearlynx core have the following file extensions:
38+
39+
- .lnx
40+
- .lyx
41+
- .o
42+
43+
RetroArch database(s) that are associated with the Gearlynx core:
44+
45+
- [Atari - Lynx](https://github.com/libretro/libretro-database/blob/master/rdb/Atari%20-%20Lynx.rdb)
46+
47+
## Features
48+
49+
Frontend-level settings or features that the Gearlynx core respects.
50+
51+
| Feature | Supported |
52+
|-------------------|:---------:|
53+
| Restart | ✔ |
54+
| Screenshots | ✔ |
55+
| Saves | ✕ |
56+
| States | ✔ |
57+
| Rewind | ✔ |
58+
| Netplay | ✔ |
59+
| Core Options | ✔ |
60+
| [Memory Monitoring (achievements)](../guides/memorymonitoring.md) | ✔ |
61+
| RetroArch Cheats | ✕ |
62+
| Native Cheats | ✕ |
63+
| Controls | ✔ |
64+
| Remapping | ✔ |
65+
| Multi-Mouse | ✕ |
66+
| Rumble | ✕ |
67+
| Sensors | ✕ |
68+
| Camera | ✕ |
69+
| Location | ✕ |
70+
| Subsystem | ✕ |
71+
| [Softpatching](../guides/softpatching.md) | ✔ |
72+
| Disk Control | ✕ |
73+
| Username | ✕ |
74+
| Language | ✕ |
75+
| Crop Overscan | ✕ |
76+
| LEDs | ✕ |
77+
78+
### Directories
79+
80+
The Gearlynx core's library name is 'Gearlynx'
81+
82+
The Gearlynx core saves/loads to/from these directories.
83+
84+
**Frontend's State directory**
85+
86+
| File | Description |
87+
|:--------:|:-----------:|
88+
| *.state# | State |
89+
90+
### Geometry and timing
91+
92+
- The Gearlynx core's core provided FPS is variable from 50 to 75
93+
- The Gearlynx core's core provided sample rate is 44100 Hz
94+
- The Gearlynx core's base width is 160
95+
- The Gearlynx core's base height is 102
96+
- The Gearlynx core's max width is 160
97+
- The Gearlynx core's max height is 102
98+
- The Gearlynx core's provided aspect ratio is dependent on the ['Aspect Ratio' core option](#core-options).
99+
100+
## Core options
101+
102+
The Gearlynx core has the following options that can be tweaked from the core options menu. The default setting is bolded.
103+
104+
Settings with (restart) means that core has to be closed for the new setting to be applied on next launch.
105+
106+
- **Aspect Ratio** [gearlynx_aspect_ratio] (**1:1 PAR**|4:3 DAR|16:9 DAR|16:10 DAR)
107+
108+
Select which aspect ratio will be presented by the core.
109+
110+
- *1:1 PAR* selects an aspect ratio that produces square pixels.
111+
- *4:3 DAR* forces 4:3 aspect ratio.
112+
- *16:9 DAR* forces 16:9 aspect ratio.
113+
- *16:10 DAR* forces 16:10 aspect ratio.
114+
115+
- **Screen Rotation** [gearlynx_rotation] (**Auto**|Left|Right)
116+
117+
Rotates the screen display. This is useful since many Lynx games were designed to be played with the system held vertically.
118+
119+
- *Auto* automatically rotates based on the game.
120+
- *Left* rotates the screen 90 degrees counter-clockwise.
121+
- *Right* rotates the screen 90 degrees clockwise.
122+
- *Disabled* forces the screen to remain in standard horizontal orientation.
123+
124+
- **Console Type** [gearlynx_console_type] (**Auto**|Lynx I|Lynx II)
125+
126+
Select the Atari Lynx console model to emulate.
127+
128+
- *Auto* automatically selects the appropriate console type based on the game.
129+
- *Lynx I* forces emulation of the original Lynx model.
130+
- *Lynx II* forces emulation of the Lynx II model.
131+
132+
- **Audio Low-Pass Filter (Hz)** [gearlynx_lowpass_filter] (**3500**|500|1000|1500|2000|2500|3000|3500|4000|4500|5000)
133+
134+
Configures a low-pass audio filter to reduce high-frequency noise.
135+
136+
- **Audio Channel 0 Volume** [gearlynx_audio_ch0_volume] (**100**|0-200)
137+
138+
Sets the volume level for audio channel 0 (percentage).
139+
140+
- **Audio Channel 1 Volume** [gearlynx_audio_ch1_volume] (**100**|0-200)
141+
142+
Sets the volume level for audio channel 1 (percentage).
143+
144+
- **Audio Channel 2 Volume** [gearlynx_audio_ch2_volume] (**100**|0-200)
145+
146+
Sets the volume level for audio channel 2 (percentage).
147+
148+
- **Audio Channel 3 Volume** [gearlynx_audio_ch3_volume] (**100**|0-200)
149+
150+
Sets the volume level for audio channel 3 (percentage).
151+
152+
- **Allow Up+Down / Left+Right** [gearlynx_up_down_allowed] (**Disabled**|Enabled)
153+
154+
Enabling this option allows pressing, quickly alternating, or holding both left and right (or up and down) directions at the same time.
155+
156+
This may cause movement based glitches to occur in certain games.
157+
158+
It's best to keep this core option disabled.
159+
160+
## Joypad
161+
162+
![](../image/controller/lynx.png)
163+
164+
| User 1 input descriptors | RetroPad Inputs |
165+
|--------------------------|---------------------------------------------|
166+
| B | ![](../image/retropad/retro_b.png) |
167+
| Pause | ![](../image/retropad/retro_start.png) |
168+
| Up | ![](../image/retropad/retro_dpad_up.png) |
169+
| Down | ![](../image/retropad/retro_dpad_down.png) |
170+
| Left | ![](../image/retropad/retro_dpad_left.png) |
171+
| Right | ![](../image/retropad/retro_dpad_right.png) |
172+
| A | ![](../image/retropad/retro_a.png) |
173+
| Option 1 | ![](../image/retropad/retro_l1.png) |
174+
| Option 2 | ![](../image/retropad/retro_r1.png) |
175+
176+
## Compatibility
177+
178+
- [Gearlynx Hardware Tests](https://github.com/drhelius/lynx-tests)
179+
180+
## External Links
181+
182+
- [Official Gearlynx Github Repository](https://github.com/drhelius/Gearlynx)
183+
- [Libretro Gearlynx Core info file](https://github.com/libretro/libretro-super/blob/master/dist/info/gearlynx_libretro.info)
184+
- [Report Libretro Gearlynx Core Issues Here](https://github.com/drhelius/Gearlynx/issues)
185+
186+
### See also
187+
188+
#### Atari - Lynx
189+
190+
- [Atari - Lynx (Beetle Lynx)](beetle_lynx.md)
191+
- [Atari - Lynx (Handy)](handy.md)
192+
- [Atari - Lynx (Holani)](holani.md)

‎docs/meta/see-also.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ This is a list of cores that are related to each other in some way.
5353
## Lynx
5454

5555
- [Atari - Lynx (Beetle Lynx)](../library/beetle_lynx.md)
56+
- [Atari - Lynx (Gearlynx)](../library/gearlynx.md)
5657
- [Atari - Lynx (Handy)](../library/handy.md)
5758
- [Atari - Lynx (Holani)](../library/holani.md)
5859

‎mkdocs.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -135,6 +135,7 @@ nav:
135135
- 'Atari - 5200 (Atari800)': 'library/atari800.md'
136136
- 'Atari - Jaguar (Virtual Jaguar)': 'library/virtual_jaguar.md'
137137
- 'Atari - Lynx (Beetle Lynx)': 'library/beetle_lynx.md'
138+
- 'Atari - Lynx (Gearlynx)': 'library/gearlynx.md'
138139
- 'Atari - Lynx (Handy)': 'library/handy.md'
139140
- 'Atari - Lynx (Holani)': 'library/holani.md'
140141
- 'Atari - ST/STE/TT/Falcon (Hatari)': 'library/hatari.md'

0 commit comments

Comments
 (0)