wbrawner/distribution
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #1711 from fewtarius/dev

Browse source 
Implements automated documentation for systems emulators and cores per device.
This commit is contained in:
fewtarius 2023-07-14 09:59:35 -04:00 committed by GitHub
commit 239687c976
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
29 changed files with 1727 additions and 846 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
.github/workflows/build-main.yaml vendored
View file

@ -98,15 +98,15 @@ jobs:
* Write the image to an SDCARD using an imaging tool. Common imaging tools include [Balena Etcher](https://www.balena.io/etcher/), [Raspberry Pi Imager](https://www.raspberrypi.com/software/), and [Win32 Disk Imager](https://sourceforge.net/projects/win32diskimager/). If you're skilled with the command line, dd works fine too.
### Installation Package Downloads
|**Device/Platform**|**Download Package**|
|----|----|
|**Anbernic RG351P/M, ODROID Go Advance, ODROID Go Super**|[JELOS-RK3326.aarch64-${{ steps.version.outputs.version }}.img.gz](https://github.com/JustEnoughLinuxOS/distribution/releases/download/${{ steps.version.outputs.version }}/JELOS-RK3326.aarch64-${{ steps.version.outputs.version }}.img.gz)|
|**Anbernic RG353P/M/V/VS, RG503, and Powkiddy RK2023**|[JELOS-RK3566.aarch64-${{ steps.version.outputs.version }}.img.gz](https://github.com/JustEnoughLinuxOS/distribution/releases/download/${{ steps.version.outputs.version }}/JELOS-RK3566.aarch64-${{ steps.version.outputs.version }}.img.gz)|
|**Anbernic RG552**|[JELOS-RK3399.aarch64-${{ steps.version.outputs.version }}.img.gz](https://github.com/JustEnoughLinuxOS/distribution/releases/download/${{ steps.version.outputs.version }}/JELOS-RK3399.aarch64-${{ steps.version.outputs.version }}.img.gz)|
|**Ayaneo Handhelds, Atari VCS, and other x86_64 devices**|[JELOS-AMD64.x86_64-${{ steps.version.outputs.version }}.img.gz](https://github.com/JustEnoughLinuxOS/distribution/releases/download/${{ steps.version.outputs.version }}/JELOS-AMD64.x86_64-${{ steps.version.outputs.version }}.img.gz)|
|**Hardkernel ODROID Go Ultra, Powkiddy RGB10 Max 3 Pro**|[JELOS-S922X.aarch64-${{ steps.version.outputs.version }}.img.gz](https://github.com/JustEnoughLinuxOS/distribution/releases/download/${{ steps.version.outputs.version }}/JELOS-S922X.aarch64-${{ steps.version.outputs.version }}.img.gz)|
|**Orange Pi 5, and Indiedroid Nova**|[JELOS-RK3588.aarch64-${{ steps.version.outputs.version }}.img.gz](https://github.com/JustEnoughLinuxOS/distribution/releases/download/${{ steps.version.outputs.version }}/JELOS-RK3588.aarch64-${{ steps.version.outputs.version }}.img.gz)|
|**Powkiddy x55**|[JELOS-RK3566-X55.aarch64-${{ steps.version.outputs.version }}.img.gz](https://github.com/JustEnoughLinuxOS/distribution/releases/download/${{ steps.version.outputs.version }}/JELOS-RK3566-X55.aarch64-${{ steps.version.outputs.version }}.img.gz)|
|**Device/Platform**|**Download Package**|**Documentation**|
|----|----|----|
|**Anbernic RG351P/M, ODROID Go Advance, ODROID Go Super**|[JELOS-RK3326.aarch64-${{ steps.version.outputs.version }}.img.gz](https://github.com/JustEnoughLinuxOS/distribution/releases/download/${{ steps.version.outputs.version }}/JELOS-RK3326.aarch64-${{ steps.version.outputs.version }}.img.gz)|[documentation](/documentation/RK3326/)|
|**Anbernic RG353P/M/V/VS, RG503, and Powkiddy RK2023**|[JELOS-RK3566.aarch64-${{ steps.version.outputs.version }}.img.gz](https://github.com/JustEnoughLinuxOS/distribution/releases/download/${{ steps.version.outputs.version }}/JELOS-RK3566.aarch64-${{ steps.version.outputs.version }}.img.gz)|[documentation](/documentation/RK3566/)|
|**Anbernic RG552**|[JELOS-RK3399.aarch64-${{ steps.version.outputs.version }}.img.gz](https://github.com/JustEnoughLinuxOS/distribution/releases/download/${{ steps.version.outputs.version }}/JELOS-RK3399.aarch64-${{ steps.version.outputs.version }}.img.gz)|[documentation](/documentation/RK3399/)|
|**Ayaneo Handhelds, Atari VCS, and other x86_64 devices**|[JELOS-AMD64.x86_64-${{ steps.version.outputs.version }}.img.gz](https://github.com/JustEnoughLinuxOS/distribution/releases/download/${{ steps.version.outputs.version }}/JELOS-AMD64.x86_64-${{ steps.version.outputs.version }}.img.gz)|[documentation](/documentation/AMD64/)|
|**Hardkernel ODROID Go Ultra, Powkiddy RGB10 Max 3 Pro**|[JELOS-S922X.aarch64-${{ steps.version.outputs.version }}.img.gz](https://github.com/JustEnoughLinuxOS/distribution/releases/download/${{ steps.version.outputs.version }}/JELOS-S922X.aarch64-${{ steps.version.outputs.version }}.img.gz)|[documentation](/documentation/S922X/)|
|**Orange Pi 5, and Indiedroid Nova**|[JELOS-RK3588.aarch64-${{ steps.version.outputs.version }}.img.gz](https://github.com/JustEnoughLinuxOS/distribution/releases/download/${{ steps.version.outputs.version }}/JELOS-RK3588.aarch64-${{ steps.version.outputs.version }}.img.gz)|[documentation](/documentation/RK3588/)|
|**Powkiddy x55**|[JELOS-RK3566-X55.aarch64-${{ steps.version.outputs.version }}.img.gz](https://github.com/JustEnoughLinuxOS/distribution/releases/download/${{ steps.version.outputs.version }}/JELOS-RK3566-X55.aarch64-${{ steps.version.outputs.version }}.img.gz)|[documentation](/documentation/RK3566-X55/)|
## Upgrading
* Download and install the update online via the System Settings menu.
@ -128,6 +128,7 @@ jobs:
## Documentation
* [Home](https://github.com/JustEnoughLinuxOS/distribution/wiki)
* [General Documentation](https://github.com/JustEnoughLinuxOS/distribution/documentation)
* [Donating to JELOS](https://github.com/JustEnoughLinuxOS/distribution/wiki/Donating-to-JELOS)
* [Frequently asked Questions](https://github.com/JustEnoughLinuxOS/distribution/wiki/Frequently-Asked-Questions)
* [HotKeys](https://github.com/JustEnoughLinuxOS/distribution/wiki/Hotkeys)

3
.gitignore vendored
View file

@ -46,6 +46,9 @@
# es generation files
.es_cache/
# system document cache
.doc_cache/
# release images
release/

260
BUILDING.md
View file

@ -1,260 +0,0 @@
# Developing and Building JELOS
JELOS is a fairly unique distribution as it is *built to order* and only enough of the operating system and applications are built for the purpose of booting and executing emulators and ports. Developers and others who would like to contribute to our project should read and agree to the [Contributor Covenant Code of Conduct](https://github.com/JustEnoughLinuxOS/distribution/blob/main/CODE_OF_CONDUCT.md) and [Contributing to JELOS](https://github.com/JustEnoughLinuxOS/distribution/blob/main/CONTRIBUTING.md) guides before submitting your first contribution.
## Filesystem Structure
We have a simple filesystem structure adopted from parent distributions CoreELEC, LibreELEC, etc.
```
.
├── build.JELOS-DEVICE.ARCHITECTURE
├── config
├── distributions
├── Dockerfile
├── licenses
├── Makefile
├── packages
├── post-update
├── projects
├── release
├── scripts
├── sources
└── tools
```
**build.JELOS-DEVICE.ARCHITECTURE**
Build roots for each device and that devices architecture(s). For ARM devices JELOS builds and uses a 32bit root for several of the cores used in the 64bit distribution.
**config**
Contains functions utilized during the build process including architecture specific build flags, optimizations, and functions used throughout the build workflow.
**distributions**
Distributions contains distribution specific build flags and parameters and splash screens.
**Dockerfile**
Used to build the Ubuntu container used to build JELOS. The container is hosted at [https://hub.docker.com/u/justenoughlinuxos](https://hub.docker.com/u/justenoughlinuxos)
**licenses**
All of the licenses used throughout the distribution packages are hosted here. If you're adding a package that contains a license, make sure it is available in this directory before submitting the PR.
**Makefile**
Used to build one or more JELOS images, or to build and deploy the Ubuntu container.
**packages**
All of the package set that is used to develop and build JELOS are hosted within the packages directory. The package structure documentation is available in [PACKAGE.md](PACKAGE.md)
**post-update**
Anything that is necessary to be run on a device after an upgrade should be added here. Be sure to apply a guard to test that the change needs to be executed before execution.
**projects**
Hardware specific parameters are stored in the projects folder, anything that should not be included on every device during a world build should be isolated to the specific project or device here.
**release**
The output directory for all of the build images.
**scripts**
This directory contains all of the scripts used to fetch, extract, build, and release the distribution. Review Makefile for more details.
**sources**
As the distribution is being built, package source are fetched and hosted in this directory. They will persist after a `make clean`.
**tools**
The tools directory contains utility scripts that can be used during the development process, including a simple tool to burn an image to a usb drive or sdcard.
## Building JELOS
Building JELOS requires an Ubuntu 22.04 host with 200GB of free space for a single device, or 1TB of free space for a full world build. Other Linux distributions may be used when building using Docker, however this is untested and unsupported.
### Cloning the JELOS Sources
To build JELOS, start by cloning the project git repository.
```
cd ~
git clone https://github.com/JustEnoughLinuxOS/distribution.git
```
### Selecting the Desired Branch
Once you have cloned the repo, you will want to determine if you want to build the main branch which is more stable, or the development branch which is unstable but hosts our newest features.
|Branch|Purpose|
|----|----|
|main|Stable JELOS sources|
|dev|Unstable JELOS sources|
To check out our development branch, cd into the project directory and checkout `dev`.
```
cd distribution
git checkout dev
```
### Building with Docker
Building JELOS is easy, the fastest and most recommended method is to instruct the build to use Docker, this is only known to work on a Linux system. To build JELOS with Docker use the table below.
| Devices | Dependency | Docker Command |
| ---- | ---- | ---- |
|AMD64||```make docker-AMD64```|
|RK3588||```make docker-RK3588```|
|RK3326||```make docker-RK3326```|
|RK3566||```make docker-RK3566```|
|RK3566-X55||```make docker-RK3566-X55```|
|S922X||```make docker-S922X```|
|ALL DEVICES||```make docker-world```|
> Devices that list a dependency require the dependency to be built first as that build will be used as the root of the device you are building. This will be done automatically by the build tooling when you start a build for your device.
### Building Manually
To build JELOS manually, you will need several prerequisite host packages installed.
#### Distribution Packages
```
sudo apt install gcc make git unzip wget \
xz-utils libsdl2-dev libsdl2-mixer-dev libfreeimage-dev libfreetype6-dev libcurl4-openssl-dev \
rapidjson-dev libasound2-dev libgl1-mesa-dev build-essential libboost-all-dev cmake fonts-droid-fallback \
libvlc-dev libvlccore-dev vlc-bin texinfo premake4 golang libssl-dev curl patchelf \
xmlstarlet patchutils gawk gperf xfonts-utils default-jre python-is-python3 xsltproc libjson-perl \
lzop libncurses5-dev device-tree-compiler u-boot-tools rsync p7zip libparse-yapp-perl \
zip binutils-aarch64-linux-gnu dos2unix p7zip-full libvpx-dev bsdmainutils bc meson p7zip-full \
qemu-user-binfmt zstd parted imagemagick qemu-user-static ca-certificates curl gnupg
```
### Docker
```
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /etc/apt/keyrings/docker.gpg
sudo chmod a+r /etc/apt/keyrings/docker.gpg
echo \
"deb [arch="$(dpkg --print-architecture)" signed-by=/etc/apt/keyrings/docker.gpg] https://download.docker.com/linux/ubuntu \
"$(. /etc/os-release && echo "$VERSION_CODENAME")" stable" | \
sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
sudo apt update
sudo apt install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin
```
> Docker installation reference (source): https://docs.docker.com/engine/install/ubuntu/
Next, build the version of JELOS for your device. See the table above for dependencies.
```
make AMD64
```
### Building a single package
It is also possible to build individual packages.
```
DEVICE=AMD64 ARCH=x86_64 ./scripts/clean busybox
DEVICE=AMD64 ARCH=x86_64 ./scripts/build busybox
```
> Note: An EmulationStation package standalone build requires additional steps because its source code located in a separate repository, see instructions inside, [link](https://github.com/JustEnoughLinuxOS/distribution/blob/main/packages/ui/emulationstation/package.mk).
### Rightsized builds
JELOS supports various build variables which alter the behavior of the distribution for specific purposes including debugging, or hosting containers. The options are defined below and are passed on the make command line. Ex. `BASE_ONLY=true make docker-RK3566`.
|Build Option|Setting|Function|
|----|----|----|
|EMULATION_DEVICE|yes|Builds EmulationStation and all emulators, builds EmulationStation and NO emulators if false.|
|ENABLE_32BIT|yes|Builds a 32bit root and includes it in the image. Needed for 32bit cores and applications.|
|BASE_ONLY|false<sup>1</sup>|Builds only the bare minimum packages, includes Weston on supported devices. Does not build EmulationStation.|
|CONTAINER_SUPPORT|no|Builds support for running containers on JELOS|
> Note: <sup>1</sup> this property will change to yes/no for consistency in a future release.
### Special env variables
For development builds, you can use the following env variables to customize the image or change build time functionality. To make them globally available to the builds, add them to ${HOME}/.JELOS/options.
|Variable|Function|
|----|----|
|LOCAL_SSH_KEYS_FILE|Enables using ssh public keys for access without the root password.|
|LOCAL_WIFI_SSID|The SSID of the network the device should connect too automatically.|
|LOCAL_WIFI_KEY|The WIFI authentication key for the connection."|
|SCREENSCRAPER_DEV_LOGIN|Login information for screenscraper.fr.|
|GAMESDB_APIKEY|Login information for thegamesdb.net.|
|CHEEVOS_DEV_LOGIN|Login information for retroachievements.org.|
|CLEAN_PACKAGES|Allows specifying packages to clean during a build.|
#### SSH keys
```
export LOCAL_SSH_KEYS_FILE=~/.ssh/jelos/authorized_keys
```
#### WiFi SSID and password
```
export LOCAL_WIFI_SSID=MYWIFI
export LOCAL_WIFI_KEY=secret
```
#### Screenscraper, GamesDB, and RetroAchievements
To enable Screenscraper, GamesDB, and RetroAchievements, register at each site and apply the api keys in ${HOME}/.JELOS/options. Unsetting one of the variables will disable it in EmulationStation. This configuration is picked up by EmulationStation during the build.
```
# Apply for a Screenscraper API Key here: https://www.screenscraper.fr/forumsujets.php?frub=12&numpage=0
export SCREENSCRAPER_DEV_LOGIN="devid=DEVID&devpassword=DEVPASSWORD"
# Apply for a GamesDB API Key here: https://forums.thegamesdb.net/viewforum.php?f=10
export GAMESDB_APIKEY="APIKEY"
# Find your Cheevos Web API key here: https://retroachievements.org/controlpanel.php
export CHEEVOS_DEV_LOGIN="z=RETROACHIEVEMENTSUSERNAME&y=APIKEYID"
```
#### Cleaning additional packages
```
CLEAN_PACKAGES="linux ppsspp-sa" make AMD64
```
### Creating a patch for a package
It is common to have imported package source code modifed to fit the use case. It's recommended to use a special shell script to built it in case you need to iterate over it. See below.
```
cd sources/wireguard-linux-compat
tar -xvJf wireguard-linux-compat-v1.0.20211208.tar.xz
mv wireguard-linux-compat-v1.0.20211208 wireguard-linux-compat
cp -rf wireguard-linux-compat wireguard-linux-compat.orig
# Make your changes to wireguard-linux-compat
mkdir -p ../../packages/network/wireguard-linux-compat/patches/AMD64
# run from the sources dir
diff -rupN wireguard-linux-compat wireguard-linux-compat.orig >../../packages/network/wireguard-linux-compat/patches/AMD64/mychanges.patch
```
### Creating a patch for a package using git
If you are working with a git repository, building a patch for the distribution is simple. Rather than using `diff`, use `git diff`.
```
cd sources/emulationstation/emulationstation-098226b/
# Make your changes to EmulationStation
vim/emacs/vscode/notepad.exe
# Make the patch directory
mkdir -p ../../packages/ui/emulationstation/patches
# Run from the sources dir
git diff >../../packages/ui/emulationstation/patches/005-mypatch.patch
```
After patch is generated, one can rebuild an individual package, see section above. The build system will automatically pick up patch files from `patches` directory. For testing, one can either copy the built binary to the console or burn the whole image on SD card.
### Building an image with your patch
If you already have a build for your device made using the above process, it's simple to shortcut the build process and create an image to test your changes quickly using the process below.
```
# Update the package version for a new package, or apply your patch as above.
vim/emacs/vscode/notepad.exe
# Export the variables needed to complete your build, we'll assume you are building AMD64, update the device to match your configuration.
export OS_VERSION=$(date +%Y%m%d) BUILD_DATE=$(date)
export PROJECT=PC ARCH=x86_64 DEVICE=AMD64
# Clean the package you are building.
./scripts/clean emulationstation
# Build the package.
./scripts/build emulationstation
# Install the package into the build root.
./scripts/install emulationstation
# Generate an image with your new package.
./scripts/image mkimage
```

1
BUILDING.md Symbolic link
View file

@ -0,0 +1 @@
documentation/BUILDING.md

128
CODE_OF_CONDUCT.md
View file

@ -1,128 +0,0 @@
# Contributor Covenant Code of Conduct
## Our Pledge
We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, religion, or sexual identity
and orientation.
We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.
## Our Standards
Examples of behavior that contributes to a positive environment for our
community include:
* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the
overall community
Examples of unacceptable behavior include:
* The use of sexualized language or imagery, and sexual attention or
advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email
address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
## Enforcement Responsibilities
Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.
Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.
## Scope
This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
contact at jelos dot org.
All complaints will be reviewed and investigated promptly and fairly.
All community leaders are obligated to respect the privacy and security of the
reporter of any incident.
## Enforcement Guidelines
Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:
### 1. Correction
**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.
**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.
### 2. Warning
**Community Impact**: A violation through a single incident or series
of actions.
**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or
permanent ban.
### 3. Temporary Ban
**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.
**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.
### 4. Permanent Ban
**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.
**Consequence**: A permanent ban from any sort of public interaction within
the community.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).
[homepage]: https://www.contributor-covenant.org
For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.

1
CODE_OF_CONDUCT.md Symbolic link
View file

@ -0,0 +1 @@
documentation/CODE_OF_CONDUCT.md

39
CONTRIBUTING.md
View file

@ -1,39 +0,0 @@
# Contributing to JELOS
Welcome new contributor! Your contribution will help JELOS become a better Linux distribution, so thank you! We want to make contributing to this project as easy and transparent as possible. Contributors are able to:
- Discuss the current state of the code
- Submit a fix
- Propose new features
- Become a maintainer
## Becoming a maintainer
When contributing to JELOS you are expected to become the maintainer of your contribution. Please keep this in mind when submitting pull requests.
* Keep track of your contributions upstreams and keep your components up-to-date.
* Watch the issue tracker and resolve issues related to your contribution.
## We Develop with Github
We use Github to host code, to track issues and feature requests, as well as accept pull requests.
## We Use [Github Flow](https://guides.github.com/introduction/flow/index.html), So All Code Changes Happen Through Pull Requests
Pull requests are the best way to propose changes to the codebase (we use [Github Flow](https://guides.github.com/introduction/flow/index.html)). We actively welcome your pull requests:
1. Join our discord and chat with us, we'll be happy to help you successfully implement your change.
2. Fork the repo and create your branch from `dev`.
3. Ensure your code is built locally and tested.
4. Any changes should be reflected in the documentation.
5. Issue a pull request back to our `dev` branch.
## Any contributions you make will be under the Apache 2 Software License
In short, when you submit code changes, your submissions are understood to be contributed under the same license as the original project code or under [Apache 2](https://choosealicense.com/licenses/apache-2.0/) license when no other license applies.
## Use a Consistent Coding Style
* Follow the same style as the source you are editing.
* If you are contributing new code, keep the style consistent with other similar works.
* Parameterize as much as possible, try to avoid hard coded values whenever you can.
* Use 2 spaces for indentation rather than tabs when possible.
## License
By contributing, you agree that your contributions will be licensed under the license of the existing project code being modified or Apache 2.
## References
This document was adapted from the open-source contribution guidelines for [Facebook's Draft](https://github.com/facebook/draft-js/blob/a9316a723f9e918afde44dea68b5f9f39b7d9b00/CONTRIBUTING.md)

1
CONTRIBUTING.md Symbolic link
View file

@ -0,0 +1 @@
documentation/CONTRIBUTING.md

32
LICENSE.md
View file

@ -1,32 +0,0 @@
## Licenses
JELOS is a Linux distribution that is made up of many open-source components. Components are provided under their respective licenses. This distribution includes components licensed for non-commercial use only.
### JELOS Branding
JELOS branding and images are licensed under a [Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License](https://creativecommons.org/licenses/by-nc-sa/4.0/).
#### You are free to
* Share — copy and redistribute the material in any medium or format
* Adapt — remix, transform, and build upon the material
#### Under the following terms
* Attribution — You must give appropriate credit, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.
* NonCommercial — You may not use the material for commercial purposes.
* ShareAlike — If you remix, transform, or build upon the material, you must distribute your contributions under the same license as the original.
### JELOS Software
Copyright 2021-present Fewtarius
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
### Bundled Works
All other software is provided under each component's respective license. These licenses can be found in the software sources or in this project's licenses folder.

1
LICENSE.md Symbolic link
View file

@ -0,0 +1 @@
documentation/LICENSE.md

269
PACKAGE.md
View file

@ -1,269 +0,0 @@
# Structure of package.mk files
## Introduction
The package.mk file defines variables and functions to build a package.
## Variables
To control the build behaviour of your package, use variables in the top-down order listed here.
#### Base
| Variable | Default | Required |Description |
|-------------|---------|----------|------------|
| PKG_NAME | - | yes | Name of the packaged software application. Should be lowercase |
| PKG_VERSION | - | yes | Version of the packaged software application. If the version is a githash, please use the full githash, not the abbreviated form. |
| PKG_SHA256 | - | yes | SHA256 hashsum of the application download file |
| PKG_ARCH | any | no | Architectures for which the package builds. `any` or a space separated list of `aarch64`, `arm` or `x86_64` |
| PKG_LICENSE | - | yes | License of the software application. [Reference](https://github.com/JustEnoughLinuxOS/distribution/tree/main/licenses) |
| PKG_SITE | - | yes | Site of the software application |
| PKG_URL | - | yes | Address at which the source of the software application can be retrieved |
| PKG_MAINTAINER | - | no | Your name |
| PKG_DEPENDS_BOOTSTRAP<br>PKG_DEPENDS_HOST PKG_DEPENDS_INIT PKG_DEPENDS_TARGET | - | no | A space separated list of name of packages required to build the software application |
| PKG_SECTION | - | no | virtual if the package only defines dependencies |
| PKG_SHORTDESC | - | no<br>yes&nbsp;for&nbsp;addons | Short description of the software package |
| PKG_LONGDESC | - | yes | Long description of the package including purpose or function within JELOS or Kodi |
#### Universal Build Option
| Variable | Default | Required |Description |
|-------------|---------|----------|------------|
| PKG_SOURCE_DIR | - | no | Force the folder name that application sources are unpacked to. Used when sources do not automatically unpack to a folder with the `PKG_NAME-PKG_VERSION` naming convention. |
| PKG_SOURCE_NAME | - | no | Force the filename of the application sources. Used when the filename is not the basename of `PKG_URL` |
| PKG_PATCH_DIRS | - | no | Patches in `./patches` are automatically applied after package unpack. Use this option to include patches from an additional folder, e.g. `./patches/$PKG_PATCH_DIRS` |
| PKG_NEED_UNPACK | - | no | Space separated list of files or folders to include in package stamp calculation. If the stamp is invalidated through changes to package files or dependent files/folders the package is cleaned and rebuilt. e.g. `PKG_NEED_UNPACK="$(get_pkg_directory linux)"` will trigger clean/rebuild of a Linux kernel driver package when a change to the `linux` kernel package is detected. |
| PKG_TOOLCHAIN | auto | no | Control which build toolchain is used. For detailed information, see [reference](#toolchain-options). |
| PKG_BUILD_FLAGS | - | no | A space separated list of flags with which to fine-tune the build process. Flags can be enabled or disabled with a `+` or `-` prefix. For detailed information, see the [Reference](#build_flags-options). |
| PKG_PYTHON_VERSION | python2.7 | no | Define the Python version to be used. |
| PKG_IS_KERNEL_PKG | - | no | Set to `yes` for packages that include Linux kernel modules |
#### Meson Options
| Variable | Default | Required |Description |
|-------------|---------|----------|------------|
| PKG_MESON_SCRIPT | ${PKG_BUILD}/meson.build | no | Meson build file to use |
| PKG_MESON_OPTS_TARGET | - | no | Options directly passed to meson |
#### CMAKE Options
| Variable | Default | Required |Description |
|-------------|---------|----------|------------|
| PKG_CMAKE_SCRIPT | ${PKG_BUILD}/CMakeLists.txt | no | CMake build file to use |
| PKG_CMAKE_OPTS_HOST<br>PKG_CMAKE_OPTS_TARGET | - | no | Options directly passed to cmake |
#### Configure Options
| Variable | Default | Required |Description |
|-------------|---------|----------|------------|
| PKG_CONFIGURE_SCRIPT | ${PKG_BUILD}/configure | no | configure script to use |
| PKG_CONFIGURE_OPTS<br>PKG_CONFIGURE_OPTS_BOOTSTRAP<br>PKG_CONFIGURE_OPTS_HOST<br>PKG_CONFIGURE_OPTS_INIT<br>PKG_CONFIGURE_OPTS_TARGET | - | no | Options directly passed to configure |
#### Make Options
| Variable | Default | Required |Description |
|-------------|---------|----------|------------|
| PKG_MAKE_OPTS<br>PKG_MAKE_OPTS_BOOTSTRP<br>PKG_MAKE_OPTS_HOST<br>PKG_MAKE_OPTS_INIT<br> PKG_MAKE_OPTS_TARGET | - | no | Options directly passed to make in the build step
| PKG_MAKEINSTALL_OPTS_HOST<br>PKG_MAKEINSTALL_OPTS_TARGET | - | no | Options directly passed to make in the install step
#### Addons
Additional options used when the package builds an addon.
| Variable | Default | Required |Description |
|-------------|---------|----------|------------|
| PKG_REV | - | yes | The revision number of the addon (starts at 100). Must be placed after `PKG_VERSION`. Must be incremented for each new version else Kodi clients will not detect version change and download the updated addon. |
| PKG_IS_ADDON | no | yes | Must be set to `yes` <br>or to `embedded` when this addon is part of the image |
| PKG_ADDON_NAME | - | yes | Proper name of the addon that is shown at the repo |
| PKG_ADDON_TYPE | - | yes | See LE/config/addon/ for other possibilities |
| PKG_ADDON_VERSION | - | no | The version of the addon, used in addon.xml |
| PKG_ADDON_PROVIDES | - | no | [Provides](http://kodi.wiki/view/addon.xml#.3Cprovides.3E_element) in addon-xml |
| PKG_ADDON_REQUIRES | - | no | [Requires](http://kodi.wiki/view/addon.xml#.3Crequires.3E) used in addon.xml |
| PKG_ADDON_PROJECTS | @PROJECTS@ | no | for available projects or devices, see projects subdirectory (note: Use RPi for RPi project, and RPi1 for RPi device) |
| PKG_DISCLAIMER | - | no | [Disclaimer](https://kodi.wiki/view/Addon.xml#.3Cdisclaimer.3E) in addon-xml |
| PKG_ADDON_IS_STANDALONE | - | no | Defines if an addon depends on Kodi (on) or is standalone (yes) |
| PKG_ADDON_BROKEN | - | no | Marks an addon as broken for the user |
#### Detailed Information for Options
##### TOOLCHAIN options
Application/packages needs different toolchains for build.
For instance `cmake` or the classic `./configure` or same very different.
For the most application/packages, the auto-detection of the toolchain works proper.
But not always. To select a specific toolchain, you only need to set the `PKG_TOOLCHAIN` variable.
| Toolchain | Description (if needed) |
|----------- |-------------------------|
| meson | [Meson Build System](http://mesonbuild.com/) |
| cmake | [CMake](https://cmake.org/) with Ninja |
| cmake-make | [CMake](https://cmake.org/) with Make |
| autotools | [GNU Build System](https://en.wikipedia.org/wiki/GNU_Build_System)
| configure | preconfigured [GNU Build System](https://en.wikipedia.org/wiki/GNU_Build_System) |
| ninja | [Ninja Build](https://ninja-build.org/) |
| make | [Makefile Based](https://www.gnu.org/software/make/) |
| manual | only runs self writen build steps, see [Functions](#functions) |
###### Auto-Detection
The auto-detections looks for specific files in the source path.
1. `meson.build` (PKG_MESON_SCRIPT) => meson toolchain
2. `CMakeLists.txt` (PKG_CMAKE_SCRIPT) => cmake toolchain
3. `configure` (PKG_CONFIGURE_SCRIPT) => configure toolchain
4. `Makefile` => make toolchain
When none of these was found, the build abort and you have to set the toolchain via `PKG_TOOLCHAIN`
##### BUILD_FLAGS options
Build flags implement often used build options. Normally these are activated be default, but single applications/packages has problems to compile/run with these.
Set the variable `PKG_BUILD_FLAGS` in the `package.mk` to enable/disable the single flags. It is a space separated list. The flags can enabled with a `+` prefix, and disabled with a `-`.
| flag | default | affected stage | description |
|----------|----------|----------------|-------------|
| pic | disabled | target/init | [Position Independent Code](https://en.wikipedia.org/wiki/Position-independent_code) |
| pic:host | disabled | host/bootstrap | see above |
| lto | disabled | target/init | enable LTO (Link Time optimization) in the compiler and linker unless disabled via `LTO_SUPPORT`. Compiles non-fat LTO objects (only bytecode) and performs single-threaded optimization at link stage |
| lto-parallel | disabled | target/init | same as `lto` but enable parallel optimization at link stage. Only enable this if the package build doesn't run multiple linkers in parallel otherwise this can result in lots of parallel processes! |
| lto-fat | disabled | target/init | same as `lto` but compile fat LTO objects (bytecode plus optimized assembly). This increases compile time but can be useful to create static libraries suitable both for LTO and non-LTO linking |
| lto-off | disabled | target/init | explicitly disable LTO in the compiler and linker |
| gold | depend on `GOLD_SUPPORT` | target/init | can only disabled, use of the GOLD-Linker |
| parallel | enabled | all | `make` or `ninja` builds with multiple threads/processes (or not) |
| strip | enabled | target | strips executables (or not) |
###### Example
```
PKG_BUILD_FLAGS="+pic -gold"
PKG_BUILD_FLAGS="-parallel"
```
## Functions
All build steps in the JELOS build system are done by shell function.
These functions can overwritten in the `package.mk`. But this raises problems, when the build system is updated. To reduce the problem, most function was extended by `pre_` and `post_` scripts, to use instead.
When it is nesseary to replace configure, make and makeinstall, please use `PKG_TOOLCHAIN="manual"`.
Some of the build steps needs to be run once, like `unpack`. Other steps needs to be run multiple times, to create the toolchain (stage bootstrap & host) or to create the LE image (stage init & target). These stage specific functions have the stage as suffix, like `make_target`.
Full list of overwrittable functions.
| function | stages specific | description |
|-------------------------|--------|-------------|
| configure_package | - | Optional function to implement late binding variable assignment (see below) |
| unpack<br>pre_unpack<br>post_unpack | - | Extract the source from the downloaded file |
| pre_patch<br>post_patch | - | Apply the patches to the source, after extraction. The patch function it self is not allowed to overwritten |
| pre_build_\[stage] | yes | Runs before of the start of the build |
| pre_configure<br>pre_configure_\[stage]<br>configure_\[stage]<br>post_configure_\[stage] | yes | Configure the package for the compile. This is only relevant for toolchain, that supports it (e.g. meson, cmake, configure, manual) |
| make_\[stage]<br>pre_make_\[stage]<br>post_make_\[stage] | yes | Build of the package |
| makeinstall_\[stage]<br>pre_makeinstall_\[stage]<br>post_makeinstall_\[stage] | yes | Installation of the files in the correct pathes<br>host: TOOLCHAIN<br>target: SYSROOT and IMAGE<br>bootstrap and init: temporary destination
| addon | - | Copy all files together for addon creation. This is requiered for addons |
## Late Binding variable assignment
A package will be loaded only once, by the call to `config/options`. During this process, additional package specific variables will be initialised, such as:
* `PKG_BUILD` - path to the build folder
* `PKG_SOURCE_NAME` - if not already specified, generated from `PKG_URL`, `PKG_NAME` and` PKG_VERSION`
Since these variables will not exist at the time the package is loaded, they can only be referenced **after** package has loaded. This can be accomplished by referencing these variables in the `configure_package()` function which is executed once the additional variables have been assigned.
If necessary, the following variables would be configured in `configure_package()` as they are normally relative to `${PKG_BUILD}`:
```
PKG_CONFIGURE_SCRIPT
PKG_CMAKE_SCRIPT
PKG_MESON_SCRIPT
```
Further to this, toolchain variables that are defined in `setup_toolchain()` must not be referenced "globally" in the package as they will only be configured reliably after `setup_toolchain()` has been called during `scripts/build`. Any variable in the following list must instead be referenced in a package function such as `pre_build_*`, `pre_configure_*`, `pre_make_*` etc.:
```
TARGET_CFLAGS TARGET_CXXFLAGS TARGET_LDFLAGS
NINJA_OPTS MAKEFLAGS
DESTIMAGE
CC CXX CPP LD
AS AR NM RANLIB
OBJCOPY OBJDUMP
STRIP
CPPFLAGS CFLAGS CXXFLAGS LDFLAGS
PKG_CONFIG
PKG_CONFIG_PATH
PKG_CONFIG_LIBDIR
PKG_CONFIG_SYSROOT_DIR
PKG_CONFIG_ALLOW_SYSTEM_CFLAGS
PKG_CONFIG_ALLOW_SYSTEM_LIBS
CMAKE_CONF CMAKE
HOST_CC HOST_CXX HOSTCC HOSTCXX
CC_FOR_BUILD CXX_FOR_BUILD BUILD_CC BUILD_CXX
_python_sysroot _python_prefix _python_exec_prefix
```
Lastly, the following variables are assigned during `scripts/build` but some packages may need to use alternative values for these variables. To do so, the package must assign alternative values in `pre_build_*`/`pre_configure_*`/`pre_make_*` etc. functions as these functions will be called after the variables are initialised with default values in `scripts/build` but before they are used by `scripts/build`.
```
CMAKE_GENERATOR_NINJA
TARGET_CONFIGURE_OPTS
TARGET_CMAKE_OPTS
TARGET_MESON_OPTS
HOST_CONFIGURE_OPTS
HOST_CMAKE_OPTS
HOST_MESON_OPTS
INIT_CONFIGURE_OPTS
INIT_CMAKE_OPTS
INIT_MESON_OPTS
BOOTSTRAP_CONFIGURE_OPTS
BOOTSTRAP_CMAKE_OPTS
BOOTSTRAP_MESON_OPTS
```
#### Example
```
configure_package() {
# now we know where we're building, assign a value
PKG_CONFIGURE_SCRIPT="${PKG_BUILD}/gettext-tools/configure"
}
post_patch() {
# replace hardcoded stuff
sed -i ${PKG_CONFIGURE_SCRIPT} 's|hardcoded stuff|variable stuff|'
}
pre_configure_target() {
# add extra flag to toolchain default
CFLAGS="${CFLAGS} -DEXTRA_FLAG=yeah"
}
post_makeinstall_target() {
# remove unused executable, install what remains
rm ${INSTALL}/usr/bin/bigexecutable
}
```
#### tools/pkgcheck
Use `tools/pkgcheck` to verify packages. It detects the following issues:
Issue | Level | Meaning |
| :--- | :----: | ---- |
| late&nbsp;binding&nbsp;violation | FAIL | Late binding variables referenced outside of a function - see [late binding](https://github.com/JELOS/JELOS.tv/blob/master/packages/readme.md#late-binding-variable-assignment) |
| duplicate&nbsp;function&nbsp;def | FAIL | Function defined multiple times, only last definition will be used |
| bad&nbsp;func&nbsp;-&nbsp;missing&nbsp;brace | FAIL | Opening brace (`{`) for function definition should be on same line as the function def, ie. `pre_configure_target() {` |
| intertwined&nbsp;vars&nbsp;&&nbsp;funcs | WARN | Variable assignments and logic is intertwined with functions - this is cosmetic, but variables and logic should be specified before all functions |
| unknown&nbsp;function | WARN | Could be a misspelled function, ie. `per_configure_target() {` which might fail silently.|
| ignored&nbsp;depends&nbsp;assign | WARN | Values assigned to `PKG_DEPENDS_*` outside of the global section or `configure_package()` will be ignored. |
## Add a new package to the Image
1. Think about, why you need it in the image.
* new multimedia tool
* add a new network tool
* new kernel driver
* ...
2. Find a place in the packages tree
* look into the package tree structure, which is generally self explaind.
* do not place it in an existing package (directory that includes a `package.mk`)
* when you found a place, create a directory with the name of your package (use same value for `PKG_NAME`!!)
3. Create an initial `package.mk`
* you can find a template under `packages/package.mk.template`. Copy the template into the new directory and call it `package.mk`
* apply any required changes to your new `package.mk`
4. Find a place in the dependency tree
* when it extend an existing package, add it there to the `PKG_DEPENDS_TARGET`/`PKG_DEPENDS_HOST` etc.
* take a look into the path `packages/virtual`, there you should find a virtual packages, that match your new package (misc-packages should be the last option)
5. Now you can build your image
* after the build, inside the `build-*` folder you should find a directory with your package name and -version, eg. `widget-1.2.3`.

1
PACKAGE.md Symbolic link
View file

@ -0,0 +1 @@
documentation/PACKAGE.md

38
PULL_REQUEST_TEMPLATE.md
View file

@ -1,38 +0,0 @@
# Pull Request Template
## Description
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
Fixes # (issue)
## Type of change
Please delete options that are not relevant.
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] This change requires a documentation update
## How Has This Been Tested Locally?
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
- [ ] Test A
- [ ] Test B
**Test Configuration**:
* Build OS name and version:
* Docker (Y/N):
* JELOS Branch:
* Any additional information that may be useful:
## Checklist:
- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
Note: This PR template is adapted from [embeddedartistry](https://github.com/embeddedartistry/templates/blob/master/oss_docs/PULL_REQUEST_TEMPLATE.md)

1
PULL_REQUEST_TEMPLATE.md Symbolic link
View file

@ -0,0 +1 @@
documentation/PULL_REQUEST_TEMPLATE.md

69
README.md
View file

@ -1,69 +0,0 @@
&nbsp;&nbsp;<img src="https://raw.githubusercontent.com/JustEnoughLinuxOS/distribution/dev/distributions/JELOS/logos/jelos-logo.png" width=192>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[![Latest Version](https://img.shields.io/github/release/JustEnoughLinuxOS/distribution.svg?color=5998FF&label=latest%20version&style=flat-square)](https://github.com/JustEnoughLinuxOS/distribution/releases/latest) [![Activity](https://img.shields.io/github/commit-activity/m/JustEnoughLinuxOS/distribution?color=5998FF&style=flat-square)](https://github.com/JustEnoughLinuxOS/distribution/commits) [![Pull Requests](https://img.shields.io/github/issues-pr-closed/JustEnoughLinuxOS/distribution?color=5998FF&style=flat-square)](https://github.com/JustEnoughLinuxOS/distribution/pulls) [![Discord Server](https://img.shields.io/discord/948029830325235753?color=5998FF&label=chat&style=flat-square)](https://discord.gg/seTxckZjJy)
#
Just Enough Linux Operating System (JELOS) is an immutable Linux distribution for handheld gaming devices developed by a small community of enthusiasts. Our goal is to produce an operating system that has the features and capabilities that we need, and to have fun as we develop it.
## Licenses
JELOS is a Linux distribution that is made up of many open-source components. Components are provided under their respective licenses. This distribution includes components licensed for non-commercial use only.
### JELOS Branding
JELOS branding and images are licensed under a [Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License](https://creativecommons.org/licenses/by-nc-sa/4.0/).
#### You are free to
* Share — copy and redistribute the material in any medium or format
* Adapt — remix, transform, and build upon the material
#### Under the following terms
* Attribution — You must give appropriate credit, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.
* NonCommercial — You may not use the material for commercial purposes.
* ShareAlike — If you remix, transform, or build upon the material, you must distribute your contributions under the same license as the original.
### JELOS Software
Copyright 2021-present Fewtarius
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
## Flashing
* Download the latest [version of JELOS](https://github.com/JustEnoughLinuxOS/distribution/releases) (.img.gz) for your device.
* Decompress the image.
* Write the image to an SDCARD using an imaging tool. Common imaging tools include [Balena Etcher](https://www.balena.io/etcher/), [Raspberry Pi Imager](https://www.raspberrypi.com/software/), and [Win32 Disk Imager](https://sourceforge.net/projects/win32diskimager/). If you're skilled with the command line, dd works fine too.
## Installation
* JELOS includes an installation tool. The installation tool can be found in the tools menu.
## Upgrading
* Download and install the update online via the System Settings menu.
* Download the latest [version of JELOS](https://github.com/JustEnoughLinuxOS/distribution/releases) (.tar) for your device.
* Copy the update to your device over the network to your device's update share.
* Reboot the device, and the update will begin automatically.
## Network Access
* External services are disabled by default in stable builds. When enabled, the username for ssh and samba access is "root". The root password is generated during every boot, it can be found in the System Settings menu.
## Documentation
* [Home](https://github.com/JustEnoughLinuxOS/distribution/wiki)
* [Donating to JELOS](https://github.com/JustEnoughLinuxOS/distribution/wiki/Donating-to-JELOS)
* [Frequently asked Questions](https://github.com/JustEnoughLinuxOS/distribution/wiki/Frequently-Asked-Questions)
* [HotKeys](https://github.com/JustEnoughLinuxOS/distribution/wiki/Hotkeys)
* [Emulators and Game Engines](https://github.com/JustEnoughLinuxOS/distribution/wiki/JELOS-emulators-and-game-engines)
* [Moonlight Game Streaming](https://github.com/JustEnoughLinuxOS/distribution/wiki/Moonlight-Game-Streaming)
* [Performance and Battery Life Optimizations](https://github.com/JustEnoughLinuxOS/distribution/wiki/Performance-and-Battery-Life-Optimizations)
* [Using Cloud Drives](https://github.com/JustEnoughLinuxOS/distribution/wiki/Using-Cloud-Drives)
* [Tailscale VPN](https://github.com/JustEnoughLinuxOS/distribution/wiki/Tailscale-VPN)
* [Wireguard VPN](https://github.com/JustEnoughLinuxOS/distribution/wiki/WireGuard-VPN)
## Contributing
* [Developing and Building JELOS](https://github.com/JustEnoughLinuxOS/distribution/blob/dev/BUILDING.md)
## Credits
Like any Linux distribution, this project is not the work of one person. It is the work of many persons all over the world who have developed the open source bits without which this project could not exist. Special thanks to CoreELEC, LibreELEC, and to developers and contributors across the open source community.

1
README.md Symbolic link
View file

@ -0,0 +1 @@
documentation/README.md

1
config/emulators/gbch.conf
View file

@ -8,4 +8,3 @@ SYSTEM_EXTENSION=".gb .GB .gbc .GBC .zip .ZIP .7z .7Z"
SYSTEM_COMMAND="/usr/bin/runemu.sh %ROM% -P%SYSTEM% --core=%CORE% --emulator=%EMULATOR% --controllers=\"%CONTROLLERSCONFIG%\""
SYSTEM_PLATFORM="gbc"
SYSTEM_THEME="gbch"
SYSTEM_FULLNAME="GameCube"

78
config/functions
View file

@ -1764,6 +1764,79 @@ exec_thread_safe() {
return ${result}
}
### Generate System Documentation
clean_doc_cache() {
DOCTMP="${ROOT}/.doc_cache/${DEVICE}"
if [ -d "${DOCTMP}" ]
then
rm -rf "${DOCTMP}"
fi
}
start_system_doc() {
if [ -z "${SYSDOC}" ]
then
echo "Unable to generate documentation, define SYSDOC in options."
exit 1
fi
if [ ! -d "${SYSDOCROOT}" ]
then
mkdir ${SYSDOCROOT}
fi
if [ -e "${SYSDOC}.md" ]
then
rm -f ${SYSDOC}.md
fi
if [ -e "${ROOT}/templates/HEADER.md" ]
then
cat ${ROOT}/templates/HEADER.md >${SYSDOC}.md
fi
DOCTEMPLATE="$(basename ${SYSDOC})"
if [ -e "${ROOT}/templates/${DOCTEMPLATE}.md" ]
then
cat ${ROOT}/templates/${DOCTEMPLATE}.md >>${SYSDOC}.md
fi
cat <<EOF >>${SYSDOC}.md
|Manufacturer|System|Release Date|Games Path|Supported Extensions|Emulator / Core|
|----|----|----|----|----|----|
EOF
}
add_system_doc() {
echo -n "|${SYSTEM_MANUFACTURER}|${SYSTEM_FULLNAME} (${SYSTEM_NAME})|${SYSTEM_RELEASE}|\`$(basename ${SYSTEM_PATH})\`|${SYSTEM_EXTENSION}|" >>${DOCTMP}/${1}:system.tmp
}
add_emu_doc() {
if [ ! -d "${DOCTMP}" ]
then
mkdir -p "${DOCTMP}"
fi
if [ "${4}" = "true" ]
then
DEFAULT=" (default)"
else
unset DEFAULT
fi
echo -n "**${2}:** ${3}${DEFAULT}<br>" >>${DOCTMP}/${1}:emulators.tmp
}
mk_system_doc() {
for system in $(ls ${DOCTMP}/ | awk 'BEGIN {FS=":"} {print $1}' | sort | uniq)
do
cat ${DOCTMP}/${system}:system.tmp >>${SYSDOC}.tmp
if [ -e "${DOCTMP}/${system}:emulators.tmp" ]
then
cat ${DOCTMP}/${system}:emulators.tmp >>${SYSDOC}.tmp
fi
echo "|" >>${SYSDOC}.tmp
done
cat ${SYSDOC}.tmp | sort -f >>${SYSDOC}.md
rm -f ${SYSDOC}.tmp
}
### Generate ES Systems
clean_es_cache() {
ESTMP="${ROOT}/.es_cache/${DEVICE}"
if [ -d "${ESTMP}" ]
@ -1780,9 +1853,11 @@ add_emu_core() {
# Schema: emulator|core|true/false
echo "${2}|${3}|${4}" >>${ESTMP}/${1}-emulators.tmp
add_emu_doc $*
}
mk_es_systems() {
cat <<EOF >${ESTMP}/.es_systems.cfg
<?xml version="1.0" encoding="UTF-8"?>
<systemList>
@ -1796,6 +1871,7 @@ EOF
</systemList>
EOF
xmlstarlet fo -t ${ESTMP}/.es_systems.cfg >${ESTMP}/es_systems.cfg 2>/dev/null
}
add_system_dir() {
@ -1895,7 +1971,7 @@ EOF
fi
done <${ESTMP}/${SYSTEM_NAME}-emulators.tmp
fi
add_system_doc ${SYSTEM_NAME}
}
# Use distribution functions if any

4
config/options
View file

@ -43,6 +43,10 @@ OS_VERSION=$(date +%Y%m%d)
# defines the born on date of a build
BUILD_DATE=$(date)
# defines supported systems documentation path
SYSDOCROOT="${ROOT}/documentation/${DEVICE}/"
SYSDOC="${SYSDOCROOT}/SUPPORTED_EMULATORS_AND_CORES"
# include helper functions
. config/functions

116
documentation/AMD64/SUPPORTED_EMULATORS_AND_CORES.md Normal file
View file

@ -0,0 +1,116 @@
&nbsp;&nbsp;<img src="https://raw.githubusercontent.com/JustEnoughLinuxOS/distribution/dev/distributions/JELOS/logos/jelos-logo.png" width=192>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[![Latest Version](https://img.shields.io/github/release/JustEnoughLinuxOS/distribution.svg?color=5998FF&label=latest%20version&style=flat-square)](https://github.com/JustEnoughLinuxOS/distribution/releases/latest) [![Activity](https://img.shields.io/github/commit-activity/m/JustEnoughLinuxOS/distribution?color=5998FF&style=flat-square)](https://github.com/JustEnoughLinuxOS/distribution/commits) [![Pull Requests](https://img.shields.io/github/issues-pr-closed/JustEnoughLinuxOS/distribution?color=5998FF&style=flat-square)](https://github.com/JustEnoughLinuxOS/distribution/pulls) [![Discord Server](https://img.shields.io/discord/948029830325235753?color=5998FF&label=chat&style=flat-square)](https://discord.gg/seTxckZjJy)
#
|Manufacturer|System|Release Date|Games Path|Supported Extensions|Emulator / Core|
|----|----|----|----|----|----|
|Amstrad|CPC (amstradcpc)|1984|`amstradcpc`|.dsk .DSK .sna .SNA .tap .TAP .cdt .CDT .kcr .KCR .voc .VOC .m3u .M3U .zip .ZIP .7z .7Z|**retroarch:** crocods (default)<br>**retroarch:** cap32<br>|
|Arcade|Arcade (arcade)|1984|`arcade`|.zip .ZIP .7z .7Z|**retroarch:** mame2003_plus (default)<br>**retroarch:** mame2000<br>**retroarch:** mame2010<br>**retroarch:** mame2015<br>**retroarch:** fbneo<br>**retroarch:** fbalpha2012<br>**retroarch:** fbalpha2019<br>**retroarch:** mame<br>|
|Arcade|Daphne (daphne)|1996|`daphne`|.daphne .DAPHNE .zip .ZIP|**hypseus:** hypseus (default)<br>**retroarch:** daphne<br>|
|Arcade|Final Burn Neo (fbn)|1986|`fbneo`|.7z .zip .7Z .ZIP|**retroarch:** fbneo (default)<br>**retroarch:** mame2003_plus<br>**retroarch:** mame2010<br>**retroarch:** mame2015<br>**retroarch:** mame<br>**retroarch:** fbalpha2012<br>**retroarch:** fbalpha2019<br>|
|Arcade|MAME (mame)|1989|`mame`|.7z .7Z .zip .ZIP|**retroarch:** mame2003_plus (default)<br>**retroarch:** mame2010<br>**retroarch:** mame2015<br>**retroarch:** mame<br>**retroarch:** fbneo<br>**retroarch:** fbalpha2012<br>**retroarch:** fbalpha2019<br>|
|Atari|2600 (atari2600)|1977|`atari2600`|.a26 .A26 .bin .BIN .zip .ZIP .7z .7Z|**retroarch:** stella (default)<br>|
|Atari|5200 (atari5200)|1982|`atari5200`|.rom .ROM .xfd .XFD .atr .ATR .atx .ATX .cdm .CDM .cas .CAS .car .CAR .bin .BIN .a52 .A52 .xex .XEX .zip .ZIP .7z .7Z|**retroarch:** a5200 (default)<br>**retroarch:** atari800<br>|
|Atari|7800 (atari7800)|1986|`atari7800`|.a78 .A78 .bin .BIN .zip .ZIP .7z .7Z|**retroarch:** prosystem (default)<br>|
|Atari|Atari 800 (atari800)|1979|`atari800`|.rom .ROM .xfd .XFD .atr .ATR .atx .ATX .cdm .CDM .cas .CAS .car .CAR .bin .BIN .a52 .A52 .xex .XEX .zip .ZIP .7z .7Z|**retroarch:** atari800 (default)<br>|
|Atari|Atari ST (atarist)|1985|`atarist`|.st .ST .msa .MSA .stx .STX .dim .DIM .ipf .IPF .m3u .M3U .zip .ZIP .7z .7Z|**retroarch:** hatari (default)<br>**hatarisa:** hatarisa<br>|
|Atari|Jaguar (atarijaguar)|1993|`atarijaguar`|.j64 .J64 .jag .JAG .rom .ROM .abs .ABS .cof .COF .bin .BIN .prg .PRG|**retroarch:** virtualjaguar (default)<br>|
|Atari|Lynx (atarilynx)|1989|`atarilynx`|.lnx .LNX .o .O .zip .ZIP .7z .7Z|**retroarch:** handy (default)<br>**retroarch:** beetle_lynx<br>|
|Bandai|SuFami Turbo (sufami)|1996|`sufami`|.st .ST .zip .ZIP .7z .7Z|**retroarch:** snes9x (default)<br>|
|Bandai|Wonderswan (wonderswan)|1999|`wonderswan`|.ws .WS .zip .ZIP .7z .7Z|**retroarch:** beetle_wswan (default)<br>|
|Bandai|Wonderswan Color (wonderswancolor)|2000|`wonderswancolor`|.wsc .WSC .zip .ZIP .7z .7Z|**retroarch:** beetle_wswan (default)<br>|
|belogic|Uzebox (uzebox)|2008|`uzebox`|.uze .UZE|**retroarch:** uzem (default)<br>|
|Capcom|PlaySystem 1 (cps1)|1988|`cps1`|.zip .ZIP .7z .7Z|**retroarch:** fbneo (default)<br>**retroarch:** mame2003_plus<br>**retroarch:** mame2010<br>**retroarch:** fbalpha2012<br>**retroarch:** mba_mini<br>|
|Capcom|PlaySystem 2 (cps2)|1993|`cps2`|.zip .ZIP .7z .7Z|**retroarch:** fbneo (default)<br>**retroarch:** mame2003_plus<br>**retroarch:** mame2010<br>**retroarch:** fbalpha2012<br>**retroarch:** mba_mini<br>|
|Capcom|PlaySystem 3 (cps3)|1996|`cps3`|.zip .ZIP .7z .7Z|**retroarch:** fbneo (default)<br>**retroarch:** mame2003_plus<br>**retroarch:** mame2010<br>**retroarch:** fbalpha2012<br>**retroarch:** mba_mini<br>|
|Coleco|ColecoVision (colecovision)|1982|`coleco`|.bin .BIN .col .COL .rom .ROM .zip .ZIP .7z .7Z|**retroarch:** bluemsx (default)<br>**retroarch:** gearcoleco<br>**retroarch:** smsplus<br>|
|Commodore|Amiga (amiga)|1985|`amiga`|.zip .ZIP .adf .ADF .uae .UAE .ipf .IPF .dms .DMS .adz .ADZ .lha .LHA .m3u .M3U .hdf .HDF .hdz .HDZ|**retroarch:** puae (default)<br>|
|Commodore|Amiga CD32 (amigacd32)|1994|`amigacd32`|.iso .ISO .cue .CUE .lha .LHA .chd .CHD|**retroarch:** puae (default)<br>|
|Commodore|C128 (c128)|1985|`c128`|.d64 .D64 .d71 .D71 .d80 .D80 .d81 .D81 .d82 .D82 .g64 .G64 .g41 .G41 .x64 .X64 .t64 .T64 .tap .TAP .prg .PRG .p00 .P00 .crt .CRT .bin .BIN .d6z .D6Z .d7z .D7Z .d8z .D8Z .g6z .G6Z .g4z .G4Z .x6z .X6Z .cmd .CMD .m3u .M3U .vsf .VSF .nib .NIB .nbz .NBZ .zip .ZIP|**retroarch:** vice_x128 (default)<br>**vicesa:** x128<br>|
|Commodore|C16 (c16)|1984|`c16`|.d64 .D64 .d71 .D71 .d80 .D80 .d81 .D81 .d82 .D82 .g64 .G64 .g41 .G41 .x64 .X64 .t64 .T64 .tap .TAP .prg .PRG .p00 .P00 .crt .CRT .bin .BIN .d6z .D6Z .d7z .D7Z .d8z .D8Z .g6z .G6Z .g4z .G4Z .x6z .X6Z .cmd .CMD .m3u .M3U .vsf .VSF .nib .NIB .nbz .NBZ .zip .ZIP|**retroarch:** vice_xplus4 (default)<br>**vicesa:** xplus4<br>|
|Commodore|C64 (c64)|1982|`c64`|.d64 .D64 .d71 .D71 .d80 .D80 .d81 .D81 .d82 .D82 .g64 .G64 .g41 .G41 .x64 .X64 .t64 .T64 .tap .TAP .prg .PRG .p00 .P00 .crt .CRT .bin .BIN .d6z .D6Z .d7z .D7Z .d8z .D8Z .g6z .G6Z .g4z .G4Z .x6z .X6Z .cmd .CMD .m3u .M3U .vsf .VSF .nib .NIB .nbz .NBZ .zip .ZIP|**retroarch:** vice_x64 (default)<br>**vicesa:** x64sc<br>|
|Commodore|Commodore PET (pet)|1977|`pet`|.20 .40 .60 .a0 .b0 .d64 .d71 .d80 .d81 .d82 .g64 .g41 .x64 .t64 .tap .prg .p00 .crt .bin .gz .d6z .d7z .d8z .g6z .g4z .x6z .cmd .m3u .vsf .nib .nbz .zip|**retroarch:** vice_xpet (default)<br>|
|Commodore|VIC-20 (vic20)|1980|`vic20`|.20 .40 .60 .a0 .A0 .b0 .B0 .d64 .D64 .d71 .D71 .d80 .D80 .d81 .D81 .d82 .D82 .g64 .G64 .g41 .G41 .x64 .X64 .t64 .T64 .tap .TAP .prg .PRG .p00 .P00 .crt .CRT .bin .BIN .gz .GZ .d6z .D6Z .d7z .D7Z .d8z .D8Z .g6z .G6Z .g4z .G4Z .x6z .X6Z .cmd .CMD .m3u .M3U .vsf .VSF .nib .NIB .nbz .NBZ .zip .ZIP|**retroarch:** vice_xvic (default)<br>**vicesa:** vice_xvic<br>|
|Fairchild|Channel F (channelf)|1976|`channelf`|.bin .BIN .chf .CHF .zip .ZIP .7z .7Z|**retroarch:** freechaf (default)<br>|
|id Software|Doom (doom)|1993|`doom`|.doom|**gzdoom:** gzdoom-sa (default)<br>|
|JELOS|Moonlight Game Streaming (moonlight)|2021|`moonlight`|.sh .SH||
|JELOS|MPlayer (mplayer)|unknown|`mplayer`|.mp4 .MP4 .mkv .MKV .avi .AVI .mov .MOV .wmv .WMV .m3u .M3U .mpg .MPG .ytb .YTB .twi .TWI .sh .SH .mp3 .MP3 .aac .AAC .mka .MKA .dts .DTS .flac .FLAC .ogg .OGG .m4a .M4A .ac3 .AC3 .opus .OPUS .wav .WAV .wv .WV .eac3 .EAC3 .thd .THD|**mplayer:** mplayer (default)<br>|
|JELOS|Ports (ports)|2021|`ports`|.sh .SH||
|JELOS|Screenshots (imageviewer)|2021|`screenshots`|.jpg .jpeg .png .bmp .psd .tga .gif .hdr .pic .ppm .pgm .mkv .pdf .mp4 .avi||
|JELOS|Tools (tools)|2021|`modules`|.sh||
|Lexaloffle|PICO-8 (pico-8)|2015|`pico-8`|.sh .p8 .png .SH .P8 .PNG|**pico-8:** pico8 (default)<br>**retroarch:** fake08<br>|
|Magnavox|Odyssey (odyssey2)|1979|`odyssey`|.bin .BIN .zip .ZIP .7z .7Z|**retroarch:** o2em (default)<br>|
|Mattel|Intellivision (intellivision)|1979|`intellivision`|.int .INT .bin .BIN .rom .ROM .zip .ZIP .7z .7Z|**retroarch:** freeintv (default)<br>|
|Microsoft|MS-DOS (pc)|1981|`pc`|.com .COM .bat .BAT .exe .EXE .dosz .DOSZ|**retroarch:** dosbox_pure<br>**retroarch:** dosbox_svn<br>|
|Microsoft|MSX (msx)|1983|`msx`|.dsk .DSK .mx1 .MX1 .mx2 .MX2 .rom .ROM .zip .ZIP .7z .7Z .M3U .m3u|**retroarch:** bluemsx (default)<br>**retroarch:** fmsx<br>|
|Microsoft|MSX2 (msx2)|1988|`msx2`|.dsk .DSK .mx1 .MX1 .mx2 .MX2 .rom .ROM .zip .ZIP .7z .7Z .M3U .m3u|**retroarch:** bluemsx (default)<br>**retroarch:** fmsx<br>|
|Microsoft|Xbox (xbox)|2001|`xbox`|.iso .ISO|**xemu:** xemu-sa (default)<br>|
|Milton Bradley|Vectrex (vectrex)|1982|`vectrex`|.bin .BIN .gam .GAM .vec .VEC .zip .ZIP .7z .7Z|**retroarch:** vecx (default)<br>|
|NEC|PC Engine (pcengine)|1987|`pcengine`|.pce .PCE .bin .BIN .zip .ZIP .7z .7Z|**retroarch:** beetle_pce_fast (default)<br>**retroarch:** beetle_pce<br>**retroarch:** beetle_supergrafx<br>|
|NEC|PC Engine CD (pcenginecd)|1988|`pcenginecd`|.cue .CUE .ccd .CCD .chd .CHD .toc .TOC .m3u .M3U|**retroarch:** beetle_pce_fast (default)<br>**retroarch:** beetle_pce<br>**retroarch:** beetle_supergrafx<br>|
|NEC|PC-8800 (pc-8800)|1981|`pc88`|.d88 .D88 .m3u .M3U|**retroarch:** quasi88 (default)<br>|
|NEC|PC-9800 (pc-9800)|1983|`pc98`|.d98 .zip .98d .fdi .fdd .2hd .tfd .d88 .88d .hdm .xdf .dup .hdi .thd .nhd .hdd .hdn|**retroarch:** np2kai (default)<br>|
|NEC|PC-FX (pcfx)|1994|`pcfx`|.chd .CHD .cue .CUE .ccd .CCD .toc .TOC|**retroarch:** beetle_pcfx (default)<br>|
|NEC|Super Grafx (supergrafx)|1989|`sgfx`|.pce .PCE .sgx .SGX .cue .CUE .ccd .CCD .chd .CHD .zip .ZIP .7z .7Z|**retroarch:** beetle_supergrafx<br>**retroarch:** beetle_pce<br>|
|NEC|TurboGrafx-16 (tg16)|1989|`tg16`|.pce .PCE .bin .BIN .zip .ZIP .7z .7Z|**retroarch:** beetle_pce_fast (default)<br>**retroarch:** beetle_pce<br>**retroarch:** beetle_supergrafx<br>|
|NEC|TurboGrafx-CD (tg16cd)|1989|`tg16cd`|.cue .CUE .ccd .CCD .chd .CHD .toc .TOC .m3u .M3U|**retroarch:** beetle_pce_fast (default)<br>**retroarch:** beetle_pce<br>**retroarch:** beetle_supergrafx<br>|
|Nesbox|TIC-80 (tic-80)|2017|`tic-80`|.tic .TIC|**retroarch:** tic80 (default)<br>|
|Nintendo|3DS (3ds)|2010|`3ds`|.3ds .3DS .3dsx .3DSX .elf .ELF .axf .AXF .cci .CCI .cxi .CXI .app .APP|**retroarch:** citra (default)<br>**citra:** citra-sa<br>|
|Nintendo|DS (nds)|2005|`nds`|.nds .zip .NDS .ZIP .7z|**retroarch:** melonds (default)<br>**retroarch:** desmume<br>**melonds:** melonds-sa<br>|
|Nintendo|Famicom (famicom)|1983|`famicom`|.nes .NES .unif .UNIF .unf .UNF .zip .ZIP .7z .7Z|**retroarch:** nestopia (default)<br>**retroarch:** fceumm<br>**retroarch:** quicknes<br>**retroarch:** mesen<br>|
|Nintendo|Famicom Disk System (fds)|1986|`fds`|.fds .FDS .zip .ZIP .7z .7Z|**retroarch:** nestopia (default)<br>**retroarch:** fceumm<br>**retroarch:** quicknes<br>|
|Nintendo|Game and Watch (gameandwatch)|1980|`gameandwatch`|.mgw .MGW .zip .ZIP .7z .7Z|**retroarch:** gw<br>|
|Nintendo|Game Boy (gb)|1989|`gb`|.gb .GB .gbc .GBC .zip .ZIP .7z .7Z|**retroarch:** gambatte (default)<br>**retroarch:** sameboy<br>**retroarch:** gearboy<br>**retroarch:** tgbdual<br>**retroarch:** mgba<br>**retroarch:** vbam<br>|
|Nintendo|Game Boy (Hacks) (gbh)|1989|`gbh`|.gb .GB .zip .ZIP .7z .7Z|**retroarch:** gambatte (default)<br>**retroarch:** sameboy<br>**retroarch:** gearboy<br>**retroarch:** tgbdual<br>**retroarch:** mgba<br>**retroarch:** vbam<br>|
|Nintendo|Game Boy Advance (gba)|2001|`gba`|.gba .GBA .zip .ZIP .7z .7Z|**retroarch:** mgba (default)<br>**retroarch:** gbsp<br>**retroarch:** vbam<br>**retroarch:** vba_next<br>**retroarch:** beetle_gba<br>|
|Nintendo|Game Boy Advance (Hacks) (gbah)|2001|`gbah`|.gba .GBA .zip .ZIP .7z .7Z|**retroarch:** mgba (default)<br>**retroarch:** gbsp<br>**retroarch:** vbam<br>**retroarch:** vba_next<br>**retroarch:** beetle_gba<br>|
|Nintendo|Game Boy Color (gbc)|1998|`gbc`|.gb .GB .gbc .GBC .zip .ZIP .7z .7Z|**retroarch:** gambatte (default)<br>**retroarch:** sameboy<br>**retroarch:** gearboy<br>**retroarch:** tgbdual<br>**retroarch:** mgba<br>**retroarch:** vbam<br>|
|Nintendo|Game Boy Color (Hacks) (gbch)|1998|`gbch`|.gb .GB .gbc .GBC .zip .ZIP .7z .7Z|**retroarch:** gambatte (default)<br>**retroarch:** sameboy<br>**retroarch:** gearboy<br>**retroarch:** tgbdual<br>**retroarch:** mgba<br>**retroarch:** vbam<br>|
|Nintendo|GameCube (gamecube)|2001|`gamecube`|.gcm .GCM .iso .ISO .gcz .GCZ .ciso .CISO .wbfs .WBFS .rvz .RVZ .dol .DOL|**dolphin:** dolphin-sa-gc (default)<br>**primehack:** primehack<br>**retroarch:** dolphin<br>|
|Nintendo|MSU-1 (snesmsu1)|2012|`snesmsu1`|.smc .SMC .fig .FIG .sfc .SFC .swc .SWC .zip .ZIP .7z .7Z|**retroarch:** snes9x (default)<br>**retroarch:** beetle_supafaust<br>|
|Nintendo|N64 (n64)|1996|`n64`|.z64 .Z64 .n64 .N64 .v64 .V64 .zip .ZIP .7z .7Z|**retroarch:** mupen64plus_next (default)<br>**retroarch:** mupen64plus<br>**retroarch:** parallel_n64<br>**mupen64plus-sa:** m64p_gliden64<br>**mupen64plus-sa:** m64p_gl64mk2<br>**mupen64plus-sa:** m64p_rice<br>|
|Nintendo|NES (Hacks) (nesh)|1985|`nesh`|.nes .NES .unif .UNIF .unf .UNF .zip .ZIP .7z .7Z|**retroarch:** nestopia (default)<br>**retroarch:** fceumm<br>**retroarch:** quicknes<br>**retroarch:** mesen<br>|
|Nintendo|NES (nes)|1985|`nes`|.nes .NES .unif .UNIF .unf .UNF .zip .ZIP .7z .7Z|**retroarch:** nestopia (default)<br>**retroarch:** fceumm<br>**retroarch:** quicknes<br>**retroarch:** mesen<br>|
|Nintendo|Pokémon Mini (pokemini)|2001|`pokemini`|.min .MIN .zip .ZIP .7z .7Z|**retroarch:** pokemini (default)<br>|
|Nintendo|Satellaview (satellaview)|1995|`satellaview`|.smc .SMC .fig .FIG .bs .BS .sfc .SFC .bsx .BSX .swc .SWC .zip .ZIP .7z .7Z|**retroarch:** snes9x (default)<br>**retroarch:** snes9x2010<br>**retroarch:** snes9x2002<br>**retroarch:** snes9x2005_plus<br>|
|Nintendo|Super Famicom (sfc)|1990|`sfc`|.smc .SMC .fig .FIG .sfc .SFC .swc .SWC .zip .ZIP .7z .7Z|**retroarch:** snes9x (default)<br>**retroarch:** snes9x2010<br>**retroarch:** snes9x2002<br>**retroarch:** snes9x2005_plus<br>**retroarch:** beetle_supafaust<br>**retroarch:** bsnes<br>**retroarch:** bsnes_mercury_performance<br>**retroarch:** bsnes_hd_beta<br>|
|Nintendo|Super Nintendo (Hacks) (snesh)|1991|`snesh`|.smc .SMC .fig .FIG .sfc .SFC .swc .SWC .zip .ZIP .7z .7Z|**retroarch:** snes9x (default)<br>**retroarch:** snes9x2010<br>**retroarch:** snes9x2002<br>**retroarch:** snes9x2005_plus<br>**retroarch:** beetle_supafaust<br>**retroarch:** bsnes<br>**retroarch:** bsnes_mercury_performance<br>**retroarch:** bsnes_hd_beta<br>|
|Nintendo|Super Nintendo (snes)|1991|`snes`|.smc .SMC .fig .FIG .sfc .SFC .swc .SWC .zip .ZIP .7z .7Z|**retroarch:** snes9x (default)<br>**retroarch:** snes9x2010<br>**retroarch:** snes9x2002<br>**retroarch:** snes9x2005_plus<br>**retroarch:** beetle_supafaust<br>**retroarch:** bsnes<br>**retroarch:** bsnes_mercury_performance<br>**retroarch:** bsnes_hd_beta<br>|
|Nintendo|switch (switch)|2017|`switch`|.xci .XCI .nsp .NSP .nca .NCA .nso .NSO .nro .NRO|**yuzu:** yuzu-sa (default)<br>**ryujinx:** ryujinx-sa<br>|
|Nintendo|Virtual Boy (virtualboy)|1995|`virtualboy`|.vb .VB .zip .ZIP .7z .7Z|**retroarch:** beetle_vb (default)<br>|
|Nintendo|Wii (wii)|2006|`wii`|.gcm .GCM .iso .ISO .gcz .GCZ .ciso .CISO .wbfs .WBFS .rvz .RVZ .dol .DOL .wad .WAD|**dolphin:** dolphin-sa-wii (default)<br>**primehack:** primehack<br>**retroarch:** dolphin<br>|
|Nintendo|Wii U (wiiu)|2012|`wiiu`|.wud .WUD .wux .WUX .wua .WUA|**cemu:** cemu-sa (default)<br>|
|Panasonic|3DO (3do)|1993|`3do`|.iso .ISO .bin .BIN .chd .CHD .cue .CUE|**retroarch:** opera (default)<br>|
|Philips|VideoPac (videopac)|1978|`videopac`|.bin .BIN .zip .ZIP .7z .7Z|**retroarch:** o2em (default)<br>|
|Sammy|Atomiswave (atomiswave)|2003|`atomiswave`|.lst .LST .bin .BIN .dat .DAT .zip .ZIP .7z .7Z|**retroarch:** flycast (default)<br>**flycast:** flycast-sa<br>|
|Sega|32X (sega32x)|1994|`sega32x`|.32x .32X .smd .SMD .bin .BIN .md .MD .zip .ZIP .7z .7Z|**retroarch:** picodrive (default)<br>|
|Sega|CD (segacd)|1991|`segacd`|.chd .CHD .cue .CUE .iso .ISO .m3u .M3U|**retroarch:** genesis_plus_gx (default)<br>**retroarch:** picodrive<br>|
|Sega|Dreamcast (dreamcast)|1998|`dreamcast`|.cdi .CDI .gdi .GDI .chd .CHD .m3u .M3U|**retroarch:** flycast2021<br>**retroarch:** flycast (default)<br>**flycast:** flycast-sa<br>|
|Sega|Game Gear (gamegear)|1990|`gamegear`|.bin .BIN .gg .GG .zip .ZIP .7z .7Z|**retroarch:** gearsystem (default)<br>**retroarch:** genesis_plus_gx<br>**retroarch:** picodrive<br>**retroarch:** smsplus<br>|
|Sega|Game Gear (Hacks) (ggh)|1990|`gamegearh`|.bin .BIN .gg .GG .zip .ZIP .7z .7Z|**retroarch:** gearsystem (default)<br>**retroarch:** genesis_plus_gx<br>**retroarch:** picodrive<br>**retroarch:** smsplus<br>|
|Sega|Genesis (genesis)|1989|`genesis`|.bin .BIN .gen .GEN .md .MD .sg .SG .smd .SMD .zip .ZIP .7z .7Z|**retroarch:** genesis_plus_gx (default)<br>**retroarch:** genesis_plus_gx_wide<br>**retroarch:** picodrive<br>|
|Sega|Genesis (Hacks) (genh)|1989|`genh`|.bin .BIN .gen .GEN .md .MD .sg .SG .smd .SMD .zip .ZIP .7z .7Z|**retroarch:** genesis_plus_gx (default)<br>**retroarch:** genesis_plus_gx_wide<br>**retroarch:** picodrive<br>|
|Sega|Master System (mastersystem)|1985|`mastersystem`|.bin .BIN .sms .SMS .zip .ZIP .7z .7Z|**retroarch:** gearsystem (default)<br>**retroarch:** genesis_plus_gx<br>**retroarch:** picodrive<br>**retroarch:** smsplus<br>|
|Sega|Mega Drive (megadrive)|1990|`megadrive`|.bin .BIN .gen .GEN .md .MD .sg .SG .smd .SMD .zip .ZIP .7z .7Z|**retroarch:** genesis_plus_gx (default)<br>**retroarch:** genesis_plus_gx_wide<br>**retroarch:** picodrive<br>|
|Sega|Mega Drive (megadrive-japan)|1988|`megadrive-japan`|.bin .BIN .gen .GEN .md .MD .sg .SG .smd .SMD .zip .ZIP .7z .7Z|**retroarch:** genesis_plus_gx (default)<br>**retroarch:** genesis_plus_gx_wide<br>**retroarch:** picodrive<br>|
|Sega|Mega-CD (megacd)|1991|`megacd`|.chd .CHD .cue .CUE .iso .ISO .m3u .M3U|**retroarch:** genesis_plus_gx (default)<br>**retroarch:** picodrive<br>|
|Sega|Naomi (naomi)|1998|`naomi`|.lst .LST .bin .BIN .dat .DAT .zip .ZIP .7z .7Z|**retroarch:** flycast2021<br>**retroarch:** flycast (default)<br>**flycast:** flycast-sa<br>|
|Sega|Saturn (saturn)|1994|`saturn`|.cue .CUE .chd .CHD .iso .ISO|**retroarch:** yabasanshiro (default)<br>**retroarch:** beetle_saturn<br>|
|Sega|SG-1000 (sg-1000)|1983|`sg-1000`|.bin .BIN .sg .SG .zip .ZIP .7z .7Z|**retroarch:** gearsystem (default)<br>**retroarch:** genesis_plus_gx<br>**retroarch:** picodrive<br>|
|Sharp|X1 (x1)|1982|`x1`|.dx1 .DX1 .2d .2D .2hd .2HD .tfd .TFD .d88 .D88 .88d .88D .hdm .HDM .xdf .XDF .dup .DUP .tap .TAP .cmd .CMD .zip .ZIP .7z .7Z|**retroarch:** x1 (default)<br>|
|Sharp|x68000 (x68000)|1987|`x68000`|.dim .DIM .img .IMG .d88 .D88 .88d .88D .hdm .HDM .dup .DUP .2hd .2HD .xdf .XDF .hdf .HDF .cmd .CMD .m3u .M3U .zip .ZIP .7z .7Z|**retroarch:** px68k (default)<br>|
|Sinclair|ZX Spectrum (zxspectrum)|1982|`zxspectrum`|.tzx .TZX .tap .TAP .z80 .Z80 .rzx .RZX .scl .SCL .trd .TRD .dsk .DSK .zip .ZIP .7z .7Z|**retroarch:** fuse<br>|
|Sinclair|ZX81 (zx81)|1981|`zx81`|.tzx .TZX .p .P .zip .ZIP .7z .7Z|**retroarch:** 81 (default)<br>|
|SNK|Neo Geo (neogeo)|1990|`neogeo`|.7z .7Z .zip .ZIP|**retroarch:** fbneo (default)<br>**retroarch:** mame2003_plus<br>**retroarch:** fbalpha2012<br>**retroarch:** fbalpha2019<br>**retroarch:** mame2010<br>**retroarch:** mame2015<br>**retroarch:** mame<br>|
|SNK|Neo Geo CD (neocd)|1990|`neocd`|.cue .CUE .iso .ISO .chd .CHD|**retroarch:** neocd (default)<br>**retroarch:** fbneo<br>|
|SNK|Neo Geo Pocket (ngp)|1998|`ngp`|.ngc .NGC .ngp .NGP .zip .ZIP .7z .7Z|**retroarch:** beetle_ngp (default)<br>**retroarch:** race<br>|
|SNK|Neo Geo Pocket Color (ngpc)|1999|`ngpc`|.ngc .NGC .zip .ZIP .7z .7Z|**retroarch:** beetle_ngp (default)<br>**retroarch:** race<br>|
|Sony|PlayStation (psx)|1994|`psx`|.bin .BIN .cue .CUE .img .IMG .mdf .MDF .pbp .PBP .toc .TOC .cbn .CBN .m3u .M3U .ccd .CCD .chd .CHD .iso .ISO|**retroarch:** beetle_psx (default)<br>**Duckstation:** duckstation-sa<br>**retroarch:** duckstation<br>**retroarch:** swanstation<br>|
|Sony|PlayStation 2 (ps2)|2000|`ps2`|.iso .ISO .mdf .MDF .nrg .NRG .bin .BIN .img .IMG .dump .DUMP .gz .GZ .cso .CSO .chd .CHD|**retroarch:** pcsx2 (default)<br>**pcsx2:** pcsx2-sa<br>|
|Sony|PlayStation 3 (ps3)|2006|`ps3`|.ps3 .PS3 .bin .BIN|**rpcs3:** rpcs3-sa (default)<br>|
|Sony|PlayStation Portable (psp)|2004|`psp`|.iso .ISO .cso .CSO .pbp .PBP|**ppsspp:** ppsspp-sa (default)<br>**retroarch:** ppsspp<br>|
|Sony|PSP Minis (pspminis)|2004|`pspminis`|.iso .ISO .cso .CSO .pbp .PBP|**ppsspp:** ppsspp-sa (default)<br>**retroarch:** ppsspp<br>|
|Sun Microsystems|J2ME (j2me)|2002|`j2me`|.jar .JAR|**retroarch:** freej2me (default)<br>|
|Various|EasyRPG (easyrpg)|2003|`easyrpg`|.zip .ZIP .easyrpg .EASYRPG .ldb .LDB|**retroarch:** easyrpg (default)<br>|
|Various|OpenBOR (openbor)|2008|`openbor`|.pak .PAK|**OpenBOR:** OpenBOR (default)<br>|
|Various|ScummVM (scummvm)|2001|`games`|.sh .SH .svm .SVM .scummvm|**scummvmsa:** scummvm (default)<br>**retroarch:** scummvm<br>|
|Watara|Supervision (supervision)|1992|`supervision`|.sv .SV .zip .ZIP .7z .7Z|**retroarch:** potator (default)<br>|
|Welback Holdings|Mega Duck (megaduck)|1993|`megaduck`|.bin .BIN .zip .ZIP .7z .7Z|**retroarch:** sameduck (default)<br>|

260
documentation/BUILDING.md Normal file
View file

@ -0,0 +1,260 @@
# Developing and Building JELOS
JELOS is a fairly unique distribution as it is *built to order* and only enough of the operating system and applications are built for the purpose of booting and executing emulators and ports. Developers and others who would like to contribute to our project should read and agree to the [Contributor Covenant Code of Conduct](https://github.com/JustEnoughLinuxOS/distribution/blob/main/CODE_OF_CONDUCT.md) and [Contributing to JELOS](https://github.com/JustEnoughLinuxOS/distribution/blob/main/CONTRIBUTING.md) guides before submitting your first contribution.
## Filesystem Structure
We have a simple filesystem structure adopted from parent distributions CoreELEC, LibreELEC, etc.
```
.
├── build.JELOS-DEVICE.ARCHITECTURE
├── config
├── distributions
├── Dockerfile
├── licenses
├── Makefile
├── packages
├── post-update
├── projects
├── release
├── scripts
├── sources
└── tools
```
**build.JELOS-DEVICE.ARCHITECTURE**
Build roots for each device and that devices architecture(s). For ARM devices JELOS builds and uses a 32bit root for several of the cores used in the 64bit distribution.
**config**
Contains functions utilized during the build process including architecture specific build flags, optimizations, and functions used throughout the build workflow.
**distributions**
Distributions contains distribution specific build flags and parameters and splash screens.
**Dockerfile**
Used to build the Ubuntu container used to build JELOS. The container is hosted at [https://hub.docker.com/u/justenoughlinuxos](https://hub.docker.com/u/justenoughlinuxos)
**licenses**
All of the licenses used throughout the distribution packages are hosted here. If you're adding a package that contains a license, make sure it is available in this directory before submitting the PR.
**Makefile**
Used to build one or more JELOS images, or to build and deploy the Ubuntu container.
**packages**
All of the package set that is used to develop and build JELOS are hosted within the packages directory. The package structure documentation is available in [PACKAGE.md](PACKAGE.md)
**post-update**
Anything that is necessary to be run on a device after an upgrade should be added here. Be sure to apply a guard to test that the change needs to be executed before execution.
**projects**
Hardware specific parameters are stored in the projects folder, anything that should not be included on every device during a world build should be isolated to the specific project or device here.
**release**
The output directory for all of the build images.
**scripts**
This directory contains all of the scripts used to fetch, extract, build, and release the distribution. Review Makefile for more details.
**sources**
As the distribution is being built, package source are fetched and hosted in this directory. They will persist after a `make clean`.
**tools**
The tools directory contains utility scripts that can be used during the development process, including a simple tool to burn an image to a usb drive or sdcard.
## Building JELOS
Building JELOS requires an Ubuntu 22.04 host with 200GB of free space for a single device, or 1TB of free space for a full world build. Other Linux distributions may be used when building using Docker, however this is untested and unsupported.
### Cloning the JELOS Sources
To build JELOS, start by cloning the project git repository.
```
cd ~
git clone https://github.com/JustEnoughLinuxOS/distribution.git
```
### Selecting the Desired Branch
Once you have cloned the repo, you will want to determine if you want to build the main branch which is more stable, or the development branch which is unstable but hosts our newest features.
|Branch|Purpose|
|----|----|
|main|Stable JELOS sources|
|dev|Unstable JELOS sources|
To check out our development branch, cd into the project directory and checkout `dev`.
```
cd distribution
git checkout dev
```
### Building with Docker
Building JELOS is easy, the fastest and most recommended method is to instruct the build to use Docker, this is only known to work on a Linux system. To build JELOS with Docker use the table below.
| Devices | Dependency | Docker Command |
| ---- | ---- | ---- |
|AMD64||```make docker-AMD64```|
|RK3588||```make docker-RK3588```|
|RK3326||```make docker-RK3326```|
|RK3566||```make docker-RK3566```|
|RK3566-X55||```make docker-RK3566-X55```|
|S922X||```make docker-S922X```|
|ALL DEVICES||```make docker-world```|
> Devices that list a dependency require the dependency to be built first as that build will be used as the root of the device you are building. This will be done automatically by the build tooling when you start a build for your device.
### Building Manually
To build JELOS manually, you will need several prerequisite host packages installed.
#### Distribution Packages
```
sudo apt install gcc make git unzip wget \
xz-utils libsdl2-dev libsdl2-mixer-dev libfreeimage-dev libfreetype6-dev libcurl4-openssl-dev \
rapidjson-dev libasound2-dev libgl1-mesa-dev build-essential libboost-all-dev cmake fonts-droid-fallback \
libvlc-dev libvlccore-dev vlc-bin texinfo premake4 golang libssl-dev curl patchelf \
xmlstarlet patchutils gawk gperf xfonts-utils default-jre python-is-python3 xsltproc libjson-perl \
lzop libncurses5-dev device-tree-compiler u-boot-tools rsync p7zip libparse-yapp-perl \
zip binutils-aarch64-linux-gnu dos2unix p7zip-full libvpx-dev bsdmainutils bc meson p7zip-full \
qemu-user-binfmt zstd parted imagemagick qemu-user-static ca-certificates curl gnupg
```
### Docker
```
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /etc/apt/keyrings/docker.gpg
sudo chmod a+r /etc/apt/keyrings/docker.gpg
echo \
"deb [arch="$(dpkg --print-architecture)" signed-by=/etc/apt/keyrings/docker.gpg] https://download.docker.com/linux/ubuntu \
"$(. /etc/os-release && echo "$VERSION_CODENAME")" stable" | \
sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
sudo apt update
sudo apt install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin
```
> Docker installation reference (source): https://docs.docker.com/engine/install/ubuntu/
Next, build the version of JELOS for your device. See the table above for dependencies.
```
make AMD64
```
### Building a single package
It is also possible to build individual packages.
```
DEVICE=AMD64 ARCH=x86_64 ./scripts/clean busybox
DEVICE=AMD64 ARCH=x86_64 ./scripts/build busybox
```
> Note: An EmulationStation package standalone build requires additional steps because its source code located in a separate repository, see instructions inside, [link](https://github.com/JustEnoughLinuxOS/distribution/blob/main/packages/ui/emulationstation/package.mk).
### Rightsized builds
JELOS supports various build variables which alter the behavior of the distribution for specific purposes including debugging, or hosting containers. The options are defined below and are passed on the make command line. Ex. `BASE_ONLY=true make docker-RK3566`.
|Build Option|Setting|Function|
|----|----|----|
|EMULATION_DEVICE|yes|Builds EmulationStation and all emulators, builds EmulationStation and NO emulators if false.|
|ENABLE_32BIT|yes|Builds a 32bit root and includes it in the image. Needed for 32bit cores and applications.|
|BASE_ONLY|false<sup>1</sup>|Builds only the bare minimum packages, includes Weston on supported devices. Does not build EmulationStation.|
|CONTAINER_SUPPORT|no|Builds support for running containers on JELOS|
> Note: <sup>1</sup> this property will change to yes/no for consistency in a future release.
### Special env variables
For development builds, you can use the following env variables to customize the image or change build time functionality. To make them globally available to the builds, add them to ${HOME}/.JELOS/options.
|Variable|Function|
|----|----|
|LOCAL_SSH_KEYS_FILE|Enables using ssh public keys for access without the root password.|
|LOCAL_WIFI_SSID|The SSID of the network the device should connect too automatically.|
|LOCAL_WIFI_KEY|The WIFI authentication key for the connection."|
|SCREENSCRAPER_DEV_LOGIN|Login information for screenscraper.fr.|
|GAMESDB_APIKEY|Login information for thegamesdb.net.|
|CHEEVOS_DEV_LOGIN|Login information for retroachievements.org.|
|CLEAN_PACKAGES|Allows specifying packages to clean during a build.|
#### SSH keys
```
export LOCAL_SSH_KEYS_FILE=~/.ssh/jelos/authorized_keys
```
#### WiFi SSID and password
```
export LOCAL_WIFI_SSID=MYWIFI
export LOCAL_WIFI_KEY=secret
```
#### Screenscraper, GamesDB, and RetroAchievements
To enable Screenscraper, GamesDB, and RetroAchievements, register at each site and apply the api keys in ${HOME}/.JELOS/options. Unsetting one of the variables will disable it in EmulationStation. This configuration is picked up by EmulationStation during the build.
```
# Apply for a Screenscraper API Key here: https://www.screenscraper.fr/forumsujets.php?frub=12&numpage=0
export SCREENSCRAPER_DEV_LOGIN="devid=DEVID&devpassword=DEVPASSWORD"
# Apply for a GamesDB API Key here: https://forums.thegamesdb.net/viewforum.php?f=10
export GAMESDB_APIKEY="APIKEY"
# Find your Cheevos Web API key here: https://retroachievements.org/controlpanel.php
export CHEEVOS_DEV_LOGIN="z=RETROACHIEVEMENTSUSERNAME&y=APIKEYID"
```
#### Cleaning additional packages
```
CLEAN_PACKAGES="linux ppsspp-sa" make AMD64
```
### Creating a patch for a package
It is common to have imported package source code modifed to fit the use case. It's recommended to use a special shell script to built it in case you need to iterate over it. See below.
```
cd sources/wireguard-linux-compat
tar -xvJf wireguard-linux-compat-v1.0.20211208.tar.xz
mv wireguard-linux-compat-v1.0.20211208 wireguard-linux-compat
cp -rf wireguard-linux-compat wireguard-linux-compat.orig
# Make your changes to wireguard-linux-compat
mkdir -p ../../packages/network/wireguard-linux-compat/patches/AMD64
# run from the sources dir
diff -rupN wireguard-linux-compat wireguard-linux-compat.orig >../../packages/network/wireguard-linux-compat/patches/AMD64/mychanges.patch
```
### Creating a patch for a package using git
If you are working with a git repository, building a patch for the distribution is simple. Rather than using `diff`, use `git diff`.
```
cd sources/emulationstation/emulationstation-098226b/
# Make your changes to EmulationStation
vim/emacs/vscode/notepad.exe
# Make the patch directory
mkdir -p ../../packages/ui/emulationstation/patches
# Run from the sources dir
git diff >../../packages/ui/emulationstation/patches/005-mypatch.patch
```
After patch is generated, one can rebuild an individual package, see section above. The build system will automatically pick up patch files from `patches` directory. For testing, one can either copy the built binary to the console or burn the whole image on SD card.
### Building an image with your patch
If you already have a build for your device made using the above process, it's simple to shortcut the build process and create an image to test your changes quickly using the process below.
```
# Update the package version for a new package, or apply your patch as above.
vim/emacs/vscode/notepad.exe
# Export the variables needed to complete your build, we'll assume you are building AMD64, update the device to match your configuration.
export OS_VERSION=$(date +%Y%m%d) BUILD_DATE=$(date)
export PROJECT=PC ARCH=x86_64 DEVICE=AMD64
# Clean the package you are building.
./scripts/clean emulationstation
# Build the package.
./scripts/build emulationstation
# Install the package into the build root.
./scripts/install emulationstation
# Generate an image with your new package.
./scripts/image mkimage
```

128
documentation/CODE_OF_CONDUCT.md Normal file
View file

@ -0,0 +1,128 @@
# Contributor Covenant Code of Conduct
## Our Pledge
We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, religion, or sexual identity
and orientation.
We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.
## Our Standards
Examples of behavior that contributes to a positive environment for our
community include:
* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the
overall community
Examples of unacceptable behavior include:
* The use of sexualized language or imagery, and sexual attention or
advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email
address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
## Enforcement Responsibilities
Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.
Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.
## Scope
This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
contact at jelos dot org.
All complaints will be reviewed and investigated promptly and fairly.
All community leaders are obligated to respect the privacy and security of the
reporter of any incident.
## Enforcement Guidelines
Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:
### 1. Correction
**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.
**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.
### 2. Warning
**Community Impact**: A violation through a single incident or series
of actions.
**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or
permanent ban.
### 3. Temporary Ban
**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.
**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.
### 4. Permanent Ban
**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.
**Consequence**: A permanent ban from any sort of public interaction within
the community.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).
[homepage]: https://www.contributor-covenant.org
For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.

39
documentation/CONTRIBUTING.md Normal file
View file

@ -0,0 +1,39 @@
# Contributing to JELOS
Welcome new contributor! Your contribution will help JELOS become a better Linux distribution, so thank you! We want to make contributing to this project as easy and transparent as possible. Contributors are able to:
- Discuss the current state of the code
- Submit a fix
- Propose new features
- Become a maintainer
## Becoming a maintainer
When contributing to JELOS you are expected to become the maintainer of your contribution. Please keep this in mind when submitting pull requests.
* Keep track of your contributions upstreams and keep your components up-to-date.
* Watch the issue tracker and resolve issues related to your contribution.
## We Develop with Github
We use Github to host code, to track issues and feature requests, as well as accept pull requests.
## We Use [Github Flow](https://guides.github.com/introduction/flow/index.html), So All Code Changes Happen Through Pull Requests
Pull requests are the best way to propose changes to the codebase (we use [Github Flow](https://guides.github.com/introduction/flow/index.html)). We actively welcome your pull requests:
1. Join our discord and chat with us, we'll be happy to help you successfully implement your change.
2. Fork the repo and create your branch from `dev`.
3. Ensure your code is built locally and tested.
4. Any changes should be reflected in the documentation.
5. Issue a pull request back to our `dev` branch.
## Any contributions you make will be under the Apache 2 Software License
In short, when you submit code changes, your submissions are understood to be contributed under the same license as the original project code or under [Apache 2](https://choosealicense.com/licenses/apache-2.0/) license when no other license applies.
## Use a Consistent Coding Style
* Follow the same style as the source you are editing.
* If you are contributing new code, keep the style consistent with other similar works.
* Parameterize as much as possible, try to avoid hard coded values whenever you can.
* Use 2 spaces for indentation rather than tabs when possible.
## License
By contributing, you agree that your contributions will be licensed under the license of the existing project code being modified or Apache 2.
## References
This document was adapted from the open-source contribution guidelines for [Facebook's Draft](https://github.com/facebook/draft-js/blob/a9316a723f9e918afde44dea68b5f9f39b7d9b00/CONTRIBUTING.md)

32
documentation/LICENSE.md Normal file
View file

@ -0,0 +1,32 @@
## Licenses
JELOS is a Linux distribution that is made up of many open-source components. Components are provided under their respective licenses. This distribution includes components licensed for non-commercial use only.
### JELOS Branding
JELOS branding and images are licensed under a [Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License](https://creativecommons.org/licenses/by-nc-sa/4.0/).
#### You are free to
* Share — copy and redistribute the material in any medium or format
* Adapt — remix, transform, and build upon the material
#### Under the following terms
* Attribution — You must give appropriate credit, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.
* NonCommercial — You may not use the material for commercial purposes.
* ShareAlike — If you remix, transform, or build upon the material, you must distribute your contributions under the same license as the original.
### JELOS Software
Copyright 2021-present Fewtarius
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
### Bundled Works
All other software is provided under each component's respective license. These licenses can be found in the software sources or in this project's licenses folder.

269
documentation/PACKAGE.md Normal file
View file

@ -0,0 +1,269 @@
# Structure of package.mk files
## Introduction
The package.mk file defines variables and functions to build a package.
## Variables
To control the build behaviour of your package, use variables in the top-down order listed here.
#### Base
| Variable | Default | Required |Description |
|-------------|---------|----------|------------|
| PKG_NAME | - | yes | Name of the packaged software application. Should be lowercase |
| PKG_VERSION | - | yes | Version of the packaged software application. If the version is a githash, please use the full githash, not the abbreviated form. |
| PKG_SHA256 | - | yes | SHA256 hashsum of the application download file |
| PKG_ARCH | any | no | Architectures for which the package builds. `any` or a space separated list of `aarch64`, `arm` or `x86_64` |
| PKG_LICENSE | - | yes | License of the software application. [Reference](https://github.com/JustEnoughLinuxOS/distribution/tree/main/licenses) |
| PKG_SITE | - | yes | Site of the software application |
| PKG_URL | - | yes | Address at which the source of the software application can be retrieved |
| PKG_MAINTAINER | - | no | Your name |
| PKG_DEPENDS_BOOTSTRAP<br>PKG_DEPENDS_HOST PKG_DEPENDS_INIT PKG_DEPENDS_TARGET | - | no | A space separated list of name of packages required to build the software application |
| PKG_SECTION | - | no | virtual if the package only defines dependencies |
| PKG_SHORTDESC | - | no<br>yes&nbsp;for&nbsp;addons | Short description of the software package |
| PKG_LONGDESC | - | yes | Long description of the package including purpose or function within JELOS or Kodi |
#### Universal Build Option
| Variable | Default | Required |Description |
|-------------|---------|----------|------------|
| PKG_SOURCE_DIR | - | no | Force the folder name that application sources are unpacked to. Used when sources do not automatically unpack to a folder with the `PKG_NAME-PKG_VERSION` naming convention. |
| PKG_SOURCE_NAME | - | no | Force the filename of the application sources. Used when the filename is not the basename of `PKG_URL` |
| PKG_PATCH_DIRS | - | no | Patches in `./patches` are automatically applied after package unpack. Use this option to include patches from an additional folder, e.g. `./patches/$PKG_PATCH_DIRS` |
| PKG_NEED_UNPACK | - | no | Space separated list of files or folders to include in package stamp calculation. If the stamp is invalidated through changes to package files or dependent files/folders the package is cleaned and rebuilt. e.g. `PKG_NEED_UNPACK="$(get_pkg_directory linux)"` will trigger clean/rebuild of a Linux kernel driver package when a change to the `linux` kernel package is detected. |
| PKG_TOOLCHAIN | auto | no | Control which build toolchain is used. For detailed information, see [reference](#toolchain-options). |
| PKG_BUILD_FLAGS | - | no | A space separated list of flags with which to fine-tune the build process. Flags can be enabled or disabled with a `+` or `-` prefix. For detailed information, see the [Reference](#build_flags-options). |
| PKG_PYTHON_VERSION | python2.7 | no | Define the Python version to be used. |
| PKG_IS_KERNEL_PKG | - | no | Set to `yes` for packages that include Linux kernel modules |
#### Meson Options
| Variable | Default | Required |Description |
|-------------|---------|----------|------------|
| PKG_MESON_SCRIPT | ${PKG_BUILD}/meson.build | no | Meson build file to use |
| PKG_MESON_OPTS_TARGET | - | no | Options directly passed to meson |
#### CMAKE Options
| Variable | Default | Required |Description |
|-------------|---------|----------|------------|
| PKG_CMAKE_SCRIPT | ${PKG_BUILD}/CMakeLists.txt | no | CMake build file to use |
| PKG_CMAKE_OPTS_HOST<br>PKG_CMAKE_OPTS_TARGET | - | no | Options directly passed to cmake |
#### Configure Options
| Variable | Default | Required |Description |
|-------------|---------|----------|------------|
| PKG_CONFIGURE_SCRIPT | ${PKG_BUILD}/configure | no | configure script to use |
| PKG_CONFIGURE_OPTS<br>PKG_CONFIGURE_OPTS_BOOTSTRAP<br>PKG_CONFIGURE_OPTS_HOST<br>PKG_CONFIGURE_OPTS_INIT<br>PKG_CONFIGURE_OPTS_TARGET | - | no | Options directly passed to configure |
#### Make Options
| Variable | Default | Required |Description |
|-------------|---------|----------|------------|
| PKG_MAKE_OPTS<br>PKG_MAKE_OPTS_BOOTSTRP<br>PKG_MAKE_OPTS_HOST<br>PKG_MAKE_OPTS_INIT<br> PKG_MAKE_OPTS_TARGET | - | no | Options directly passed to make in the build step
| PKG_MAKEINSTALL_OPTS_HOST<br>PKG_MAKEINSTALL_OPTS_TARGET | - | no | Options directly passed to make in the install step
#### Addons
Additional options used when the package builds an addon.
| Variable | Default | Required |Description |
|-------------|---------|----------|------------|
| PKG_REV | - | yes | The revision number of the addon (starts at 100). Must be placed after `PKG_VERSION`. Must be incremented for each new version else Kodi clients will not detect version change and download the updated addon. |
| PKG_IS_ADDON | no | yes | Must be set to `yes` <br>or to `embedded` when this addon is part of the image |
| PKG_ADDON_NAME | - | yes | Proper name of the addon that is shown at the repo |
| PKG_ADDON_TYPE | - | yes | See LE/config/addon/ for other possibilities |
| PKG_ADDON_VERSION | - | no | The version of the addon, used in addon.xml |
| PKG_ADDON_PROVIDES | - | no | [Provides](http://kodi.wiki/view/addon.xml#.3Cprovides.3E_element) in addon-xml |
| PKG_ADDON_REQUIRES | - | no | [Requires](http://kodi.wiki/view/addon.xml#.3Crequires.3E) used in addon.xml |
| PKG_ADDON_PROJECTS | @PROJECTS@ | no | for available projects or devices, see projects subdirectory (note: Use RPi for RPi project, and RPi1 for RPi device) |
| PKG_DISCLAIMER | - | no | [Disclaimer](https://kodi.wiki/view/Addon.xml#.3Cdisclaimer.3E) in addon-xml |
| PKG_ADDON_IS_STANDALONE | - | no | Defines if an addon depends on Kodi (on) or is standalone (yes) |
| PKG_ADDON_BROKEN | - | no | Marks an addon as broken for the user |
#### Detailed Information for Options
##### TOOLCHAIN options
Application/packages needs different toolchains for build.
For instance `cmake` or the classic `./configure` or same very different.
For the most application/packages, the auto-detection of the toolchain works proper.
But not always. To select a specific toolchain, you only need to set the `PKG_TOOLCHAIN` variable.
| Toolchain | Description (if needed) |
|----------- |-------------------------|
| meson | [Meson Build System](http://mesonbuild.com/) |
| cmake | [CMake](https://cmake.org/) with Ninja |
| cmake-make | [CMake](https://cmake.org/) with Make |
| autotools | [GNU Build System](https://en.wikipedia.org/wiki/GNU_Build_System)
| configure | preconfigured [GNU Build System](https://en.wikipedia.org/wiki/GNU_Build_System) |
| ninja | [Ninja Build](https://ninja-build.org/) |
| make | [Makefile Based](https://www.gnu.org/software/make/) |
| manual | only runs self writen build steps, see [Functions](#functions) |
###### Auto-Detection
The auto-detections looks for specific files in the source path.
1. `meson.build` (PKG_MESON_SCRIPT) => meson toolchain
2. `CMakeLists.txt` (PKG_CMAKE_SCRIPT) => cmake toolchain
3. `configure` (PKG_CONFIGURE_SCRIPT) => configure toolchain
4. `Makefile` => make toolchain
When none of these was found, the build abort and you have to set the toolchain via `PKG_TOOLCHAIN`
##### BUILD_FLAGS options
Build flags implement often used build options. Normally these are activated be default, but single applications/packages has problems to compile/run with these.
Set the variable `PKG_BUILD_FLAGS` in the `package.mk` to enable/disable the single flags. It is a space separated list. The flags can enabled with a `+` prefix, and disabled with a `-`.
| flag | default | affected stage | description |
|----------|----------|----------------|-------------|
| pic | disabled | target/init | [Position Independent Code](https://en.wikipedia.org/wiki/Position-independent_code) |
| pic:host | disabled | host/bootstrap | see above |
| lto | disabled | target/init | enable LTO (Link Time optimization) in the compiler and linker unless disabled via `LTO_SUPPORT`. Compiles non-fat LTO objects (only bytecode) and performs single-threaded optimization at link stage |
| lto-parallel | disabled | target/init | same as `lto` but enable parallel optimization at link stage. Only enable this if the package build doesn't run multiple linkers in parallel otherwise this can result in lots of parallel processes! |
| lto-fat | disabled | target/init | same as `lto` but compile fat LTO objects (bytecode plus optimized assembly). This increases compile time but can be useful to create static libraries suitable both for LTO and non-LTO linking |
| lto-off | disabled | target/init | explicitly disable LTO in the compiler and linker |
| gold | depend on `GOLD_SUPPORT` | target/init | can only disabled, use of the GOLD-Linker |
| parallel | enabled | all | `make` or `ninja` builds with multiple threads/processes (or not) |
| strip | enabled | target | strips executables (or not) |
###### Example
```
PKG_BUILD_FLAGS="+pic -gold"
PKG_BUILD_FLAGS="-parallel"
```
## Functions
All build steps in the JELOS build system are done by shell function.
These functions can overwritten in the `package.mk`. But this raises problems, when the build system is updated. To reduce the problem, most function was extended by `pre_` and `post_` scripts, to use instead.
When it is nesseary to replace configure, make and makeinstall, please use `PKG_TOOLCHAIN="manual"`.
Some of the build steps needs to be run once, like `unpack`. Other steps needs to be run multiple times, to create the toolchain (stage bootstrap & host) or to create the LE image (stage init & target). These stage specific functions have the stage as suffix, like `make_target`.
Full list of overwrittable functions.
| function | stages specific | description |
|-------------------------|--------|-------------|
| configure_package | - | Optional function to implement late binding variable assignment (see below) |
| unpack<br>pre_unpack<br>post_unpack | - | Extract the source from the downloaded file |
| pre_patch<br>post_patch | - | Apply the patches to the source, after extraction. The patch function it self is not allowed to overwritten |
| pre_build_\[stage] | yes | Runs before of the start of the build |
| pre_configure<br>pre_configure_\[stage]<br>configure_\[stage]<br>post_configure_\[stage] | yes | Configure the package for the compile. This is only relevant for toolchain, that supports it (e.g. meson, cmake, configure, manual) |
| make_\[stage]<br>pre_make_\[stage]<br>post_make_\[stage] | yes | Build of the package |
| makeinstall_\[stage]<br>pre_makeinstall_\[stage]<br>post_makeinstall_\[stage] | yes | Installation of the files in the correct pathes<br>host: TOOLCHAIN<br>target: SYSROOT and IMAGE<br>bootstrap and init: temporary destination
| addon | - | Copy all files together for addon creation. This is requiered for addons |
## Late Binding variable assignment
A package will be loaded only once, by the call to `config/options`. During this process, additional package specific variables will be initialised, such as:
* `PKG_BUILD` - path to the build folder
* `PKG_SOURCE_NAME` - if not already specified, generated from `PKG_URL`, `PKG_NAME` and` PKG_VERSION`
Since these variables will not exist at the time the package is loaded, they can only be referenced **after** package has loaded. This can be accomplished by referencing these variables in the `configure_package()` function which is executed once the additional variables have been assigned.
If necessary, the following variables would be configured in `configure_package()` as they are normally relative to `${PKG_BUILD}`:
```
PKG_CONFIGURE_SCRIPT
PKG_CMAKE_SCRIPT
PKG_MESON_SCRIPT
```
Further to this, toolchain variables that are defined in `setup_toolchain()` must not be referenced "globally" in the package as they will only be configured reliably after `setup_toolchain()` has been called during `scripts/build`. Any variable in the following list must instead be referenced in a package function such as `pre_build_*`, `pre_configure_*`, `pre_make_*` etc.:
```
TARGET_CFLAGS TARGET_CXXFLAGS TARGET_LDFLAGS
NINJA_OPTS MAKEFLAGS
DESTIMAGE
CC CXX CPP LD
AS AR NM RANLIB
OBJCOPY OBJDUMP
STRIP
CPPFLAGS CFLAGS CXXFLAGS LDFLAGS
PKG_CONFIG
PKG_CONFIG_PATH
PKG_CONFIG_LIBDIR
PKG_CONFIG_SYSROOT_DIR
PKG_CONFIG_ALLOW_SYSTEM_CFLAGS
PKG_CONFIG_ALLOW_SYSTEM_LIBS
CMAKE_CONF CMAKE
HOST_CC HOST_CXX HOSTCC HOSTCXX
CC_FOR_BUILD CXX_FOR_BUILD BUILD_CC BUILD_CXX
_python_sysroot _python_prefix _python_exec_prefix
```
Lastly, the following variables are assigned during `scripts/build` but some packages may need to use alternative values for these variables. To do so, the package must assign alternative values in `pre_build_*`/`pre_configure_*`/`pre_make_*` etc. functions as these functions will be called after the variables are initialised with default values in `scripts/build` but before they are used by `scripts/build`.
```
CMAKE_GENERATOR_NINJA
TARGET_CONFIGURE_OPTS
TARGET_CMAKE_OPTS
TARGET_MESON_OPTS
HOST_CONFIGURE_OPTS
HOST_CMAKE_OPTS
HOST_MESON_OPTS
INIT_CONFIGURE_OPTS
INIT_CMAKE_OPTS
INIT_MESON_OPTS
BOOTSTRAP_CONFIGURE_OPTS
BOOTSTRAP_CMAKE_OPTS
BOOTSTRAP_MESON_OPTS
```
#### Example
```
configure_package() {
# now we know where we're building, assign a value
PKG_CONFIGURE_SCRIPT="${PKG_BUILD}/gettext-tools/configure"
}
post_patch() {
# replace hardcoded stuff
sed -i ${PKG_CONFIGURE_SCRIPT} 's|hardcoded stuff|variable stuff|'
}
pre_configure_target() {
# add extra flag to toolchain default
CFLAGS="${CFLAGS} -DEXTRA_FLAG=yeah"
}
post_makeinstall_target() {
# remove unused executable, install what remains
rm ${INSTALL}/usr/bin/bigexecutable
}
```
#### tools/pkgcheck
Use `tools/pkgcheck` to verify packages. It detects the following issues:
Issue | Level | Meaning |
| :--- | :----: | ---- |
| late&nbsp;binding&nbsp;violation | FAIL | Late binding variables referenced outside of a function - see [late binding](https://github.com/JELOS/JELOS.tv/blob/master/packages/readme.md#late-binding-variable-assignment) |
| duplicate&nbsp;function&nbsp;def | FAIL | Function defined multiple times, only last definition will be used |
| bad&nbsp;func&nbsp;-&nbsp;missing&nbsp;brace | FAIL | Opening brace (`{`) for function definition should be on same line as the function def, ie. `pre_configure_target() {` |
| intertwined&nbsp;vars&nbsp;&&nbsp;funcs | WARN | Variable assignments and logic is intertwined with functions - this is cosmetic, but variables and logic should be specified before all functions |
| unknown&nbsp;function | WARN | Could be a misspelled function, ie. `per_configure_target() {` which might fail silently.|
| ignored&nbsp;depends&nbsp;assign | WARN | Values assigned to `PKG_DEPENDS_*` outside of the global section or `configure_package()` will be ignored. |
## Add a new package to the Image
1. Think about, why you need it in the image.
* new multimedia tool
* add a new network tool
* new kernel driver
* ...
2. Find a place in the packages tree
* look into the package tree structure, which is generally self explaind.
* do not place it in an existing package (directory that includes a `package.mk`)
* when you found a place, create a directory with the name of your package (use same value for `PKG_NAME`!!)
3. Create an initial `package.mk`
* you can find a template under `packages/package.mk.template`. Copy the template into the new directory and call it `package.mk`
* apply any required changes to your new `package.mk`
4. Find a place in the dependency tree
* when it extend an existing package, add it there to the `PKG_DEPENDS_TARGET`/`PKG_DEPENDS_HOST` etc.
* take a look into the path `packages/virtual`, there you should find a virtual packages, that match your new package (misc-packages should be the last option)
5. Now you can build your image
* after the build, inside the `build-*` folder you should find a directory with your package name and -version, eg. `widget-1.2.3`.

38
documentation/PULL_REQUEST_TEMPLATE.md Normal file
View file

@ -0,0 +1,38 @@
# Pull Request Template
## Description
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
Fixes # (issue)
## Type of change
Please delete options that are not relevant.
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] This change requires a documentation update
## How Has This Been Tested Locally?
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
- [ ] Test A
- [ ] Test B
**Test Configuration**:
* Build OS name and version:
* Docker (Y/N):
* JELOS Branch:
* Any additional information that may be useful:
## Checklist:
- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
Note: This PR template is adapted from [embeddedartistry](https://github.com/embeddedartistry/templates/blob/master/oss_docs/PULL_REQUEST_TEMPLATE.md)

69
documentation/README.md Normal file
View file

@ -0,0 +1,69 @@
&nbsp;&nbsp;<img src="https://raw.githubusercontent.com/JustEnoughLinuxOS/distribution/dev/distributions/JELOS/logos/jelos-logo.png" width=192>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[![Latest Version](https://img.shields.io/github/release/JustEnoughLinuxOS/distribution.svg?color=5998FF&label=latest%20version&style=flat-square)](https://github.com/JustEnoughLinuxOS/distribution/releases/latest) [![Activity](https://img.shields.io/github/commit-activity/m/JustEnoughLinuxOS/distribution?color=5998FF&style=flat-square)](https://github.com/JustEnoughLinuxOS/distribution/commits) [![Pull Requests](https://img.shields.io/github/issues-pr-closed/JustEnoughLinuxOS/distribution?color=5998FF&style=flat-square)](https://github.com/JustEnoughLinuxOS/distribution/pulls) [![Discord Server](https://img.shields.io/discord/948029830325235753?color=5998FF&label=chat&style=flat-square)](https://discord.gg/seTxckZjJy)
#
Just Enough Linux Operating System (JELOS) is an immutable Linux distribution for handheld gaming devices developed by a small community of enthusiasts. Our goal is to produce an operating system that has the features and capabilities that we need, and to have fun as we develop it.
## Licenses
JELOS is a Linux distribution that is made up of many open-source components. Components are provided under their respective licenses. This distribution includes components licensed for non-commercial use only.
### JELOS Branding
JELOS branding and images are licensed under a [Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License](https://creativecommons.org/licenses/by-nc-sa/4.0/).
#### You are free to
* Share — copy and redistribute the material in any medium or format
* Adapt — remix, transform, and build upon the material
#### Under the following terms
* Attribution — You must give appropriate credit, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.
* NonCommercial — You may not use the material for commercial purposes.
* ShareAlike — If you remix, transform, or build upon the material, you must distribute your contributions under the same license as the original.
### JELOS Software
Copyright 2021-present Fewtarius
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
## Flashing
* Download the latest [version of JELOS](https://github.com/JustEnoughLinuxOS/distribution/releases) (.img.gz) for your device.
* Decompress the image.
* Write the image to an SDCARD using an imaging tool. Common imaging tools include [Balena Etcher](https://www.balena.io/etcher/), [Raspberry Pi Imager](https://www.raspberrypi.com/software/), and [Win32 Disk Imager](https://sourceforge.net/projects/win32diskimager/). If you're skilled with the command line, dd works fine too.
## Installation
* JELOS includes an installation tool. The installation tool can be found in the tools menu.
## Upgrading
* Download and install the update online via the System Settings menu.
* Download the latest [version of JELOS](https://github.com/JustEnoughLinuxOS/distribution/releases) (.tar) for your device.
* Copy the update to your device over the network to your device's update share.
* Reboot the device, and the update will begin automatically.
## Network Access
* External services are disabled by default in stable builds. When enabled, the username for ssh and samba access is "root". The root password is generated during every boot, it can be found in the System Settings menu.
## Documentation
* [Home](https://github.com/JustEnoughLinuxOS/distribution/wiki)
* [Donating to JELOS](https://github.com/JustEnoughLinuxOS/distribution/wiki/Donating-to-JELOS)
* [Frequently asked Questions](https://github.com/JustEnoughLinuxOS/distribution/wiki/Frequently-Asked-Questions)
* [HotKeys](https://github.com/JustEnoughLinuxOS/distribution/wiki/Hotkeys)
* [Emulators and Game Engines](https://github.com/JustEnoughLinuxOS/distribution/wiki/JELOS-emulators-and-game-engines)
* [Moonlight Game Streaming](https://github.com/JustEnoughLinuxOS/distribution/wiki/Moonlight-Game-Streaming)
* [Performance and Battery Life Optimizations](https://github.com/JustEnoughLinuxOS/distribution/wiki/Performance-and-Battery-Life-Optimizations)
* [Using Cloud Drives](https://github.com/JustEnoughLinuxOS/distribution/wiki/Using-Cloud-Drives)
* [Tailscale VPN](https://github.com/JustEnoughLinuxOS/distribution/wiki/Tailscale-VPN)
* [Wireguard VPN](https://github.com/JustEnoughLinuxOS/distribution/wiki/WireGuard-VPN)
## Contributing
* [Developing and Building JELOS](https://github.com/JustEnoughLinuxOS/distribution/blob/dev/BUILDING.md)
## Credits
Like any Linux distribution, this project is not the work of one person. It is the work of many persons all over the world who have developed the open source bits without which this project could not exist. Special thanks to CoreELEC, LibreELEC, and to developers and contributors across the open source community.

108
documentation/RK3326/SUPPORTED_EMULATORS_AND_CORES.md Normal file
View file

@ -0,0 +1,108 @@
&nbsp;&nbsp;<img src="https://raw.githubusercontent.com/JustEnoughLinuxOS/distribution/dev/distributions/JELOS/logos/jelos-logo.png" width=192>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[![Latest Version](https://img.shields.io/github/release/JustEnoughLinuxOS/distribution.svg?color=5998FF&label=latest%20version&style=flat-square)](https://github.com/JustEnoughLinuxOS/distribution/releases/latest) [![Activity](https://img.shields.io/github/commit-activity/m/JustEnoughLinuxOS/distribution?color=5998FF&style=flat-square)](https://github.com/JustEnoughLinuxOS/distribution/commits) [![Pull Requests](https://img.shields.io/github/issues-pr-closed/JustEnoughLinuxOS/distribution?color=5998FF&style=flat-square)](https://github.com/JustEnoughLinuxOS/distribution/pulls) [![Discord Server](https://img.shields.io/discord/948029830325235753?color=5998FF&label=chat&style=flat-square)](https://discord.gg/seTxckZjJy)
#
|Manufacturer|System|Release Date|Games Path|Supported Extensions|Emulator / Core|
|----|----|----|----|----|----|
|Amstrad|CPC (amstradcpc)|1984|`amstradcpc`|.dsk .DSK .sna .SNA .tap .TAP .cdt .CDT .kcr .KCR .voc .VOC .m3u .M3U .zip .ZIP .7z .7Z|**retroarch:** crocods (default)<br>**retroarch:** cap32<br>|
|Arcade|Arcade (arcade)|1984|`arcade`|.zip .ZIP .7z .7Z|**retroarch:** mame2003_plus (default)<br>**retroarch:** mame2000<br>**retroarch:** mame2010<br>**retroarch:** mame2015<br>**retroarch:** fbneo<br>**retroarch:** fbalpha2012<br>**retroarch:** fbalpha2019<br>|
|Arcade|Daphne (daphne)|1996|`daphne`|.daphne .DAPHNE .zip .ZIP|**hypseus:** hypseus (default)<br>**retroarch:** daphne<br>|
|Arcade|Final Burn Neo (fbn)|1986|`fbneo`|.7z .zip .7Z .ZIP|**retroarch:** fbneo (default)<br>**retroarch:** mame2003_plus<br>**retroarch:** mame2010<br>**retroarch:** mame2015<br>**retroarch:** mame<br>**retroarch:** fbalpha2012<br>**retroarch:** fbalpha2019<br>|
|Arcade|MAME (mame)|1989|`mame`|.7z .7Z .zip .ZIP|**retroarch:** mame2003_plus (default)<br>**retroarch:** mame2010<br>**retroarch:** mame2015<br>**retroarch:** mame<br>**retroarch:** fbneo<br>**retroarch:** fbalpha2012<br>**retroarch:** fbalpha2019<br>|
|Atari|2600 (atari2600)|1977|`atari2600`|.a26 .A26 .bin .BIN .zip .ZIP .7z .7Z|**retroarch:** stella (default)<br>|
|Atari|5200 (atari5200)|1982|`atari5200`|.rom .ROM .xfd .XFD .atr .ATR .atx .ATX .cdm .CDM .cas .CAS .car .CAR .bin .BIN .a52 .A52 .xex .XEX .zip .ZIP .7z .7Z|**retroarch:** a5200 (default)<br>**retroarch:** atari800<br>|
|Atari|7800 (atari7800)|1986|`atari7800`|.a78 .A78 .bin .BIN .zip .ZIP .7z .7Z|**retroarch:** prosystem (default)<br>|
|Atari|Atari 800 (atari800)|1979|`atari800`|.rom .ROM .xfd .XFD .atr .ATR .atx .ATX .cdm .CDM .cas .CAS .car .CAR .bin .BIN .a52 .A52 .xex .XEX .zip .ZIP .7z .7Z|**retroarch:** atari800 (default)<br>|
|Atari|Atari ST (atarist)|1985|`atarist`|.st .ST .msa .MSA .stx .STX .dim .DIM .ipf .IPF .m3u .M3U .zip .ZIP .7z .7Z|**retroarch:** hatari (default)<br>**hatarisa:** hatarisa<br>|
|Atari|Jaguar (atarijaguar)|1993|`atarijaguar`|.j64 .J64 .jag .JAG .rom .ROM .abs .ABS .cof .COF .bin .BIN .prg .PRG|**retroarch:** virtualjaguar (default)<br>|
|Atari|Lynx (atarilynx)|1989|`atarilynx`|.lnx .LNX .o .O .zip .ZIP .7z .7Z|**retroarch:** handy (default)<br>**retroarch:** beetle_lynx<br>|
|Bandai|SuFami Turbo (sufami)|1996|`sufami`|.st .ST .zip .ZIP .7z .7Z|**retroarch:** snes9x (default)<br>|
|Bandai|Wonderswan (wonderswan)|1999|`wonderswan`|.ws .WS .zip .ZIP .7z .7Z|**retroarch:** beetle_wswan (default)<br>|
|Bandai|Wonderswan Color (wonderswancolor)|2000|`wonderswancolor`|.wsc .WSC .zip .ZIP .7z .7Z|**retroarch:** beetle_wswan (default)<br>|
|belogic|Uzebox (uzebox)|2008|`uzebox`|.uze .UZE|**retroarch:** uzem (default)<br>|
|Capcom|PlaySystem 1 (cps1)|1988|`cps1`|.zip .ZIP .7z .7Z|**retroarch:** fbneo (default)<br>**retroarch:** mame2003_plus<br>**retroarch:** mame2010<br>**retroarch:** fbalpha2012<br>**retroarch:** mba_mini<br>**AdvanceMame:** AdvanceMame<br>|
|Capcom|PlaySystem 2 (cps2)|1993|`cps2`|.zip .ZIP .7z .7Z|**retroarch:** fbneo (default)<br>**retroarch:** mame2003_plus<br>**retroarch:** mame2010<br>**retroarch:** fbalpha2012<br>**retroarch:** mba_mini<br>**AdvanceMame:** AdvanceMame<br>|
|Capcom|PlaySystem 3 (cps3)|1996|`cps3`|.zip .ZIP .7z .7Z|**retroarch:** fbneo (default)<br>**retroarch:** mame2003_plus<br>**retroarch:** mame2010<br>**retroarch:** fbalpha2012<br>**retroarch:** mba_mini<br>**AdvanceMame:** AdvanceMame<br>|
|Coleco|ColecoVision (colecovision)|1982|`coleco`|.bin .BIN .col .COL .rom .ROM .zip .ZIP .7z .7Z|**retroarch:** bluemsx (default)<br>**retroarch:** gearcoleco<br>**retroarch:** smsplus<br>|
|Commodore|Amiga (amiga)|1985|`amiga`|.zip .ZIP .adf .ADF .uae .UAE .ipf .IPF .dms .DMS .adz .ADZ .lha .LHA .m3u .M3U .hdf .HDF .hdz .HDZ|**retroarch:** puae (default)<br>**amiberry:** false<br>|
|Commodore|Amiga CD32 (amigacd32)|1994|`amigacd32`|.iso .ISO .cue .CUE .lha .LHA .chd .CHD|**retroarch:** puae (default)<br>**retroarch:** uae4arm<br>|
|Commodore|C128 (c128)|1985|`c128`|.d64 .D64 .d71 .D71 .d80 .D80 .d81 .D81 .d82 .D82 .g64 .G64 .g41 .G41 .x64 .X64 .t64 .T64 .tap .TAP .prg .PRG .p00 .P00 .crt .CRT .bin .BIN .d6z .D6Z .d7z .D7Z .d8z .D8Z .g6z .G6Z .g4z .G4Z .x6z .X6Z .cmd .CMD .m3u .M3U .vsf .VSF .nib .NIB .nbz .NBZ .zip .ZIP|**retroarch:** vice_x128 (default)<br>**vicesa:** x128<br>|
|Commodore|C16 (c16)|1984|`c16`|.d64 .D64 .d71 .D71 .d80 .D80 .d81 .D81 .d82 .D82 .g64 .G64 .g41 .G41 .x64 .X64 .t64 .T64 .tap .TAP .prg .PRG .p00 .P00 .crt .CRT .bin .BIN .d6z .D6Z .d7z .D7Z .d8z .D8Z .g6z .G6Z .g4z .G4Z .x6z .X6Z .cmd .CMD .m3u .M3U .vsf .VSF .nib .NIB .nbz .NBZ .zip .ZIP|**retroarch:** vice_xplus4 (default)<br>**vicesa:** xplus4<br>|
|Commodore|C64 (c64)|1982|`c64`|.d64 .D64 .d71 .D71 .d80 .D80 .d81 .D81 .d82 .D82 .g64 .G64 .g41 .G41 .x64 .X64 .t64 .T64 .tap .TAP .prg .PRG .p00 .P00 .crt .CRT .bin .BIN .d6z .D6Z .d7z .D7Z .d8z .D8Z .g6z .G6Z .g4z .G4Z .x6z .X6Z .cmd .CMD .m3u .M3U .vsf .VSF .nib .NIB .nbz .NBZ .zip .ZIP|**retroarch:** vice_x64 (default)<br>**vicesa:** x64sc<br>|
|Commodore|Commodore PET (pet)|1977|`pet`|.20 .40 .60 .a0 .b0 .d64 .d71 .d80 .d81 .d82 .g64 .g41 .x64 .t64 .tap .prg .p00 .crt .bin .gz .d6z .d7z .d8z .g6z .g4z .x6z .cmd .m3u .vsf .nib .nbz .zip|**retroarch:** vice_xpet (default)<br>|
|Commodore|VIC-20 (vic20)|1980|`vic20`|.20 .40 .60 .a0 .A0 .b0 .B0 .d64 .D64 .d71 .D71 .d80 .D80 .d81 .D81 .d82 .D82 .g64 .G64 .g41 .G41 .x64 .X64 .t64 .T64 .tap .TAP .prg .PRG .p00 .P00 .crt .CRT .bin .BIN .gz .GZ .d6z .D6Z .d7z .D7Z .d8z .D8Z .g6z .G6Z .g4z .G4Z .x6z .X6Z .cmd .CMD .m3u .M3U .vsf .VSF .nib .NIB .nbz .NBZ .zip .ZIP|**retroarch:** vice_xvic (default)<br>**vicesa:** vice_xvic<br>|
|Fairchild|Channel F (channelf)|1976|`channelf`|.bin .BIN .chf .CHF .zip .ZIP .7z .7Z|**retroarch:** freechaf (default)<br>|
|id Software|Doom (doom)|1993|`doom`|.doom|**gzdoom:** gzdoom-sa (default)<br>|
|JELOS|Moonlight Game Streaming (moonlight)|2021|`moonlight`|.sh .SH||
|JELOS|MPlayer (mplayer)|unknown|`mplayer`|.mp4 .MP4 .mkv .MKV .avi .AVI .mov .MOV .wmv .WMV .m3u .M3U .mpg .MPG .ytb .YTB .twi .TWI .sh .SH .mp3 .MP3 .aac .AAC .mka .MKA .dts .DTS .flac .FLAC .ogg .OGG .m4a .M4A .ac3 .AC3 .opus .OPUS .wav .WAV .wv .WV .eac3 .EAC3 .thd .THD|**mplayer:** mplayer (default)<br>|
|JELOS|Ports (ports)|2021|`ports`|.sh .SH||
|JELOS|Screenshots (imageviewer)|2021|`screenshots`|.jpg .jpeg .png .bmp .psd .tga .gif .hdr .pic .ppm .pgm .mkv .pdf .mp4 .avi||
|JELOS|Tools (tools)|2021|`modules`|.sh||
|Lexaloffle|PICO-8 (pico-8)|2015|`pico-8`|.sh .p8 .png .SH .P8 .PNG|**pico-8:** pico8 (default)<br>**retroarch:** fake08<br>|
|Magnavox|Odyssey (odyssey2)|1979|`odyssey`|.bin .BIN .zip .ZIP .7z .7Z|**retroarch:** o2em (default)<br>|
|Mattel|Intellivision (intellivision)|1979|`intellivision`|.int .INT .bin .BIN .rom .ROM .zip .ZIP .7z .7Z|**retroarch:** freeintv (default)<br>|
|Microsoft|MS-DOS (pc)|1981|`pc`|.com .COM .bat .BAT .exe .EXE .dosz .DOSZ|**retroarch:** dosbox_pure<br>**retroarch:** dosbox_svn<br>|
|Microsoft|MSX (msx)|1983|`msx`|.dsk .DSK .mx1 .MX1 .mx2 .MX2 .rom .ROM .zip .ZIP .7z .7Z .M3U .m3u|**retroarch:** bluemsx (default)<br>**retroarch:** fmsx<br>|
|Microsoft|MSX2 (msx2)|1988|`msx2`|.dsk .DSK .mx1 .MX1 .mx2 .MX2 .rom .ROM .zip .ZIP .7z .7Z .M3U .m3u|**retroarch:** bluemsx (default)<br>**retroarch:** fmsx<br>|
|Milton Bradley|Vectrex (vectrex)|1982|`vectrex`|.bin .BIN .gam .GAM .vec .VEC .zip .ZIP .7z .7Z|**retroarch:** vecx (default)<br>|
|NEC|PC Engine (pcengine)|1987|`pcengine`|.pce .PCE .bin .BIN .zip .ZIP .7z .7Z|**retroarch:** beetle_pce_fast (default)<br>**retroarch:** beetle_pce<br>**retroarch:** beetle_supergrafx<br>|
|NEC|PC Engine CD (pcenginecd)|1988|`pcenginecd`|.cue .CUE .ccd .CCD .chd .CHD .toc .TOC .m3u .M3U|**retroarch:** beetle_pce_fast (default)<br>**retroarch:** beetle_pce<br>**retroarch:** beetle_supergrafx<br>|
|NEC|PC-8800 (pc-8800)|1981|`pc88`|.d88 .D88 .m3u .M3U|**retroarch:** quasi88 (default)<br>|
|NEC|PC-9800 (pc-9800)|1983|`pc98`|.d98 .zip .98d .fdi .fdd .2hd .tfd .d88 .88d .hdm .xdf .dup .hdi .thd .nhd .hdd .hdn|**retroarch:** np2kai (default)<br>|
|NEC|PC-FX (pcfx)|1994|`pcfx`|.chd .CHD .cue .CUE .ccd .CCD .toc .TOC|**retroarch:** beetle_pcfx (default)<br>|
|NEC|Super Grafx (supergrafx)|1989|`sgfx`|.pce .PCE .sgx .SGX .cue .CUE .ccd .CCD .chd .CHD .zip .ZIP .7z .7Z|**retroarch:** beetle_supergrafx<br>**retroarch:** beetle_pce<br>|
|NEC|TurboGrafx-16 (tg16)|1989|`tg16`|.pce .PCE .bin .BIN .zip .ZIP .7z .7Z|**retroarch:** beetle_pce_fast (default)<br>**retroarch:** beetle_pce<br>**retroarch:** beetle_supergrafx<br>|
|NEC|TurboGrafx-CD (tg16cd)|1989|`tg16cd`|.cue .CUE .ccd .CCD .chd .CHD .toc .TOC .m3u .M3U|**retroarch:** beetle_pce_fast (default)<br>**retroarch:** beetle_pce<br>**retroarch:** beetle_supergrafx<br>|
|Nesbox|TIC-80 (tic-80)|2017|`tic-80`|.tic .TIC|**retroarch:** tic80 (default)<br>|
|Nintendo|DS (nds)|2005|`nds`|.nds .zip .NDS .ZIP .7z|**drastic:** drastic-sa (default)<br>**retroarch:** melonds<br>|
|Nintendo|Famicom (famicom)|1983|`famicom`|.nes .NES .unif .UNIF .unf .UNF .zip .ZIP .7z .7Z|**retroarch:** nestopia (default)<br>**retroarch:** fceumm<br>**retroarch:** quicknes<br>**retroarch:** mesen<br>|
|Nintendo|Famicom Disk System (fds)|1986|`fds`|.fds .FDS .zip .ZIP .7z .7Z|**retroarch:** nestopia (default)<br>**retroarch:** fceumm<br>**retroarch:** quicknes<br>|
|Nintendo|Game and Watch (gameandwatch)|1980|`gameandwatch`|.mgw .MGW .zip .ZIP .7z .7Z|**retroarch:** gw<br>|
|Nintendo|Game Boy (gb)|1989|`gb`|.gb .GB .gbc .GBC .zip .ZIP .7z .7Z|**retroarch:** gambatte (default)<br>**retroarch:** sameboy<br>**retroarch:** gearboy<br>**retroarch:** tgbdual<br>**retroarch:** mgba<br>**retroarch:** vbam<br>|
|Nintendo|Game Boy (Hacks) (gbh)|1989|`gbh`|.gb .GB .zip .ZIP .7z .7Z|**retroarch:** gambatte (default)<br>**retroarch:** sameboy<br>**retroarch:** gearboy<br>**retroarch:** tgbdual<br>**retroarch:** mgba<br>**retroarch:** vbam<br>|
|Nintendo|Game Boy Advance (gba)|2001|`gba`|.gba .GBA .zip .ZIP .7z .7Z|**retroarch:** mgba (default)<br>**retroarch:** gbsp<br>**retroarch:** vbam<br>**retroarch:** vba_next<br>**retroarch:** beetle_gba<br>|
|Nintendo|Game Boy Advance (Hacks) (gbah)|2001|`gbah`|.gba .GBA .zip .ZIP .7z .7Z|**retroarch:** mgba (default)<br>**retroarch:** gbsp<br>**retroarch:** vbam<br>**retroarch:** vba_next<br>**retroarch:** beetle_gba<br>|
|Nintendo|Game Boy Color (gbc)|1998|`gbc`|.gb .GB .gbc .GBC .zip .ZIP .7z .7Z|**retroarch:** gambatte (default)<br>**retroarch:** sameboy<br>**retroarch:** gearboy<br>**retroarch:** tgbdual<br>**retroarch:** mgba<br>**retroarch:** vbam<br>|
|Nintendo|Game Boy Color (Hacks) (gbch)|1998|`gbch`|.gb .GB .gbc .GBC .zip .ZIP .7z .7Z|**retroarch:** gambatte (default)<br>**retroarch:** sameboy<br>**retroarch:** gearboy<br>**retroarch:** tgbdual<br>**retroarch:** mgba<br>**retroarch:** vbam<br>|
|Nintendo|MSU-1 (snesmsu1)|2012|`snesmsu1`|.smc .SMC .fig .FIG .sfc .SFC .swc .SWC .zip .ZIP .7z .7Z|**retroarch:** snes9x (default)<br>**retroarch:** beetle_supafaust<br>|
|Nintendo|N64 (n64)|1996|`n64`|.z64 .Z64 .n64 .N64 .v64 .V64 .zip .ZIP .7z .7Z|**retroarch:** mupen64plus_next (default)<br>**retroarch:** mupen64plus<br>**retroarch:** parallel_n64<br>**mupen64plus-sa:** m64p_gliden64<br>**mupen64plus-sa:** m64p_gl64mk2<br>**mupen64plus-sa:** m64p_rice<br>|
|Nintendo|NES (Hacks) (nesh)|1985|`nesh`|.nes .NES .unif .UNIF .unf .UNF .zip .ZIP .7z .7Z|**retroarch:** nestopia (default)<br>**retroarch:** fceumm<br>**retroarch:** quicknes<br>**retroarch:** mesen<br>|
|Nintendo|NES (nes)|1985|`nes`|.nes .NES .unif .UNIF .unf .UNF .zip .ZIP .7z .7Z|**retroarch:** nestopia (default)<br>**retroarch:** fceumm<br>**retroarch:** quicknes<br>**retroarch:** mesen<br>|
|Nintendo|Pokémon Mini (pokemini)|2001|`pokemini`|.min .MIN .zip .ZIP .7z .7Z|**retroarch:** pokemini (default)<br>|
|Nintendo|Satellaview (satellaview)|1995|`satellaview`|.smc .SMC .fig .FIG .bs .BS .sfc .SFC .bsx .BSX .swc .SWC .zip .ZIP .7z .7Z|**retroarch:** snes9x (default)<br>**retroarch:** snes9x2010<br>**retroarch:** snes9x2002<br>**retroarch:** snes9x2005_plus<br>|
|Nintendo|Super Famicom (sfc)|1990|`sfc`|.smc .SMC .fig .FIG .sfc .SFC .swc .SWC .zip .ZIP .7z .7Z|**retroarch:** snes9x (default)<br>**retroarch:** snes9x2010<br>**retroarch:** snes9x2002<br>**retroarch:** snes9x2005_plus<br>**retroarch:** beetle_supafaust<br>**retroarch:** bsnes<br>**retroarch:** bsnes_mercury_performance<br>**retroarch:** bsnes_hd_beta<br>|
|Nintendo|Super Nintendo (Hacks) (snesh)|1991|`snesh`|.smc .SMC .fig .FIG .sfc .SFC .swc .SWC .zip .ZIP .7z .7Z|**retroarch:** snes9x (default)<br>**retroarch:** snes9x2010<br>**retroarch:** snes9x2002<br>**retroarch:** snes9x2005_plus<br>**retroarch:** beetle_supafaust<br>**retroarch:** bsnes<br>**retroarch:** bsnes_mercury_performance<br>**retroarch:** bsnes_hd_beta<br>|
|Nintendo|Super Nintendo (snes)|1991|`snes`|.smc .SMC .fig .FIG .sfc .SFC .swc .SWC .zip .ZIP .7z .7Z|**retroarch:** snes9x (default)<br>**retroarch:** snes9x2010<br>**retroarch:** snes9x2002<br>**retroarch:** snes9x2005_plus<br>**retroarch:** beetle_supafaust<br>**retroarch:** bsnes<br>**retroarch:** bsnes_mercury_performance<br>**retroarch:** bsnes_hd_beta<br>|
|Nintendo|Virtual Boy (virtualboy)|1995|`virtualboy`|.vb .VB .zip .ZIP .7z .7Z|**retroarch:** beetle_vb (default)<br>|
|Panasonic|3DO (3do)|1993|`3do`|.iso .ISO .bin .BIN .chd .CHD .cue .CUE|**retroarch:** opera (default)<br>|
|Philips|VideoPac (videopac)|1978|`videopac`|.bin .BIN .zip .ZIP .7z .7Z|**retroarch:** o2em (default)<br>|
|Sammy|Atomiswave (atomiswave)|2003|`atomiswave`|.lst .LST .bin .BIN .dat .DAT .zip .ZIP .7z .7Z|**retroarch:** flycast2021<br>**retroarch:** flycast32 (default)<br>**retroarch:** flycast<br>**flycast:** flycast-sa<br>|
|Sega|32X (sega32x)|1994|`sega32x`|.32x .32X .smd .SMD .bin .BIN .md .MD .zip .ZIP .7z .7Z|**retroarch:** picodrive (default)<br>|
|Sega|CD (segacd)|1991|`segacd`|.chd .CHD .cue .CUE .iso .ISO .m3u .M3U|**retroarch:** genesis_plus_gx (default)<br>**retroarch:** picodrive<br>|
|Sega|Dreamcast (dreamcast)|1998|`dreamcast`|.cdi .CDI .gdi .GDI .chd .CHD .m3u .M3U|**retroarch:** flycast2021<br>**retroarch:** flycast32 (default)<br>**retroarch:** flycast<br>**flycast:** flycast-sa<br>|
|Sega|Game Gear (gamegear)|1990|`gamegear`|.bin .BIN .gg .GG .zip .ZIP .7z .7Z|**retroarch:** gearsystem (default)<br>**retroarch:** genesis_plus_gx<br>**retroarch:** picodrive<br>**retroarch:** smsplus<br>|
|Sega|Game Gear (Hacks) (ggh)|1990|`gamegearh`|.bin .BIN .gg .GG .zip .ZIP .7z .7Z|**retroarch:** gearsystem (default)<br>**retroarch:** genesis_plus_gx<br>**retroarch:** picodrive<br>**retroarch:** smsplus<br>|
|Sega|Genesis (genesis)|1989|`genesis`|.bin .BIN .gen .GEN .md .MD .sg .SG .smd .SMD .zip .ZIP .7z .7Z|**retroarch:** genesis_plus_gx (default)<br>**retroarch:** genesis_plus_gx_wide<br>**retroarch:** picodrive<br>|
|Sega|Genesis (Hacks) (genh)|1989|`genh`|.bin .BIN .gen .GEN .md .MD .sg .SG .smd .SMD .zip .ZIP .7z .7Z|**retroarch:** genesis_plus_gx (default)<br>**retroarch:** genesis_plus_gx_wide<br>**retroarch:** picodrive<br>|
|Sega|Master System (mastersystem)|1985|`mastersystem`|.bin .BIN .sms .SMS .zip .ZIP .7z .7Z|**retroarch:** gearsystem (default)<br>**retroarch:** genesis_plus_gx<br>**retroarch:** picodrive<br>**retroarch:** smsplus<br>|
|Sega|Mega Drive (megadrive)|1990|`megadrive`|.bin .BIN .gen .GEN .md .MD .sg .SG .smd .SMD .zip .ZIP .7z .7Z|**retroarch:** genesis_plus_gx (default)<br>**retroarch:** genesis_plus_gx_wide<br>**retroarch:** picodrive<br>|
|Sega|Mega Drive (megadrive-japan)|1988|`megadrive-japan`|.bin .BIN .gen .GEN .md .MD .sg .SG .smd .SMD .zip .ZIP .7z .7Z|**retroarch:** genesis_plus_gx (default)<br>**retroarch:** genesis_plus_gx_wide<br>**retroarch:** picodrive<br>|
|Sega|Mega-CD (megacd)|1991|`megacd`|.chd .CHD .cue .CUE .iso .ISO .m3u .M3U|**retroarch:** genesis_plus_gx (default)<br>**retroarch:** picodrive<br>|
|Sega|Naomi (naomi)|1998|`naomi`|.lst .LST .bin .BIN .dat .DAT .zip .ZIP .7z .7Z|**retroarch:** flycast2021<br>**retroarch:** flycast32 (default)<br>**retroarch:** flycast<br>**flycast:** flycast-sa<br>|
|Sega|Saturn (saturn)|1994|`saturn`|.cue .CUE .chd .CHD .iso .ISO|**yabasanshiro:** yabasanshiro-sa (default)<br>**retroarch:** yabasanshiro<br>**retroarch:** beetle_saturn<br>|
|Sega|SG-1000 (sg-1000)|1983|`sg-1000`|.bin .BIN .sg .SG .zip .ZIP .7z .7Z|**retroarch:** gearsystem (default)<br>**retroarch:** genesis_plus_gx<br>**retroarch:** picodrive<br>|
|Sharp|X1 (x1)|1982|`x1`|.dx1 .DX1 .2d .2D .2hd .2HD .tfd .TFD .d88 .D88 .88d .88D .hdm .HDM .xdf .XDF .dup .DUP .tap .TAP .cmd .CMD .zip .ZIP .7z .7Z|**retroarch:** x1 (default)<br>|
|Sharp|x68000 (x68000)|1987|`x68000`|.dim .DIM .img .IMG .d88 .D88 .88d .88D .hdm .HDM .dup .DUP .2hd .2HD .xdf .XDF .hdf .HDF .cmd .CMD .m3u .M3U .zip .ZIP .7z .7Z|**retroarch:** px68k (default)<br>|
|Sinclair|ZX Spectrum (zxspectrum)|1982|`zxspectrum`|.tzx .TZX .tap .TAP .z80 .Z80 .rzx .RZX .scl .SCL .trd .TRD .dsk .DSK .zip .ZIP .7z .7Z|**retroarch:** fuse<br>|
|Sinclair|ZX81 (zx81)|1981|`zx81`|.tzx .TZX .p .P .zip .ZIP .7z .7Z|**retroarch:** 81 (default)<br>|
|SNK|Neo Geo (neogeo)|1990|`neogeo`|.7z .7Z .zip .ZIP|**retroarch:** fbneo (default)<br>**retroarch:** mame2003_plus<br>**retroarch:** fbalpha2012<br>**retroarch:** fbalpha2019<br>**retroarch:** mame2010<br>**retroarch:** mame2015<br>**retroarch:** mame<br>|
|SNK|Neo Geo CD (neocd)|1990|`neocd`|.cue .CUE .iso .ISO .chd .CHD|**retroarch:** neocd (default)<br>**retroarch:** fbneo<br>|
|SNK|Neo Geo Pocket (ngp)|1998|`ngp`|.ngc .NGC .ngp .NGP .zip .ZIP .7z .7Z|**retroarch:** beetle_ngp (default)<br>**retroarch:** race<br>|
|SNK|Neo Geo Pocket Color (ngpc)|1999|`ngpc`|.ngc .NGC .zip .ZIP .7z .7Z|**retroarch:** beetle_ngp (default)<br>**retroarch:** race<br>|
|Sony|PlayStation (psx)|1994|`psx`|.bin .BIN .cue .CUE .img .IMG .mdf .MDF .pbp .PBP .toc .TOC .cbn .CBN .m3u .M3U .ccd .CCD .chd .CHD .iso .ISO|**retroarch:** pcsx_rearmed32 (default)<br>**retroarch:** pcsx_rearmed<br>**Duckstation:** duckstation-sa<br>**retroarch:** duckstation<br>**retroarch:** swanstation<br>|
|Sony|PlayStation Portable (psp)|2004|`psp`|.iso .ISO .cso .CSO .pbp .PBP|**ppsspp:** ppsspp-sa (default)<br>|
|Sony|PSP Minis (pspminis)|2004|`pspminis`|.iso .ISO .cso .CSO .pbp .PBP|**ppsspp:** ppsspp-sa (default)<br>**retroarch:** ppsspp<br>|
|Sun Microsystems|J2ME (j2me)|2002|`j2me`|.jar .JAR|**retroarch:** freej2me (default)<br>|
|Various|EasyRPG (easyrpg)|2003|`easyrpg`|.zip .ZIP .easyrpg .EASYRPG .ldb .LDB|**retroarch:** easyrpg (default)<br>|
|Various|OpenBOR (openbor)|2008|`openbor`|.pak .PAK|**OpenBOR:** OpenBOR (default)<br>|
|Various|ScummVM (scummvm)|2001|`games`|.sh .SH .svm .SVM .scummvm|**scummvmsa:** scummvm (default)<br>**retroarch:** scummvm<br>|
|Watara|Supervision (supervision)|1992|`supervision`|.sv .SV .zip .ZIP .7z .7Z|**retroarch:** potator (default)<br>|
|Welback Holdings|Mega Duck (megaduck)|1993|`megaduck`|.bin .BIN .zip .ZIP .7z .7Z|**retroarch:** sameduck (default)<br>|

111
documentation/RK3399/SUPPORTED_EMULATORS_AND_CORES.md Normal file
View file

@ -0,0 +1,111 @@
&nbsp;&nbsp;<img src="https://raw.githubusercontent.com/JustEnoughLinuxOS/distribution/dev/distributions/JELOS/logos/jelos-logo.png" width=192>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[![Latest Version](https://img.shields.io/github/release/JustEnoughLinuxOS/distribution.svg?color=5998FF&label=latest%20version&style=flat-square)](https://github.com/JustEnoughLinuxOS/distribution/releases/latest) [![Activity](https://img.shields.io/github/commit-activity/m/JustEnoughLinuxOS/distribution?color=5998FF&style=flat-square)](https://github.com/JustEnoughLinuxOS/distribution/commits) [![Pull Requests](https://img.shields.io/github/issues-pr-closed/JustEnoughLinuxOS/distribution?color=5998FF&style=flat-square)](https://github.com/JustEnoughLinuxOS/distribution/pulls) [![Discord Server](https://img.shields.io/discord/948029830325235753?color=5998FF&label=chat&style=flat-square)](https://discord.gg/seTxckZjJy)
#
|Manufacturer|System|Release Date|Games Path|Supported Extensions|Emulator / Core|
|----|----|----|----|----|----|
|Amstrad|CPC (amstradcpc)|1984|`amstradcpc`|.dsk .DSK .sna .SNA .tap .TAP .cdt .CDT .kcr .KCR .voc .VOC .m3u .M3U .zip .ZIP .7z .7Z|**retroarch:** crocods (default)<br>**retroarch:** cap32<br>|
|Arcade|Arcade (arcade)|1984|`arcade`|.zip .ZIP .7z .7Z|**retroarch:** mame2003_plus (default)<br>**retroarch:** mame2000<br>**retroarch:** mame2010<br>**retroarch:** mame2015<br>**retroarch:** fbneo<br>**retroarch:** fbalpha2012<br>**retroarch:** fbalpha2019<br>**retroarch:** mame<br>|
|Arcade|Daphne (daphne)|1996|`daphne`|.daphne .DAPHNE .zip .ZIP|**hypseus:** hypseus (default)<br>**retroarch:** daphne<br>|
|Arcade|Final Burn Neo (fbn)|1986|`fbneo`|.7z .zip .7Z .ZIP|**retroarch:** fbneo (default)<br>**retroarch:** mame2003_plus<br>**retroarch:** mame2010<br>**retroarch:** mame2015<br>**retroarch:** mame<br>**retroarch:** fbalpha2012<br>**retroarch:** fbalpha2019<br>|
|Arcade|MAME (mame)|1989|`mame`|.7z .7Z .zip .ZIP|**retroarch:** mame2003_plus (default)<br>**retroarch:** mame2010<br>**retroarch:** mame2015<br>**retroarch:** mame<br>**retroarch:** fbneo<br>**retroarch:** fbalpha2012<br>**retroarch:** fbalpha2019<br>|
|Atari|2600 (atari2600)|1977|`atari2600`|.a26 .A26 .bin .BIN .zip .ZIP .7z .7Z|**retroarch:** stella (default)<br>|
|Atari|5200 (atari5200)|1982|`atari5200`|.rom .ROM .xfd .XFD .atr .ATR .atx .ATX .cdm .CDM .cas .CAS .car .CAR .bin .BIN .a52 .A52 .xex .XEX .zip .ZIP .7z .7Z|**retroarch:** a5200 (default)<br>**retroarch:** atari800<br>|
|Atari|7800 (atari7800)|1986|`atari7800`|.a78 .A78 .bin .BIN .zip .ZIP .7z .7Z|**retroarch:** prosystem (default)<br>|
|Atari|Atari 800 (atari800)|1979|`atari800`|.rom .ROM .xfd .XFD .atr .ATR .atx .ATX .cdm .CDM .cas .CAS .car .CAR .bin .BIN .a52 .A52 .xex .XEX .zip .ZIP .7z .7Z|**retroarch:** atari800 (default)<br>|
|Atari|Atari ST (atarist)|1985|`atarist`|.st .ST .msa .MSA .stx .STX .dim .DIM .ipf .IPF .m3u .M3U .zip .ZIP .7z .7Z|**retroarch:** hatari (default)<br>**hatarisa:** hatarisa<br>|
|Atari|Jaguar (atarijaguar)|1993|`atarijaguar`|.j64 .J64 .jag .JAG .rom .ROM .abs .ABS .cof .COF .bin .BIN .prg .PRG|**retroarch:** virtualjaguar (default)<br>|
|Atari|Lynx (atarilynx)|1989|`atarilynx`|.lnx .LNX .o .O .zip .ZIP .7z .7Z|**retroarch:** handy (default)<br>**retroarch:** beetle_lynx<br>|
|Bandai|SuFami Turbo (sufami)|1996|`sufami`|.st .ST .zip .ZIP .7z .7Z|**retroarch:** snes9x (default)<br>|
|Bandai|Wonderswan (wonderswan)|1999|`wonderswan`|.ws .WS .zip .ZIP .7z .7Z|**retroarch:** beetle_wswan (default)<br>|
|Bandai|Wonderswan Color (wonderswancolor)|2000|`wonderswancolor`|.wsc .WSC .zip .ZIP .7z .7Z|**retroarch:** beetle_wswan (default)<br>|
|belogic|Uzebox (uzebox)|2008|`uzebox`|.uze .UZE|**retroarch:** uzem (default)<br>|
|Capcom|PlaySystem 1 (cps1)|1988|`cps1`|.zip .ZIP .7z .7Z|**retroarch:** fbneo (default)<br>**retroarch:** mame2003_plus<br>**retroarch:** mame2010<br>**retroarch:** fbalpha2012<br>**retroarch:** mba_mini<br>**AdvanceMame:** AdvanceMame<br>|
|Capcom|PlaySystem 2 (cps2)|1993|`cps2`|.zip .ZIP .7z .7Z|**retroarch:** fbneo (default)<br>**retroarch:** mame2003_plus<br>**retroarch:** mame2010<br>**retroarch:** fbalpha2012<br>**retroarch:** mba_mini<br>**AdvanceMame:** AdvanceMame<br>|
|Capcom|PlaySystem 3 (cps3)|1996|`cps3`|.zip .ZIP .7z .7Z|**retroarch:** fbneo (default)<br>**retroarch:** mame2003_plus<br>**retroarch:** mame2010<br>**retroarch:** fbalpha2012<br>**retroarch:** mba_mini<br>**AdvanceMame:** AdvanceMame<br>|
|Coleco|ColecoVision (colecovision)|1982|`coleco`|.bin .BIN .col .COL .rom .ROM .zip .ZIP .7z .7Z|**retroarch:** bluemsx (default)<br>**retroarch:** gearcoleco<br>**retroarch:** smsplus<br>|
|Commodore|Amiga (amiga)|1985|`amiga`|.zip .ZIP .adf .ADF .uae .UAE .ipf .IPF .dms .DMS .adz .ADZ .lha .LHA .m3u .M3U .hdf .HDF .hdz .HDZ|**retroarch:** puae (default)<br>**amiberry:** false<br>|
|Commodore|Amiga CD32 (amigacd32)|1994|`amigacd32`|.iso .ISO .cue .CUE .lha .LHA .chd .CHD|**retroarch:** puae (default)<br>**retroarch:** uae4arm<br>|
|Commodore|C128 (c128)|1985|`c128`|.d64 .D64 .d71 .D71 .d80 .D80 .d81 .D81 .d82 .D82 .g64 .G64 .g41 .G41 .x64 .X64 .t64 .T64 .tap .TAP .prg .PRG .p00 .P00 .crt .CRT .bin .BIN .d6z .D6Z .d7z .D7Z .d8z .D8Z .g6z .G6Z .g4z .G4Z .x6z .X6Z .cmd .CMD .m3u .M3U .vsf .VSF .nib .NIB .nbz .NBZ .zip .ZIP|**retroarch:** vice_x128 (default)<br>**vicesa:** x128<br>|
|Commodore|C16 (c16)|1984|`c16`|.d64 .D64 .d71 .D71 .d80 .D80 .d81 .D81 .d82 .D82 .g64 .G64 .g41 .G41 .x64 .X64 .t64 .T64 .tap .TAP .prg .PRG .p00 .P00 .crt .CRT .bin .BIN .d6z .D6Z .d7z .D7Z .d8z .D8Z .g6z .G6Z .g4z .G4Z .x6z .X6Z .cmd .CMD .m3u .M3U .vsf .VSF .nib .NIB .nbz .NBZ .zip .ZIP|**retroarch:** vice_xplus4 (default)<br>**vicesa:** xplus4<br>|
|Commodore|C64 (c64)|1982|`c64`|.d64 .D64 .d71 .D71 .d80 .D80 .d81 .D81 .d82 .D82 .g64 .G64 .g41 .G41 .x64 .X64 .t64 .T64 .tap .TAP .prg .PRG .p00 .P00 .crt .CRT .bin .BIN .d6z .D6Z .d7z .D7Z .d8z .D8Z .g6z .G6Z .g4z .G4Z .x6z .X6Z .cmd .CMD .m3u .M3U .vsf .VSF .nib .NIB .nbz .NBZ .zip .ZIP|**retroarch:** vice_x64 (default)<br>**vicesa:** x64sc<br>|
|Commodore|Commodore PET (pet)|1977|`pet`|.20 .40 .60 .a0 .b0 .d64 .d71 .d80 .d81 .d82 .g64 .g41 .x64 .t64 .tap .prg .p00 .crt .bin .gz .d6z .d7z .d8z .g6z .g4z .x6z .cmd .m3u .vsf .nib .nbz .zip|**retroarch:** vice_xpet (default)<br>|
|Commodore|VIC-20 (vic20)|1980|`vic20`|.20 .40 .60 .a0 .A0 .b0 .B0 .d64 .D64 .d71 .D71 .d80 .D80 .d81 .D81 .d82 .D82 .g64 .G64 .g41 .G41 .x64 .X64 .t64 .T64 .tap .TAP .prg .PRG .p00 .P00 .crt .CRT .bin .BIN .gz .GZ .d6z .D6Z .d7z .D7Z .d8z .D8Z .g6z .G6Z .g4z .G4Z .x6z .X6Z .cmd .CMD .m3u .M3U .vsf .VSF .nib .NIB .nbz .NBZ .zip .ZIP|**retroarch:** vice_xvic (default)<br>**vicesa:** vice_xvic<br>|
|Fairchild|Channel F (channelf)|1976|`channelf`|.bin .BIN .chf .CHF .zip .ZIP .7z .7Z|**retroarch:** freechaf (default)<br>|
|id Software|Doom (doom)|1993|`doom`|.doom|**gzdoom:** gzdoom-sa (default)<br>|
|JELOS|Moonlight Game Streaming (moonlight)|2021|`moonlight`|.sh .SH||
|JELOS|MPlayer (mplayer)|unknown|`mplayer`|.mp4 .MP4 .mkv .MKV .avi .AVI .mov .MOV .wmv .WMV .m3u .M3U .mpg .MPG .ytb .YTB .twi .TWI .sh .SH .mp3 .MP3 .aac .AAC .mka .MKA .dts .DTS .flac .FLAC .ogg .OGG .m4a .M4A .ac3 .AC3 .opus .OPUS .wav .WAV .wv .WV .eac3 .EAC3 .thd .THD|**mplayer:** mplayer (default)<br>|
|JELOS|Ports (ports)|2021|`ports`|.sh .SH||
|JELOS|Screenshots (imageviewer)|2021|`screenshots`|.jpg .jpeg .png .bmp .psd .tga .gif .hdr .pic .ppm .pgm .mkv .pdf .mp4 .avi||
|JELOS|Tools (tools)|2021|`modules`|.sh||
|Lexaloffle|PICO-8 (pico-8)|2015|`pico-8`|.sh .p8 .png .SH .P8 .PNG|**pico-8:** pico8 (default)<br>**retroarch:** fake08<br>|
|Magnavox|Odyssey (odyssey2)|1979|`odyssey`|.bin .BIN .zip .ZIP .7z .7Z|**retroarch:** o2em (default)<br>|
|Mattel|Intellivision (intellivision)|1979|`intellivision`|.int .INT .bin .BIN .rom .ROM .zip .ZIP .7z .7Z|**retroarch:** freeintv (default)<br>|
|Microsoft|MS-DOS (pc)|1981|`pc`|.com .COM .bat .BAT .exe .EXE .dosz .DOSZ|**retroarch:** dosbox_pure<br>**retroarch:** dosbox_svn<br>|
|Microsoft|MSX (msx)|1983|`msx`|.dsk .DSK .mx1 .MX1 .mx2 .MX2 .rom .ROM .zip .ZIP .7z .7Z .M3U .m3u|**retroarch:** bluemsx (default)<br>**retroarch:** fmsx<br>|
|Microsoft|MSX2 (msx2)|1988|`msx2`|.dsk .DSK .mx1 .MX1 .mx2 .MX2 .rom .ROM .zip .ZIP .7z .7Z .M3U .m3u|**retroarch:** bluemsx (default)<br>**retroarch:** fmsx<br>|
|Milton Bradley|Vectrex (vectrex)|1982|`vectrex`|.bin .BIN .gam .GAM .vec .VEC .zip .ZIP .7z .7Z|**retroarch:** vecx (default)<br>|
|NEC|PC Engine (pcengine)|1987|`pcengine`|.pce .PCE .bin .BIN .zip .ZIP .7z .7Z|**retroarch:** beetle_pce_fast (default)<br>**retroarch:** beetle_pce<br>**retroarch:** beetle_supergrafx<br>|
|NEC|PC Engine CD (pcenginecd)|1988|`pcenginecd`|.cue .CUE .ccd .CCD .chd .CHD .toc .TOC .m3u .M3U|**retroarch:** beetle_pce_fast (default)<br>**retroarch:** beetle_pce<br>**retroarch:** beetle_supergrafx<br>|
|NEC|PC-8800 (pc-8800)|1981|`pc88`|.d88 .D88 .m3u .M3U|**retroarch:** quasi88 (default)<br>|
|NEC|PC-9800 (pc-9800)|1983|`pc98`|.d98 .zip .98d .fdi .fdd .2hd .tfd .d88 .88d .hdm .xdf .dup .hdi .thd .nhd .hdd .hdn|**retroarch:** np2kai (default)<br>|
|NEC|PC-FX (pcfx)|1994|`pcfx`|.chd .CHD .cue .CUE .ccd .CCD .toc .TOC|**retroarch:** beetle_pcfx (default)<br>|
|NEC|Super Grafx (supergrafx)|1989|`sgfx`|.pce .PCE .sgx .SGX .cue .CUE .ccd .CCD .chd .CHD .zip .ZIP .7z .7Z|**retroarch:** beetle_supergrafx<br>**retroarch:** beetle_pce<br>|
|NEC|TurboGrafx-16 (tg16)|1989|`tg16`|.pce .PCE .bin .BIN .zip .ZIP .7z .7Z|**retroarch:** beetle_pce_fast (default)<br>**retroarch:** beetle_pce<br>**retroarch:** beetle_supergrafx<br>|
|NEC|TurboGrafx-CD (tg16cd)|1989|`tg16cd`|.cue .CUE .ccd .CCD .chd .CHD .toc .TOC .m3u .M3U|**retroarch:** beetle_pce_fast (default)<br>**retroarch:** beetle_pce<br>**retroarch:** beetle_supergrafx<br>|
|Nesbox|TIC-80 (tic-80)|2017|`tic-80`|.tic .TIC|**retroarch:** tic80 (default)<br>|
|Nintendo|DS (nds)|2005|`nds`|.nds .zip .NDS .ZIP .7z|**drastic:** drastic-sa (default)<br>**retroarch:** melonds<br>**melonds:** melonds-sa<br>|
|Nintendo|Famicom (famicom)|1983|`famicom`|.nes .NES .unif .UNIF .unf .UNF .zip .ZIP .7z .7Z|**retroarch:** nestopia (default)<br>**retroarch:** fceumm<br>**retroarch:** quicknes<br>**retroarch:** mesen<br>|
|Nintendo|Famicom Disk System (fds)|1986|`fds`|.fds .FDS .zip .ZIP .7z .7Z|**retroarch:** nestopia (default)<br>**retroarch:** fceumm<br>**retroarch:** quicknes<br>|
|Nintendo|Game and Watch (gameandwatch)|1980|`gameandwatch`|.mgw .MGW .zip .ZIP .7z .7Z|**retroarch:** gw<br>|
|Nintendo|Game Boy (gb)|1989|`gb`|.gb .GB .gbc .GBC .zip .ZIP .7z .7Z|**retroarch:** gambatte (default)<br>**retroarch:** sameboy<br>**retroarch:** gearboy<br>**retroarch:** tgbdual<br>**retroarch:** mgba<br>**retroarch:** vbam<br>|
|Nintendo|Game Boy (Hacks) (gbh)|1989|`gbh`|.gb .GB .zip .ZIP .7z .7Z|**retroarch:** gambatte (default)<br>**retroarch:** sameboy<br>**retroarch:** gearboy<br>**retroarch:** tgbdual<br>**retroarch:** mgba<br>**retroarch:** vbam<br>|
|Nintendo|Game Boy Advance (gba)|2001|`gba`|.gba .GBA .zip .ZIP .7z .7Z|**retroarch:** mgba (default)<br>**retroarch:** gbsp<br>**retroarch:** vbam<br>**retroarch:** vba_next<br>**retroarch:** beetle_gba<br>|
|Nintendo|Game Boy Advance (Hacks) (gbah)|2001|`gbah`|.gba .GBA .zip .ZIP .7z .7Z|**retroarch:** mgba (default)<br>**retroarch:** gbsp<br>**retroarch:** vbam<br>**retroarch:** vba_next<br>**retroarch:** beetle_gba<br>|
|Nintendo|Game Boy Color (gbc)|1998|`gbc`|.gb .GB .gbc .GBC .zip .ZIP .7z .7Z|**retroarch:** gambatte (default)<br>**retroarch:** sameboy<br>**retroarch:** gearboy<br>**retroarch:** tgbdual<br>**retroarch:** mgba<br>**retroarch:** vbam<br>|
|Nintendo|Game Boy Color (Hacks) (gbch)|1998|`gbch`|.gb .GB .gbc .GBC .zip .ZIP .7z .7Z|**retroarch:** gambatte (default)<br>**retroarch:** sameboy<br>**retroarch:** gearboy<br>**retroarch:** tgbdual<br>**retroarch:** mgba<br>**retroarch:** vbam<br>|
|Nintendo|GameCube (gamecube)|2001|`gamecube`|.gcm .GCM .iso .ISO .gcz .GCZ .ciso .CISO .wbfs .WBFS .rvz .RVZ .dol .DOL|**dolphin:** dolphin-sa-gc (default)<br>**primehack:** primehack<br>**retroarch:** dolphin<br>|
|Nintendo|MSU-1 (snesmsu1)|2012|`snesmsu1`|.smc .SMC .fig .FIG .sfc .SFC .swc .SWC .zip .ZIP .7z .7Z|**retroarch:** snes9x (default)<br>**retroarch:** beetle_supafaust<br>|
|Nintendo|N64 (n64)|1996|`n64`|.z64 .Z64 .n64 .N64 .v64 .V64 .zip .ZIP .7z .7Z|**retroarch:** mupen64plus_next (default)<br>**retroarch:** mupen64plus<br>**retroarch:** parallel_n64<br>**mupen64plus-sa:** m64p_gliden64<br>**mupen64plus-sa:** m64p_gl64mk2<br>**mupen64plus-sa:** m64p_rice<br>|
|Nintendo|NES (Hacks) (nesh)|1985|`nesh`|.nes .NES .unif .UNIF .unf .UNF .zip .ZIP .7z .7Z|**retroarch:** nestopia (default)<br>**retroarch:** fceumm<br>**retroarch:** quicknes<br>**retroarch:** mesen<br>|
|Nintendo|NES (nes)|1985|`nes`|.nes .NES .unif .UNIF .unf .UNF .zip .ZIP .7z .7Z|**retroarch:** nestopia (default)<br>**retroarch:** fceumm<br>**retroarch:** quicknes<br>**retroarch:** mesen<br>|
|Nintendo|Pokémon Mini (pokemini)|2001|`pokemini`|.min .MIN .zip .ZIP .7z .7Z|**retroarch:** pokemini (default)<br>|
|Nintendo|Satellaview (satellaview)|1995|`satellaview`|.smc .SMC .fig .FIG .bs .BS .sfc .SFC .bsx .BSX .swc .SWC .zip .ZIP .7z .7Z|**retroarch:** snes9x (default)<br>**retroarch:** snes9x2010<br>**retroarch:** snes9x2002<br>**retroarch:** snes9x2005_plus<br>|
|Nintendo|Super Famicom (sfc)|1990|`sfc`|.smc .SMC .fig .FIG .sfc .SFC .swc .SWC .zip .ZIP .7z .7Z|**retroarch:** snes9x (default)<br>**retroarch:** snes9x2010<br>**retroarch:** snes9x2002<br>**retroarch:** snes9x2005_plus<br>**retroarch:** beetle_supafaust<br>**retroarch:** bsnes<br>**retroarch:** bsnes_mercury_performance<br>**retroarch:** bsnes_hd_beta<br>|
|Nintendo|Super Nintendo (Hacks) (snesh)|1991|`snesh`|.smc .SMC .fig .FIG .sfc .SFC .swc .SWC .zip .ZIP .7z .7Z|**retroarch:** snes9x (default)<br>**retroarch:** snes9x2010<br>**retroarch:** snes9x2002<br>**retroarch:** snes9x2005_plus<br>**retroarch:** beetle_supafaust<br>**retroarch:** bsnes<br>**retroarch:** bsnes_mercury_performance<br>**retroarch:** bsnes_hd_beta<br>|
|Nintendo|Super Nintendo (snes)|1991|`snes`|.smc .SMC .fig .FIG .sfc .SFC .swc .SWC .zip .ZIP .7z .7Z|**retroarch:** snes9x (default)<br>**retroarch:** snes9x2010<br>**retroarch:** snes9x2002<br>**retroarch:** snes9x2005_plus<br>**retroarch:** beetle_supafaust<br>**retroarch:** bsnes<br>**retroarch:** bsnes_mercury_performance<br>**retroarch:** bsnes_hd_beta<br>|
|Nintendo|Virtual Boy (virtualboy)|1995|`virtualboy`|.vb .VB .zip .ZIP .7z .7Z|**retroarch:** beetle_vb (default)<br>|
|Nintendo|Wii (wii)|2006|`wii`|.gcm .GCM .iso .ISO .gcz .GCZ .ciso .CISO .wbfs .WBFS .rvz .RVZ .dol .DOL .wad .WAD|**dolphin:** dolphin-sa-wii (default)<br>**primehack:** primehack<br>**retroarch:** dolphin<br>|
|Panasonic|3DO (3do)|1993|`3do`|.iso .ISO .bin .BIN .chd .CHD .cue .CUE|**retroarch:** opera (default)<br>|
|Philips|VideoPac (videopac)|1978|`videopac`|.bin .BIN .zip .ZIP .7z .7Z|**retroarch:** o2em (default)<br>|
|Sammy|Atomiswave (atomiswave)|2003|`atomiswave`|.lst .LST .bin .BIN .dat .DAT .zip .ZIP .7z .7Z|**flycast:** flycast-sa<br>**retroarch:** flycast (default)<br>|
|Sega|32X (sega32x)|1994|`sega32x`|.32x .32X .smd .SMD .bin .BIN .md .MD .zip .ZIP .7z .7Z|**retroarch:** picodrive (default)<br>|
|Sega|CD (segacd)|1991|`segacd`|.chd .CHD .cue .CUE .iso .ISO .m3u .M3U|**retroarch:** genesis_plus_gx (default)<br>**retroarch:** picodrive<br>|
|Sega|Dreamcast (dreamcast)|1998|`dreamcast`|.cdi .CDI .gdi .GDI .chd .CHD .m3u .M3U|**flycast:** flycast-sa<br>**retroarch:** flycast (default)<br>|
|Sega|Game Gear (gamegear)|1990|`gamegear`|.bin .BIN .gg .GG .zip .ZIP .7z .7Z|**retroarch:** gearsystem (default)<br>**retroarch:** genesis_plus_gx<br>**retroarch:** picodrive<br>**retroarch:** smsplus<br>|
|Sega|Game Gear (Hacks) (ggh)|1990|`gamegearh`|.bin .BIN .gg .GG .zip .ZIP .7z .7Z|**retroarch:** gearsystem (default)<br>**retroarch:** genesis_plus_gx<br>**retroarch:** picodrive<br>**retroarch:** smsplus<br>|
|Sega|Genesis (genesis)|1989|`genesis`|.bin .BIN .gen .GEN .md .MD .sg .SG .smd .SMD .zip .ZIP .7z .7Z|**retroarch:** genesis_plus_gx (default)<br>**retroarch:** genesis_plus_gx_wide<br>**retroarch:** picodrive<br>|
|Sega|Genesis (Hacks) (genh)|1989|`genh`|.bin .BIN .gen .GEN .md .MD .sg .SG .smd .SMD .zip .ZIP .7z .7Z|**retroarch:** genesis_plus_gx (default)<br>**retroarch:** genesis_plus_gx_wide<br>**retroarch:** picodrive<br>|
|Sega|Master System (mastersystem)|1985|`mastersystem`|.bin .BIN .sms .SMS .zip .ZIP .7z .7Z|**retroarch:** gearsystem (default)<br>**retroarch:** genesis_plus_gx<br>**retroarch:** picodrive<br>**retroarch:** smsplus<br>|
|Sega|Mega Drive (megadrive)|1990|`megadrive`|.bin .BIN .gen .GEN .md .MD .sg .SG .smd .SMD .zip .ZIP .7z .7Z|**retroarch:** genesis_plus_gx (default)<br>**retroarch:** genesis_plus_gx_wide<br>**retroarch:** picodrive<br>|
|Sega|Mega Drive (megadrive-japan)|1988|`megadrive-japan`|.bin .BIN .gen .GEN .md .MD .sg .SG .smd .SMD .zip .ZIP .7z .7Z|**retroarch:** genesis_plus_gx (default)<br>**retroarch:** genesis_plus_gx_wide<br>**retroarch:** picodrive<br>|
|Sega|Mega-CD (megacd)|1991|`megacd`|.chd .CHD .cue .CUE .iso .ISO .m3u .M3U|**retroarch:** genesis_plus_gx (default)<br>**retroarch:** picodrive<br>|
|Sega|Naomi (naomi)|1998|`naomi`|.lst .LST .bin .BIN .dat .DAT .zip .ZIP .7z .7Z|**flycast:** flycast-sa<br>**retroarch:** flycast (default)<br>|
|Sega|Saturn (saturn)|1994|`saturn`|.cue .CUE .chd .CHD .iso .ISO|**yabasanshiro:** yabasanshiro-sa (default)<br>**retroarch:** yabasanshiro<br>**retroarch:** beetle_saturn<br>|
|Sega|SG-1000 (sg-1000)|1983|`sg-1000`|.bin .BIN .sg .SG .zip .ZIP .7z .7Z|**retroarch:** gearsystem (default)<br>**retroarch:** genesis_plus_gx<br>**retroarch:** picodrive<br>|
|Sharp|X1 (x1)|1982|`x1`|.dx1 .DX1 .2d .2D .2hd .2HD .tfd .TFD .d88 .D88 .88d .88D .hdm .HDM .xdf .XDF .dup .DUP .tap .TAP .cmd .CMD .zip .ZIP .7z .7Z|**retroarch:** x1 (default)<br>|
|Sharp|x68000 (x68000)|1987|`x68000`|.dim .DIM .img .IMG .d88 .D88 .88d .88D .hdm .HDM .dup .DUP .2hd .2HD .xdf .XDF .hdf .HDF .cmd .CMD .m3u .M3U .zip .ZIP .7z .7Z|**retroarch:** px68k (default)<br>|
|Sinclair|ZX Spectrum (zxspectrum)|1982|`zxspectrum`|.tzx .TZX .tap .TAP .z80 .Z80 .rzx .RZX .scl .SCL .trd .TRD .dsk .DSK .zip .ZIP .7z .7Z|**retroarch:** fuse<br>|
|Sinclair|ZX81 (zx81)|1981|`zx81`|.tzx .TZX .p .P .zip .ZIP .7z .7Z|**retroarch:** 81 (default)<br>|
|SNK|Neo Geo (neogeo)|1990|`neogeo`|.7z .7Z .zip .ZIP|**retroarch:** fbneo (default)<br>**retroarch:** mame2003_plus<br>**retroarch:** fbalpha2012<br>**retroarch:** fbalpha2019<br>**retroarch:** mame2010<br>**retroarch:** mame2015<br>**retroarch:** mame<br>|
|SNK|Neo Geo CD (neocd)|1990|`neocd`|.cue .CUE .iso .ISO .chd .CHD|**retroarch:** neocd (default)<br>**retroarch:** fbneo<br>|
|SNK|Neo Geo Pocket (ngp)|1998|`ngp`|.ngc .NGC .ngp .NGP .zip .ZIP .7z .7Z|**retroarch:** beetle_ngp (default)<br>**retroarch:** race<br>|
|SNK|Neo Geo Pocket Color (ngpc)|1999|`ngpc`|.ngc .NGC .zip .ZIP .7z .7Z|**retroarch:** beetle_ngp (default)<br>**retroarch:** race<br>|
|Sony|PlayStation (psx)|1994|`psx`|.bin .BIN .cue .CUE .img .IMG .mdf .MDF .pbp .PBP .toc .TOC .cbn .CBN .m3u .M3U .ccd .CCD .chd .CHD .iso .ISO|**retroarch:** pcsx_rearmed32 (default)<br>**retroarch:** pcsx_rearmed<br>**retroarch:** beetle_psx<br>**Duckstation:** duckstation-sa<br>**retroarch:** duckstation<br>**retroarch:** swanstation<br>|
|Sony|PlayStation 2 (ps2)|2000|`ps2`|.iso .ISO .mdf .MDF .nrg .NRG .bin .BIN .img .IMG .dump .DUMP .gz .GZ .cso .CSO .chd .CHD|**aethersx2:** aethersx2-sa (default)<br>|
|Sony|PlayStation Portable (psp)|2004|`psp`|.iso .ISO .cso .CSO .pbp .PBP|**ppsspp:** ppsspp-sa (default)<br>|
|Sony|PSP Minis (pspminis)|2004|`pspminis`|.iso .ISO .cso .CSO .pbp .PBP|**ppsspp:** ppsspp-sa (default)<br>**retroarch:** ppsspp<br>|
|Sun Microsystems|J2ME (j2me)|2002|`j2me`|.jar .JAR|**retroarch:** freej2me (default)<br>|
|Various|EasyRPG (easyrpg)|2003|`easyrpg`|.zip .ZIP .easyrpg .EASYRPG .ldb .LDB|**retroarch:** easyrpg (default)<br>|
|Various|OpenBOR (openbor)|2008|`openbor`|.pak .PAK|**OpenBOR:** OpenBOR (default)<br>|
|Various|ScummVM (scummvm)|2001|`games`|.sh .SH .svm .SVM .scummvm|**scummvmsa:** scummvm (default)<br>**retroarch:** scummvm<br>|
|Watara|Supervision (supervision)|1992|`supervision`|.sv .SV .zip .ZIP .7z .7Z|**retroarch:** potator (default)<br>|
|Welback Holdings|Mega Duck (megaduck)|1993|`megaduck`|.bin .BIN .zip .ZIP .7z .7Z|**retroarch:** sameduck (default)<br>|

110
documentation/RK3566-X55/SUPPORTED_EMULATORS_AND_CORES.md Normal file
View file

@ -0,0 +1,110 @@
&nbsp;&nbsp;<img src="https://raw.githubusercontent.com/JustEnoughLinuxOS/distribution/dev/distributions/JELOS/logos/jelos-logo.png" width=192>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[![Latest Version](https://img.shields.io/github/release/JustEnoughLinuxOS/distribution.svg?color=5998FF&label=latest%20version&style=flat-square)](https://github.com/JustEnoughLinuxOS/distribution/releases/latest) [![Activity](https://img.shields.io/github/commit-activity/m/JustEnoughLinuxOS/distribution?color=5998FF&style=flat-square)](https://github.com/JustEnoughLinuxOS/distribution/commits) [![Pull Requests](https://img.shields.io/github/issues-pr-closed/JustEnoughLinuxOS/distribution?color=5998FF&style=flat-square)](https://github.com/JustEnoughLinuxOS/distribution/pulls) [![Discord Server](https://img.shields.io/discord/948029830325235753?color=5998FF&label=chat&style=flat-square)](https://discord.gg/seTxckZjJy)
#
|Manufacturer|System|Release Date|Games Path|Supported Extensions|Emulator / Core|
|----|----|----|----|----|----|
|Amstrad|CPC (amstradcpc)|1984|`amstradcpc`|.dsk .DSK .sna .SNA .tap .TAP .cdt .CDT .kcr .KCR .voc .VOC .m3u .M3U .zip .ZIP .7z .7Z|**retroarch:** crocods (default)<br>**retroarch:** cap32<br>|
|Arcade|Arcade (arcade)|1984|`arcade`|.zip .ZIP .7z .7Z|**retroarch:** mame2003_plus (default)<br>**retroarch:** mame2000<br>**retroarch:** mame2010<br>**retroarch:** mame2015<br>**retroarch:** fbneo<br>**retroarch:** fbalpha2012<br>**retroarch:** fbalpha2019<br>|
|Arcade|Daphne (daphne)|1996|`daphne`|.daphne .DAPHNE .zip .ZIP|**hypseus:** hypseus (default)<br>**retroarch:** daphne<br>|
|Arcade|Final Burn Neo (fbn)|1986|`fbneo`|.7z .zip .7Z .ZIP|**retroarch:** fbneo (default)<br>**retroarch:** mame2003_plus<br>**retroarch:** mame2010<br>**retroarch:** mame2015<br>**retroarch:** mame<br>**retroarch:** fbalpha2012<br>**retroarch:** fbalpha2019<br>|
|Arcade|MAME (mame)|1989|`mame`|.7z .7Z .zip .ZIP|**retroarch:** mame2003_plus (default)<br>**retroarch:** mame2010<br>**retroarch:** mame2015<br>**retroarch:** mame<br>**retroarch:** fbneo<br>**retroarch:** fbalpha2012<br>**retroarch:** fbalpha2019<br>|
|Atari|2600 (atari2600)|1977|`atari2600`|.a26 .A26 .bin .BIN .zip .ZIP .7z .7Z|**retroarch:** stella (default)<br>|
|Atari|5200 (atari5200)|1982|`atari5200`|.rom .ROM .xfd .XFD .atr .ATR .atx .ATX .cdm .CDM .cas .CAS .car .CAR .bin .BIN .a52 .A52 .xex .XEX .zip .ZIP .7z .7Z|**retroarch:** a5200 (default)<br>**retroarch:** atari800<br>|
|Atari|7800 (atari7800)|1986|`atari7800`|.a78 .A78 .bin .BIN .zip .ZIP .7z .7Z|**retroarch:** prosystem (default)<br>|
|Atari|Atari 800 (atari800)|1979|`atari800`|.rom .ROM .xfd .XFD .atr .ATR .atx .ATX .cdm .CDM .cas .CAS .car .CAR .bin .BIN .a52 .A52 .xex .XEX .zip .ZIP .7z .7Z|**retroarch:** atari800 (default)<br>|
|Atari|Atari ST (atarist)|1985|`atarist`|.st .ST .msa .MSA .stx .STX .dim .DIM .ipf .IPF .m3u .M3U .zip .ZIP .7z .7Z|**retroarch:** hatari (default)<br>**hatarisa:** hatarisa<br>|
|Atari|Jaguar (atarijaguar)|1993|`atarijaguar`|.j64 .J64 .jag .JAG .rom .ROM .abs .ABS .cof .COF .bin .BIN .prg .PRG|**retroarch:** virtualjaguar (default)<br>|
|Atari|Lynx (atarilynx)|1989|`atarilynx`|.lnx .LNX .o .O .zip .ZIP .7z .7Z|**retroarch:** handy (default)<br>**retroarch:** beetle_lynx<br>|
|Bandai|SuFami Turbo (sufami)|1996|`sufami`|.st .ST .zip .ZIP .7z .7Z|**retroarch:** snes9x (default)<br>|
|Bandai|Wonderswan (wonderswan)|1999|`wonderswan`|.ws .WS .zip .ZIP .7z .7Z|**retroarch:** beetle_wswan (default)<br>|
|Bandai|Wonderswan Color (wonderswancolor)|2000|`wonderswancolor`|.wsc .WSC .zip .ZIP .7z .7Z|**retroarch:** beetle_wswan (default)<br>|
|belogic|Uzebox (uzebox)|2008|`uzebox`|.uze .UZE|**retroarch:** uzem (default)<br>|
|Capcom|PlaySystem 1 (cps1)|1988|`cps1`|.zip .ZIP .7z .7Z|**retroarch:** fbneo (default)<br>**retroarch:** mame2003_plus<br>**retroarch:** mame2010<br>**retroarch:** fbalpha2012<br>**retroarch:** mba_mini<br>**AdvanceMame:** AdvanceMame<br>|
|Capcom|PlaySystem 2 (cps2)|1993|`cps2`|.zip .ZIP .7z .7Z|**retroarch:** fbneo (default)<br>**retroarch:** mame2003_plus<br>**retroarch:** mame2010<br>**retroarch:** fbalpha2012<br>**retroarch:** mba_mini<br>**AdvanceMame:** AdvanceMame<br>|
|Capcom|PlaySystem 3 (cps3)|1996|`cps3`|.zip .ZIP .7z .7Z|**retroarch:** fbneo (default)<br>**retroarch:** mame2003_plus<br>**retroarch:** mame2010<br>**retroarch:** fbalpha2012<br>**retroarch:** mba_mini<br>**AdvanceMame:** AdvanceMame<br>|
|Coleco|ColecoVision (colecovision)|1982|`coleco`|.bin .BIN .col .COL .rom .ROM .zip .ZIP .7z .7Z|**retroarch:** bluemsx (default)<br>**retroarch:** gearcoleco<br>**retroarch:** smsplus<br>|
|Commodore|Amiga (amiga)|1985|`amiga`|.zip .ZIP .adf .ADF .uae .UAE .ipf .IPF .dms .DMS .adz .ADZ .lha .LHA .m3u .M3U .hdf .HDF .hdz .HDZ|**retroarch:** puae (default)<br>**amiberry:** false<br>|
|Commodore|Amiga CD32 (amigacd32)|1994|`amigacd32`|.iso .ISO .cue .CUE .lha .LHA .chd .CHD|**retroarch:** puae (default)<br>**retroarch:** uae4arm<br>|
|Commodore|C128 (c128)|1985|`c128`|.d64 .D64 .d71 .D71 .d80 .D80 .d81 .D81 .d82 .D82 .g64 .G64 .g41 .G41 .x64 .X64 .t64 .T64 .tap .TAP .prg .PRG .p00 .P00 .crt .CRT .bin .BIN .d6z .D6Z .d7z .D7Z .d8z .D8Z .g6z .G6Z .g4z .G4Z .x6z .X6Z .cmd .CMD .m3u .M3U .vsf .VSF .nib .NIB .nbz .NBZ .zip .ZIP|**retroarch:** vice_x128 (default)<br>**vicesa:** x128<br>|
|Commodore|C16 (c16)|1984|`c16`|.d64 .D64 .d71 .D71 .d80 .D80 .d81 .D81 .d82 .D82 .g64 .G64 .g41 .G41 .x64 .X64 .t64 .T64 .tap .TAP .prg .PRG .p00 .P00 .crt .CRT .bin .BIN .d6z .D6Z .d7z .D7Z .d8z .D8Z .g6z .G6Z .g4z .G4Z .x6z .X6Z .cmd .CMD .m3u .M3U .vsf .VSF .nib .NIB .nbz .NBZ .zip .ZIP|**retroarch:** vice_xplus4 (default)<br>**vicesa:** xplus4<br>|
|Commodore|C64 (c64)|1982|`c64`|.d64 .D64 .d71 .D71 .d80 .D80 .d81 .D81 .d82 .D82 .g64 .G64 .g41 .G41 .x64 .X64 .t64 .T64 .tap .TAP .prg .PRG .p00 .P00 .crt .CRT .bin .BIN .d6z .D6Z .d7z .D7Z .d8z .D8Z .g6z .G6Z .g4z .G4Z .x6z .X6Z .cmd .CMD .m3u .M3U .vsf .VSF .nib .NIB .nbz .NBZ .zip .ZIP|**retroarch:** vice_x64 (default)<br>**vicesa:** x64sc<br>|
|Commodore|Commodore PET (pet)|1977|`pet`|.20 .40 .60 .a0 .b0 .d64 .d71 .d80 .d81 .d82 .g64 .g41 .x64 .t64 .tap .prg .p00 .crt .bin .gz .d6z .d7z .d8z .g6z .g4z .x6z .cmd .m3u .vsf .nib .nbz .zip|**retroarch:** vice_xpet (default)<br>|
|Commodore|VIC-20 (vic20)|1980|`vic20`|.20 .40 .60 .a0 .A0 .b0 .B0 .d64 .D64 .d71 .D71 .d80 .D80 .d81 .D81 .d82 .D82 .g64 .G64 .g41 .G41 .x64 .X64 .t64 .T64 .tap .TAP .prg .PRG .p00 .P00 .crt .CRT .bin .BIN .gz .GZ .d6z .D6Z .d7z .D7Z .d8z .D8Z .g6z .G6Z .g4z .G4Z .x6z .X6Z .cmd .CMD .m3u .M3U .vsf .VSF .nib .NIB .nbz .NBZ .zip .ZIP|**retroarch:** vice_xvic (default)<br>**vicesa:** vice_xvic<br>|
|Fairchild|Channel F (channelf)|1976|`channelf`|.bin .BIN .chf .CHF .zip .ZIP .7z .7Z|**retroarch:** freechaf (default)<br>|
|id Software|Doom (doom)|1993|`doom`|.doom|**gzdoom:** gzdoom-sa (default)<br>|
|JELOS|Moonlight Game Streaming (moonlight)|2021|`moonlight`|.sh .SH||
|JELOS|MPlayer (mplayer)|unknown|`mplayer`|.mp4 .MP4 .mkv .MKV .avi .AVI .mov .MOV .wmv .WMV .m3u .M3U .mpg .MPG .ytb .YTB .twi .TWI .sh .SH .mp3 .MP3 .aac .AAC .mka .MKA .dts .DTS .flac .FLAC .ogg .OGG .m4a .M4A .ac3 .AC3 .opus .OPUS .wav .WAV .wv .WV .eac3 .EAC3 .thd .THD|**mplayer:** mplayer (default)<br>|
|JELOS|Ports (ports)|2021|`ports`|.sh .SH||
|JELOS|Screenshots (imageviewer)|2021|`screenshots`|.jpg .jpeg .png .bmp .psd .tga .gif .hdr .pic .ppm .pgm .mkv .pdf .mp4 .avi||
|JELOS|Tools (tools)|2021|`modules`|.sh||
|Lexaloffle|PICO-8 (pico-8)|2015|`pico-8`|.sh .p8 .png .SH .P8 .PNG|**pico-8:** pico8 (default)<br>**retroarch:** fake08<br>|
|Magnavox|Odyssey (odyssey2)|1979|`odyssey`|.bin .BIN .zip .ZIP .7z .7Z|**retroarch:** o2em (default)<br>|
|Mattel|Intellivision (intellivision)|1979|`intellivision`|.int .INT .bin .BIN .rom .ROM .zip .ZIP .7z .7Z|**retroarch:** freeintv (default)<br>|
|Microsoft|MS-DOS (pc)|1981|`pc`|.com .COM .bat .BAT .exe .EXE .dosz .DOSZ|**retroarch:** dosbox_pure<br>**retroarch:** dosbox_svn<br>|
|Microsoft|MSX (msx)|1983|`msx`|.dsk .DSK .mx1 .MX1 .mx2 .MX2 .rom .ROM .zip .ZIP .7z .7Z .M3U .m3u|**retroarch:** bluemsx (default)<br>**retroarch:** fmsx<br>|
|Microsoft|MSX2 (msx2)|1988|`msx2`|.dsk .DSK .mx1 .MX1 .mx2 .MX2 .rom .ROM .zip .ZIP .7z .7Z .M3U .m3u|**retroarch:** bluemsx (default)<br>**retroarch:** fmsx<br>|
|Milton Bradley|Vectrex (vectrex)|1982|`vectrex`|.bin .BIN .gam .GAM .vec .VEC .zip .ZIP .7z .7Z|**retroarch:** vecx (default)<br>|
|NEC|PC Engine (pcengine)|1987|`pcengine`|.pce .PCE .bin .BIN .zip .ZIP .7z .7Z|**retroarch:** beetle_pce_fast (default)<br>**retroarch:** beetle_pce<br>**retroarch:** beetle_supergrafx<br>|
|NEC|PC Engine CD (pcenginecd)|1988|`pcenginecd`|.cue .CUE .ccd .CCD .chd .CHD .toc .TOC .m3u .M3U|**retroarch:** beetle_pce_fast (default)<br>**retroarch:** beetle_pce<br>**retroarch:** beetle_supergrafx<br>|
|NEC|PC-8800 (pc-8800)|1981|`pc88`|.d88 .D88 .m3u .M3U|**retroarch:** quasi88 (default)<br>|
|NEC|PC-9800 (pc-9800)|1983|`pc98`|.d98 .zip .98d .fdi .fdd .2hd .tfd .d88 .88d .hdm .xdf .dup .hdi .thd .nhd .hdd .hdn|**retroarch:** np2kai (default)<br>|
|NEC|PC-FX (pcfx)|1994|`pcfx`|.chd .CHD .cue .CUE .ccd .CCD .toc .TOC|**retroarch:** beetle_pcfx (default)<br>|
|NEC|Super Grafx (supergrafx)|1989|`sgfx`|.pce .PCE .sgx .SGX .cue .CUE .ccd .CCD .chd .CHD .zip .ZIP .7z .7Z|**retroarch:** beetle_supergrafx<br>**retroarch:** beetle_pce<br>|
|NEC|TurboGrafx-16 (tg16)|1989|`tg16`|.pce .PCE .bin .BIN .zip .ZIP .7z .7Z|**retroarch:** beetle_pce_fast (default)<br>**retroarch:** beetle_pce<br>**retroarch:** beetle_supergrafx<br>|
|NEC|TurboGrafx-CD (tg16cd)|1989|`tg16cd`|.cue .CUE .ccd .CCD .chd .CHD .toc .TOC .m3u .M3U|**retroarch:** beetle_pce_fast (default)<br>**retroarch:** beetle_pce<br>**retroarch:** beetle_supergrafx<br>|
|Nesbox|TIC-80 (tic-80)|2017|`tic-80`|.tic .TIC|**retroarch:** tic80 (default)<br>|
|Nintendo|DS (nds)|2005|`nds`|.nds .zip .NDS .ZIP .7z|**drastic:** drastic-sa (default)<br>**retroarch:** melonds<br>|
|Nintendo|Famicom (famicom)|1983|`famicom`|.nes .NES .unif .UNIF .unf .UNF .zip .ZIP .7z .7Z|**retroarch:** nestopia (default)<br>**retroarch:** fceumm<br>**retroarch:** quicknes<br>**retroarch:** mesen<br>|
|Nintendo|Famicom Disk System (fds)|1986|`fds`|.fds .FDS .zip .ZIP .7z .7Z|**retroarch:** nestopia (default)<br>**retroarch:** fceumm<br>**retroarch:** quicknes<br>|
|Nintendo|Game and Watch (gameandwatch)|1980|`gameandwatch`|.mgw .MGW .zip .ZIP .7z .7Z|**retroarch:** gw<br>|
|Nintendo|Game Boy (gb)|1989|`gb`|.gb .GB .gbc .GBC .zip .ZIP .7z .7Z|**retroarch:** gambatte (default)<br>**retroarch:** sameboy<br>**retroarch:** gearboy<br>**retroarch:** tgbdual<br>**retroarch:** mgba<br>**retroarch:** vbam<br>|
|Nintendo|Game Boy (Hacks) (gbh)|1989|`gbh`|.gb .GB .zip .ZIP .7z .7Z|**retroarch:** gambatte (default)<br>**retroarch:** sameboy<br>**retroarch:** gearboy<br>**retroarch:** tgbdual<br>**retroarch:** mgba<br>**retroarch:** vbam<br>|
|Nintendo|Game Boy Advance (gba)|2001|`gba`|.gba .GBA .zip .ZIP .7z .7Z|**retroarch:** mgba (default)<br>**retroarch:** gbsp<br>**retroarch:** vbam<br>**retroarch:** vba_next<br>**retroarch:** beetle_gba<br>|
|Nintendo|Game Boy Advance (Hacks) (gbah)|2001|`gbah`|.gba .GBA .zip .ZIP .7z .7Z|**retroarch:** mgba (default)<br>**retroarch:** gbsp<br>**retroarch:** vbam<br>**retroarch:** vba_next<br>**retroarch:** beetle_gba<br>|
|Nintendo|Game Boy Color (gbc)|1998|`gbc`|.gb .GB .gbc .GBC .zip .ZIP .7z .7Z|**retroarch:** gambatte (default)<br>**retroarch:** sameboy<br>**retroarch:** gearboy<br>**retroarch:** tgbdual<br>**retroarch:** mgba<br>**retroarch:** vbam<br>|
|Nintendo|Game Boy Color (Hacks) (gbch)|1998|`gbch`|.gb .GB .gbc .GBC .zip .ZIP .7z .7Z|**retroarch:** gambatte (default)<br>**retroarch:** sameboy<br>**retroarch:** gearboy<br>**retroarch:** tgbdual<br>**retroarch:** mgba<br>**retroarch:** vbam<br>|
|Nintendo|GameCube (gamecube)|2001|`gamecube`|.gcm .GCM .iso .ISO .gcz .GCZ .ciso .CISO .wbfs .WBFS .rvz .RVZ .dol .DOL|**dolphin:** dolphin-sa-gc (default)<br>**primehack:** primehack<br>**retroarch:** dolphin<br>|
|Nintendo|MSU-1 (snesmsu1)|2012|`snesmsu1`|.smc .SMC .fig .FIG .sfc .SFC .swc .SWC .zip .ZIP .7z .7Z|**retroarch:** snes9x (default)<br>**retroarch:** beetle_supafaust<br>|
|Nintendo|N64 (n64)|1996|`n64`|.z64 .Z64 .n64 .N64 .v64 .V64 .zip .ZIP .7z .7Z|**retroarch:** mupen64plus_next (default)<br>**retroarch:** mupen64plus<br>**retroarch:** parallel_n64<br>**mupen64plus-sa:** m64p_gliden64<br>**mupen64plus-sa:** m64p_gl64mk2<br>**mupen64plus-sa:** m64p_rice<br>|
|Nintendo|NES (Hacks) (nesh)|1985|`nesh`|.nes .NES .unif .UNIF .unf .UNF .zip .ZIP .7z .7Z|**retroarch:** nestopia (default)<br>**retroarch:** fceumm<br>**retroarch:** quicknes<br>**retroarch:** mesen<br>|
|Nintendo|NES (nes)|1985|`nes`|.nes .NES .unif .UNIF .unf .UNF .zip .ZIP .7z .7Z|**retroarch:** nestopia (default)<br>**retroarch:** fceumm<br>**retroarch:** quicknes<br>**retroarch:** mesen<br>|
|Nintendo|Pokémon Mini (pokemini)|2001|`pokemini`|.min .MIN .zip .ZIP .7z .7Z|**retroarch:** pokemini (default)<br>|
|Nintendo|Satellaview (satellaview)|1995|`satellaview`|.smc .SMC .fig .FIG .bs .BS .sfc .SFC .bsx .BSX .swc .SWC .zip .ZIP .7z .7Z|**retroarch:** snes9x (default)<br>**retroarch:** snes9x2010<br>**retroarch:** snes9x2002<br>**retroarch:** snes9x2005_plus<br>|
|Nintendo|Super Famicom (sfc)|1990|`sfc`|.smc .SMC .fig .FIG .sfc .SFC .swc .SWC .zip .ZIP .7z .7Z|**retroarch:** snes9x (default)<br>**retroarch:** snes9x2010<br>**retroarch:** snes9x2002<br>**retroarch:** snes9x2005_plus<br>**retroarch:** beetle_supafaust<br>**retroarch:** bsnes<br>**retroarch:** bsnes_mercury_performance<br>**retroarch:** bsnes_hd_beta<br>|
|Nintendo|Super Nintendo (Hacks) (snesh)|1991|`snesh`|.smc .SMC .fig .FIG .sfc .SFC .swc .SWC .zip .ZIP .7z .7Z|**retroarch:** snes9x (default)<br>**retroarch:** snes9x2010<br>**retroarch:** snes9x2002<br>**retroarch:** snes9x2005_plus<br>**retroarch:** beetle_supafaust<br>**retroarch:** bsnes<br>**retroarch:** bsnes_mercury_performance<br>**retroarch:** bsnes_hd_beta<br>|
|Nintendo|Super Nintendo (snes)|1991|`snes`|.smc .SMC .fig .FIG .sfc .SFC .swc .SWC .zip .ZIP .7z .7Z|**retroarch:** snes9x (default)<br>**retroarch:** snes9x2010<br>**retroarch:** snes9x2002<br>**retroarch:** snes9x2005_plus<br>**retroarch:** beetle_supafaust<br>**retroarch:** bsnes<br>**retroarch:** bsnes_mercury_performance<br>**retroarch:** bsnes_hd_beta<br>|
|Nintendo|Virtual Boy (virtualboy)|1995|`virtualboy`|.vb .VB .zip .ZIP .7z .7Z|**retroarch:** beetle_vb (default)<br>|
|Nintendo|Wii (wii)|2006|`wii`|.gcm .GCM .iso .ISO .gcz .GCZ .ciso .CISO .wbfs .WBFS .rvz .RVZ .dol .DOL .wad .WAD|**dolphin:** dolphin-sa-wii (default)<br>**primehack:** primehack<br>**retroarch:** dolphin<br>|
|Panasonic|3DO (3do)|1993|`3do`|.iso .ISO .bin .BIN .chd .CHD .cue .CUE|**retroarch:** opera (default)<br>|
|Philips|VideoPac (videopac)|1978|`videopac`|.bin .BIN .zip .ZIP .7z .7Z|**retroarch:** o2em (default)<br>|
|Sammy|Atomiswave (atomiswave)|2003|`atomiswave`|.lst .LST .bin .BIN .dat .DAT .zip .ZIP .7z .7Z|**retroarch:** flycast2021<br>**retroarch:** flycast32 (default)<br>**retroarch:** flycast<br>**flycast:** flycast-sa<br>|
|Sega|32X (sega32x)|1994|`sega32x`|.32x .32X .smd .SMD .bin .BIN .md .MD .zip .ZIP .7z .7Z|**retroarch:** picodrive (default)<br>|
|Sega|CD (segacd)|1991|`segacd`|.chd .CHD .cue .CUE .iso .ISO .m3u .M3U|**retroarch:** genesis_plus_gx (default)<br>**retroarch:** picodrive<br>|
|Sega|Dreamcast (dreamcast)|1998|`dreamcast`|.cdi .CDI .gdi .GDI .chd .CHD .m3u .M3U|**retroarch:** flycast2021<br>**retroarch:** flycast32 (default)<br>**retroarch:** flycast<br>**flycast:** flycast-sa<br>|
|Sega|Game Gear (gamegear)|1990|`gamegear`|.bin .BIN .gg .GG .zip .ZIP .7z .7Z|**retroarch:** gearsystem (default)<br>**retroarch:** genesis_plus_gx<br>**retroarch:** picodrive<br>**retroarch:** smsplus<br>|
|Sega|Game Gear (Hacks) (ggh)|1990|`gamegearh`|.bin .BIN .gg .GG .zip .ZIP .7z .7Z|**retroarch:** gearsystem (default)<br>**retroarch:** genesis_plus_gx<br>**retroarch:** picodrive<br>**retroarch:** smsplus<br>|
|Sega|Genesis (genesis)|1989|`genesis`|.bin .BIN .gen .GEN .md .MD .sg .SG .smd .SMD .zip .ZIP .7z .7Z|**retroarch:** genesis_plus_gx (default)<br>**retroarch:** genesis_plus_gx_wide<br>**retroarch:** picodrive<br>|
|Sega|Genesis (Hacks) (genh)|1989|`genh`|.bin .BIN .gen .GEN .md .MD .sg .SG .smd .SMD .zip .ZIP .7z .7Z|**retroarch:** genesis_plus_gx (default)<br>**retroarch:** genesis_plus_gx_wide<br>**retroarch:** picodrive<br>|
|Sega|Master System (mastersystem)|1985|`mastersystem`|.bin .BIN .sms .SMS .zip .ZIP .7z .7Z|**retroarch:** gearsystem (default)<br>**retroarch:** genesis_plus_gx<br>**retroarch:** picodrive<br>**retroarch:** smsplus<br>|
|Sega|Mega Drive (megadrive)|1990|`megadrive`|.bin .BIN .gen .GEN .md .MD .sg .SG .smd .SMD .zip .ZIP .7z .7Z|**retroarch:** genesis_plus_gx (default)<br>**retroarch:** genesis_plus_gx_wide<br>**retroarch:** picodrive<br>|
|Sega|Mega Drive (megadrive-japan)|1988|`megadrive-japan`|.bin .BIN .gen .GEN .md .MD .sg .SG .smd .SMD .zip .ZIP .7z .7Z|**retroarch:** genesis_plus_gx (default)<br>**retroarch:** genesis_plus_gx_wide<br>**retroarch:** picodrive<br>|
|Sega|Mega-CD (megacd)|1991|`megacd`|.chd .CHD .cue .CUE .iso .ISO .m3u .M3U|**retroarch:** genesis_plus_gx (default)<br>**retroarch:** picodrive<br>|
|Sega|Naomi (naomi)|1998|`naomi`|.lst .LST .bin .BIN .dat .DAT .zip .ZIP .7z .7Z|**retroarch:** flycast2021<br>**retroarch:** flycast32 (default)<br>**retroarch:** flycast<br>**flycast:** flycast-sa<br>|
|Sega|Saturn (saturn)|1994|`saturn`|.cue .CUE .chd .CHD .iso .ISO|**yabasanshiro:** yabasanshiro-sa (default)<br>**retroarch:** yabasanshiro<br>**retroarch:** beetle_saturn<br>|
|Sega|SG-1000 (sg-1000)|1983|`sg-1000`|.bin .BIN .sg .SG .zip .ZIP .7z .7Z|**retroarch:** gearsystem (default)<br>**retroarch:** genesis_plus_gx<br>**retroarch:** picodrive<br>|
|Sharp|X1 (x1)|1982|`x1`|.dx1 .DX1 .2d .2D .2hd .2HD .tfd .TFD .d88 .D88 .88d .88D .hdm .HDM .xdf .XDF .dup .DUP .tap .TAP .cmd .CMD .zip .ZIP .7z .7Z|**retroarch:** x1 (default)<br>|
|Sharp|x68000 (x68000)|1987|`x68000`|.dim .DIM .img .IMG .d88 .D88 .88d .88D .hdm .HDM .dup .DUP .2hd .2HD .xdf .XDF .hdf .HDF .cmd .CMD .m3u .M3U .zip .ZIP .7z .7Z|**retroarch:** px68k (default)<br>|
|Sinclair|ZX Spectrum (zxspectrum)|1982|`zxspectrum`|.tzx .TZX .tap .TAP .z80 .Z80 .rzx .RZX .scl .SCL .trd .TRD .dsk .DSK .zip .ZIP .7z .7Z|**retroarch:** fuse<br>|
|Sinclair|ZX81 (zx81)|1981|`zx81`|.tzx .TZX .p .P .zip .ZIP .7z .7Z|**retroarch:** 81 (default)<br>|
|SNK|Neo Geo (neogeo)|1990|`neogeo`|.7z .7Z .zip .ZIP|**retroarch:** fbneo (default)<br>**retroarch:** mame2003_plus<br>**retroarch:** fbalpha2012<br>**retroarch:** fbalpha2019<br>**retroarch:** mame2010<br>**retroarch:** mame2015<br>**retroarch:** mame<br>|
|SNK|Neo Geo CD (neocd)|1990|`neocd`|.cue .CUE .iso .ISO .chd .CHD|**retroarch:** neocd (default)<br>**retroarch:** fbneo<br>|
|SNK|Neo Geo Pocket (ngp)|1998|`ngp`|.ngc .NGC .ngp .NGP .zip .ZIP .7z .7Z|**retroarch:** beetle_ngp (default)<br>**retroarch:** race<br>|
|SNK|Neo Geo Pocket Color (ngpc)|1999|`ngpc`|.ngc .NGC .zip .ZIP .7z .7Z|**retroarch:** beetle_ngp (default)<br>**retroarch:** race<br>|
|Sony|PlayStation (psx)|1994|`psx`|.bin .BIN .cue .CUE .img .IMG .mdf .MDF .pbp .PBP .toc .TOC .cbn .CBN .m3u .M3U .ccd .CCD .chd .CHD .iso .ISO|**retroarch:** pcsx_rearmed32 (default)<br>**retroarch:** pcsx_rearmed<br>**Duckstation:** duckstation-sa<br>**retroarch:** duckstation<br>**retroarch:** swanstation<br>|
|Sony|PlayStation Portable (psp)|2004|`psp`|.iso .ISO .cso .CSO .pbp .PBP|**ppsspp:** ppsspp-sa (default)<br>|
|Sony|PSP Minis (pspminis)|2004|`pspminis`|.iso .ISO .cso .CSO .pbp .PBP|**ppsspp:** ppsspp-sa (default)<br>**retroarch:** ppsspp<br>|
|Sun Microsystems|J2ME (j2me)|2002|`j2me`|.jar .JAR|**retroarch:** freej2me (default)<br>|
|Various|EasyRPG (easyrpg)|2003|`easyrpg`|.zip .ZIP .easyrpg .EASYRPG .ldb .LDB|**retroarch:** easyrpg (default)<br>|
|Various|OpenBOR (openbor)|2008|`openbor`|.pak .PAK|**OpenBOR:** OpenBOR (default)<br>|
|Various|ScummVM (scummvm)|2001|`games`|.sh .SH .svm .SVM .scummvm|**scummvmsa:** scummvm (default)<br>**retroarch:** scummvm<br>|
|Watara|Supervision (supervision)|1992|`supervision`|.sv .SV .zip .ZIP .7z .7Z|**retroarch:** potator (default)<br>|
|Welback Holdings|Mega Duck (megaduck)|1993|`megaduck`|.bin .BIN .zip .ZIP .7z .7Z|**retroarch:** sameduck (default)<br>|

110
documentation/RK3566/SUPPORTED_EMULATORS_AND_CORES.md Normal file
View file

@ -0,0 +1,110 @@
&nbsp;&nbsp;<img src="https://raw.githubusercontent.com/JustEnoughLinuxOS/distribution/dev/distributions/JELOS/logos/jelos-logo.png" width=192>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[![Latest Version](https://img.shields.io/github/release/JustEnoughLinuxOS/distribution.svg?color=5998FF&label=latest%20version&style=flat-square)](https://github.com/JustEnoughLinuxOS/distribution/releases/latest) [![Activity](https://img.shields.io/github/commit-activity/m/JustEnoughLinuxOS/distribution?color=5998FF&style=flat-square)](https://github.com/JustEnoughLinuxOS/distribution/commits) [![Pull Requests](https://img.shields.io/github/issues-pr-closed/JustEnoughLinuxOS/distribution?color=5998FF&style=flat-square)](https://github.com/JustEnoughLinuxOS/distribution/pulls) [![Discord Server](https://img.shields.io/discord/948029830325235753?color=5998FF&label=chat&style=flat-square)](https://discord.gg/seTxckZjJy)
#
|Manufacturer|System|Release Date|Games Path|Supported Extensions|Emulator / Core|
|----|----|----|----|----|----|
|Amstrad|CPC (amstradcpc)|1984|`amstradcpc`|.dsk .DSK .sna .SNA .tap .TAP .cdt .CDT .kcr .KCR .voc .VOC .m3u .M3U .zip .ZIP .7z .7Z|**retroarch:** crocods (default)<br>**retroarch:** cap32<br>|
|Arcade|Arcade (arcade)|1984|`arcade`|.zip .ZIP .7z .7Z|**retroarch:** mame2003_plus (default)<br>**retroarch:** mame2000<br>**retroarch:** mame2010<br>**retroarch:** mame2015<br>**retroarch:** fbneo<br>**retroarch:** fbalpha2012<br>**retroarch:** fbalpha2019<br>|
|Arcade|Daphne (daphne)|1996|`daphne`|.daphne .DAPHNE .zip .ZIP|**hypseus:** hypseus (default)<br>**retroarch:** daphne<br>|
|Arcade|Final Burn Neo (fbn)|1986|`fbneo`|.7z .zip .7Z .ZIP|**retroarch:** fbneo (default)<br>**retroarch:** mame2003_plus<br>**retroarch:** mame2010<br>**retroarch:** mame2015<br>**retroarch:** mame<br>**retroarch:** fbalpha2012<br>**retroarch:** fbalpha2019<br>|
|Arcade|MAME (mame)|1989|`mame`|.7z .7Z .zip .ZIP|**retroarch:** mame2003_plus (default)<br>**retroarch:** mame2010<br>**retroarch:** mame2015<br>**retroarch:** mame<br>**retroarch:** fbneo<br>**retroarch:** fbalpha2012<br>**retroarch:** fbalpha2019<br>|
|Atari|2600 (atari2600)|1977|`atari2600`|.a26 .A26 .bin .BIN .zip .ZIP .7z .7Z|**retroarch:** stella (default)<br>|
|Atari|5200 (atari5200)|1982|`atari5200`|.rom .ROM .xfd .XFD .atr .ATR .atx .ATX .cdm .CDM .cas .CAS .car .CAR .bin .BIN .a52 .A52 .xex .XEX .zip .ZIP .7z .7Z|**retroarch:** a5200 (default)<br>**retroarch:** atari800<br>|
|Atari|7800 (atari7800)|1986|`atari7800`|.a78 .A78 .bin .BIN .zip .ZIP .7z .7Z|**retroarch:** prosystem (default)<br>|
|Atari|Atari 800 (atari800)|1979|`atari800`|.rom .ROM .xfd .XFD .atr .ATR .atx .ATX .cdm .CDM .cas .CAS .car .CAR .bin .BIN .a52 .A52 .xex .XEX .zip .ZIP .7z .7Z|**retroarch:** atari800 (default)<br>|
|Atari|Atari ST (atarist)|1985|`atarist`|.st .ST .msa .MSA .stx .STX .dim .DIM .ipf .IPF .m3u .M3U .zip .ZIP .7z .7Z|**retroarch:** hatari (default)<br>**hatarisa:** hatarisa<br>|
|Atari|Jaguar (atarijaguar)|1993|`atarijaguar`|.j64 .J64 .jag .JAG .rom .ROM .abs .ABS .cof .COF .bin .BIN .prg .PRG|**retroarch:** virtualjaguar (default)<br>|
|Atari|Lynx (atarilynx)|1989|`atarilynx`|.lnx .LNX .o .O .zip .ZIP .7z .7Z|**retroarch:** handy (default)<br>**retroarch:** beetle_lynx<br>|
|Bandai|SuFami Turbo (sufami)|1996|`sufami`|.st .ST .zip .ZIP .7z .7Z|**retroarch:** snes9x (default)<br>|
|Bandai|Wonderswan (wonderswan)|1999|`wonderswan`|.ws .WS .zip .ZIP .7z .7Z|**retroarch:** beetle_wswan (default)<br>|
|Bandai|Wonderswan Color (wonderswancolor)|2000|`wonderswancolor`|.wsc .WSC .zip .ZIP .7z .7Z|**retroarch:** beetle_wswan (default)<br>|
|belogic|Uzebox (uzebox)|2008|`uzebox`|.uze .UZE|**retroarch:** uzem (default)<br>|
|Capcom|PlaySystem 1 (cps1)|1988|`cps1`|.zip .ZIP .7z .7Z|**retroarch:** fbneo (default)<br>**retroarch:** mame2003_plus<br>**retroarch:** mame2010<br>**retroarch:** fbalpha2012<br>**retroarch:** mba_mini<br>**AdvanceMame:** AdvanceMame<br>|
|Capcom|PlaySystem 2 (cps2)|1993|`cps2`|.zip .ZIP .7z .7Z|**retroarch:** fbneo (default)<br>**retroarch:** mame2003_plus<br>**retroarch:** mame2010<br>**retroarch:** fbalpha2012<br>**retroarch:** mba_mini<br>**AdvanceMame:** AdvanceMame<br>|
|Capcom|PlaySystem 3 (cps3)|1996|`cps3`|.zip .ZIP .7z .7Z|**retroarch:** fbneo (default)<br>**retroarch:** mame2003_plus<br>**retroarch:** mame2010<br>**retroarch:** fbalpha2012<br>**retroarch:** mba_mini<br>**AdvanceMame:** AdvanceMame<br>|
|Coleco|ColecoVision (colecovision)|1982|`coleco`|.bin .BIN .col .COL .rom .ROM .zip .ZIP .7z .7Z|**retroarch:** bluemsx (default)<br>**retroarch:** gearcoleco<br>**retroarch:** smsplus<br>|
|Commodore|Amiga (amiga)|1985|`amiga`|.zip .ZIP .adf .ADF .uae .UAE .ipf .IPF .dms .DMS .adz .ADZ .lha .LHA .m3u .M3U .hdf .HDF .hdz .HDZ|**retroarch:** puae (default)<br>**amiberry:** false<br>|
|Commodore|Amiga CD32 (amigacd32)|1994|`amigacd32`|.iso .ISO .cue .CUE .lha .LHA .chd .CHD|**retroarch:** puae (default)<br>**retroarch:** uae4arm<br>|
|Commodore|C128 (c128)|1985|`c128`|.d64 .D64 .d71 .D71 .d80 .D80 .d81 .D81 .d82 .D82 .g64 .G64 .g41 .G41 .x64 .X64 .t64 .T64 .tap .TAP .prg .PRG .p00 .P00 .crt .CRT .bin .BIN .d6z .D6Z .d7z .D7Z .d8z .D8Z .g6z .G6Z .g4z .G4Z .x6z .X6Z .cmd .CMD .m3u .M3U .vsf .VSF .nib .NIB .nbz .NBZ .zip .ZIP|**retroarch:** vice_x128 (default)<br>**vicesa:** x128<br>|
|Commodore|C16 (c16)|1984|`c16`|.d64 .D64 .d71 .D71 .d80 .D80 .d81 .D81 .d82 .D82 .g64 .G64 .g41 .G41 .x64 .X64 .t64 .T64 .tap .TAP .prg .PRG .p00 .P00 .crt .CRT .bin .BIN .d6z .D6Z .d7z .D7Z .d8z .D8Z .g6z .G6Z .g4z .G4Z .x6z .X6Z .cmd .CMD .m3u .M3U .vsf .VSF .nib .NIB .nbz .NBZ .zip .ZIP|**retroarch:** vice_xplus4 (default)<br>**vicesa:** xplus4<br>|
|Commodore|C64 (c64)|1982|`c64`|.d64 .D64 .d71 .D71 .d80 .D80 .d81 .D81 .d82 .D82 .g64 .G64 .g41 .G41 .x64 .X64 .t64 .T64 .tap .TAP .prg .PRG .p00 .P00 .crt .CRT .bin .BIN .d6z .D6Z .d7z .D7Z .d8z .D8Z .g6z .G6Z .g4z .G4Z .x6z .X6Z .cmd .CMD .m3u .M3U .vsf .VSF .nib .NIB .nbz .NBZ .zip .ZIP|**retroarch:** vice_x64 (default)<br>**vicesa:** x64sc<br>|
|Commodore|Commodore PET (pet)|1977|`pet`|.20 .40 .60 .a0 .b0 .d64 .d71 .d80 .d81 .d82 .g64 .g41 .x64 .t64 .tap .prg .p00 .crt .bin .gz .d6z .d7z .d8z .g6z .g4z .x6z .cmd .m3u .vsf .nib .nbz .zip|**retroarch:** vice_xpet (default)<br>|
|Commodore|VIC-20 (vic20)|1980|`vic20`|.20 .40 .60 .a0 .A0 .b0 .B0 .d64 .D64 .d71 .D71 .d80 .D80 .d81 .D81 .d82 .D82 .g64 .G64 .g41 .G41 .x64 .X64 .t64 .T64 .tap .TAP .prg .PRG .p00 .P00 .crt .CRT .bin .BIN .gz .GZ .d6z .D6Z .d7z .D7Z .d8z .D8Z .g6z .G6Z .g4z .G4Z .x6z .X6Z .cmd .CMD .m3u .M3U .vsf .VSF .nib .NIB .nbz .NBZ .zip .ZIP|**retroarch:** vice_xvic (default)<br>**vicesa:** vice_xvic<br>|
|Fairchild|Channel F (channelf)|1976|`channelf`|.bin .BIN .chf .CHF .zip .ZIP .7z .7Z|**retroarch:** freechaf (default)<br>|
|id Software|Doom (doom)|1993|`doom`|.doom|**gzdoom:** gzdoom-sa (default)<br>|
|JELOS|Moonlight Game Streaming (moonlight)|2021|`moonlight`|.sh .SH||
|JELOS|MPlayer (mplayer)|unknown|`mplayer`|.mp4 .MP4 .mkv .MKV .avi .AVI .mov .MOV .wmv .WMV .m3u .M3U .mpg .MPG .ytb .YTB .twi .TWI .sh .SH .mp3 .MP3 .aac .AAC .mka .MKA .dts .DTS .flac .FLAC .ogg .OGG .m4a .M4A .ac3 .AC3 .opus .OPUS .wav .WAV .wv .WV .eac3 .EAC3 .thd .THD|**mplayer:** mplayer (default)<br>|
|JELOS|Ports (ports)|2021|`ports`|.sh .SH||
|JELOS|Screenshots (imageviewer)|2021|`screenshots`|.jpg .jpeg .png .bmp .psd .tga .gif .hdr .pic .ppm .pgm .mkv .pdf .mp4 .avi||
|JELOS|Tools (tools)|2021|`modules`|.sh||
|Lexaloffle|PICO-8 (pico-8)|2015|`pico-8`|.sh .p8 .png .SH .P8 .PNG|**pico-8:** pico8 (default)<br>**retroarch:** fake08<br>|
|Magnavox|Odyssey (odyssey2)|1979|`odyssey`|.bin .BIN .zip .ZIP .7z .7Z|**retroarch:** o2em (default)<br>|
|Mattel|Intellivision (intellivision)|1979|`intellivision`|.int .INT .bin .BIN .rom .ROM .zip .ZIP .7z .7Z|**retroarch:** freeintv (default)<br>|
|Microsoft|MS-DOS (pc)|1981|`pc`|.com .COM .bat .BAT .exe .EXE .dosz .DOSZ|**retroarch:** dosbox_pure<br>**retroarch:** dosbox_svn<br>|
|Microsoft|MSX (msx)|1983|`msx`|.dsk .DSK .mx1 .MX1 .mx2 .MX2 .rom .ROM .zip .ZIP .7z .7Z .M3U .m3u|**retroarch:** bluemsx (default)<br>**retroarch:** fmsx<br>|
|Microsoft|MSX2 (msx2)|1988|`msx2`|.dsk .DSK .mx1 .MX1 .mx2 .MX2 .rom .ROM .zip .ZIP .7z .7Z .M3U .m3u|**retroarch:** bluemsx (default)<br>**retroarch:** fmsx<br>|
|Milton Bradley|Vectrex (vectrex)|1982|`vectrex`|.bin .BIN .gam .GAM .vec .VEC .zip .ZIP .7z .7Z|**retroarch:** vecx (default)<br>|
|NEC|PC Engine (pcengine)|1987|`pcengine`|.pce .PCE .bin .BIN .zip .ZIP .7z .7Z|**retroarch:** beetle_pce_fast (default)<br>**retroarch:** beetle_pce<br>**retroarch:** beetle_supergrafx<br>|
|NEC|PC Engine CD (pcenginecd)|1988|`pcenginecd`|.cue .CUE .ccd .CCD .chd .CHD .toc .TOC .m3u .M3U|**retroarch:** beetle_pce_fast (default)<br>**retroarch:** beetle_pce<br>**retroarch:** beetle_supergrafx<br>|
|NEC|PC-8800 (pc-8800)|1981|`pc88`|.d88 .D88 .m3u .M3U|**retroarch:** quasi88 (default)<br>|
|NEC|PC-9800 (pc-9800)|1983|`pc98`|.d98 .zip .98d .fdi .fdd .2hd .tfd .d88 .88d .hdm .xdf .dup .hdi .thd .nhd .hdd .hdn|**retroarch:** np2kai (default)<br>|
|NEC|PC-FX (pcfx)|1994|`pcfx`|.chd .CHD .cue .CUE .ccd .CCD .toc .TOC|**retroarch:** beetle_pcfx (default)<br>|
|NEC|Super Grafx (supergrafx)|1989|`sgfx`|.pce .PCE .sgx .SGX .cue .CUE .ccd .CCD .chd .CHD .zip .ZIP .7z .7Z|**retroarch:** beetle_supergrafx<br>**retroarch:** beetle_pce<br>|
|NEC|TurboGrafx-16 (tg16)|1989|`tg16`|.pce .PCE .bin .BIN .zip .ZIP .7z .7Z|**retroarch:** beetle_pce_fast (default)<br>**retroarch:** beetle_pce<br>**retroarch:** beetle_supergrafx<br>|
|NEC|TurboGrafx-CD (tg16cd)|1989|`tg16cd`|.cue .CUE .ccd .CCD .chd .CHD .toc .TOC .m3u .M3U|**retroarch:** beetle_pce_fast (default)<br>**retroarch:** beetle_pce<br>**retroarch:** beetle_supergrafx<br>|
|Nesbox|TIC-80 (tic-80)|2017|`tic-80`|.tic .TIC|**retroarch:** tic80 (default)<br>|
|Nintendo|DS (nds)|2005|`nds`|.nds .zip .NDS .ZIP .7z|**drastic:** drastic-sa (default)<br>**retroarch:** melonds<br>|
|Nintendo|Famicom (famicom)|1983|`famicom`|.nes .NES .unif .UNIF .unf .UNF .zip .ZIP .7z .7Z|**retroarch:** nestopia (default)<br>**retroarch:** fceumm<br>**retroarch:** quicknes<br>**retroarch:** mesen<br>|
|Nintendo|Famicom Disk System (fds)|1986|`fds`|.fds .FDS .zip .ZIP .7z .7Z|**retroarch:** nestopia (default)<br>**retroarch:** fceumm<br>**retroarch:** quicknes<br>|
|Nintendo|Game and Watch (gameandwatch)|1980|`gameandwatch`|.mgw .MGW .zip .ZIP .7z .7Z|**retroarch:** gw<br>|
|Nintendo|Game Boy (gb)|1989|`gb`|.gb .GB .gbc .GBC .zip .ZIP .7z .7Z|**retroarch:** gambatte (default)<br>**retroarch:** sameboy<br>**retroarch:** gearboy<br>**retroarch:** tgbdual<br>**retroarch:** mgba<br>**retroarch:** vbam<br>|
|Nintendo|Game Boy (Hacks) (gbh)|1989|`gbh`|.gb .GB .zip .ZIP .7z .7Z|**retroarch:** gambatte (default)<br>**retroarch:** sameboy<br>**retroarch:** gearboy<br>**retroarch:** tgbdual<br>**retroarch:** mgba<br>**retroarch:** vbam<br>|
|Nintendo|Game Boy Advance (gba)|2001|`gba`|.gba .GBA .zip .ZIP .7z .7Z|**retroarch:** mgba (default)<br>**retroarch:** gbsp<br>**retroarch:** vbam<br>**retroarch:** vba_next<br>**retroarch:** beetle_gba<br>|
|Nintendo|Game Boy Advance (Hacks) (gbah)|2001|`gbah`|.gba .GBA .zip .ZIP .7z .7Z|**retroarch:** mgba (default)<br>**retroarch:** gbsp<br>**retroarch:** vbam<br>**retroarch:** vba_next<br>**retroarch:** beetle_gba<br>|
|Nintendo|Game Boy Color (gbc)|1998|`gbc`|.gb .GB .gbc .GBC .zip .ZIP .7z .7Z|**retroarch:** gambatte (default)<br>**retroarch:** sameboy<br>**retroarch:** gearboy<br>**retroarch:** tgbdual<br>**retroarch:** mgba<br>**retroarch:** vbam<br>|
|Nintendo|Game Boy Color (Hacks) (gbch)|1998|`gbch`|.gb .GB .gbc .GBC .zip .ZIP .7z .7Z|**retroarch:** gambatte (default)<br>**retroarch:** sameboy<br>**retroarch:** gearboy<br>**retroarch:** tgbdual<br>**retroarch:** mgba<br>**retroarch:** vbam<br>|
|Nintendo|GameCube (gamecube)|2001|`gamecube`|.gcm .GCM .iso .ISO .gcz .GCZ .ciso .CISO .wbfs .WBFS .rvz .RVZ .dol .DOL|**dolphin:** dolphin-sa-gc (default)<br>**primehack:** primehack<br>**retroarch:** dolphin<br>|
|Nintendo|MSU-1 (snesmsu1)|2012|`snesmsu1`|.smc .SMC .fig .FIG .sfc .SFC .swc .SWC .zip .ZIP .7z .7Z|**retroarch:** snes9x (default)<br>**retroarch:** beetle_supafaust<br>|
|Nintendo|N64 (n64)|1996|`n64`|.z64 .Z64 .n64 .N64 .v64 .V64 .zip .ZIP .7z .7Z|**retroarch:** mupen64plus_next (default)<br>**retroarch:** mupen64plus<br>**retroarch:** parallel_n64<br>**mupen64plus-sa:** m64p_gliden64<br>**mupen64plus-sa:** m64p_gl64mk2<br>**mupen64plus-sa:** m64p_rice<br>|
|Nintendo|NES (Hacks) (nesh)|1985|`nesh`|.nes .NES .unif .UNIF .unf .UNF .zip .ZIP .7z .7Z|**retroarch:** nestopia (default)<br>**retroarch:** fceumm<br>**retroarch:** quicknes<br>**retroarch:** mesen<br>|
|Nintendo|NES (nes)|1985|`nes`|.nes .NES .unif .UNIF .unf .UNF .zip .ZIP .7z .7Z|**retroarch:** nestopia (default)<br>**retroarch:** fceumm<br>**retroarch:** quicknes<br>**retroarch:** mesen<br>|
|Nintendo|Pokémon Mini (pokemini)|2001|`pokemini`|.min .MIN .zip .ZIP .7z .7Z|**retroarch:** pokemini (default)<br>|
|Nintendo|Satellaview (satellaview)|1995|`satellaview`|.smc .SMC .fig .FIG .bs .BS .sfc .SFC .bsx .BSX .swc .SWC .zip .ZIP .7z .7Z|**retroarch:** snes9x (default)<br>**retroarch:** snes9x2010<br>**retroarch:** snes9x2002<br>**retroarch:** snes9x2005_plus<br>|
|Nintendo|Super Famicom (sfc)|1990|`sfc`|.smc .SMC .fig .FIG .sfc .SFC .swc .SWC .zip .ZIP .7z .7Z|**retroarch:** snes9x (default)<br>**retroarch:** snes9x2010<br>**retroarch:** snes9x2002<br>**retroarch:** snes9x2005_plus<br>**retroarch:** beetle_supafaust<br>**retroarch:** bsnes<br>**retroarch:** bsnes_mercury_performance<br>**retroarch:** bsnes_hd_beta<br>|
|Nintendo|Super Nintendo (Hacks) (snesh)|1991|`snesh`|.smc .SMC .fig .FIG .sfc .SFC .swc .SWC .zip .ZIP .7z .7Z|**retroarch:** snes9x (default)<br>**retroarch:** snes9x2010<br>**retroarch:** snes9x2002<br>**retroarch:** snes9x2005_plus<br>**retroarch:** beetle_supafaust<br>**retroarch:** bsnes<br>**retroarch:** bsnes_mercury_performance<br>**retroarch:** bsnes_hd_beta<br>|
|Nintendo|Super Nintendo (snes)|1991|`snes`|.smc .SMC .fig .FIG .sfc .SFC .swc .SWC .zip .ZIP .7z .7Z|**retroarch:** snes9x (default)<br>**retroarch:** snes9x2010<br>**retroarch:** snes9x2002<br>**retroarch:** snes9x2005_plus<br>**retroarch:** beetle_supafaust<br>**retroarch:** bsnes<br>**retroarch:** bsnes_mercury_performance<br>**retroarch:** bsnes_hd_beta<br>|
|Nintendo|Virtual Boy (virtualboy)|1995|`virtualboy`|.vb .VB .zip .ZIP .7z .7Z|**retroarch:** beetle_vb (default)<br>|
|Nintendo|Wii (wii)|2006|`wii`|.gcm .GCM .iso .ISO .gcz .GCZ .ciso .CISO .wbfs .WBFS .rvz .RVZ .dol .DOL .wad .WAD|**dolphin:** dolphin-sa-wii (default)<br>**primehack:** primehack<br>**retroarch:** dolphin<br>|
|Panasonic|3DO (3do)|1993|`3do`|.iso .ISO .bin .BIN .chd .CHD .cue .CUE|**retroarch:** opera (default)<br>|
|Philips|VideoPac (videopac)|1978|`videopac`|.bin .BIN .zip .ZIP .7z .7Z|**retroarch:** o2em (default)<br>|
|Sammy|Atomiswave (atomiswave)|2003|`atomiswave`|.lst .LST .bin .BIN .dat .DAT .zip .ZIP .7z .7Z|**retroarch:** flycast2021<br>**retroarch:** flycast32 (default)<br>**retroarch:** flycast<br>**flycast:** flycast-sa<br>|
|Sega|32X (sega32x)|1994|`sega32x`|.32x .32X .smd .SMD .bin .BIN .md .MD .zip .ZIP .7z .7Z|**retroarch:** picodrive (default)<br>|
|Sega|CD (segacd)|1991|`segacd`|.chd .CHD .cue .CUE .iso .ISO .m3u .M3U|**retroarch:** genesis_plus_gx (default)<br>**retroarch:** picodrive<br>|
|Sega|Dreamcast (dreamcast)|1998|`dreamcast`|.cdi .CDI .gdi .GDI .chd .CHD .m3u .M3U|**retroarch:** flycast2021<br>**retroarch:** flycast32 (default)<br>**retroarch:** flycast<br>**flycast:** flycast-sa<br>|
|Sega|Game Gear (gamegear)|1990|`gamegear`|.bin .BIN .gg .GG .zip .ZIP .7z .7Z|**retroarch:** gearsystem (default)<br>**retroarch:** genesis_plus_gx<br>**retroarch:** picodrive<br>**retroarch:** smsplus<br>|
|Sega|Game Gear (Hacks) (ggh)|1990|`gamegearh`|.bin .BIN .gg .GG .zip .ZIP .7z .7Z|**retroarch:** gearsystem (default)<br>**retroarch:** genesis_plus_gx<br>**retroarch:** picodrive<br>**retroarch:** smsplus<br>|
|Sega|Genesis (genesis)|1989|`genesis`|.bin .BIN .gen .GEN .md .MD .sg .SG .smd .SMD .zip .ZIP .7z .7Z|**retroarch:** genesis_plus_gx (default)<br>**retroarch:** genesis_plus_gx_wide<br>**retroarch:** picodrive<br>|
|Sega|Genesis (Hacks) (genh)|1989|`genh`|.bin .BIN .gen .GEN .md .MD .sg .SG .smd .SMD .zip .ZIP .7z .7Z|**retroarch:** genesis_plus_gx (default)<br>**retroarch:** genesis_plus_gx_wide<br>**retroarch:** picodrive<br>|
|Sega|Master System (mastersystem)|1985|`mastersystem`|.bin .BIN .sms .SMS .zip .ZIP .7z .7Z|**retroarch:** gearsystem (default)<br>**retroarch:** genesis_plus_gx<br>**retroarch:** picodrive<br>**retroarch:** smsplus<br>|
|Sega|Mega Drive (megadrive)|1990|`megadrive`|.bin .BIN .gen .GEN .md .MD .sg .SG .smd .SMD .zip .ZIP .7z .7Z|**retroarch:** genesis_plus_gx (default)<br>**retroarch:** genesis_plus_gx_wide<br>**retroarch:** picodrive<br>|
|Sega|Mega Drive (megadrive-japan)|1988|`megadrive-japan`|.bin .BIN .gen .GEN .md .MD .sg .SG .smd .SMD .zip .ZIP .7z .7Z|**retroarch:** genesis_plus_gx (default)<br>**retroarch:** genesis_plus_gx_wide<br>**retroarch:** picodrive<br>|
|Sega|Mega-CD (megacd)|1991|`megacd`|.chd .CHD .cue .CUE .iso .ISO .m3u .M3U|**retroarch:** genesis_plus_gx (default)<br>**retroarch:** picodrive<br>|
|Sega|Naomi (naomi)|1998|`naomi`|.lst .LST .bin .BIN .dat .DAT .zip .ZIP .7z .7Z|**retroarch:** flycast2021<br>**retroarch:** flycast32 (default)<br>**retroarch:** flycast<br>**flycast:** flycast-sa<br>|
|Sega|Saturn (saturn)|1994|`saturn`|.cue .CUE .chd .CHD .iso .ISO|**yabasanshiro:** yabasanshiro-sa (default)<br>**retroarch:** yabasanshiro<br>**retroarch:** beetle_saturn<br>|
|Sega|SG-1000 (sg-1000)|1983|`sg-1000`|.bin .BIN .sg .SG .zip .ZIP .7z .7Z|**retroarch:** gearsystem (default)<br>**retroarch:** genesis_plus_gx<br>**retroarch:** picodrive<br>|
|Sharp|X1 (x1)|1982|`x1`|.dx1 .DX1 .2d .2D .2hd .2HD .tfd .TFD .d88 .D88 .88d .88D .hdm .HDM .xdf .XDF .dup .DUP .tap .TAP .cmd .CMD .zip .ZIP .7z .7Z|**retroarch:** x1 (default)<br>|
|Sharp|x68000 (x68000)|1987|`x68000`|.dim .DIM .img .IMG .d88 .D88 .88d .88D .hdm .HDM .dup .DUP .2hd .2HD .xdf .XDF .hdf .HDF .cmd .CMD .m3u .M3U .zip .ZIP .7z .7Z|**retroarch:** px68k (default)<br>|
|Sinclair|ZX Spectrum (zxspectrum)|1982|`zxspectrum`|.tzx .TZX .tap .TAP .z80 .Z80 .rzx .RZX .scl .SCL .trd .TRD .dsk .DSK .zip .ZIP .7z .7Z|**retroarch:** fuse<br>|
|Sinclair|ZX81 (zx81)|1981|`zx81`|.tzx .TZX .p .P .zip .ZIP .7z .7Z|**retroarch:** 81 (default)<br>|
|SNK|Neo Geo (neogeo)|1990|`neogeo`|.7z .7Z .zip .ZIP|**retroarch:** fbneo (default)<br>**retroarch:** mame2003_plus<br>**retroarch:** fbalpha2012<br>**retroarch:** fbalpha2019<br>**retroarch:** mame2010<br>**retroarch:** mame2015<br>**retroarch:** mame<br>|
|SNK|Neo Geo CD (neocd)|1990|`neocd`|.cue .CUE .iso .ISO .chd .CHD|**retroarch:** neocd (default)<br>**retroarch:** fbneo<br>|
|SNK|Neo Geo Pocket (ngp)|1998|`ngp`|.ngc .NGC .ngp .NGP .zip .ZIP .7z .7Z|**retroarch:** beetle_ngp (default)<br>**retroarch:** race<br>|
|SNK|Neo Geo Pocket Color (ngpc)|1999|`ngpc`|.ngc .NGC .zip .ZIP .7z .7Z|**retroarch:** beetle_ngp (default)<br>**retroarch:** race<br>|
|Sony|PlayStation (psx)|1994|`psx`|.bin .BIN .cue .CUE .img .IMG .mdf .MDF .pbp .PBP .toc .TOC .cbn .CBN .m3u .M3U .ccd .CCD .chd .CHD .iso .ISO|**retroarch:** pcsx_rearmed32 (default)<br>**retroarch:** pcsx_rearmed<br>**Duckstation:** duckstation-sa<br>**retroarch:** duckstation<br>**retroarch:** swanstation<br>|
|Sony|PlayStation Portable (psp)|2004|`psp`|.iso .ISO .cso .CSO .pbp .PBP|**ppsspp:** ppsspp-sa (default)<br>|
|Sony|PSP Minis (pspminis)|2004|`pspminis`|.iso .ISO .cso .CSO .pbp .PBP|**ppsspp:** ppsspp-sa (default)<br>**retroarch:** ppsspp<br>|
|Sun Microsystems|J2ME (j2me)|2002|`j2me`|.jar .JAR|**retroarch:** freej2me (default)<br>|
|Various|EasyRPG (easyrpg)|2003|`easyrpg`|.zip .ZIP .easyrpg .EASYRPG .ldb .LDB|**retroarch:** easyrpg (default)<br>|
|Various|OpenBOR (openbor)|2008|`openbor`|.pak .PAK|**OpenBOR:** OpenBOR (default)<br>|
|Various|ScummVM (scummvm)|2001|`games`|.sh .SH .svm .SVM .scummvm|**scummvmsa:** scummvm (default)<br>**retroarch:** scummvm<br>|
|Watara|Supervision (supervision)|1992|`supervision`|.sv .SV .zip .ZIP .7z .7Z|**retroarch:** potator (default)<br>|
|Welback Holdings|Mega Duck (megaduck)|1993|`megaduck`|.bin .BIN .zip .ZIP .7z .7Z|**retroarch:** sameduck (default)<br>|

111
documentation/RK3588/SUPPORTED_EMULATORS_AND_CORES.md Normal file
View file

@ -0,0 +1,111 @@
&nbsp;&nbsp;<img src="https://raw.githubusercontent.com/JustEnoughLinuxOS/distribution/dev/distributions/JELOS/logos/jelos-logo.png" width=192>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[![Latest Version](https://img.shields.io/github/release/JustEnoughLinuxOS/distribution.svg?color=5998FF&label=latest%20version&style=flat-square)](https://github.com/JustEnoughLinuxOS/distribution/releases/latest) [![Activity](https://img.shields.io/github/commit-activity/m/JustEnoughLinuxOS/distribution?color=5998FF&style=flat-square)](https://github.com/JustEnoughLinuxOS/distribution/commits) [![Pull Requests](https://img.shields.io/github/issues-pr-closed/JustEnoughLinuxOS/distribution?color=5998FF&style=flat-square)](https://github.com/JustEnoughLinuxOS/distribution/pulls) [![Discord Server](https://img.shields.io/discord/948029830325235753?color=5998FF&label=chat&style=flat-square)](https://discord.gg/seTxckZjJy)
#
|Manufacturer|System|Release Date|Games Path|Supported Extensions|Emulator / Core|
|----|----|----|----|----|----|
|Amstrad|CPC (amstradcpc)|1984|`amstradcpc`|.dsk .DSK .sna .SNA .tap .TAP .cdt .CDT .kcr .KCR .voc .VOC .m3u .M3U .zip .ZIP .7z .7Z|**retroarch:** crocods (default)<br>**retroarch:** cap32<br>|
|Arcade|Arcade (arcade)|1984|`arcade`|.zip .ZIP .7z .7Z|**retroarch:** mame2003_plus (default)<br>**retroarch:** mame2000<br>**retroarch:** mame2010<br>**retroarch:** mame2015<br>**retroarch:** fbneo<br>**retroarch:** fbalpha2012<br>**retroarch:** fbalpha2019<br>**retroarch:** mame<br>|
|Arcade|Daphne (daphne)|1996|`daphne`|.daphne .DAPHNE .zip .ZIP|**hypseus:** hypseus (default)<br>**retroarch:** daphne<br>|
|Arcade|Final Burn Neo (fbn)|1986|`fbneo`|.7z .zip .7Z .ZIP|**retroarch:** fbneo (default)<br>**retroarch:** mame2003_plus<br>**retroarch:** mame2010<br>**retroarch:** mame2015<br>**retroarch:** mame<br>**retroarch:** fbalpha2012<br>**retroarch:** fbalpha2019<br>|
|Arcade|MAME (mame)|1989|`mame`|.7z .7Z .zip .ZIP|**retroarch:** mame2003_plus (default)<br>**retroarch:** mame2010<br>**retroarch:** mame2015<br>**retroarch:** mame<br>**retroarch:** fbneo<br>**retroarch:** fbalpha2012<br>**retroarch:** fbalpha2019<br>|
|Atari|2600 (atari2600)|1977|`atari2600`|.a26 .A26 .bin .BIN .zip .ZIP .7z .7Z|**retroarch:** stella (default)<br>|
|Atari|5200 (atari5200)|1982|`atari5200`|.rom .ROM .xfd .XFD .atr .ATR .atx .ATX .cdm .CDM .cas .CAS .car .CAR .bin .BIN .a52 .A52 .xex .XEX .zip .ZIP .7z .7Z|**retroarch:** a5200 (default)<br>**retroarch:** atari800<br>|
|Atari|7800 (atari7800)|1986|`atari7800`|.a78 .A78 .bin .BIN .zip .ZIP .7z .7Z|**retroarch:** prosystem (default)<br>|
|Atari|Atari 800 (atari800)|1979|`atari800`|.rom .ROM .xfd .XFD .atr .ATR .atx .ATX .cdm .CDM .cas .CAS .car .CAR .bin .BIN .a52 .A52 .xex .XEX .zip .ZIP .7z .7Z|**retroarch:** atari800 (default)<br>|
|Atari|Atari ST (atarist)|1985|`atarist`|.st .ST .msa .MSA .stx .STX .dim .DIM .ipf .IPF .m3u .M3U .zip .ZIP .7z .7Z|**retroarch:** hatari (default)<br>**hatarisa:** hatarisa<br>|
|Atari|Jaguar (atarijaguar)|1993|`atarijaguar`|.j64 .J64 .jag .JAG .rom .ROM .abs .ABS .cof .COF .bin .BIN .prg .PRG|**retroarch:** virtualjaguar (default)<br>|
|Atari|Lynx (atarilynx)|1989|`atarilynx`|.lnx .LNX .o .O .zip .ZIP .7z .7Z|**retroarch:** handy (default)<br>**retroarch:** beetle_lynx<br>|
|Bandai|SuFami Turbo (sufami)|1996|`sufami`|.st .ST .zip .ZIP .7z .7Z|**retroarch:** snes9x (default)<br>|
|Bandai|Wonderswan (wonderswan)|1999|`wonderswan`|.ws .WS .zip .ZIP .7z .7Z|**retroarch:** beetle_wswan (default)<br>|
|Bandai|Wonderswan Color (wonderswancolor)|2000|`wonderswancolor`|.wsc .WSC .zip .ZIP .7z .7Z|**retroarch:** beetle_wswan (default)<br>|
|belogic|Uzebox (uzebox)|2008|`uzebox`|.uze .UZE|**retroarch:** uzem (default)<br>|
|Capcom|PlaySystem 1 (cps1)|1988|`cps1`|.zip .ZIP .7z .7Z|**retroarch:** fbneo (default)<br>**retroarch:** mame2003_plus<br>**retroarch:** mame2010<br>**retroarch:** fbalpha2012<br>**retroarch:** mba_mini<br>**AdvanceMame:** AdvanceMame<br>|
|Capcom|PlaySystem 2 (cps2)|1993|`cps2`|.zip .ZIP .7z .7Z|**retroarch:** fbneo (default)<br>**retroarch:** mame2003_plus<br>**retroarch:** mame2010<br>**retroarch:** fbalpha2012<br>**retroarch:** mba_mini<br>**AdvanceMame:** AdvanceMame<br>|
|Capcom|PlaySystem 3 (cps3)|1996|`cps3`|.zip .ZIP .7z .7Z|**retroarch:** fbneo (default)<br>**retroarch:** mame2003_plus<br>**retroarch:** mame2010<br>**retroarch:** fbalpha2012<br>**retroarch:** mba_mini<br>**AdvanceMame:** AdvanceMame<br>|
|Coleco|ColecoVision (colecovision)|1982|`coleco`|.bin .BIN .col .COL .rom .ROM .zip .ZIP .7z .7Z|**retroarch:** bluemsx (default)<br>**retroarch:** gearcoleco<br>**retroarch:** smsplus<br>|
|Commodore|Amiga (amiga)|1985|`amiga`|.zip .ZIP .adf .ADF .uae .UAE .ipf .IPF .dms .DMS .adz .ADZ .lha .LHA .m3u .M3U .hdf .HDF .hdz .HDZ|**retroarch:** puae (default)<br>**amiberry:** false<br>|
|Commodore|Amiga CD32 (amigacd32)|1994|`amigacd32`|.iso .ISO .cue .CUE .lha .LHA .chd .CHD|**retroarch:** puae (default)<br>**retroarch:** uae4arm<br>|
|Commodore|C128 (c128)|1985|`c128`|.d64 .D64 .d71 .D71 .d80 .D80 .d81 .D81 .d82 .D82 .g64 .G64 .g41 .G41 .x64 .X64 .t64 .T64 .tap .TAP .prg .PRG .p00 .P00 .crt .CRT .bin .BIN .d6z .D6Z .d7z .D7Z .d8z .D8Z .g6z .G6Z .g4z .G4Z .x6z .X6Z .cmd .CMD .m3u .M3U .vsf .VSF .nib .NIB .nbz .NBZ .zip .ZIP|**retroarch:** vice_x128 (default)<br>**vicesa:** x128<br>|
|Commodore|C16 (c16)|1984|`c16`|.d64 .D64 .d71 .D71 .d80 .D80 .d81 .D81 .d82 .D82 .g64 .G64 .g41 .G41 .x64 .X64 .t64 .T64 .tap .TAP .prg .PRG .p00 .P00 .crt .CRT .bin .BIN .d6z .D6Z .d7z .D7Z .d8z .D8Z .g6z .G6Z .g4z .G4Z .x6z .X6Z .cmd .CMD .m3u .M3U .vsf .VSF .nib .NIB .nbz .NBZ .zip .ZIP|**retroarch:** vice_xplus4 (default)<br>**vicesa:** xplus4<br>|
|Commodore|C64 (c64)|1982|`c64`|.d64 .D64 .d71 .D71 .d80 .D80 .d81 .D81 .d82 .D82 .g64 .G64 .g41 .G41 .x64 .X64 .t64 .T64 .tap .TAP .prg .PRG .p00 .P00 .crt .CRT .bin .BIN .d6z .D6Z .d7z .D7Z .d8z .D8Z .g6z .G6Z .g4z .G4Z .x6z .X6Z .cmd .CMD .m3u .M3U .vsf .VSF .nib .NIB .nbz .NBZ .zip .ZIP|**retroarch:** vice_x64 (default)<br>**vicesa:** x64sc<br>|
|Commodore|Commodore PET (pet)|1977|`pet`|.20 .40 .60 .a0 .b0 .d64 .d71 .d80 .d81 .d82 .g64 .g41 .x64 .t64 .tap .prg .p00 .crt .bin .gz .d6z .d7z .d8z .g6z .g4z .x6z .cmd .m3u .vsf .nib .nbz .zip|**retroarch:** vice_xpet (default)<br>|
|Commodore|VIC-20 (vic20)|1980|`vic20`|.20 .40 .60 .a0 .A0 .b0 .B0 .d64 .D64 .d71 .D71 .d80 .D80 .d81 .D81 .d82 .D82 .g64 .G64 .g41 .G41 .x64 .X64 .t64 .T64 .tap .TAP .prg .PRG .p00 .P00 .crt .CRT .bin .BIN .gz .GZ .d6z .D6Z .d7z .D7Z .d8z .D8Z .g6z .G6Z .g4z .G4Z .x6z .X6Z .cmd .CMD .m3u .M3U .vsf .VSF .nib .NIB .nbz .NBZ .zip .ZIP|**retroarch:** vice_xvic (default)<br>**vicesa:** vice_xvic<br>|
|Fairchild|Channel F (channelf)|1976|`channelf`|.bin .BIN .chf .CHF .zip .ZIP .7z .7Z|**retroarch:** freechaf (default)<br>|
|id Software|Doom (doom)|1993|`doom`|.doom|**gzdoom:** gzdoom-sa (default)<br>|
|JELOS|Moonlight Game Streaming (moonlight)|2021|`moonlight`|.sh .SH||
|JELOS|MPlayer (mplayer)|unknown|`mplayer`|.mp4 .MP4 .mkv .MKV .avi .AVI .mov .MOV .wmv .WMV .m3u .M3U .mpg .MPG .ytb .YTB .twi .TWI .sh .SH .mp3 .MP3 .aac .AAC .mka .MKA .dts .DTS .flac .FLAC .ogg .OGG .m4a .M4A .ac3 .AC3 .opus .OPUS .wav .WAV .wv .WV .eac3 .EAC3 .thd .THD|**mplayer:** mplayer (default)<br>|
|JELOS|Ports (ports)|2021|`ports`|.sh .SH||
|JELOS|Screenshots (imageviewer)|2021|`screenshots`|.jpg .jpeg .png .bmp .psd .tga .gif .hdr .pic .ppm .pgm .mkv .pdf .mp4 .avi||
|JELOS|Tools (tools)|2021|`modules`|.sh||
|Lexaloffle|PICO-8 (pico-8)|2015|`pico-8`|.sh .p8 .png .SH .P8 .PNG|**pico-8:** pico8 (default)<br>**retroarch:** fake08<br>|
|Magnavox|Odyssey (odyssey2)|1979|`odyssey`|.bin .BIN .zip .ZIP .7z .7Z|**retroarch:** o2em (default)<br>|
|Mattel|Intellivision (intellivision)|1979|`intellivision`|.int .INT .bin .BIN .rom .ROM .zip .ZIP .7z .7Z|**retroarch:** freeintv (default)<br>|
|Microsoft|MS-DOS (pc)|1981|`pc`|.com .COM .bat .BAT .exe .EXE .dosz .DOSZ|**retroarch:** dosbox_pure<br>**retroarch:** dosbox_svn<br>|
|Microsoft|MSX (msx)|1983|`msx`|.dsk .DSK .mx1 .MX1 .mx2 .MX2 .rom .ROM .zip .ZIP .7z .7Z .M3U .m3u|**retroarch:** bluemsx (default)<br>**retroarch:** fmsx<br>|
|Microsoft|MSX2 (msx2)|1988|`msx2`|.dsk .DSK .mx1 .MX1 .mx2 .MX2 .rom .ROM .zip .ZIP .7z .7Z .M3U .m3u|**retroarch:** bluemsx (default)<br>**retroarch:** fmsx<br>|
|Milton Bradley|Vectrex (vectrex)|1982|`vectrex`|.bin .BIN .gam .GAM .vec .VEC .zip .ZIP .7z .7Z|**retroarch:** vecx (default)<br>|
|NEC|PC Engine (pcengine)|1987|`pcengine`|.pce .PCE .bin .BIN .zip .ZIP .7z .7Z|**retroarch:** beetle_pce_fast (default)<br>**retroarch:** beetle_pce<br>**retroarch:** beetle_supergrafx<br>|
|NEC|PC Engine CD (pcenginecd)|1988|`pcenginecd`|.cue .CUE .ccd .CCD .chd .CHD .toc .TOC .m3u .M3U|**retroarch:** beetle_pce_fast (default)<br>**retroarch:** beetle_pce<br>**retroarch:** beetle_supergrafx<br>|
|NEC|PC-8800 (pc-8800)|1981|`pc88`|.d88 .D88 .m3u .M3U|**retroarch:** quasi88 (default)<br>|
|NEC|PC-9800 (pc-9800)|1983|`pc98`|.d98 .zip .98d .fdi .fdd .2hd .tfd .d88 .88d .hdm .xdf .dup .hdi .thd .nhd .hdd .hdn|**retroarch:** np2kai (default)<br>|
|NEC|PC-FX (pcfx)|1994|`pcfx`|.chd .CHD .cue .CUE .ccd .CCD .toc .TOC|**retroarch:** beetle_pcfx (default)<br>|
|NEC|Super Grafx (supergrafx)|1989|`sgfx`|.pce .PCE .sgx .SGX .cue .CUE .ccd .CCD .chd .CHD .zip .ZIP .7z .7Z|**retroarch:** beetle_supergrafx<br>**retroarch:** beetle_pce<br>|
|NEC|TurboGrafx-16 (tg16)|1989|`tg16`|.pce .PCE .bin .BIN .zip .ZIP .7z .7Z|**retroarch:** beetle_pce_fast (default)<br>**retroarch:** beetle_pce<br>**retroarch:** beetle_supergrafx<br>|
|NEC|TurboGrafx-CD (tg16cd)|1989|`tg16cd`|.cue .CUE .ccd .CCD .chd .CHD .toc .TOC .m3u .M3U|**retroarch:** beetle_pce_fast (default)<br>**retroarch:** beetle_pce<br>**retroarch:** beetle_supergrafx<br>|
|Nesbox|TIC-80 (tic-80)|2017|`tic-80`|.tic .TIC|**retroarch:** tic80 (default)<br>|
|Nintendo|DS (nds)|2005|`nds`|.nds .zip .NDS .ZIP .7z|**drastic:** drastic-sa (default)<br>**retroarch:** melonds<br>|
|Nintendo|Famicom (famicom)|1983|`famicom`|.nes .NES .unif .UNIF .unf .UNF .zip .ZIP .7z .7Z|**retroarch:** nestopia (default)<br>**retroarch:** fceumm<br>**retroarch:** quicknes<br>**retroarch:** mesen<br>|
|Nintendo|Famicom Disk System (fds)|1986|`fds`|.fds .FDS .zip .ZIP .7z .7Z|**retroarch:** nestopia (default)<br>**retroarch:** fceumm<br>**retroarch:** quicknes<br>|
|Nintendo|Game and Watch (gameandwatch)|1980|`gameandwatch`|.mgw .MGW .zip .ZIP .7z .7Z|**retroarch:** gw<br>|
|Nintendo|Game Boy (gb)|1989|`gb`|.gb .GB .gbc .GBC .zip .ZIP .7z .7Z|**retroarch:** gambatte (default)<br>**retroarch:** sameboy<br>**retroarch:** gearboy<br>**retroarch:** tgbdual<br>**retroarch:** mgba<br>**retroarch:** vbam<br>|
|Nintendo|Game Boy (Hacks) (gbh)|1989|`gbh`|.gb .GB .zip .ZIP .7z .7Z|**retroarch:** gambatte (default)<br>**retroarch:** sameboy<br>**retroarch:** gearboy<br>**retroarch:** tgbdual<br>**retroarch:** mgba<br>**retroarch:** vbam<br>|
|Nintendo|Game Boy Advance (gba)|2001|`gba`|.gba .GBA .zip .ZIP .7z .7Z|**retroarch:** mgba (default)<br>**retroarch:** gbsp<br>**retroarch:** vbam<br>**retroarch:** vba_next<br>**retroarch:** beetle_gba<br>|
|Nintendo|Game Boy Advance (Hacks) (gbah)|2001|`gbah`|.gba .GBA .zip .ZIP .7z .7Z|**retroarch:** mgba (default)<br>**retroarch:** gbsp<br>**retroarch:** vbam<br>**retroarch:** vba_next<br>**retroarch:** beetle_gba<br>|
|Nintendo|Game Boy Color (gbc)|1998|`gbc`|.gb .GB .gbc .GBC .zip .ZIP .7z .7Z|**retroarch:** gambatte (default)<br>**retroarch:** sameboy<br>**retroarch:** gearboy<br>**retroarch:** tgbdual<br>**retroarch:** mgba<br>**retroarch:** vbam<br>|
|Nintendo|Game Boy Color (Hacks) (gbch)|1998|`gbch`|.gb .GB .gbc .GBC .zip .ZIP .7z .7Z|**retroarch:** gambatte (default)<br>**retroarch:** sameboy<br>**retroarch:** gearboy<br>**retroarch:** tgbdual<br>**retroarch:** mgba<br>**retroarch:** vbam<br>|
|Nintendo|GameCube (gamecube)|2001|`gamecube`|.gcm .GCM .iso .ISO .gcz .GCZ .ciso .CISO .wbfs .WBFS .rvz .RVZ .dol .DOL|**dolphin:** dolphin-sa-gc (default)<br>**primehack:** primehack<br>**retroarch:** dolphin<br>|
|Nintendo|MSU-1 (snesmsu1)|2012|`snesmsu1`|.smc .SMC .fig .FIG .sfc .SFC .swc .SWC .zip .ZIP .7z .7Z|**retroarch:** snes9x (default)<br>**retroarch:** beetle_supafaust<br>|
|Nintendo|N64 (n64)|1996|`n64`|.z64 .Z64 .n64 .N64 .v64 .V64 .zip .ZIP .7z .7Z|**retroarch:** mupen64plus_next (default)<br>**retroarch:** mupen64plus<br>**retroarch:** parallel_n64<br>**mupen64plus-sa:** m64p_gliden64<br>**mupen64plus-sa:** m64p_gl64mk2<br>**mupen64plus-sa:** m64p_rice<br>|
|Nintendo|NES (Hacks) (nesh)|1985|`nesh`|.nes .NES .unif .UNIF .unf .UNF .zip .ZIP .7z .7Z|**retroarch:** nestopia (default)<br>**retroarch:** fceumm<br>**retroarch:** quicknes<br>**retroarch:** mesen<br>|
|Nintendo|NES (nes)|1985|`nes`|.nes .NES .unif .UNIF .unf .UNF .zip .ZIP .7z .7Z|**retroarch:** nestopia (default)<br>**retroarch:** fceumm<br>**retroarch:** quicknes<br>**retroarch:** mesen<br>|
|Nintendo|Pokémon Mini (pokemini)|2001|`pokemini`|.min .MIN .zip .ZIP .7z .7Z|**retroarch:** pokemini (default)<br>|
|Nintendo|Satellaview (satellaview)|1995|`satellaview`|.smc .SMC .fig .FIG .bs .BS .sfc .SFC .bsx .BSX .swc .SWC .zip .ZIP .7z .7Z|**retroarch:** snes9x (default)<br>**retroarch:** snes9x2010<br>**retroarch:** snes9x2002<br>**retroarch:** snes9x2005_plus<br>|
|Nintendo|Super Famicom (sfc)|1990|`sfc`|.smc .SMC .fig .FIG .sfc .SFC .swc .SWC .zip .ZIP .7z .7Z|**retroarch:** snes9x (default)<br>**retroarch:** snes9x2010<br>**retroarch:** snes9x2002<br>**retroarch:** snes9x2005_plus<br>**retroarch:** beetle_supafaust<br>**retroarch:** bsnes<br>**retroarch:** bsnes_mercury_performance<br>**retroarch:** bsnes_hd_beta<br>|
|Nintendo|Super Nintendo (Hacks) (snesh)|1991|`snesh`|.smc .SMC .fig .FIG .sfc .SFC .swc .SWC .zip .ZIP .7z .7Z|**retroarch:** snes9x (default)<br>**retroarch:** snes9x2010<br>**retroarch:** snes9x2002<br>**retroarch:** snes9x2005_plus<br>**retroarch:** beetle_supafaust<br>**retroarch:** bsnes<br>**retroarch:** bsnes_mercury_performance<br>**retroarch:** bsnes_hd_beta<br>|
|Nintendo|Super Nintendo (snes)|1991|`snes`|.smc .SMC .fig .FIG .sfc .SFC .swc .SWC .zip .ZIP .7z .7Z|**retroarch:** snes9x (default)<br>**retroarch:** snes9x2010<br>**retroarch:** snes9x2002<br>**retroarch:** snes9x2005_plus<br>**retroarch:** beetle_supafaust<br>**retroarch:** bsnes<br>**retroarch:** bsnes_mercury_performance<br>**retroarch:** bsnes_hd_beta<br>|
|Nintendo|Virtual Boy (virtualboy)|1995|`virtualboy`|.vb .VB .zip .ZIP .7z .7Z|**retroarch:** beetle_vb (default)<br>|
|Nintendo|Wii (wii)|2006|`wii`|.gcm .GCM .iso .ISO .gcz .GCZ .ciso .CISO .wbfs .WBFS .rvz .RVZ .dol .DOL .wad .WAD|**dolphin:** dolphin-sa-wii (default)<br>**primehack:** primehack<br>**retroarch:** dolphin<br>|
|Panasonic|3DO (3do)|1993|`3do`|.iso .ISO .bin .BIN .chd .CHD .cue .CUE|**retroarch:** opera (default)<br>|
|Philips|VideoPac (videopac)|1978|`videopac`|.bin .BIN .zip .ZIP .7z .7Z|**retroarch:** o2em (default)<br>|
|Sammy|Atomiswave (atomiswave)|2003|`atomiswave`|.lst .LST .bin .BIN .dat .DAT .zip .ZIP .7z .7Z|**retroarch:** flycast2021<br>**retroarch:** flycast32 (default)<br>**retroarch:** flycast<br>**flycast:** flycast-sa<br>|
|Sega|32X (sega32x)|1994|`sega32x`|.32x .32X .smd .SMD .bin .BIN .md .MD .zip .ZIP .7z .7Z|**retroarch:** picodrive (default)<br>|
|Sega|CD (segacd)|1991|`segacd`|.chd .CHD .cue .CUE .iso .ISO .m3u .M3U|**retroarch:** genesis_plus_gx (default)<br>**retroarch:** picodrive<br>|
|Sega|Dreamcast (dreamcast)|1998|`dreamcast`|.cdi .CDI .gdi .GDI .chd .CHD .m3u .M3U|**retroarch:** flycast2021<br>**retroarch:** flycast32 (default)<br>**retroarch:** flycast<br>**flycast:** flycast-sa<br>|
|Sega|Game Gear (gamegear)|1990|`gamegear`|.bin .BIN .gg .GG .zip .ZIP .7z .7Z|**retroarch:** gearsystem (default)<br>**retroarch:** genesis_plus_gx<br>**retroarch:** picodrive<br>**retroarch:** smsplus<br>|
|Sega|Game Gear (Hacks) (ggh)|1990|`gamegearh`|.bin .BIN .gg .GG .zip .ZIP .7z .7Z|**retroarch:** gearsystem (default)<br>**retroarch:** genesis_plus_gx<br>**retroarch:** picodrive<br>**retroarch:** smsplus<br>|
|Sega|Genesis (genesis)|1989|`genesis`|.bin .BIN .gen .GEN .md .MD .sg .SG .smd .SMD .zip .ZIP .7z .7Z|**retroarch:** genesis_plus_gx (default)<br>**retroarch:** genesis_plus_gx_wide<br>**retroarch:** picodrive<br>|
|Sega|Genesis (Hacks) (genh)|1989|`genh`|.bin .BIN .gen .GEN .md .MD .sg .SG .smd .SMD .zip .ZIP .7z .7Z|**retroarch:** genesis_plus_gx (default)<br>**retroarch:** genesis_plus_gx_wide<br>**retroarch:** picodrive<br>|
|Sega|Master System (mastersystem)|1985|`mastersystem`|.bin .BIN .sms .SMS .zip .ZIP .7z .7Z|**retroarch:** gearsystem (default)<br>**retroarch:** genesis_plus_gx<br>**retroarch:** picodrive<br>**retroarch:** smsplus<br>|
|Sega|Mega Drive (megadrive)|1990|`megadrive`|.bin .BIN .gen .GEN .md .MD .sg .SG .smd .SMD .zip .ZIP .7z .7Z|**retroarch:** genesis_plus_gx (default)<br>**retroarch:** genesis_plus_gx_wide<br>**retroarch:** picodrive<br>|
|Sega|Mega Drive (megadrive-japan)|1988|`megadrive-japan`|.bin .BIN .gen .GEN .md .MD .sg .SG .smd .SMD .zip .ZIP .7z .7Z|**retroarch:** genesis_plus_gx (default)<br>**retroarch:** genesis_plus_gx_wide<br>**retroarch:** picodrive<br>|
|Sega|Mega-CD (megacd)|1991|`megacd`|.chd .CHD .cue .CUE .iso .ISO .m3u .M3U|**retroarch:** genesis_plus_gx (default)<br>**retroarch:** picodrive<br>|
|Sega|Naomi (naomi)|1998|`naomi`|.lst .LST .bin .BIN .dat .DAT .zip .ZIP .7z .7Z|**retroarch:** flycast2021<br>**retroarch:** flycast32 (default)<br>**retroarch:** flycast<br>**flycast:** flycast-sa<br>|
|Sega|Saturn (saturn)|1994|`saturn`|.cue .CUE .chd .CHD .iso .ISO|**yabasanshiro:** yabasanshiro-sa (default)<br>**retroarch:** yabasanshiro<br>**retroarch:** beetle_saturn<br>|
|Sega|SG-1000 (sg-1000)|1983|`sg-1000`|.bin .BIN .sg .SG .zip .ZIP .7z .7Z|**retroarch:** gearsystem (default)<br>**retroarch:** genesis_plus_gx<br>**retroarch:** picodrive<br>|
|Sharp|X1 (x1)|1982|`x1`|.dx1 .DX1 .2d .2D .2hd .2HD .tfd .TFD .d88 .D88 .88d .88D .hdm .HDM .xdf .XDF .dup .DUP .tap .TAP .cmd .CMD .zip .ZIP .7z .7Z|**retroarch:** x1 (default)<br>|
|Sharp|x68000 (x68000)|1987|`x68000`|.dim .DIM .img .IMG .d88 .D88 .88d .88D .hdm .HDM .dup .DUP .2hd .2HD .xdf .XDF .hdf .HDF .cmd .CMD .m3u .M3U .zip .ZIP .7z .7Z|**retroarch:** px68k (default)<br>|
|Sinclair|ZX Spectrum (zxspectrum)|1982|`zxspectrum`|.tzx .TZX .tap .TAP .z80 .Z80 .rzx .RZX .scl .SCL .trd .TRD .dsk .DSK .zip .ZIP .7z .7Z|**retroarch:** fuse<br>|
|Sinclair|ZX81 (zx81)|1981|`zx81`|.tzx .TZX .p .P .zip .ZIP .7z .7Z|**retroarch:** 81 (default)<br>|
|SNK|Neo Geo (neogeo)|1990|`neogeo`|.7z .7Z .zip .ZIP|**retroarch:** fbneo (default)<br>**retroarch:** mame2003_plus<br>**retroarch:** fbalpha2012<br>**retroarch:** fbalpha2019<br>**retroarch:** mame2010<br>**retroarch:** mame2015<br>**retroarch:** mame<br>|
|SNK|Neo Geo CD (neocd)|1990|`neocd`|.cue .CUE .iso .ISO .chd .CHD|**retroarch:** neocd (default)<br>**retroarch:** fbneo<br>|
|SNK|Neo Geo Pocket (ngp)|1998|`ngp`|.ngc .NGC .ngp .NGP .zip .ZIP .7z .7Z|**retroarch:** beetle_ngp (default)<br>**retroarch:** race<br>|
|SNK|Neo Geo Pocket Color (ngpc)|1999|`ngpc`|.ngc .NGC .zip .ZIP .7z .7Z|**retroarch:** beetle_ngp (default)<br>**retroarch:** race<br>|
|Sony|PlayStation (psx)|1994|`psx`|.bin .BIN .cue .CUE .img .IMG .mdf .MDF .pbp .PBP .toc .TOC .cbn .CBN .m3u .M3U .ccd .CCD .chd .CHD .iso .ISO|**retroarch:** pcsx_rearmed32 (default)<br>**retroarch:** pcsx_rearmed<br>**retroarch:** beetle_psx<br>**Duckstation:** duckstation-sa<br>**retroarch:** duckstation<br>**retroarch:** swanstation<br>|
|Sony|PlayStation 2 (ps2)|2000|`ps2`|.iso .ISO .mdf .MDF .nrg .NRG .bin .BIN .img .IMG .dump .DUMP .gz .GZ .cso .CSO .chd .CHD|**aethersx2:** aethersx2-sa (default)<br>|
|Sony|PlayStation Portable (psp)|2004|`psp`|.iso .ISO .cso .CSO .pbp .PBP|**ppsspp:** ppsspp-sa (default)<br>|
|Sony|PSP Minis (pspminis)|2004|`pspminis`|.iso .ISO .cso .CSO .pbp .PBP|**ppsspp:** ppsspp-sa (default)<br>**retroarch:** ppsspp<br>|
|Sun Microsystems|J2ME (j2me)|2002|`j2me`|.jar .JAR|**retroarch:** freej2me (default)<br>|
|Various|EasyRPG (easyrpg)|2003|`easyrpg`|.zip .ZIP .easyrpg .EASYRPG .ldb .LDB|**retroarch:** easyrpg (default)<br>|
|Various|OpenBOR (openbor)|2008|`openbor`|.pak .PAK|**OpenBOR:** OpenBOR (default)<br>|
|Various|ScummVM (scummvm)|2001|`games`|.sh .SH .svm .SVM .scummvm|**scummvmsa:** scummvm (default)<br>**retroarch:** scummvm<br>|
|Watara|Supervision (supervision)|1992|`supervision`|.sv .SV .zip .ZIP .7z .7Z|**retroarch:** potator (default)<br>|
|Welback Holdings|Mega Duck (megaduck)|1993|`megaduck`|.bin .BIN .zip .ZIP .7z .7Z|**retroarch:** sameduck (default)<br>|

112
documentation/S922X/SUPPORTED_EMULATORS_AND_CORES.md Normal file
View file

@ -0,0 +1,112 @@
&nbsp;&nbsp;<img src="https://raw.githubusercontent.com/JustEnoughLinuxOS/distribution/dev/distributions/JELOS/logos/jelos-logo.png" width=192>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[![Latest Version](https://img.shields.io/github/release/JustEnoughLinuxOS/distribution.svg?color=5998FF&label=latest%20version&style=flat-square)](https://github.com/JustEnoughLinuxOS/distribution/releases/latest) [![Activity](https://img.shields.io/github/commit-activity/m/JustEnoughLinuxOS/distribution?color=5998FF&style=flat-square)](https://github.com/JustEnoughLinuxOS/distribution/commits) [![Pull Requests](https://img.shields.io/github/issues-pr-closed/JustEnoughLinuxOS/distribution?color=5998FF&style=flat-square)](https://github.com/JustEnoughLinuxOS/distribution/pulls) [![Discord Server](https://img.shields.io/discord/948029830325235753?color=5998FF&label=chat&style=flat-square)](https://discord.gg/seTxckZjJy)
#
|Manufacturer|System|Release Date|Games Path|Supported Extensions|Emulator / Core|
|----|----|----|----|----|----|
|Amstrad|CPC (amstradcpc)|1984|`amstradcpc`|.dsk .DSK .sna .SNA .tap .TAP .cdt .CDT .kcr .KCR .voc .VOC .m3u .M3U .zip .ZIP .7z .7Z|**retroarch:** crocods (default)<br>**retroarch:** cap32<br>|
|Arcade|Arcade (arcade)|1984|`arcade`|.zip .ZIP .7z .7Z|**retroarch:** mame2003_plus (default)<br>**retroarch:** mame2000<br>**retroarch:** mame2010<br>**retroarch:** mame2015<br>**retroarch:** fbneo<br>**retroarch:** fbalpha2012<br>**retroarch:** fbalpha2019<br>**retroarch:** mame<br>|
|Arcade|Daphne (daphne)|1996|`daphne`|.daphne .DAPHNE .zip .ZIP|**hypseus:** hypseus (default)<br>**retroarch:** daphne<br>|
|Arcade|Final Burn Neo (fbn)|1986|`fbneo`|.7z .zip .7Z .ZIP|**retroarch:** fbneo (default)<br>**retroarch:** mame2003_plus<br>**retroarch:** mame2010<br>**retroarch:** mame2015<br>**retroarch:** mame<br>**retroarch:** fbalpha2012<br>**retroarch:** fbalpha2019<br>|
|Arcade|MAME (mame)|1989|`mame`|.7z .7Z .zip .ZIP|**retroarch:** mame2003_plus (default)<br>**retroarch:** mame2010<br>**retroarch:** mame2015<br>**retroarch:** mame<br>**retroarch:** fbneo<br>**retroarch:** fbalpha2012<br>**retroarch:** fbalpha2019<br>|
|Atari|2600 (atari2600)|1977|`atari2600`|.a26 .A26 .bin .BIN .zip .ZIP .7z .7Z|**retroarch:** stella (default)<br>|
|Atari|5200 (atari5200)|1982|`atari5200`|.rom .ROM .xfd .XFD .atr .ATR .atx .ATX .cdm .CDM .cas .CAS .car .CAR .bin .BIN .a52 .A52 .xex .XEX .zip .ZIP .7z .7Z|**retroarch:** a5200 (default)<br>**retroarch:** atari800<br>|
|Atari|7800 (atari7800)|1986|`atari7800`|.a78 .A78 .bin .BIN .zip .ZIP .7z .7Z|**retroarch:** prosystem (default)<br>|
|Atari|Atari 800 (atari800)|1979|`atari800`|.rom .ROM .xfd .XFD .atr .ATR .atx .ATX .cdm .CDM .cas .CAS .car .CAR .bin .BIN .a52 .A52 .xex .XEX .zip .ZIP .7z .7Z|**retroarch:** atari800 (default)<br>|
|Atari|Atari ST (atarist)|1985|`atarist`|.st .ST .msa .MSA .stx .STX .dim .DIM .ipf .IPF .m3u .M3U .zip .ZIP .7z .7Z|**retroarch:** hatari (default)<br>**hatarisa:** hatarisa<br>|
|Atari|Jaguar (atarijaguar)|1993|`atarijaguar`|.j64 .J64 .jag .JAG .rom .ROM .abs .ABS .cof .COF .bin .BIN .prg .PRG|**retroarch:** virtualjaguar (default)<br>|
|Atari|Lynx (atarilynx)|1989|`atarilynx`|.lnx .LNX .o .O .zip .ZIP .7z .7Z|**retroarch:** handy (default)<br>**retroarch:** beetle_lynx<br>|
|Bandai|SuFami Turbo (sufami)|1996|`sufami`|.st .ST .zip .ZIP .7z .7Z|**retroarch:** snes9x (default)<br>|
|Bandai|Wonderswan (wonderswan)|1999|`wonderswan`|.ws .WS .zip .ZIP .7z .7Z|**retroarch:** beetle_wswan (default)<br>|
|Bandai|Wonderswan Color (wonderswancolor)|2000|`wonderswancolor`|.wsc .WSC .zip .ZIP .7z .7Z|**retroarch:** beetle_wswan (default)<br>|
|belogic|Uzebox (uzebox)|2008|`uzebox`|.uze .UZE|**retroarch:** uzem (default)<br>|
|Capcom|PlaySystem 1 (cps1)|1988|`cps1`|.zip .ZIP .7z .7Z|**retroarch:** fbneo (default)<br>**retroarch:** mame2003_plus<br>**retroarch:** mame2010<br>**retroarch:** fbalpha2012<br>**retroarch:** mba_mini<br>**AdvanceMame:** AdvanceMame<br>|
|Capcom|PlaySystem 2 (cps2)|1993|`cps2`|.zip .ZIP .7z .7Z|**retroarch:** fbneo (default)<br>**retroarch:** mame2003_plus<br>**retroarch:** mame2010<br>**retroarch:** fbalpha2012<br>**retroarch:** mba_mini<br>**AdvanceMame:** AdvanceMame<br>|
|Capcom|PlaySystem 3 (cps3)|1996|`cps3`|.zip .ZIP .7z .7Z|**retroarch:** fbneo (default)<br>**retroarch:** mame2003_plus<br>**retroarch:** mame2010<br>**retroarch:** fbalpha2012<br>**retroarch:** mba_mini<br>**AdvanceMame:** AdvanceMame<br>|
|Coleco|ColecoVision (colecovision)|1982|`coleco`|.bin .BIN .col .COL .rom .ROM .zip .ZIP .7z .7Z|**retroarch:** bluemsx (default)<br>**retroarch:** gearcoleco<br>**retroarch:** smsplus<br>|
|Commodore|Amiga (amiga)|1985|`amiga`|.zip .ZIP .adf .ADF .uae .UAE .ipf .IPF .dms .DMS .adz .ADZ .lha .LHA .m3u .M3U .hdf .HDF .hdz .HDZ|**retroarch:** puae (default)<br>**amiberry:** false<br>|
|Commodore|Amiga CD32 (amigacd32)|1994|`amigacd32`|.iso .ISO .cue .CUE .lha .LHA .chd .CHD|**retroarch:** puae (default)<br>**retroarch:** uae4arm<br>|
|Commodore|C128 (c128)|1985|`c128`|.d64 .D64 .d71 .D71 .d80 .D80 .d81 .D81 .d82 .D82 .g64 .G64 .g41 .G41 .x64 .X64 .t64 .T64 .tap .TAP .prg .PRG .p00 .P00 .crt .CRT .bin .BIN .d6z .D6Z .d7z .D7Z .d8z .D8Z .g6z .G6Z .g4z .G4Z .x6z .X6Z .cmd .CMD .m3u .M3U .vsf .VSF .nib .NIB .nbz .NBZ .zip .ZIP|**retroarch:** vice_x128 (default)<br>**vicesa:** x128<br>|
|Commodore|C16 (c16)|1984|`c16`|.d64 .D64 .d71 .D71 .d80 .D80 .d81 .D81 .d82 .D82 .g64 .G64 .g41 .G41 .x64 .X64 .t64 .T64 .tap .TAP .prg .PRG .p00 .P00 .crt .CRT .bin .BIN .d6z .D6Z .d7z .D7Z .d8z .D8Z .g6z .G6Z .g4z .G4Z .x6z .X6Z .cmd .CMD .m3u .M3U .vsf .VSF .nib .NIB .nbz .NBZ .zip .ZIP|**retroarch:** vice_xplus4 (default)<br>**vicesa:** xplus4<br>|
|Commodore|C64 (c64)|1982|`c64`|.d64 .D64 .d71 .D71 .d80 .D80 .d81 .D81 .d82 .D82 .g64 .G64 .g41 .G41 .x64 .X64 .t64 .T64 .tap .TAP .prg .PRG .p00 .P00 .crt .CRT .bin .BIN .d6z .D6Z .d7z .D7Z .d8z .D8Z .g6z .G6Z .g4z .G4Z .x6z .X6Z .cmd .CMD .m3u .M3U .vsf .VSF .nib .NIB .nbz .NBZ .zip .ZIP|**retroarch:** vice_x64 (default)<br>**vicesa:** x64sc<br>|
|Commodore|Commodore PET (pet)|1977|`pet`|.20 .40 .60 .a0 .b0 .d64 .d71 .d80 .d81 .d82 .g64 .g41 .x64 .t64 .tap .prg .p00 .crt .bin .gz .d6z .d7z .d8z .g6z .g4z .x6z .cmd .m3u .vsf .nib .nbz .zip|**retroarch:** vice_xpet (default)<br>|
|Commodore|VIC-20 (vic20)|1980|`vic20`|.20 .40 .60 .a0 .A0 .b0 .B0 .d64 .D64 .d71 .D71 .d80 .D80 .d81 .D81 .d82 .D82 .g64 .G64 .g41 .G41 .x64 .X64 .t64 .T64 .tap .TAP .prg .PRG .p00 .P00 .crt .CRT .bin .BIN .gz .GZ .d6z .D6Z .d7z .D7Z .d8z .D8Z .g6z .G6Z .g4z .G4Z .x6z .X6Z .cmd .CMD .m3u .M3U .vsf .VSF .nib .NIB .nbz .NBZ .zip .ZIP|**retroarch:** vice_xvic (default)<br>**vicesa:** vice_xvic<br>|
|Fairchild|Channel F (channelf)|1976|`channelf`|.bin .BIN .chf .CHF .zip .ZIP .7z .7Z|**retroarch:** freechaf (default)<br>|
|id Software|Doom (doom)|1993|`doom`|.doom|**gzdoom:** gzdoom-sa (default)<br>|
|JELOS|Moonlight Game Streaming (moonlight)|2021|`moonlight`|.sh .SH||
|JELOS|MPlayer (mplayer)|unknown|`mplayer`|.mp4 .MP4 .mkv .MKV .avi .AVI .mov .MOV .wmv .WMV .m3u .M3U .mpg .MPG .ytb .YTB .twi .TWI .sh .SH .mp3 .MP3 .aac .AAC .mka .MKA .dts .DTS .flac .FLAC .ogg .OGG .m4a .M4A .ac3 .AC3 .opus .OPUS .wav .WAV .wv .WV .eac3 .EAC3 .thd .THD|**mplayer:** mplayer (default)<br>|
|JELOS|Ports (ports)|2021|`ports`|.sh .SH||
|JELOS|Screenshots (imageviewer)|2021|`screenshots`|.jpg .jpeg .png .bmp .psd .tga .gif .hdr .pic .ppm .pgm .mkv .pdf .mp4 .avi||
|JELOS|Tools (tools)|2021|`modules`|.sh||
|Lexaloffle|PICO-8 (pico-8)|2015|`pico-8`|.sh .p8 .png .SH .P8 .PNG|**pico-8:** pico8 (default)<br>**retroarch:** fake08<br>|
|Magnavox|Odyssey (odyssey2)|1979|`odyssey`|.bin .BIN .zip .ZIP .7z .7Z|**retroarch:** o2em (default)<br>|
|Mattel|Intellivision (intellivision)|1979|`intellivision`|.int .INT .bin .BIN .rom .ROM .zip .ZIP .7z .7Z|**retroarch:** freeintv (default)<br>|
|Microsoft|MS-DOS (pc)|1981|`pc`|.com .COM .bat .BAT .exe .EXE .dosz .DOSZ|**retroarch:** dosbox_pure<br>**retroarch:** dosbox_svn<br>|
|Microsoft|MSX (msx)|1983|`msx`|.dsk .DSK .mx1 .MX1 .mx2 .MX2 .rom .ROM .zip .ZIP .7z .7Z .M3U .m3u|**retroarch:** bluemsx (default)<br>**retroarch:** fmsx<br>|
|Microsoft|MSX2 (msx2)|1988|`msx2`|.dsk .DSK .mx1 .MX1 .mx2 .MX2 .rom .ROM .zip .ZIP .7z .7Z .M3U .m3u|**retroarch:** bluemsx (default)<br>**retroarch:** fmsx<br>|
|Milton Bradley|Vectrex (vectrex)|1982|`vectrex`|.bin .BIN .gam .GAM .vec .VEC .zip .ZIP .7z .7Z|**retroarch:** vecx (default)<br>|
|NEC|PC Engine (pcengine)|1987|`pcengine`|.pce .PCE .bin .BIN .zip .ZIP .7z .7Z|**retroarch:** beetle_pce_fast (default)<br>**retroarch:** beetle_pce<br>**retroarch:** beetle_supergrafx<br>|
|NEC|PC Engine CD (pcenginecd)|1988|`pcenginecd`|.cue .CUE .ccd .CCD .chd .CHD .toc .TOC .m3u .M3U|**retroarch:** beetle_pce_fast (default)<br>**retroarch:** beetle_pce<br>**retroarch:** beetle_supergrafx<br>|
|NEC|PC-8800 (pc-8800)|1981|`pc88`|.d88 .D88 .m3u .M3U|**retroarch:** quasi88 (default)<br>|
|NEC|PC-9800 (pc-9800)|1983|`pc98`|.d98 .zip .98d .fdi .fdd .2hd .tfd .d88 .88d .hdm .xdf .dup .hdi .thd .nhd .hdd .hdn|**retroarch:** np2kai (default)<br>|
|NEC|PC-FX (pcfx)|1994|`pcfx`|.chd .CHD .cue .CUE .ccd .CCD .toc .TOC|**retroarch:** beetle_pcfx (default)<br>|
|NEC|Super Grafx (supergrafx)|1989|`sgfx`|.pce .PCE .sgx .SGX .cue .CUE .ccd .CCD .chd .CHD .zip .ZIP .7z .7Z|**retroarch:** beetle_supergrafx<br>**retroarch:** beetle_pce<br>|
|NEC|TurboGrafx-16 (tg16)|1989|`tg16`|.pce .PCE .bin .BIN .zip .ZIP .7z .7Z|**retroarch:** beetle_pce_fast (default)<br>**retroarch:** beetle_pce<br>**retroarch:** beetle_supergrafx<br>|
|NEC|TurboGrafx-CD (tg16cd)|1989|`tg16cd`|.cue .CUE .ccd .CCD .chd .CHD .toc .TOC .m3u .M3U|**retroarch:** beetle_pce_fast (default)<br>**retroarch:** beetle_pce<br>**retroarch:** beetle_supergrafx<br>|
|Nesbox|TIC-80 (tic-80)|2017|`tic-80`|.tic .TIC|**retroarch:** tic80 (default)<br>|
|Nintendo|3DS (3ds)|2010|`3ds`|.3ds .3DS .3dsx .3DSX .elf .ELF .axf .AXF .cci .CCI .cxi .CXI .app .APP|**citra:** citra-sa (default)<br>|
|Nintendo|DS (nds)|2005|`nds`|.nds .zip .NDS .ZIP .7z|**drastic:** drastic-sa (default)<br>**retroarch:** melonds<br>|
|Nintendo|Famicom (famicom)|1983|`famicom`|.nes .NES .unif .UNIF .unf .UNF .zip .ZIP .7z .7Z|**retroarch:** nestopia (default)<br>**retroarch:** fceumm<br>**retroarch:** quicknes<br>**retroarch:** mesen<br>|
|Nintendo|Famicom Disk System (fds)|1986|`fds`|.fds .FDS .zip .ZIP .7z .7Z|**retroarch:** nestopia (default)<br>**retroarch:** fceumm<br>**retroarch:** quicknes<br>|
|Nintendo|Game and Watch (gameandwatch)|1980|`gameandwatch`|.mgw .MGW .zip .ZIP .7z .7Z|**retroarch:** gw<br>|
|Nintendo|Game Boy (gb)|1989|`gb`|.gb .GB .gbc .GBC .zip .ZIP .7z .7Z|**retroarch:** gambatte (default)<br>**retroarch:** sameboy<br>**retroarch:** gearboy<br>**retroarch:** tgbdual<br>**retroarch:** mgba<br>**retroarch:** vbam<br>|
|Nintendo|Game Boy (Hacks) (gbh)|1989|`gbh`|.gb .GB .zip .ZIP .7z .7Z|**retroarch:** gambatte (default)<br>**retroarch:** sameboy<br>**retroarch:** gearboy<br>**retroarch:** tgbdual<br>**retroarch:** mgba<br>**retroarch:** vbam<br>|
|Nintendo|Game Boy Advance (gba)|2001|`gba`|.gba .GBA .zip .ZIP .7z .7Z|**retroarch:** mgba (default)<br>**retroarch:** gbsp<br>**retroarch:** vbam<br>**retroarch:** vba_next<br>**retroarch:** beetle_gba<br>|
|Nintendo|Game Boy Advance (Hacks) (gbah)|2001|`gbah`|.gba .GBA .zip .ZIP .7z .7Z|**retroarch:** mgba (default)<br>**retroarch:** gbsp<br>**retroarch:** vbam<br>**retroarch:** vba_next<br>**retroarch:** beetle_gba<br>|
|Nintendo|Game Boy Color (gbc)|1998|`gbc`|.gb .GB .gbc .GBC .zip .ZIP .7z .7Z|**retroarch:** gambatte (default)<br>**retroarch:** sameboy<br>**retroarch:** gearboy<br>**retroarch:** tgbdual<br>**retroarch:** mgba<br>**retroarch:** vbam<br>|
|Nintendo|Game Boy Color (Hacks) (gbch)|1998|`gbch`|.gb .GB .gbc .GBC .zip .ZIP .7z .7Z|**retroarch:** gambatte (default)<br>**retroarch:** sameboy<br>**retroarch:** gearboy<br>**retroarch:** tgbdual<br>**retroarch:** mgba<br>**retroarch:** vbam<br>|
|Nintendo|GameCube (gamecube)|2001|`gamecube`|.gcm .GCM .iso .ISO .gcz .GCZ .ciso .CISO .wbfs .WBFS .rvz .RVZ .dol .DOL|**dolphin:** dolphin-sa-gc (default)<br>**primehack:** primehack<br>**retroarch:** dolphin<br>|
|Nintendo|MSU-1 (snesmsu1)|2012|`snesmsu1`|.smc .SMC .fig .FIG .sfc .SFC .swc .SWC .zip .ZIP .7z .7Z|**retroarch:** snes9x (default)<br>**retroarch:** beetle_supafaust<br>|
|Nintendo|N64 (n64)|1996|`n64`|.z64 .Z64 .n64 .N64 .v64 .V64 .zip .ZIP .7z .7Z|**retroarch:** mupen64plus_next (default)<br>**retroarch:** mupen64plus<br>**retroarch:** parallel_n64<br>**mupen64plus-sa:** m64p_gliden64<br>**mupen64plus-sa:** m64p_gl64mk2<br>**mupen64plus-sa:** m64p_rice<br>|
|Nintendo|NES (Hacks) (nesh)|1985|`nesh`|.nes .NES .unif .UNIF .unf .UNF .zip .ZIP .7z .7Z|**retroarch:** nestopia (default)<br>**retroarch:** fceumm<br>**retroarch:** quicknes<br>**retroarch:** mesen<br>|
|Nintendo|NES (nes)|1985|`nes`|.nes .NES .unif .UNIF .unf .UNF .zip .ZIP .7z .7Z|**retroarch:** nestopia (default)<br>**retroarch:** fceumm<br>**retroarch:** quicknes<br>**retroarch:** mesen<br>|
|Nintendo|Pokémon Mini (pokemini)|2001|`pokemini`|.min .MIN .zip .ZIP .7z .7Z|**retroarch:** pokemini (default)<br>|
|Nintendo|Satellaview (satellaview)|1995|`satellaview`|.smc .SMC .fig .FIG .bs .BS .sfc .SFC .bsx .BSX .swc .SWC .zip .ZIP .7z .7Z|**retroarch:** snes9x (default)<br>**retroarch:** snes9x2010<br>**retroarch:** snes9x2002<br>**retroarch:** snes9x2005_plus<br>|
|Nintendo|Super Famicom (sfc)|1990|`sfc`|.smc .SMC .fig .FIG .sfc .SFC .swc .SWC .zip .ZIP .7z .7Z|**retroarch:** snes9x (default)<br>**retroarch:** snes9x2010<br>**retroarch:** snes9x2002<br>**retroarch:** snes9x2005_plus<br>**retroarch:** beetle_supafaust<br>**retroarch:** bsnes<br>**retroarch:** bsnes_mercury_performance<br>**retroarch:** bsnes_hd_beta<br>|
|Nintendo|Super Nintendo (Hacks) (snesh)|1991|`snesh`|.smc .SMC .fig .FIG .sfc .SFC .swc .SWC .zip .ZIP .7z .7Z|**retroarch:** snes9x (default)<br>**retroarch:** snes9x2010<br>**retroarch:** snes9x2002<br>**retroarch:** snes9x2005_plus<br>**retroarch:** beetle_supafaust<br>**retroarch:** bsnes<br>**retroarch:** bsnes_mercury_performance<br>**retroarch:** bsnes_hd_beta<br>|
|Nintendo|Super Nintendo (snes)|1991|`snes`|.smc .SMC .fig .FIG .sfc .SFC .swc .SWC .zip .ZIP .7z .7Z|**retroarch:** snes9x (default)<br>**retroarch:** snes9x2010<br>**retroarch:** snes9x2002<br>**retroarch:** snes9x2005_plus<br>**retroarch:** beetle_supafaust<br>**retroarch:** bsnes<br>**retroarch:** bsnes_mercury_performance<br>**retroarch:** bsnes_hd_beta<br>|
|Nintendo|Virtual Boy (virtualboy)|1995|`virtualboy`|.vb .VB .zip .ZIP .7z .7Z|**retroarch:** beetle_vb (default)<br>|
|Nintendo|Wii (wii)|2006|`wii`|.gcm .GCM .iso .ISO .gcz .GCZ .ciso .CISO .wbfs .WBFS .rvz .RVZ .dol .DOL .wad .WAD|**dolphin:** dolphin-sa-wii (default)<br>**primehack:** primehack<br>**retroarch:** dolphin<br>|
|Panasonic|3DO (3do)|1993|`3do`|.iso .ISO .bin .BIN .chd .CHD .cue .CUE|**retroarch:** opera (default)<br>|
|Philips|VideoPac (videopac)|1978|`videopac`|.bin .BIN .zip .ZIP .7z .7Z|**retroarch:** o2em (default)<br>|
|Sammy|Atomiswave (atomiswave)|2003|`atomiswave`|.lst .LST .bin .BIN .dat .DAT .zip .ZIP .7z .7Z|**retroarch:** flycast2021<br>**flycast:** flycast-sa (default)<br>**retroarch:** flycast<br>|
|Sega|32X (sega32x)|1994|`sega32x`|.32x .32X .smd .SMD .bin .BIN .md .MD .zip .ZIP .7z .7Z|**retroarch:** picodrive (default)<br>|
|Sega|CD (segacd)|1991|`segacd`|.chd .CHD .cue .CUE .iso .ISO .m3u .M3U|**retroarch:** genesis_plus_gx (default)<br>**retroarch:** picodrive<br>|
|Sega|Dreamcast (dreamcast)|1998|`dreamcast`|.cdi .CDI .gdi .GDI .chd .CHD .m3u .M3U|**retroarch:** flycast2021<br>**flycast:** flycast-sa (default)<br>**retroarch:** flycast<br>|
|Sega|Game Gear (gamegear)|1990|`gamegear`|.bin .BIN .gg .GG .zip .ZIP .7z .7Z|**retroarch:** gearsystem (default)<br>**retroarch:** genesis_plus_gx<br>**retroarch:** picodrive<br>**retroarch:** smsplus<br>|
|Sega|Game Gear (Hacks) (ggh)|1990|`gamegearh`|.bin .BIN .gg .GG .zip .ZIP .7z .7Z|**retroarch:** gearsystem (default)<br>**retroarch:** genesis_plus_gx<br>**retroarch:** picodrive<br>**retroarch:** smsplus<br>|
|Sega|Genesis (genesis)|1989|`genesis`|.bin .BIN .gen .GEN .md .MD .sg .SG .smd .SMD .zip .ZIP .7z .7Z|**retroarch:** genesis_plus_gx (default)<br>**retroarch:** genesis_plus_gx_wide<br>**retroarch:** picodrive<br>|
|Sega|Genesis (Hacks) (genh)|1989|`genh`|.bin .BIN .gen .GEN .md .MD .sg .SG .smd .SMD .zip .ZIP .7z .7Z|**retroarch:** genesis_plus_gx (default)<br>**retroarch:** genesis_plus_gx_wide<br>**retroarch:** picodrive<br>|
|Sega|Master System (mastersystem)|1985|`mastersystem`|.bin .BIN .sms .SMS .zip .ZIP .7z .7Z|**retroarch:** gearsystem (default)<br>**retroarch:** genesis_plus_gx<br>**retroarch:** picodrive<br>**retroarch:** smsplus<br>|
|Sega|Mega Drive (megadrive)|1990|`megadrive`|.bin .BIN .gen .GEN .md .MD .sg .SG .smd .SMD .zip .ZIP .7z .7Z|**retroarch:** genesis_plus_gx (default)<br>**retroarch:** genesis_plus_gx_wide<br>**retroarch:** picodrive<br>|
|Sega|Mega Drive (megadrive-japan)|1988|`megadrive-japan`|.bin .BIN .gen .GEN .md .MD .sg .SG .smd .SMD .zip .ZIP .7z .7Z|**retroarch:** genesis_plus_gx (default)<br>**retroarch:** genesis_plus_gx_wide<br>**retroarch:** picodrive<br>|
|Sega|Mega-CD (megacd)|1991|`megacd`|.chd .CHD .cue .CUE .iso .ISO .m3u .M3U|**retroarch:** genesis_plus_gx (default)<br>**retroarch:** picodrive<br>|
|Sega|Naomi (naomi)|1998|`naomi`|.lst .LST .bin .BIN .dat .DAT .zip .ZIP .7z .7Z|**retroarch:** flycast2021<br>**flycast:** flycast-sa (default)<br>**retroarch:** flycast<br>|
|Sega|Saturn (saturn)|1994|`saturn`|.cue .CUE .chd .CHD .iso .ISO|**yabasanshiro:** yabasanshiro-sa (default)<br>**retroarch:** yabasanshiro<br>**retroarch:** beetle_saturn<br>|
|Sega|SG-1000 (sg-1000)|1983|`sg-1000`|.bin .BIN .sg .SG .zip .ZIP .7z .7Z|**retroarch:** gearsystem (default)<br>**retroarch:** genesis_plus_gx<br>**retroarch:** picodrive<br>|
|Sharp|X1 (x1)|1982|`x1`|.dx1 .DX1 .2d .2D .2hd .2HD .tfd .TFD .d88 .D88 .88d .88D .hdm .HDM .xdf .XDF .dup .DUP .tap .TAP .cmd .CMD .zip .ZIP .7z .7Z|**retroarch:** x1 (default)<br>|
|Sharp|x68000 (x68000)|1987|`x68000`|.dim .DIM .img .IMG .d88 .D88 .88d .88D .hdm .HDM .dup .DUP .2hd .2HD .xdf .XDF .hdf .HDF .cmd .CMD .m3u .M3U .zip .ZIP .7z .7Z|**retroarch:** px68k (default)<br>|
|Sinclair|ZX Spectrum (zxspectrum)|1982|`zxspectrum`|.tzx .TZX .tap .TAP .z80 .Z80 .rzx .RZX .scl .SCL .trd .TRD .dsk .DSK .zip .ZIP .7z .7Z|**retroarch:** fuse<br>|
|Sinclair|ZX81 (zx81)|1981|`zx81`|.tzx .TZX .p .P .zip .ZIP .7z .7Z|**retroarch:** 81 (default)<br>|
|SNK|Neo Geo (neogeo)|1990|`neogeo`|.7z .7Z .zip .ZIP|**retroarch:** fbneo (default)<br>**retroarch:** mame2003_plus<br>**retroarch:** fbalpha2012<br>**retroarch:** fbalpha2019<br>**retroarch:** mame2010<br>**retroarch:** mame2015<br>**retroarch:** mame<br>|
|SNK|Neo Geo CD (neocd)|1990|`neocd`|.cue .CUE .iso .ISO .chd .CHD|**retroarch:** neocd (default)<br>**retroarch:** fbneo<br>|
|SNK|Neo Geo Pocket (ngp)|1998|`ngp`|.ngc .NGC .ngp .NGP .zip .ZIP .7z .7Z|**retroarch:** beetle_ngp (default)<br>**retroarch:** race<br>|
|SNK|Neo Geo Pocket Color (ngpc)|1999|`ngpc`|.ngc .NGC .zip .ZIP .7z .7Z|**retroarch:** beetle_ngp (default)<br>**retroarch:** race<br>|
|Sony|PlayStation (psx)|1994|`psx`|.bin .BIN .cue .CUE .img .IMG .mdf .MDF .pbp .PBP .toc .TOC .cbn .CBN .m3u .M3U .ccd .CCD .chd .CHD .iso .ISO|**retroarch:** pcsx_rearmed (default)<br>**retroarch:** beetle_psx<br>**Duckstation:** duckstation-sa<br>**retroarch:** duckstation<br>**retroarch:** swanstation<br>|
|Sony|PlayStation 2 (ps2)|2000|`ps2`|.iso .ISO .mdf .MDF .nrg .NRG .bin .BIN .img .IMG .dump .DUMP .gz .GZ .cso .CSO .chd .CHD|**aethersx2:** aethersx2-sa (default)<br>|
|Sony|PlayStation Portable (psp)|2004|`psp`|.iso .ISO .cso .CSO .pbp .PBP|**ppsspp:** ppsspp-sa (default)<br>|
|Sony|PSP Minis (pspminis)|2004|`pspminis`|.iso .ISO .cso .CSO .pbp .PBP|**ppsspp:** ppsspp-sa (default)<br>**retroarch:** ppsspp<br>|
|Sun Microsystems|J2ME (j2me)|2002|`j2me`|.jar .JAR|**retroarch:** freej2me (default)<br>|
|Various|EasyRPG (easyrpg)|2003|`easyrpg`|.zip .ZIP .easyrpg .EASYRPG .ldb .LDB|**retroarch:** easyrpg (default)<br>|
|Various|OpenBOR (openbor)|2008|`openbor`|.pak .PAK|**OpenBOR:** OpenBOR (default)<br>|
|Various|ScummVM (scummvm)|2001|`games`|.sh .SH .svm .SVM .scummvm|**retroarch:** scummvm (default)<br>|
|Watara|Supervision (supervision)|1992|`supervision`|.sv .SV .zip .ZIP .7z .7Z|**retroarch:** potator (default)<br>|
|Welback Holdings|Mega Duck (megaduck)|1993|`megaduck`|.bin .BIN .zip .ZIP .7z .7Z|**retroarch:** sameduck (default)<br>|

7
packages/virtual/emulators/package.mk
View file

@ -96,10 +96,14 @@ makeinstall_target() {
### Flush cache from previous builds
clean_es_cache
clean_doc_cache
### Add BIOS directory
add_system_dir /storage/roms/bios
### Apply documentation header
start_system_doc
### Panasonic 3DO
add_emu_core 3do retroarch opera true
add_es_system 3do
@ -901,6 +905,9 @@ makeinstall_target() {
### Create es_systems
mk_es_systems
### Generate document
mk_system_doc
mkdir -p ${INSTALL}/usr/config/emulationstation
cp -f ${ESTMP}/es_systems.cfg ${INSTALL}/usr/config/emulationstation

2
templates/HEADER.md Normal file
View file

@ -0,0 +1,2 @@
&nbsp;&nbsp;<img src="https://raw.githubusercontent.com/JustEnoughLinuxOS/distribution/dev/distributions/JELOS/logos/jelos-logo.png" width=192>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[![Latest Version](https://img.shields.io/github/release/JustEnoughLinuxOS/distribution.svg?color=5998FF&label=latest%20version&style=flat-square)](https://github.com/JustEnoughLinuxOS/distribution/releases/latest) [![Activity](https://img.shields.io/github/commit-activity/m/JustEnoughLinuxOS/distribution?color=5998FF&style=flat-square)](https://github.com/JustEnoughLinuxOS/distribution/commits) [![Pull Requests](https://img.shields.io/github/issues-pr-closed/JustEnoughLinuxOS/distribution?color=5998FF&style=flat-square)](https://github.com/JustEnoughLinuxOS/distribution/pulls) [![Discord Server](https://img.shields.io/discord/948029830325235753?color=5998FF&label=chat&style=flat-square)](https://discord.gg/seTxckZjJy)
#

4
templates/SUPPORTED_SYSTEMS.md Normal file
View file

@ -0,0 +1,4 @@
# Supported Systems Emulators and Cores
This document describes all available systems emulators and cores available for the device.