distribution/README.md

140 lines
10 KiB
Markdown
Raw Normal View History

2023-09-20 22:29:09 +00:00
<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.
2023-08-14 11:40:19 +00:00
## Features
2023-09-20 22:29:09 +00:00
2023-08-14 11:40:19 +00:00
* JELOS has a very active community of developers and users.
* Integrated cross-device local and remote network play.
* In-game touch support on supported devices.
* Fine grain control for battery life or performance.
* Includes support for playing Music and Video.
* Bluetooth audio and controller support.
* Support for HDMI audio and video out, and USB audio.
2023-08-14 11:40:19 +00:00
* Device to device and device to cloud sync with Syncthing and rclone.
* VPN support with Wireguard, Tailscale, and ZeroTier.
* Includes built-in support for scraping and retroachievements.
2023-07-20 22:52:03 +00:00
## Screenshots
2023-09-20 22:29:09 +00:00
<table>
<tr>
<td><img src="https://jelos.org/_inc/images/screenshots/system-view.png"/></td>
<td><img src="https://jelos.org/_inc/images/screenshots/menu.png"/></td>
</tr>
<tr>
<td><img src="https://jelos.org/_inc/images/screenshots/gamelist-view-metadata-immersive.png"/></td>
<td><img src="https://jelos.org/_inc/images/screenshots/gamelist-view-no-metadata-immersive.png"/></td>
</tr>
</table>
2023-07-20 22:52:03 +00:00
2023-08-14 11:40:19 +00:00
## Community
2023-09-20 22:29:09 +00:00
The JELOS community utilizes Discord for discussion, if you would like to join us please use this link: [https://discord.gg/seTxckZjJy](https://discord.gg/seTxckZjJy)
2023-08-14 11:40:19 +00:00
2023-08-14 11:44:03 +00:00
## Licenses
2023-09-20 22:29:09 +00:00
2023-08-14 11:44:03 +00:00
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
2023-09-20 22:29:09 +00:00
2023-08-14 11:44:03 +00:00
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/).
2023-09-20 22:29:09 +00:00
You are free to:
- Share: copy and redistribute the material in any medium or format
- Adapt: remix, transform, and build upon the material
2023-08-14 11:44:03 +00:00
2023-09-20 22:29:09 +00:00
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.
2023-08-14 11:44:03 +00:00
### JELOS Software
2023-09-20 22:29:09 +00:00
Copyright 2021-present JELOS Project
2023-08-14 11:40:19 +00:00
2023-09-20 22:29:09 +00:00
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](http://www.apache.org/licenses/LICENSE-2.0)
2023-08-14 11:44:03 +00:00
2023-09-20 22:29:09 +00:00
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.
2023-08-14 11:44:03 +00:00
2023-09-20 22:29:09 +00:00
### 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.
2023-08-14 11:44:03 +00:00
## Documentation
2023-09-20 22:29:09 +00:00
### Contribute
* [Building JELOS](https://jelos.org/contribute/build/)
* [Code of Conduct](https://jelos.org/contribute/code-of-conduct/)
* [Contributing to JELOS](https://jelos.org/contribute/)
* [Modifying JELOS](https://jelos.org/contribute/modify/)
* [Adding Hardware Quirks](https://jelos.org/contribute/quirks/)
* [Creating Packages](https://jelos.org/contribute/packages/)
2023-08-14 11:40:19 +00:00
* [Pull Request Template](/PULL_REQUEST_TEMPLATE.md)
2023-09-20 22:29:09 +00:00
### Play
* [Installing JELOS](https://jelos.org/play/install/)
* [Updating JELOS](https://jelos.org/play/update/)
2023-09-20 22:35:15 +00:00
* [Controls](https://jelos.org/play/controls/)
* [Netplay](https://jelos.org/play/netplay/)
* [Configuring Moonlight](https://jelos.org/systems/moonlight/)
2023-08-14 11:40:19 +00:00
* [Device Specific Documentation](/documentation/PER_DEVICE_DOCUMENTATION)
2023-09-20 22:35:15 +00:00
### Configure
* [Optimizations](https://jelos.org/configure/optimizations/)
* [Shaders](https://jelos.org/configure/shaders/)
* [Cloud Sync](https://jelos.org/configure/cloud-sync/)
* [VPN](https://jelos.org/configure/vpn/)
2023-08-14 11:40:19 +00:00
2023-09-20 22:29:09 +00:00
### Other
* [Frequently Asked Questions](https://jelos.org/faqs/)
* [Donating to JELOS](https://jelos.org/donations/)
2023-09-20 22:52:31 +00:00
## Device Support
2023-09-20 22:29:09 +00:00
JELOS supports a variety of ARM and Intel/AMD based devices.
| Manufacturer | Device | CPU / Architecture | Kernel | GL driver | Interface |
2023-09-20 22:29:09 +00:00
| -- | -- | -- | -- | -- | -- |
2023-09-20 22:36:59 +00:00
| Anbernic | [RG351P/M](http://jelos.org/devices/anbernic/rg351pm) | Rockchip RK3326 (ARM) | Mainline Linux | Panfrost | Weston + Emulation Station |
| Anbernic | [RG353P](http://jelos.org/devices/anbernic/rg353pmvvs) | Rockchip RK3566 (ARM) | Rockchip BSP 4.19 | Mali | KMS/DRM + Emulation Station |
| Anbernic | [RG353M](http://jelos.org/devices/anbernic/rg353pmvvs) | Rockchip RK3566 (ARM) | Rockchip BSP 4.19 | Mali | KMS/DRM + Emulation Station |
| Anbernic | [RG353V](http://jelos.org/devices/anbernic/rg353pmvvs) | Rockchip RK3566 (ARM) | Rockchip BSP 4.19 | Mali | KMS/DRM + Emulation Station |
| Anbernic | [RG353VS](http://jelos.org/devices/anbernic/rg353pmvvs) | Rockchip RK3566 (ARM) | Rockchip BSP 4.19 | Mali | KMS/DRM + Emulation Station |
| Anbernic | [RG503](http://jelos.org/devices/anbernic/rg503) | Rockchip RK3566 (ARM) | Rockchip BSP 4.19 | Mali | KMS/DRM + Emulation Station |
| Anbernic | [RG552](http://jelos.org/devices/anbernic/rg552) | Rockchip RK3399 (ARM) | Mainline Linux | Panfrost | Weston + Emulation Station |
| Anbernic | [Win600](http://jelos.org/devices/anbernic/win600) | AMD Athlon Silver 3050e (x86_64) | Mainline Linux | Radeonsi | Weston + Emulation Station |
| AOKZOE | [A1 Pro](http://jelos.org/devices/aokzoe/a1-pro) | AMD 7840u (x86_64) | Mainline Linux | Radeonsi | Weston + Emulation Station |
| Atari | [VCS](http://jelos.org/devices/atari/vcs) | AMD Ryzen R1606G (x86_64) | Mainline Linux | Radeonsi | Weston + Emulation Station |
| AYANEO | [Air / Air Pro](http://jelos.org/devices/ayaneo/air) | Amd Ryzen 5 5560U / AMD Ryzen 7 5825U (x86_64) | Mainline Linux | Radeonsi | Weston + Emulation Station |
| AYANEO | [Air Plus](http://jelos.org/devices/ayaneo/air-plus) | Amd Ryzen 7 6800U / (x86_64) | Mainline Linux | Radeonsi | Weston + Emulation Station |
| AYANEO | [AYANEO 2](http://jelos.org/devices/ayaneo/ayaneo-2) | Amd Ryzen 7 6800U / (x86_64) | Mainline Linux | Radeonsi | Weston + Emulation Station |
| Ayn | [Loki Zero](http://jelos.org/devices/ayn/loki-zero) | AMD Athlon Silver 3050e (x86_64) | Mainline Linux | Radeonsi | Weston + Emulation Station |
| Ayn | [Loki Max](http://jelos.org/devices/ayn/loki-max) | Amd Ryzen 7 6800U / (x86_64) | Mainline Linux | Radeonsi | Weston + Emulation Station |
| GPD | [Win 4](http://jelos.org/devices/gpd/win4) | Amd Ryzen 7 6800U / (x86_64) | Mainline Linux | Radeonsi | Weston + Emulation Station |
| GPD | [Win Max 2 (2022)](http://jelos.org/devices/gpd/win-max-2) | Amd Ryzen 7 6800U / (x86_64) | Mainline Linux| Radeonsi | Weston + Emulation Station |
| Hardkernel | [Odroid Go Advance](http://jelos.org/devices/hardkernel/odroid-go-advance) | Rockchip RK3326 (ARM) | Mainline Linux | Panfrost | Weston + Emulation Station |
| Hardkernel | [Odroid Go Super](http://jelos.org/devices/hardkernel/odroid-go-super) | Rockchip RK3326 (ARM) | Mainline Linux | Panfrost | Weston + Emulation Station |
| Hardkernel | [Odroid Go Ultra](http://jelos.org/devices/hardkernel/odroid-go-ultra) | Amlogic S922X / Mali G52 M6 (ARMv8-A) | Mainline Linux | Mali | Weston + Emulation Station |
2023-10-21 12:46:18 +00:00
| Hardkernel | [Odroid N2/N2+](http://jelos.org/devices/hardkernel/odroid-n2) | Amlogic S922X / Mali G52 M6 (ARMv8-A) | Mainline Linux | Mali | Weston + Emulation Station |
2023-09-20 22:36:59 +00:00
| Indiedroid | [Nova](http://jelos.org/devices/indiedroid/nova) | Rockchip RK3588S / Mali G610 (ARMv8-A) | Rockchip 5.10 BSP Linux | Panfrost | Weston + Emulation Station |
| Orange Pi | [Orange Pi 5](http://jelos.org/devices/orange-pi/orange-pi-5) | Rockchip RK3588S / Mali G610 (ARMv8-A) | Rockchip 5.10 BSP Linux | Panfrost | Weston + Emulation Station |
| Powkiddy | [RGB10 Max 3 Pro](http://jelos.org/devices/powkiddy/rgb10-max-3-pro) | Amlogic A311D / Mali G52 M4 (ARMv8-A) | Mainline Linux | Mali | Weston + Emulation Station |
| Powkiddy | [RGB30](http://jelos.org/devices/powkiddy/rgb30) | Rockchip RK3566 (ARM) | Rockchip BSP 4.19 | Mali | KMS/DRM + Emulation Station |
| Powkiddy | [RK2023](http://jelos.org/devices/powkiddy/rk2023) | Rockchip RK3566 (ARM) | Rockchip BSP 4.19 | Mali | KMS/DRM + Emulation Station |
| Powkiddy | [x55](http://jelos.org/devices/powkiddy/x55) | Rockchip RK3566 (ARM) | Rockchip BSP 4.19 | Mali | KMS/DRM + Emulation Station |
2023-09-20 22:29:09 +00:00
> [!NOTE]
> While not technically supported, JELOS is also known to work well on a variety of generic x86_64 devices including gaming PCs, mini PCs, and laptop computers.
## Credits
2023-10-21 12:46:18 +00:00
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.