Skip to content

Commit

Permalink
Update licenses.md, retroachievements.md, beetle_lynx.md, and 5 more …
Browse files Browse the repository at this point in the history
…files
  • Loading branch information
LLeny committed Nov 11, 2024
1 parent 093688e commit 33f22ef
Show file tree
Hide file tree
Showing 8 changed files with 140 additions and 1 deletion.
1 change: 1 addition & 0 deletions docs/development/licenses.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,7 @@ See below for a summary of the licenses behind RetroArch and its cores:
| [gpSP](../library/gpsp.md) | [GPLv2](https://github.com/libretro/gpsp/blob/master/COPYING) | |
| [GW](../library/gw.md) | [zlib](https://github.com/libretro/gw-libretro/blob/master/LICENSE) | |
| [Handy](../library/handy.md) | [zlib](https://github.com/libretro/libretro-handy/blob/master/lynx/license.txt) | |
| [Holani](../library/holani.md) | [GPLv3](https://github.com/LLeny/holani-retro/blob/main/LICENSE) | |
| [Hatari](../library/hatari.md) | [GPLv2](https://github.com/libretro/hatari/blob/master/readme.txt) | |
| [higan Accuracy](../library/higan_accuracy.md) | [GPLv3](https://gitlab.com/higan/higan/blob/master/LICENSE.txt) | |
| [Imageviewer](../library/imageviewer.md) | [MIT](https://github.com/libretro/RetroArch/blob/master/cores/libretro-imageviewer/LICENSE) | |
Expand Down
3 changes: 2 additions & 1 deletion docs/guides/retroachievements.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,8 @@ You can also check the progress of your friends and add comments on their trophi
| Core | Supported | Notes |
|------------------------------------------------------------------|:---------:|:------|
| [Beetle Lynx](https://github.com/libretro/beetle-lynx-libretro) || |
| [Handy](https://github.com/libretro/libretro-handy) || Preferred core. |
| [Handy](https://github.com/libretro/libretro-handy) || |
| [Holani](https://github.com/LLeny/holani-retro) || |

### Bandai

Expand Down
1 change: 1 addition & 0 deletions docs/library/beetle_lynx.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,3 +152,4 @@ Supported combinations
#### Atari - Lynx

- [Atari - Lynx (Handy)](handy.md)
- [Atari - Lynx (Holani)](holani.md)
1 change: 1 addition & 0 deletions docs/library/bios.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ Gamecube/Wii | Dolphin | [BIOS information](dolphin.
Intellivision | FreeIntv | [BIOS information](freeintv.md#bios)
Lynx | Beetle Lynx | [BIOS information](beetle_lynx.md#bios)
Lynx | Handy | [BIOS information](handy.md#bios)
Lynx | Holani | [BIOS information](holani.md#bios)
Master System | Emux SMS | [BIOS information](emux_sms.md#bios)
MS/GG | SMS Plus GX | [BIOS information](smsplus.md#bios)
MS/GG/MD/CD | Genesis Plus GX | [BIOS information](genesis_plus_gx.md#bios)
Expand Down
1 change: 1 addition & 0 deletions docs/library/handy.md
Original file line number Diff line number Diff line change
Expand Up @@ -146,3 +146,4 @@ Supported combinations
#### Atari - Lynx

- [Atari - Lynx (Beetle Lynx)](beetle_lynx.md)
- [Atari - Lynx (Holani)](holani.md)
132 changes: 132 additions & 0 deletions docs/library/holani.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,132 @@
# Atari - Lynx (Holani)

## Background

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.

### Author/License

The Holani core has been authored by

- [LLeny](https://github.com/LLeny)

The Holani core is licensed under

- [GNU General Public License v3.0](https://github.com/LLeny/holani/blob/main/LICENSE)

A summary of the licenses behind RetroArch and its cores can be found [here](../development/licenses.md).

## Extensions

Content that can be loaded by the Holani core have the following file extensions:

- .lnx
- .o

## Databases

RetroArch database(s) that are associated with the Holani core:

- [Atari - Lynx](https://github.com/libretro/libretro-database/blob/master/rdb/Atari%20-%20Lynx.rdb)

## BIOS

Optional firmware files go in the frontend's system directory.

| Filename | Description | md5sum |
|:-------------:|:--------------------------:|:--------------------------------:|
| lynxboot.img | Lynx Boot Image - Required | fcd403db69f54290b51035d82f835e7b |

## Features

Frontend-level settings or features that the Holani core respects.

| Feature | Supported |
|-------------------|:---------:|
| Restart ||
| Screenshots ||
| Saves ||
| States ||
| Rewind ||
| Netplay (State based) | ✔ (not link-cable emulation) |
| Core Options ||
| RetroAchievements ||
| Cheats (Cheats menu) ||
| Native Cheats ||
| Controls ||
| Remapping ||
| Multi-Mouse ||
| Rumble ||
| Sensors ||
| Camera ||
| Location ||
| Subsystem ||
| [Softpatching](../guides/softpatching.md) ||
| Disk Control ||
| Username ||
| Language ||
| Crop Overscan ||
| LEDs ||

### Directories

The Holani core's directory name is 'Holani'

The Holani core saves/loads to/from these directories.

**Frontend's State directory**

- 'content-name'.state# (State)

### Geometry and timing

- The Holani core's core provided FPS is dynamic
- The Holani core's core provided sample rate is 16,000 Hz

## Controllers

The Holani core supports the following device type(s) in the controls menu, bolded device types are the default for the specified user(s):

### User 1 device types

- None - Doesn't disable input.
- **RetroPad** - Joypad
- RetroPad w/Analog - Joypad - There's no reason to switch to this.

### Controller tables

#### Joypad

![](../image/controller/lynx.png)

| User 1 Remap descriptors | RetroPad Inputs |
|--------------------------|---------------------------------------------|
| B | ![](../image/retropad/retro_b.png) |
| Pause | ![](../image/retropad/retro_start.png) |
| D-Pad Up | ![](../image/retropad/retro_dpad_up.png) |
| D-Pad Down | ![](../image/retropad/retro_dpad_down.png) |
| D-Pad Left | ![](../image/retropad/retro_dpad_left.png) |
| D-Pad Right | ![](../image/retropad/retro_dpad_right.png) |
| A | ![](../image/retropad/retro_a.png) |
| Option 1 | ![](../image/retropad/retro_l1.png) |
| Option 2 | ![](../image/retropad/retro_r1.png) |

Supported combinations

- Option 1 + Pause = Restarts game
- Option 2 + Pause = Flips Screen

## External Links

- [Official Holani Website](https://github.com/LLeny/holani-retro)
- [Official Holani Downloads](https://github.com/LLeny/holani-retro/releases)
- [Libretro Holani Core info file](https://github.com/libretro/libretro-super/blob/master/dist/info/holani_libretro.info)
- [Libretro Holani Github Repository](https://github.com/LLeny/holani-retro)
- [Report Libretro Holani Core Issues Here](https://github.com/LLeny/holani-retro/issues)

### See also

#### Atari - Lynx

- [Atari - Lynx (Beetle Lynx)](beetle_lynx.md)
- [Atari - Lynx (Handy)](handy.md)
1 change: 1 addition & 0 deletions docs/meta/see-also.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ This is a list of cores that are related to each other in some way.

- [Atari - Lynx (Beetle Lynx)](../library/beetle_lynx.md)
- [Atari - Lynx (Handy)](../library/handy.md)
- [Atari - Lynx (Holani)](../library/holani.md)

## MSX

Expand Down
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,7 @@ nav:
- 'Atari - Jaguar (Virtual Jaguar)': 'library/virtual_jaguar.md'
- 'Atari - Lynx (Beetle Lynx)': 'library/beetle_lynx.md'
- 'Atari - Lynx (Handy)': 'library/handy.md'
- 'Atari - Lynx (Holani)': 'library/holani.md'
- 'Atari - ST/STE/TT/Falcon (Hatari)': 'library/hatari.md'
- 'Bandai Emulation':
- 'Bandai - WonderSwan/Color (Beetle Cygne)': 'library/beetle_cygne.md'
Expand Down

0 comments on commit 33f22ef

Please sign in to comment.