Skip to content

Commit e37be89

Browse files
fpscanfpscan
authored
Merge pull request #1000 from LLeny/holani-docs
Holani docs update
2 parents 093688e + 33f22ef commit e37be89

File tree

8 files changed

+140
-1
lines changed

8 files changed

+140
-1
lines changed

‎docs/development/licenses.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -129,6 +129,7 @@ See below for a summary of the licenses behind RetroArch and its cores:
129129
| [gpSP](../library/gpsp.md) | [GPLv2](https://github.com/libretro/gpsp/blob/master/COPYING) | |
130130
| [GW](../library/gw.md) | [zlib](https://github.com/libretro/gw-libretro/blob/master/LICENSE) | |
131131
| [Handy](../library/handy.md) | [zlib](https://github.com/libretro/libretro-handy/blob/master/lynx/license.txt) | |
132+
| [Holani](../library/holani.md) | [GPLv3](https://github.com/LLeny/holani-retro/blob/main/LICENSE) | |
132133
| [Hatari](../library/hatari.md) | [GPLv2](https://github.com/libretro/hatari/blob/master/readme.txt) | |
133134
| [higan Accuracy](../library/higan_accuracy.md) | [GPLv3](https://gitlab.com/higan/higan/blob/master/LICENSE.txt) | |
134135
| [Imageviewer](../library/imageviewer.md) | [MIT](https://github.com/libretro/RetroArch/blob/master/cores/libretro-imageviewer/LICENSE) | |

‎docs/guides/retroachievements.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,8 @@ You can also check the progress of your friends and add comments on their trophi
9696
| Core | Supported | Notes |
9797
|------------------------------------------------------------------|:---------:|:------|
9898
| [Beetle Lynx](https://github.com/libretro/beetle-lynx-libretro) | ✔ | |
99-
| [Handy](https://github.com/libretro/libretro-handy) | ✔ | Preferred core. |
99+
| [Handy](https://github.com/libretro/libretro-handy) | ✔ | |
100+
| [Holani](https://github.com/LLeny/holani-retro) | ✔ | |
100101

101102
### Bandai
102103

‎docs/library/beetle_lynx.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -152,3 +152,4 @@ Supported combinations
152152
#### Atari - Lynx
153153

154154
- [Atari - Lynx (Handy)](handy.md)
155+
- [Atari - Lynx (Holani)](holani.md)

‎docs/library/bios.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,7 @@ Gamecube/Wii | Dolphin | [BIOS information](dolphin.
6767
Intellivision | FreeIntv | [BIOS information](freeintv.md#bios)
6868
Lynx | Beetle Lynx | [BIOS information](beetle_lynx.md#bios)
6969
Lynx | Handy | [BIOS information](handy.md#bios)
70+
Lynx | Holani | [BIOS information](holani.md#bios)
7071
Master System | Emux SMS | [BIOS information](emux_sms.md#bios)
7172
MS/GG | SMS Plus GX | [BIOS information](smsplus.md#bios)
7273
MS/GG/MD/CD | Genesis Plus GX | [BIOS information](genesis_plus_gx.md#bios)

‎docs/library/handy.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -146,3 +146,4 @@ Supported combinations
146146
#### Atari - Lynx
147147

148148
- [Atari - Lynx (Beetle Lynx)](beetle_lynx.md)
149+
- [Atari - Lynx (Holani)](holani.md)

‎docs/library/holani.md

Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
# Atari - Lynx (Holani)
2+
3+
## Background
4+
5+
Holani is a cycle-stepped Atari Lynx video game system emulator that can be used as a libretro core. Holani's primary goal is to get closer to the Lynx hardware and provide a better emulation experience.
6+
7+
### Author/License
8+
9+
The Holani core has been authored by
10+
11+
- [LLeny](https://github.com/LLeny)
12+
13+
The Holani core is licensed under
14+
15+
- [GNU General Public License v3.0](https://github.com/LLeny/holani/blob/main/LICENSE)
16+
17+
A summary of the licenses behind RetroArch and its cores can be found [here](../development/licenses.md).
18+
19+
## Extensions
20+
21+
Content that can be loaded by the Holani core have the following file extensions:
22+
23+
- .lnx
24+
- .o
25+
26+
## Databases
27+
28+
RetroArch database(s) that are associated with the Holani core:
29+
30+
- [Atari - Lynx](https://github.com/libretro/libretro-database/blob/master/rdb/Atari%20-%20Lynx.rdb)
31+
32+
## BIOS
33+
34+
Optional firmware files go in the frontend's system directory.
35+
36+
| Filename | Description | md5sum |
37+
|:-------------:|:--------------------------:|:--------------------------------:|
38+
| lynxboot.img | Lynx Boot Image - Required | fcd403db69f54290b51035d82f835e7b |
39+
40+
## Features
41+
42+
Frontend-level settings or features that the Holani core respects.
43+
44+
| Feature | Supported |
45+
|-------------------|:---------:|
46+
| Restart | ✔ |
47+
| Screenshots | ✔ |
48+
| Saves | ✔ |
49+
| States | ✔ |
50+
| Rewind | ✔ |
51+
| Netplay (State based) | ✔ (not link-cable emulation) |
52+
| Core Options | ✔ |
53+
| RetroAchievements | ✔ |
54+
| Cheats (Cheats menu) | ✔ |
55+
| Native Cheats | ✕ |
56+
| Controls | ✔ |
57+
| Remapping | ✔ |
58+
| Multi-Mouse | ✕ |
59+
| Rumble | ✕ |
60+
| Sensors | ✕ |
61+
| Camera | ✕ |
62+
| Location | ✕ |
63+
| Subsystem | ✕ |
64+
| [Softpatching](../guides/softpatching.md) | ✕ |
65+
| Disk Control | ✕ |
66+
| Username | ✕ |
67+
| Language | ✕ |
68+
| Crop Overscan | ✕ |
69+
| LEDs | ✕ |
70+
71+
### Directories
72+
73+
The Holani core's directory name is 'Holani'
74+
75+
The Holani core saves/loads to/from these directories.
76+
77+
**Frontend's State directory**
78+
79+
- 'content-name'.state# (State)
80+
81+
### Geometry and timing
82+
83+
- The Holani core's core provided FPS is dynamic
84+
- The Holani core's core provided sample rate is 16,000 Hz
85+
86+
## Controllers
87+
88+
The Holani core supports the following device type(s) in the controls menu, bolded device types are the default for the specified user(s):
89+
90+
### User 1 device types
91+
92+
- None - Doesn't disable input.
93+
- **RetroPad** - Joypad
94+
- RetroPad w/Analog - Joypad - There's no reason to switch to this.
95+
96+
### Controller tables
97+
98+
#### Joypad
99+
100+
![](../image/controller/lynx.png)
101+
102+
| User 1 Remap descriptors | RetroPad Inputs |
103+
|--------------------------|---------------------------------------------|
104+
| B | ![](../image/retropad/retro_b.png) |
105+
| Pause | ![](../image/retropad/retro_start.png) |
106+
| D-Pad Up | ![](../image/retropad/retro_dpad_up.png) |
107+
| D-Pad Down | ![](../image/retropad/retro_dpad_down.png) |
108+
| D-Pad Left | ![](../image/retropad/retro_dpad_left.png) |
109+
| D-Pad Right | ![](../image/retropad/retro_dpad_right.png) |
110+
| A | ![](../image/retropad/retro_a.png) |
111+
| Option 1 | ![](../image/retropad/retro_l1.png) |
112+
| Option 2 | ![](../image/retropad/retro_r1.png) |
113+
114+
Supported combinations
115+
116+
- Option 1 + Pause = Restarts game
117+
- Option 2 + Pause = Flips Screen
118+
119+
## External Links
120+
121+
- [Official Holani Website](https://github.com/LLeny/holani-retro)
122+
- [Official Holani Downloads](https://github.com/LLeny/holani-retro/releases)
123+
- [Libretro Holani Core info file](https://github.com/libretro/libretro-super/blob/master/dist/info/holani_libretro.info)
124+
- [Libretro Holani Github Repository](https://github.com/LLeny/holani-retro)
125+
- [Report Libretro Holani Core Issues Here](https://github.com/LLeny/holani-retro/issues)
126+
127+
### See also
128+
129+
#### Atari - Lynx
130+
131+
- [Atari - Lynx (Beetle Lynx)](beetle_lynx.md)
132+
- [Atari - Lynx (Handy)](handy.md)

‎docs/meta/see-also.md

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

5353
- [Atari - Lynx (Beetle Lynx)](../library/beetle_lynx.md)
5454
- [Atari - Lynx (Handy)](../library/handy.md)
55+
- [Atari - Lynx (Holani)](../library/holani.md)
5556

5657
## MSX
5758

‎mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,6 +133,7 @@ nav:
133133
- 'Atari - Jaguar (Virtual Jaguar)': 'library/virtual_jaguar.md'
134134
- 'Atari - Lynx (Beetle Lynx)': 'library/beetle_lynx.md'
135135
- 'Atari - Lynx (Handy)': 'library/handy.md'
136+
- 'Atari - Lynx (Holani)': 'library/holani.md'
136137
- 'Atari - ST/STE/TT/Falcon (Hatari)': 'library/hatari.md'
137138
- 'Bandai Emulation':
138139
- 'Bandai - WonderSwan/Color (Beetle Cygne)': 'library/beetle_cygne.md'

0 commit comments

Comments
 (0)