diff options
| -rw-r--r-- | .gitignore | 2 | ||||
| -rw-r--r-- | CHANGELOG.md | 3 | ||||
| -rw-r--r-- | CONTRIBUTING.md | 37 | ||||
| -rw-r--r-- | LICENSE | 674 | ||||
| -rw-r--r-- | Makefile | 38 | ||||
| -rw-r--r-- | README.md | 41 | ||||
| -rw-r--r-- | assets/jetpac.chr | bin | 0 -> 8192 bytes | |||
| -rw-r--r-- | assets/session.nss | 613 | ||||
| -rw-r--r-- | config/nrom.cfg | 24 | ||||
| -rw-r--r-- | include/apu.s | 4 | ||||
| -rw-r--r-- | include/globals.s | 34 | ||||
| -rw-r--r-- | include/oam.s | 11 | ||||
| -rw-r--r-- | include/ppu.s | 8 | ||||
| -rw-r--r-- | src/jetpac.s | 86 | ||||
| -rw-r--r-- | src/vectors.s | 109 |
15 files changed, 1684 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..088ff7b --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +out/ +TODO diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..fa7d153 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,3 @@ +# 1.0 + +WIP diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..1606801 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,37 @@ +## Why? + +Do you want to fix an error you have found? Do you know a way to improve my +6502-fu or do you know a technique on NES/Famicom development that might help +here? I am open for discussion and welcome any help! + +## How? + +There are many ways to help me out. One way might be to open an issue on +[Github's tracker](https://github.com/mssola/jetpac.nes/issues) and start a +discussion. For this, mind the following: + +- Check that the issue has not already been reported or fixed in `main`. +- Try to be concise and precise in your description. +- If you have found a problem, provide a step by step guide on how to reproduce it. +- Provide the version you are using (git commit SHA), as well as the version of + the toolchain and the emulator/system being used. + +Another way is to simply submit a pull request. For this, also mind these: + +- Write a [good commit message](https://chris.beams.io/posts/git-commit/). +- You are sure that `make` continues to work. +- The game continues to work. +- The pull request has *only* one subject and a clear title. You are not + submitting a pull request with tons of different unrelated commits. + +## Development cycle + +In order to test your changes, I'd go this way: + +1. Make sure that you have the toolchain installed. For this you can call `make + deps` and it will error out if you are missing anything. +2. Make your changes in the code and run `make`. This will produce the ROM + inside of the `out` directory. +3. Run the ROM that was produced with an emulator of your choosing. Make sure + that things run as expected. + @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see <https://www.gnu.org/licenses/>. + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + <program> Copyright (C) <year> <name of author> + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +<https://www.gnu.org/licenses/>. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +<https://www.gnu.org/licenses/why-not-lgpl.html>. diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..4130ebf --- /dev/null +++ b/Makefile @@ -0,0 +1,38 @@ +V = +ifeq ($(strip $(V)),) + E = @echo + Q = @ +else + E = @\# + Q = +endif + +CC65 ?= cl65 +CCOPTS ?= --target nes + +.PHONY: all +all: clean deps build + +.PHONY: clean +clean: + @rm -rf out + @find . -type f -name "*.o" -delete + @find . -type f -name "*.nes" -delete + @mkdir -p out/ + +.PHONY: deps +deps: + @which $(CC65) >/dev/null 2>/dev/null || (echo "ERROR: $(CC65) not found." && false) + +.PHONY: build +build: build-full build-partial + +.PHONY: build-full +build-full: + $(E) " CC jetpac (full)" + $(Q) $(CC65) $(CCOPTS) src/jetpac.s -C config/nrom.cfg -o out/jetpac.nes + +.PHONY: build-partial +build-partial: + $(E) " CC jetpac (partial)" + $(Q) $(CC65) $(CCOPTS) src/jetpac.s -C config/nrom.cfg --asm-define PARTIAL=1 -o out/partial.nes diff --git a/README.md b/README.md new file mode 100644 index 0000000..e0bfa31 --- /dev/null +++ b/README.md @@ -0,0 +1,41 @@ +This is a port to the NES of the renown +[jetpac](https://en.wikipedia.org/wiki/Jetpac) game from Ultimate Play the Game. +You can find a ROM to play the game in the [releases +page](https://github.com/mssola/jetpac.nes/releases). + +## The game + +The game follows the original as much as possible. Some things had to be adapted +because of hardware differences. For example, the colors are a bit different +because the NES offers a fixed set of them and that's it. Other than small +differences I'm sure that the feel from the game might be a bit different too. +Some of it might be attributed to, again, the nature of the NES, but some other +bit of this can be attributed directly to me. Hence, if you know how to improve +the game (by being closer to the original), [do tell me](./CONTRIBUTING.md)! + +Other than that, the game is a shooter in which you have to re-assemble your +ship's parts and fill it with fuel, all while killing enemies that keep popping +up. The controls are as follows: + +| Button | Action | +|:----------------------------------------------:|:----------------------| +| <kbd>Start</kbd> | Pause/Resume the game | +| <kbd>Select</kbd> | *Not used* | +| <kbd>A</kbd> | Throttle | +| <kbd>B</kbd> | Shoot | +| <kbd>Arrow Left</kbd> & <kbd>Arrow Right</kbd> | Move horizontally | +| <kbd>Arrow up</kbd> | Throttle | +| <kbd>Arrow down</kbd> | *Not used* | + +## [Changelog](https://pbs.twimg.com/media/DJDYCcLXcAA_eIo?format=jpg&name=small) + +Read the [CHANGELOG.md](./CHANGELOG.md) file. + +## License + +The original game was developed and published by Ultimate Play the Game and +released for the ZX Spectrum and VIC-20 in 1983 and the BBC Micro in 1984. Thus, +the original idea is not mine, and I only did the porting to the NES/Famicom +platform. This port is released under the +[GPLv3+](http://www.gnu.org/licenses/gpl-3.0.txt), Copyright (C) 2023-<i>Ω</i> +Miquel Sabaté Solà. diff --git a/assets/jetpac.chr b/assets/jetpac.chr Binary files differnew file mode 100644 index 0000000..2eae737 --- /dev/null +++ b/assets/jetpac.chr diff --git a/assets/session.nss b/assets/session.nss new file mode 100644 index 0000000..769acad --- /dev/null +++ b/assets/session.nss @@ -0,0 +1,613 @@ +NSTssTXT
+
+BtnTiles=1
+BtnChecker=0
+BtnSelTiles=0
+BtnChrBank1=1
+BtnChrBank2=0
+BtnGridAll=1
+BtnGridTile=1
+BtnGridAtr=1
+BtnGridBlock=0
+BtnGridScr=0
+BtnSelectedOnlyInverted=0
+BtnSolidityMask=0
+BtnPal=1
+BtnTypeIn=0
+BtnFrameAll=1
+BtnFrameSelected=0
+BtnFrameNone=0
+BtnSpriteSnap=0
+BtnSprite8x16=0
+BtnForce8x16=1
+MenuBestOffsets=0
+MenuLossy=0
+MenuThreshold=0
+MenuNoColorData=0
+MenuMetaSprAutoInc=0
+MenuMetaSprSkipZero=0
+MenuMetaSprMerge=0
+MenuSaveIncName=1
+MenuSaveIncAttr=1
+MenuSaveRLE=0
+CheckLinkedCHRmode=0
+CheckMetatileEditor_ReserveFirst=0
+CheckMetatileEditor_AlignToScreen=0
+BtnMetatileEditor_UseAttributes=0
+BtnMetatileEditor_Clonestamp=0
+BtnMetatileEditor_CloneSnap=0
+BtnMetatileEditor_Tiles=0
+BtnMetatileEditor_Attributes=0
+BtnMetatileEditor_Properties=0
+BtnMetatileEditor_Map=0
+ChkSwapBanks_Properties=0
+ChkSwapBanks_Labels=0
+BtnPPuMaskA=0
+BtnPPuMaskB=0
+BtnPPuMaskLinked=1
+VarTileViewTagBuf=0
+VarBgPalCur=0
+VarPalActive=0
+VarTileActive=0
+VarBankActive=0
+VarPPUMask=0
+VarPPUMaskSet0=0
+VarPPUMaskSet1=0
+VarPPUMaskSet2=0
+VarPPUMaskSet3=0
+VarPPUMaskGlobal0=0
+VarPPUMaskGlobal1=0
+VarPalBank=0
+VarMetaSpriteActive=0
+VarSpriteActive=0
+VarSpriteGridX=64
+VarSpriteGridY=64
+VarNameW=32
+VarNameH=30
+VarNameViewX=0
+VarNameViewY=-1
+VarNameViewX2=0
+VarNameViewY2=-1
+VarNameSelectionL=24
+VarNameSelectionR=25
+VarNameSelectionT=2
+VarNameSelectionB=3
+VarNameCopyW=6
+VarNameCopyH=2
+VarCHRSelectionL=0
+VarCHRSelectionR=1
+VarCHRSelectionT=0
+VarCHRSelectionB=1
+VarCHRCopyW=-1
+VarCHRCopyH=-1
+VarCHRCopyRect=1
+VarCHRSelectRect=1
+VarCHRBanks=4
+VarCHRBanksUndo=4
+VarCheckpoint_CHRBanks=4
+VarCheckpoint_CHRBanksUndo=4
+VarMtClickID=0
+VarMtClickID_store_2x2=0
+VarMtClickID_store_4x4=0
+VarMtClickID_store_8x8=0
+VarMetatileSets_2x2=4
+VarUndo_metatileSets_2x2=4
+VarCheckpoint_metatileSets_2x2=4
+VarUndo_checkpoint_metatileSets_2x2=4
+VarMetatileSets_4x4=4
+VarUndo_metatileSets_4x4=4
+VarCheckpoint_metatileSets_4x4=4
+VarUndo_checkpoint_metatileSets_4x4=4
+VarMetatileSets_8x8=2
+VarUndo_metatileSets_8x8=2
+VarCheckpoint_metatileSets_8x8=2
+VarUndo_checkpoint_metatileSets_8x8=2
+VarCustomScanlineWarningCyan=2
+VarBrushPresetIndex=0
+BtnStateMtProps0=0
+BtnStateMtProps1=0
+BtnStateMtProps2=0
+BtnStateMtProps3=0
+BtnStateMtProps4=0
+BtnStateMtProps5=0
+BtnStateMtProps6=0
+BtnStateMtProps7=0
+BtnStateCHRProps0=0
+BtnStateCHRProps1=0
+BtnStateCHRProps2=0
+BtnStateCHRProps3=0
+BtnStateCHRProps4=0
+BtnStateCHRProps5=0
+BtnStateCHRProps6=0
+BtnStateCHRProps7=0
+propertyCHRlabel0=solid
+propertyCHRlabel1=dangerous
+propertyCHRlabel2=unlabeled2
+propertyCHRlabel3=unlabeled3
+propertyCHRlabel4=unlabeled4
+propertyCHRlabel5=unlabeled5
+propertyCHRlabel6=escape bit
+propertyCHRlabel7=global condition
+
+
+
+MetaSpriteBankName=session
+MetaspritePlayBackCursor=0
+
+
+FilterCHR=0
+FilterName=1
+FileNameCHR=C:\users\mssola\Desktop\jetpac-sprites
+FileNameName=C:\users\mssola\Desktop\asd
+FileNamePal=
+FileNameMetaSpriteBank=
+FileNameTileProps=
+FileNameMetatileText=
+FileNameAssociatedMetatiles=
+FileNameAssociatedTileset=
+CheckboxDoAssociateMetatiles=0
+CheckboxDoAssociateTileset=0
+RadioAutoexport_UseWorkDir=0
+RadioAutoexport_UseSubDir_Project=0
+RadioAutoexport_UseSubDir_NEXXT=0
+CheckAutoexport_MetatileAsBMP=0
+
+
+VarCHRSelected=0100[ff]
+
+
+Palette=0f302c280f2c302a0f2814280f1630000f1c21320f1122330f1223340f1324350f1324360f1526370f1627370f1928380f1829380f1b2a390f1b2b3c0f1c2c3b
+
+
+PalUndo=0f302c280f2c302a0f2814280f1630000f1c21320f1122330f1223340f1324350f1324360f1526370f1627370f1928380f1829380f1b2a390f1b2b3c0f1c2c3b
+
+
+CHRMain=00[10]2f7fffddfb7b71212f7fffddfb7b7121bdff[2]f7ebddad04bdff[2]f7ebddad044cfeff3efffe9c084cfeff3efffe9c0800[8]01[2]02[2]05[2]090800[8]80[2]c0[2]e0[2]f01000[8]09[8]00[8]f0[5]50[3]00[8]09[5]19[2]2900[8]10f0b030b018f8fc00[8]2959[2]89b9[4]00[8]fcf4f6[2]f1f7[3]00[8]b9[3]f9a9[2]f4f500[8]f7[2]fff5[3]6fef00[8]555289b9b800[b]eacb91971700[4]3c464a52623c00[a]182808[3]3e00[a]3c42023c407e00[a]3c420c02423c00[a]081828487e0800[a]7e407c02423c00[a]3e407c42[2]3c00[a]3e02040810[2]00[a]3c423c42[2]3c00[a]3c42[2]3e023c00[9]3c4299a1[2]99423c00[9]3c42[2]7e42[2]00[a]7c427c42[2]3c00[a]3c4240[2]423c00[a]7c42[4]7c00[a]7c407040[2]7c00[a]3c40[2]7040[2]00[a]3c42404e423c00[a]42[3]7e42[2]00[a]3e08[4]3e00[a]02[3]42[2]3c00[a]44487048444200[a]40[5]7e00[a]42665a42[3]00[a]4262524a464200[a]3c42[4]3c00[a]7c42[2]7c40[2]00[a]3c42[3]3c0600[a]3c42[2]7c444200[a]3e403c02[2]7c00[a]3e08[5]00[a]42[5]3c00[a]22[4]140800[a]42[3]5a664200[a]422418[2]244200[a]41221408[3]00[a]7e040810207e00[9]18243c7e5a3c[2]6600[caa]0105[3]0c[2]00[2]0105[3]0c[2]00f0c080c0[2]f800[2]f0c0bcdc[2]f80078f87468cceeff0078f87468cceeff00[11]01[2]02[2]05[2]090801[2]02[2]05[2]090880[2]c0[2]e0[2]f01080[2]c0[2]e0[2]f01009[5]19[2]2909[5]19[2]2910f0b030b018f8fc10f0b030b018f8fcb9[3]f9a9[2]f4f5b9[3]f9a9[2]f4f5f7[2]fff5[3]6feff7[2]fff5[3]6fef00[2]303f[2]3c[2]3d071f3f7ffffc[2]fd00[3]e0f038b8bce0f8fcfeff3fbf[2]00[4]18ff[2]8a00[c]18ff[2]8b00[28]0a0e0a0e0b0f07050a0e0a0e0b0f0705f09a[2]8778[2]f878f09a[2]8778[2]f8780a0f0001030d0e070a0f0001030d0e07b858d8[2]981c1e1fb858d8[2]981c1e1f09[10]f0[5]50[3]f0[5]50[3]2959[2]89b9[4]2959[2]89b9[4]fcf4f6[2]f1f7[3]fcf4f6[2]f1f7[3]555289b9b800[3]555289b9b800[3]eacb91971700[3]eacb91971700[3]3c3f[5]00[2]fcfff07c7f[2]3f073cfcf8fcf0e000[2]3fff671efc[2]f8e0ba8abab8ff[2]1800[9]bb9bbb89ff[2]1800[29]0a0f00[6]0a0f00[6]b8[2]300030383c00b8[2]300030383c000a0f000a07081b040a0f00[6]bc[2]0c000e0f00[2]bc[2]0c000e0f00[4a]555289b9b800[b]eacb91971700[2d63]
+
+
+CHRUndo=00[10]2f7fffddfb7b71212f7fffddfb7b7121bdff[2]f7ebddad04bdff[2]f7ebddad044cfeff3efffe9c084cfeff3efffe9c0800[8]01[2]02[2]05[2]090800[8]80[2]c0[2]e0[2]f01000[8]09[8]00[8]f0[5]50[3]00[8]09[5]19[2]2900[8]10f0b030b018f8fc00[8]2959[2]89b9[4]00[8]fcf4f6[2]f1f7[3]00[8]b9[3]f9a9[2]f4f500[8]f7[2]fff5[3]6fef00[8]555289b9b800[b]eacb91971700[4]3c464a52623c00[a]182808[3]3e00[a]3c42023c407e00[a]3c420c02423c00[a]081828487e0800[a]7e407c02423c00[a]3e407c42[2]3c00[a]3e02040810[2]00[a]3c423c42[2]3c00[a]3c42[2]3e023c00[9]3c4299a1[2]99423c00[9]3c42[2]7e42[2]00[a]7c427c42[2]3c00[a]3c4240[2]423c00[a]7c42[4]7c00[a]7c407040[2]7c00[a]3c40[2]7040[2]00[a]3c42404e423c00[a]42[3]7e42[2]00[a]3e08[4]3e00[a]02[3]42[2]3c00[a]44487048444200[a]40[5]7e00[a]42665a42[3]00[a]4262524a464200[a]3c42[4]3c00[a]7c42[2]7c40[2]00[a]3c42[3]3c0600[a]3c42[2]7c444200[a]3e403c02[2]7c00[a]3e08[5]00[a]42[5]3c00[a]22[4]140800[a]42[3]5a664200[a]422418[2]244200[a]41221408[3]00[a]7e040810207e00[9]18243c7e5a3c[2]6600[caa]0105[3]0c[2]00[2]0105[3]0c[2]00f0c080c0[2]f800[2]f0c0bcdc[2]f80078f87468cceeff0078f87468cceeff00[11]01[2]02[2]05[2]090801[2]02[2]05[2]090880[2]c0[2]e0[2]f01080[2]c0[2]e0[2]f01009[5]19[2]2909[5]19[2]2910f0b030b018f8fc10f0b030b018f8fcb9[3]f9a9[2]f4f5b9[3]f9a9[2]f4f5f7[2]fff5[3]6feff7[2]fff5[3]6fef00[2]303f[2]3c[2]3d071f3f7ffffc[2]fd00[3]e0f038b8bce0f8fcfeff3fbf[2]00[4]18ff[2]8a00[c]18ff[2]8b00[28]0a0e0a0e0b0f07050a0e0a0e0b0f0705f09a[2]8778[2]f878f09a[2]8778[2]f8780a0f0001030d0e070a0f0001030d0e07b858d8[2]981c1e1fb858d8[2]981c1e1f09[10]f0[5]50[3]f0[5]50[3]2959[2]89b9[4]2959[2]89b9[4]fcf4f6[2]f1f7[3]fcf4f6[2]f1f7[3]555289b9b800[3]555289b9b800[3]eacb91971700[3]eacb91971700[3]3c3f[5]00[2]fcfff07c7f[2]3f073cfcf8fcf0e000[2]3fff671efc[2]f8e0ba8abab8ff[2]1800[9]bb9bbb89ff[2]1800[29]0a0f00[6]0a0f00[6]b8[2]300030383c00b8[2]300030383c000a0f000a07081b040a0f00[6]bc[2]0c000e0f00[2]bc[2]0c000e0f00[4a]555289b9b800[b]eacb91971700[2d63]
+
+
+CHRCopy=00[4000]
+
+
+NameTable=00[44]112f2a00[2]143500[4]222300[9]122f2a00[5]10[6]00[5]10[6]00[5]10[6]00[ba]0102[4]0300[45]0102[4]0300[66]0102[2]0300[12d]0102[1e]0300[80]
+
+
+NameCopy=00[2]122f2a0010[6]00[3b4]
+
+
+NameUndo=00[44]112f2a00[2]143500[4]222300[11]10[6]00[5]10[6]00[c5]0102[4]0300[45]0102[4]0300[66]0102[2]0300[12d]0102[1e]0300[80]
+
+
+AttrTable=0300[14]405511040501515000[2]c000010005[2]00[1b]
+
+
+AttrCopy=00[40]
+
+
+AttrUndo=0300[14]405511040501515000[2]c000010005[2]00[1b]
+
+
+MetaSprites=ff[10000]
+
+
+iBrushSize=02030405
+
+
+iBrushSnapSize_x=02030405
+
+
+iBrushSnapSize_y=02030405
+
+
+iBrushCursorAlignment=04[4]
+
+
+BrushMask_2a=01[100]
+
+
+BrushMask_3a=000100010001000100[2]010001000100[2]0100010001000100[2]010001000100[2]0100010001000100[2]010001000100[2]0100010001000100[2]010001000100[2]0100010001000100[2]010001000100[2]0100010001000100[2]010001000100[2]0100010001000100[2]010001000100[2]0100010001000100[2]010001000100[2]0100010001000100[2]010001000100[2]0100010001000100[2]010001000100[2]0100010001000100[2]010001000100[2]0100010001000100[2]010001000100[2]0100010001000100[2]010001000100[2]0100010001000100[2]010001000100[2]0100010001000100[2]010001000100[2]0100010001000100[2]010001000100
+
+
+BrushMask_4a=0001[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00[2]01[2]00
+
+
+BrushMask_5a=0001[3]00[2]01[3]00[2]01[3]00[3]01[3]00[2]01[3]00[2]01[3]00[3]01[3]00[2]01[3]00[2]01[3]00[3]01[3]00[2]01[3]00[2]01[3]00[3]01[3]00[2]01[3]00[2]01[3]00[3]01[3]00[2]01[3]00[2]01[3]00[3]01[3]00[2]01[3]00[2]01[3]00[3]01[3]00[2]01[3]00[2]01[3]00[3]01[3]00[2]01[3]00[2]01[3]00[3]01[3]00[2]01[3]00[2]01[3]00[3]01[3]00[2]01[3]00[2]01[3]00[3]01[3]00[2]01[3]00[2]01[3]00[3]01[3]00[2]01[3]00[2]01[3]00[3]01[3]00[2]01[3]00[2]01[3]00[3]01[3]00[2]01[3]00[2]01[3]00[3]01[3]00[2]01[3]00[2]01[3]00[2]
+
+
+BrushMask_6a=01[100]
+
+
+BrushMask_7a=01[100]
+
+
+BrushMask_8a=01[100]
+
+
+BrushMask_2b=00[5]01[6]00[8]01[2]00[6]01[2]00[5]0100[a]0100[3]0100[c]0100[2]0100[c]01000100[e]01[2]00[e]01[2]00[e]01[2]00[e]01[2]00[e]01[2]00[e]01000100[c]0100[2]0100[c]0100[3]0100[a]0100[5]01[2]00[6]01[2]00[8]01[6]00[5]
+
+
+BrushMask_3b=000100[e]01[3]00[e]0100[de]
+
+
+BrushMask_4b=0001[2]00[d]01[4]00[c]01[4]00[d]01[2]00[cd]
+
+
+BrushMask_5b=0001[3]00[c]01[5]00[b]01[5]00[b]01[5]00[c]01[3]00[bc]
+
+
+BrushMask_6b=00[2]01[2]00[d]01[4]00[b]01[6]00[a]01[6]00[b]01[4]00[d]01[2]00[ac]
+
+
+BrushMask_7b=00[2]01[3]00[c]01[5]00[a]01[7]00[9]01[7]00[9]01[7]00[a]01[5]00[c]01[3]00[9b]
+
+
+BrushMask_8b=00[2]01[4]00[b]01[6]00[9]01[8]00[8]01[8]00[8]01[8]00[8]01[8]00[9]01[6]00[b]01[4]00[8a]
+
+
+32_BankViewTable=00000000[100]00001000[100]00002000[100]00003000[100]
+
+
+32_BankViewTableUndo=00000000[100]00001000[100]00002000[100]00003000[100]
+
+
+8_TileCollisionProperties=00[400]
+
+
+8_TileCollisionPropertiesUndo=00[400]
+
+
+PropertyConditions=1[2]0[2]1[2]0[2]1[2]0[2]1[2]0[2]1[2]0[2]1[2]0[2]1[2]0[2]1[2]0[2]
+
+
+PropertyConditionsUndo=1[2]0[2]1[2]0[2]1[2]0[2]1[2]0[2]1[2]0[2]1[2]0[2]1[2]0[2]1[2]0[2]
+
+
+TilePropConditionType=00[7]02
+
+
+TilePropConditionTypeUndo=00[7]02
+
+
+MetatileSet_2x2_id=00[400]
+
+
+MetatileSet_2x2_idUndo=00[400]
+
+
+MetatileSet_2x2_pal=00[400]
+
+
+MetatileSet_2x2_palUndo=00[400]
+
+
+MetatileSet_2x2_props=00[400]
+
+
+MetatileSet_2x2_propsUndo=00[400]
+
+
+MetatileSet_4x4_id=00[1000]
+
+
+MetatileSet_4x4_idUndo=00[1000]
+
+
+MetatileSet_4x4_pal=00[1000]
+
+
+MetatileSet_4x4_palUndo=00[1000]
+
+
+MetatileSet_4x4_props=00[1000]
+
+
+MetatileSet_4x4_propsUndo=00[1000]
+
+
+MetatileSet_8x8_id=00[2000]
+
+
+MetatileSet_8x8_idUndo=00[2000]
+
+
+MetatileSet_8x8_pal=00[2000]
+
+
+MetatileSet_8x8_palUndo=00[2000]
+
+
+MetatileSet_8x8_props=00[2000]
+
+
+MetatileSet_8x8_propsUndo=00[2000]
+
+
+MetatileSetLabels_2x2=Unlabeled,Unlabeled,Unlabeled,Unlabeled
+MetatileSetLabels_2x2Undo=Unlabeled,Unlabeled,Unlabeled,Unlabeled
+
+MetatileSetLabels_4x4=Unlabeled,Unlabeled,Unlabeled,Unlabeled
+MetatileSetLabels_4x4Undo=Unlabeled,Unlabeled,Unlabeled,Unlabeled
+
+MetatileSetLabels_8x8=Unlabeled,Unlabeled
+MetatileSetLabels_8x8Undo=Unlabeled,Unlabeled
+
+CHRBankLabels=Unlabeled,Unlabeled,Unlabeled,Unlabeled
+
+CHRBankLabelsUndo=Unlabeled,Unlabeled,Unlabeled,Unlabeled
+
+32_NTSC_MsprDuration=00000006[100]
+
+
+32_NTSC_MsprDurationUndo=00000006[100]
+
+
+32_PAL_MsprDuration=00000005[100]
+
+
+32_PAL_MsprDurationUndo=00000005[100]
+
+
+MsprDirectTagStart=[100]
+
+
+MsprDirectTagStartUndo=[100]
+
+
+MsprDirectTagLoop=[100]
+
+
+MsprDirectTagLoopUndo=[100]
+
+
+MsprDirectTagCall=[100]
+
+
+MsprDirectTagCallUndo=[100]
+
+
+MsprDirectTagCall2=[100]
+
+
+MsprDirectTagCall2Undo=[100]
+
+
+MsprDirectTagRevert=[100]
+
+
+MsprDirectTagRevertUndo=[100]
+
+
+MsprDirectTagSeconds=[100]
+
+
+MsprDirectTagSecondsUndo=[100]
+
+
+MsprDirectTagHalfSeconds=[100]
+
+
+MsprDirectTagHalfSecondsUndo=[100]
+
+
+Checkpoint_Palette=0f0010300f0c21320f0516270f0b1a290f1c21320f1122330f1223340f1324350f1324360f1526370f1627370f1928380f1829380f1b2a390f1b2b3c0f1c2c3b
+
+
+Checkpoint_PalUndo=0f0010300f0c21320f0516270f0b1a290f1c21320f1122330f1223340f1324350f1324360f1526370f1627370f1928380f1829380f1b2a390f1b2b3c0f1c2c3b
+
+
+Checkpoint_CHRMain=00[4000]
+
+
+Checkpoint_CHRUndo=00[4000]
+
+
+Checkpoint_NameTable=00[3c0]
+
+
+Checkpoint_NameUndo=00[3c0]
+
+
+Checkpoint_AttrTable=00[40]
+
+
+Checkpoint_AttrUndo=00[40]
+
+
+Checkpoint_MetaSprites=ff[10000]
+
+
+Checkpoint_32_BankViewTable=00000000[100]00001000[100]00002000[100]00003000[100]
+
+
+Checkpoint_32_BankViewTableUndo=00000000[100]00001000[100]00002000[100]00003000[100]
+
+
+Checkpoint_8_TileCollisionProperties=00[400]
+
+
+Checkpoint_8_TileCollisionPropertiesUndo=00[400]
+
+
+Checkpoint_PropertyConditions=[20]
+
+
+Checkpoint_PropertyConditionsUndo=[20]
+
+
+Checkpoint_TilePropConditionType=00[7]02
+
+
+Checkpoint_TilePropConditionTypeUndo=00[7]02
+
+
+Checkpoint_MetatileSet_2x2_id=00[400]
+
+
+Checkpoint_MetatileSet_2x2_idUndo=00[400]
+
+
+Checkpoint_MetatileSet_2x2_pal=00[400]
+
+
+Checkpoint_MetatileSet_2x2_palUndo=00[400]
+
+
+Checkpoint_MetatileSet_2x2_props=00[400]
+
+
+Checkpoint_MetatileSet_2x2_propsUndo=00[400]
+
+
+Checkpoint_MetatileSet_4x4_id=00[1000]
+
+
+Checkpoint_MetatileSet_4x4_idUndo=00[1000]
+
+
+Checkpoint_MetatileSet_4x4_pal=00[1000]
+
+
+Checkpoint_MetatileSet_4x4_palUndo=00[1000]
+
+
+Checkpoint_MetatileSet_4x4_props=00[1000]
+
+
+Checkpoint_MetatileSet_4x4_propsUndo=00[1000]
+
+
+Checkpoint_MetatileSet_8x8_id=00[2000]
+
+
+Checkpoint_MetatileSet_8x8_idUndo=00[2000]
+
+
+Checkpoint_MetatileSet_8x8_pal=00[2000]
+
+
+Checkpoint_MetatileSet_8x8_palUndo=00[2000]
+
+
+Checkpoint_MetatileSet_8x8_props=00[2000]
+
+
+Checkpoint_MetatileSet_8x8_propsUndo=00[2000]
+
+
+Checkpoint_MetatileSetLabels_2x2=Unlabeled,Unlabeled,Unlabeled,Unlabeled
+Checkpoint_MetatileSetLabels_2x2Undo=Unlabeled,Unlabeled,Unlabeled,Unlabeled
+
+Checkpoint_MetatileSetLabels_4x4=Unlabeled,Unlabeled,Unlabeled,Unlabeled
+Checkpoint_MetatileSetLabels_4x4Undo=Unlabeled,Unlabeled,Unlabeled,Unlabeled
+
+Checkpoint_MetatileSetLabels_8x8=Unlabeled,Unlabeled
+Checkpoint_MetatileSetLabels_8x8Undo=Unlabeled,Unlabeled
+
+Checkpoint_CHRBankLabels=Unlabeled,Unlabeled,Unlabeled,Unlabeled
+
+Checkpoint_CHRBankLabelsUndo=Unlabeled,Unlabeled,Unlabeled,Unlabeled
+
+
+Checkpoint_32_NTSC_MsprDuration=00000006[100]
+
+
+Checkpoint_32_NTSC_MsprDurationUndo=00000000[100]
+
+
+Checkpoint_32_PAL_MsprDuration=00000005[100]
+
+
+Checkpoint_32_PAL_MsprDurationUndo=00000000[100]
+
+
+Checkpoint_MsprDirectTagStart=[100]
+
+
+Checkpoint_MsprDirectTagStartUndo=[100]
+
+
+Checkpoint_MsprDirectTagLoop=[100]
+
+
+Checkpoint_MsprDirectTagLoopUndo=[100]
+
+
+Checkpoint_MsprDirectTagCall=[100]
+
+
+Checkpoint_MsprDirectTagCallUndo=[100]
+
+
+Checkpoint_MsprDirectTagCall2=[100]
+
+
+Checkpoint_MsprDirectTagCall2Undo=[100]
+
+
+Checkpoint_MsprDirectTagRevert=[100]
+
+
+Checkpoint_MsprDirectTagRevertUndo=[100]
+
+
+Checkpoint_MsprDirectTagSeconds=[100]
+
+
+Checkpoint_MsprDirectTagSecondsUndo=[100]
+
+
+Checkpoint_MsprDirectTagHalfSeconds=[100]
+
+
+Checkpoint_MsprDirectTagHalfSecondsUndo=[100]
+
+=========================================================
+Current settings switch tiles
+=========================================================
+
+
+
+Metadata:
+---------------------------------------------------------
+Switch tiles enabled=0
+Current preset ID=0
+
+GUI behaviour:
+---------------------------------------------------------
+Use paired mode if possible=0
+Affect backgrounds=1
+Affect sprites=1
+
+Nonpaired mode start set behaviour:
+---------------------------------------------------------
+Nonpaired, Use set of 1st checked switch tile=1
+Nonpaired, Use active set=0
+Nonpaired, Use fixed set=0
+Nonpaired, fixed set ID=0
+
+Paired mode start set behaviour:
+---------------------------------------------------------
+Paired, Use set of 1st checked switch tile=1
+
+Switch tile IDs:
+---------------------------------------------------------
+Switch tile 1 ID=254
+Switch tile 2 ID=253
+Switch tile 3 ID=252
+Switch tile 4 ID=251
+
+Switch tile targets:
+---------------------------------------------------------
+Switch tile 1 target=0
+Switch tile 2 target=4096
+Switch tile 3 target=8192
+Switch tile 4 target=12288
+
+Switch tile checkboxes:
+---------------------------------------------------------
+Switch tile 1 checkbox=1
+Switch tile 2 checkbox=1
+Switch tile 3 checkbox=1
+Switch tile 4 checkbox=1
diff --git a/config/nrom.cfg b/config/nrom.cfg new file mode 100644 index 0000000..41a1f2a --- /dev/null +++ b/config/nrom.cfg @@ -0,0 +1,24 @@ +## +# Same as the default NROM configuration provided by cc65, but with C stuff +# stripped away (e.g. namely, there are no more segments like 'STARTUP'). + +MEMORY { + # iNES header + HEADER: file = %O, start = $0000, size = $0010, fill = yes; + + # Fixed ROM. + ROM0: file = %O, start = $8000, size = $7FFA, fill = yes, define = yes; + + # Hardware Vectors. + ROMV: file = %O, start = $FFFA, size = $0006, fill = yes; + + # 1 8k CHR Bank + ROM2: file = %O, start = $0000, size = $2000, fill = yes; +} + +SEGMENTS { + HEADER: load = HEADER, type = ro; + CODE: load = ROM0, type = ro, define = yes; + VECTORS: load = ROMV, type = rw; + CHARS: load = ROM2, type = rw; +} diff --git a/include/apu.s b/include/apu.s new file mode 100644 index 0000000..65d9876 --- /dev/null +++ b/include/apu.s @@ -0,0 +1,4 @@ +.scope APU + DMC = $4010 + FRAME_COUNTER = $4017 +.endscope diff --git a/include/globals.s b/include/globals.s new file mode 100644 index 0000000..d22b217 --- /dev/null +++ b/include/globals.s @@ -0,0 +1,34 @@ +;; Global variables used throughout the code base. +.scope Globals + ;;; + ;; Argument values as defined in https://github.com/mssola/style.nes. Note + ;; that these variables can also be used as temporary variables. + zp_arg0 = $00 + zp_arg1 = $01 + zp_arg2 = $02 + zp_arg3 = $03 + zp_arg4 = $04 + + ;;; + ;; Random values that can be used inside of functions for temporary values + ;; so `zp_argX` variables are not overwritten as often. + zp_tmp0 = $05 + zp_tmp1 = $06 + zp_tmp2 = $07 + zp_tmp3 = $08 + + ;;; + ;; Reserve a byte of memory for preserving indices on memory. This is needed + ;; whenever the `x` and `y` registers might not be reliable because of + ;; underlying `jsr` calls that might tamper with their values. Sometimes + ;; saving the value in memory is enough instead of playing with the stack. + zp_idx = $09 + + ;; Flags that manage the state of the game. + ;; + ;; | Bit | Short name | Meaning when set | + ;; |-----+------------+-------------------------------------------------------------| + ;; | 7 | render | Game logic is over, block main code until NMI code is over. | + ;; | 6-0 | - | Unused | + zp_flags = $20 +.endscope diff --git a/include/oam.s b/include/oam.s new file mode 100644 index 0000000..22935b2 --- /dev/null +++ b/include/oam.s @@ -0,0 +1,11 @@ +.scope OAM + ADDRESS = $2003 + DMA = $4014 +.endscope + +.macro OAM_WRITE_SPRITES + lda #$00 + sta OAM::ADDR + lda #$02 + sta OAM::DMA +.endmacro diff --git a/include/ppu.s b/include/ppu.s new file mode 100644 index 0000000..fa0df19 --- /dev/null +++ b/include/ppu.s @@ -0,0 +1,8 @@ +.scope PPU + CONTROL = $2000 + MASK = $2001 + STATUS = $2002 + SCROLL = $2005 + ADDRESS = $2006 + DATA = $2007 +.endscope diff --git a/src/jetpac.s b/src/jetpac.s new file mode 100644 index 0000000..2f273a3 --- /dev/null +++ b/src/jetpac.s @@ -0,0 +1,86 @@ +.segment "HEADER" + .byte 'N', 'E', 'S', $1A + .byte $02, $01 + .res $0A, $00 + +.segment "CODE" + +.include "../include/apu.s" +.include "../include/oam.s" +.include "../include/ppu.s" +.include "../include/globals.s" +.include "vectors.s" + +.proc main + jsr init_palettes + jsr init_nametables + +;;; TODO + cli + lda #%10110000 + sta $2000 + lda #%00011110 + sta $2001 + +@main_game_loop: + ;;; + ;; TODO + ;;; + + lda #%10000000 + ora Globals::zp_flags + sta Globals::zp_flags +@wait_for_render: + bit Globals::zp_flags + bmi @wait_for_render + + ;; Rendering is done, we can perform another iteration of the loop! + jmp @main_game_loop +.endproc + +;; Copies all the palettes for our game into the proper PPU address. +.proc init_palettes + lda #$3F + sta PPU::ADDRESS + lda #$00 + sta PPU::ADDRESS + + ldx #0 +@load_palettes_loop: + lda palettes, x + sta PPU::DATA + inx + cpx #$20 + bne @load_palettes_loop + rts +palettes: + ;; Background + ;; 0: score + .byte $0F, $30, $2C, $28 + ;; 1: floating platforms + .byte $0F, $2C, $30, $2A + ;; 2: ground + .byte $0F, $28, $14, $28 + ;; 3: ship + .byte $0F, $16, $30, $00 + + ;; TODO: fuel tank needs color $24 + ;; Foreground + ;; 0: player & ship + .byte $0F, $16, $10, $30 + ;; 1: enemy 1 & bonuses + .byte $0F, $16, $2C, $2A + ;; 2: enemy 2, fuel & bonuses + .byte $0F, $16, $14, $28 + ;; 3: SUSE easter egg + .byte $0F, $16, $00, $2B +.endproc + +.proc init_nametables + ;; TODO + rts +.endproc + + +.segment "CHARS" + .incbin "../assets/jetpac.chr" diff --git a/src/vectors.s b/src/vectors.s new file mode 100644 index 0000000..2edc6a6 --- /dev/null +++ b/src/vectors.s @@ -0,0 +1,109 @@ +.segment "VECTORS" + .addr nmi, reset, irq + +.segment "CODE" + +;; Pretty standard reset function, nothing crazy. +.proc reset + sei + cld + + ldx #$40 + stx APU::FRAME_COUNTER + + ldx #$FF + txs + + inx + stx PPU::CONTROL + stx PPU::MASK + stx APU::DMC + +@vblankwait1: + bit PPU::STATUS + bpl @vblankwait1 + + ldx #0 + lda #0 +@ram_reset_loop: + sta $000, x + sta $100, x + sta $300, x + sta $400, x + sta $500, x + sta $600, x + sta $700, x + inx + bne @ram_reset_loop + + lda #$EF +@sprite_reset_loop: + sta $200, x + inx + bne @sprite_reset_loop + + lda #$00 + sta OAM::ADDRESS + lda #$02 + sta OAM::DMA + +@vblankwait2: + bit PPU::STATUS + bpl @vblankwait2 + + lda #$3F + sta PPU::ADDRESS + lda #$00 + sta PPU::ADDRESS + + lda #$0F + ldx #$20 +@palettes_reset_loop: + sta PPU::DATA + dex + bne @palettes_reset_loop + + jmp main +.endproc + +.proc nmi + ;; Should we skip it? + bit Globals::zp_flags + bpl @end + + ;; Save registers. + pha + txa + pha + tya + pha + + lda #$00 + sta OAM::ADDRESS + lda #$02 + sta OAM::DMA + + bit PPU::STATUS + lda #$00 + sta PPU::SCROLL + sta PPU::SCROLL + + lda #%01111111 + and Globals::zp_flags + sta Globals::zp_flags + + ;; Restore registers. + pla + tay + pla + tax + pla + +@end: + rti +.endproc + +;; Unused. +.proc irq + rti +.endproc |
