commit 95a6297d9aff0244bb71a3bf250512f6db1974bd Author: Greg Tseng Date: Fri Feb 28 19:39:04 2025 -0500 initial commit, cloning Saradomin Launcher from 2009Scape with a few small tweaks diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..6b9b67b --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +/Glitonea diff --git a/Glitonea_Reminder b/Glitonea_Reminder new file mode 100644 index 0000000..204e5ff --- /dev/null +++ b/Glitonea_Reminder @@ -0,0 +1 @@ +Note this project requires Glitonea: https://github.com/vddCore/Glitonea diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..464f507 --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +# Saradomin - C# Launcher for 2009Scape +[![GPLv3 License](https://img.shields.io/badge/License-GPL%20v3-yellow.svg)](https://opensource.org/licenses/) + + +Saradomin is an alternative launcher to the mainline java-based 2009Scape launcher that offers some additional features and streamlines configuration options. + +![image](/uploads/fb44f9b24f9d844b38e4caa8635c3ebe/image.png) + +## Download latest release + +* Note: **Self Contained is the best choice for most users.** It is ready to run right out of the box. The "No Runtime" download should be considered as intended for **advanced users only.** + +Linux: [Get it on Flathub](https://flathub.org/apps/details/org._2009scape.Launcher) | [Self Contained](https://gitlab.com/2009scape/Saradomin-Launcher/-/jobs/artifacts/master/raw/Saradomin/2009scape-launcher-sc?job=pack_linux_sc) | [No Runtime](https://gitlab.com/2009scape/Saradomin-Launcher/-/jobs/artifacts/master/raw/Saradomin/2009scape-launcher-no_rt?job=pack_linux_no_rt) + +Windows: [Self Contained](https://gitlab.com/2009scape/Saradomin-Launcher/-/jobs/artifacts/master/raw/Saradomin/2009scape-launcher-sc.exe?job=pack_windows_sc) | [No Runtime](https://gitlab.com/2009scape/Saradomin-Launcher/-/jobs/artifacts/master/raw/Saradomin/2009scape-launcher-no_rt.exe?job=pack_windows_no_rt) + +## Authors + +- [@vddCore](https://www.gitlab.com/vddcore) (Vast majority of the work) +- [@ceikry](https://gitlab.com/ceikry) (Bugfixes and improvements) +- [@bushtail](https://gitlab.com/bushtail) (Bugfixes and improvements) + diff --git a/Saradomin.sln b/Saradomin.sln new file mode 100644 index 0000000..cfbf37a --- /dev/null +++ b/Saradomin.sln @@ -0,0 +1,22 @@ + +Microsoft Visual Studio Solution File, Format Version 12.00 +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Saradomin", "Saradomin\Saradomin.csproj", "{29C8B474-5AE6-4B2D-9BE4-4764AFC50E16}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Glitonea", "Glitonea\Glitonea.csproj", "{D2884654-2246-4AC0-B53B-5F1DF33DEDD7}" +EndProject +Global + GlobalSection(SolutionConfigurationPlatforms) = preSolution + Debug|Any CPU = Debug|Any CPU + Release|Any CPU = Release|Any CPU + EndGlobalSection + GlobalSection(ProjectConfigurationPlatforms) = postSolution + {29C8B474-5AE6-4B2D-9BE4-4764AFC50E16}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {29C8B474-5AE6-4B2D-9BE4-4764AFC50E16}.Debug|Any CPU.Build.0 = Debug|Any CPU + {29C8B474-5AE6-4B2D-9BE4-4764AFC50E16}.Release|Any CPU.ActiveCfg = Release|Any CPU + {29C8B474-5AE6-4B2D-9BE4-4764AFC50E16}.Release|Any CPU.Build.0 = Release|Any CPU + {D2884654-2246-4AC0-B53B-5F1DF33DEDD7}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {D2884654-2246-4AC0-B53B-5F1DF33DEDD7}.Debug|Any CPU.Build.0 = Debug|Any CPU + {D2884654-2246-4AC0-B53B-5F1DF33DEDD7}.Release|Any CPU.ActiveCfg = Release|Any CPU + {D2884654-2246-4AC0-B53B-5F1DF33DEDD7}.Release|Any CPU.Build.0 = Release|Any CPU + EndGlobalSection +EndGlobal diff --git a/Saradomin.sln.DotSettings b/Saradomin.sln.DotSettings new file mode 100644 index 0000000..0044dd2 --- /dev/null +++ b/Saradomin.sln.DotSettings @@ -0,0 +1,3 @@ + + True + True \ No newline at end of file diff --git a/Saradomin.sln.DotSettings.user b/Saradomin.sln.DotSettings.user new file mode 100644 index 0000000..61a8768 --- /dev/null +++ b/Saradomin.sln.DotSettings.user @@ -0,0 +1,5 @@ + + + /usr/share/dotnet/sdk/7.0.100/MSBuild.dll + No + \ No newline at end of file diff --git a/Saradomin/.gitignore b/Saradomin/.gitignore new file mode 100644 index 0000000..8afdcb6 --- /dev/null +++ b/Saradomin/.gitignore @@ -0,0 +1,454 @@ +## Ignore Visual Studio temporary files, build results, and +## files generated by popular Visual Studio add-ons. +## +## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore + +# User-specific files +*.rsuser +*.suo +*.user +*.userosscache +*.sln.docstates + +# User-specific files (MonoDevelop/Xamarin Studio) +*.userprefs + +# Mono auto generated files +mono_crash.* + +# Build results +[Dd]ebug/ +[Dd]ebugPublic/ +[Rr]elease/ +[Rr]eleases/ +x64/ +x86/ +[Ww][Ii][Nn]32/ +[Aa][Rr][Mm]/ +[Aa][Rr][Mm]64/ +bld/ +[Bb]in/ +[Oo]bj/ +[Ll]og/ +[Ll]ogs/ + +# Visual Studio 2015/2017 cache/options directory +.vs/ +# Uncomment if you have tasks that create the project's static files in wwwroot +#wwwroot/ + +# Visual Studio 2017 auto generated files +Generated\ Files/ + +# MSTest test Results +[Tt]est[Rr]esult*/ +[Bb]uild[Ll]og.* + +# NUnit +*.VisualState.xml +TestResult.xml +nunit-*.xml + +# Build Results of an ATL Project +[Dd]ebugPS/ +[Rr]eleasePS/ +dlldata.c + +# Benchmark Results +BenchmarkDotNet.Artifacts/ + +# .NET Core +project.lock.json +project.fragment.lock.json +artifacts/ + +# Tye +.tye/ + +# ASP.NET Scaffolding +ScaffoldingReadMe.txt + +# StyleCop +StyleCopReport.xml + +# Files built by Visual Studio +*_i.c +*_p.c +*_h.h +*.ilk +*.meta +*.obj +*.iobj +*.pch +*.pdb +*.ipdb +*.pgc +*.pgd +*.rsp +*.sbr +*.tlb +*.tli +*.tlh +*.tmp +*.tmp_proj +*_wpftmp.csproj +*.log +*.vspscc +*.vssscc +.builds +*.pidb +*.svclog +*.scc + +# Chutzpah Test files +_Chutzpah* + +# Visual C++ cache files +ipch/ +*.aps +*.ncb +*.opendb +*.opensdf +*.sdf +*.cachefile +*.VC.db +*.VC.VC.opendb + +# Visual Studio profiler +*.psess +*.vsp +*.vspx +*.sap + +# Visual Studio Trace Files +*.e2e + +# TFS 2012 Local Workspace +$tf/ + +# Guidance Automation Toolkit +*.gpState + +# ReSharper is a .NET coding add-in +_ReSharper*/ +*.[Rr]e[Ss]harper +*.DotSettings.user + +# TeamCity is a build add-in +_TeamCity* + +# DotCover is a Code Coverage Tool +*.dotCover + +# AxoCover is a Code Coverage Tool +.axoCover/* +!.axoCover/settings.json + +# Coverlet is a free, cross platform Code Coverage Tool +coverage*.json +coverage*.xml +coverage*.info + +# Visual Studio code coverage results +*.coverage +*.coveragexml + +# NCrunch +_NCrunch_* +.*crunch*.local.xml +nCrunchTemp_* + +# MightyMoose +*.mm.* +AutoTest.Net/ + +# Web workbench (sass) +.sass-cache/ + +# Installshield output folder +[Ee]xpress/ + +# DocProject is a documentation generator add-in +DocProject/buildhelp/ +DocProject/Help/*.HxT +DocProject/Help/*.HxC +DocProject/Help/*.hhc +DocProject/Help/*.hhk +DocProject/Help/*.hhp +DocProject/Help/Html2 +DocProject/Help/html + +# Click-Once directory +publish/ + +# Publish Web Output +*.[Pp]ublish.xml +*.azurePubxml +# Note: Comment the next line if you want to checkin your web deploy settings, +# but database connection strings (with potential passwords) will be unencrypted +*.pubxml +*.publishproj + +# Microsoft Azure Web App publish settings. Comment the next line if you want to +# checkin your Azure Web App publish settings, but sensitive information contained +# in these scripts will be unencrypted +PublishScripts/ + +# NuGet Packages +*.nupkg +# NuGet Symbol Packages +*.snupkg +# The packages folder can be ignored because of Package Restore +**/[Pp]ackages/* +# except build/, which is used as an MSBuild target. +!**/[Pp]ackages/build/ +# Uncomment if necessary however generally it will be regenerated when needed +#!**/[Pp]ackages/repositories.config +# NuGet v3's project.json files produces more ignorable files +*.nuget.props +*.nuget.targets + +# Microsoft Azure Build Output +csx/ +*.build.csdef + +# Microsoft Azure Emulator +ecf/ +rcf/ + +# Windows Store app package directories and files +AppPackages/ +BundleArtifacts/ +Package.StoreAssociation.xml +_pkginfo.txt +*.appx +*.appxbundle +*.appxupload + +# Visual Studio cache files +# files ending in .cache can be ignored +*.[Cc]ache +# but keep track of directories ending in .cache +!?*.[Cc]ache/ + +# Others +ClientBin/ +~$* +*~ +*.dbmdl +*.dbproj.schemaview +*.jfm +*.pfx +*.publishsettings +orleans.codegen.cs + +# Including strong name files can present a security risk +# (https://github.com/github/gitignore/pull/2483#issue-259490424) +#*.snk + +# Since there are multiple workflows, uncomment next line to ignore bower_components +# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622) +#bower_components/ + +# RIA/Silverlight projects +Generated_Code/ + +# Backup & report files from converting an old project file +# to a newer Visual Studio version. Backup files are not needed, +# because we have git ;-) +_UpgradeReport_Files/ +Backup*/ +UpgradeLog*.XML +UpgradeLog*.htm +ServiceFabricBackup/ +*.rptproj.bak + +# SQL Server files +*.mdf +*.ldf +*.ndf + +# Business Intelligence projects +*.rdl.data +*.bim.layout +*.bim_*.settings +*.rptproj.rsuser +*- [Bb]ackup.rdl +*- [Bb]ackup ([0-9]).rdl +*- [Bb]ackup ([0-9][0-9]).rdl + +# Microsoft Fakes +FakesAssemblies/ + +# GhostDoc plugin setting file +*.GhostDoc.xml + +# Node.js Tools for Visual Studio +.ntvs_analysis.dat +node_modules/ + +# Visual Studio 6 build log +*.plg + +# Visual Studio 6 workspace options file +*.opt + +# Visual Studio 6 auto-generated workspace file (contains which files were open etc.) +*.vbw + +# Visual Studio LightSwitch build output +**/*.HTMLClient/GeneratedArtifacts +**/*.DesktopClient/GeneratedArtifacts +**/*.DesktopClient/ModelManifest.xml +**/*.Server/GeneratedArtifacts +**/*.Server/ModelManifest.xml +_Pvt_Extensions + +# Paket dependency manager +.paket/paket.exe +paket-files/ + +# FAKE - F# Make +.fake/ + +# CodeRush personal settings +.cr/personal + +# Python Tools for Visual Studio (PTVS) +__pycache__/ +*.pyc + +# Cake - Uncomment if you are using it +# tools/** +# !tools/packages.config + +# Tabs Studio +*.tss + +# Telerik's JustMock configuration file +*.jmconfig + +# BizTalk build output +*.btp.cs +*.btm.cs +*.odx.cs +*.xsd.cs + +# OpenCover UI analysis results +OpenCover/ + +# Azure Stream Analytics local run output +ASALocalRun/ + +# MSBuild Binary and Structured Log +*.binlog + +# NVidia Nsight GPU debugger configuration file +*.nvuser + +# MFractors (Xamarin productivity tool) working folder +.mfractor/ + +# Local History for Visual Studio +.localhistory/ + +# BeatPulse healthcheck temp database +healthchecksdb + +# Backup folder for Package Reference Convert tool in Visual Studio 2017 +MigrationBackup/ + +# Ionide (cross platform F# VS Code tools) working folder +.ionide/ + +# Fody - auto-generated XML schema +FodyWeavers.xsd + +## +## Visual studio for Mac +## + + +# globs +Makefile.in +*.userprefs +*.usertasks +config.make +config.status +aclocal.m4 +install-sh +autom4te.cache/ +*.tar.gz +tarballs/ +test-results/ + +# Mac bundle stuff +*.dmg +*.app + +# content below from: https://github.com/github/gitignore/blob/master/Global/macOS.gitignore +# General +.DS_Store +.AppleDouble +.LSOverride + +# Icon must end with two \r +Icon + + +# Thumbnails +._* + +# Files that might appear in the root of a volume +.DocumentRevisions-V100 +.fseventsd +.Spotlight-V100 +.TemporaryItems +.Trashes +.VolumeIcon.icns +.com.apple.timemachine.donotpresent + +# Directories potentially created on remote AFP share +.AppleDB +.AppleDesktop +Network Trash Folder +Temporary Items +.apdisk + +# content below from: https://github.com/github/gitignore/blob/master/Global/Windows.gitignore +# Windows thumbnail cache files +Thumbs.db +ehthumbs.db +ehthumbs_vista.db + +# Dump file +*.stackdump + +# Folder config file +[Dd]esktop.ini + +# Recycle Bin used on file shares +$RECYCLE.BIN/ + +# Windows Installer files +*.cab +*.msi +*.msix +*.msm +*.msp + +# Windows shortcuts +*.lnk + +# JetBrains Rider +.idea/ +*.sln.iml + +## +## Visual Studio Code +## +.vscode/* +!.vscode/settings.json +!.vscode/tasks.json +!.vscode/launch.json +!.vscode/extensions.json diff --git a/Saradomin/App.axaml b/Saradomin/App.axaml new file mode 100644 index 0000000..e48d70b --- /dev/null +++ b/Saradomin/App.axaml @@ -0,0 +1,115 @@ + + + #3E3529 + #CC3E3529 + #3E3529 + #3E3529 + + #4F463A + #4F463A + #4F463A + + #6F5D45 + #6F5D45 + #6F5D45 + + #7F6D55 + #7F6D55 + #7F6D55 + + #8F7D65 + #8F7D65 + + #998468 + #998468 + + #A1855C + + #F0F0F0 + #F0F0F0 + + #FFFFFF + + #F2C954 + #B28914 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/Saradomin/App.axaml.cs b/Saradomin/App.axaml.cs new file mode 100644 index 0000000..6a52123 --- /dev/null +++ b/Saradomin/App.axaml.cs @@ -0,0 +1,30 @@ +using Avalonia; +using Avalonia.Controls.ApplicationLifetimes; +using Avalonia.Markup.Xaml; +using Glitonea; +using PropertyChanged; +using Saradomin.View.Windows; + +namespace Saradomin +{ + [DoNotNotify] + public class App : Application + { + + public override void Initialize() + { + AvaloniaXamlLoader.Load(this); + GlitoneaCore.Initialize(); + } + + public override void OnFrameworkInitializationCompleted() + { + if (ApplicationLifetime is IClassicDesktopStyleApplicationLifetime desktop) + { + desktop.MainWindow = new MainWindow(); + } + + base.OnFrameworkInitializationCompleted(); + } + } +} \ No newline at end of file diff --git a/Saradomin/FodyWeavers.xml b/Saradomin/FodyWeavers.xml new file mode 100644 index 0000000..d5abfed --- /dev/null +++ b/Saradomin/FodyWeavers.xml @@ -0,0 +1,3 @@ + + + \ No newline at end of file diff --git a/Saradomin/Infrastructure/Messages.cs b/Saradomin/Infrastructure/Messages.cs new file mode 100644 index 0000000..80c9e93 --- /dev/null +++ b/Saradomin/Infrastructure/Messages.cs @@ -0,0 +1,10 @@ +using Glitonea.Mvvm.Messaging; + +namespace Saradomin.Infrastructure +{ + public record MainViewLoadedMessage : Message; + public record NotificationBoxStateChangedMessage(bool WasOpened) : Message; + public record SettingsModifiedMessage(string SettingName) : Message; + public record ClientClosedMessage : Message; + public record ClientLaunchRequestedMessage : Message; +} \ No newline at end of file diff --git a/Saradomin/Infrastructure/Services/ClientLaunchService.cs b/Saradomin/Infrastructure/Services/ClientLaunchService.cs new file mode 100644 index 0000000..e5a2201 --- /dev/null +++ b/Saradomin/Infrastructure/Services/ClientLaunchService.cs @@ -0,0 +1,61 @@ +using System; +using System.Diagnostics; +using System.IO; +using System.IO.Compression; +using System.Net.Http; +using System.Runtime.InteropServices; +using System.Threading.Tasks; +using Avalonia; +using Glitonea.Extensions; +using Saradomin.Utilities; + +namespace Saradomin.Infrastructure.Services +{ + public class ClientLaunchService : IClientLaunchService + { + private readonly ISettingsService _settingsService; // Use the interface here + private readonly IClientUpdateService _clientUpdateService; + + public ClientLaunchService( + ISettingsService settingsService, // Use the interface here + IClientUpdateService clientUpdateService + ) + { + _settingsService = settingsService; + _clientUpdateService = clientUpdateService; + } + + public async Task LaunchClient() + { + // Original code to launch the game + var proc = new Process + { + StartInfo = new ProcessStartInfo( + $"{_settingsService.Launcher.JavaExecutableLocation}" + ) + { + Arguments = + $"-Dsun.java2d.uiScale={_settingsService.Client.UiScale} " + + $"-DclientFps={_settingsService.Client.Fps} " + + $"-DclientHomeOverride=\"{CrossPlatform.Get2009scapeHome()}/\" " + + $"-jar \"{_clientUpdateService.PreferredTargetFilePath}\"", + WorkingDirectory = $"{CrossPlatform.Get2009scapeHome()}", + UseShellExecute = true, + WindowStyle = ProcessWindowStyle.Hidden + } + }; + + proc.Start(); + + if (_settingsService.Launcher.ExitAfterLaunchingClient) + { + Application.Current.GetDesktopLifetime().Shutdown(); + return; + } + + await proc.WaitForExitAsync(); + } + + + } +} diff --git a/Saradomin/Infrastructure/Services/ClientUpdateService.cs b/Saradomin/Infrastructure/Services/ClientUpdateService.cs new file mode 100644 index 0000000..cfa53bc --- /dev/null +++ b/Saradomin/Infrastructure/Services/ClientUpdateService.cs @@ -0,0 +1,96 @@ +using System; +using System.IO; +using System.Net.Http; +using System.Security.Cryptography; +using System.Text; +using System.Threading; +using System.Threading.Tasks; +using Saradomin.Model.Settings.Launcher; +using Saradomin.Utilities; + +namespace Saradomin.Infrastructure.Services +{ + public class ClientUpdateService : IClientUpdateService + { + private readonly ISettingsService _settingsService; + + private float CurrentDownloadProgress { get; set; } + + public string ClientDownloadURL => "https://gitlab.com/2009scape/rt4-client/-/jobs/artifacts/master/raw/client/build/libs/rt4-client.jar?job=build"; + public string ClientHashURL => "https://gitlab.com/2009scape/rt4-client/-/jobs/artifacts/master/raw/client/build/libs/rt4-client.jar.sha256?job=build"; + + public string PreferredTargetFilePath => + CrossPlatform.Get2009scapeExecutable(); + + public event EventHandler DownloadProgressChanged; + + public ClientUpdateService(ISettingsService settingsService) + { + _settingsService = settingsService; + } + + public async Task FetchRemoteClientHashAsync(CancellationToken cancellationToken) + { + using var httpClient = new HttpClient(); + { + var response = await httpClient.GetAsync(ClientHashURL, cancellationToken); + return await response.Content.ReadAsStringAsync(cancellationToken); + } + } + + public async Task FetchRemoteClientExecutableAsync(CancellationToken cancellationToken, + string targetPath = null) + { + CurrentDownloadProgress = 0; + + targetPath ??= PreferredTargetFilePath; + + if (File.Exists(targetPath)) + { + File.Delete(targetPath); + } + + using (var httpClient = new HttpClient()) + { + var response = await httpClient.GetAsync(ClientDownloadURL, cancellationToken); + var contentLength = response.Content.Headers.ContentLength ?? 12 * 1024 * 1024 * 1024f; + + using var responseStream = await response.Content.ReadAsStreamAsync(cancellationToken); + using var outFileStream = File.OpenWrite(targetPath); + + var data = new byte[1024]; + var totalRead = 0; + + while (responseStream.Position < contentLength) + { + var dataRead = await responseStream.ReadAsync(data, 0, data.Length, cancellationToken); + + if (dataRead <= 0) + throw new IOException("Unexpected 0-byte read in network stream."); + + await outFileStream.WriteAsync(data[0..dataRead], cancellationToken); + totalRead += dataRead; + + CurrentDownloadProgress = totalRead / contentLength; + DownloadProgressChanged?.Invoke(this, CurrentDownloadProgress); + } + } + } + + public async Task ComputeLocalClientHashAsync(string filePath = null) + { + filePath ??= PreferredTargetFilePath; + + if (!File.Exists(filePath)) + throw new FileNotFoundException($"Unable to calculate local client hash. File '{filePath}' missing."); + + await using var stream = File.OpenRead(filePath); + { + var sha256 = SHA256.Create(); + stream.Position = 0; + var hash = await sha256.ComputeHashAsync(stream); + return BitConverter.ToString(hash).Replace("-", string.Empty); + } + } + } +} \ No newline at end of file diff --git a/Saradomin/Infrastructure/Services/IClientLaunchService.cs b/Saradomin/Infrastructure/Services/IClientLaunchService.cs new file mode 100644 index 0000000..6077379 --- /dev/null +++ b/Saradomin/Infrastructure/Services/IClientLaunchService.cs @@ -0,0 +1,10 @@ +using System.Threading.Tasks; +using Glitonea.Mvvm; + +namespace Saradomin.Infrastructure.Services +{ + public interface IClientLaunchService : IService + { + Task LaunchClient(); + } +} \ No newline at end of file diff --git a/Saradomin/Infrastructure/Services/IClientUpdateService.cs b/Saradomin/Infrastructure/Services/IClientUpdateService.cs new file mode 100644 index 0000000..f52f651 --- /dev/null +++ b/Saradomin/Infrastructure/Services/IClientUpdateService.cs @@ -0,0 +1,19 @@ +using System; +using System.Threading; +using System.Threading.Tasks; +using Glitonea.Mvvm; + +namespace Saradomin.Infrastructure.Services +{ + public interface IClientUpdateService : IService + { + string ClientDownloadURL { get; } + string PreferredTargetFilePath { get; } + + event EventHandler DownloadProgressChanged; + + Task FetchRemoteClientHashAsync(CancellationToken cancellationToken); + Task FetchRemoteClientExecutableAsync(CancellationToken cancellationToken, string targetPath = null); + Task ComputeLocalClientHashAsync(string filePath = null); + } +} \ No newline at end of file diff --git a/Saradomin/Infrastructure/Services/IJavaUpdateService.cs b/Saradomin/Infrastructure/Services/IJavaUpdateService.cs new file mode 100644 index 0000000..e2cd5be --- /dev/null +++ b/Saradomin/Infrastructure/Services/IJavaUpdateService.cs @@ -0,0 +1,12 @@ +using System; +using System.Threading.Tasks; +using Glitonea.Mvvm; + +namespace Saradomin.Infrastructure.Services +{ + public interface IJavaUpdateService : IService + { + event EventHandler> JavaDownloadProgressChanged; + Task DownloadAndSetJava11(ISettingsService settingsService); + } +} diff --git a/Saradomin/Infrastructure/Services/IPluginDownloadService.cs b/Saradomin/Infrastructure/Services/IPluginDownloadService.cs new file mode 100644 index 0000000..2bf44d5 --- /dev/null +++ b/Saradomin/Infrastructure/Services/IPluginDownloadService.cs @@ -0,0 +1,14 @@ +using System.Collections.Generic; +using System.Threading.Tasks; +using Glitonea.Mvvm; +using Saradomin.Model; + +namespace Saradomin.Infrastructure.Services +{ + public interface IPluginDownloadService : IService + { + Task> FetchFileListForPlugin(string pluginName); + Task DownloadPluginFiles(string pluginName, string pluginRepositoryPath); + Task> GetAllMetadata (string pluginRepositoryPath, bool isUpdateCheck, bool writePersistentUpdateFlag); + } +} \ No newline at end of file diff --git a/Saradomin/Infrastructure/Services/IPluginManagementService.cs b/Saradomin/Infrastructure/Services/IPluginManagementService.cs new file mode 100644 index 0000000..324ba13 --- /dev/null +++ b/Saradomin/Infrastructure/Services/IPluginManagementService.cs @@ -0,0 +1,18 @@ +using System.Collections.Generic; +using System.IO.Compression; +using System.Threading.Tasks; +using Glitonea.Mvvm; + +namespace Saradomin.Infrastructure.Services +{ + public interface IPluginManagementService : IService + { + string PluginRepositoryPath { get; set; } + + Task> EnumerateInstalledPlugins(); + Task IsPluginInstalled(string pluginName); + + Task UninstallPlugin(string pluginName); + Task InstallPlugin(ZipArchive zipArchive, string pluginName); + } +} \ No newline at end of file diff --git a/Saradomin/Infrastructure/Services/IRemoteConfigService.cs b/Saradomin/Infrastructure/Services/IRemoteConfigService.cs new file mode 100644 index 0000000..f63bc36 --- /dev/null +++ b/Saradomin/Infrastructure/Services/IRemoteConfigService.cs @@ -0,0 +1,17 @@ +using System.Collections.ObjectModel; +using System.Threading.Tasks; +using Glitonea.Mvvm; +using Saradomin.Model; + +namespace Saradomin.Infrastructure.Services +{ + public interface IRemoteConfigService : IService + { + ObservableCollection AvailableProfiles { get; } + + Task FetchServerProfileConfig(string outputPath); + Task LoadServerProfileConfig(string filePath); + + void LoadFailsafeDefaults(); + } +} \ No newline at end of file diff --git a/Saradomin/Infrastructure/Services/ISettingsService.cs b/Saradomin/Infrastructure/Services/ISettingsService.cs new file mode 100644 index 0000000..f51d656 --- /dev/null +++ b/Saradomin/Infrastructure/Services/ISettingsService.cs @@ -0,0 +1,14 @@ +using Glitonea.Mvvm; +using Saradomin.Model.Settings.Client; +using Saradomin.Model.Settings.Launcher; + +namespace Saradomin.Infrastructure.Services +{ + public interface ISettingsService : IService + { + LauncherSettings Launcher { get; } + ClientSettings Client { get; } + + void SaveAll(); + } +} \ No newline at end of file diff --git a/Saradomin/Infrastructure/Services/ISingleplayerUpdateService.cs b/Saradomin/Infrastructure/Services/ISingleplayerUpdateService.cs new file mode 100644 index 0000000..a2f798d --- /dev/null +++ b/Saradomin/Infrastructure/Services/ISingleplayerUpdateService.cs @@ -0,0 +1,12 @@ +using System; +using System.Threading.Tasks; +using Glitonea.Mvvm; + +namespace Saradomin.Infrastructure.Services +{ + public interface ISingleplayerUpdateService : IService + { + event EventHandler> SingleplayerDownloadProgressChanged; + Task DownloadSingleplayer(); + } +} diff --git a/Saradomin/Infrastructure/Services/JavaUpdateService.cs b/Saradomin/Infrastructure/Services/JavaUpdateService.cs new file mode 100644 index 0000000..e5fca80 --- /dev/null +++ b/Saradomin/Infrastructure/Services/JavaUpdateService.cs @@ -0,0 +1,103 @@ +using System; +using System.IO; +using System.IO.Compression; +using System.Net.Http; +using System.Runtime.InteropServices; +using System.Threading.Tasks; +using Saradomin.Utilities; + +namespace Saradomin.Infrastructure.Services +{ + public class JavaUpdateService : IJavaUpdateService + { + public event EventHandler> JavaDownloadProgressChanged; + + public async Task DownloadAndSetJava11(ISettingsService settingsService) + { + string downloadUrl = CrossPlatform.GetJava11DownloadUrl(); + + string downloadPath = Path.Combine( + CrossPlatform.Get2009scapeHome(), + "jre11" + Path.GetExtension(downloadUrl) + ); + string extractedPath = Path.Combine( + CrossPlatform.Get2009scapeHome(), + "jre11" + ); + + using (HttpClient httpClient = new HttpClient()) + { + var response = await httpClient.GetAsync(downloadUrl, HttpCompletionOption.ResponseHeadersRead); + var contentLength = response.Content.Headers.ContentLength ?? 40 * 1024 * 1024L; + var totalRead = 0L; + var buffer = new byte[8192]; + + // Create a FileStream to write the downloaded bytes to + await using (var fileStream = new FileStream(downloadPath, FileMode.Create, FileAccess.Write, FileShare.None)) + { + await using (var stream = await response.Content.ReadAsStreamAsync()) + { + int bytesRead; + do + { + bytesRead = await stream.ReadAsync(buffer, 0, buffer.Length); + totalRead += bytesRead; + + // Write the bytes to the FileStream + await fileStream.WriteAsync(buffer, 0, bytesRead); + + var progress = (float)totalRead / contentLength; + JavaDownloadProgressChanged?.Invoke(this, new Tuple(progress, false)); + } while (bytesRead > 0); + } + } + } + + JavaDownloadProgressChanged?.Invoke(this, new Tuple(1f, false)); + + if (Directory.Exists(extractedPath)) Directory.Delete(extractedPath, true); + + if (Path.GetExtension(downloadUrl) == ".zip") + { + // Don't use /tmp because Directory.Move doesn't work cross-partition + string tempDir = Path.Combine(CrossPlatform.Get2009scapeHome(), "jre11_temp"); + if (Directory.Exists(tempDir)) Directory.Delete(tempDir, true); + await Task.Run(() => ZipFile.ExtractToDirectory(downloadPath, tempDir)); + Directory.Move(Directory.GetDirectories(tempDir)[0], extractedPath); + Directory.Delete(tempDir, true); + } + else if (Path.GetExtension(downloadUrl) == ".gz" || Path.GetExtension(downloadUrl) == ".tar.gz") + { + Directory.CreateDirectory(extractedPath); + await Task.Run(() => CrossPlatform.RunCommandAndGetOutput($"tar xf {downloadPath} -C {extractedPath} --strip-components 1")); + } + + File.Delete(downloadPath); + + if (RuntimeInformation.IsOSPlatform(OSPlatform.OSX)) + { + settingsService.Launcher.JavaExecutableLocation = Path.Combine( + extractedPath, + "Contents", + "Home", + "bin", + "java" + ); + } else if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows)) { + settingsService.Launcher.JavaExecutableLocation = Path.Combine( + extractedPath, + "bin", + "java.exe" + ); + } else { + settingsService.Launcher.JavaExecutableLocation = Path.Combine( + extractedPath, + "bin", + "java" + ); + } + settingsService.SaveAll(); + JavaDownloadProgressChanged?.Invoke(this, new Tuple(1f, true)); + } + } +} diff --git a/Saradomin/Infrastructure/Services/PluginDownloadService.cs b/Saradomin/Infrastructure/Services/PluginDownloadService.cs new file mode 100644 index 0000000..551bda9 --- /dev/null +++ b/Saradomin/Infrastructure/Services/PluginDownloadService.cs @@ -0,0 +1,207 @@ +using System; +using System.Collections.Generic; +using System.Diagnostics; +using System.IO; +using System.Linq; +using System.Net.Http; +using System.Text.RegularExpressions; +using System.Threading.Tasks; +using GitLabApiClient; +using GitLabApiClient.Models.Trees.Responses; +using Saradomin.Model; +using Saradomin.View.Windows; + +namespace Saradomin.Infrastructure.Services +{ + public class PluginDownloadService : IPluginDownloadService + { + private const string GroupName = "2009scape"; + private const string ProjectName = "Tools/client-plugins"; + private const string BranchName = "master"; + + private readonly GitLabClient _gitLabClient; + private static IList _cachedQuery; + + public PluginDownloadService() + { + _gitLabClient = new GitLabClient("https://gitlab.com"); + } + + private async Task PerformInitialQuery() + { + _cachedQuery = await _gitLabClient.Trees.GetAsync($"{GroupName}/{ProjectName}", o => + { + o.Recursive = true; + o.Reference = BranchName; + } + ); + } + + public async Task> FetchPluginMetadataPaths() + { + if (_cachedQuery == null) await PerformInitialQuery(); + + return _cachedQuery + .Where(x => x.Type == "blob" && x.Path.Contains("properties")) + .Select(x => x.Path) + .ToList(); + } + + public async Task> FetchFileListForPlugin(string pluginName) + { + if (_cachedQuery == null) await PerformInitialQuery(); + + return _cachedQuery + .Where(x => x.Path.Contains(pluginName) && x.Type == "blob") + .Select(x => x.Path) + .ToList(); + } + + public async Task DownloadPluginFiles(string pluginName, string pluginRepositoryPath) + { + var directoryPath = Path.Combine(pluginRepositoryPath, pluginName); + if (!Directory.Exists(directoryPath)) + { + Directory.CreateDirectory(directoryPath); + } + else + { + foreach (var file in Directory.EnumerateFiles(directoryPath)) + { + File.Delete(file); + } + } + + var pluginFiles = await FetchFileListForPlugin(pluginName); + foreach (var filePath in pluginFiles) + { + var file = await _gitLabClient.Files.GetAsync($"{GroupName}/{ProjectName}", filePath, BranchName); + + var downloadDirectoryPath = Path.Combine(pluginRepositoryPath, Path.GetDirectoryName(filePath)!); + var downloadFilePath = Path.Combine(pluginRepositoryPath, filePath); + + Directory.CreateDirectory(downloadDirectoryPath); + + await File.WriteAllBytesAsync( + downloadFilePath, + Convert.FromBase64String(file.Content) + ); + } + } + + public async Task > GetAllMetadata (string pluginRepositoryPath, bool isUpdateCheck, bool writePersistentUpdateFlag) + { + try + { + var metadataPaths = await FetchPluginMetadataPaths(); + var infos = new List(); + + foreach (var path in metadataPaths) + { + infos.Add(await ProcessMetadataPath(path, pluginRepositoryPath, isUpdateCheck, + writePersistentUpdateFlag)); + } + + return isUpdateCheck ? infos.Where(x => x.UpdateAvailable).ToList() : infos; + } + catch (HttpRequestException e) + { + return new List(); + } + } + + private async Task ProcessMetadataPath(string path, string pluginRepositoryPath, bool isUpdateCheck, bool writePersistentUpdateFlag) + { + var pluginName = path.Split("/")[0]; + var pluginFolder = Path.Combine(pluginRepositoryPath, pluginName); + + if (!Directory.Exists(pluginFolder)) + Directory.CreateDirectory(pluginFolder); + + var filePath = Path.Combine(pluginFolder, "plugin.properties"); + var fileContent = ""; + var updateContent = ""; + + if (!File.Exists(filePath) || isUpdateCheck) + { + var file = await _gitLabClient.Files.GetAsync($"{GroupName}/{ProjectName}", path, BranchName); + if (isUpdateCheck && File.Exists(filePath)) + { + fileContent = await File.ReadAllTextAsync(filePath); + updateContent = file.ContentDecoded; + } + else if (isUpdateCheck) + fileContent = updateContent = file.ContentDecoded; + else + fileContent = file.ContentDecoded; + + if (!isUpdateCheck) + { + await File.WriteAllBytesAsync( + filePath, + Convert.FromBase64String(file.Content) + ); + } + } + else if (File.Exists(filePath)) + { + fileContent = await File.ReadAllTextAsync(filePath); + } + + var info = ParseInfo(pluginName, fileContent); + var updatedInfo = !string.IsNullOrEmpty(updateContent) ? ParseInfo(pluginName, updateContent) : info; + + if (isUpdateCheck && updatedInfo.Version != info.Version) + { + if (writePersistentUpdateFlag) + await File.WriteAllTextAsync(filePath, fileContent + "\r\nUPDATEAVAILABLE=1"); + info.UpdateAvailable = true; + } + + info.Installed = File.Exists(Path.Combine(pluginFolder, "plugin.class")); + return info; + } + + public static PluginInfo ParseInfo(string pluginName, string text) + { + var lines = new Regex("\r\n|\r|\n").Split(text); + var parsedData = new Dictionary(); + var lastKey = ""; + + foreach (var lineInfo in lines.Select(t => t.Split("="))) + { + if (lineInfo.Length > 1) + { + parsedData.Add (lineInfo[0], lineInfo[1].Trim('\'').Trim()); + lastKey = lineInfo[0]; + } + else + { + parsedData[lastKey] += lineInfo[0]; + } + } + + var info = new PluginInfo(pluginName); + foreach (var (key, value) in parsedData) + { + switch (key.ToLower()) + { + case "author": + info.Author = value; + break; + case "description": + info.Description = value.Replace("\\", System.Environment.NewLine); + break; + case "version": + info.Version = value; + break; + case "updateavailable": + info.UpdateAvailable = true; + break; + } + } + + return info; + } + } +} \ No newline at end of file diff --git a/Saradomin/Infrastructure/Services/PluginManagementService.cs b/Saradomin/Infrastructure/Services/PluginManagementService.cs new file mode 100644 index 0000000..2059bc4 --- /dev/null +++ b/Saradomin/Infrastructure/Services/PluginManagementService.cs @@ -0,0 +1,68 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.IO.Compression; +using System.Linq; +using System.Threading.Tasks; +using Saradomin.Utilities; + +namespace Saradomin.Infrastructure.Services +{ + public class PluginManagementService : IPluginManagementService + { + public string PluginRepositoryPath { get; set; } + + public PluginManagementService(ISettingsService settings) + { + PluginRepositoryPath = Path.Combine(CrossPlatform.Get2009scapeHome(), "plugins"); + } + + public Task> EnumerateInstalledPlugins() + { + EnsurePluginRepositoryPathSane(); + + return Task.FromResult(Directory + .GetDirectories(PluginRepositoryPath, "*", SearchOption.TopDirectoryOnly) + .Select(x => Path.GetFileName(x)).ToList()); + } + + public async Task IsPluginInstalled(string pluginName) + { + EnsurePluginRepositoryPathSane(); + + return (await EnumerateInstalledPlugins()) + .Contains(pluginName); + } + + public Task UninstallPlugin(string pluginName) + { + EnsurePluginRepositoryPathSane(); + var pluginPath = GetPluginDirectoryPath(pluginName); + + if (Directory.Exists(pluginPath)) + { + Directory.Delete(pluginPath, true); + } + + return Task.CompletedTask; + } + + public Task InstallPlugin(ZipArchive zipArchive, string pluginName) + { + throw new NotSupportedException("Feature not supported yet."); + } + + private string GetPluginDirectoryPath(string pluginName) + => Path.Combine(PluginRepositoryPath, pluginName); + + private void EnsurePluginRepositoryPathSane() + { + if (string.IsNullOrWhiteSpace(PluginRepositoryPath)) + { + throw new InvalidOperationException("Plugin repository path has not been set."); + } + + Directory.CreateDirectory(PluginRepositoryPath); + } + } +} \ No newline at end of file diff --git a/Saradomin/Infrastructure/Services/RemoteConfigService.cs b/Saradomin/Infrastructure/Services/RemoteConfigService.cs new file mode 100644 index 0000000..0046fc7 --- /dev/null +++ b/Saradomin/Infrastructure/Services/RemoteConfigService.cs @@ -0,0 +1,81 @@ +using System; +using System.Collections.ObjectModel; +using System.IO; +using System.Net.Http; +using System.Text.Json; +using System.Threading.Tasks; +using Saradomin.Model; + +namespace Saradomin.Infrastructure.Services +{ + public class RemoteConfigService : IRemoteConfigService + { + private const string ServerProfilesURL = + "https://emoscape.org/server_profiles.json"; + + public ObservableCollection AvailableProfiles { get; private set; } = new(); + + public async Task FetchServerProfileConfig(string outputPath) + { + using (var httpClient = new HttpClient { Timeout = TimeSpan.FromSeconds(5) }) + { + var configJson = await httpClient.GetStringAsync(ServerProfilesURL); + + if (File.Exists(outputPath)) + { + File.Delete(outputPath); + } + else + { + await File.WriteAllTextAsync(outputPath!, configJson); + } + } + } + + public async Task LoadServerProfileConfig(string filePath) + { + using (var sr = new StreamReader(filePath)) + { + AvailableProfiles = JsonSerializer.Deserialize>( + await sr.ReadToEndAsync() + ); + } + } + + public void LoadFailsafeDefaults() + { + AvailableProfiles = new ObservableCollection + { + new() + { + Name = "Local server", + ManagementServerAddress = "localhost", + GameServerAddress = "localhost", + GameServerPort = 43594, + WorldListServerPort = 43595, + CacheServerPort = 43595 + }, + + new() + { + Name = "EmoScape Live Game", + ManagementServerAddress = "play.emoscape.org", + GameServerAddress = "play.emoscape.org", + GameServerPort = 43594, + WorldListServerPort = 43595, + CacheServerPort = 43595 + }, + + new() + { + Name = "Original 2009Scape Live Server", + ManagementServerAddress = "play.2009scape.org", + GameServerAddress = "play.2009scape.org", + GameServerPort = 43594, + WorldListServerPort = 43595, + CacheServerPort = 43595 + }, + }; + } + } +} diff --git a/Saradomin/Infrastructure/Services/SettingsService.cs b/Saradomin/Infrastructure/Services/SettingsService.cs new file mode 100644 index 0000000..9e3f71e --- /dev/null +++ b/Saradomin/Infrastructure/Services/SettingsService.cs @@ -0,0 +1,84 @@ +using System; +using System.IO; +using System.Text.Json; +using Saradomin.Model.Settings.Client; +using Saradomin.Model.Settings.Launcher; +using Saradomin.Utilities; + +namespace Saradomin.Infrastructure.Services +{ + public class SettingsService : ISettingsService + { + public LauncherSettings Launcher { get; private set; } = new(); + public ClientSettings Client { get; private set; } = new(); + + private string ClientSettingsPath + => Path.Combine(CrossPlatform.Get2009scapeHome(), ClientSettings.FileName); + + private string LauncherSettingsPath + => Path.Combine(CrossPlatform.GetSaradominHome(), LauncherSettings.FileName); + + public SettingsService() + { + TryReadConfigurationData(); + } + + public void SaveAll() + { + SaveLauncherSettings(); + SaveClientSettings(); + } + + private void TryReadConfigurationData() + { + Directory.CreateDirectory(CrossPlatform.GetSaradominHome()); + + if (File.Exists(LauncherSettingsPath)) + { + using (var stream = File.OpenRead(LauncherSettingsPath)) + { + Launcher = JsonSerializer.Deserialize(stream); + } + } + else + { + SaveLauncherSettings(); + } + + Directory.CreateDirectory(CrossPlatform.Get2009scapeHome()); + if (File.Exists(ClientSettingsPath)) + { + using (var stream = File.OpenRead(ClientSettingsPath)) + { + Client = JsonSerializer.Deserialize(stream); + } + } + else + { + SaveClientSettings(); + } + } + + private void SaveLauncherSettings() + { + File.WriteAllText( + LauncherSettingsPath, + JsonSerializer.Serialize(Launcher, new JsonSerializerOptions + { + WriteIndented = true + }) + ); + } + + private void SaveClientSettings() + { + File.WriteAllText( + ClientSettingsPath, + JsonSerializer.Serialize(Client, new JsonSerializerOptions + { + WriteIndented = true + }) + ); + } + } +} \ No newline at end of file diff --git a/Saradomin/Infrastructure/Services/SingleplayerUpdateService.cs b/Saradomin/Infrastructure/Services/SingleplayerUpdateService.cs new file mode 100644 index 0000000..aa0d795 --- /dev/null +++ b/Saradomin/Infrastructure/Services/SingleplayerUpdateService.cs @@ -0,0 +1,70 @@ +using System; +using System.IO; +using System.IO.Compression; +using System.Net.Http; +using System.Threading.Tasks; +using Saradomin.Utilities; + +namespace Saradomin.Infrastructure.Services +{ + public class SingleplayerUpdateService : ISingleplayerUpdateService + { + public event EventHandler> SingleplayerDownloadProgressChanged; + + public async Task DownloadSingleplayer() + { + SingleplayerDownloadProgressChanged?.Invoke(this, new Tuple(0f, false)); + string downloadUrl = + "https://gitlab.com/2009scape/singleplayer/windows/-/archive/master/windows-master.zip"; + + string downloadPath = Path.Combine( + CrossPlatform.Get2009scapeHome(), + "singleplayer" + Path.GetExtension(downloadUrl) + ); + + using (HttpClient httpClient = new HttpClient()) + { + var response = await httpClient.GetAsync(downloadUrl, HttpCompletionOption.ResponseHeadersRead); + var contentLength = response.Content.Headers.ContentLength ?? 40 * 1024 * 1024L; + var totalRead = 0L; + var buffer = new byte[8192]; + + // Create a FileStream to write the downloaded bytes to + await using (var fileStream = + new FileStream(downloadPath, FileMode.Create, FileAccess.Write, FileShare.None)) + { + await using (var stream = await response.Content.ReadAsStreamAsync()) + { + int bytesRead; + do + { + bytesRead = await stream.ReadAsync(buffer, 0, buffer.Length); + totalRead += bytesRead; + + // Write the bytes to the FileStream + await fileStream.WriteAsync(buffer, 0, bytesRead); + + var progress = (float)totalRead / contentLength; + SingleplayerDownloadProgressChanged?.Invoke(this, + new Tuple(progress, false)); + } while (bytesRead > 0); + } + } + } + + SingleplayerDownloadProgressChanged?.Invoke(this, new Tuple(1f, false)); + + if (Directory.Exists(CrossPlatform.GetSingleplayerHome())) Directory.Delete(CrossPlatform.GetSingleplayerHome(), true); + + // Don't use /tmp because Directory.Move doesn't work cross-partition + string tempDir = Path.Combine(CrossPlatform.Get2009scapeHome(), "singleplayer_temp"); + if (Directory.Exists(tempDir)) Directory.Delete(tempDir, true); + await Task.Run(() => ZipFile.ExtractToDirectory(downloadPath, tempDir)); + Directory.Move(Directory.GetDirectories(tempDir)[0], CrossPlatform.GetSingleplayerHome()); + Directory.Delete(tempDir, true); + + File.Delete(downloadPath); + SingleplayerDownloadProgressChanged?.Invoke(this, new Tuple(1f, true)); + } + } +} diff --git a/Saradomin/Model/PluginInfo.cs b/Saradomin/Model/PluginInfo.cs new file mode 100644 index 0000000..3bb044d --- /dev/null +++ b/Saradomin/Model/PluginInfo.cs @@ -0,0 +1,23 @@ +using System.Linq; +using System.Text.RegularExpressions; + +namespace Saradomin.Model +{ + public class PluginInfo + { + private static Regex DescSplitRegex = new Regex("\r\n|\r|\n"); + public string Name { get; set; } + public string Author { get; set; } + public string Description { get; set; } + public string Version { get; set; } + public bool Installed { get; set; } + public bool UpdateAvailable { get; set; } + public bool CanUpdate => UpdateAvailable && Installed; + public string DescriptionShort => DescSplitRegex.Split(Description)[0]; + + public PluginInfo(string name) + { + Name = name; + } + } +} \ No newline at end of file diff --git a/Saradomin/Model/ServerProfile.cs b/Saradomin/Model/ServerProfile.cs new file mode 100644 index 0000000..e0043d0 --- /dev/null +++ b/Saradomin/Model/ServerProfile.cs @@ -0,0 +1,25 @@ +using System.Text.Json.Serialization; + +namespace Saradomin.Model +{ + public class ServerProfile + { + [JsonPropertyName("name")] + public string Name { get; set; } + + [JsonPropertyName("ip_management")] + public string ManagementServerAddress { get; set; } + + [JsonPropertyName("ip_address")] + public string GameServerAddress { get; set; } + + [JsonPropertyName("server_port")] + public ushort GameServerPort { get; set; } + + [JsonPropertyName("wl_port")] + public ushort WorldListServerPort { get; set; } + + [JsonPropertyName("js5_port")] + public ushort CacheServerPort { get; set; } + } +} \ No newline at end of file diff --git a/Saradomin/Model/Settings/Client/ClientSettings.cs b/Saradomin/Model/Settings/Client/ClientSettings.cs new file mode 100644 index 0000000..2776343 --- /dev/null +++ b/Saradomin/Model/Settings/Client/ClientSettings.cs @@ -0,0 +1,54 @@ +using System; +using System.ComponentModel; +using System.Text.Json.Serialization; + +namespace Saradomin.Model.Settings.Client +{ + public class ClientSettings : SettingsBase + { + public const string FileName = "config.json"; + + public const string LiveServerAddress = "play.2009scape.org"; + public const string TestServerAddress = "test.2009scape.org"; + public const string LocalServerAddress = "localhost"; + + public enum ServerProfile + { + [Description("Stable server;play.2009scape.org")] + Live, + + [Description("Testing server;test.2009scape.org")] + Testing, + + [Description("Local server;localhost")] + Local, + + [Description("Unsupported server")] + Unsupported + } + + [JsonPropertyName("ip_management")] + public string ManagementServerAddress { get; set; } = LiveServerAddress; + + [JsonPropertyName("ip_address")] + public string GameServerAddress { get; set; } = LiveServerAddress; + + [JsonPropertyName("world")] + public ushort World { get; set; } = 1; + + [JsonPropertyName("server_port")] + public ushort GameServerPort { get; set; } = 43594; + + [JsonPropertyName("wl_port")] + public ushort WorldListServerPort { get; set; } = 43595; + + [JsonPropertyName("js5_port")] + public ushort CacheServerPort { get; set; } = 43595; + + [JsonPropertyName("ui_scale")] + public int UiScale { get; set; } = 1; + + [JsonPropertyName("fps")] + public int Fps { get; set; } = 0; + } +} diff --git a/Saradomin/Model/Settings/Launcher/LauncherSettings.cs b/Saradomin/Model/Settings/Launcher/LauncherSettings.cs new file mode 100644 index 0000000..0bd6aff --- /dev/null +++ b/Saradomin/Model/Settings/Launcher/LauncherSettings.cs @@ -0,0 +1,24 @@ +using Saradomin.Utilities; + +namespace Saradomin.Model.Settings.Launcher +{ + public class LauncherSettings : SettingsBase + { + public const string FileName = "saradomin_launcher.json"; + + public bool PlaceCloseButtonOnLeft { get; set; } = false; + public bool ExitAfterLaunchingClient { get; set; } = true; + public bool AllowMultiboxing { get; set; } = false; + public bool CheckForClientUpdatesOnLaunch { get; set; } = true; + public bool CheckForServerProfilesOnLaunch { get; set; } = true; + public string JavaExecutableLocation { get; set; } + + protected override void OnSettingsModified(string propertyName) + { + if (propertyName == nameof(AllowMultiboxing) && AllowMultiboxing) + { + ExitAfterLaunchingClient = false; + } + } + } +} \ No newline at end of file diff --git a/Saradomin/Model/Settings/SettingsBase.cs b/Saradomin/Model/Settings/SettingsBase.cs new file mode 100644 index 0000000..c0f8f62 --- /dev/null +++ b/Saradomin/Model/Settings/SettingsBase.cs @@ -0,0 +1,8 @@ + +namespace Saradomin.Model.Settings +{ + public abstract class SettingsBase : SettingsComponent + { + // Marker + } +} \ No newline at end of file diff --git a/Saradomin/Model/Settings/SettingsComponent.cs b/Saradomin/Model/Settings/SettingsComponent.cs new file mode 100644 index 0000000..165057f --- /dev/null +++ b/Saradomin/Model/Settings/SettingsComponent.cs @@ -0,0 +1,27 @@ +using System.ComponentModel; +using Saradomin.Infrastructure; + +namespace Saradomin.Model.Settings +{ + public class SettingsComponent : INotifyPropertyChanged + { + public event PropertyChangedEventHandler PropertyChanged; + + public SettingsComponent() + { + PropertyChanged += RaiseSettingsModified; + } + + protected void RaiseSettingsModified(object sender, PropertyChangedEventArgs e) + { + OnSettingsModified(e.PropertyName); + + new SettingsModifiedMessage(e.PropertyName) + .Broadcast(); + } + + protected virtual void OnSettingsModified(string propertyName) + { + } + } +} \ No newline at end of file diff --git a/Saradomin/Program.cs b/Saradomin/Program.cs new file mode 100644 index 0000000..3790745 --- /dev/null +++ b/Saradomin/Program.cs @@ -0,0 +1,19 @@ +using System; +using Avalonia; + +namespace Saradomin +{ + internal class Program + { + [STAThread] + public static void Main(string[] args) + { + BuildAvaloniaApp().StartWithClassicDesktopLifetime(args); + } + + public static AppBuilder BuildAvaloniaApp() + => AppBuilder.Configure() + .UsePlatformDetect() + .LogToTrace(); + } +} \ No newline at end of file diff --git a/Saradomin/Resources/Branding/0.png b/Saradomin/Resources/Branding/0.png new file mode 100644 index 0000000..6e2018f Binary files /dev/null and b/Saradomin/Resources/Branding/0.png differ diff --git a/Saradomin/Resources/Branding/1.png b/Saradomin/Resources/Branding/1.png new file mode 100644 index 0000000..ce6a4e7 Binary files /dev/null and b/Saradomin/Resources/Branding/1.png differ diff --git a/Saradomin/Resources/Branding/2.png b/Saradomin/Resources/Branding/2.png new file mode 100644 index 0000000..29c9455 Binary files /dev/null and b/Saradomin/Resources/Branding/2.png differ diff --git a/Saradomin/Resources/Branding/3.png b/Saradomin/Resources/Branding/3.png new file mode 100644 index 0000000..996ec58 Binary files /dev/null and b/Saradomin/Resources/Branding/3.png differ diff --git a/Saradomin/Resources/Branding/4.png b/Saradomin/Resources/Branding/4.png new file mode 100644 index 0000000..8f721ec Binary files /dev/null and b/Saradomin/Resources/Branding/4.png differ diff --git a/Saradomin/Resources/Icons/saradomin.icns b/Saradomin/Resources/Icons/saradomin.icns new file mode 100644 index 0000000..7baa5f2 Binary files /dev/null and b/Saradomin/Resources/Icons/saradomin.icns differ diff --git a/Saradomin/Resources/Icons/saradomin.ico b/Saradomin/Resources/Icons/saradomin.ico new file mode 100644 index 0000000..13e560f Binary files /dev/null and b/Saradomin/Resources/Icons/saradomin.ico differ diff --git a/Saradomin/Resources/Icons/saradomin.svg b/Saradomin/Resources/Icons/saradomin.svg new file mode 100644 index 0000000..1b772cb --- /dev/null +++ b/Saradomin/Resources/Icons/saradomin.svg @@ -0,0 +1 @@ + diff --git a/Saradomin/Resources/Linux/org._2009scape.Launcher.appdata.xml b/Saradomin/Resources/Linux/org._2009scape.Launcher.appdata.xml new file mode 100644 index 0000000..3a0d335 --- /dev/null +++ b/Saradomin/Resources/Linux/org._2009scape.Launcher.appdata.xml @@ -0,0 +1,83 @@ + + + org._2009scape.Launcher + org._2009scape.Launcher.desktop + 2009scape + 2009scape + 2009 Runescape Emulation + CC0-1.0 + AGPL-3.0-or-later + https://2009scape.org/ + + +

