Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor: ES-DE Name Wrong #1061

Closed
wants to merge 29 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -236,8 +236,7 @@ Advanced usage:

{adam} The ROM's emulator-specific /ROMS/* directory for the 'Adam' image (e.g. "GB")
{batocera} The ROM's emulator-specific /roms/* directory for Batocera (e.g. "gb")
{es} The ROM's emulator-specific /roms/* directory for the 'EmulationStation' image (
e.g. "gb")
{esde} The ROM's emulator-specific /roms/* directory for the 'ES-DE' image (e.g. "gb")
{funkeyos} The ROM's emulator-specific /* directory for FunKey OS (e.g. "Game Boy")
{jelos} The ROM's emulator-specific /roms/* directory for JELOS (e.g. "gb")
{minui} The ROM's emulator-specific /Roms/* directory for MinUI (e.g. "Game Boy (GB)")
Expand Down
2 changes: 1 addition & 1 deletion docs/output/tokens.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ To help sort ROMs into unique file structures for popular frontends & hardware,

- `{adam}` the ['Adam' image](../usage/handheld/adam.md) emulator's directory for the ROM
- `{batocera}` the [Batocera](../usage/desktop/batocera.md) emulator's directory for the ROM
- `{es}` the [EmulationStation](../usage/desktop/emulationstation.md) emulator's directory for the ROM
- `{esde}` the [ES-DE](../usage/desktop/esde.md) emulator's directory for the ROM
- `{funkeyos}` the [FunKey OS](../usage/handheld/funkeyos.md) emulator's directory for the ROM
- `{minui}` the [MinUI](../usage/handheld/minui.md) emulator's directory for the ROM
- `{miyoocfw}` the [MiyooCFW](../usage/handheld/miyoocfw.md) emulator's directory for the ROM
Expand Down
2 changes: 1 addition & 1 deletion docs/usage/arcade.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Here is a chart of instructions for various setups:

