wbrawner/jelos.org
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Initial Commit

Browse source
This commit is contained in:
anthonycaccese 2023-09-18 07:19:49 -04:00
commit 2643bf936e
170 changed files with 4147 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
.github/workflows/ci.yml vendored Normal file
View file

@ -0,0 +1,23 @@
name: ci
on:
push:
branches:
- master
- main
permissions:
contents: write
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v4
with:
python-version: 3.x
- uses: actions/cache@v2
with:
key: ${{ github.ref }}
path: .cache
- run: pip install mkdocs-material
- run: pip install mkdocs-glightbox
- run: mkdocs gh-deploy --force

171
.gitignore vendored Normal file
View file

@ -0,0 +1,171 @@
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class
# C extensions
*.so
# Distribution / packaging
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
share/python-wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST
# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec
# Installer logs
pip-log.txt
pip-delete-this-directory.txt
# Unit test / coverage reports
htmlcov/
.tox/
.nox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
*.py,cover
.hypothesis/
.pytest_cache/
cover/
# Translations
*.mo
*.pot
# Django stuff:
*.log
local_settings.py
db.sqlite3
db.sqlite3-journal
# Flask stuff:
instance/
.webassets-cache
# Scrapy stuff:
.scrapy
# Sphinx documentation
docs/_build/
# PyBuilder
.pybuilder/
target/
# Jupyter Notebook
.ipynb_checkpoints
# IPython
profile_default/
ipython_config.py
# pyenv
# For a library or package, you might want to ignore these files since the code is
# intended to run in multiple environments; otherwise, check them in:
# .python-version
# pipenv
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
# However, in case of collaboration, if having platform-specific dependencies or dependencies
# having no cross-platform support, pipenv may install dependencies that don't work, or not
# install all needed dependencies.
#Pipfile.lock
# poetry
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
# This is especially recommended for binary packages to ensure reproducibility, and is more
# commonly ignored for libraries.
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
#poetry.lock
# pdm
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
#pdm.lock
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
# in version control.
# https://pdm.fming.dev/#use-with-ide
.pdm.toml
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
__pypackages__/
# Celery stuff
celerybeat-schedule
celerybeat.pid
# SageMath parsed files
*.sage.py
# Environments
.env
.venv
env/
venv/
ENV/
env.bak/
venv.bak/
# Spyder project settings
.spyderproject
.spyproject
# Rope project settings
.ropeproject
# mkdocs documentation
/site
# mypy
.mypy_cache/
.dmypy.json
dmypy.json
# Pyre type checker
.pyre/
# pytype static type analyzer
.pytype/
# Cython debug symbols
cython_debug/
# PyCharm
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
# and can be added to the global gitignore or merged into this file. For a more nuclear
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
#.idea/
# OS generated files #
######################
.DS_Store
.DS_Store?
._*
.Spotlight-V100
.Trashes
Icon?
ehthumbs.db
Thumbs.db

674
LICENSE Normal file
View file

@ -0,0 +1,674 @@
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors. You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of
protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
products. If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary. To prevent this, the GPL assures that
patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
<program> Copyright (C) <year> <name of author>
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, your program's commands
might be different; for a GUI interface, you would use an "about box".
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
<https://www.gnu.org/licenses/>.
The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
<https://www.gnu.org/licenses/why-not-lgpl.html>.

37
README.md Normal file
View file

