commit 2643bf936e0320cda6377bd7e67fde960102e5d7 Author: anthonycaccese Date: Mon Sep 18 07:19:49 2023 -0400 Initial Commit diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..5d3cee2 --- /dev/null +++ b/.github/workflows/ci.yml @@ -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 diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..6b34adf --- /dev/null +++ b/.gitignore @@ -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 \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + 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. + + + Copyright (C) + + 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 . + +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: + + Copyright (C) + 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 +. + + 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 +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..ef8e3fe --- /dev/null +++ b/README.md @@ -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! \ No newline at end of file diff --git a/docs/_inc/css/custom.css b/docs/_inc/css/custom.css new file mode 100644 index 0000000..dd3cadf --- /dev/null +++ b/docs/_inc/css/custom.css @@ -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; + } +} \ No newline at end of file diff --git a/docs/_inc/images/devices/anbernic-rg351pm.png b/docs/_inc/images/devices/anbernic-rg351pm.png new file mode 100644 index 0000000..dc816bc Binary files /dev/null and b/docs/_inc/images/devices/anbernic-rg351pm.png differ diff --git a/docs/_inc/images/devices/anbernic-rg353.png b/docs/_inc/images/devices/anbernic-rg353.png new file mode 100644 index 0000000..7cb572c Binary files /dev/null and b/docs/_inc/images/devices/anbernic-rg353.png differ diff --git a/docs/_inc/images/devices/anbernic-rg503.png b/docs/_inc/images/devices/anbernic-rg503.png new file mode 100644 index 0000000..9c84106 Binary files /dev/null and b/docs/_inc/images/devices/anbernic-rg503.png differ diff --git a/docs/_inc/images/devices/anbernic-rg552.png b/docs/_inc/images/devices/anbernic-rg552.png new file mode 100644 index 0000000..238768a Binary files /dev/null and b/docs/_inc/images/devices/anbernic-rg552.png differ diff --git a/docs/_inc/images/devices/anbernic-win600.png b/docs/_inc/images/devices/anbernic-win600.png new file mode 100644 index 0000000..ee95d6c Binary files /dev/null and b/docs/_inc/images/devices/anbernic-win600.png differ diff --git a/docs/_inc/images/devices/aokzoe-a1-pro.png b/docs/_inc/images/devices/aokzoe-a1-pro.png new file mode 100644 index 0000000..db32cad Binary files /dev/null and b/docs/_inc/images/devices/aokzoe-a1-pro.png differ diff --git a/docs/_inc/images/devices/atari-vcs.png b/docs/_inc/images/devices/atari-vcs.png new file mode 100644 index 0000000..d0d85dc Binary files /dev/null and b/docs/_inc/images/devices/atari-vcs.png differ diff --git a/docs/_inc/images/devices/ayaneo-2.png b/docs/_inc/images/devices/ayaneo-2.png new file mode 100644 index 0000000..589e946 Binary files /dev/null and b/docs/_inc/images/devices/ayaneo-2.png differ diff --git a/docs/_inc/images/devices/ayaneo-air-plus.png b/docs/_inc/images/devices/ayaneo-air-plus.png new file mode 100644 index 0000000..e7cdb17 Binary files /dev/null and b/docs/_inc/images/devices/ayaneo-air-plus.png differ diff --git a/docs/_inc/images/devices/ayaneo-air.png b/docs/_inc/images/devices/ayaneo-air.png new file mode 100644 index 0000000..6f63164 Binary files /dev/null and b/docs/_inc/images/devices/ayaneo-air.png differ diff --git a/docs/_inc/images/devices/ayn-loki.png b/docs/_inc/images/devices/ayn-loki.png new file mode 100644 index 0000000..299b0b5 Binary files /dev/null and b/docs/_inc/images/devices/ayn-loki.png differ diff --git a/docs/_inc/images/devices/gpdwin-4.png b/docs/_inc/images/devices/gpdwin-4.png new file mode 100644 index 0000000..80d61c4 Binary files /dev/null and b/docs/_inc/images/devices/gpdwin-4.png differ diff --git a/docs/_inc/images/devices/gpdwin-max-2.png b/docs/_inc/images/devices/gpdwin-max-2.png new file mode 100644 index 0000000..99ffd51 Binary files /dev/null and b/docs/_inc/images/devices/gpdwin-max-2.png differ diff --git a/docs/_inc/images/devices/indiedroid-nova.png b/docs/_inc/images/devices/indiedroid-nova.png new file mode 100644 index 0000000..fc7002c Binary files /dev/null and b/docs/_inc/images/devices/indiedroid-nova.png differ diff --git a/docs/_inc/images/devices/orange-pi-5.png b/docs/_inc/images/devices/orange-pi-5.png new file mode 100644 index 0000000..84cbbdc Binary files /dev/null and b/docs/_inc/images/devices/orange-pi-5.png differ diff --git a/docs/_inc/images/devices/powkiddy-rgb10max3pro.png b/docs/_inc/images/devices/powkiddy-rgb10max3pro.png new file mode 100644 index 0000000..e69394d Binary files /dev/null and b/docs/_inc/images/devices/powkiddy-rgb10max3pro.png differ diff --git a/docs/_inc/images/devices/powkiddy-rgb30.png b/docs/_inc/images/devices/powkiddy-rgb30.png new file mode 100644 index 0000000..dadb3c2 Binary files /dev/null and b/docs/_inc/images/devices/powkiddy-rgb30.png differ diff --git a/docs/_inc/images/devices/powkiddy-rk2023.png b/docs/_inc/images/devices/powkiddy-rk2023.png new file mode 100644 index 0000000..58b4ac3 Binary files /dev/null and b/docs/_inc/images/devices/powkiddy-rk2023.png differ diff --git a/docs/_inc/images/devices/powkiddy-x55.png b/docs/_inc/images/devices/powkiddy-x55.png new file mode 100644 index 0000000..c3a6aec Binary files /dev/null and b/docs/_inc/images/devices/powkiddy-x55.png differ diff --git a/docs/_inc/images/logo.png b/docs/_inc/images/logo.png new file mode 100644 index 0000000..b20a64d Binary files /dev/null and b/docs/_inc/images/logo.png differ diff --git a/docs/_inc/images/screenshots/gamelist-view-metadata-immersive.png b/docs/_inc/images/screenshots/gamelist-view-metadata-immersive.png new file mode 100644 index 0000000..ae6442d Binary files /dev/null and b/docs/_inc/images/screenshots/gamelist-view-metadata-immersive.png differ diff --git a/docs/_inc/images/screenshots/gamelist-view-no-metadata-immersive.png b/docs/_inc/images/screenshots/gamelist-view-no-metadata-immersive.png new file mode 100644 index 0000000..e07ea52 Binary files /dev/null and b/docs/_inc/images/screenshots/gamelist-view-no-metadata-immersive.png differ diff --git a/docs/_inc/images/screenshots/menu.png b/docs/_inc/images/screenshots/menu.png new file mode 100644 index 0000000..1f79f6f Binary files /dev/null and b/docs/_inc/images/screenshots/menu.png differ diff --git a/docs/_inc/images/screenshots/system-view.png b/docs/_inc/images/screenshots/system-view.png new file mode 100644 index 0000000..6bba9f8 Binary files /dev/null and b/docs/_inc/images/screenshots/system-view.png differ diff --git a/docs/contribute/build.md b/docs/contribute/build.md new file mode 100644 index 0000000..69b936f --- /dev/null +++ b/docs/contribute/build.md @@ -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|false1|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: 1 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. diff --git a/docs/contribute/code-of-conduct.md b/docs/contribute/code-of-conduct.md new file mode 100644 index 0000000..e549196 --- /dev/null +++ b/docs/contribute/code-of-conduct.md @@ -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. diff --git a/docs/contribute/index.md b/docs/contribute/index.md new file mode 100644 index 0000000..7c34a9c --- /dev/null +++ b/docs/contribute/index.md @@ -0,0 +1,52 @@ + + +# 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) \ No newline at end of file diff --git a/docs/contribute/modify.md b/docs/contribute/modify.md new file mode 100644 index 0000000..9f42d12 --- /dev/null +++ b/docs/contribute/modify.md @@ -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 +``` \ No newline at end of file diff --git a/docs/contribute/packages.md b/docs/contribute/packages.md new file mode 100644 index 0000000..e11db18 --- /dev/null +++ b/docs/contribute/packages.md @@ -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
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
yes for 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
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
PKG_CONFIGURE_OPTS_BOOTSTRAP
PKG_CONFIGURE_OPTS_HOST
PKG_CONFIGURE_OPTS_INIT
PKG_CONFIGURE_OPTS_TARGET | - | no | Options directly passed to configure | + +#### Make Options +| Variable | Default | Required |Description | +|-------------|---------|----------|------------| +| PKG_MAKE_OPTS
PKG_MAKE_OPTS_BOOTSTRP
PKG_MAKE_OPTS_HOST
PKG_MAKE_OPTS_INIT
PKG_MAKE_OPTS_TARGET | - | no | Options directly passed to make in the build step +| PKG_MAKEINSTALL_OPTS_HOST
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`
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
pre_unpack
post_unpack | - | Extract the source from the downloaded file | +| pre_patch
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
pre_configure_\[stage]
configure_\[stage]
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]
pre_make_\[stage]
post_make_\[stage] | yes | Build of the package | +| makeinstall_\[stage]
pre_makeinstall_\[stage]
post_makeinstall_\[stage] | yes | Installation of the files in the correct pathes
host: TOOLCHAIN
target: SYSROOT and IMAGE
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 binding 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 function def | FAIL | Function defined multiple times, only last definition will be used | +| bad func - missing brace | FAIL | Opening brace (`{`) for function definition should be on same line as the function def, ie. `pre_configure_target() {` | +| intertwined vars & funcs | WARN | Variable assignments and logic is intertwined with functions - this is cosmetic, but variables and logic should be specified before all functions | +| unknown function | WARN | Could be a misspelled function, ie. `per_configure_target() {` which might fail silently.| +| ignored depends 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`. diff --git a/docs/contribute/quirks.md b/docs/contribute/quirks.md new file mode 100644 index 0000000..06d44c3 --- /dev/null +++ b/docs/contribute/quirks.md @@ -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. diff --git a/docs/donations.md b/docs/donations.md new file mode 100644 index 0000000..2d3188d --- /dev/null +++ b/docs/donations.md @@ -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 | \ No newline at end of file diff --git a/docs/faqs.md b/docs/faqs.md new file mode 100644 index 0000000..fb15e0a --- /dev/null +++ b/docs/faqs.md @@ -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. \ No newline at end of file diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..dbae7dd --- /dev/null +++ b/docs/index.md @@ -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 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 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 + + + + + + + + + + +
+ +## Community + +The JELOS community utilizes Discord for discussion, if you would like to join us please use this link:  [: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. \ No newline at end of file diff --git a/docs/play/hotkeys.md b/docs/play/hotkeys.md new file mode 100644 index 0000000..e6b787b --- /dev/null +++ b/docs/play/hotkeys.md @@ -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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
EmulatorNotes
AmiberryStandalone
Dolphin (dolphin-sa)Standalone + +``` +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 +``` +
ecwolfGame Engine
gzdoomGame Engine
Hatari (Hatarisa)Standalone
Hypseus-singeStandalone + +``` +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 + +``` +
lzdoomGame Engine
mupen64plus (mupen64plussa)Standalone + +``` +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``` +
OpenborStandalone + +``` +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 + +
PPSSPPSDLStandalone + +``` +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 +``` +
RazeGame Engine
Scummmvm (Scummvmsa)Standalone
vice (vicesa)Standalone + +``` +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 +
YabasanshiroStandalone + +``` +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 +``` +
Retroarch with Libretro Cores (RA:)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 +``` +
Port MasterPort Installer
+ +## 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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Joypad ButtonButton Codes
+DIGITALRG552/RG503/RG353PRG351MPRG351P/MRG351V
+A (EAST) 1 (305 BTN_EAST)1 (305 BTN_EAST)0 (305 BTN_EAST)0 (305 BTN_EAST)
+B (SOUTH) 0 (304 BTN_SOUTH)0 (304 BTN_SOUTH)1 (304 BTN_SOUTH)1 (304 BTN_SOUTH)
+X (NORTH) 2 (307 BTN_NORTH)2 (307 BTN_NORTH)2 (307 BTN_NORTH)2 (307 BTN_NORTH)
+Y (WEST) 3 (308 BTN_WEST)3 (308 BTN_WEST)3 (306 BTN_C)3 (306 BTN_C)
+L1 4 (310 BTN_TL)4 (310 BTN_TL)4 (308 BTN_WEST)4 (308 BTN_WEST)
+L2 6 (312 BTN_TL2)6 (312 BTN_TL2)10 (314 BTN_SELECT)10 (314 BTN_SELECT)
+L3 11 (317 BTN_THUMBL)14 (706 BTN_TRIGGER_HAPPY3)8 (312 BTN_TL2)8 (312 BTN_TL2)
+R1 5 (311 BTN_TR)5 (311 BTN_TR)5 (309 BTN_Z)5 (309 BTN_Z)
+R2 7 (313 BTN_TR2)7 (313 BTN_TR2)11 (315 BTN_START)11 (315 BTN_START)
+R3 12 (318 BTN_THUMBR)15 (707 BTN_TRIGGER_HAPPY4)9 (313 BTN_TR2)9 (313 BTN_TR2; F)
+SELECT 8 (314 BTN_SELECT)12 (704 BTN_TRIGGER_HAPPY1)7 (311 BTN_TR)7 (311 BTN_TR)
+START 9 (315 BTN_START)13 (705 BTN_TRIGGER_HAPPY2)6 (310 BTN_TL)6 (310 BTN_TL)
+HOTKEY ENABLE 10 (316) 12 (704 BTN_TRIGGER_HAPPY1) 7 (311 BTN_TR) 7 (311 BTN_TR)
+DPAD UP 13 (544 BTN_DPAD_UP) 8 (544 BTN_DPAD_UP) hat(1) (16 -ve ABS_HAT0Y -1)hat(1) (16 -ve ABS_HAT0Y -1)
+DPAD DOWN 14 (545 BTN_DPAD_DOWN) 9 (545 BTN_DPAD_DOWN) hat(4) (16 +ve ABS_HAT0Y 1)hat(4) (16 +ve ABS_HAT0Y 1)
+DPAD LEFT 15 (546 BTN_DPAD_LEFT) 10 (546 BTN_DPAD_LEFT) hat(8) (17 -ve ABS_HAT0X -1)hat(8) (17 -ve ABS_HAT0X -1)
+DPAD RIGHT 16 (547 BTN_DPAD_RIGHT) 11 (547 BTN_DPAD_RIGHT) hat(2) (17 +ve ABS_HAT0X 1)hat(2) (17 +ve ABS_HAT0X 1)
+ANALOGRG552/RG503/RG353PRG351MPRG351P/MRG351V
+LEFTANALOGLEFT AXIS 0 -ve (ABS_X)AXIS 0 -ve (ABS_X)AXIS 2 +ve (ABS_Z 4095)AXIS 2 +ve (ABS_Z 4095)
+LEFTANALOGRIGHT AXIS 0 +ve (ABS_X)AXIS 0 +ve (ABS_X)AXIS 2 -ve (ABS_Z 0)AXIS 2 -ve (ABS_Z 0)
+LEFTANALOGUP AXIS 1 -ve (ABS_Y)AXIS 1 -ve (ABS_Y)AXIS 3 +ve (ABS_RX 4040)AXIS 3 +ve (ABS_RX 4040)
+LEFTANALOGDOWN AXIS 1 +ve (ABS_Y)AXIS 1 +ve (ABS_Y)AXIS 3 -ve (ABS_RX 0)AXIS 3 -ve (ABS_RX 0)
+RIGHTANALOGLEFT AXIS 2 -ve (ABS_RX)AXIS 2 -ve (ABS_RX)AXIS 4 -ve (ABS_RY)
+RIGHTANALOGRIGHT AXIS 2 +ve (ABS_RX)AXIS 2 +ve (ABS_RX)AXIS 4 +ve (ABS_RY)
+RIGHTANALOGUP AXIS 3 -ve (ABS_RY)AXIS 3 -ve (ABS_RY)AXIS 5 -ve (ABS_RZ)
+RIGHTANALOGDOWN AXIS 3 +ve (ABS_RY)AXIS 3 +ve (ABS_RY)AXIS 5 +ve (ABS_RZ)
\ No newline at end of file diff --git a/docs/play/install.md b/docs/play/install.md new file mode 100644 index 0000000..0387229 --- /dev/null +++ b/docs/play/install.md @@ -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. \ No newline at end of file diff --git a/docs/play/update.md b/docs/play/update.md new file mode 100644 index 0000000..14126a7 --- /dev/null +++ b/docs/play/update.md @@ -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. \ No newline at end of file diff --git a/docs/supported-devices/anbernic/rg351pm.md b/docs/supported-devices/anbernic/rg351pm.md new file mode 100644 index 0000000..3b815f8 --- /dev/null +++ b/docs/supported-devices/anbernic/rg351pm.md @@ -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) \ No newline at end of file diff --git a/docs/supported-devices/anbernic/rg353pmvvs.md b/docs/supported-devices/anbernic/rg353pmvvs.md new file mode 100644 index 0000000..6f49f7a --- /dev/null +++ b/docs/supported-devices/anbernic/rg353pmvvs.md @@ -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 + +| | | +| -- | -- | +| | | diff --git a/docs/supported-devices/anbernic/rg503.md b/docs/supported-devices/anbernic/rg503.md new file mode 100644 index 0000000..81ee645 --- /dev/null +++ b/docs/supported-devices/anbernic/rg503.md @@ -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) \ No newline at end of file diff --git a/docs/supported-devices/anbernic/rg552.md b/docs/supported-devices/anbernic/rg552.md new file mode 100644 index 0000000..c1eea87 --- /dev/null +++ b/docs/supported-devices/anbernic/rg552.md @@ -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) \ No newline at end of file diff --git a/docs/supported-devices/anbernic/win600.md b/docs/supported-devices/anbernic/win600.md new file mode 100644 index 0000000..398e5f8 --- /dev/null +++ b/docs/supported-devices/anbernic/win600.md @@ -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) \ No newline at end of file diff --git a/docs/supported-devices/aokzoe/a1-pro.md b/docs/supported-devices/aokzoe/a1-pro.md new file mode 100644 index 0000000..21504e5 --- /dev/null +++ b/docs/supported-devices/aokzoe/a1-pro.md @@ -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) \ No newline at end of file diff --git a/docs/supported-devices/atari/vcs.md b/docs/supported-devices/atari/vcs.md new file mode 100644 index 0000000..4f4c787 --- /dev/null +++ b/docs/supported-devices/atari/vcs.md @@ -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) \ No newline at end of file diff --git a/docs/supported-devices/ayaneo/air-plus.md b/docs/supported-devices/ayaneo/air-plus.md new file mode 100644 index 0000000..3007c23 --- /dev/null +++ b/docs/supported-devices/ayaneo/air-plus.md @@ -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                 | Notes | +| -- | -- | +| :material-harddisk: Storage | JELOS can be run from an SD Card, USB Drive or installed directly to the internal NVME.
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) \ No newline at end of file diff --git a/docs/supported-devices/ayaneo/air.md b/docs/supported-devices/ayaneo/air.md new file mode 100644 index 0000000..3a15872 --- /dev/null +++ b/docs/supported-devices/ayaneo/air.md @@ -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                 | Notes | +| -- | -- | +| :material-harddisk: Storage | JELOS can be run from an SD Card, USB Drive or installed directly to the internal NVME.
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)
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) \ No newline at end of file diff --git a/docs/supported-devices/ayaneo/ayaneo-2.md b/docs/supported-devices/ayaneo/ayaneo-2.md new file mode 100644 index 0000000..eebe850 --- /dev/null +++ b/docs/supported-devices/ayaneo/ayaneo-2.md @@ -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                 | Notes | +| -- | -- | +| :material-harddisk: Storage | JELOS can be run from an SD Card, USB Drive or installed directly to the internal NVME.
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) \ No newline at end of file diff --git a/docs/supported-devices/ayn/loki-max.md b/docs/supported-devices/ayn/loki-max.md new file mode 100644 index 0000000..54eccfe --- /dev/null +++ b/docs/supported-devices/ayn/loki-max.md @@ -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                 | Notes | +| -- | -- | +| :material-harddisk: Storage | JELOS can be run from an SD Card, USB Drive or installed directly to the internal NVME.
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)
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) \ No newline at end of file diff --git a/docs/supported-devices/ayn/loki-zero.md b/docs/supported-devices/ayn/loki-zero.md new file mode 100644 index 0000000..93edcaa --- /dev/null +++ b/docs/supported-devices/ayn/loki-zero.md @@ -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                 | Notes | +| -- | -- | +| :material-harddisk: Storage | JELOS can be run from an SD Card, USB Drive or installed directly to the internal NVME.
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)
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) \ No newline at end of file diff --git a/docs/supported-devices/gpd/win-max-2.md b/docs/supported-devices/gpd/win-max-2.md new file mode 100644 index 0000000..a5ed3ad --- /dev/null +++ b/docs/supported-devices/gpd/win-max-2.md @@ -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) \ No newline at end of file diff --git a/docs/supported-devices/gpd/win4.md b/docs/supported-devices/gpd/win4.md new file mode 100644 index 0000000..b83bc80 --- /dev/null +++ b/docs/supported-devices/gpd/win4.md @@ -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) \ No newline at end of file diff --git a/docs/supported-devices/hardkernel/odroid-go-advance.md b/docs/supported-devices/hardkernel/odroid-go-advance.md new file mode 100644 index 0000000..d6213cb --- /dev/null +++ b/docs/supported-devices/hardkernel/odroid-go-advance.md @@ -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) \ No newline at end of file diff --git a/docs/supported-devices/hardkernel/odroid-go-super.md b/docs/supported-devices/hardkernel/odroid-go-super.md new file mode 100644 index 0000000..ce4e97c --- /dev/null +++ b/docs/supported-devices/hardkernel/odroid-go-super.md @@ -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) \ No newline at end of file diff --git a/docs/supported-devices/hardkernel/odroid-go-ultra.md b/docs/supported-devices/hardkernel/odroid-go-ultra.md new file mode 100644 index 0000000..0734712 --- /dev/null +++ b/docs/supported-devices/hardkernel/odroid-go-ultra.md @@ -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) \ No newline at end of file diff --git a/docs/supported-devices/index.md b/docs/supported-devices/index.md new file mode 100644 index 0000000..bf10de5 --- /dev/null +++ b/docs/supported-devices/index.md @@ -0,0 +1,42 @@ + + +# Supported Devices + +JELOS supports a variety of ARM and Intel/AMD based devices1. + +| Manufacturer | Device | CPU / Architecture | Kernel | GL driver | Interface | +|--|--|--|--|--|--| +|Anbernic| RG351P/M | Rockchip RK3326 (ARM) | Mainline Linux | Panfrost | Weston + EmulationStation| +|Anbernic| RG353P2 | Rockchip RK3566 (ARM) | Rockchip BSP 4.19 | Mali | KMS/DRM + EmulationStation| +|Anbernic| RG353M2 | Rockchip RK3566 (ARM) | Rockchip BSP 4.19 | Mali | KMS/DRM + EmulationStation| +|Anbernic| RG353V2 | Rockchip RK3566 (ARM) | Rockchip BSP 4.19 | Mali | KMS/DRM + EmulationStation| +|Anbernic| RG353VS2 | 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| +|AYANEO3|Air / Air Pro|Amd Ryzen 5 5560U / AMD Ryzen 7 5825U (x86_64)|Mainline Linux|Radeonsi|Weston + EmulationStation| +|AYANEO3|Air Plus|Amd Ryzen 7 6800U / (x86_64)|Mainline Linux|Radeonsi|Weston + EmulationStation| +|AYANEO3|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 | + +> 1 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. + +> 2 Anbernic RG353P/M/V/VS devices with both v1 and v2 displays are supported. RG353PS will not be supported. + +> 3 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. \ No newline at end of file diff --git a/docs/supported-devices/indiedroid/nova.md b/docs/supported-devices/indiedroid/nova.md new file mode 100644 index 0000000..91e5522 --- /dev/null +++ b/docs/supported-devices/indiedroid/nova.md @@ -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) \ No newline at end of file diff --git a/docs/supported-devices/orange-pi/orange-pi-5.md b/docs/supported-devices/orange-pi/orange-pi-5.md new file mode 100644 index 0000000..47f7dd5 --- /dev/null +++ b/docs/supported-devices/orange-pi/orange-pi-5.md @@ -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) + diff --git a/docs/supported-devices/powkiddy/rgb10-max-3-pro.md b/docs/supported-devices/powkiddy/rgb10-max-3-pro.md new file mode 100644 index 0000000..672df4c --- /dev/null +++ b/docs/supported-devices/powkiddy/rgb10-max-3-pro.md @@ -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 | \ No newline at end of file diff --git a/docs/supported-devices/powkiddy/rgb30.md b/docs/supported-devices/powkiddy/rgb30.md new file mode 100644 index 0000000..5023c18 --- /dev/null +++ b/docs/supported-devices/powkiddy/rgb30.md @@ -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) \ No newline at end of file diff --git a/docs/supported-devices/powkiddy/rk2023.md b/docs/supported-devices/powkiddy/rk2023.md new file mode 100644 index 0000000..4c52f09 --- /dev/null +++ b/docs/supported-devices/powkiddy/rk2023.md @@ -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) \ No newline at end of file diff --git a/docs/supported-devices/powkiddy/x55.md b/docs/supported-devices/powkiddy/x55.md new file mode 100644 index 0000000..df67c1f --- /dev/null +++ b/docs/supported-devices/powkiddy/x55.md @@ -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) \ No newline at end of file diff --git a/docs/systems/3do.md b/docs/systems/3do.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/systems/3ds.md b/docs/systems/3ds.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/systems/amiga.md b/docs/systems/amiga.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/systems/amigacd32.md b/docs/systems/amigacd32.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/systems/amstradcpc.md b/docs/systems/amstradcpc.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/systems/arcade/index.md b/docs/systems/arcade/index.md new file mode 100644 index 0000000..51c4a59 --- /dev/null +++ b/docs/systems/arcade/index.md @@ -0,0 +1 @@ +# Arcade \ No newline at end of file diff --git a/docs/systems/arduboy.md b/docs/systems/arduboy.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/systems/atari2600.md b/docs/systems/atari2600.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/systems/atari5200.md b/docs/systems/atari5200.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/systems/atari7800.md b/docs/systems/atari7800.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/systems/atari800.md b/docs/systems/atari800.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/systems/atarijaguar.md b/docs/systems/atarijaguar.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/systems/atarilynx.md b/docs/systems/atarilynx.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/systems/atarist.md b/docs/systems/atarist.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/systems/atomiswave.md b/docs/systems/atomiswave.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/systems/c128.md b/docs/systems/c128.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/systems/c16.md b/docs/systems/c16.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/systems/c64.md b/docs/systems/c64.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/systems/channelf.md b/docs/systems/channelf.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/systems/colecovision.md b/docs/systems/colecovision.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/systems/cps1.md b/docs/systems/cps1.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/systems/cps2.md b/docs/systems/cps2.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/systems/cps3.md b/docs/systems/cps3.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/systems/daphne.md b/docs/systems/daphne.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/systems/doom.md b/docs/systems/doom.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/systems/dreamcast.md b/docs/systems/dreamcast.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/systems/easyrpg.md b/docs/systems/easyrpg.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/systems/famicom.md b/docs/systems/famicom.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/systems/fbn.md b/docs/systems/fbn.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/systems/fds.md b/docs/systems/fds.md new file mode 100644 index 0000000..9c5a20a --- /dev/null +++ b/docs/systems/fds.md @@ -0,0 +1,37 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/systems/gameandwatch.md b/docs/systems/gameandwatch.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/systems/gamegear.md b/docs/systems/gamegear.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/systems/gb.md b/docs/systems/gb.md new file mode 100644 index 0000000..b37df78 --- /dev/null +++ b/docs/systems/gb.md @@ -0,0 +1,24 @@ +# Nintendo Game Boy + +## Overview + +| Path(s) | Supported Extensions | +| --- | --- | +| `storage/roms/gb` | `.gb` `.zip` `.7z` | + +## Emulators + +| Name | Documentation | +| --- | --- | +| Gambatte   `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` | \ No newline at end of file diff --git a/docs/systems/gba.md b/docs/systems/gba.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/systems/gbc.md b/docs/systems/gbc.md new file mode 100644 index 0000000..9f138f3 --- /dev/null +++ b/docs/systems/gbc.md @@ -0,0 +1,24 @@ +# Nintendo Game Boy Color + +## Overview + +| Path(s) | Supported Extensions | +| --- | --- | +| `storage/roms/gbc` | `.gbc` `.zip` `.7z` | + +## Emulators + +| Name | Documentation | +| --- | --- | +| Gambatte   `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` | \ No newline at end of file diff --git a/docs/systems/gc.md b/docs/systems/gc.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/systems/genesis.md b/docs/systems/genesis.md new file mode 100644 index 0000000..1bdfe08 --- /dev/null +++ b/docs/systems/genesis.md @@ -0,0 +1,3 @@ +genesis +megadrive +megadrive-japan \ No newline at end of file diff --git a/docs/systems/index.md b/docs/systems/index.md new file mode 100644 index 0000000..462ba0e --- /dev/null +++ b/docs/systems/index.md @@ -0,0 +1,5 @@ + + +# Supported Systems \ No newline at end of file diff --git a/docs/systems/intellivision.md b/docs/systems/intellivision.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/systems/j2me.md b/docs/systems/j2me.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/systems/mame.md b/docs/systems/mame.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/systems/mastersystem.md b/docs/systems/mastersystem.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/systems/megaduck.md b/docs/systems/megaduck.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/systems/moonlight.md b/docs/systems/moonlight.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/systems/mplayer.md b/docs/systems/mplayer.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/systems/msx.md b/docs/systems/msx.md new file mode 100644 index 0000000..8bd12dc --- /dev/null +++ b/docs/systems/msx.md @@ -0,0 +1,2 @@ +msx +msx2 \ No newline at end of file diff --git a/docs/systems/music.md b/docs/systems/music.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/systems/n64.md b/docs/systems/n64.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/systems/naomi.md b/docs/systems/naomi.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/systems/nds.md b/docs/systems/nds.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/systems/neogeo.md b/docs/systems/neogeo.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/systems/neogeocd.md b/docs/systems/neogeocd.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/systems/nes.md b/docs/systems/nes.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/systems/ngp.md b/docs/systems/ngp.md new file mode 100644 index 0000000..625e0f4 --- /dev/null +++ b/docs/systems/ngp.md @@ -0,0 +1,2 @@ +ngp +npgc \ No newline at end of file diff --git a/docs/systems/odyssey2.md b/docs/systems/odyssey2.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/systems/openbor.md b/docs/systems/openbor.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/systems/pc.md b/docs/systems/pc.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/systems/pc88.md b/docs/systems/pc88.md new file mode 100644 index 0000000..11b28f3 --- /dev/null +++ b/docs/systems/pc88.md @@ -0,0 +1,106 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/systems/pc98.md b/docs/systems/pc98.md new file mode 100644 index 0000000..bcfe484 --- /dev/null +++ b/docs/systems/pc98.md @@ -0,0 +1,26 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/systems/pce-cd.md b/docs/systems/pce-cd.md new file mode 100644 index 0000000..a9dbf7a --- /dev/null +++ b/docs/systems/pce-cd.md @@ -0,0 +1,20 @@ + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/systems/pcengine.md b/docs/systems/pcengine.md new file mode 100644 index 0000000..99ff9dd --- /dev/null +++ b/docs/systems/pcengine.md @@ -0,0 +1,12 @@ + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/systems/pcfx.md b/docs/systems/pcfx.md new file mode 100644 index 0000000..3eecf66 --- /dev/null +++ b/docs/systems/pcfx.md @@ -0,0 +1,45 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/systems/pet.md b/docs/systems/pet.md new file mode 100644 index 0000000..2ca00a9 --- /dev/null +++ b/docs/systems/pet.md @@ -0,0 +1,12 @@ + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/systems/pico-8.md b/docs/systems/pico-8.md new file mode 100644 index 0000000..8d3edc8 --- /dev/null +++ b/docs/systems/pico-8.md @@ -0,0 +1,9 @@ + + + + + + + + + \ No newline at end of file diff --git a/docs/systems/pokemini.md b/docs/systems/pokemini.md new file mode 100644 index 0000000..648b9c5 --- /dev/null +++ b/docs/systems/pokemini.md @@ -0,0 +1,17 @@ + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/systems/ports.md b/docs/systems/ports.md new file mode 100644 index 0000000..03fd34c --- /dev/null +++ b/docs/systems/ports.md @@ -0,0 +1,11 @@ + + + + + + + + + + + \ No newline at end of file diff --git a/docs/systems/ps2.md b/docs/systems/ps2.md new file mode 100644 index 0000000..816de4f --- /dev/null +++ b/docs/systems/ps2.md @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/docs/systems/ps3.md b/docs/systems/ps3.md new file mode 100644 index 0000000..83f3af4 --- /dev/null +++ b/docs/systems/ps3.md @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/docs/systems/psp.md b/docs/systems/psp.md new file mode 100644 index 0000000..5a69ab8 --- /dev/null +++ b/docs/systems/psp.md @@ -0,0 +1,28 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/systems/pspminis.md b/docs/systems/pspminis.md new file mode 100644 index 0000000..6e9f324 --- /dev/null +++ b/docs/systems/pspminis.md @@ -0,0 +1,17 @@ + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/systems/psvita.md b/docs/systems/psvita.md new file mode 100644 index 0000000..b56f7ef --- /dev/null +++ b/docs/systems/psvita.md @@ -0,0 +1,11 @@ + + + + + + + + + + + \ No newline at end of file diff --git a/docs/systems/psx.md b/docs/systems/psx.md new file mode 100644 index 0000000..4123eda --- /dev/null +++ b/docs/systems/psx.md @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/docs/systems/satellaview.md b/docs/systems/satellaview.md new file mode 100644 index 0000000..490472f --- /dev/null +++ b/docs/systems/satellaview.md @@ -0,0 +1,39 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/systems/saturn.md b/docs/systems/saturn.md new file mode 100644 index 0000000..af78a25 --- /dev/null +++ b/docs/systems/saturn.md @@ -0,0 +1,13 @@ + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/systems/scummvm.md b/docs/systems/scummvm.md new file mode 100644 index 0000000..f1ff43d --- /dev/null +++ b/docs/systems/scummvm.md @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/docs/systems/sega32x.md b/docs/systems/sega32x.md new file mode 100644 index 0000000..333ec59 --- /dev/null +++ b/docs/systems/sega32x.md @@ -0,0 +1,14 @@ + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/systems/segacd.md b/docs/systems/segacd.md new file mode 100644 index 0000000..0b07389 --- /dev/null +++ b/docs/systems/segacd.md @@ -0,0 +1,11 @@ + + + + + + + + + + + \ No newline at end of file diff --git a/docs/systems/sfc.md b/docs/systems/sfc.md new file mode 100644 index 0000000..f6ba6b2 --- /dev/null +++ b/docs/systems/sfc.md @@ -0,0 +1,35 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/systems/sg-1000.md b/docs/systems/sg-1000.md new file mode 100644 index 0000000..876b0f8 --- /dev/null +++ b/docs/systems/sg-1000.md @@ -0,0 +1,12 @@ + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/systems/snes.md b/docs/systems/snes.md new file mode 100644 index 0000000..2989df1 --- /dev/null +++ b/docs/systems/snes.md @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/docs/systems/snesmsu1.md b/docs/systems/snesmsu1.md new file mode 100644 index 0000000..17b228a --- /dev/null +++ b/docs/systems/snesmsu1.md @@ -0,0 +1,21 @@ + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/systems/st-v.md b/docs/systems/st-v.md new file mode 100644 index 0000000..f436b43 --- /dev/null +++ b/docs/systems/st-v.md @@ -0,0 +1,21 @@ + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/systems/sufami.md b/docs/systems/sufami.md new file mode 100644 index 0000000..d85590f --- /dev/null +++ b/docs/systems/sufami.md @@ -0,0 +1,36 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/systems/supergrafx.md b/docs/systems/supergrafx.md new file mode 100644 index 0000000..d72ad75 --- /dev/null +++ b/docs/systems/supergrafx.md @@ -0,0 +1,20 @@ + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/systems/supervision.md b/docs/systems/supervision.md new file mode 100644 index 0000000..87621fb --- /dev/null +++ b/docs/systems/supervision.md @@ -0,0 +1,15 @@ + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/systems/switch.md b/docs/systems/switch.md new file mode 100644 index 0000000..6a3fa58 --- /dev/null +++ b/docs/systems/switch.md @@ -0,0 +1,24 @@ + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/systems/tg16.md b/docs/systems/tg16.md new file mode 100644 index 0000000..c8b3c43 --- /dev/null +++ b/docs/systems/tg16.md @@ -0,0 +1,15 @@ + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/systems/tg16cd.md b/docs/systems/tg16cd.md new file mode 100644 index 0000000..97a5532 --- /dev/null +++ b/docs/systems/tg16cd.md @@ -0,0 +1,14 @@ + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/systems/tic-80.md b/docs/systems/tic-80.md new file mode 100644 index 0000000..4b48508 --- /dev/null +++ b/docs/systems/tic-80.md @@ -0,0 +1,9 @@ + + + + + + + + + \ No newline at end of file diff --git a/docs/systems/uzebox.md b/docs/systems/uzebox.md new file mode 100644 index 0000000..1829e6e --- /dev/null +++ b/docs/systems/uzebox.md @@ -0,0 +1,7 @@ + + + + + + + \ No newline at end of file diff --git a/docs/systems/vectrex.md b/docs/systems/vectrex.md new file mode 100644 index 0000000..73dd559 --- /dev/null +++ b/docs/systems/vectrex.md @@ -0,0 +1,12 @@ + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/systems/vic20.md b/docs/systems/vic20.md new file mode 100644 index 0000000..9ce457a --- /dev/null +++ b/docs/systems/vic20.md @@ -0,0 +1,19 @@ + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/systems/videopac.md b/docs/systems/videopac.md new file mode 100644 index 0000000..89127da --- /dev/null +++ b/docs/systems/videopac.md @@ -0,0 +1,23 @@ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/systems/virtualboy.md b/docs/systems/virtualboy.md new file mode 100644 index 0000000..c07861f --- /dev/null +++ b/docs/systems/virtualboy.md @@ -0,0 +1,15 @@ + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/systems/wii.md b/docs/systems/wii.md new file mode 100644 index 0000000..a48e6f0 --- /dev/null +++ b/docs/systems/wii.md @@ -0,0 +1,10 @@ + + + + + + + + + + \ No newline at end of file diff --git a/docs/systems/wiiu.md b/docs/systems/wiiu.md new file mode 100644 index 0000000..f20f4ca --- /dev/null +++ b/docs/systems/wiiu.md @@ -0,0 +1,12 @@ + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/systems/wonderswan.md b/docs/systems/wonderswan.md new file mode 100644 index 0000000..51c4c26 --- /dev/null +++ b/docs/systems/wonderswan.md @@ -0,0 +1,16 @@ + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/systems/wonderswancolor.md b/docs/systems/wonderswancolor.md new file mode 100644 index 0000000..2cc1f90 --- /dev/null +++ b/docs/systems/wonderswancolor.md @@ -0,0 +1,21 @@ + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/systems/x1.md b/docs/systems/x1.md new file mode 100644 index 0000000..b3a91cc --- /dev/null +++ b/docs/systems/x1.md @@ -0,0 +1 @@ +Sharp_X1_logo \ No newline at end of file diff --git a/docs/systems/x68000.md b/docs/systems/x68000.md new file mode 100644 index 0000000..f99c6b1 --- /dev/null +++ b/docs/systems/x68000.md @@ -0,0 +1,13 @@ + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/systems/xbox.md b/docs/systems/xbox.md new file mode 100644 index 0000000..1371869 --- /dev/null +++ b/docs/systems/xbox.md @@ -0,0 +1,7 @@ + + + + + + + \ No newline at end of file diff --git a/docs/systems/zmachine.md b/docs/systems/zmachine.md new file mode 100644 index 0000000..4eba758 --- /dev/null +++ b/docs/systems/zmachine.md @@ -0,0 +1,10 @@ + + + + + + + + + + \ No newline at end of file diff --git a/docs/systems/zx81.md b/docs/systems/zx81.md new file mode 100644 index 0000000..22caafe --- /dev/null +++ b/docs/systems/zx81.md @@ -0,0 +1,17 @@ + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/systems/zxspectrum.md b/docs/systems/zxspectrum.md new file mode 100644 index 0000000..33e135b --- /dev/null +++ b/docs/systems/zxspectrum.md @@ -0,0 +1,29 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..7e4e71e --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,178 @@ +site_name: JELOS Wiki +site_url: https://jelos.org +repo_url: https://github.com/JustEnoughLinuxOS/jelos.org +repo_name: jelos.org +copyright: Copyright Creative Commons Attribution-ShareAlike 4.0 International +theme: + language: en + name: material + logo: _inc/images/logo.png + palette: + # Palette toggle for light mode + - media: "(prefers-color-scheme: light)" + scheme: art-book + toggle: + icon: material/brightness-7 + name: Switch to dark mode + # Palette toggle for dark mode + - media: "(prefers-color-scheme: dark)" + scheme: art-book-next + toggle: + icon: material/brightness-4 + name: Switch to light mode + font: + text: Oxygen + code: Oxygen Mono + features: + - navigation.top + - navigation.instant + - navigation.sections + - navigation.indexes + - toc.follow + - search.suggest + - content.tooltips + - content.code.copy + - content.code.annotate +markdown_extensions: + - tables + - attr_list + - pymdownx.emoji: + emoji_index: !!python/name:materialx.emoji.twemoji + emoji_generator: !!python/name:materialx.emoji.to_svg + - admonition + - pymdownx.details + - pymdownx.superfences + - toc: + toc_depth: 2 + - pymdownx.highlight: + anchor_linenums: true + line_spans: __span + pygments_lang_class: true + - pymdownx.inlinehilite + - pymdownx.snippets + - pymdownx.superfences +extra_css: + - _inc/css/custom.css +extra: + social: + - icon: fontawesome/brands/github + link: https://github.com/JustEnoughLinuxOS/distribution + - icon: fontawesome/brands/discord + link: https://discord.gg/seTxckZjJy +plugins: + - search + - glightbox +nav: + - Home: index.md + - FAQs: faqs.md + - Donations: donations.md + - Play: + - Install: play/install.md + - Update: play/update.md + - Hotkeys: play/hotkeys.md + - Contribute: + - contribute/index.md + - Code of Conduct: contribute/code-of-conduct.md + - Build: contribute/build.md + - Modify: contribute/modify.md + - Quirks: contribute/quirks.md + - Packages: contribute/packages.md + - Systems: + #- systems/index.md + - Arcade: + #- systems/arcade/index.md + - Atomiswave: systems/atomiswave.md + - CPS1: systems/cps1.md + - CPS2: systems/cps2.md + - CPS3: systems/cps3.md + - Daphne: systems/daphne.md + - Final Burn Neo: systems/fbn.md + - M.A.M.E.: systems/mame.md + - Naomi: systems/naomi.md + - Neo Geo: systems/neogeo.md + - Consoles: + - Amiga CD32: systems/amigacd32.md + - Atari 2600: systems/atari2600.md + - Atari 5200: systems/atari5200.md + - Atari 7800: systems/atari7800.md + - Atari Jaguar: systems/atarijaguar.md + - ColecoVision: systems/colecovision.md + - Fairchild Channel F: systems/channelf.md + - Mattel Intellivision: systems/intellivision.md + - Magnavox Odyssey 2: systems/odyssey2.md + - Nintendo Famicom: systems/famicom.md + - Nintendo Entertainment System: systems/nes.md + - Nintendo 64: systems/n64.md + - Nintendo Gamecube: systems/gc.md + - Panasonic 3DO: systems/3do.md + - Sega Master System: systems/mastersystem.md + - Sega Genesis / Megadrive: systems/genesis.md + - Sega Dreamcast: systems/dreamcast.md + - SNK Neo Geo: systems/neogeo.md + - SNK Neo Geo CD: systems/neogeocd.md + - Portables: + - Arduboy: systems/arduboy.md + - Atari Lynx: systems/atarilynx.md + - Mega Duck: systems/megaduck.md + - Nintendo DS: systems/nds.md + - Nintendo 3DS: systems/3ds.md + - Nintendo Game & Watch: systems/gameandwatch.md + - Nintendo Gameboy: systems/gb.md + - Nintendo Gameboy Advance: systems/gba.md + - Nintendo Gameboy Color: systems/gbc.md + - Sega Game Gear: systems/gamegear.md + - SNK Neo Geo Pocket: systems/ngp.md + - Computers: + - Amiga: systems/amiga.md + - Amstrad CPC: systems/amstradcpc.md + - Atari 800: systems/atari800.md + - Atari ST: systems/atarist.md + - Commodore 16: systems/c16.md + - Commodore 64: systems/c64.md + - Commodore 128: systems/c128.md + - MSX: systems/msx.md + - Engines: + - Doom: systems/doom.md + - EasyRPG: systems/easyrpg.md + - J2ME: systems/j2me.md + - Open Beats of Rage: systems/openbor.md + - Other: + - Moonlight: systems/moonlight.md + - MPlayer: systems/mplayer.md + - Music Player: systems/music.md + - Supported Devices: + - supported-devices/index.md + - Anbernic: + - RG351 [P/M]: supported-devices/anbernic/rg351pm.md + - RG353 [P/M/V/VS]: supported-devices/anbernic/rg353pmvvs.md + - RG503: supported-devices/anbernic/rg503.md + - RG552: supported-devices/anbernic/rg552.md + - Win600: supported-devices/anbernic/win600.md + - AOKZOE: + - A1 Pro: supported-devices/aokzoe/a1-pro.md + - Atari: + - VCS: supported-devices/atari/vcs.md + - AYANEO: + - Air / Air Pro: supported-devices/ayaneo/air.md + - Air Plus: supported-devices/ayaneo/air-plus.md + - AYANEO 2: supported-devices/ayaneo/ayaneo-2.md + - AYN: + - Loki Zero: supported-devices/ayn/loki-zero.md + - Loki Max: supported-devices/ayn/loki-max.md + - GPD: + - Win 4: supported-devices/gpd/win4.md + - Win Max 2: supported-devices/gpd/win-max-2.md + - Hardkernel: + - Odroid Go Advance: supported-devices/hardkernel/odroid-go-advance.md + - Odroid Go Super: supported-devices/hardkernel/odroid-go-super.md + - Odroid Go Ultra: supported-devices/hardkernel/odroid-go-ultra.md + - Indiedroid: + - Nova: supported-devices/indiedroid/nova.md + - Orange Pi: + - Orange Pi 5: supported-devices/orange-pi/orange-pi-5.md + - Powkiddy: + - RGB10 Max 3 Pro: supported-devices/powkiddy/rgb10-max-3-pro.md + - RGB30: supported-devices/powkiddy/rgb30.md + - RK2023: supported-devices/powkiddy/rk2023.md + - x55: supported-devices/powkiddy/x55.md + \ No newline at end of file