| Emulator | How to get DATs | Alternatives |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Frontends ([Batocera](desktop/batocera.md), [EmulationStation](desktop/emulationstation.md), [Lakka](desktop/lakka.md), [Recalbox](desktop/recalbox.md), [RetroArch](desktop/retroarch.md), [RetroPie](desktop/retropie.md), etc.) | Each frontend's documentation should have instructions or links to download the appropriate DAT(s). For example, [RetroArch's arcade docs](https://docs.libretro.com/guides/arcade-getting-started/#step-3-use-the-correct-version-romsets-for-that-emulator) links to the exact DAT needed for each arcade core. | N/A |
| Frontends ([Batocera](desktop/batocera.md), [ES-DE](desktop/esde.md), [Lakka](desktop/lakka.md), [Recalbox](desktop/recalbox.md), [RetroArch](desktop/retroarch.md), [RetroPie](desktop/retropie.md), etc.) | Each frontend's documentation should have instructions or links to download the appropriate DAT(s). For example, [RetroArch's arcade docs](https://docs.libretro.com/guides/arcade-getting-started/#step-3-use-the-correct-version-romsets-for-that-emulator) links to the exact DAT needed for each arcade core. | N/A |
| [MAME](https://www.mamedev.org/) | The easiest way to ensure you're using _exactly_ the right DAT for your MAME version is to provide the executable as `--dat ./mame`. See the [DATs page](../dats/processing.md) for more information. | A standalone download of the latest MAME ListXML can be found on the [official site](https://www.mamedev.org/release.html). See the [DATs page](../dats/introduction.md#dat-release-groups) for other alternatives. |
| [FinalBurn Neo](https://github.com/finalburnneo/FBNeo) | FinalBurn Neo doesn't provide an obvious way to find the correct DAT for each version. But it is likely that you are using FinalBurn Neo through a frontend, so use the above instructions. | N/A |
| [FinalBurn Alpha](https://www.fbalpha.com/) | FinalBurn Alpha was forked into FinalBurn Neo, so you should use that if possible. Otherwise, hopefully your frontend's documentation has links to download the correct DAT. | N/A |
Expand Down
2 changes: 1 addition & 1 deletion docs/usage/desktop/batocera.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Batocera

[Batocera](https://batocera.org/) is a pre-configured Linux distribution for [EmulationStation](emulationstation.md) & [RetroArch](retroarch.md). Batocera is primarily for single-board computers (SBCs) such as the [Raspberry Pi](https://www.raspberrypi.com/).
[Batocera](https://batocera.org/) is a pre-configured Linux distribution for [ES-DE](esde.md) & [RetroArch](retroarch.md). Batocera is primarily for single-board computers (SBCs) such as the [Raspberry Pi](https://www.raspberrypi.com/).

## BIOS

Expand Down
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# EmulationStation
# ES-DE

## EmulationStation Desktop Edition (ES-DE)

[EmulationStation](https://emulationstation.org/) is a frontend for [RetroArch](retroarch.md) and many other standalone emulators.
[ES-DE](https://emulationstation.org/) is a frontend for [RetroArch](retroarch.md) and many other standalone emulators.

## BIOS

Because EmulationStation uses RetroArch under the hood, the instructions are generally the [same as RetroArch](retroarch.md). By default, the EmulationStation BIOS directory is `/userdata/bios/`:
Because ES-DE uses RetroArch under the hood, the instructions are generally the [same as RetroArch](retroarch.md). By default, the ES-DE BIOS directory is `/userdata/bios/`:

=== ":simple-linux: EmulationStation (Linux)"
=== ":simple-linux: ES-DE (Linux)"

You can copy BIOS files from a USB drive named "USB-Drive" like this:

Expand All @@ -23,16 +23,16 @@ Other emulators may use other names for their BIOS images but all reside in the

## ROMs

EmulationStation uses its own proprietary ROM folder structure, so `igir` has a replaceable `{es}` token to sort ROMs into the right place. See the [replaceable tokens page](../../output/tokens.md) for more information.
ES-DE uses its own proprietary ROM folder structure, so `igir` has a replaceable `{esde}` token to sort ROMs into the right place. See the [replaceable tokens page](../../output/tokens.md) for more information.

=== ":simple-linux: EmulationStation (Linux)"
=== ":simple-linux: ES-DE (Linux)"

You can copy ROMs from a USB drive named "USB-Drive" like this:

```shell
igir copy zip test clean \
--dat "/media/USB-Drive/No-Intro*.zip" \
--input "/media/USB-Drive/ROMs/" \
--output "/userdata/roms/{es}" \
--output "/userdata/roms/{esde}" \
--no-bios
```
2 changes: 1 addition & 1 deletion docs/usage/desktop/recalbox.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Recalbox

[Recalbox](https://www.recalbox.com/) is a pre-configured Linux distribution for [EmulationStation](emulationstation.md) & [RetroArch](retroarch.md).
[Recalbox](https://www.recalbox.com/) is a pre-configured Linux distribution for [ES-DE](esde.md) & [RetroArch](retroarch.md).

## BIOS

Expand Down
2 changes: 1 addition & 1 deletion docs/usage/desktop/retrodeck.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# RetroDECK

[RetroDECK](https://retrodeck.net/) is a self contained application package that uses [EmulationStation](emulationstation.md) as a frontend for [RetroArch](retroarch.md) and many other standalone emulators. It is primarily designed and optimised for the Steam Deck.
[RetroDECK](https://retrodeck.net/) is a self contained application package that uses [ES-DE](esde.md) as a frontend for [RetroArch](retroarch.md) and many other standalone emulators. It is primarily designed and optimised for the Steam Deck.

## BIOS

Expand Down
2 changes: 1 addition & 1 deletion docs/usage/desktop/retropie.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# RetroPie

[RetroPie](https://retropie.org.uk/) is an installer for [EmulationStation](emulationstation.md) & [RetroArch](retroarch.md) on single-board computers (SBCs) such as the [Raspberry Pi](https://www.raspberrypi.com/).
[RetroPie](https://retropie.org.uk/) is an installer for [ES-DE](esde.md) & [RetroArch](retroarch.md) on single-board computers (SBCs) such as the [Raspberry Pi](https://www.raspberrypi.com/).

## BIOS

Expand Down
4 changes: 0 additions & 4 deletions docs/usage/handheld/jelos.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,5 @@
# JELOS

!!! info

[JELOS](https://jelos.org) is based on [RetroArch](https://www.retroarch.com/) and [EmulationStation](https://emulationstation.org/). If the instructions on this page don't lead to success on your device, you might want to try your luck with their documentation.

[JELOS](https://jelos.org) (or **J**ust **E**nough **L**inux **OS**) is a slim open source operating system for many devices by Anbernic, Powkiddy, Hardkernel etc. While it supports many devices as an aftermarket operating system choice, vendors have started shipping their devices with JELOS, too. With powerful features like custom collections and online scraping, it can make good use of huge and well managed ROM collections.

## Different card setups
Expand Down
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ nav:
- usage/handheld/adam.md
- usage/desktop/batocera.md
- usage/desktop/emuelec.md
- usage/desktop/emulationstation.md
- usage/desktop/esde.md
- usage/handheld/funkeyos.md
- usage/handheld/jelos.md
- usage/desktop/lakka.md
Expand Down
2 changes: 1 addition & 1 deletion src/modules/argumentsParser.ts
Original file line number Diff line number Diff line change
Expand Up @@ -830,7 +830,7 @@ Advanced usage:

{adam} The ROM's emulator-specific /ROMS/* directory for the 'Adam' image (e.g. "GB")
{batocera} The ROM's emulator-specific /roms/* directory for Batocera (e.g. "gb")
{es} The ROM's emulator-specific /roms/* directory for the 'EmulationStation' image (e.g. "gb")
{esde} The ROM's emulator-specific /roms/* directory for the 'ES-DE' image (e.g. "gb")
{funkeyos} The ROM's emulator-specific /* directory for FunKey OS (e.g. "Game Boy")
{jelos} The ROM's emulator-specific /roms/* directory for JELOS (e.g. "gb")
{minui} The ROM's emulator-specific /Roms/* directory for MinUI (e.g. "Game Boy (GB)")
Expand Down
Loading
Loading