2009scape is a free, open-source launcher for Runescape 2009 Emulation servers

+

Not affiliated with the Jagex Launcher or OSRS.

+ + + + + https://i.imgur.com/pmcGBRd.jpg + Running from Chickens - 2009scape, Play Now! + + + https://i.imgur.com/mKJ3j1c.png + 2009scape Screenshot Collage - 2009scape Fully Authentic Remake + + + https://i.imgur.com/HlyM2vN.png + 2009scape Login Screen - 2009scape has been hosted since 2017 for free + + + https://i.imgur.com/SHqJlKf.png + A 2009scape player in Falador after a Wyvern trip + + + https://i.imgur.com/ZzXLnkc.png + 2009scape Hiscores - Players have cumulatively played over 20,000 hours on 2009scape + + + + + + +

Improved Singleplayer Experience

+

Bugfixes and UI/UX improvements

+ + + + +

Flatpak no longer has direct access to xdg-data/2009scape, and will instead use paths given by the Flatpak runtime environment (i.e. ~/.var/app/org._2009scape.Launcher)

+ + + + +

Small formatting improvements to Latest News feed

+ + + + +

Added Singleplayer Server Hosting to launcher

+

Bugfixes

+ + + + +

Plugin Management Overhaul

+

Bugfixes

+ + + + + + moderate + moderate + mild + moderate + mild + moderate + mild + mild + moderate + moderate + + diff --git a/Saradomin/Resources/Linux/org._2009scape.Launcher.desktop b/Saradomin/Resources/Linux/org._2009scape.Launcher.desktop new file mode 100644 index 0000000..522e506 --- /dev/null +++ b/Saradomin/Resources/Linux/org._2009scape.Launcher.desktop @@ -0,0 +1,10 @@ +[Desktop Entry] +Type=Application +Terminal=false +Name=2009scape +GenericName=2009scape Launcher +Comment=2009scape Launcher is a free, open-source launcher for Runescape 2009 compatible servers +Keywords=game;runescape;2009scape;osrs;saradomin +Exec=2009scape-launcher +Icon=org._2009scape.Launcher +Categories=Game;RolePlaying; diff --git a/Saradomin/Resources/Styles/CheckBox.axaml b/Saradomin/Resources/Styles/CheckBox.axaml new file mode 100644 index 0000000..0940940 --- /dev/null +++ b/Saradomin/Resources/Styles/CheckBox.axaml @@ -0,0 +1,67 @@ + + + + + + + + + + + \ No newline at end of file diff --git a/Saradomin/Resources/Styles/CloseButton.axaml b/Saradomin/Resources/Styles/CloseButton.axaml new file mode 100644 index 0000000..b7da9d0 --- /dev/null +++ b/Saradomin/Resources/Styles/CloseButton.axaml @@ -0,0 +1,29 @@ + + + + + + + \ No newline at end of file diff --git a/Saradomin/Resources/Styles/ComboBox.axaml b/Saradomin/Resources/Styles/ComboBox.axaml new file mode 100644 index 0000000..887ebac --- /dev/null +++ b/Saradomin/Resources/Styles/ComboBox.axaml @@ -0,0 +1,63 @@ + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/Saradomin/Resources/Styles/Expander.axaml b/Saradomin/Resources/Styles/Expander.axaml new file mode 100644 index 0000000..dd72233 --- /dev/null +++ b/Saradomin/Resources/Styles/Expander.axaml @@ -0,0 +1,34 @@ + + + + + + + + + + + + + + + + + diff --git a/Saradomin/Resources/Styles/GroupBox.axaml b/Saradomin/Resources/Styles/GroupBox.axaml new file mode 100644 index 0000000..2689191 --- /dev/null +++ b/Saradomin/Resources/Styles/GroupBox.axaml @@ -0,0 +1,36 @@ + + + \ No newline at end of file diff --git a/Saradomin/Resources/Styles/Hyperlink.axaml b/Saradomin/Resources/Styles/Hyperlink.axaml new file mode 100644 index 0000000..136cb7b --- /dev/null +++ b/Saradomin/Resources/Styles/Hyperlink.axaml @@ -0,0 +1,33 @@ + + + + + + + + + + + + \ No newline at end of file diff --git a/Saradomin/Resources/Styles/ListBox.axaml b/Saradomin/Resources/Styles/ListBox.axaml new file mode 100644 index 0000000..d341e62 --- /dev/null +++ b/Saradomin/Resources/Styles/ListBox.axaml @@ -0,0 +1,9 @@ + + + \ No newline at end of file diff --git a/Saradomin/Resources/Styles/ListBoxItem.axaml b/Saradomin/Resources/Styles/ListBoxItem.axaml new file mode 100644 index 0000000..7c56cf6 --- /dev/null +++ b/Saradomin/Resources/Styles/ListBoxItem.axaml @@ -0,0 +1,38 @@ + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/Saradomin/Resources/Styles/NumericUpDown.axaml b/Saradomin/Resources/Styles/NumericUpDown.axaml new file mode 100644 index 0000000..5208b42 --- /dev/null +++ b/Saradomin/Resources/Styles/NumericUpDown.axaml @@ -0,0 +1,92 @@ + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/Saradomin/Resources/Styles/OutsideNavigatorButton.axaml b/Saradomin/Resources/Styles/OutsideNavigatorButton.axaml new file mode 100644 index 0000000..06078dc --- /dev/null +++ b/Saradomin/Resources/Styles/OutsideNavigatorButton.axaml @@ -0,0 +1,31 @@ + + + + + + + + + \ No newline at end of file diff --git a/Saradomin/Resources/Styles/RadioButton.axaml b/Saradomin/Resources/Styles/RadioButton.axaml new file mode 100644 index 0000000..434849b --- /dev/null +++ b/Saradomin/Resources/Styles/RadioButton.axaml @@ -0,0 +1,70 @@ + + + + + + + + + + + \ No newline at end of file diff --git a/Saradomin/Resources/Styles/ScrollBar.axaml b/Saradomin/Resources/Styles/ScrollBar.axaml new file mode 100644 index 0000000..8a7cc09 --- /dev/null +++ b/Saradomin/Resources/Styles/ScrollBar.axaml @@ -0,0 +1,67 @@ + + + + + + + + + + + + + + \ No newline at end of file diff --git a/Saradomin/Resources/Styles/TextBlock.axaml b/Saradomin/Resources/Styles/TextBlock.axaml new file mode 100644 index 0000000..7d9c9a0 --- /dev/null +++ b/Saradomin/Resources/Styles/TextBlock.axaml @@ -0,0 +1,6 @@ + + + diff --git a/Saradomin/Resources/Styles/TextBox.axaml b/Saradomin/Resources/Styles/TextBox.axaml new file mode 100644 index 0000000..a6c345e --- /dev/null +++ b/Saradomin/Resources/Styles/TextBox.axaml @@ -0,0 +1,30 @@ + + + + + + + + + + + \ No newline at end of file diff --git a/Saradomin/Resources/Styles/ToolTip.axaml b/Saradomin/Resources/Styles/ToolTip.axaml new file mode 100644 index 0000000..c31db2f --- /dev/null +++ b/Saradomin/Resources/Styles/ToolTip.axaml @@ -0,0 +1,9 @@ + + + \ No newline at end of file diff --git a/Saradomin/Resources/Styles/TopBarNavigation.axaml b/Saradomin/Resources/Styles/TopBarNavigation.axaml new file mode 100644 index 0000000..d0083af --- /dev/null +++ b/Saradomin/Resources/Styles/TopBarNavigation.axaml @@ -0,0 +1,44 @@ + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/Saradomin/Saradomin.csproj b/Saradomin/Saradomin.csproj new file mode 100644 index 0000000..4b800a1 --- /dev/null +++ b/Saradomin/Saradomin.csproj @@ -0,0 +1,79 @@ + + + WinExe + net6.0 + 1.6.1 + IL2026;CS0067 + Resources\Icons\saradomin.ico + true + Saradomin.Program + + + + $(NugetPackageRoot)\nsubsys\1.0.0\tool\NSubsys.Tasks.dll + + + + + + + + + + + + + + + + + + + + + + + runtime; build; native; contentfiles; analyzers; buildtransitive + all + + + + + + + + + + + MainWindow.axaml + Code + + + NotificationBox.axaml + Code + + + MainWindow.axaml + Code + + + MainWindow.axaml + Code + + + MenuPreview.axaml + Code + + + PluginManagerView.axaml + + + SingleplayerView.axaml + Code + + + + + + + diff --git a/Saradomin/Utilities/CrossPlatform.cs b/Saradomin/Utilities/CrossPlatform.cs new file mode 100644 index 0000000..202f3aa --- /dev/null +++ b/Saradomin/Utilities/CrossPlatform.cs @@ -0,0 +1,399 @@ +using System; +using System.Diagnostics; +using System.IO; +using System.Runtime.InteropServices; +using System.Text; +using Microsoft.Win32; +using Mono.Unix; + +namespace Saradomin.Utilities +{ + public static class CrossPlatform + { + public static void LaunchURL(string url) + { + if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows)) + { + url = url.Replace("&", "^&"); + Process.Start(new ProcessStartInfo(url) { UseShellExecute = true }); + } + else if (RuntimeInformation.IsOSPlatform(OSPlatform.Linux)) + { + Process.Start("xdg-open", url); + } + else if (RuntimeInformation.IsOSPlatform(OSPlatform.OSX)) + { + Process.Start("open", url); + } + } + + public static void OpenFolder(string path) + { + if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows)) + { + Process.Start(new ProcessStartInfo(path) { UseShellExecute = true }); + } + else if (RuntimeInformation.IsOSPlatform(OSPlatform.Linux)) + { + Process.Start("xdg-open", path); + } + else if (RuntimeInformation.IsOSPlatform(OSPlatform.OSX)) + { + Process.Start("open", path); + } + } + + public static bool IsJavaExecutableValid(string location) + { + try + { + if (!File.Exists(location)) + { + return false; + } + + using (var fileStream = File.OpenRead(location)) + { + var bytes = new byte[4]; + fileStream.Read(bytes, 0, 4); + + if (bytes[0] == 0x7F + && bytes[1] == 0x45 + && bytes[2] == 0x4C + && bytes[3] == 0x46) + { + return RuntimeInformation.IsOSPlatform(OSPlatform.Linux); + } + + if (bytes[0] == 'M' + && bytes[1] == 'Z') + { + return RuntimeInformation.IsOSPlatform(OSPlatform.Windows); + } + + if ((bytes[0] == 0xCF + && bytes[1] == 0xFA) + || (bytes[0] == 0xCA + && bytes[1] == 0xFE)) + { + return RuntimeInformation.IsOSPlatform(OSPlatform.OSX); + } + + } + } + catch + { + // Ignore + } + + return false; + } + + public static string LocateJavaExecutable() + { + if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows)) + { + var envPath = Environment.GetEnvironmentVariable("JAVA_HOME"); + + if (!string.IsNullOrEmpty(envPath)) + return Path.Combine(envPath, "bin/java.exe"); + + using (var rk = Registry.LocalMachine.OpenSubKey("SOFTWARE\\JavaSoft\\Java Runtime Environment\\")) + { + if (rk == null) + return null; + + var currentVersion = rk.GetValue("CurrentVersion")?.ToString(); + + if (currentVersion == null) + return null; + + using (var key = rk.OpenSubKey(currentVersion)) + { + if (key == null) + return null; + + envPath = key.GetValue("JavaHome")?.ToString(); + } + } + + if (!string.IsNullOrEmpty(envPath)) + return Path.Combine(envPath, "bin/java.exe"); + + throw new FileNotFoundException("Failed to find Java. Make sure it's installed!"); + } + else if (RuntimeInformation.IsOSPlatform(OSPlatform.Linux) + || RuntimeInformation.IsOSPlatform(OSPlatform.FreeBSD)) + { + var proc = new Process + { + StartInfo = new("/bin/which") + { + Arguments = "java", + RedirectStandardOutput = true, + UseShellExecute = false + } + }; + + proc.Start(); + proc.WaitForExit(); + var data = proc.StandardOutput.ReadToEnd(); + + if (!string.IsNullOrEmpty(data)) + return UnixPath.GetCompleteRealPath(data.Trim()); + + throw new FileNotFoundException("Failed to find Java. Make sure it's installed!"); + } + else if (RuntimeInformation.IsOSPlatform(OSPlatform.OSX)) + { + var proc = new Process + { + StartInfo = new("/usr/bin/which") + { + Arguments = "java", + RedirectStandardOutput = true, + UseShellExecute = false + } + }; + + proc.Start(); + proc.WaitForExit(); + var data = proc.StandardOutput.ReadToEnd(); + + if (!string.IsNullOrEmpty(data)) + return Path.Combine(UnixPath.GetCompleteRealPath(data.Trim())); + + throw new FileNotFoundException("Failed to find Java. Make sure it's installed!"); + } + else + { + throw new NotSupportedException("Your platform is not supported."); + } + } + + public static string LocateUnixUserHome() + { + return Environment.GetEnvironmentVariable("XDG_DATA_HOME") + ?? Path.Combine( + Environment.GetFolderPath(Environment.SpecialFolder.UserProfile), + ".local", + "share" + ); + } + + public static string Get2009scapeHome() + { + if (RuntimeInformation.IsOSPlatform(OSPlatform.Linux) + || RuntimeInformation.IsOSPlatform(OSPlatform.FreeBSD)) + { + return Path.Combine( + LocateUnixUserHome(), + "2009scape" + ); + } + else + { + var userProfile = Path.Combine ( + Environment.GetFolderPath(Environment.SpecialFolder.UserProfile), + "2009scape" + ); + var appData = Path.Combine( + Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData), + "2009scape" + ); + return Directory.Exists(userProfile) ? userProfile : appData; + } + } + + public static string GetSaradominHome() + { + if (RuntimeInformation.IsOSPlatform(OSPlatform.Linux) + || RuntimeInformation.IsOSPlatform(OSPlatform.FreeBSD)) + { + return Path.Combine( + // Get the XDG_DATA_HOME environment variable, or if it doesn't exist, use the default ~/.local/share + LocateUnixUserHome(), + "2009scape", + "saradomin" + ); + } + + return Path.Combine( + Environment.GetFolderPath(Environment.SpecialFolder.UserProfile), + "2009scape", + "saradomin" + ); + } + + public static string GetSingleplayerBackupsHome() + { + return Path.Combine(Get2009scapeHome(), "singleplayer_backups"); + } + + public static string GetSingleplayerHome() + { + return Path.Combine(Get2009scapeHome(), "singleplayer"); + } + + public static string LocateSingleplayerExecutable() + { + return Path.Combine(GetSingleplayerHome(), RuntimeInformation.IsOSPlatform(OSPlatform.Windows) ? "launch.bat" : "launch.sh"); + } + + public static string Get2009scapeExecutable() + { + return Path.Combine(Get2009scapeHome(), "2009scape.jar"); + } + + public static string GetServerProfilePath(string baseDirectory) + { + baseDirectory ??= Get2009scapeHome(); + return Path.Combine(baseDirectory, "server_profiles.json"); + } + + public static string RunCommandAndGetOutput(string command, Action onOutputReceived = null, Action onErrorReceived = null) + { + Process process = new Process(); + StringBuilder output = new StringBuilder(); + if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows)) + { + process.StartInfo = new ProcessStartInfo("cmd.exe", "/c " + command) + { + RedirectStandardOutput = true, + RedirectStandardError = true, + UseShellExecute = false, + CreateNoWindow = true, + }; + } + else if ( + RuntimeInformation.IsOSPlatform(OSPlatform.Linux) + || RuntimeInformation.IsOSPlatform(OSPlatform.OSX) + ) + { + process.StartInfo = new ProcessStartInfo("bash", "-c \"" + command + "\"") + { + RedirectStandardOutput = true, + RedirectStandardError = true, + UseShellExecute = false, + CreateNoWindow = true, + }; + } + + process.OutputDataReceived += (_, e) => + { + if (e.Data == null) return; + output.AppendLine(e.Data); + onOutputReceived?.Invoke(e.Data); + }; + + process.ErrorDataReceived += (_, e) => + { + if (e.Data == null) return; + output.AppendLine(e.Data); + onErrorReceived?.Invoke(e.Data); + }; + + process.Start(); + + process.BeginOutputReadLine(); + process.BeginErrorReadLine(); + + process.WaitForExit(); + + return output.ToString(); + } + + public static string GetJava11DownloadUrl() + { + string architecture = GetSystemArchitecture(); + if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows)) + { + return "https://github.com/adoptium/temurin11-binaries/releases/download/jdk-11.0.20%2B8/OpenJDK11U-jre_x64_windows_hotspot_11.0.20_8.zip"; + } + else if (RuntimeInformation.IsOSPlatform(OSPlatform.Linux)) + { + return architecture == "x64" + ? "https://github.com/adoptium/temurin11-binaries/releases/download/jdk-11.0.20%2B8/OpenJDK11U-jre_x64_linux_hotspot_11.0.20_8.tar.gz" + : "https://github.com/adoptium/temurin11-binaries/releases/download/jdk-11.0.20%2B8/OpenJDK11U-jre_aarch64_linux_hotspot_11.0.20_8.tar.gz"; + } + else if (RuntimeInformation.IsOSPlatform(OSPlatform.OSX)) + { + return architecture == "x64" + ? "https://github.com/adoptium/temurin11-binaries/releases/download/jdk-11.0.20%2B8/OpenJDK11U-jre_x64_mac_hotspot_11.0.20_8.tar.gz" + : "https://github.com/adoptium/temurin11-binaries/releases/download/jdk-11.0.20%2B8/OpenJDK11U-jre_aarch64_mac_hotspot_11.0.20_8.tar.gz"; + } + else + { + throw new NotSupportedException("Your platform is not supported."); + } + } + + private static string GetSystemArchitecture() + { + if (RuntimeInformation.OSArchitecture == Architecture.X64) + { + return "x64"; + } + else if (RuntimeInformation.OSArchitecture == Architecture.Arm64) + { + return "aarch64"; + } + else + { + throw new NotSupportedException("Your architecture is not supported."); + } + } + public static bool IsDirectoryWritable(string directoryPath) + { + var testFilePath = Path.Combine(directoryPath, "test"); + + try + { + File.Create(testFilePath).Dispose(); + File.Delete(testFilePath); + + return true; + } + catch (UnauthorizedAccessException) + { + return false; + } + } + + public static Process StartJavaProcess(string javaExecutable, string jarPath, string memoryAllocation, Action outputHandler, Action onExit) + { + Process process = new Process(); + process.StartInfo = new ProcessStartInfo + { + FileName = javaExecutable, + Arguments = $"-Xmx{memoryAllocation} -Xms{memoryAllocation} -jar \"{jarPath}\"", + UseShellExecute = false, + CreateNoWindow = true, + RedirectStandardOutput = true, + RedirectStandardError = true, + WorkingDirectory = Path.Combine(CrossPlatform.GetSingleplayerHome(), "game") + }; + + process.OutputDataReceived += (_, args) => + { + if (string.IsNullOrEmpty(args.Data)) return; + outputHandler?.Invoke(args.Data); + }; + + process.ErrorDataReceived += (_, args) => + { + if (string.IsNullOrEmpty(args.Data)) return; + outputHandler?.Invoke(args.Data); + }; + + process.EnableRaisingEvents = true; + process.Exited += (_, _) => onExit?.Invoke(); + + process.Start(); + + process.BeginOutputReadLine(); + process.BeginErrorReadLine(); + return process; + } + } +} \ No newline at end of file diff --git a/Saradomin/Utilities/HtmlRenderer.cs b/Saradomin/Utilities/HtmlRenderer.cs new file mode 100644 index 0000000..e38f782 --- /dev/null +++ b/Saradomin/Utilities/HtmlRenderer.cs @@ -0,0 +1,152 @@ +using System; +using System.Collections.Generic; +using System.Web; +using Avalonia; +using Avalonia.Controls; +using Avalonia.Controls.Documents; +using Avalonia.Layout; +using Avalonia.Media; +using HtmlAgilityPack; + +namespace Saradomin.Utilities +{ + public class HtmlRenderer + { + private int _listDescent = 0; + private string _prefix; + private InlineCollection _inlines; + private HtmlNode _rootNode; + + public HtmlRenderer(HtmlNode rootNode) + { + _rootNode = rootNode; + } + + public InlineCollection Render() + { + _inlines = new(); + { + Visit(_rootNode); + } + return _inlines; + } + + private void InNewBlockDo(Action action) + { + action(); + _inlines.Add(new LineBreak()); + } + + private void CreateNewInlineTextElement( + string text, + FontWeight weight = FontWeight.Normal, + double fontSize = 12 + ) + { + _inlines.Add(new Run(text) + { + FontWeight = weight, + FontSize = fontSize, + }); + } + + private void VisitBold(HtmlNode htmlNode) + { + CreateNewInlineTextElement( + HttpUtility.HtmlDecode( + htmlNode.GetDirectInnerText() + ), + FontWeight.Bold + ); + } + + private void VisitList(HtmlNode htmlNode) + { + _listDescent++; + { + InNewBlockDo(() => + { + foreach (var child in htmlNode.ChildNodes) + { + Visit(child); + } + }); + } + _listDescent--; + } + + private void VisitListEntry(HtmlNode htmlNode) + { + _inlines.Add(new Run("• ")); + + for (var i = 0; i < htmlNode.ChildNodes.Count; i++) + { + var child = htmlNode.ChildNodes[i]; + + if (i != 0) + { + _prefix = " "; + } + + Visit(child); + + _prefix = null; + } + + _prefix = null; + _inlines.Add(new LineBreak()); + } + + private void VisitParagraph(HtmlNode htmlNode) + { + InNewBlockDo(() => + { + foreach (var child in htmlNode.ChildNodes) + { + Visit(child); + } + }); + } + + private void Visit(HtmlNode htmlNode) + { + switch (htmlNode.Name) + { + case "#text": + var text = HttpUtility.HtmlDecode( + htmlNode.GetDirectInnerText().Trim(' ').Trim('\n') + ); + + CreateNewInlineTextElement($"{_prefix}{text}"); + break; + + case "br": + _inlines.Add(new LineBreak()); + break; + + case "b": + VisitBold(htmlNode); + break; + + case "ul": + VisitList(htmlNode); + break; + + case "li": + VisitListEntry(htmlNode); + break; + + case "p": + VisitParagraph(htmlNode); + break; + + default: + foreach (var child in htmlNode.ChildNodes) + { + Visit(child); + } + break; + } + } + } +} \ No newline at end of file diff --git a/Saradomin/Utilities/Singleplayer/SingleplayerManagement.cs b/Saradomin/Utilities/Singleplayer/SingleplayerManagement.cs new file mode 100644 index 0000000..2eb72e0 --- /dev/null +++ b/Saradomin/Utilities/Singleplayer/SingleplayerManagement.cs @@ -0,0 +1,160 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Linq; + +namespace Saradomin.Utilities +{ + public static class SingleplayerManagement + { + private static readonly string[] DirsToBackup = + { + "game/data/players", + "game/data/serverstore", + "game/worldprops" + }; + + private static readonly string[] FilesToBackup = + { + "game/data/eco/grandexchange.db" + }; + + public static void MakeBackup(Action log) + { + string timestamp = DateTime.Now.ToString("yyyyMMdd_HHmmss"); + string newBackupDir = Path.Combine( + CrossPlatform.GetSingleplayerBackupsHome(), + timestamp + ); + + foreach (string dir in DirsToBackup) + { + string sourcePath = Path.Combine(CrossPlatform.GetSingleplayerHome(), dir); + if (!Directory.Exists(sourcePath)) + { + log($" Skipping backup of {dir} because it doesn't exist (Full path attempted: {sourcePath})"); + continue; + } + + string destPath = Path.Combine(newBackupDir, dir); + CopyDirectory(sourcePath, destPath); + } + + foreach (string file in FilesToBackup) + { + string sourceFilePath = Path.Combine(CrossPlatform.GetSingleplayerHome(), file); + if (!File.Exists(sourceFilePath)) + { + log($" Skipping backup of {file} because it doesn't exist (Full path attempted: {sourceFilePath})"); + continue; + } + + string destFilePath = Path.Combine(newBackupDir, file); + string directoryForFile = Path.GetDirectoryName(destFilePath); + if (!Directory.Exists(directoryForFile)) + Directory.CreateDirectory(directoryForFile); + File.Copy(sourceFilePath, destFilePath, true); + } + } + + private static void CopyDirectory(string sourceDir, string destinationDir) + { + if (!Directory.Exists(destinationDir)) + Directory.CreateDirectory(destinationDir); + + foreach (string filePath in Directory.GetFiles(sourceDir)) + { + string fileName = Path.GetFileName(filePath); + string destFilePath = Path.Combine(destinationDir, fileName); + File.Copy(filePath, destFilePath, true); + } + + foreach (string subDirPath in Directory.GetDirectories(sourceDir)) + { + string subDirName = Path.GetFileName(subDirPath); + string destSubDirPath = Path.Combine(destinationDir, subDirName); + // Recurse! + CopyDirectory(subDirPath, destSubDirPath); + } + } + + public static string FindMostRecentBackupDirectory(IEnumerable directories) + { + return directories.Select(Path.GetFileName).MaxBy(name => name); + } + + public static void ApplyLatestBackup(Action log) + { + var backupHome = CrossPlatform.GetSingleplayerBackupsHome(); + var singleplayerHome = CrossPlatform.GetSingleplayerHome(); + + // Get all backup directories + string[] backupDirectories = Directory.Exists(backupHome) ? Directory.GetDirectories(backupHome) : Array.Empty(); + + string mostRecentBackupDirName = FindMostRecentBackupDirectory(backupDirectories); + + if (mostRecentBackupDirName == null) + { + log(" No backups found."); + return; + } + + string mostRecentBackupFullPath = Path.Combine(backupHome, mostRecentBackupDirName); + + // Get the list of files in the most recent backup + var filesInBackup = Directory.GetFiles( + mostRecentBackupFullPath, + "*", + SearchOption.AllDirectories + ); + + foreach (var file in filesInBackup) + { + // Calculate the file's destination path in the singleplayer home directory + var relativePath = file.Substring(mostRecentBackupFullPath.Length) + .TrimStart(Path.DirectorySeparatorChar); + var destFilePath = Path.Combine(singleplayerHome, relativePath); + + // Ensure the destination directory exists + var destDirectory = Path.GetDirectoryName(destFilePath); + if (!Directory.Exists(destDirectory)) + { + Directory.CreateDirectory(destDirectory); + } + + // Copy the file to the destination, overwriting any existing file + File.Copy(file, destFilePath, true); + } + + log($" Backup from {mostRecentBackupDirName} has been successfully applied."); + } + + private static Dictionary _confCache; + private static string ConfPath => Path.Combine(CrossPlatform.GetSingleplayerHome(), "game", "worldprops", "default.conf"); + public static Dictionary GrabConfCache() + { + return File.ReadLines(ConfPath) + .Where(line => line.Contains('=') && !line.TrimStart().StartsWith("#")) + .Select(l => l.Split(new[] { '#', '=' }, 3)) + .ToDictionary(parts => parts[0].Trim(), parts => parts[1].Trim()); + } + + public static T ParseConf(string key, T defaultValue = default) + { + if (!File.Exists(ConfPath)) return defaultValue; + _confCache ??= GrabConfCache(); + if (!_confCache.TryGetValue(key, out var value)) return defaultValue; + return (T)Convert.ChangeType(value, typeof(T)); + } + + public static void WriteConf(string key, object value) + { + _confCache[key] = value.ToString().ToLowerInvariant(); // Update cache + var lines = File.ReadAllLines(ConfPath).Select(l => + l.StartsWith(key + " =") + ? $"{key} = {_confCache[key]}" + (l.Contains("#") ? " " + l.Substring(l.IndexOf('#')) : "") + : l); + File.WriteAllLines(ConfPath, lines); + } + } +} \ No newline at end of file diff --git a/Saradomin/View/Controls/PluginManagerView.axaml b/Saradomin/View/Controls/PluginManagerView.axaml new file mode 100644 index 0000000..4f0c386 --- /dev/null +++ b/Saradomin/View/Controls/PluginManagerView.axaml @@ -0,0 +1,132 @@ + + + + + + + + + + + + + + diff --git a/Saradomin/View/Windows/MainWindow.axaml.cs b/Saradomin/View/Windows/MainWindow.axaml.cs new file mode 100644 index 0000000..9b3728e --- /dev/null +++ b/Saradomin/View/Windows/MainWindow.axaml.cs @@ -0,0 +1,29 @@ +using System; +using Avalonia.Controls; +using Avalonia.Input; +using PropertyChanged; +using Saradomin.Infrastructure; + +namespace Saradomin.View.Windows +{ + [DoNotNotify] + public partial class MainWindow : Window + { + public MainWindow() + { + InitializeComponent(); + } + + protected override void OnOpened(EventArgs e) + { + new MainViewLoadedMessage() + .Broadcast(); + } + + private void TitleBar_MouseDown(object _, PointerPressedEventArgs e) + { + if (e.GetCurrentPoint(this).Properties.IsLeftButtonPressed) + BeginMoveDrag(e); + } + } +} \ No newline at end of file diff --git a/Saradomin/View/Windows/NotificationBox.axaml b/Saradomin/View/Windows/NotificationBox.axaml new file mode 100644 index 0000000..7d5dda8 --- /dev/null +++ b/Saradomin/View/Windows/NotificationBox.axaml @@ -0,0 +1,56 @@ + + + + + + + + + + + + + +