diff --git a/LICENSE.MD b/LICENSE.MD index c1d8d1d5..806424f2 100644 --- a/LICENSE.MD +++ b/LICENSE.MD @@ -56,6 +56,18 @@ The Launcher consists of the following files, and any later version of them: Distributing the Launcher together with this program is permitted only in unmodified official releases from BOIS CLUB GAMES, LLC. +### PortMaster distribution permission + +As an exception to the Launcher distribution restriction above, BOIS CLUB +GAMES, LLC grants permission to distribute the Launcher with this program +through PortMaster, including the PortMaster-MV repository and its release +packages. This permission covers PortMaster packaging and launch scripts; +it does not grant a general right to reuse or modify the proprietary Launcher +in other projects. Retain this license and the attribution required above. + +This exception records the explicit PortMaster permission granted by project +owner bryanthaboi on 6 October 2026. All other terms remain unchanged. + ### 3. Names and marks (Section 7(e)) This license grants no rights to use the names, logos, or trademarks of BOIS diff --git a/docs/portmaster-submission.md b/docs/portmaster-submission.md new file mode 100644 index 00000000..e56555bc --- /dev/null +++ b/docs/portmaster-submission.md @@ -0,0 +1,73 @@ +# PortMaster submission + +Status: testing candidate; not accepted into the catalogue. +Destination: https://github.com/PortsMaster-MV/PortMaster-MV-New +Current requirements: https://portmaster.games/packaging.html + +## Permission + +On 6 October 2026, project owner bryanthaboi replied “Explicit permission +granted” to Nexhas's request to permit PortMaster distribution of the proprietary +launcher. The supplied private-message screenshot is retained by the requester; +it is not bundled or published. LICENSE.MD records the narrow distribution +exception. The original attribution and other launcher restrictions remain. + +## Build and validate + +```sh +python3 scripts/portmaster/package.py --version X.Y.Z --screenshot /absolute/gameplay.png +python3 scripts/portmaster/test_launcher.py +luajit tests/engine/portmaster_managed_update_test.lua +``` + +Use a clean, committed source revision; SOURCE.txt records that revision and +whether tracked changes were present. X.Y.Z identifies the engine version, not +PortMaster approval. The ZIP is explicitly named `gen1recomp-testing.zip`. +The screenshot must show the actual unmodified base game or main function, +not a mod absent from the package. A desktop capture is presentation evidence, +not ARM device validation. Do not commit ROMs or extracted caches. + +Copy `dist/portmaster/ports/gen1recomp/` into `ports/` in a sparse checkout of +PortMaster-MV-New. Run its `python3 tools/build_release.py --do-check` and +`python3 tools/build_release.py --quick-build gen1recomp`. +The repository-built ZIP is preferred for community testing. + +## Hardware evidence + +- Existing standalone SBC build: Nexhas reports it worked on TrimUI Brick. +- Firmware/version and exact build for that report: not yet recorded. +- Catalogue testing ZIP: Nexhas confirmed it works on TrimUI Brick on + 6 October 2026, after testing the candidate supplied in this chat. +- Tested candidate source: `fce5f08650618846ae35142475441ac65937fd2f`. +- Supplied ZIP SHA-256: `7298d2720cf4701f48d5fd31b5f27d03f1351375730e0d0c11cb47553c3ce519`. +- Firmware/version and individual import/save, exit and suspend checks for the + catalogue test: not yet specified; the report confirms general operation. +- Discord #testing-n-dev thread: not yet created. + +Record build SHA/checksum, firmware/version, device and resolution with each +result. Check cold launch, missing/wrong ROM handling, import, controls, +new game, save/reload, exit shortcut, suspend/resume, offline play, and an +update preserving saves. Test 640x480 and a higher resolution; request help +for AmberELEC, dArkOS/ArkOS, muOS, ROCKNIX (Libmali/Panfrost), and Knulli. +Keep untested cells unchecked. The Brick confirmation applies to the candidate +identified above; it does not establish compatibility with other firmware. + +## Testing-thread draft + +Title: Gen1Recomp — aarch64 LÖVE port testing + +I'm preparing Gen1Recomp for PortMaster-MV. It is a native recreation which +extracts assets from a user-supplied supported US ROM; no ROMs or generated +cache are included. The project owner has explicitly permitted PortMaster +distribution of the launcher, recorded in the included license. + +I tested this catalogue candidate on my TrimUI Brick and confirmed it works. +It uses PortMaster's LÖVE 11.5 runtime. I'm looking +for testing on the firmware and resolutions listed above, especially import, +save/reload, controller exit and suspend/resume. Please include device, +firmware, package checksum, result and `gen1recomp/log.txt` when reporting a +problem. Do not upload ROMs, saves, or generated cache in reports. + +Attach the validated testing ZIP and its SHA-256. Add the thread URL here once +posted. Submit the upstream PR after community testing, with the source +revision, build instructions, permission note and honest testing matrix. diff --git a/scripts/portmaster/Gen1Recomp.sh b/scripts/portmaster/Gen1Recomp.sh new file mode 100644 index 00000000..54c7fea7 --- /dev/null +++ b/scripts/portmaster/Gen1Recomp.sh @@ -0,0 +1,41 @@ +#!/bin/bash +# Gen1Recomp catalogue launcher; runtime and exit shortcut supplied by PortMaster. +XDG_DATA_HOME=${XDG_DATA_HOME:-$HOME/.local/share} +if [ -d /opt/system/Tools/PortMaster ]; then + controlfolder=/opt/system/Tools/PortMaster +elif [ -d /opt/tools/PortMaster ]; then + controlfolder=/opt/tools/PortMaster +elif [ -d "$XDG_DATA_HOME/PortMaster" ]; then + controlfolder="$XDG_DATA_HOME/PortMaster" +else + controlfolder=/roms/ports/PortMaster +fi +source "$controlfolder/control.txt" || exit 1 +[ -f "$controlfolder/mod_${CFW_NAME}.txt" ] && source "$controlfolder/mod_${CFW_NAME}.txt" +get_controls + +SHDIR="$(cd "$(dirname "$0")" && pwd)" +GAMEDIR="$SHDIR/gen1recomp" +CONFDIR="$GAMEDIR/conf" +mkdir -p "$CONFDIR" +cd "$GAMEDIR" || exit 1 +exec >"$GAMEDIR/log.txt" 2>&1 +export XDG_DATA_HOME="$CONFDIR" +export XDG_CONFIG_HOME="$CONFDIR" +export SDL_GAMECONTROLLERCONFIG="$sdl_controllerconfig" +export POKEPORT_HANDHELD=1 +export POKEPORT_PORTMASTER=1 +export POKEPORT_PORTMASTER_MANAGED=1 +export NINTENDO_LAYOUT=1 +export POKEPORT_AUDIO_RATE=22050 +export POKEPORT_IDLE_AFTER=10 +export POKEPORT_IDLE_FPS=6 +export LOVE_GRAPHICS_USE_OPENGLES=1 + +source "$controlfolder/runtimes/love_11.5/love.txt" || exit 1 +$GPTOKEYB "$LOVE_GPTK" & +trap 'pm_finish' EXIT +pm_platform_helper "$LOVE_BINARY" +# LOVE_RUN intentionally contains the runtime command and its environment. +$LOVE_RUN "$GAMEDIR/lovegame" +exit $? diff --git a/scripts/portmaster/README.md b/scripts/portmaster/README.md new file mode 100644 index 00000000..1aea8fb0 --- /dev/null +++ b/scripts/portmaster/README.md @@ -0,0 +1,65 @@ +## Notes + +Gen1Recomp is a native LÖVE recreation using assets extracted locally from a +player-supplied, supported canonical US ROM. No ROM or generated cache is included. + +Based on the Pokemon Gen 1 Recompilation Project by BOIS CLUB GAMES, LLC +(https://github.com/bryanthaboi/gen1recomp). +Thanks to BOIS CLUB GAMES, LLC for the engine and permission to distribute the +launcher through PortMaster, and to the PortMaster team for the LÖVE runtime. +PortMaster packaging: Nexhas28. + +## Installation + +Install the port and keep PortMaster up to date (LÖVE 11.5 is required). +Copy your supported US ROM into `ports/gen1recomp/lovegame/`, launch +**Gen1Recomp**, and use **Choose ROM**. Start testing with Red or Blue. +No ROM download is supplied. The importer verifies the ROM before extraction. + +## Controls + +| Button | Action | +|--|--| +| D-pad | Move / navigate | +| A | Confirm | +| B | Cancel | +| Start | In-game menu | +| L1 / R1 | Launcher tabs | +| PortMaster exit combination | Quit | + +In-game controls can be rebound in OPTIONS → CONTROLS. + +## Saves and updates + +Portable saves and extracted caches live in `gen1recomp/lovegame/`; LÖVE +configuration lives in `gen1recomp/conf/`. Back these up before updating. +Update this catalogue edition through PortMaster. Its launcher disables the +standalone application updater to avoid installing a differently named SBC pack. + +To migrate from the standalone `gen1recomp-sbc` package: back it up, install this +edition, then copy its `lovegame/` and `conf/` contents into the corresponding +new directories **before reinstalling this catalogue package over them**. This +retains user data while restoring the catalogue edition's code. Do not launch +between copying and reinstalling. Do not migrate `updates/` directories. +Keep the original backup until saves have been loaded successfully. + +## Build + +From the source revision recorded in `gen1recomp/SOURCE.txt`: + +```sh +python3 scripts/portmaster/package.py --version X.Y.Z --screenshot /path/to/gameplay.png +``` + +The output under `dist/portmaster/ports/gen1recomp/` is the unpacked submission. +The builder uses the existing shared payload packer; LÖVE is provided by +PortMaster, not bundled again. No native shader-conversion bridge is bundled; +converting new SHADER FX presets on-device is unavailable in this package. + +## Testing status + +Nexhas confirmed the catalogue candidate from source revision `fce5f086` works +on TrimUI Brick on 6 October 2026. Firmware/version and individual import/save, +exit and suspend checks have not been specified. Other devices and firmware +remain unverified. See `docs/portmaster-submission.md` for the candidate checksum +and testing checklist. diff --git a/scripts/portmaster/licenses/CC-BY-4.0.txt b/scripts/portmaster/licenses/CC-BY-4.0.txt new file mode 100644 index 00000000..4ea99c21 --- /dev/null +++ b/scripts/portmaster/licenses/CC-BY-4.0.txt @@ -0,0 +1,395 @@ +Attribution 4.0 International + +======================================================================= + +Creative Commons Corporation ("Creative Commons") is not a law firm and +does not provide legal services or legal advice. Distribution of +Creative Commons public licenses does not create a lawyer-client or +other relationship. Creative Commons makes its licenses and related +information available on an "as-is" basis. Creative Commons gives no +warranties regarding its licenses, any material licensed under their +terms and conditions, or any related information. Creative Commons +disclaims all liability for damages resulting from their use to the +fullest extent possible. + +Using Creative Commons Public Licenses + +Creative Commons public licenses provide a standard set of terms and +conditions that creators and other rights holders may use to share +original works of authorship and other material subject to copyright +and certain other rights specified in the public license below. The +following considerations are for informational purposes only, are not +exhaustive, and do not form part of our licenses. + + Considerations for licensors: Our public licenses are + intended for use by those authorized to give the public + permission to use material in ways otherwise restricted by + copyright and certain other rights. Our licenses are + irrevocable. Licensors should read and understand the terms + and conditions of the license they choose before applying it. + Licensors should also secure all rights necessary before + applying our licenses so that the public can reuse the + material as expected. Licensors should clearly mark any + material not subject to the license. This includes other CC- + licensed material, or material used under an exception or + limitation to copyright. More considerations for licensors: + wiki.creativecommons.org/Considerations_for_licensors + + Considerations for the public: By using one of our public + licenses, a licensor grants the public permission to use the + licensed material under specified terms and conditions. If + the licensor's permission is not necessary for any reason--for + example, because of any applicable exception or limitation to + copyright--then that use is not regulated by the license. Our + licenses grant only permissions under copyright and certain + other rights that a licensor has authority to grant. Use of + the licensed material may still be restricted for other + reasons, including because others have copyright or other + rights in the material. A licensor may make special requests, + such as asking that all changes be marked or described. + Although not required by our licenses, you are encouraged to + respect those requests where reasonable. More considerations + for the public: + wiki.creativecommons.org/Considerations_for_licensees + +======================================================================= + +Creative Commons Attribution 4.0 International Public License + +By exercising the Licensed Rights (defined below), You accept and agree +to be bound by the terms and conditions of this Creative Commons +Attribution 4.0 International Public License ("Public License"). To the +extent this Public License may be interpreted as a contract, You are +granted the Licensed Rights in consideration of Your acceptance of +these terms and conditions, and the Licensor grants You such rights in +consideration of benefits the Licensor receives from making the +Licensed Material available under these terms and conditions. + + +Section 1 -- Definitions. + + a. Adapted Material means material subject to Copyright and Similar + Rights that is derived from or based upon the Licensed Material + and in which the Licensed Material is translated, altered, + arranged, transformed, or otherwise modified in a manner requiring + permission under the Copyright and Similar Rights held by the + Licensor. For purposes of this Public License, where the Licensed + Material is a musical work, performance, or sound recording, + Adapted Material is always produced where the Licensed Material is + synched in timed relation with a moving image. + + b. Adapter's License means the license You apply to Your Copyright + and Similar Rights in Your contributions to Adapted Material in + accordance with the terms and conditions of this Public License. + + c. Copyright and Similar Rights means copyright and/or similar rights + closely related to copyright including, without limitation, + performance, broadcast, sound recording, and Sui Generis Database + Rights, without regard to how the rights are labeled or + categorized. For purposes of this Public License, the rights + specified in Section 2(b)(1)-(2) are not Copyright and Similar + Rights. + + d. Effective Technological Measures means those measures that, in the + absence of proper authority, may not be circumvented under laws + fulfilling obligations under Article 11 of the WIPO Copyright + Treaty adopted on December 20, 1996, and/or similar international + agreements. + + e. Exceptions and Limitations means fair use, fair dealing, and/or + any other exception or limitation to Copyright and Similar Rights + that applies to Your use of the Licensed Material. + + f. Licensed Material means the artistic or literary work, database, + or other material to which the Licensor applied this Public + License. + + g. Licensed Rights means the rights granted to You subject to the + terms and conditions of this Public License, which are limited to + all Copyright and Similar Rights that apply to Your use of the + Licensed Material and that the Licensor has authority to license. + + h. Licensor means the individual(s) or entity(ies) granting rights + under this Public License. + + i. Share means to provide material to the public by any means or + process that requires permission under the Licensed Rights, such + as reproduction, public display, public performance, distribution, + dissemination, communication, or importation, and to make material + available to the public including in ways that members of the + public may access the material from a place and at a time + individually chosen by them. + + j. Sui Generis Database Rights means rights other than copyright + resulting from Directive 96/9/EC of the European Parliament and of + the Council of 11 March 1996 on the legal protection of databases, + as amended and/or succeeded, as well as other essentially + equivalent rights anywhere in the world. + + k. You means the individual or entity exercising the Licensed Rights + under this Public License. Your has a corresponding meaning. + + +Section 2 -- Scope. + + a. License grant. + + 1. Subject to the terms and conditions of this Public License, + the Licensor hereby grants You a worldwide, royalty-free, + non-sublicensable, non-exclusive, irrevocable license to + exercise the Licensed Rights in the Licensed Material to: + + a. reproduce and Share the Licensed Material, in whole or + in part; and + + b. produce, reproduce, and Share Adapted Material. + + 2. Exceptions and Limitations. For the avoidance of doubt, where + Exceptions and Limitations apply to Your use, this Public + License does not apply, and You do not need to comply with + its terms and conditions. + + 3. Term. The term of this Public License is specified in Section + 6(a). + + 4. Media and formats; technical modifications allowed. The + Licensor authorizes You to exercise the Licensed Rights in + all media and formats whether now known or hereafter created, + and to make technical modifications necessary to do so. The + Licensor waives and/or agrees not to assert any right or + authority to forbid You from making technical modifications + necessary to exercise the Licensed Rights, including + technical modifications necessary to circumvent Effective + Technological Measures. For purposes of this Public License, + simply making modifications authorized by this Section 2(a) + (4) never produces Adapted Material. + + 5. Downstream recipients. + + a. Offer from the Licensor -- Licensed Material. Every + recipient of the Licensed Material automatically + receives an offer from the Licensor to exercise the + Licensed Rights under the terms and conditions of this + Public License. + + b. No downstream restrictions. You may not offer or impose + any additional or different terms or conditions on, or + apply any Effective Technological Measures to, the + Licensed Material if doing so restricts exercise of the + Licensed Rights by any recipient of the Licensed + Material. + + 6. No endorsement. Nothing in this Public License constitutes or + may be construed as permission to assert or imply that You + are, or that Your use of the Licensed Material is, connected + with, or sponsored, endorsed, or granted official status by, + the Licensor or others designated to receive attribution as + provided in Section 3(a)(1)(A)(i). + + b. Other rights. + + 1. Moral rights, such as the right of integrity, are not + licensed under this Public License, nor are publicity, + privacy, and/or other similar personality rights; however, to + the extent possible, the Licensor waives and/or agrees not to + assert any such rights held by the Licensor to the limited + extent necessary to allow You to exercise the Licensed + Rights, but not otherwise. + + 2. Patent and trademark rights are not licensed under this + Public License. + + 3. To the extent possible, the Licensor waives any right to + collect royalties from You for the exercise of the Licensed + Rights, whether directly or through a collecting society + under any voluntary or waivable statutory or compulsory + licensing scheme. In all other cases the Licensor expressly + reserves any right to collect such royalties. + + +Section 3 -- License Conditions. + +Your exercise of the Licensed Rights is expressly made subject to the +following conditions. + + a. Attribution. + + 1. If You Share the Licensed Material (including in modified + form), You must: + + a. retain the following if it is supplied by the Licensor + with the Licensed Material: + + i. identification of the creator(s) of the Licensed + Material and any others designated to receive + attribution, in any reasonable manner requested by + the Licensor (including by pseudonym if + designated); + + ii. a copyright notice; + + iii. a notice that refers to this Public License; + + iv. a notice that refers to the disclaimer of + warranties; + + v. a URI or hyperlink to the Licensed Material to the + extent reasonably practicable; + + b. indicate if You modified the Licensed Material and + retain an indication of any previous modifications; and + + c. indicate the Licensed Material is licensed under this + Public License, and include the text of, or the URI or + hyperlink to, this Public License. + + 2. You may satisfy the conditions in Section 3(a)(1) in any + reasonable manner based on the medium, means, and context in + which You Share the Licensed Material. For example, it may be + reasonable to satisfy the conditions by providing a URI or + hyperlink to a resource that includes the required + information. + + 3. If requested by the Licensor, You must remove any of the + information required by Section 3(a)(1)(A) to the extent + reasonably practicable. + + 4. If You Share Adapted Material You produce, the Adapter's + License You apply must not prevent recipients of the Adapted + Material from complying with this Public License. + + +Section 4 -- Sui Generis Database Rights. + +Where the Licensed Rights include Sui Generis Database Rights that +apply to Your use of the Licensed Material: + + a. for the avoidance of doubt, Section 2(a)(1) grants You the right + to extract, reuse, reproduce, and Share all or a substantial + portion of the contents of the database; + + b. if You include all or a substantial portion of the database + contents in a database in which You have Sui Generis Database + Rights, then the database in which You have Sui Generis Database + Rights (but not its individual contents) is Adapted Material; and + + c. You must comply with the conditions in Section 3(a) if You Share + all or a substantial portion of the contents of the database. + +For the avoidance of doubt, this Section 4 supplements and does not +replace Your obligations under this Public License where the Licensed +Rights include other Copyright and Similar Rights. + + +Section 5 -- Disclaimer of Warranties and Limitation of Liability. + + a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE + EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS + AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF + ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS, + IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION, + WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR + PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS, + ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT + KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT + ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU. + + b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE + TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION, + NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT, + INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES, + COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR + USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN + ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR + DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR + IN PART, THIS LIMITATION MAY NOT APPLY TO YOU. + + c. The disclaimer of warranties and limitation of liability provided + above shall be interpreted in a manner that, to the extent + possible, most closely approximates an absolute disclaimer and + waiver of all liability. + + +Section 6 -- Term and Termination. + + a. This Public License applies for the term of the Copyright and + Similar Rights licensed here. However, if You fail to comply with + this Public License, then Your rights under this Public License + terminate automatically. + + b. Where Your right to use the Licensed Material has terminated under + Section 6(a), it reinstates: + + 1. automatically as of the date the violation is cured, provided + it is cured within 30 days of Your discovery of the + violation; or + + 2. upon express reinstatement by the Licensor. + + For the avoidance of doubt, this Section 6(b) does not affect any + right the Licensor may have to seek remedies for Your violations + of this Public License. + + c. For the avoidance of doubt, the Licensor may also offer the + Licensed Material under separate terms or conditions or stop + distributing the Licensed Material at any time; however, doing so + will not terminate this Public License. + + d. Sections 1, 5, 6, 7, and 8 survive termination of this Public + License. + + +Section 7 -- Other Terms and Conditions. + + a. The Licensor shall not be bound by any additional or different + terms or conditions communicated by You unless expressly agreed. + + b. Any arrangements, understandings, or agreements regarding the + Licensed Material not stated herein are separate from and + independent of the terms and conditions of this Public License. + + +Section 8 -- Interpretation. + + a. For the avoidance of doubt, this Public License does not, and + shall not be interpreted to, reduce, limit, restrict, or impose + conditions on any use of the Licensed Material that could lawfully + be made without permission under this Public License. + + b. To the extent possible, if any provision of this Public License is + deemed unenforceable, it shall be automatically reformed to the + minimum extent necessary to make it enforceable. If the provision + cannot be reformed, it shall be severed from this Public License + without affecting the enforceability of the remaining terms and + conditions. + + c. No term or condition of this Public License will be waived and no + failure to comply consented to unless expressly agreed to by the + Licensor. + + d. Nothing in this Public License constitutes or may be interpreted + as a limitation upon, or waiver of, any privileges and immunities + that apply to the Licensor or You, including from the legal + processes of any jurisdiction or authority. + + +======================================================================= + +Creative Commons is not a party to its public +licenses. Notwithstanding, Creative Commons may elect to apply one of +its public licenses to material it publishes and in those instances +will be considered the “Licensor.” The text of the Creative Commons +public licenses is dedicated to the public domain under the CC0 Public +Domain Dedication. Except for the limited purpose of indicating that +material is shared under a Creative Commons public license or as +otherwise permitted by the Creative Commons policies published at +creativecommons.org/policies, Creative Commons does not authorize the +use of the trademark "Creative Commons" or any other trademark or logo +of Creative Commons without its prior written consent including, +without limitation, in connection with any unauthorized modifications +to any of its public licenses or any other arrangements, +understandings, or agreements concerning use of licensed material. For +the avoidance of doubt, this paragraph does not form part of the +public licenses. + +Creative Commons may be contacted at creativecommons.org. diff --git a/scripts/portmaster/licenses/CC0-1.0.txt b/scripts/portmaster/licenses/CC0-1.0.txt new file mode 100644 index 00000000..0e259d42 --- /dev/null +++ b/scripts/portmaster/licenses/CC0-1.0.txt @@ -0,0 +1,121 @@ +Creative Commons Legal Code + +CC0 1.0 Universal + + CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE + LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN + ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS + INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES + REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS + PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM + THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED + HEREUNDER. + +Statement of Purpose + +The laws of most jurisdictions throughout the world automatically confer +exclusive Copyright and Related Rights (defined below) upon the creator +and subsequent owner(s) (each and all, an "owner") of an original work of +authorship and/or a database (each, a "Work"). + +Certain owners wish to permanently relinquish those rights to a Work for +the purpose of contributing to a commons of creative, cultural and +scientific works ("Commons") that the public can reliably and without fear +of later claims of infringement build upon, modify, incorporate in other +works, reuse and redistribute as freely as possible in any form whatsoever +and for any purposes, including without limitation commercial purposes. +These owners may contribute to the Commons to promote the ideal of a free +culture and the further production of creative, cultural and scientific +works, or to gain reputation or greater distribution for their Work in +part through the use and efforts of others. + +For these and/or other purposes and motivations, and without any +expectation of additional consideration or compensation, the person +associating CC0 with a Work (the "Affirmer"), to the extent that he or she +is an owner of Copyright and Related Rights in the Work, voluntarily +elects to apply CC0 to the Work and publicly distribute the Work under its +terms, with knowledge of his or her Copyright and Related Rights in the +Work and the meaning and intended legal effect of CC0 on those rights. + +1. Copyright and Related Rights. A Work made available under CC0 may be +protected by copyright and related or neighboring rights ("Copyright and +Related Rights"). Copyright and Related Rights include, but are not +limited to, the following: + + i. the right to reproduce, adapt, distribute, perform, display, + communicate, and translate a Work; + ii. moral rights retained by the original author(s) and/or performer(s); +iii. publicity and privacy rights pertaining to a person's image or + likeness depicted in a Work; + iv. rights protecting against unfair competition in regards to a Work, + subject to the limitations in paragraph 4(a), below; + v. rights protecting the extraction, dissemination, use and reuse of data + in a Work; + vi. database rights (such as those arising under Directive 96/9/EC of the + European Parliament and of the Council of 11 March 1996 on the legal + protection of databases, and under any national implementation + thereof, including any amended or successor version of such + directive); and +vii. other similar, equivalent or corresponding rights throughout the + world based on applicable law or treaty, and any national + implementations thereof. + +2. Waiver. To the greatest extent permitted by, but not in contravention +of, applicable law, Affirmer hereby overtly, fully, permanently, +irrevocably and unconditionally waives, abandons, and surrenders all of +Affirmer's Copyright and Related Rights and associated claims and causes +of action, whether now known or unknown (including existing as well as +future claims and causes of action), in the Work (i) in all territories +worldwide, (ii) for the maximum duration provided by applicable law or +treaty (including future time extensions), (iii) in any current or future +medium and for any number of copies, and (iv) for any purpose whatsoever, +including without limitation commercial, advertising or promotional +purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each +member of the public at large and to the detriment of Affirmer's heirs and +successors, fully intending that such Waiver shall not be subject to +revocation, rescission, cancellation, termination, or any other legal or +equitable action to disrupt the quiet enjoyment of the Work by the public +as contemplated by Affirmer's express Statement of Purpose. + +3. Public License Fallback. Should any part of the Waiver for any reason +be judged legally invalid or ineffective under applicable law, then the +Waiver shall be preserved to the maximum extent permitted taking into +account Affirmer's express Statement of Purpose. In addition, to the +extent the Waiver is so judged Affirmer hereby grants to each affected +person a royalty-free, non transferable, non sublicensable, non exclusive, +irrevocable and unconditional license to exercise Affirmer's Copyright and +Related Rights in the Work (i) in all territories worldwide, (ii) for the +maximum duration provided by applicable law or treaty (including future +time extensions), (iii) in any current or future medium and for any number +of copies, and (iv) for any purpose whatsoever, including without +limitation commercial, advertising or promotional purposes (the +"License"). The License shall be deemed effective as of the date CC0 was +applied by Affirmer to the Work. Should any part of the License for any +reason be judged legally invalid or ineffective under applicable law, such +partial invalidity or ineffectiveness shall not invalidate the remainder +of the License, and in such case Affirmer hereby affirms that he or she +will not (i) exercise any of his or her remaining Copyright and Related +Rights in the Work or (ii) assert any associated claims and causes of +action with respect to the Work, in either case contrary to Affirmer's +express Statement of Purpose. + +4. Limitations and Disclaimers. + + a. No trademark or patent rights held by Affirmer are waived, abandoned, + surrendered, licensed or otherwise affected by this document. + b. Affirmer offers the Work as-is and makes no representations or + warranties of any kind concerning the Work, express, implied, + statutory or otherwise, including without limitation warranties of + title, merchantability, fitness for a particular purpose, non + infringement, or the absence of latent or other defects, accuracy, or + the present or absence of errors, whether or not discoverable, all to + the greatest extent permissible under applicable law. + c. Affirmer disclaims responsibility for clearing rights of other persons + that may apply to the Work or any use thereof, including without + limitation any person's Copyright and Related Rights in the Work. + Further, Affirmer disclaims responsibility for obtaining any necessary + consents, permissions or other rights required for any use of the + Work. + d. Affirmer understands and acknowledges that Creative Commons is not a + party to this document and has no duty or obligation with respect to + this CC0 or use of the Work. diff --git a/scripts/portmaster/package.py b/scripts/portmaster/package.py new file mode 100644 index 00000000..c4ada562 --- /dev/null +++ b/scripts/portmaster/package.py @@ -0,0 +1,104 @@ +#!/usr/bin/env python3 +"""Build the ROM-free PortMaster catalogue submission from this checkout.""" +import argparse +import datetime +import json +from pathlib import Path +import re +import shutil +import subprocess +import zipfile + +ROOT = Path(__file__).resolve().parents[2] + +def main(): + parser = argparse.ArgumentParser(description=__doc__) + parser.add_argument("--version", required=True) + parser.add_argument("--screenshot", type=Path, required=True) + args = parser.parse_args() + if not re.fullmatch(r"[0-9]+\.[0-9]+\.[0-9]+", args.version): + parser.error("version must be X.Y.Z") + screenshot = args.screenshot.resolve() + if not screenshot.is_file() or screenshot.suffix.lower() not in (".png", ".jpg"): + parser.error("screenshot must be an existing PNG or JPG gameplay capture") + output = ROOT / "dist/portmaster" + port = output / "ports/gen1recomp" + if port.exists(): + shutil.rmtree(port) + game = port / "gen1recomp" + game.mkdir(parents=True) + payload = output / "game.love" + subprocess.run([str(ROOT / "scripts/pack_love.sh"), "--output", str(payload), + "--listing", str(output / "payload-listing.txt"), + "--version", args.version], check=True) + with zipfile.ZipFile(payload) as archive: + for name in archive.namelist(): + path = Path(name) + if (path.is_absolute() or ".." in path.parts + or path.suffix.lower() in (".gb", ".gbc", ".gba", ".sav", ".srm", ".bak") + or "generated" in path.parts or "updates" in path.parts): + raise SystemExit(f"Private/generated payload entry rejected: {name}") + archive.extractall(game / "lovegame") + # These development helpers are not used by the game and cause firmware + # frontends to discover extra launch entries inside the port directory. + for helper in ("src/import/gba/install_local_rom.sh", + "src/import/gba/chrome/vendor_ui.sh"): + (game / "lovegame" / helper).unlink(missing_ok=True) + (game / "lovegame/portable.txt").touch() + licenses = game / "licenses" + licenses.mkdir() + shutil.copy2(ROOT / "LICENSE.MD", licenses / "LICENSE.MD") + shutil.copy2(ROOT / "assets/launcher/lucide/LICENSE", licenses / "lucide.txt") + for notice in (ROOT / "scripts/portmaster/licenses").glob("*.txt"): + shutil.copy2(notice, licenses / notice.name) + for notice in ("fonts/plainpixel", "skins/gba_purple", "skins/gb_anim", + "skins/tv_crt", "touch", "game3"): + shutil.copy2(ROOT / "assets" / notice / "README.md", + licenses / (notice.replace("/", "-") + ".md")) + revision = subprocess.check_output(["git", "rev-parse", "HEAD"], cwd=ROOT, text=True).strip() + dirty = bool(subprocess.check_output(["git", "status", "--porcelain", "--untracked-files=no"], cwd=ROOT)) + (game / "SOURCE.txt").write_text( + f"https://github.com/bryanthaboi/gen1recomp\nRevision: {revision}\n" + f"Version: {args.version}\nTracked working-tree changes: {dirty}\n" + "Testing candidate; hardware validation pending.\n") + for name in ("Gen1Recomp.sh", "README.md"): + shutil.copy2(ROOT / "scripts/portmaster" / name, port / name) + (port / "Gen1Recomp.sh").chmod(0o755) + shutil.copy2(screenshot, port / ("screenshot" + screenshot.suffix.lower())) + metadata = { + "version": 4, "name": "gen1recomp.zip", + "items": ["Gen1Recomp.sh", "gen1recomp"], "items_opt": [], + "attr": {"title": "Gen1Recomp", "porter": ["Nexhas28"], + "desc": "Native Pokemon recreation in LÖVE. Requires your own supported US ROM; no ROM is included.", + "desc_md": None, + "inst": "Copy a supported canonical US ROM into gen1recomp/lovegame/, then launch and choose the ROM. Start with Red or Blue. Update through PortMaster.", + "inst_md": None, "genres": ["adventure", "rpg"], "image": None, + "rtr": False, "exp": False, "runtime": [], "store": [], + "reqs": [], "arch": ["aarch64"], "min_glibc": ""}} + (port / "port.json").write_text(json.dumps(metadata, indent=4) + "\n") + date = datetime.date.today().strftime("%Y%m%d") + (port / "gameinfo.xml").write_text(f''' + +./Gen1Recomp.shGen1Recomp +Native Pokemon recreation. Supply your own supported US ROM. +Based on the Pokemon Gen 1 Recompilation Project by BOIS CLUB GAMES, LLC +(https://github.com/bryanthaboi/gen1recomp) +{date}T000000BOIS CLUB GAMES, LLC +BOIS CLUB GAMES, LLCRPG +./gen1recomp/screenshot{screenshot.suffix.lower()} + +''') + with zipfile.ZipFile(output / "gen1recomp-testing.zip", "w", zipfile.ZIP_DEFLATED) as archive: + for path in sorted(port.rglob("*")): + if path.is_file(): + relative = path.relative_to(port) + # Match PortMaster's build_release.py install layout. + if len(relative.parts) == 1 and relative.name != "Gen1Recomp.sh": + name = "gen1recomp.md" if relative.name == "README.md" else relative.name + relative = Path("gen1recomp") / name + archive.write(path, relative) + print(port) + print(output / "gen1recomp-testing.zip") + +if __name__ == "__main__": + main() diff --git a/scripts/portmaster/test_launcher.py b/scripts/portmaster/test_launcher.py new file mode 100644 index 00000000..8dd738f6 --- /dev/null +++ b/scripts/portmaster/test_launcher.py @@ -0,0 +1,49 @@ +#!/usr/bin/env python3 +"""Exercise launcher ordering, paths with spaces, exit status and cleanup.""" +import os +from pathlib import Path +import shutil +import subprocess +import tempfile + +SOURCE = Path(__file__).with_name("Gen1Recomp.sh") +with tempfile.TemporaryDirectory(prefix="portmaster launcher ") as tmp: + root = Path(tmp) + control = root / "PortMaster" + runtime = control / "runtimes/love_11.5" + runtime.mkdir(parents=True) + port = root / "ports/gen1recomp" + (port / "lovegame").mkdir(parents=True) + trace = root / "trace" + (control / "control.txt").write_text('''CFW_NAME=test +DEVICE_ARCH=aarch64 +get_controls() { echo controls >> "$TRACE"; sdl_controllerconfig=testpad; } +pm_platform_helper() { echo helper >> "$TRACE"; } +pm_finish() { echo finish >> "$TRACE"; } +GPTOKEYB=true +''') + (control / "mod_test.txt").write_text('echo cfw >> "$TRACE"\n') + binary = runtime / "love.aarch64" + binary.write_text('''#!/bin/bash +[ "$POKEPORT_PORTMASTER_MANAGED" = 1 ] || exit 90 +[ "$SDL_GAMECONTROLLERCONFIG" = testpad ] || exit 91 +[ -d "$1" ] || exit 92 +echo game >> "$TRACE" +exit 7 +''') + binary.chmod(0o755) + # Real LOVE_RUN is a shell word list; use a space-free command with quoted + # execution inside the fake runtime function to test the GAME directory. + (runtime / "love.txt").write_text('''LOVE_BINARY="$RUNTIME_BINARY" +LOVE_GPTK=love.aarch64 +run_love() { "$LOVE_BINARY" "$@"; } +LOVE_RUN=run_love +''') + launcher = root / "ports/Gen1Recomp.sh" + shutil.copy2(SOURCE, launcher) + env = dict(os.environ, XDG_DATA_HOME=str(root), TRACE=str(trace), + RUNTIME_BINARY=str(binary)) + result = subprocess.run(["bash", str(launcher)], env=env) + assert result.returncode == 7, result.returncode + assert trace.read_text().splitlines() == ["cfw", "controls", "helper", "game", "finish"] + print("PASS launcher: CFW/controls order, spaced game path, managed updates, exit status, cleanup") diff --git a/src/core/Prelaunch.lua b/src/core/Prelaunch.lua index 1c852c0b..d8eedbe6 100644 --- a/src/core/Prelaunch.lua +++ b/src/core/Prelaunch.lua @@ -19,6 +19,8 @@ local function consumeMarker(fs) end local function updateAllowed(opts, fs) + -- Catalogue packages are updated by PortMaster, not the standalone updater. + if os.getenv("POKEPORT_PORTMASTER_MANAGED") == "1" then return false end if opts.allowUpdate ~= nil then return opts.allowUpdate and true or false end local ok, Version = pcall(require, "src.core.Version") if ok and type(Version) == "table" and Version.isDev and Version.isDev() then diff --git a/src/update/Boot.lua b/src/update/Boot.lua index c23e92cb..4456df09 100644 --- a/src/update/Boot.lua +++ b/src/update/Boot.lua @@ -395,6 +395,8 @@ end -- accident. Boot.run and Prelaunch.updateAllowed both ask this one function, -- so the boot gate and the --update gate cannot disagree. function Boot.canUpdateInPlace() + -- Catalogue packages are updated by PortMaster, not the standalone updater. + if os.getenv("POKEPORT_PORTMASTER_MANAGED") == "1" then return false end local fs = love and love.filesystem if not fs then return false end if fs.isFused and fs.isFused() then return true end diff --git a/src/update/Check.lua b/src/update/Check.lua index f3a5e509..9d481e1a 100644 --- a/src/update/Check.lua +++ b/src/update/Check.lua @@ -203,6 +203,7 @@ if persistedRequirement then end local function ensureWorker() + if os.getenv("POKEPORT_PORTMASTER_MANAGED") == "1" then return false end if workerReady ~= nil then return workerReady end if not Platform.networkValidated() then workerReady = false @@ -254,6 +255,8 @@ end -- once a check is in flight or has reached a terminal state it is a no-op unless -- force=true is passed (e.g. from an explicit button press). function Check.start(force) + -- Do not offer standalone SBC archives over a catalogue-managed install. + if os.getenv("POKEPORT_PORTMASTER_MANAGED") == "1" then return end drain() if cache.status == "checking" or cache.status == "downloading" then return end if not force and requested and cache.status ~= "error" and cache.status ~= "idle" then return end @@ -271,6 +274,7 @@ end -- idle | checking | uptodate | available | downloading | ready | needs_full | -- full_downloading | full_ready | error. function Check.state() + if os.getenv("POKEPORT_PORTMASTER_MANAGED") == "1" then return { status = "idle" } end drain() return { status = cache.status or "idle", diff --git a/tests/engine/portmaster_managed_update_test.lua b/tests/engine/portmaster_managed_update_test.lua new file mode 100644 index 00000000..66a7667b --- /dev/null +++ b/tests/engine/portmaster_managed_update_test.lua @@ -0,0 +1,28 @@ +-- Catalogue installs must not download or boot standalone application updates. +package.path = "./?.lua;./?/init.lua;" .. package.path +local T = require("tests.harness") +local Boot = require("src.update.Boot") +local Check = require("src.update.Check") +local Prelaunch = require("src.core.Prelaunch") +local oldEnv, oldLove = os.getenv, _G.love +local enabled = "1" +os.getenv = function(name) + if name == "POKEPORT_PORTMASTER_MANAGED" then return enabled end + return oldEnv(name) +end +local threads = 0 +_G.love = { + filesystem = { isFused = function() return true end }, + thread = { newThread = function() threads = threads + 1; error("must not start") end }, +} +T.eq(Boot.canUpdateInPlace(), false, "managed fused builds cannot chainload") +T.eq(Boot.run({}), false, "managed boot ignores downloaded updates") +Check.start(true) +T.eq(threads, 0, "forced checks do not start the network worker") +T.eq(Check.state().status, "idle", "managed update UI stays idle") +T.eq(Prelaunch.new({ tasks = { update = true, sync = false }, + allowUpdate = true, fs = false }), nil, "prelaunch cannot override package manager") +enabled = "0" +T.eq(Boot.canUpdateInPlace(), true, "standalone fused builds still update") +os.getenv, _G.love = oldEnv, oldLove +T.finish()