@ -0,0 +1,37 @@
# JELOS Wiki
This is the repository for the JELOS Wiki ([created using MkDocs](https://www.mkdocs.org/))
It uses the mkdocs-material theme for its layout & styling: [https://github.com/squidfunk/mkdocs-material](https://github.com/squidfunk/mkdocs-material)
The JELOS Wiki is located at: [jelos.org](https://jelos.org/)
This is not the **repository** for the JELOS distribution, you can find that here: [https://github.com/JustEnoughLinuxOS/distribution](https://github.com/JustEnoughLinuxOS/distribution).
## How to Contribute
You can contribute to the JELOS Wiki in a couple of ways.
### Option 1: A quick shout-out on Discord
Write us a message on the JELOS Discord stating what should be edited or added.
[JELOS Discord](https://discord.gg/seTxckZjJy)
### Option 2: Creating a Pull Request
You will need to create a GitHub account to open a Pull Request.
Markdown is a fairly straightforward markup language. If you are not familiar, you can take a quick look at the documents in the `docs` folder.
Depending on your comfort level with GitHub, you can either use GitHub's web editor to edit any markdown files or you may also clone the repository and edit the markdown files that way.
To edit markdown files in GitHub's web editor, open a document in the `docs` folder, and click the small pencil icon in the top right. Once you are finished, click `Commit changes..`. GitHub will prompt you to open a Pull Request, which will then be merged once it is reviewed.
Once the PR is merged and reviewed, your changes will automatically be deployed to the website.
If you do choose to clone the repository, you only need to clone the `main` branch.
Depending on your permission level, when you are finished making edits, either push your changes to `main` or create a Pull Request. Any changes you make to the markdown files will automatically be pushed to the `gh-pages` branch and deployed to the website once you have either pushed your changes to `main` or your Pull Request is approved and merged.
Thank you for contributing!

202
docs/_inc/css/custom.css Normal file
View file

@ -0,0 +1,202 @@
[data-md-color-scheme="art-book"] {
/* Primary color shades */
--md-primary-fg-color: #111111;
--md-primary-bg-color: #eeeeee;
--md-primary-bg-color--light: #bbbbbb;
/* Accent color shades */
--md-accent-fg-color: #5998FF;
--md-accent-fg-color--transparent: #cccccc;
/*--md-accent-bg-color: #111111;
--md-accent-bg-color--light: #111111;*/
/* Default color shades */
--md-default-fg-color: #111111;
--md-default-fg-color--light: #222222;
--md-default-fg-color--lighter: #cccccc;
--md-default-fg-color--lightest: #cccccc;
--md-default-bg-color: #dddddd;
--md-default-bg-color--light: #dddddd;
--md-default-bg-color--lighter: #dddddd;
--md-default-bg-color--lightest: #dddddd;
/* Typeset color shades */
--md-typeset-color: #111111;
/* Typeset `a` color shades */
--md-typeset-a-color: #111111;
/* Typeset `table` color shades */
--md-typeset-table-color: #cccccc;
--md-typeset-table-color--light: #eeeeee;
/* Footer color shades */
/*--md-footer-fg-color: #ffffff;
--md-footer-fg-color--light: #eeeeee;
--md-footer-fg-color--lighter: #cccccc; */
--md-footer-bg-color: #111111;
/* Code color shades
--md-code-fg-color: #111111;
--md-code-bg-color: #111111;*/
/* Code highlighting color shades
--md-code-hl-color: #111111;
--md-code-hl-number-color: #111111;
--md-code-hl-special-color: #111111;
--md-code-hl-function-color: #111111;
--md-code-hl-constant-color: #111111;
--md-code-hl-keyword-color: #111111;
--md-code-hl-string-color: #111111;
--md-code-hl-name-color: #111111;
--md-code-hl-operator-color: #111111;
--md-code-hl-punctuation-color: #111111;
--md-code-hl-comment-color: #111111;
--md-code-hl-generic-color: #111111;
--md-code-hl-variable-color: #111111;*/
/* Typeset `mark` color shades
--md-typeset-mark-color: #111111;*/
/* Typeset `del` and `ins` color shades
--md-typeset-del-color: #111111;
--md-typeset-ins-color: #111111;*/
/* Typeset `kbd` color shades
--md-typeset-kbd-color: #111111;
--md-typeset-kbd-accent-color: #111111;
--md-typeset-kbd-border-color: #111111;*/
/* Admonition color shades
--md-admonition-fg-color: #111111;
--md-admonition-bg-color: #111111;*/
/* Warning color shades
--md-warning-fg-color: #111111;
--md-warning-bg-color: #111111;*/
}
[data-md-color-scheme="art-book-next"] {
/* Primary color shades */
--md-primary-fg-color: #111111;
--md-primary-bg-color: #eeeeee;
--md-primary-bg-color--light: #bbbbbb;
/* Accent color shades */
--md-accent-fg-color: #5998FF;
--md-accent-fg-color--transparent: #333333;
/*--md-accent-bg-color: #111111;
--md-accent-bg-color--light: #111111;*/
/* Default color shades */
--md-default-fg-color: #eeeeee;
--md-default-fg-color--light: #eeeeee;
--md-default-fg-color--lighter: #cccccc;
--md-default-fg-color--lightest: #111111;
--md-default-bg-color: #222222;
--md-default-bg-color--light: #222222;
--md-default-bg-color--lighter: #222222;
--md-default-bg-color--lightest: #222222;
/* Typeset color shades */
--md-typeset-color: #eeeeee;
/* Typeset `a` color shades */
--md-typeset-a-color: #dddddd;
/* Typeset `table` color shades */
--md-typeset-table-color: #333333;
--md-typeset-table-color--light: #444444;
/* Footer color shades */
/*--md-footer-fg-color: #ffffff;
--md-footer-fg-color--light: #eeeeee;
--md-footer-fg-color--lighter: #cccccc; */
--md-footer-bg-color: #111111;
/* Code color shades
--md-code-fg-color: #111111;
--md-code-bg-color: #111111;*/
/* Code highlighting color shades
--md-code-hl-color: #111111;
--md-code-hl-number-color: #111111;
--md-code-hl-special-color: #111111;
--md-code-hl-function-color: #111111;
--md-code-hl-constant-color: #111111;
--md-code-hl-keyword-color: #111111;
--md-code-hl-string-color: #111111;
--md-code-hl-name-color: #111111;
--md-code-hl-operator-color: #111111;
--md-code-hl-punctuation-color: #111111;
--md-code-hl-comment-color: #111111;
--md-code-hl-generic-color: #111111;
--md-code-hl-variable-color: #111111;*/
/* Typeset `mark` color shades
--md-typeset-mark-color: #111111;*/
/* Typeset `del` and `ins` color shades
--md-typeset-del-color: #111111;
--md-typeset-ins-color: #111111;*/
/* Typeset `kbd` color shades
--md-typeset-kbd-color: #111111;
--md-typeset-kbd-accent-color: #111111;
--md-typeset-kbd-border-color: #111111;*/
/* Admonition color shades
--md-admonition-fg-color: #111111;
--md-admonition-bg-color: #111111;*/
/* Warning color shades
--md-warning-fg-color: #111111;
--md-warning-bg-color: #111111;*/
}
[data-md-color-scheme="art-book"] img[src$="#only-dark"],
[data-md-color-scheme="art-book"] img[src$="#gh-dark-mode-only"] {
display: none; /* Hide dark images in light mode */
}
[data-md-color-scheme="art-book-next"] img[src$="#only-light"],
[data-md-color-scheme="art-book-next"] img[src$="#gh-light-mode-only"] {
display: none; /* Hide dark images in light mode */
}
.md-typeset h1, .md-typeset h2, .md-typeset h3 {
font-weight: 700;
}
.md-typeset h1 {
margin: 0 0 0.64em;
}
.md-typeset h2 {
margin: 1em 0 0.64em;
}
.md-typeset h3 {
margin: 0.64em 0 0.8em;
}
.md-header__inner {
padding: 0.4rem 0.2rem;
}
.md-main__inner {
margin-top: 0.5rem;
padding-top: 0;
}
.md-typeset table:not([class]) {
font-size: .74rem;
}
.md-nav__item--section>.md-nav__link {
font-weight: 700;
}
@media screen and (min-width: 76.25em) {
.md-nav__item--section {
margin: 1.5em 0;
}
.md-nav__item--section>.md-nav__link {
font-size: .8rem;
}
}

BIN
docs/_inc/images/devices/anbernic-rg351pm.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 157 KiB

BIN
docs/_inc/images/devices/anbernic-rg353.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 170 KiB

BIN
docs/_inc/images/devices/anbernic-rg503.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 234 KiB

BIN
docs/_inc/images/devices/anbernic-rg552.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 237 KiB

BIN
docs/_inc/images/devices/anbernic-win600.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 230 KiB

BIN
docs/_inc/images/devices/aokzoe-a1-pro.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 227 KiB

BIN
docs/_inc/images/devices/atari-vcs.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 125 KiB

BIN
docs/_inc/images/devices/ayaneo-2.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 259 KiB

BIN
docs/_inc/images/devices/ayaneo-air-plus.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 222 KiB

BIN
docs/_inc/images/devices/ayaneo-air.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 182 KiB

BIN
docs/_inc/images/devices/ayn-loki.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 167 KiB

BIN
docs/_inc/images/devices/gpdwin-4.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 330 KiB

BIN
docs/_inc/images/devices/gpdwin-max-2.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 262 KiB

BIN
docs/_inc/images/devices/indiedroid-nova.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 973 KiB

BIN
docs/_inc/images/devices/orange-pi-5.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 520 KiB

BIN
docs/_inc/images/devices/powkiddy-rgb10max3pro.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 294 KiB

BIN
docs/_inc/images/devices/powkiddy-rgb30.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 130 KiB

BIN
docs/_inc/images/devices/powkiddy-rk2023.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 161 KiB

BIN
docs/_inc/images/devices/powkiddy-x55.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 151 KiB

BIN
docs/_inc/images/logo.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 24 KiB

BIN
docs/_inc/images/screenshots/gamelist-view-metadata-immersive.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 593 KiB

BIN
docs/_inc/images/screenshots/gamelist-view-no-metadata-immersive.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 525 KiB

BIN
docs/_inc/images/screenshots/menu.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 274 KiB

BIN
docs/_inc/images/screenshots/system-view.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 115 KiB

249
docs/contribute/build.md Normal file
View file

@ -0,0 +1,249 @@
# 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 Code of Conduct](code-of-conduct.md) and [Contributing to JELOS](index.md) guides before submitting your first contribution.
## 1. Prep
Building JELOS requires a host with 200GB of free space for a single device, or 1TB of free space for a full world build.
!!! note "Expect your first build to take on the order of ten hours. You will need a stable internet connection, since hundreds of packages will be downloaded from their source."
Download errors often produce build failures with misleading error messages. If this happens to you, see the Troubleshooting section below.
After a clean build, all subsequent builds will go much faster (minutes) since 99% of the build work is cached.
### Docker **(Recommended)**
!!! tip "Docker is the easiest and most reliable way to build JELOS."
You need no previous experience with Docker; you merely need to install it on your build machine. Newcomers to the project are strongly recommended to use this approach.
We recommend using Ubuntu 22.04 for the host machine, as this is well-tested and known to work. Other distributions and operating systems might also work for Docker builds, but are untested and unsupported.
``` bash title="Install Docker using the following commands:"
sudo apt updatezsh
sudo apt install ca-certificates curl gnupg
sudo install -m 0755 -d /etc/apt/keyrings
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
sudo groupadd docker
sudo usermod -aG docker $USER
newgrp docker
docker run hello-world
```
> Docker installation reference (source): [Install using the apt repository](https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository) and [Linux post-installation steps](https://docs.docker.com/engine/install/linux-postinstall/).
The final command should produce a message indicating that Docker is properly installed. If you encounter any errors, see the reference links above.
### Manual Build
Manual builds (outside of Docker) are only recommended for developers with specific needs that cannot be met by the Docker approach. The host configuration should match the Docker container as closely as possible, running Ubuntu 22.04 with all packages listed in the [Dockerfile](https://github.com/JustEnoughLinuxOS/distribution/blob/main/Dockerfile).
### Virtual Machines
If you must use a virtual machine for your build platform, keep in mind that results vary. There have been some anecdotes of success with VMware Workstation (Player and Pro) and failure with VirtualBox and WSL. These reports are not definitive, but something to keep in mind if you must use a VM.
## 2. Clone
After preparing the build machine, clone the JELOS git repository onto it.
``` bash
cd ~
git clone https://github.com/JustEnoughLinuxOS/distribution.git
```
### Selecting the Desired Branch
Once you have cloned the repo, decide whether 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`.
``` bash
cd distribution
git checkout dev
```
### Filesystem Structure
We have a simple filesystem structure adopted from parent distributions CoreELEC, LibreELEC, etc.
``` bash
.
├── 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 device's 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 packages used to develop and build JELOS are hosted within the packages directory. The package structure documentation is available in [DEVEL_CREATING_PACKAGES.md](DEVEL_CREATING_PACKAGES.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 files 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.
## 3. Build
### Building Device Images
Building JELOS is easy. From the root of your local repository, issue one of the `make` commands listed below, depending on the desired device and whether you are using Docker.
| Devices | Dependency | Docker Command | Manual Command |
| ---- | ---- | ---- | ---- |
|AMD64||`make docker-AMD64`|`make AMD64`|
|RK3588||`make docker-RK3588`|`make RK3588`|
|RK3326||`make docker-RK3326`|`make RK3326`|
|RK3566||`make docker-RK3566`|`make RK3566`|
|RK3566-X55|RK3566|`make docker-RK3566-X55`|`make RK3566-X55`|
|S922X||`make docker-S922X`|`make S922X`|
|ALL DEVICES||`make docker-world`|`make world`|
> Devices that list a dependency require you to build the dependency first, since that build will be used as the root of the device you are building.
For example, the following command uses Docker to build the AMD64 image.
``` bash
make docker-AMD64
```
### 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|Default|Function|
|----|----|----|
|EMULATION_DEVICE|yes|Builds EmulationStation and all emulators if `yes`. Builds EmulationStation and NO emulators if `no`.|
|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 to 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
``` bash
export LOCAL_SSH_KEYS_FILE=~/.ssh/jelos/authorized_keys
```
#### WiFi SSID and password
``` bash
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.
``` bash
# 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
``` bash
make docker-shell
CLEAN_PACKAGES="linux ppsspp-sa" make AMD64
exit
```
The first and last lines should be omitted if building outside of Docker.
## Troubleshooting
The very first build after a fresh checkout is the hardest. Give yourself sufficient time to generate the first build and work through any failures before attempting to modify JELOS.
- Download errors produce misleading failure messages. Beware of chasing red herrings. A network failure is much more likely than a bug in the makefile, given how frequently it is tested by the CI system and other devs.
- Try cleaning the failed package (see above) and building again.
- If you suspect a download failure, manually delete the relevant package(s) from the `sources` and `build.JELOS-...` directories, to force a full package re-download and re-build.
- Exhaust all options before using `make clean` since this deletes the build cache and takes hours to regenerate.
- As a very last resort, delete the entire local repository and start over.

128
docs/contribute/code-of-conduct.md Normal file
View file

@ -0,0 +1,128 @@
# Contributor 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.

52
docs/contribute/index.md Normal file
View file

@ -0,0 +1,52 @@
<!---
icon: material/developer-board
--->
# Contributing to JELOS
Your contribution helps JELOS become a better Linux distribution, so we're glad you're here! We aim 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 upstream 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.
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.
## Use a Consistent Coding Style
- Please 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.
## Pull Request Template
[PULL_REQUEST_TEMPLATE.md](https://github.com/JustEnoughLinuxOS/distribution/blob/main/PULL_REQUEST_TEMPLATE.md)
## License
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.
## 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)

93
docs/contribute/modify.md Normal file
View file

@ -0,0 +1,93 @@
# Modifying JELOS
Before modifying JELOS, be sure you can successfully [build](build.md) the unmodified `main` or `dev` branch. Establish a baseline of success before introducing changes to the JELOS source.
## Building a Single Package
When modifying individual packages, it's useful to regularly verify the build-ability of your changes. Rather than rebuild an entire device image, it is much faster to simply rebuild a single package using the following commands:
```
make docker-shell
export PROJECT=PC DEVICE=AMD64 ARCH=x86_64
./scripts/clean busybox
./scripts/build busybox
exit
```
The first and last lines should be omitted if building outside of Docker. PROJECT is one of `Amlogic`, `PC`, or `Rockchip` (i.e. the subdirectories of the project directory).
!!! info "If you are interested in an EmulationStation package build it requires additional steps because its source code is located in a separate repository. Please see instructions [here](https://github.com/JustEnoughLinuxOS/distribution/blob/main/packages/ui/emulationstation/package.mk)."
## 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 build 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 the patch is generated, rebuild an individual package by following the section above. The build system will automatically pick up patch files from the `patches` directory. For testing, one can either copy the built binary to the console or burn the whole image on SD card.
## Building a Modified Image
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.
```
make docker-shell
# Update the package version for a new package, or apply your patch as above.
vim/emacs/vscode/notepad.exe
export OS_VERSION=$(date +%Y%m%d) BUILD_DATE=$(date)
export PROJECT=PC DEVICE=AMD64 ARCH=x86_64
./scripts/clean emulationstation
./scripts/build emulationstation
./scripts/install emulationstation
./scripts/image mkimage
exit
```
!!! note "The first and last lines should be omitted if building outside of Docker."
## Pushing Modified Images to a Device
You can of course reflash the SD card with the modified image.
Alternatively, you may install the image through the JELOS update mechanism, which retains your ES and emulator settings. If the device is networked and reachable from the build machine, this can be done as follows.
```
# Replace with your device values
HOST=192.168.0.123
DEVICE=RK3566
ARCH=aarch64
# Assume today is the same UTC day that the image was built
TIMESTAMP=$(date -u +%Y%m%d)
SSH_OPTS="-o StrictHostKeyChecking=no -o UserKnownHostsFile=/dev/null"
scp ${SSH_OPTS} ~/distribution/release/JELOS-${DEVICE}.${ARCH}-${TIMESTAMP}.tar root@${HOST}:~/.update && \
ssh ${SSH_OPTS} root@{HOST} reboot
```

270
docs/contribute/packages.md Normal file
View file

@ -0,0 +1,270 @@
# 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`.

74
docs/contribute/quirks.md Normal file
View file

@ -0,0 +1,74 @@
# Adding Quirks
## Panel Rotation
If you have a new device that supports Mainline Linux, adding and submitting a rotation patch is very simple. Adding a rotation patch to the kernel will provide the hints needed for Wayland/Weston to also correctly rotate the panel.
To begin, download the kernel sources. Extract the kernel and rename it to linux-{version}.orig, and then copy that folder to linux-{version} or extract it again so there are two copies. This will be necessary to create the [patch](modify.md#creating-a-patch-for-a-package-using-git).
### Panel Definition and Default Orientation
Next, edit `linux-{version}/./drivers/gpu/drm/drm_panel_orientation_quirks.c` and add a struct describing your panel and its orientation if one does not already exist. For example:
```
static const struct drm_dmi_panel_orientation_data lcd1080x1920_leftside_up = {
.width = 1080,
.height = 1920,
.orientation = DRM_MODE_PANEL_ORIENTATION_LEFT_UP,
};
```
In the example above, the panel is 1080p, and rotated to the left in order to be corrected.
### DMI Matching
Now that the rotation correction has been defined, the kernel needs a method to match and apply it. For this we use DMI data. You can retrieve the DMI data by using `cat`, or `dmidecode`. For our example, we'll use `cat`.
```
airplus:~ # cat /sys/class/dmi/id/sys_vendor
AYANEO
airplus:~ # cat /sys/class/dmi/id/product_name
AIR Plus
```
Using this data, we will create a match rule to match our panel struct in drm_panel_orientation_quirks.c.
```
{
.matches = {
DMI_EXACT_MATCH(DMI_SYS_VENDOR, "AYANEO"),
DMI_EXACT_MATCH(DMI_PRODUCT_NAME, "AIR Plus"),
},
.driver_data = (void *)&lcd1080x1920_leftside_up,
}
```
Save, and build your patch following the instructions [here](modify.md). Place your patch in `packages/kernel/linux/patches/AMD64` or the appropriate device directory, and run a test build.
!!! note "DMI_EXACT_MATCH or DMI_MATCH can be used. DMI_EXACT_MATCH is as implied, an exact match. DMI_MATCH will match that any device where its DMI data includes "AIR Plus""
## Hardware Quirks
Adding hardware quirks are simple, and many examples can be found in `packages/hardware/quirks/devices`. To begin, review an existing quirk to familiarize yourself with the pattern.
### Creating a Quirk
The simplest way to create a quirk for your device is to copy an existing quirk and modify it. To copy it, simply copy the whole folder to the name of your device using the same DMI pattern as above. If you are working on an AYANEO Air Plus, the folder name would be "AYANEO Air Plus" based on the DMI data in our example.
Next, edit each file to contain the data appropriate for your device. To collect the data that you need, use the following tools:
- 001-deviceconfig
- This configuration file contains basic information for JELOS that cannot currently be determined automatically. A configuration is provided with the distribution if there is no quirk found, however it can be customized to suit. The following tools can be used to identify the correct data for your device.
- KEYA/B_MODIFIER - `evtest`.
- PATH_SPK/HP - `amixer`.
- 002-fancontrol
- Not all devices have methods available to control the fan. The following can help determine if yours can be controlled.
- `find /sys/devices -name pwm*` and evaluate if fan control is available.
- DEVICE_HAS_FAN="false" if manual control cannot be enabled.
### Additional Quirks
Your device may need additional quirks to function correctly or for optimization. Ask in the JELOS discord if you need additional guidance.
## Submit Your Quirk
Please follow the instuctons for [Building](build.md) and [Contributing](index.md) to submit your quirks to the distribution for inclusion. Please do not change major functionality of the distribution or break our hotkey standards, submissions that do not follow our standards will need to be revised.

26
docs/donations.md Normal file
View file

@ -0,0 +1,26 @@
# Donations and Funding
Thank you for your interest in donating to JELOS! At this time we are not accepting financial contributions. If you would like to volunteer or contribute in some way to our project, please read our [Code of Conduct](contribute/code-of-conduct.md) and [Contributing to JELOS](contribute/index.md) guides. You are also encouraged to join us on Discord.
## Why Don't You Accept Donations?
* As an Open Source project our operational expenses are fairly low, so to us a donation of your time is much more valuable.
* Open Source development is not considered charitable activity in some parts of the world, including the United States. Accepting donations can create unnecessary complexity for the project, and for the person donating.
## Build Infrastructure
Our GitHub runners are the nodes we use to build and push releases to GitHub. Trillian is our primary development host, Deepthought is our primary release builder. Node specs can be found in the table below:
| Name | CPU | Cores/Threads | RAM | Disk | Usage |
|----|----|----|----|----|----|
| deepthought | Ryzen 7 5800H | 8c/16t | 32GB | 2TB NVMe SSD | GitHub Runner |
| trillian | Ryzen 7 5800H | 8c/16t | 32GB | 2TB NVMe SSD | Local Development |
## Project and Web Hosting
GitHub serves our release packages, as well as our WIKI. Our domain, [https://www.jelos.org](https://www.jelos.org) is hosted with GitHub pages and is a simple WIKI redirect. Currently, JELOS does not take advantage of functionality that requires a paid GitHub plan.
| Project | URL | Comment |
|----|----|----|
| JELOS | [https://github.com/JustEnoughLinuxOS/distribution](https://github.com/JustEnoughLinuxOS/distribution) | Project site, Stable Release Repository. |
| Documentation | [https://www.jelos.org](https://www.jelos.org) | JELOS Wiki |

96
docs/faqs.md Normal file
View file

@ -0,0 +1,96 @@
# Frequently Asked Questions
## About the Distribution
### Does JELOS offer any formal support?
No. JELOS is something that we develop for fun, it is provided as-is. There are a variety of avenues to seek community help, but this is a tinkerer's distribution so you will need to get your hands dirty to solve your problems.
### Do you plan to add additional ports, software, or emulators?
We are a community developed distribution, and we believe that it is the responsibility of the person who wants a new feature to develop and contribute that feature. If you would like to add something to JELOS, pull requests are welcomed. Please review our [code of conduct](https://github.com/JustEnoughLinuxOS/distribution/blob/main/CODE_OF_CONDUCT.md), our [contributing guidelines](https://github.com/JustEnoughLinuxOS/distribution/blob/main/CONTRIBUTING.md), and our [build guide](https://github.com/JustEnoughLinuxOS/distribution/blob/main/BUILDING.md) before submitting your first pull request.
### Licensing JELOS for redistribution
JELOS utilizes a non-commercial CC BY-NC-SA 4.0 copyleft license on our branding which is intended to prevent abuse of our software. Device Makers and others who would like to bundle on devices may not do so without our express permission.
#### Redistribution Authorization Requirements
If you would like to receive permission from our project to redistribute JELOS, you must request permission in writing. We can be reached at contact@jelos.org.
##### Benefits
Authorization to use our branding will allow you to distribute JELOS on your device without needing to maintain a fork of the project for your device. This would include access to our online update feature.
##### Minimum Requirements
To receive permission to redistribute JELOS the following *minimum* criteria must be met. Please note, that taking these actions without formally receiving approval from our project does not grant you the authority to use our branding. You MUST receive approval from JELOS.
1. We receive sources for device(s) before they ship to consumers and we have irrevokable authority to publish at our leisure. We strongly prefer device makers contribute changes to support their device(s) directly to the distribution themselves.
2. Provide, upon request, device samples for every JELOS team member (including core developers, moderation team, and outside contributors), as well as any community developer designated by JELOS, for all devices planned, supported by, or bundled with JELOS for as long as the device maker manufactures the device.
3. It is up to the requestor to secure distribution rights for software included with JELOS that is not developed or owned by JELOS.
4. A support representative must join and participate in our community to support their device(s).
##### Selling JELOS
JELOS branding is licensed for non-commercial use only. Even if approved to be distributed on a device, it is not allowed to be sold or included as an up charge in any form what-so-ever. Period. This is not negotiable.
### What if you stop working on JELOS?
I don't expect that to happen, however JELOS is an Open Source project hosted here on GitHub which means the source code is readily available for anyone in the world to pick up and continue where we left off. Our [license model](https://tldrlegal.com/license/apache-license-2.0-(apache-2.0)) allows for this to happen by providing and encouraging redistribution ([freedom 2](https://www.gnu.org/philosophy/free-sw.en.html#four-freedoms)) and the right to distribute a modified version ([freedom 3](https://www.gnu.org/philosophy/free-sw.en.html#four-freedoms)). JELOS only prohibits commercial use through our branding which is licensed by the [Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License](https://tldrlegal.com/license/creative-commons-attribution-noncommercial-sharealike-4.0-international-(cc-by-nc-sa-4.0)).
## About Using JELOS
### Which emulators and game engines are supported by JELOS?
Emulators and game engines are configured on a per device basis and are automatically documented at build time. Documentation can be found at the following URL: [Per Device Documentation](https://github.com/JustEnoughLinuxOS/distribution/tree/main/documentation/PER_DEVICE_DOCUMENTATION)
### Sound suddenly stopped working on my device!
Log in over ssh, and run the following steps.
```
systemctl stop pipewire-pulse pipewire-pulse.socket pipewire pipewire.socket wireplumber
rm -rf /storage/.local/state /storage/.config/pulse
reboot
```
### EmuStation displays duplicate game titles. How can I disable a file extension to remove the duplicates? (e.g. display only `.cue` and don't display `.bin` files for PlayStation)
* Within EmuStation, select the relevant game system (e.g. PlayStation)
* Press `Select` to View Options
* In View Options section, choose View Customisation
* Under File Extensions, deselect any file extensions that are not required (e.g. deselect `.bin` for PlayStation when also using `.cue` files)
### How do I edit `es_systems.cfg` (for example, to modify the list of systems in EmuStation, add a custom core or script, or change the order that systems are displayed)?
* Delete the ~/.config/emulationstation/es_systems.cfg symlink.
* Copy the custom version of `es_systems.cfg` to `~/.config/emulationstation`.
* Stop the UI service: `systemctl stop ${UI_SERVICE}`
* Restart the UI service to use the custom version: `systemctl start ${UI_SERVICE}`
> Note: System updates will overwrite it, custom settings will be preserved as last_es_systems.cfg.
### Where do I put bios files and files and Retroarch system files
* They go in `/storage/roms/bios`
* System bios checker in `game settings, missing bios` identities missing files per emulator and indicates their required location
### Where do I put music files to enable background music within emulationstation (while browsing my game library)?
* Music files should be added to `/storage/roms/BGM`
### My game has slowdown and stuttering issues. What can I do to improve performance?
First make sure you do not have a TDP configured that is too low for your emulator to function correctly. Next, try adjusting settings within the emulator, either retroarch core or standalone emulator configuration menu. First make sure that rewind is disabled. Search online to check for recommended settings that others may have determined.
### Where are log files stored?
Log files can be found in `/var/log/`
Various logs are generated, including
* EmuStation logs `es_log.txt` (cumulative log of all ES activity), `es_launch_stdout.log` (last emulator launched from ES) and `es_launch_stderr.log` (blank if there wasn't an error for the last emulator launch)
* Execution log `exec.log` (generic execution log that indicates what was last executed, including the command to launch the emulator) e.g. for gzdoom launch of heretic.doom `runemu.sh: Executing /usr/bin/bash start_gzdoom.sh /storage/roms/doom/heretic.doom`
* Boot log `boot.log` (Output from autostart during system startup)
* Emulator-specific log (for non-retroarch emulators) e.g. `gzdoom.log` is the log specific to gzdoom to indicate whether there is any issue within the emulator when launching heretic.doom, noted above
* Retroarch logs are [turned off by default](https://github.com/JustEnoughLinuxOS/distribution/blob/main/packages/games/emulators/retroarch/sources/handheld/retroarch.cfg#L420), but can be enabled within Retroarch (`Tools > Retroarch`: `Settings > Logging > Log to a File`), are stored in `/var/log/retroarch` and are quite detailed, so should provide sufficient detail to identify missing roms within a game's romset, configuration issues and other errors that prevent games from working
> Note: Retroarch uses a shared config file, so logging can be enabled within 64bit or 32bit and it will be enabled for all Retroarch cores
### I have a device with a single microsd and I can't see the games partition in Windows or macOS.
JELOS does not create an ExFAT partition on the boot device, and expands the full partition using ext4. You can sync files to the device using SyncThing, copy files to the device using SAMBA, or by loading your files onto a EXT4, ExFAT, or FAT32 formatted usb stick and copy them with FileMan or over ssh.
* Windows Users can connect to their device by unc path using the device name such as `\\handheld` or by IP `\\device IP address` into the address bar in Windows Explorer.
* Mac users can connect by selecting "Go" from the Finder menu, followed by "Connect to Server", then enter `smb://handheld` or `smb://device IP address`.
* Log in as root. The root password is required for access which can be found in the system menu.

71
docs/index.md Normal file
View file

@ -0,0 +1,71 @@
![JELOS on AYANEO Air Plus](_inc/images/devices/ayaneo-air-plus.png){ .off-glb }
# Welcome to the JELOS Wiki :material-gamepad:
[![Latest Version](https://img.shields.io/github/release/JustEnoughLinuxOS/distribution.svg?labelColor=111111&color=5998FF&label=Latest&style=flat#only-light)](https://github.com/JustEnoughLinuxOS/distribution/releases/latest) [![Activity](https://img.shields.io/github/commit-activity/m/JustEnoughLinuxOS/distribution?labelColor=111111&color=5998FF&label=Commits&style=flat#only-light)](https://github.com/JustEnoughLinuxOS/distribution/commits) [![Pull Requests](https://img.shields.io/github/issues-pr-closed/JustEnoughLinuxOS/distribution?labelColor=111111&color=5998FF&label=Pull&nbsp;Requests&style=flat#only-light)](https://github.com/JustEnoughLinuxOS/distribution/pulls) [![Community](https://img.shields.io/discord/948029830325235753?labelColor=111111&color=5998FF&label=Community&style=flat#only-light)](https://discord.gg/seTxckZjJy)
[![Latest Version](https://img.shields.io/github/release/JustEnoughLinuxOS/distribution.svg?labelColor=dddddd&color=5998FF&label=Latest&style=flat#only-dark)](https://github.com/JustEnoughLinuxOS/distribution/releases/latest) [![Activity](https://img.shields.io/github/commit-activity/m/JustEnoughLinuxOS/distribution?labelColor=dddddd&color=5998FF&label=Commits&style=flat#only-dark)](https://github.com/JustEnoughLinuxOS/distribution/commits) [![Pull Requests](https://img.shields.io/github/issues-pr-closed/JustEnoughLinuxOS/distribution?labelColor=dddddd&color=5998FF&label=Pull&nbsp;Requests&style=flat#only-dark)](https://github.com/JustEnoughLinuxOS/distribution/pulls) [![Community](https://img.shields.io/discord/948029830325235753?labelColor=dddddd&color=5998FF&label=Community&style=flat#only-dark)](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.
## Features
- 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.
- 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.
## Screenshots
<table>
<tr>
<td><img src="_inc/images/screenshots/system-view.png"/></td>
<td><img src="_inc/images/screenshots/menu.png"/></td>
</tr>
<tr>
<td><img src="_inc/images/screenshots/gamelist-view-metadata-immersive.png"/></td>
<td><img src="_inc/images/screenshots/gamelist-view-no-metadata-immersive.png"/></td>
</tr>
</table>
## Community
The JELOS community utilizes Discord for discussion, if you would like to join us please use this link: &nbsp;[:simple-discord: Discord](https://discord.gg/seTxckZjJy)
## 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](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.
## 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.

360
docs/play/hotkeys.md Normal file
View file

@ -0,0 +1,360 @@
# Hotkeys
By default JELOS will detect your controller and configure RetroArch hotkeys automatically. If this behavior is not desired it can be disabled in the System Settings menu by disabling the "AUTOCONFIGURE RETROARCH HOTKEYS" option.
## RetroArch Hotkeys
* [Hotkey Enable](https://docs.libretro.com/guides/input-and-controls/#hotkey-controls): Select (Hold)
* Exit: Start (Press Twice)
* Menu: X
* Favorite: Hold X
* Show/Hide FPS: Y
* Save State: R1
* Load State: L1
* Rewind: L2
* Fast-Forward Toggle: R2
> Note: X and Y are reversed on some devices, this is normal behavior.
## Global Hotkeys
* Pause: Start
* Quit: Start+Select
* Force-Close: L1+Start+Select
* Skip 5s: R1
* Back 5s: L1
* Skip 60s: R2
* Back 60s: L2
> Note: Force-Close is R1+Start+Select on some devices, this is normal behavior.
## Per Device Hotkeys
|Device|Brightness Up|Brightness Down|Battery Status|WIFI Toggle|
|----|----|----|----|----|
|Anbernic RG351M|Select & Vol +|Select & Vol -|Start & Vol +|Start & Vol -|
|Anbernic RG353M|Select & Vol +|Select & Vol -|Fn & Vol +|Fn & Vol -|
|Anbernic RG353P|Select & Vol +|Select & Vol -|Fn & Vol +|Fn & Vol -|
|Anbernic RG353V|Select & Vol +|Select & Vol -|Fn & Vol +|Fn & Vol -|
|Anbernic RG503|Select & Vol +|Select & Vol -|Fn & Vol +|Fn & Vol -|
|Anbernic RG552|Select & Vol +|Select & Vol -|Fn & Vol +|Fn & Vol -|
|ATARI VCS 800 Onyx|NA|NA|NA|NA|
|AYANEO AIR|Aya Button & Vol + | Aya Button & Vol - | = Button & Vol + | = Button & Vol -|
|AYANEO AIR Plus|Aya Button & Vol + | Aya Button & Vol - | = Button & Vol + | = Button & Vol -|
|AYANEO AIR Pro|Aya Button & Vol + | Aya Button & Vol - | = Button & Vol + | = Button & Vol -|
|AYANEO AYANEO 2|Aya Button & Vol + | Aya Button & Vol - | = Button & Vol + | = Button & Vol -|
|AYANEO AYA NEO 2021|Aya Button & Vol + | Aya Button & Vol - | = Button & Vol + | = Button & Vol -|
|AYANEO AYANEO 2021|Aya Button & Vol + | Aya Button & Vol - | = Button & Vol + | = Button & Vol -|
|AYANEO AYANEO 2021 Pro|Aya Button & Vol + | Aya Button & Vol - | = Button & Vol + | = Button & Vol -|
|AYANEO AYANEO 2021 Pro Retro Power|Aya Button & Vol + | Aya Button & Vol - | = Button & Vol + | = Button & Vol -|
|AYA NEO AYA NEO Founder|Aya Button & Vol + | Aya Button & Vol - | = Button & Vol + | = Button & Vol -|
|AYANEO AYANEO NEXT Pro|Aya Button & Vol + | Aya Button & Vol - | = Button & Vol + | = Button & Vol -|
|AYANEO GEEK|Aya Button & Vol + | Aya Button & Vol - | = Button & Vol + | = Button & Vol -|
|AYANEO NEXT|Aya Button & Vol + | Aya Button & Vol - | = Button & Vol + | = Button & Vol -|
|AYANEO NEXT Advance|Aya Button & Vol + | Aya Button & Vol - | = Button & Vol + | = Button & Vol -|
|AYANEO NEXT Pro|Aya Button & Vol + | Aya Button & Vol - | = Button & Vol + | = Button & Vol -|
|GPD G1619-04|TBD|TBD|TBD|TBD|
|Hardkernel ODROID-GO-Ultra|F1 & Vol +|F1 & Vol -|F2 & Vol +|F2 & Vol -|
|Indiedroid Nova|NA|NA|NA|NA|
|LENOVO 81TC|NA|NA|NA|NA|
|ODROID-GO Advance|Select & Vol +|Select & Vol -|Start & Vol +|Start & Vol -|
|ODROID-GO Advance Black Edition|Select & Vol +|Select & Vol -|Start & Vol +|Start & Vol -|
|ODROID-GO Super|Select & Vol +|Select & Vol -|Start & Vol +|Start & Vol -|
|Orange Pi 5|NA|NA|NA|NA|
|Powkiddy RGB10 MAX 3|F1 & Vol +|F1 & Vol -|F2 & Vol +|F2 & Vol -|
|Powkiddy RK2023|Select & Vol +|Select & Vol -|Start & Vol +|Start & Vol -|
|Powkiddy x55|Select & Vol +|Select & Vol -|Start & Vol +|Start & Vol -|
|Valve Jupiter|Steam Button & Vol + | Steam Button & Vol - | ... Button & Vol + | ... Button & Vol -|
[Reference](https://github.com/JustEnoughLinuxOS/distribution/blob/main/packages/jelos/profile.d/98-jslisten)
## Emulator Hotkeys and Button Assignments
<table>
<tr style="vertical-align:top">
<th align="left">Emulator</th><th align="left">Notes</th>
</tr>
<tr>
<td><a href="https://github.com/midwan/amiberry/wiki">Amiberry</a></td><td><a href="https://github.com/midwan/amiberry/wiki/Kickstart-ROMs-(BIOS)">Standalone</a></td>
</tr>
<tr>
<td valign="top"><a href="https://github.com/dolphin-emu/dolphin">Dolphin (dolphin-sa)</a></td><td><a href="https://dolphin-emu.org/">Standalone</a>
```
HOTKEYS (BASED ON GAMECUBE CONTROLLER PROFILE)
=======
SELECT hotkey enable
START exit to EmulationStation ("ES")
R save state
L load state
A screenshot
B internal resolution
Z game speed (fast forward)
X aspect ratio
Y fps on / off
DUP +1 save state slot
DDOWN -1 save state slot
```
</td>
</tr>
<tr>
<td><a href="http://maniacsvault.net/ecwolf/wiki/Main_Page">ecwolf</a></td><td><a href="http://maniacsvault.net/ecwolf/wiki/Game_data">Game Engine</a></td>
</tr>
<tr>
<td><a href="https://github.com/coelckers/gzdoom">gzdoom</a></td><td><a href="https://zdoom.org/wiki/IWAD">Game Engine</a></td>
</tr>
<tr>
<td><a href="https://git.tuxfamily.org/hatari/hatari.git">Hatari (Hatarisa)</a></td><td><a href="https://docs.libretro.com/library/hatari/#bios">Standalone</a></td>
</tr>
<tr>
<td valign="top"><a href="https://github.com/DirtBagXon/hypseus-singe">Hypseus-singe</a></td><td><a href="https://www.daphne-emu.com:9443/mediawiki/index.php/Main_Page">Standalone</a>
```
SELECT coin
START start
BUTTON 1 a
BUTTON 2 b
BUTTON 3 x
MOVEMENT d-pad or left-analog
QUIT select+start
```
to add functions, edit `/storage/.config/game/configs/hypseus/hypinput.ini` under `[KEYBOARD]` section by changing third number for a function from `0` (disabled) to the joystick button number
retrieve joystick button numbers with
```jstest /dev/input/js0```
the following assigns quit to ```L1``` and pause to ```R1```
```
[KEYBOARD]
KEY_QUIT = SDLK_ESCAPE 0 5
KEY_PAUSE = SDLK_p 0 6
```
</td>
</tr>
<tr>
<td><a href="https://github.com/drfrag666/gzdoom">lzdoom</a></td><td><a href="https://zdoom.org/wiki/IWAD">Game Engine</a></td>
</tr>
<tr>
<td valign="top"><a href="https://github.com/mupen64plus/mupen64plus-video-glide64mk2">mupen64plus (mupen64plussa)</a></td><td><a href="https://mupen64plus.org/docs">Standalone</a>
```
SELECT hotkey enable
START start
B a
Y b
RIGHT ANALOG C-stick
LEFT ANALOG analog
L1 L
L2 Z
R1 R
HOTKEYS
=======
SELECT+START exit to EmulationStation ("ES")
SELECT+R1 save state
SELECT+L1 load state
SELECT+Y screenshot
SELECT+B reset current game
```
CONTROLLER PROFILES
Z and L button assignment can be changed in ES.
* Highlight the game and press X
* Select ADVANCED GAME OPTIONS (A to confirm)
* Set EMULATOR to either MUPEN64PLUSSA
* Change INPUT CONFIGURATION
* DEFAULT: L1 = L, L2 = Z
* Z & L SWAP: L1 = Z, L2 = L
* CUSTOM: Users can create their own controller layout in ```/storage/.configs/game/configs/mupen64plussa```
</td>
</tr>
<tr>
<td valign="top"><a href="https://github.com/DCurrent/openbor">Openbor</a></td><td><a href="https://www.chronocrash.com/forum/index.php?resources/">Standalone</a>
```
START start, confirm
A attack 1
X attack 2
L1 attack 3
R1 attack 4
B jump
Y special
D-PAD up/down/left/right
SELECT cancel, screenshot
```
note: pressing A on title screen will exit
</td>
</tr>
<tr>
<td valign="top"><a href="https://github.com/hrydgard/ppsspp">PPSSPPSDL</a></td><td><a href="https://www.ppsspp.org/faq.html">Standalone</a>
```
START start
SELECT select
B cross
A circle
X triangle
Y square
L1 L
R1 R
ANALOG LEFT analog
ANALOG RIGHT cross(down) circle(right) triangle(up) square(left)
D-PAD up/down/left/right
L3 PPSSPPSDL menu
```
</td>
</tr>
<tr>
<td><a href="https://zdoom.org/wiki/Raze">Raze</a></td><td><a href="https://zdoom.org/wiki/Raze#Supported_games">Game Engine</a></td>
</tr>
<tr>
<td><a href="https://www.scummvm.org">Scummmvm (Scummvmsa)</a></td><td><a href="https://www.scummvm.org/compatibility/">Standalone</a></td>
</tr>
<tr>
<td valign="top"><a href="https://vice-emu.sourceforge.io/vice_toc.html">vice (vicesa)</a></td><td><a href="https://vice-emu.sourceforge.io/vice_2.html#SEC5">Standalone</a>
```
SELECT onscreen keyboard
START show menu
A back (in menus); show menu
B fire (joystick port 1); confirm (in menus)
L1 back (in menus); show menu
L2 assign hotkey
L3 fire (joystick port 2)
R1 confirm (in menus)
R2 swap joystick port (either [left analog + B=fire] or [right analog + L3=fire])
```
Notes:
Games will require keyboard key presses to progress through messages and to launch
(e.g. SPACE, RSTR [run/start], F3, F7).
SELECT to show onscreen keyboard, left analog/d-pad to move cursor, B to confirm
C= on keyboard resets the machine
L2 to assign highlighted key or menu function to gamepad button (save config to retain)
To cancel onscreen keyboard, move cursor to blank area and A/L1 to close keyboard
or click on X in top left corner of keyboard
Joystick can be assigned to port 1 or 2. R2 to switch ports.
port 1: [left analog] + [B = fire]
port 2: [right analog] + [L3 = fire].
To quit emulator, START, highlight Exit Emulator, B to confirm
</td>
</tr>
<tr>
<td valign="top"><a href="http://wiki.yabause.org/index.php5?title=Documentations">Yabasanshiro</a></td><td><a href="http://www.uoyabause.org">Standalone</a>
```
SELECT menu
START start
D-PAD up/down/left/right
Y a
B b
A c
X x
L1 (shoulder) y
R1 (shoulder) z
L2 (trigger) l
R2 (trigger) r
LEFT ANALOG analog stick
START+SELECT+L1+R1 exit emulator
```
</td>
</tr>
<tr>
<td valign="top"><a href="https://www.retroarch.com">Retroarch with Libretro Cores (<strong>RA:</strong>)</a></td><td>64-bit and 32-bit versions use shared config files
```
SELECT+START: exit (press twice)
SELECT+A: pause emulation
SELECT+B: reset emulation
SELECT+X: Retroarch menu
SELECT+Y: toggle fps
SELECT+L1: load state
SELECT+R1: save state
SELECT+L2: rewind toggle
SELECT+R2: fast-forward toggle
```
</td>
</tr>
<tr>
<td><a href="https://github.com/christianhaitian/PortMaster/blob/main/README.md">Port Master</a></td><td><a href="https://github.com/christianhaitian/PortMaster/wiki">Port Installer</a></td>
</tr>
</table>
## Button Codes
From ssh terminal:
```
evtest
```
then select `retrogame_joypad` to see details for each button press, including button labels, codes and analog stick values in real-time
```
jstest-sdl -t 0
```
to see interactive keymap
<table>
<tr style="vertical-align:top">
<th align="left">Joypad Button</th><th align="left" colspan=4>Button Codes</th>
</tr>
<tr>
<td>
<strong>DIGITAL</strong></td><td><strong><a href="https://github.com/JustEnoughLinuxOS/distribution/blob/5ae14a65cc446c1e6f7083ac47adeafc806134a6/packages/ui/emulationstation/config/es_input.cfg#L63">RG552/RG503/RG353P</a></strong></td><td><strong><a href="https://github.com/JustEnoughLinuxOS/distribution/blob/5ae14a65cc446c1e6f7083ac47adeafc806134a6/packages/ui/emulationstation/config/es_input.cfg#L33">RG351MP</a></strong></td><td><strong><a href="https://github.com/JustEnoughLinuxOS/distribution/blob/5ae14a65cc446c1e6f7083ac47adeafc806134a6/packages/ui/emulationstation/config/es_input.cfg#L6">RG351P/M</a></strong></td><td><strong><a href="https://github.com/JustEnoughLinuxOS/distribution/blob/5ae14a65cc446c1e6f7083ac47adeafc806134a6/packages/ui/emulationstation/config/es_input.cfg#L6">RG351V</a></strong></td></tr>
<tr><td>
A (EAST) </td><td><strong>1</strong> (305 BTN_EAST)</td><td><strong>1</strong> (305 BTN_EAST)</td><td><strong>0</strong> (305 BTN_EAST)</td><td><strong>0</strong> (305 BTN_EAST)</td></tr>
<tr><td>
B (SOUTH) </td><td><strong>0</strong> (304 BTN_SOUTH)</td><td><strong>0</strong> (304 BTN_SOUTH)</td><td><strong>1</strong> (304 BTN_SOUTH)</td><td><strong>1</strong> (304 BTN_SOUTH)</td></tr>
<tr><td>
X (NORTH) </td><td><strong>2</strong> (307 BTN_NORTH)</td><td><strong>2</strong> (307 BTN_NORTH)</td><td><strong>2</strong> (307 BTN_NORTH)</td><td><strong>2</strong> (307 BTN_NORTH)</td></tr>
<tr><td>
Y (WEST) </td><td><strong>3</strong> (308 BTN_WEST)</td><td><strong>3</strong> (308 BTN_WEST)</td><td><strong>3</strong> (306 BTN_C)</td><td><strong>3</strong> (306 BTN_C)</td></tr>
<tr><td>
L1 </td><td><strong>4</strong> (310 BTN_TL)</td><td><strong>4</strong> (310 BTN_TL)</td><td><strong>4</strong> (308 BTN_WEST)</td><td><strong>4</strong> (308 BTN_WEST)</td></tr>
<tr><td>
L2 </td><td><strong>6</strong> (312 BTN_TL2)</td><td><strong>6</strong> (312 BTN_TL2)</td><td><strong>10</strong> (314 BTN_SELECT)</td><td><strong>10</strong> (314 BTN_SELECT)</td></tr>
<tr><td>
L3 </td><td><strong>11</strong> (317 BTN_THUMBL)</td><td><strong>14</strong> (706 BTN_TRIGGER_HAPPY3)</td><td><strong>8</strong> (312 BTN_TL2)</td><td><strong>8</strong> (312 BTN_TL2)</td></tr>
<tr><td>
R1 </td><td><strong>5</strong> (311 BTN_TR)</td><td><strong>5</strong> (311 BTN_TR)</td><td><strong>5</strong> (309 BTN_Z)</td><td><strong>5</strong> (309 BTN_Z)</td></tr>
<tr><td>
R2 </td><td><strong>7</strong> (313 BTN_TR2)</td><td><strong>7</strong> (313 BTN_TR2)</td><td><strong>11</strong> (315 BTN_START)</td><td><strong>11</strong> (315 BTN_START)</td></tr>
<tr><td>
R3 </td><td><strong>12</strong> (318 BTN_THUMBR)</td><td><strong>15</strong> (707 BTN_TRIGGER_HAPPY4)</td><td><strong>9</strong> (313 BTN_TR2)</td><td><strong>9</strong> (313 BTN_TR2; F)</td></tr>
<tr><td>
SELECT </td><td><strong>8</strong> (314 BTN_SELECT)</td><td><strong>12</strong> (704 BTN_TRIGGER_HAPPY1)</td><td><strong>7</strong> (311 BTN_TR)</td><td><strong>7</strong> (311 BTN_TR)</td></tr>
<tr><td>
START </td><td><strong>9</strong> (315 BTN_START)</td><td><strong>13</strong> (705 BTN_TRIGGER_HAPPY2)</td><td><strong>6</strong> (310 BTN_TL)</td><td><strong>6</strong> (310 BTN_TL)</td></tr>
<tr><td>
HOTKEY ENABLE </td><td><strong>10</strong> (316) </td><td><strong>12</strong> (704 BTN_TRIGGER_HAPPY1) </td><td><strong>7</strong> (311 BTN_TR) </td><td><strong>7</strong> (311 BTN_TR) </td></tr>
<tr><td>
DPAD UP </td><td><strong>13</strong> (544 BTN_DPAD_UP) </td><td><strong>8</strong> (544 BTN_DPAD_UP) </td><td><strong>hat(1)</strong> (16 -ve ABS_HAT0Y -1)</td><td><strong>hat(1)</strong> (16 -ve ABS_HAT0Y -1)</td></tr>
<tr><td>
DPAD DOWN </td><td><strong>14</strong> (545 BTN_DPAD_DOWN) </td><td><strong>9</strong> (545 BTN_DPAD_DOWN) </td><td><strong>hat(4)</strong> (16 +ve ABS_HAT0Y 1)</td><td><strong>hat(4)</strong> (16 +ve ABS_HAT0Y 1)</td></tr>
<tr><td>
DPAD LEFT </td><td><strong>15</strong> (546 BTN_DPAD_LEFT) </td><td><strong>10</strong> (546 BTN_DPAD_LEFT) </td><td><strong>hat(8)</strong> (17 -ve ABS_HAT0X -1)</td><td><strong>hat(8)</strong> (17 -ve ABS_HAT0X -1)</td></tr>
<tr><td>
DPAD RIGHT </td><td><strong>16</strong> (547 BTN_DPAD_RIGHT) </td><td><strong>11</strong> (547 BTN_DPAD_RIGHT) </td><td><strong>hat(2)</strong> (17 +ve ABS_HAT0X 1)</td><td><strong>hat(2)</strong> (17 +ve ABS_HAT0X 1)</td></tr>
<tr><td>
<strong>ANALOG</strong></td><td><strong><a href="https://github.com/JustEnoughLinuxOS/distribution/blob/5ae14a65cc446c1e6f7083ac47adeafc806134a6/packages/ui/emulationstation/config/es_input.cfg#L63">RG552/RG503/RG353P</a></strong></td><td><strong><a href="https://github.com/JustEnoughLinuxOS/distribution/blob/5ae14a65cc446c1e6f7083ac47adeafc806134a6/packages/ui/emulationstation/config/es_input.cfg#L33">RG351MP</a></strong></td><td><strong><a href="https://github.com/JustEnoughLinuxOS/distribution/blob/5ae14a65cc446c1e6f7083ac47adeafc806134a6/packages/ui/emulationstation/config/es_input.cfg#L6">RG351P/M</a></strong></td><td><strong><a href="https://github.com/JustEnoughLinuxOS/distribution/blob/5ae14a65cc446c1e6f7083ac47adeafc806134a6/packages/ui/emulationstation/config/es_input.cfg#L6">RG351V</a></strong></td></tr>
<tr><td>
LEFTANALOGLEFT </td><td><strong>AXIS 0 -ve</strong> (ABS_X)</td><td><strong>AXIS 0 -ve</strong> (ABS_X)</td><td><strong>AXIS 2 +ve</strong> (ABS_Z 4095)</td><td><strong>AXIS 2 +ve</strong> (ABS_Z 4095)</td></tr>
<tr><td>
LEFTANALOGRIGHT </td><td><strong>AXIS 0 +ve</strong> (ABS_X)</td><td><strong>AXIS 0 +ve</strong> (ABS_X)</td><td><strong>AXIS 2 -ve (ABS_Z 0)</strong></td><td><strong>AXIS 2 -ve</strong> (ABS_Z 0)</td></tr>
<tr><td>
LEFTANALOGUP </td><td><strong>AXIS 1 -ve</strong> (ABS_Y)</td><td><strong>AXIS 1 -ve</strong> (ABS_Y)</td><td><strong>AXIS 3 +ve</strong> (ABS_RX 4040)</td><td><strong>AXIS 3 +ve</strong> (ABS_RX 4040)</td></tr>
<tr><td>
LEFTANALOGDOWN </td><td><strong>AXIS 1 +ve</strong> (ABS_Y)</td><td><strong>AXIS 1 +ve</strong> (ABS_Y)</td><td><strong>AXIS 3 -ve</strong> (ABS_RX 0)</td><td><strong>AXIS 3 -ve</strong> (ABS_RX 0)</td></tr>
<tr><td>
RIGHTANALOGLEFT </td><td><strong>AXIS 2 -ve</strong> (ABS_RX)</td><td><strong>AXIS 2 -ve</strong> (ABS_RX)</td><td><strong>AXIS 4 -ve</strong> (ABS_RY)</td><td></td></tr>
<tr><td>
RIGHTANALOGRIGHT </td><td><strong>AXIS 2 +ve</strong> (ABS_RX)</td><td><strong>AXIS 2 +ve</strong> (ABS_RX)</td><td><strong>AXIS 4 +ve</strong> (ABS_RY)</td><td></td></tr>
<tr><td>
RIGHTANALOGUP </td><td><strong>AXIS 3 -ve</strong> (ABS_RY)</td><td><strong>AXIS 3 -ve (ABS_RY)</strong></td><td><strong>AXIS 5 -ve</strong> (ABS_RZ)</td><td></td></tr>
<tr><td>
RIGHTANALOGDOWN </td><td><strong>AXIS 3 +ve</strong> (ABS_RY)</td><td><strong>AXIS 3 +ve (ABS_RY)</strong></td><td><strong>AXIS 5 +ve</strong> (ABS_RZ)</td><td></td>
</tr>
</table>

13
docs/play/install.md Normal file
View file

@ -0,0 +1,13 @@
# Installing JELOS
## Installation
* JELOS is installed by restoring an image file and [Flashing](https://github.com/JustEnoughLinuxOS/distribution/tree/main#flashing) to a device's internal storage or an external sd card.
* On x86 devices JELOS includes an installation tool. The installation tool can be found in the tools menu, which is one of the systems listed within ES.
* JELOS operating system is stored on an Ext4 partition that can be read by LINUX but is not natively readable on Windows. Currently it is not possible to access the primary JELOS Ext4 partition on Windows to transfer roms.
* On devices that support a second sd card, the sd card can be formatted as Ext4, FAT32, or exFAT. JELOS will automatically detect the second SD card on boot and configure the relevant folders for storing roms.
* External services are disabled by default in release 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.
## 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.

6
docs/play/update.md Normal file
View file

@ -0,0 +1,6 @@
# Updating JELOS
* 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.

14
docs/supported-devices/anbernic/rg351pm.md Normal file
View file

@ -0,0 +1,14 @@
# Anbernic RG351 [P/M]
![](../../_inc/images/devices/anbernic-rg351pm.png){ .off-glb }
## Overview
| Device | CPU / Architecture | Kernel | GL driver | Interface |
| -- | -- | -- | -- | -- |
| RG351P/M | Rockchip RK3326 (ARM) | Mainline Linux | Panfrost | Weston + EmulationStation |
## Additional References
- [Platform Documentation (RK3326)](https://github.com/JustEnoughLinuxOS/distribution/blob/main/documentation/PER_DEVICE_DOCUMENTATION/RK3326)
- [Device Quirks](https://github.com/JustEnoughLinuxOS/distribution/tree/main/packages/hardware/quirks/devices/Anbernic%20RG351M)

27
docs/supported-devices/anbernic/rg353pmvvs.md Normal file
View file

@ -0,0 +1,27 @@
# Anbernic RG353 [P/M/V/VS]
![](../../_inc/images/devices/anbernic-rg353.png){ .off-glb }
## Overview
| Device | CPU / Architecture | Kernel | GL driver | Interface |
| -- | -- | -- | -- | -- |
| RG353P | Rockchip RK3566 (ARM) | Rockchip BSP 4.19 | Mali | KMS/DRM + EmulationStation |
| RG353M | Rockchip RK3566 (ARM) | Rockchip BSP 4.19 | Mali | KMS/DRM + EmulationStation |
| RG353V | Rockchip RK3566 (ARM) | Rockchip BSP 4.19 | Mali | KMS/DRM + EmulationStation |
| RG353VS | Rockchip RK3566 (ARM) | Rockchip BSP 4.19 | Mali | KMS/DRM + EmulationStation |
!!! info "Anbernic RG353P/M/V/VS devices with both v1 and v2 displays are supported."
!!! warning "RG353PS will not be supported."
## Additional References
- [Platform Documentation (RK3566)](https://github.com/JustEnoughLinuxOS/distribution/blob/main/documentation/PER_DEVICE_DOCUMENTATION/RK3566)
- [Device Quirks (353P/M)](https://github.com/JustEnoughLinuxOS/distribution/tree/main/packages/hardware/quirks/devices/Anbernic%20RG353P)
- [Device Quirks (353V)](https://github.com/JustEnoughLinuxOS/distribution/tree/main/packages/hardware/quirks/devices/Anbernic%20RG353V)
## Videos
| <iframe width="560" height="315" src="https://www.youtube.com/embed/tJR0Evx3KS0?si=UNCRp6nQWJClLo0H" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe> | <iframe width="560" height="315" src="https://www.youtube.com/embed/MjyyxyIcEto?si=wYlVT6oRjsCGg0Hh" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe> |
| -- | -- |
| <iframe width="560" height="315" src="https://www.youtube.com/embed/Q9zETew3iuY?si=PiOlyviTPN3QDQqb&amp;start=1104" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe> | <iframe width="560" height="315" src="https://www.youtube.com/embed/vnHRKn9FoVw?si=OuJyNbTn3rdJNvNa" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe> |

13
docs/supported-devices/anbernic/rg503.md Normal file
View file

@ -0,0 +1,13 @@
# Anbernic RG503
![](../../_inc/images/devices/anbernic-rg503.png){ .off-glb }
## Overview
| Device | CPU / Architecture | Kernel | GL driver | Interface |
| -- | -- | -- | -- | -- |
| RG503 | Rockchip RK3566 (ARM) | Rockchip BSP 4.19 | Mali | KMS/DRM + EmulationStation |
## Additional References
- [Platform Documentation (RK3566)](https://github.com/JustEnoughLinuxOS/distribution/blob/main/documentation/PER_DEVICE_DOCUMENTATION/RK3566)

13
docs/supported-devices/anbernic/rg552.md Normal file
View file

@ -0,0 +1,13 @@
# Anbernic RG552
![](../../_inc/images/devices/anbernic-rg552.png){ .off-glb }
## Overview
| Device | CPU / Architecture | Kernel | GL driver | Interface |
| -- | -- | -- | -- | -- |
| RG552 | Rockchip RK3399 (ARM) | Mainline Linux | Panfrost | Weston + EmulationStation |
## Additional References
- [Platform Documentation (RK3399)](https://github.com/JustEnoughLinuxOS/distribution/blob/main/documentation/PER_DEVICE_DOCUMENTATION/RK3399)

13
docs/supported-devices/anbernic/win600.md Normal file
View file

@ -0,0 +1,13 @@
# Anbernic Win600
![](../../_inc/images/devices/anbernic-win600.png){ .off-glb }
## Overview
| Device | CPU / Architecture | Kernel | GL driver | Interface |
| -- | -- | -- | -- | -- |
| Win600 | AMD Athlon Silver 3050e (x86_64) | Mainline Linux | Radeonsi | Weston + EmulationStation |
## Additional References
- [Platform Documentation (AMD64)](https://github.com/JustEnoughLinuxOS/distribution/blob/main/documentation/PER_DEVICE_DOCUMENTATION/AMD64)

13
docs/supported-devices/aokzoe/a1-pro.md Normal file
View file

@ -0,0 +1,13 @@
# AOKZOE A1 Pro
![](../../_inc/images/devices/aokzoe-a1-pro.png){ .off-glb }
## Overview
| Device | CPU / Architecture | Kernel | GL driver | Interface |
| -- | -- | -- | -- | -- |
| A1 Pro | AMD 7840u (x86_64) | Mainline Linux | Radeonsi | Weston + EmulationStation |
## Additional References
- [Platform Documentation (AMD64)](https://github.com/JustEnoughLinuxOS/distribution/blob/main/documentation/PER_DEVICE_DOCUMENTATION/AMD64)

13
docs/supported-devices/atari/vcs.md Normal file
View file

@ -0,0 +1,13 @@
# Atari VCS
![](../../_inc/images/devices/atari-vcs.png){ .off-glb }
## Overview
| Device | CPU / Architecture | Kernel | GL driver | Interface |
| -- | -- | -- | -- | -- |
| VCS | AMD Ryzen R1606G (x86_64) | Mainline Linux | Radeonsi | Weston + EmulationStation |
## Additional References
- [Platform Documentation (AMD64)](https://github.com/JustEnoughLinuxOS/distribution/blob/main/documentation/PER_DEVICE_DOCUMENTATION/AMD64)

32
docs/supported-devices/ayaneo/air-plus.md Normal file
View file

@ -0,0 +1,32 @@
# AYANEO Air Plus
![](../../_inc/images/devices/ayaneo-air-plus.png){ .off-glb }
## Overview
| Device | CPU / Architecture | Kernel | GL driver | Interface |
| -- | -- | -- | -- | -- |
| Air Plus | Amd Ryzen 7 6800U / (x86_64) | Mainline Linux | Radeonsi | Weston + EmulationStation |
## Features
| Feature&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | Notes |
| -- | -- |
| :material-harddisk: Storage | JELOS can be run from an SD Card, USB Drive or installed directly to the internal NVME. <br> When installed directly to the NVME; an SD Card can be used for game storage. |
| :material-lightning-bolt-circle: TPD Limit | Can be set globally, per system or per game. |
## Notes
| DMI_SYS_VENDOR | DMI_PRODUCT_NAME |
| -- | -- |
| `AYANEO ` | `AIR Plus` |
### Booting from an SD Card
To boot JELOS from the SD Card, hold `LC` + `Volume Up` and press the power button, continue holding `LC` + `Volume Up` until the Ayaneo logo appears. Select the storage device with JELOS from the boot menu using the Ayaneo button, and then press volume up to boot the distribution.
## Additional References
- [Platform Documentation (AMD64)](https://github.com/JustEnoughLinuxOS/distribution/blob/main/documentation/PER_DEVICE_DOCUMENTATION/AMD64)
- [Device Quirks](https://github.com/JustEnoughLinuxOS/distribution/tree/main/packages/hardware/quirks/devices/AYANEO%20AIR%20Plus)
- [Panel Rotation](https://github.com/JustEnoughLinuxOS/distribution/blob/main/packages/kernel/linux/patches/AMD64/002-display-quirks.patch)

41
docs/supported-devices/ayaneo/air.md Normal file
View file

@ -0,0 +1,41 @@
# AYANEO Air / Air Pro
![](../../_inc/images/devices/ayaneo-air.png){ .off-glb }
## Overview
| Device | CPU / Architecture | Kernel | GL driver | Interface |
| -- | -- | -- | -- | -- |
| Air | Amd Ryzen 5 5560U (x86_64) | Mainline Linux | Radeonsi | Weston + EmulationStation |
| Air Pro | Amd Ryzen 5 5560U (x86_64) | Mainline Linux | Radeonsi | Weston + EmulationStation |
| Air Pro | AMD Ryzen 7 5825U (x86_64) | Mainline Linux | Radeonsi | Weston + EmulationStation |
## Features
| Feature&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | Notes |
| -- | -- |
| :material-harddisk: Storage | JELOS can be run from an SD Card, USB Drive or installed directly to the internal NVME. <br> When installed directly to the NVME; an SD Card can be used for game storage. |
| :material-fan: Fan | Can be set globally, per system or per game. |
| :material-lightning-bolt-circle: TPD Limit | Can be set globally, per system or per game. |
| :material-lightbulb-on: RGB | Supports selecting from a set of colors or turning the RGB off (choice persists through reboots) <br> Does not support changing brightness or turning on other effects. |
## Notes
| DMI_SYS_VENDOR | DMI_PRODUCT_NAME |
| -- | -- |
| `AYANEO ` | `AIR` |
| `AYANEO ` | `AIR Pro` |
### Booting from an SD Card
To boot JELOS from the SD Card, hold `LC` + `Volume Up` and press the power button, continue holding `LC` + `Volume Up` until the Ayaneo logo appears. Select the storage device with JELOS from the boot menu using the Ayaneo button, and then press volume up to boot the distribution.
### Changing the RGB
In EmulationStation press the `Start` button to open the Main Menu. Then select `System Settings` and scroll until you see `Device LEDS`. Under that setting you can choose to turn RGB Off or select from a set of pre-defined colors. The value you set will persist through all future reboots but note your RGB setting will only take effect after JELOS boots.
## Additional References
- [Platform Documentation (AMD64)](https://github.com/JustEnoughLinuxOS/distribution/blob/main/documentation/PER_DEVICE_DOCUMENTATION/AMD64)
- [Device Quirks](https://github.com/JustEnoughLinuxOS/distribution/tree/main/packages/hardware/quirks/devices/AYANEO%20AIR)
- [Panel Rotation](https://github.com/JustEnoughLinuxOS/distribution/blob/main/packages/kernel/linux/patches/AMD64/002-display-quirks.patch)

32
docs/supported-devices/ayaneo/ayaneo-2.md Normal file
View file

@ -0,0 +1,32 @@
# AYANEO 2
![](../../_inc/images/devices/ayaneo-2.png){ .off-glb }
## Overview
| Device | CPU / Architecture | Kernel | GL driver | Interface |
| -- | -- | -- | -- | -- |
| AYANEO 2 | Amd Ryzen 7 6800U / (x86_64) | Mainline Linux | Radeonsi | Weston + EmulationStation |
## Features
| Feature&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | Notes |
| -- | -- |
| :material-harddisk: Storage | JELOS can be run from an SD Card, USB Drive or installed directly to the internal NVME. <br> When installed directly to the NVME; an SD Card can be used for game storage. |
| :material-lightning-bolt-circle: TPD Limit | Can be set globally, per system or per game. |
## Notes
| DMI_SYS_VENDOR | DMI_PRODUCT_NAME |
| -- | -- |
| `AYANEO ` | `AYANEO 2` |
### Booting from an SD Card
To boot JELOS from the SD Card, hold `LC` + `Volume Up` and press the power button, continue holding `LC` + `Volume Up` until the Ayaneo logo appears. Select the storage device with JELOS from the boot menu using the Ayaneo button, and then press volume up to boot the distribution.
## Additional References
- [Platform Documentation (AMD64)](https://github.com/JustEnoughLinuxOS/distribution/blob/main/documentation/PER_DEVICE_DOCUMENTATION/AMD64)
- [Device Quirks](https://github.com/JustEnoughLinuxOS/distribution/tree/main/packages/hardware/quirks/devices/AYANEO%20AIR) (*shares the same quirks as the [AYANEO Air](air.md)*)
- [Panel Rotation](https://github.com/JustEnoughLinuxOS/distribution/blob/main/packages/kernel/linux/patches/AMD64/002-display-quirks.patch)

42
docs/supported-devices/ayn/loki-max.md Normal file
View file

@ -0,0 +1,42 @@
# Loki Max
![](../../_inc/images/devices/ayn-loki.png){ .off-glb }
## Overview
| Device | CPU / Architecture | Kernel | GL driver | Interface |
| -- | -- | -- | -- | -- |
| Max | Amd Ryzen 7 6800U / (x86_64) | Mainline Linux | Radeonsi | Weston + EmulationStation |
## Features
| Feature&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | Notes |
| -- | -- |
| :material-harddisk: Storage | JELOS can be run from an SD Card, USB Drive or installed directly to the internal NVME. <br> When installed directly to the NVME; an SD Card can be used for game storage. |
| :material-fan: Fan | Can be set globally, per system or per game. |
| :material-lightning-bolt-circle: TPD Limit | Can be set globally, per system or per game. |
| :material-lightbulb-on: RGB | Supports selecting from a set of colors or turning the RGB off (choice persists through reboots) <br> Does not support changing brightness or turning on other effects. |
## Notes
| DMI_SYS_VENDOR | DMI_PRODUCT_NAME |
| -- | -- |
| `ayn` | `Loki Max` |
### Booting from an SD Card
In order to launch JELOS from an SD card or a USB drive you will need to first change the boot order in the BIOS.
During boot you can enter the bios by either (1) holding the left & right button that sit bellow the dpad and right analog stick OR (2) connecting an external keyboard and pressing the `del` key.
In the bios; navigate to the `Boot` menu and then change the boot order to prioritize the SD card or USB Drive under `Boot Order Priorities`. Then go `Save & Exit` and select the Save Changes and Exit option. This change will persist through all reboots. If you want to boot into Windows simply remove the SD Card or USB drive.
### Changing the RGB
In EmulationStation press the `Start` button to open the Main Menu. Then select `System Settings` and scroll until you see `Device LEDS`. Under that setting you can choose to turn RGB Off or select from a set of pre-defined colors. The value you set will persist through all future reboots but note your RGB setting will only take effect after JELOS boots.
## Additional References
- [Platform Documentation (AMD64)](https://github.com/JustEnoughLinuxOS/distribution/blob/main/documentation/PER_DEVICE_DOCUMENTATION/AMD64)
- [Device Quirks](https://github.com/JustEnoughLinuxOS/distribution/tree/main/packages/hardware/quirks/devices/ayn%20Loki%20Zero) (*shares the same quirks as the [Loki Zero](loki-zero.md)*)
- [Panel Rotation](https://github.com/JustEnoughLinuxOS/distribution/blob/main/packages/kernel/linux/patches/AMD64/002-display-quirks.patch)

42
docs/supported-devices/ayn/loki-zero.md Normal file
View file

@ -0,0 +1,42 @@
# Loki Zero
![](../../_inc/images/devices/ayn-loki.png){ .off-glb }
## Overview
| Device | CPU / Architecture | Kernel | GL driver | Interface |
| -- | -- | -- | -- | -- |
| Loki Zero | AMD Athlon Silver 3050e (x86_64) | Mainline Linux | Radeonsi | Weston + EmulationStation |
## Features
| Feature&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | Notes |
| -- | -- |
| :material-harddisk: Storage | JELOS can be run from an SD Card, USB Drive or installed directly to the internal NVME. <br> When installed directly to the NVME; an SD Card can be used for game storage. |
| :material-fan: Fan | Can be set globally, per system or per game. |
| :material-lightning-bolt-circle: TPD Limit | Can be set globally, per system or per game. |
| :material-lightbulb-on: RGB | Supports selecting from a set of colors or turning the RGB off (choice persists through reboots) <br> Does not support changing brightness or turning on other effects. |
## Notes
| DMI_SYS_VENDOR | DMI_PRODUCT_NAME |
| -- | -- |
| `ayn` | `Loki Zero` |
### Booting from an SD Card
In order to launch JELOS from an SD card or a USB drive you will need to first change the boot order in the BIOS.
During boot you can enter the bios by either (1) holding the left & right button that sit bellow the dpad and right analog stick OR (2) connecting an external keyboard and pressing the `del` key.
In the bios; navigate to the `Boot` menu and then change the boot order to prioritize the SD card or USB Drive under `Boot Order Priorities`. Then go `Save & Exit` and select the Save Changes and Exit option. This change will persist through all reboots. If you want to boot into Windows simply remove the SD Card or USB drive.
### Changing the RGB
In EmulationStation press the `Start` button to open the Main Menu. Then select `System Settings` and scroll until you see `Device LEDS`. Under that setting you can choose to turn RGB Off or select from a set of pre-defined colors. The value you set will persist through all future reboots but note your RGB setting will only take effect after JELOS boots.
## Additional References
- [Platform Documentation (AMD64)](https://github.com/JustEnoughLinuxOS/distribution/blob/main/documentation/PER_DEVICE_DOCUMENTATION/AMD64)
- [Device Quirks](https://github.com/JustEnoughLinuxOS/distribution/tree/main/packages/hardware/quirks/devices/ayn%20Loki%20Zero)
- [Panel Rotation](https://github.com/JustEnoughLinuxOS/distribution/blob/main/packages/kernel/linux/patches/AMD64/002-display-quirks.patch)

13
docs/supported-devices/gpd/win-max-2.md Normal file
View file

@ -0,0 +1,13 @@
# GPDWin Max 2
![](../../_inc/images/devices/gpdwin-max-2.png){ .off-glb }
## Overview
| Device | CPU / Architecture | Kernel | GL driver | Interface |
| -- | -- | -- | -- | -- |
| Win Max 2 | Amd Ryzen 7 6800U / (x86_64) | Mainline Linux | Radeonsi | Weston + EmulationStation |
## Additional References
- [Platform Documentation (AMD64)](https://github.com/JustEnoughLinuxOS/distribution/blob/main/documentation/PER_DEVICE_DOCUMENTATION/AMD64)

13
docs/supported-devices/gpd/win4.md Normal file
View file

@ -0,0 +1,13 @@
# GPDWin 4
![](../../_inc/images/devices/gpdwin-4.png){ .off-glb }
## Overview
| Device | CPU / Architecture | Kernel | GL driver | Interface |
| -- | -- | -- | -- | -- |
| Win 4 | Amd Ryzen 7 6800U / (x86_64) | Mainline Linux | Radeonsi | Weston + EmulationStation |
## Additional References
- [Platform Documentation (AMD64)](https://github.com/JustEnoughLinuxOS/distribution/blob/main/documentation/PER_DEVICE_DOCUMENTATION/AMD64)

11
docs/supported-devices/hardkernel/odroid-go-advance.md Normal file
View file

@ -0,0 +1,11 @@
# Odroid Go Advance
## Overview
| Device | CPU / Architecture | Kernel | GL driver | Interface |
| -- | -- | -- | -- | -- |
| Odroid Go Advance | Rockchip RK3326 (ARM) | Mainline Linux | Panfrost | Weston + EmulationStation |
## Additional References
- [Platform Documentation (RK3326)](https://github.com/JustEnoughLinuxOS/distribution/blob/main/documentation/PER_DEVICE_DOCUMENTATION/RK3326)

11
docs/supported-devices/hardkernel/odroid-go-super.md Normal file
View file

@ -0,0 +1,11 @@
# Odroid Go Super
## Overview
| Device | CPU / Architecture | Kernel | GL driver | Interface |
| -- | -- | -- | -- | -- |
| Odroid Go Super | Rockchip RK3326 (ARM) | Mainline Linux | Panfrost | Weston + EmulationStation |
## Additional References
- [Platform Documentation (RK3326)](https://github.com/JustEnoughLinuxOS/distribution/blob/main/documentation/PER_DEVICE_DOCUMENTATION/RK3326)

11
docs/supported-devices/hardkernel/odroid-go-ultra.md Normal file
View file

@ -0,0 +1,11 @@
# Odroid Go Ultra
## Overview
| Device | CPU / Architecture | Kernel | GL driver | Interface |
| -- | -- | -- | -- | -- |
| Odroid Go Ultra | Amlogic S922X / Mali G52 M6 (ARMv8-A) | Mainline Linux | Mali | Weston + EmulationStation |
## Additional References
- [Platform Documentation (S922X)](https://github.com/JustEnoughLinuxOS/distribution/blob/main/documentation/PER_DEVICE_DOCUMENTATION/S922X)

42
docs/supported-devices/index.md Normal file
View file

@ -0,0 +1,42 @@
<!---
icon: material/monitor
--->
# Supported Devices
JELOS supports a variety of ARM and Intel/AMD based devices<sup>1</sup>.
| Manufacturer | Device | CPU / Architecture | Kernel | GL driver | Interface |
|--|--|--|--|--|--|
|Anbernic| RG351P/M | Rockchip RK3326 (ARM) | Mainline Linux | Panfrost | Weston + EmulationStation|
|Anbernic| RG353P<sup>2</sup> | Rockchip RK3566 (ARM) | Rockchip BSP 4.19 | Mali | KMS/DRM + EmulationStation|
|Anbernic| RG353M<sup>2</sup> | Rockchip RK3566 (ARM) | Rockchip BSP 4.19 | Mali | KMS/DRM + EmulationStation|
|Anbernic| RG353V<sup>2</sup> | Rockchip RK3566 (ARM) | Rockchip BSP 4.19 | Mali | KMS/DRM + EmulationStation|
|Anbernic| RG353VS<sup>2</sup> | Rockchip RK3566 (ARM) | Rockchip BSP 4.19 | Mali | KMS/DRM + EmulationStation|
|Anbernic| RG503 | Rockchip RK3566 (ARM) | Rockchip BSP 4.19 | Mali | KMS/DRM + EmulationStation|
|Anbernic| RG552 | Rockchip RK3399 (ARM) | Mainline Linux | Panfrost | Weston + EmulationStation|
|Anbernic|Win600|AMD Athlon Silver 3050e (x86_64)|Mainline Linux|Radeonsi|Weston + EmulationStation|
|Atari|VCS|AMD Ryzen R1606G (x86_64)|Mainline Linux|Radeonsi|Weston + EmulationStation|
|AOKZOE | A1 Pro | AMD 7840u (x86_64)|Mainline Linux|Radeonsi|Weston + EmulationStation|
|AYANEO<sup>3</sup>|Air / Air Pro|Amd Ryzen 5 5560U / AMD Ryzen 7 5825U (x86_64)|Mainline Linux|Radeonsi|Weston + EmulationStation|
|AYANEO<sup>3</sup>|Air Plus|Amd Ryzen 7 6800U / (x86_64)|Mainline Linux|Radeonsi|Weston + EmulationStation|
|AYANEO<sup>3</sup>|AYANEO 2|Amd Ryzen 7 6800U / (x86_64)|Mainline Linux|Radeonsi|Weston + EmulationStation|
|Ayn|Loki Zero|AMD Athlon Silver 3050e (x86_64)|Mainline Linux|Radeonsi|Weston + EmulationStation|
|Ayn|Max|Amd Ryzen 7 6800U / (x86_64)|Mainline Linux|Radeonsi|Weston + EmulationStation|
|GPD|Win 4|Amd Ryzen 7 6800U / (x86_64)|Mainline Linux|Radeonsi|Weston + EmulationStation|
|GPD|Win Max 2 (2022)|Amd Ryzen 7 6800U / (x86_64)|Mainline Linux|Radeonsi|Weston + EmulationStation|
|Hardkernel| Odroid Go Advance | Rockchip RK3326 (ARM) | Mainline Linux | Panfrost | Weston + EmulationStation|
|Hardkernel| Odroid Go Super | Rockchip RK3326 (ARM) | Mainline Linux | Panfrost | Weston + EmulationStation|
|Hardkernel|Odroid Go Ultra|Amlogic S922X / Mali G52 M6 (ARMv8-A)|Mainline Linux|Mali|Weston + EmulationStation|
|Indiedroid|Nova|Rockchip RK3588S / Mali G610 (ARMv8-A)|Rockchip 5.10 BSP Linux|Panfrost|Weston + EmulationStation|
|Orange Pi|Orange Pi 5|Rockchip RK3588S / Mali G610 (ARMv8-A)|Rockchip 5.10 BSP Linux|Panfrost|Weston + EmulationStation|
|Powkiddy|RGB10 Max 3 Pro|Amlogic A311D / Mali G52 M4 (ARMv8-A)|Mainline Linux|Mali|Weston + EmulationStation|
|Powkiddy| RGB30 | Rockchip RK3566 (ARM) | Rockchip BSP 4.19 | Mali | KMS/DRM + EmulationStation |
|Powkiddy| RK2023 | Rockchip RK3566 (ARM) | Rockchip BSP 4.19 | Mali | KMS/DRM + EmulationStation |
|Powkiddy| x55 | Rockchip RK3566 (ARM) | Rockchip BSP 4.19 | Mali | KMS/DRM + EmulationStation |
> <sup>1</sup> While not technically supported, JELOS is known to work well on a variety of generic x86_64 devices including gaming PCs, mini PCs, and laptop computers.
> <sup>2</sup> Anbernic RG353P/M/V/VS devices with both v1 and v2 displays are supported. RG353PS will not be supported.
> <sup>3</sup> To boot JELOS on Ayaneo devices, hold LC and volume up and press the power button, continue holding "LC" and volume up until the Ayaneo logo appears. Select the storage device with JELOS from the boot menu using the Ayaneo button, and then press volume up to boot the distribution.

13
docs/supported-devices/indiedroid/nova.md Normal file
View file

@ -0,0 +1,13 @@
# Indiedroid Nova
![](../../_inc/images/devices/indiedroid-nova.png){ .off-glb }
## Overview
| Device | CPU / Architecture | Kernel | GL driver | Interface |
| -- | -- | -- | -- | -- |
| Nova | Rockchip RK3588S / Mali G610 (ARMv8-A) | Rockchip 5.10 BSP Linux | Panfrost | Weston + EmulationStation |
## Additional References
- [Platform Documentation (RK3588)](https://github.com/JustEnoughLinuxOS/distribution/blob/main/documentation/PER_DEVICE_DOCUMENTATION/RK3588)

14
docs/supported-devices/orange-pi/orange-pi-5.md Normal file
View file

@ -0,0 +1,14 @@
# Orange Pi 5
![](../../_inc/images/devices/orange-pi-5.png){ .off-glb }
## Overview
| Device | CPU / Architecture | Kernel | GL driver | Interface |
| -- | -- | -- | -- | -- |
| Orange Pi 5 | Rockchip RK3588S / Mali G610 (ARMv8-A) | Rockchip 5.10 BSP Linux | Panfrost | Weston + EmulationStation |
## Additional References
- [Platform Documentation (RK3588)](https://github.com/JustEnoughLinuxOS/distribution/blob/main/documentation/PER_DEVICE_DOCUMENTATION/RK3588)

9
docs/supported-devices/powkiddy/rgb10-max-3-pro.md Normal file
View file

@ -0,0 +1,9 @@
# Powkiddy RGB10 Max 3 Pro
![](../../_inc/images/devices/powkiddy-rgb10max3pro.png){ .off-glb }
## Overview
| Device | CPU / Architecture | Kernel | GL driver | Interface |
| -- | -- | -- | -- | -- |
| RGB10 Max 3 Pro | Amlogic A311D / Mali G52 M4 (ARMv8-A) | Mainline Linux | Mali | Weston + EmulationStation |

13
docs/supported-devices/powkiddy/rgb30.md Normal file
View file

@ -0,0 +1,13 @@
# Powkiddy RGB30
![](../../_inc/images/devices/powkiddy-rgb30.png){ .off-glb }
## Overview
| Device | CPU / Architecture | Kernel | GL driver | Interface |
| -- | -- | -- | -- | -- |
| RGB30 | Rockchip RK3566 (ARM) | Rockchip BSP 4.19 | Mali | KMS/DRM + EmulationStation |
## Additional References
- [Platform Documentation (RK3566)](https://github.com/JustEnoughLinuxOS/distribution/blob/main/documentation/PER_DEVICE_DOCUMENTATION/RK3566)

13
docs/supported-devices/powkiddy/rk2023.md Normal file
View file

@ -0,0 +1,13 @@
# Powkiddy RK2023
![](../../_inc/images/devices/powkiddy-rk2023.png){ .off-glb }
## Overview
| Device | CPU / Architecture | Kernel | GL driver | Interface |
| -- | -- | -- | -- | -- |
| RK2023 | Rockchip RK3566 (ARM) | Rockchip BSP 4.19 | Mali | KMS/DRM + EmulationStation |
## Additional References
- [Platform Documentation (RK3566)](https://github.com/JustEnoughLinuxOS/distribution/blob/main/documentation/PER_DEVICE_DOCUMENTATION/RK3566)

13
docs/supported-devices/powkiddy/x55.md Normal file
View file

@ -0,0 +1,13 @@
# Powkiddy x55
![](../../_inc/images/devices/powkiddy-x55.png){ .off-glb }
## Overview
| Device | CPU / Architecture | Kernel | GL driver | Interface |
| -- | -- | -- | -- | -- |
| x55 | Rockchip RK3566 (ARM) | Rockchip BSP 4.19 | Mali | KMS/DRM + EmulationStation |
## Additional References
- [Platform Documentation (RK3566)](https://github.com/JustEnoughLinuxOS/distribution/blob/main/documentation/PER_DEVICE_DOCUMENTATION/RK3566)

0
docs/systems/3do.md Normal file
View file

0
docs/systems/3ds.md Normal file
View file

0
docs/systems/amiga.md Normal file
View file

0
docs/systems/amigacd32.md Normal file
View file

0
docs/systems/amstradcpc.md Normal file
View file

1
docs/systems/arcade/index.md Normal file
View file

@ -0,0 +1 @@
# Arcade

0
docs/systems/arduboy.md Normal file
View file

0
docs/systems/atari2600.md Normal file
View file

0
docs/systems/atari5200.md Normal file
View file

0
docs/systems/atari7800.md Normal file
View file

0
docs/systems/atari800.md Normal file
View file

0
docs/systems/atarijaguar.md Normal file
View file

0
docs/systems/atarilynx.md Normal file
View file

0
docs/systems/atarist.md Normal file
View file

0
docs/systems/atomiswave.md Normal file
View file

0
docs/systems/c128.md Normal file
View file

0
docs/systems/c16.md Normal file
View file

0
docs/systems/c64.md Normal file
View file

0
docs/systems/channelf.md Normal file
View file

0
docs/systems/colecovision.md Normal file
View file

0
docs/systems/cps1.md Normal file
View file

0
docs/systems/cps2.md Normal file
View file

0
docs/systems/cps3.md Normal file
View file

0
docs/systems/daphne.md Normal file
View file

0
docs/systems/doom.md Normal file
View file

0
docs/systems/dreamcast.md Normal file
View file

0
docs/systems/easyrpg.md Normal file
View file

0
docs/systems/famicom.md Normal file
View file

0
docs/systems/fbn.md Normal file
View file

37
docs/systems/fds.md Normal file
View file

@ -0,0 +1,37 @@
<?xml version="1.0" encoding="utf-8"?>
<svg version="1.2" id="Layer_2" x="0px" y="0px" viewBox="0 0 264 47" xmlns="http://www.w3.org/2000/svg">
<g transform="matrix(0.44, 0, 0, 0.440636, 0, 0)">
<path d="M 170.924 37.234 C 172.682 38.449 173.999 39.769 174.878 41.185 C 175.823 42.877 176.399 44.767 176.6 46.862 L 176.6 93.588 C 176.6 96.427 176.078 98.641 175.031 100.228 C 173.984 101.815 172.817 103.081 171.533 104.029 C 170.048 105.109 168.356 105.853 166.465 106.259 L 134.941 106.259 L 134.941 35.202 L 163.423 35.202 C 166.669 35.34 169.169 36.016 170.924 37.234 Z M 173.156 46.658 C 172.952 45.172 172.514 43.822 171.839 42.604 C 171.296 41.593 170.453 40.663 169.304 39.817 C 168.155 38.971 166.597 38.617 164.641 38.752 L 138.185 38.854 L 138.185 103.015 L 165.046 103.015 C 166.465 102.745 167.75 102.274 168.899 101.596 C 169.844 101.056 170.756 100.246 171.635 99.163 C 172.511 98.083 173.021 96.598 173.156 94.704 L 173.156 46.658 Z M 158.254 50.765 C 158.863 51.338 159.334 51.965 159.673 52.64 C 160.012 53.384 160.213 54.227 160.282 55.172 L 160.282 84.569 C 160.348 86.259 160.198 87.561 159.826 88.47 C 159.454 89.385 158.998 90.042 158.458 90.447 C 157.849 90.987 157.174 91.29 156.429 91.359 L 150.348 91.359 L 150.147 49.7 L 155.619 49.7 C 156.769 49.835 157.648 50.189 158.254 50.765 Z M 157.039 55.172 C 156.904 54.632 156.7 54.194 156.432 53.855 C 155.823 53.114 154.776 52.91 153.288 53.246 L 153.288 88.116 C 153.894 88.317 154.47 88.386 155.01 88.317 C 155.484 88.251 155.907 88.05 156.276 87.711 C 156.652 87.375 156.904 86.73 157.039 85.784 L 157.039 55.172 Z" id="path7" style="fill-opacity: 1; fill: rgb(255, 255, 255);"/>
<path d="M 200.726 35.509 L 200.726 106.057 L 181.062 106.057 L 181.062 35.509 L 200.726 35.509 Z M 197.279 39.565 L 184.305 39.565 L 184.305 102.205 L 197.279 102.205 L 197.279 39.565 Z" id="path9" style="fill-opacity: 1; fill: rgb(255, 255, 255);"/>
<path d="M 226.573 58.62 L 226.573 55.68 C 226.639 54.329 226.336 53.519 225.661 53.246 C 225.391 53.114 225.019 53.114 224.548 53.246 C 224.005 53.246 223.618 53.366 223.381 53.603 C 223.144 53.84 222.991 54.125 222.925 54.464 C 222.787 54.8 222.787 55.205 222.925 55.68 L 222.925 59.532 L 238.533 69.67 C 240.492 70.75 241.995 71.899 243.045 73.114 C 244.092 74.332 244.818 75.481 245.223 76.562 C 245.697 77.78 245.934 79.061 245.934 80.414 L 245.934 95.919 C 245.799 98.152 245.223 99.961 244.209 101.344 C 243.198 102.73 242.049 103.795 240.765 104.536 C 239.277 105.415 237.62 106.057 235.796 106.463 L 215.322 106.463 C 212.754 106.397 210.744 105.754 209.292 104.536 C 207.84 103.324 206.774 102.037 206.099 100.687 C 205.286 99.064 204.782 97.24 204.578 95.211 L 204.578 72.1 L 223.027 83.354 L 223.027 87.306 C 223.027 87.915 223.108 88.371 223.279 88.674 C 223.447 88.977 223.666 89.199 223.936 89.334 C 224.206 89.535 224.545 89.637 224.95 89.637 C 225.964 89.568 226.54 89.163 226.675 88.419 C 226.741 88.152 226.708 87.78 226.573 87.306 L 226.573 82.643 L 213.093 74.536 C 210.726 73.252 208.953 71.881 207.771 70.429 C 206.588 68.977 205.724 67.675 205.187 66.526 C 204.578 65.175 204.275 63.822 204.275 62.472 L 204.275 45.851 C 204.407 43.282 205.016 41.29 206.099 39.871 C 207.18 38.452 208.398 37.405 209.748 36.727 C 211.302 35.986 213.024 35.545 214.917 35.41 L 233.06 35.41 C 236.168 35.545 238.569 36.121 240.258 37.135 C 241.947 38.146 243.231 39.295 244.11 40.579 C 245.055 42.067 245.664 43.723 245.934 45.548 L 245.934 71.392 L 226.573 58.62 Z M 224.95 49.802 C 226.03 49.937 226.861 50.189 227.435 50.564 C 228.011 50.936 228.467 51.356 228.803 51.83 C 229.142 52.37 229.379 52.979 229.514 53.654 L 229.514 56.592 L 242.691 64.497 L 242.487 47.168 C 242.553 45.409 242.166 43.975 241.32 42.859 C 240.477 41.743 239.547 40.882 238.533 40.276 C 237.317 39.532 235.931 39.058 234.377 38.854 L 214.713 38.854 C 213.159 38.992 211.941 39.415 211.065 40.123 C 210.186 40.831 209.511 41.557 209.037 42.301 C 208.497 43.249 208.125 44.263 207.921 45.343 L 207.921 61.764 C 207.855 63.114 208.125 64.296 208.734 65.31 C 209.34 66.325 210.018 67.201 210.759 67.945 C 211.572 68.824 212.55 69.601 213.699 70.276 L 230.324 81.02 L 230.324 87.609 C 230.324 88.893 230.051 89.892 229.511 90.6 C 228.971 91.311 228.362 91.833 227.687 92.169 C 226.942 92.577 226.066 92.847 225.052 92.982 C 223.768 92.847 222.787 92.562 222.112 92.121 C 221.437 91.683 220.93 91.194 220.591 90.651 C 220.186 90.045 219.916 89.334 219.781 88.521 L 219.781 85.28 L 207.921 78.185 L 207.72 94.806 C 207.786 96.766 208.209 98.269 208.986 99.319 C 209.763 100.366 210.624 101.158 211.569 101.701 C 212.649 102.307 213.9 102.679 215.319 102.814 L 235.085 102.814 C 237.044 102.748 238.515 102.307 239.496 101.497 C 240.474 100.687 241.2 99.808 241.674 98.863 C 242.214 97.714 242.487 96.43 242.487 95.01 L 242.487 79.907 C 242.553 79.094 242.352 78.284 241.878 77.471 C 241.404 76.661 240.864 75.953 240.258 75.343 C 239.514 74.599 238.701 73.891 237.825 73.213 L 219.781 61.557 L 219.781 54.056 C 219.847 52.907 220.168 52.064 220.744 51.524 C 221.317 50.984 221.911 50.576 222.517 50.306 C 223.264 50.039 224.074 49.871 224.95 49.802 Z" id="path11" style="fill-opacity: 1; fill: rgb(255, 255, 255);"/>
<path d="M 289.418 62.067 L 282.121 70.477 L 289.418 79.397 L 289.418 106.057 L 270.666 106.057 L 270.666 86.394 L 268.032 83.96 L 268.032 106.259 L 249.076 106.259 L 249.076 35.41 L 268.032 35.41 L 268.032 57.708 L 270.666 54.563 L 270.666 35.41 L 289.418 35.41 L 289.418 62.067 Z M 286.174 39.463 L 274.416 39.463 L 274.314 56.391 L 264.785 66.121 L 264.38 39.058 L 252.52 39.058 L 252.52 102.103 L 264.278 102.103 L 264.278 75.95 L 273.504 84.668 L 273.504 102.202 L 285.97 102.202 L 285.97 79.802 L 277.962 70.477 L 286.174 60.951 L 286.174 39.463 Z" id="path13" style="fill-opacity: 1; fill: rgb(255, 255, 255);"/>
<path d="M 344.458 58.62 L 344.458 55.68 C 344.524 54.329 344.221 53.519 343.546 53.246 C 343.276 53.114 342.904 53.114 342.43 53.246 C 341.887 53.246 341.5 53.366 341.263 53.603 C 341.026 53.84 340.876 54.125 340.807 54.464 C 340.672 54.8 340.672 55.205 340.807 55.68 L 340.807 59.532 L 356.417 69.67 C 358.376 70.75 359.88 71.899 360.93 73.114 C 361.977 74.332 362.703 75.481 363.108 76.562 C 363.579 77.78 363.819 79.061 363.819 80.414 L 363.819 95.919 C 363.681 98.152 363.108 99.961 362.094 101.344 C 361.08 102.73 359.931 103.795 358.646 104.536 C 357.161 105.415 355.505 106.057 353.681 106.463 L 333.207 106.463 C 330.639 106.397 328.629 105.754 327.173 104.536 C 325.721 103.324 324.659 102.037 323.981 100.687 C 323.171 99.064 322.664 97.24 322.46 95.211 L 322.46 72.1 L 340.909 83.354 L 340.909 87.306 C 340.909 87.915 340.993 88.371 341.164 88.674 C 341.329 88.977 341.551 89.199 341.821 89.334 C 342.091 89.535 342.43 89.637 342.835 89.637 C 343.849 89.568 344.422 89.163 344.557 88.419 C 344.626 88.152 344.59 87.78 344.455 87.306 L 344.455 82.643 L 330.975 74.536 C 328.611 73.252 326.834 71.881 325.652 70.429 C 324.473 68.977 323.609 67.675 323.069 66.526 C 322.463 65.175 322.157 63.822 322.157 62.472 L 322.157 45.851 C 322.292 43.282 322.901 41.29 323.984 39.871 C 325.064 38.452 326.282 37.405 327.632 36.727 C 329.187 35.986 330.909 35.545 332.802 35.41 L 350.945 35.41 C 354.053 35.545 356.45 36.121 358.142 37.135 C 359.832 38.146 361.116 39.295 361.995 40.579 C 362.94 42.067 363.549 43.723 363.819 45.548 L 363.819 71.392 L 344.458 58.62 Z M 342.835 49.802 C 343.915 49.937 344.746 50.189 345.319 50.564 C 345.892 50.936 346.351 51.356 346.687 51.83 C 347.026 52.37 347.26 52.979 347.398 53.654 L 347.398 56.592 L 360.573 64.497 L 360.372 47.168 C 360.438 45.409 360.051 43.975 359.208 42.859 C 358.361 41.743 357.431 40.882 356.417 40.276 C 355.202 39.532 353.816 39.058 352.262 38.854 L 332.598 38.854 C 331.044 38.992 329.826 39.415 328.947 40.123 C 328.07 40.831 327.392 41.557 326.921 42.301 C 326.378 43.249 326.009 44.263 325.808 45.343 L 325.808 61.764 C 325.739 63.114 326.009 64.296 326.618 65.31 C 327.224 66.325 327.899 67.201 328.644 67.945 C 329.457 68.824 330.435 69.601 331.584 70.276 L 348.208 81.02 L 348.208 87.609 C 348.208 88.893 347.935 89.892 347.395 90.6 C 346.855 91.311 346.249 91.833 345.571 92.169 C 344.827 92.577 343.951 92.847 342.937 92.982 C 341.653 92.847 340.672 92.562 339.997 92.121 C 339.322 91.683 338.815 91.194 338.475 90.651 C 338.07 90.045 337.797 89.334 337.665 88.521 L 337.665 85.28 L 325.805 78.185 L 325.604 94.806 C 325.67 96.766 326.093 98.269 326.87 99.319 C 327.647 100.366 328.508 101.158 329.454 101.701 C 330.534 102.307 331.785 102.679 333.204 102.814 L 352.97 102.814 C 354.929 102.748 356.399 102.307 357.38 101.497 C 358.358 100.687 359.085 99.808 359.559 98.863 C 360.102 97.714 360.372 96.43 360.372 95.01 L 360.372 79.907 C 360.438 79.094 360.234 78.284 359.763 77.471 C 359.289 76.661 358.749 75.953 358.142 75.343 C 357.398 74.599 356.585 73.891 355.709 73.213 L 337.665 61.557 L 337.665 54.056 C 337.731 52.907 338.052 52.064 338.629 51.524 C 339.202 50.984 339.793 50.576 340.402 50.306 C 341.146 50.039 341.956 49.871 342.835 49.802 Z" id="path15" style="fill-opacity: 1; fill: rgb(255, 255, 255);"/>
<path d="M 409.531 35.611 L 409.531 95.82 C 409.462 98.185 408.973 100.06 408.061 101.446 C 407.149 102.832 406.12 103.894 404.971 104.638 C 403.684 105.451 402.199 106.024 400.51 106.361 L 370.609 106.361 L 370.609 89.13 L 389.664 89.13 L 389.664 85.784 L 376.69 85.784 C 374.191 85.652 372.298 85.043 371.014 83.96 C 369.73 82.88 368.818 81.662 368.277 80.312 C 367.599 78.758 367.263 77.036 367.263 75.142 L 367.263 35.611 L 386.726 35.611 L 386.726 67.945 L 390.072 67.945 L 390.072 35.611 L 409.531 35.611 Z M 406.186 39.361 L 393.924 39.361 L 393.924 67.036 C 393.855 67.912 393.618 68.689 393.213 69.364 C 392.874 69.973 392.352 70.513 391.641 70.987 C 390.93 71.461 389.901 71.731 388.55 71.797 C 387.536 71.866 386.657 71.764 385.913 71.494 C 385.238 71.224 384.632 70.75 384.089 70.075 C 383.549 69.397 383.243 68.317 383.18 66.832 L 383.18 39.364 L 371.32 39.364 L 371.32 75.346 C 371.386 76.697 371.692 77.915 372.232 78.995 C 372.703 79.94 373.429 80.801 374.41 81.578 C 375.388 82.355 376.825 82.745 378.718 82.745 L 393.822 82.745 L 393.822 88.014 C 393.684 88.893 393.381 89.67 392.907 90.345 C 392.502 90.888 391.893 91.392 391.083 91.866 C 390.27 92.34 389.189 92.577 387.839 92.577 L 374.257 92.577 L 374.257 102.61 L 400.105 102.61 C 401.254 102.475 402.268 102.139 403.147 101.599 C 403.888 101.125 404.581 100.417 405.223 99.469 C 405.865 98.524 406.186 97.24 406.186 95.616 L 406.186 39.361 Z" id="path17" style="fill-opacity: 1; fill: rgb(255, 255, 255);"/>
<path d="M 435.277 58.62 L 435.277 55.68 C 435.346 54.329 435.04 53.519 434.365 53.246 C 434.095 53.114 433.723 53.114 433.252 53.246 C 432.709 53.246 432.322 53.366 432.085 53.603 C 431.848 53.84 431.695 54.125 431.629 54.464 C 431.494 54.8 431.494 55.205 431.629 55.68 L 431.629 59.532 L 447.236 69.67 C 449.195 70.75 450.699 71.899 451.749 73.114 C 452.796 74.332 453.522 75.481 453.93 76.562 C 454.401 77.78 454.638 79.061 454.638 80.414 L 454.638 95.919 C 454.503 98.152 453.93 99.961 452.913 101.344 C 451.902 102.73 450.753 103.795 449.468 104.536 C 447.983 105.415 446.327 106.057 444.503 106.463 L 424.026 106.463 C 421.458 106.397 419.448 105.754 417.995 104.536 C 416.543 103.324 415.478 102.037 414.803 100.687 C 413.993 99.064 413.486 97.24 413.282 95.211 L 413.282 72.1 L 431.731 83.354 L 431.731 87.306 C 431.731 87.915 431.812 88.371 431.983 88.674 C 432.151 88.977 432.37 89.199 432.64 89.334 C 432.913 89.535 433.249 89.637 433.657 89.637 C 434.668 89.568 435.241 89.163 435.379 88.419 C 435.445 88.152 435.412 87.78 435.277 87.306 L 435.277 82.643 L 421.797 74.536 C 419.43 73.252 417.656 71.881 416.474 70.429 C 415.292 68.977 414.428 67.675 413.891 66.526 C 413.282 65.175 412.979 63.822 412.979 62.472 L 412.979 45.851 C 413.111 43.282 413.723 41.29 414.803 39.871 C 415.883 38.452 417.101 37.405 418.451 36.727 C 420.006 35.986 421.728 35.545 423.621 35.41 L 441.764 35.41 C 444.872 35.545 447.272 36.121 448.961 37.135 C 450.651 38.146 451.935 39.295 452.814 40.579 C 453.759 42.067 454.368 43.723 454.638 45.548 L 454.638 71.392 L 435.277 58.62 Z M 433.657 49.802 C 434.737 49.937 435.565 50.189 436.141 50.564 C 436.714 50.936 437.17 51.356 437.509 51.83 C 437.845 52.37 438.082 52.979 438.217 53.654 L 438.217 56.592 L 451.395 64.497 L 451.191 47.168 C 451.26 45.409 450.87 43.975 450.027 42.859 C 449.18 41.743 448.253 40.882 447.239 40.276 C 446.021 39.532 444.638 39.058 443.084 38.854 L 423.417 38.854 C 421.863 38.992 420.648 39.415 419.769 40.123 C 418.892 40.831 418.214 41.557 417.743 42.301 C 417.2 43.249 416.828 44.263 416.627 45.343 L 416.627 61.764 C 416.558 63.114 416.828 64.296 417.44 65.31 C 418.046 66.325 418.721 67.201 419.465 67.945 C 420.276 68.824 421.257 69.601 422.406 70.276 L 439.027 81.02 L 439.027 87.609 C 439.027 88.893 438.757 89.892 438.217 90.6 C 437.674 91.311 437.068 91.833 436.39 92.169 C 435.649 92.577 434.77 92.847 433.756 92.982 C 432.472 92.847 431.494 92.562 430.819 92.121 C 430.141 91.683 429.637 91.194 429.297 90.651 C 428.889 90.045 428.619 89.334 428.484 88.521 L 428.484 85.28 L 416.624 78.185 L 416.423 94.806 C 416.492 96.766 416.912 98.269 417.689 99.319 C 418.466 100.366 419.327 101.158 420.276 101.701 C 421.356 102.307 422.604 102.679 424.026 102.814 L 443.792 102.814 C 445.751 102.748 447.221 102.307 448.199 101.497 C 449.18 100.687 449.906 99.808 450.381 98.863 C 450.921 97.714 451.191 96.43 451.191 95.01 L 451.191 79.907 C 451.26 79.094 451.056 78.284 450.585 77.471 C 450.111 76.661 449.567 75.953 448.961 75.343 C 448.217 74.599 447.407 73.891 446.528 73.213 L 428.487 61.557 L 428.487 54.056 C 428.553 52.907 428.874 52.064 429.451 51.524 C 430.024 50.984 430.615 50.576 431.224 50.306 C 431.965 50.039 432.778 49.871 433.657 49.802 Z" id="path19" style="fill-opacity: 1; fill: rgb(255, 255, 255);"/>
<path d="M 495.184 35.815 L 495.184 54.26 L 486.465 54.26 L 486.465 106.259 L 465.991 106.259 L 465.991 54.26 L 457.677 54.26 L 457.677 35.41 L 495.184 35.815 Z M 491.23 39.463 L 461.329 39.463 L 461.329 50.207 L 469.843 50.207 L 469.843 102.61 L 482.208 102.61 L 482.208 50.51 L 491.23 50.51 L 491.23 39.463 Z" id="path21" style="fill-opacity: 1; fill: rgb(255, 255, 255);"/>
<path d="M 518.295 54.059 L 518.295 62.268 L 531.269 62.268 L 531.269 80.717 L 517.89 80.717 L 517.89 88.521 L 531.269 88.521 L 531.269 106.565 L 498.325 106.361 L 498.325 35.41 L 531.674 35.41 L 531.674 54.059 L 518.295 54.059 Z M 514.341 66.019 L 514.341 50.309 L 527.719 50.309 L 527.719 39.565 L 502.076 39.565 L 502.076 103.624 L 527.719 103.624 L 527.719 92.373 L 514.137 92.373 L 514.137 76.967 L 527.92 76.967 L 527.92 66.019 L 514.341 66.019 Z" id="path23" style="fill-opacity: 1; fill: rgb(255, 255, 255);"/>
<path d="M 596.24 37.993 C 597.59 39.109 598.538 40.273 599.078 41.491 C 599.756 42.91 600.059 44.464 599.99 46.154 L 599.99 106.664 L 580.731 106.664 L 580.731 55.782 C 580.662 55.04 580.395 54.566 579.921 54.362 C 579.648 54.296 579.378 54.26 579.108 54.26 C 578.703 54.26 578.382 54.362 578.145 54.566 C 577.908 54.767 577.725 54.971 577.59 55.172 C 577.386 55.442 577.284 55.716 577.284 55.986 L 577.284 106.463 L 558.229 106.463 L 558.229 56.085 C 558.229 55.343 557.959 54.767 557.419 54.362 C 557.149 54.161 556.879 54.026 556.606 53.957 C 556.135 53.957 555.763 54.059 555.49 54.26 C 555.22 54.464 555.019 54.701 554.884 54.971 C 554.683 55.241 554.581 55.577 554.581 55.983 L 554.581 106.157 L 536.132 106.157 L 536.132 35.509 L 559.75 35.509 C 561.236 35.374 562.538 35.491 563.651 35.863 C 564.767 36.235 565.73 36.691 566.54 37.231 C 567.419 37.84 568.229 38.551 568.973 39.361 C 569.378 38.617 569.885 38.026 570.494 37.588 C 571.101 37.147 571.71 36.793 572.319 36.523 C 572.997 36.253 573.705 36.016 574.449 35.812 L 590.362 35.812 C 592.928 36.151 594.89 36.88 596.24 37.993 Z M 596.444 45.647 C 596.375 44.497 596.105 43.483 595.634 42.604 C 595.226 41.86 594.533 41.17 593.555 40.525 C 592.574 39.886 591.206 39.565 589.447 39.565 L 575.562 39.565 C 574.482 39.631 573.468 39.901 572.523 40.375 C 571.71 40.78 570.881 41.389 570.038 42.199 C 569.192 43.012 568.532 44.092 568.061 45.442 C 567.518 44.161 566.879 43.045 566.135 42.097 C 565.391 41.287 564.479 40.543 563.399 39.868 C 562.316 39.193 560.896 38.89 559.141 38.959 L 540.188 39.16 L 540.188 102.61 L 551.44 102.61 L 551.44 55.58 C 551.371 54.632 551.539 53.789 551.944 53.045 C 552.283 52.367 552.841 51.761 553.618 51.221 C 554.395 50.678 555.562 50.408 557.116 50.408 C 557.926 50.408 558.703 50.612 559.447 51.017 C 559.987 51.353 560.512 51.944 561.016 52.79 C 561.524 53.636 561.779 54.869 561.779 56.49 L 561.779 102.61 L 573.741 102.61 L 573.741 55.577 C 573.741 54.767 573.942 53.99 574.347 53.246 C 574.683 52.637 575.226 52.079 575.97 51.575 C 576.711 51.068 577.827 50.813 579.315 50.813 C 580.125 50.747 580.902 50.846 581.644 51.116 C 582.253 51.389 582.811 51.86 583.315 52.538 C 583.822 53.213 584.077 54.293 584.077 55.779 L 584.077 102.607 L 596.444 102.607 L 596.444 45.647 Z" id="path25" style="fill-opacity: 1; fill: rgb(255, 255, 255);"/>
<polygon points="135.151 0 147.564 0 147.564 4.326 139.499 4.326 139.499 9.574 147.564 9.574 147.564 14.038 139.499 14.038 139.499 23.366 135.151 23.366" id="polygon27" style="fill-opacity: 1; fill: rgb(255, 255, 255);"/>
<path d="M 161.68 23.366 L 157.45 23.366 L 157.45 19.727 L 149.259 19.727 L 146.832 23.366 L 141.854 23.366 L 158.236 0 L 161.68 0 L 161.68 23.366 Z M 157.45 15.314 L 157.45 8.494 L 152.448 15.314 L 157.45 15.314 Z" id="path29" style="fill-opacity: 1; fill: rgb(255, 255, 255);"/>
<polygon points="163.336 0 168.242 0 175.157 15.707 182.121 0 187.075 0 187.075 23.366 182.709 23.366 182.709 11.584 177.315 23.366 172.901 23.366 167.702 11.584 167.702 23.366 163.336 23.366" id="polygon31" style="fill-opacity: 1; fill: rgb(255, 255, 255);"/>
<polygon points="268.467 0 273.372 0 280.288 15.707 287.251 0 292.208 0 292.208 23.366 287.842 23.366 287.842 11.584 282.445 23.366 278.031 23.366 272.832 11.584 272.832 23.366 268.467 23.366" id="polygon33" style="fill-opacity: 1; fill: rgb(255, 255, 255);"/>
<rect x="188.452" width="4.518" height="23.366" id="rect35" style="fill-opacity: 1; fill: rgb(255, 255, 255);"/>
<polygon points="194.212 0 198.731 0 198.731 19.106 204.617 19.106 204.617 23.366 194.212 23.366" id="polygon37" style="fill-opacity: 1; fill: rgb(255, 255, 255);"/>
<polygon points="199.598 0 204.617 0 209.364 9.574 213.972 0 218.947 0 211.464 14.86 211.464 23.366 207.083 23.366 207.083 14.86" id="polygon39" style="fill-opacity: 1; fill: rgb(255, 255, 255);"/>
<path stroke="#231F20" stroke-width="0.3451" d="M 243.567 17.333" id="path41" style="fill-opacity: 1; fill: rgb(255, 255, 255);"/>
<path d="M 243.504 6.445 C 241.518 2.664 237.558 0.084 232.991 0.084 C 226.438 0.084 221.125 5.398 221.125 11.95 C 221.125 18.503 226.435 23.813 232.991 23.813 C 237.588 23.813 241.575 21.2 243.546 17.375 L 238.17 17.42 C 236.843 18.641 235.073 19.388 233.126 19.388 C 229.019 19.388 225.688 16.058 225.688 11.95 C 225.688 7.84 229.019 4.509 233.126 4.509 C 235.046 4.509 236.792 5.236 238.113 6.43 L 243.504 6.445 Z" id="path43" style="fill-opacity: 1; fill: rgb(255, 255, 255);"/>
<path d="M 255.244 23.876 C 248.656 23.876 243.318 18.536 243.318 11.95 C 243.318 5.365 248.659 0.024 255.244 0.024 C 261.833 0.024 267.17 5.365 267.17 11.95 C 267.173 18.539 261.833 23.876 255.244 23.876 Z M 262.838 11.95 C 262.838 7.783 259.457 4.404 255.289 4.404 C 251.122 4.404 247.743 7.783 247.743 11.95 C 247.743 16.118 251.122 19.496 255.289 19.496 C 259.457 19.496 262.838 16.118 262.838 11.95 Z" id="path45" style="fill-opacity: 1; fill: rgb(255, 255, 255);"/>
<path d="M 301.512 0.003 C 305.466 0.321 308.575 3.63 308.575 7.666 C 308.575 11.701 305.466 15.01 301.512 15.329 L 298.095 15.314 L 298.095 23.366 L 293.714 23.366 L 293.714 0 L 298.095 0 L 301.512 0.003 Z M 298.098 4.497 L 298.098 10.834 L 301.512 10.831 C 303.006 10.552 304.137 9.241 304.137 7.666 C 304.137 6.091 303.006 4.779 301.512 4.5 L 298.098 4.497 Z" id="path47" style="fill-opacity: 1; fill: rgb(255, 255, 255);"/>
<path d="M 356.708 23.669 L 352.37 23.669 L 352.37 0.201 L 358.394 0.192 L 361.809 0.195 C 365.763 0.513 368.874 3.822 368.874 7.858 C 368.874 11.155 366.798 13.966 363.882 15.058 L 368.938 23.666 L 364.191 23.666 L 357.107 11.563 L 356.708 11.563 L 356.708 23.669 Z M 354.014 23.558 M 358.397 23.558 M 361.812 11.023 C 363.306 10.744 364.437 9.433 364.437 7.858 C 364.437 6.283 363.306 4.971 361.812 4.692 L 356.708 4.692 L 356.708 11.029 L 361.812 11.023 Z" id="path49" style="fill-opacity: 1; fill: rgb(255, 255, 255);"/>
<path d="M 320.633 9.118 M 320.633 9.118 M 314.299 9.118 M 314.284 13.501 M 314.284 13.501 L 314.287 16.916 C 314.569 18.413 315.877 19.541 317.452 19.541 C 319.028 19.541 320.339 18.41 320.621 16.916 L 320.624 13.501 L 320.633 0.201 L 325.121 0.201 L 325.121 13.501 L 325.115 16.916 C 324.797 20.87 321.488 23.978 317.452 23.978 C 313.417 23.978 310.108 20.87 309.79 16.916 L 309.808 13.501 L 309.799 0.201 L 314.302 0.201 L 314.284 13.501 Z" id="path51" style="fill-opacity: 1; fill: rgb(255, 255, 255);"/>
<polygon points="329.601 23.669 334.026 23.669 334.026 4.623 337.995 4.623 337.995 0.201 325.766 0.201 325.766 4.623 329.601 4.623" id="polygon53" style="fill-opacity: 1; fill: rgb(255, 255, 255);"/>
<polygon points="351.23 23.669 339.07 23.669 339.07 0.201 351.23 0.201 351.23 4.497 343.429 4.497 343.429 10.069 351.23 10.069 351.23 14.452 343.429 14.452 343.429 19.334 351.23 19.334" id="polygon55" style="fill-opacity: 1; fill: rgb(255, 255, 255);"/>
<path stroke="#231F20" stroke-width="0.3451" d="M 356.708 11.584" id="path57" style="fill-opacity: 1; fill: rgb(255, 255, 255);"/>
<path d="M 3.159 94.524 C 3.165 89.727 5.941 85.58 9.979 83.609 L 9.979 83.609 C 9.979 81.575 9.979 79.415 9.979 77.096 L 9.979 77.096 C 4.026 73.768 0.003 67.402 0 60.099 L 0 60.099 C 0.003 52.796 4.026 46.427 9.979 43.102 L 9.979 43.102 C 9.979 28.482 9.979 16.046 9.979 13.696 L 9.979 13.696 C 9.982 6.256 16.01 0.225 23.45 0.225 L 23.45 0.225 L 95.739 0.225 C 103.18 0.225 109.211 6.256 109.211 13.696 L 109.211 13.696 C 109.211 16.046 109.211 28.482 109.211 43.102 L 109.211 43.102 C 115.163 46.427 119.187 52.796 119.19 60.099 L 119.19 60.099 C 119.187 67.402 115.163 73.768 109.211 77.096 L 109.211 77.096 C 109.211 79.415 109.211 81.575 109.211 83.609 L 109.211 83.609 C 113.252 85.58 116.027 89.727 116.03 94.524 L 116.03 94.524 C 116.027 101.23 110.597 106.664 103.888 106.664 L 103.888 106.664 L 69.133 106.664 L 69.133 104.002 C 69.124 98.77 64.887 94.533 59.655 94.524 L 59.655 94.524 L 59.655 91.86 L 59.655 89.199 C 66.922 89.202 72.961 94.437 74.215 101.344 L 74.215 101.344 L 103.891 101.344 C 107.657 101.335 110.705 98.287 110.708 94.524 L 110.708 94.524 C 110.714 91.428 108.641 88.815 105.82 87.981 L 105.82 87.981 L 104.719 87.657 L 103.891 86.022 L 103.891 85.385 C 103.891 82.409 103.891 79.166 103.891 75.532 L 103.891 75.532 L 103.891 74.938 L 104.608 73.405 L 105.511 73.003 C 110.438 70.789 113.873 65.848 113.87 60.096 L 113.87 60.096 C 113.873 54.371 110.471 49.451 105.583 47.222 L 105.583 47.222 L 105.391 47.135 L 103.891 46.142 L 103.891 44.713 C 103.891 29.406 103.891 16.13 103.891 13.693 L 103.891 13.693 C 103.882 9.193 100.24 5.554 95.739 5.545 L 95.739 5.545 L 23.45 5.545 C 18.95 5.554 15.311 9.193 15.302 13.693 L 15.302 13.693 C 15.302 16.13 15.302 29.406 15.302 44.713 L 15.302 44.713 L 15.302 46.142 L 14.107 46.931 L 13.798 47.135 L 13.609 47.222 C 8.719 49.451 5.32 54.374 5.323 60.096 L 5.323 60.096 C 5.32 65.848 8.755 70.789 13.681 73.003 L 13.681 73.003 L 14.581 73.405 L 15.302 74.938 L 15.302 75.532 C 15.302 79.166 15.302 82.412 15.302 85.385 L 15.302 85.385 L 15.302 86.022 L 14.47 87.657 L 13.369 87.981 C 10.549 88.815 8.476 91.428 8.482 94.524 L 8.482 94.524 C 8.488 98.29 11.533 101.335 15.299 101.344 L 15.299 101.344 L 44.974 101.344 C 46.232 94.437 52.271 89.202 59.538 89.199 L 59.538 89.199 L 59.649 89.199 L 59.649 91.86 L 59.649 94.524 L 59.541 94.524 C 54.305 94.533 50.072 98.77 50.06 104.002 L 50.06 104.002 L 50.06 106.664 L 15.302 106.664 C 8.596 106.661 3.162 101.23 3.159 94.524 L 3.159 94.524 Z" id="path65" style="fill-opacity: 1; fill: rgb(255, 255, 255);"/>
<path d="M 12.64 96.964" id="path67" style="fill-opacity: 1; fill: rgb(255, 255, 255);"/>
<path d="M 17.573 40.525 C 17.576 29.472 26.535 20.516 37.588 20.513 L 37.588 20.513 C 48.641 20.516 57.6 29.472 57.6 40.525 L 57.6 40.525 C 57.6 51.578 48.641 60.537 37.588 60.537 L 37.588 60.537 C 26.535 60.537 17.576 51.578 17.573 40.525 L 17.573 40.525 Z M 20.9 40.525 C 20.918 49.742 28.371 57.195 37.588 57.213 L 37.588 57.213 C 46.802 57.195 54.257 49.742 54.275 40.525 L 54.275 40.525 C 54.257 31.311 46.802 23.855 37.588 23.84 L 37.588 23.84 C 28.371 23.855 20.918 31.311 20.9 40.525 L 20.9 40.525 Z" id="path69" style="fill-opacity: 1; fill: rgb(255, 255, 255);"/>
<circle cx="22.245" cy="54.787" r="1.552" id="circle71" style="fill-opacity: 1; fill: rgb(255, 255, 255);" transform="matrix(3.000294, 0, 0, 3.000291, -16.236731, -123.794456)"/>
<path d="M 61.593 40.525 L 61.593 40.525 C 61.593 29.472 70.552 20.516 81.605 20.513 L 81.605 20.513 C 92.658 20.516 101.617 29.472 101.617 40.525 L 101.617 40.525 C 101.617 51.578 92.658 60.537 81.605 60.537 L 81.605 60.537 C 70.552 60.537 61.593 51.578 61.593 40.525 L 61.593 40.525 Z M 81.605 57.213 C 90.819 57.198 98.275 49.742 98.29 40.528 L 98.29 40.528 C 98.275 31.314 90.819 23.858 81.605 23.84 L 81.605 23.84 C 72.391 23.858 64.932 31.314 64.917 40.528 L 64.917 40.528 C 64.935 49.742 72.391 57.195 81.605 57.213 L 81.605 57.213 Z" id="path73" style="fill-opacity: 1; fill: rgb(255, 255, 255);"/>
<circle cx="28.305" cy="54.787" r="1.552" id="circle75" style="fill-opacity: 1; fill: rgb(255, 255, 255);" transform="matrix(3.000297, 0, 0, 3.000291, -16.236814, -123.794456)"/>
</g>
</svg>
Side by side

After

Width:  |  Height:  |  Size: 26 KiB

0
docs/systems/gameandwatch.md Normal file
View file

0
docs/systems/gamegear.md Normal file
View file

24
docs/systems/gb.md Normal file
View file

@ -0,0 +1,24 @@
# Nintendo Game Boy
## Overview
| Path(s) | Supported Extensions |
| --- | --- |
| `storage/roms/gb` | `.gb` `.zip` `.7z` |
## Emulators
| Name | Documentation |
| --- | --- |
| Gambatte &nbsp; `default` | [docs.libretro.com/library/gambatte](https://docs.libretro.com/library/gambatte/) |
| SameBoy | [docs.libretro.com/library/sameboy](https://docs.libretro.com/library/sameboy/) |
| Gearboy | [docs.libretro.com/library/gearboy](https://docs.libretro.com/library/gearboy/) |
| TGB Dual | [docs.libretro.com/library/tgb_dual](https://docs.libretro.com/library/tgb_dual/) |
| mGBA | [docs.libretro.com/library/mgba](https://docs.libretro.com/library/mgba/) |
| VBA-M | [docs.libretro.com/library/vba_m](https://docs.libretro.com/library/vba_m/) |
## Bios
| Filename | MD5 | Path |
| --- | --- | --- |
| gb_bios.bin | 32fbbd84168d3482956eb3c5051637f5 | `storage/roms/bios` |

0
docs/systems/gba.md Normal file
View file

24
docs/systems/gbc.md Normal file
View file

@ -0,0 +1,24 @@
# Nintendo Game Boy Color
## Overview
| Path(s) | Supported Extensions |
| --- | --- |
| `storage/roms/gbc` | `.gbc` `.zip` `.7z` |
## Emulators
| Name | Documentation |
| --- | --- |
| Gambatte &nbsp; `default` | [docs.libretro.com/library/gambatte](https://docs.libretro.com/library/gambatte/) |
| SameBoy | [docs.libretro.com/library/sameboy](https://docs.libretro.com/library/sameboy/) |
| Gearboy | [docs.libretro.com/library/gearboy](https://docs.libretro.com/library/gearboy/) |
| TGB Dual | [docs.libretro.com/library/tgb_dual](https://docs.libretro.com/library/tgb_dual/) |
| mGBA | [docs.libretro.com/library/mgba](https://docs.libretro.com/library/mgba/) |
| VBA-M | [docs.libretro.com/library/vba_m](https://docs.libretro.com/library/vba_m/) |
## Bios
| Filename | MD5 | Path |
| --- | --- | --- |
| gbc_bios.bin | dbfce9db9deaa2567f6a84fde55f9680 | `storage/roms/bios` |

Some files were not shown because too many files have changed in this diff Show more