diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..a458119 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,17 @@ +*Thank you for contributing to ProtonPlus! So that your Pull Request can be handled effectively, please populate the following fields (delete sections that are not applicable)* + +### Category +> One of: Bugfix / Feature / Code style update / Refactoring Only / Build related changes / Documentation / Other (Please specify!) + +### Overview +> Briefly outline your new changes... + +### Issue Number _(if applicable)_ +> Related issue: #00 + +### New Vars _(if applicable)_ +> If you've added any new build scripts, environmental variables, config file options, dependency please outline here. + +### Screenshot _(if applicable)_ +> If you've introduced any significant UI changes, please include a screenshot. + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..b8c5c7b --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,94 @@ +# Contributing to ProtonPlus + +First off, thanks for taking the time to contribute! โค๏ธ + +All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. ๐ŸŽ‰ + +> And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about: +> - Star the project +> - Tweet about it +> - Refer this project in your project's readme +> - Mention the project at local meetups and tell your friends/colleagues + +## Table of Contents + +- [I Have a Question](#i-have-a-question) +- [I Want To Contribute](#i-want-to-contribute) + - [Reporting Bugs](#reporting-bugs) + - [Suggesting Enhancements](#suggesting-enhancements) +- [Styleguides](#styleguides) + - [Commit Messages](#commit-messages) + +## I Have a Question + +> If you want to ask a question, we assume that you have read the available [Documentation](https://github.com/Vysp3r/ProtonPlus/#readme). + +Before you ask a question, it is best to search for existing [Issues](https://github.com/Vysp3r/ProtonPlus/issues) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first. + +If you then still feel the need to ask a question and need clarification, we recommend the following: + +- Open an [Issue](https://github.com/Vysp3r/ProtonPlus/issues/new). +- Provide as much context as you can about what you're running into. + +We will then take care of the issue as soon as possible. + +## I Want To Contribute + +> ### Legal Notice +> When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license. + +### Reporting Bugs + +#### Before Submitting a Bug Report + +A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible. + +- Make sure that you are using the latest version. +- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the [documentation](https://github.com/Vysp3r/ProtonPlus/#readme). If you are looking for support, you might want to check [this section](#i-have-a-question)). +- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](https://github.com/Vysp3r/ProtonPlus/issues?q=is%3Aopen+is%3Aissue+label%3A%22%F0%9F%90%9B+Bug%22). +- Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue. +- Collect information about the bug: +- Stack trace (Traceback) +- OS, Platform and Version (Windows, Linux, macOS, x86, ARM) +- Possibly your input and the output +- Can you reliably reproduce the issue? And can you also reproduce it with older versions? + +#### How Do I Submit a Good Bug Report? + +> You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to vyspr@tuta.io. + +We use GitHub issues to track bugs and errors. If you run into an issue with the project: + +- Open an [Issue](https://github.com/Vysp3r/ProtonPlus/issues/new). +- Explain the behavior you would expect and the actual behavior. +- Please provide as much context as possible and describe the *reproduction steps* that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case. +- Provide the information you collected in the previous section. + + +### Suggesting Enhancements + +This section guides you through submitting an enhancement suggestion for ProtonPlus, **including completely new features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions. + +#### Before Submitting an Enhancement + +- Make sure that you are using the latest version. +- Read the [documentation](https://github.com/Vysp3r/ProtonPlus/#readme) carefully and find out if the functionality is already covered, maybe by an individual configuration. +- Perform a [search](https://github.com/Vysp3r/ProtonPlus/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one. +- Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library. + +#### How Do I Submit a Good Enhancement Suggestion? + +Enhancement suggestions are tracked as [GitHub issues](https://github.com/Vysp3r/ProtonPlus/issues). + +- Use a **clear and descriptive title** for the issue to identify the suggestion. +- Provide a **step-by-step description of the suggested enhancement** in as many details as possible. +- **Describe the current behavior** and **explain which behavior you expected to see instead** and why. At this point you can also tell which alternatives do not work for you. +- You may want to **include screenshots and animated GIFs** which help you demonstrate the steps or point out the part which the suggestion is related to. You can use [this tool](https://github.com/ShareX/ShareX) to record GIFs on Windows, and [this tool](https://github.com/phw/peek) on linux. +- **Explain why this enhancement would be useful** to most ProtonPlus users. You may also want to point out the other projects that solved it better and which could serve as inspiration. + +## Styleguides +### Commit Messages + +ProtonPlus uses [GitMoji](https://gitmoji.dev/). +We would appreciate it if everyone keeps their commit messages withing these rulings. + diff --git a/FAQ.md b/FAQ.md new file mode 100644 index 0000000..e69de29 diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..d2c9085 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,519 @@ + 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/Preview.png b/Preview.png new file mode 100644 index 0000000..a13d06b Binary files /dev/null and b/Preview.png differ diff --git a/README.md b/README.md index 26ef319..c6e8f95 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,125 @@ -# protonplus -A simple proton version manager +

ProtonPlus (WIP)

+ +

+ + + Latest Release (Semver) + + + + + + + +

+ +

+ Join the telegram! โ€” Don't forget to star the repo if you are enjoying the project! +

+ +- - - - + +ProtonPlus is a simple Proton version manager that make it easy to install and manage Proton versions. It works with Steam, Lutris and will soon have support for custom locations. It was made in Vala with GTK4 and Libadwaita using GNOME Builder. This project is still in its early phase, so please keep that in mind before using it. + +If you have any questions about ProtonPlus or want to share information with us, please go to one of the following places: + + + +- [Github Discussions](https://github.com/Vysp3r/ProtonPlus/discussions) +- [Telegram Server](https://t.me/ProtonPlusOfficial) + +*Before you file an [issue](https://github.com/Vysp3r/ProtonPlus/issues/new/choose), make sure you have read the [known issues](#-known-issues) section.* + +**For more information, [read the documentation!](https://github.com/Vysp3r/ProtonPlus/wiki)** + +- - - - + +## โœจ Features +- Install and manage Proton versions for Steam (GE-Proton, Luxtoperda, Boxtron, Proton Tkg and Roberta) +- Install and manage Proton versions for Lutris (Wine-GE, Lutris-Wine, DXVK and DXVK Async) +- And more... + +- - - - + +## ๐Ÿ‘€ Preview +ProtonPlus Preview + +- - - - + +## ๐Ÿ’ฅ Known Issues + +- None + +- - - - + +## ๐Ÿ“ TODOs + +- Add localization +- Comment the code +- Document the project +- Add a game list with additional data like Deck compatibility and Anti-cheat status +- Add the ability to add custom locations +- Add games specific fixes (ex. Star Citizen) +- Add an update notification system + +- - - - + +## โ‰๏ธ ProtonPlus vs ProtonUp-Qt + +| | ProtonPlus | ProtonUp-Qt | +| :---------------- | :-----------------------------------------: | :----------------------------------------------: | +| **GUI Toolkit** | [GTK4](https://gitlab.gnome.org/GNOME/gtk) | [QT](https://www.qt.io/) | +| **Language** | [Vala](https://gitlab.gnome.org/GNOME/vala) | [Python](https://www.python.org/) | +| **Based on** | Nothing | [ProtonUp](https://github.com/AUNaseef/protonup) | +| **Looks best on** | [GNOME](https://gitlab.gnome.org/GNOME) | [KDE](https://kde.org/) | + +- - - - + +### ๐Ÿ› ๏ธ Building from Source + +_Requirements_ +- [meson](https://github.com/mesonbuild/meson) +- [gtk4](https://gitlab.gnome.org/GNOME/gtk/) +- [libadwaita-1](https://gitlab.gnome.org/GNOME/libadwaita) +- [json-glib-1.0](https://gitlab.gnome.org/GNOME/json-glib) +- [libsoup-3.0](https://gitlab.gnome.org/GNOME/libsoup) +- [libarchive](https://github.com/libarchive/libarchive) + +**Installing** + +- Clone the GitHub repo: `git clone https://github.com/Vysp3r/ProtonPlus.git` & `cd ProtonPlus` +- Install all dependencies (I'm using Fedora 36): `sudo dnf install meson gtk4-devel libadwaita-devel json-glib-devel libsoup3-devel libarchive-devel` +- Build the source: `TODO` +- Start the application: `TODO` + +- - - - + +## ๐Ÿ’– Contributing +**Please read our [Contribution Guidelines](/CONTRIBUTING.md)** + +All contributions are highly appreciated. + +- - - - + +## ๐Ÿ“œ License + +ProtonPlus is licensed under [GPL 3.0](/LICENSE.md) + +``` + Copyright ยฉ 2022 Charles "Vysp3r" Malouin + + 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 . +``` + +**[โคด๏ธ Back to Top](#ProtonPlus)** diff --git a/com.vysp3r.ProtonPlus.json b/com.vysp3r.ProtonPlus.json new file mode 100644 index 0000000..c10fd17 --- /dev/null +++ b/com.vysp3r.ProtonPlus.json @@ -0,0 +1,45 @@ +{ + "app-id" : "com.vysp3r.ProtonPlus", + "runtime" : "org.gnome.Platform", + "runtime-version" : "42", + "sdk" : "org.gnome.Sdk", + "command" : "protonplus", + "finish-args" : [ + "--share=network", + "--share=ipc", + "--socket=fallback-x11", + "--device=dri", + "--socket=wayland", + "--filesystem=home", + "--talk-name=org.gtk.vfs.*", + "--filesystem=xdg-run/gvfsd" + ], + "cleanup" : [ + "/include", + "/lib/pkgconfig", + "/man", + "/share/doc", + "/share/gtk-doc", + "/share/man", + "/share/pkgconfig", + "/share/vala", + "*.la", + "*.a" + ], + "modules" : [ + { + "name" : "ProtonPlus", + "builddir" : true, + "buildsystem" : "meson", + "sources" : [ + { + "type" : "git", + "url" : "file:///home/vysp3r/Nextcloud/Workstation/protonplus" + } + ] + } + ], + "build-options" : { + "env" : { } + } +} diff --git a/com.vysp3r.ProtonPlus.json~ b/com.vysp3r.ProtonPlus.json~ new file mode 100644 index 0000000..c1d2335 --- /dev/null +++ b/com.vysp3r.ProtonPlus.json~ @@ -0,0 +1,43 @@ +{ + "app-id" : "com.vysp3r.ProtonPlus", + "runtime" : "org.gnome.Platform", + "runtime-version" : "42", + "sdk" : "org.gnome.Sdk", + "command" : "protonplus", + "finish-args" : [ + "--share=network", + "--share=ipc", + "--socket=fallback-x11", + "--device=dri", + "--socket=wayland", + "--filesystem=home" + ], + "cleanup" : [ + "/include", + "/lib/pkgconfig", + "/man", + "/share/doc", + "/share/gtk-doc", + "/share/man", + "/share/pkgconfig", + "/share/vala", + "*.la", + "*.a" + ], + "modules" : [ + { + "name" : "ProtonPlus", + "builddir" : true, + "buildsystem" : "meson", + "sources" : [ + { + "type" : "git", + "url" : "file:///home/vysp3r/Nextcloud/Workstation/protonplus" + } + ] + } + ], + "build-options" : { + "env" : { } + } +} diff --git a/data/com.vysp3r.ProtonPlus.appdata.xml.in b/data/com.vysp3r.ProtonPlus.appdata.xml.in new file mode 100644 index 0000000..10b6ab7 --- /dev/null +++ b/data/com.vysp3r.ProtonPlus.appdata.xml.in @@ -0,0 +1,9 @@ + + + com.vysp3r.ProtonPlus.desktop + CC0-1.0 + GPL-3.0-or-later + +

No description

+ + diff --git a/data/com.vysp3r.ProtonPlus.desktop.in b/data/com.vysp3r.ProtonPlus.desktop.in new file mode 100644 index 0000000..791b51b --- /dev/null +++ b/data/com.vysp3r.ProtonPlus.desktop.in @@ -0,0 +1,8 @@ +[Desktop Entry] +Name=ProtonPlus +Exec=protonplus +Icon=com.vysp3r.ProtonPlus +Terminal=false +Type=Application +Categories=GTK; +StartupNotify=true \ No newline at end of file diff --git a/data/com.vysp3r.ProtonPlus.gschema.xml b/data/com.vysp3r.ProtonPlus.gschema.xml new file mode 100644 index 0000000..6812b41 --- /dev/null +++ b/data/com.vysp3r.ProtonPlus.gschema.xml @@ -0,0 +1,5 @@ + + + + + diff --git a/data/icons/hicolor/scalable/apps/com.vysp3r.ProtonPlus.svg b/data/icons/hicolor/scalable/apps/com.vysp3r.ProtonPlus.svg new file mode 100644 index 0000000..17665ef --- /dev/null +++ b/data/icons/hicolor/scalable/apps/com.vysp3r.ProtonPlus.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/data/icons/hicolor/symbolic/apps/com.vysp3r.ProtonPlus-symbolic.svg b/data/icons/hicolor/symbolic/apps/com.vysp3r.ProtonPlus-symbolic.svg new file mode 100644 index 0000000..0444828 --- /dev/null +++ b/data/icons/hicolor/symbolic/apps/com.vysp3r.ProtonPlus-symbolic.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/data/icons/meson.build b/data/icons/meson.build new file mode 100644 index 0000000..f4dd5a5 --- /dev/null +++ b/data/icons/meson.build @@ -0,0 +1,13 @@ +application_id = 'com.vysp3r.ProtonPlus' + +scalable_dir = join_paths('hicolor', 'scalable', 'apps') +install_data( + join_paths(scalable_dir, ('@0@.svg').format(application_id)), + install_dir: join_paths(get_option('datadir'), 'icons', scalable_dir) +) + +symbolic_dir = join_paths('hicolor', 'symbolic', 'apps') +install_data( + join_paths(symbolic_dir, ('@0@-symbolic.svg').format(application_id)), + install_dir: join_paths(get_option('datadir'), 'icons', symbolic_dir) +) diff --git a/data/meson.build b/data/meson.build new file mode 100644 index 0000000..9c553a0 --- /dev/null +++ b/data/meson.build @@ -0,0 +1,43 @@ +desktop_file = i18n.merge_file( + input: 'com.vysp3r.ProtonPlus.desktop.in', + output: 'com.vysp3r.ProtonPlus.desktop', + type: 'desktop', + po_dir: '../po', + install: true, + install_dir: join_paths(get_option('datadir'), 'applications') +) + +desktop_utils = find_program('desktop-file-validate', required: false) +if desktop_utils.found() + test('Validate desktop file', desktop_utils, + args: [desktop_file] + ) +endif + +appstream_file = i18n.merge_file( + input: 'com.vysp3r.ProtonPlus.appdata.xml.in', + output: 'com.vysp3r.ProtonPlus.appdata.xml', + po_dir: '../po', + install: true, + install_dir: join_paths(get_option('datadir'), 'appdata') +) + +appstream_util = find_program('appstream-util', required: false) +if appstream_util.found() + test('Validate appstream file', appstream_util, + args: ['validate', appstream_file] + ) +endif + +install_data('com.vysp3r.ProtonPlus.gschema.xml', + install_dir: join_paths(get_option('datadir'), 'glib-2.0/schemas') +) + +compile_schemas = find_program('glib-compile-schemas', required: false) +if compile_schemas.found() + test('Validate schema file', compile_schemas, + args: ['--strict', '--dry-run', meson.current_source_dir()] + ) +endif + +subdir('icons') diff --git a/meson.build b/meson.build new file mode 100644 index 0000000..9aa58a4 --- /dev/null +++ b/meson.build @@ -0,0 +1,20 @@ +project('protonplus', ['c', 'vala'], + version: '0.1.0', + meson_version: '>= 0.59.0', + default_options: [ 'warning_level=2', + 'werror=false', + ], +) + +i18n = import('i18n') + +gnome = import('gnome') + +subdir('data') +subdir('src') + +gnome.post_install( + glib_compile_schemas: true, + gtk_update_icon_cache: true, + update_desktop_database: true, +) diff --git a/src/ProtonPlus.png b/src/ProtonPlus.png new file mode 100644 index 0000000..7f6d1ce Binary files /dev/null and b/src/ProtonPlus.png differ diff --git a/src/app.css b/src/app.css new file mode 100644 index 0000000..23755f8 --- /dev/null +++ b/src/app.css @@ -0,0 +1,3 @@ +.bold { + font-weight: bold; +} diff --git a/src/application.vala b/src/application.vala new file mode 100644 index 0000000..73a080e --- /dev/null +++ b/src/application.vala @@ -0,0 +1,53 @@ +namespace ProtonPlus { + public class Application : Adw.Application { + public Application () { + Object (application_id: "com.vysp3r.ProtonPlus", flags : ApplicationFlags.FLAGS_NONE); + } + + construct { + ActionEntry[] action_entries = { + { "preferences", this.on_preferences_action }, + { "telegram", () => Gtk.show_uri (null, "https://t.me/ProtonPlusOfficial", Gdk.CURRENT_TIME) }, + { "documentation", () => Gtk.show_uri (null, "https://github.com/Vysp3r/ProtonPlus/wiki", Gdk.CURRENT_TIME) }, + { "donation", () => Gtk.show_uri (null, "https://www.youtube.com/watch?v=dQw4w9WgXcQ", Gdk.CURRENT_TIME) }, + { "about", this.on_about_action }, + { "quit", this.quit } + }; + this.add_action_entries (action_entries, this); + } + + public override void activate () { + base.activate (); + + new Windows.Home (this); + + Manager.Preferences.Load (); + Manager.Themes.Load (); + } + + private void on_about_action () { + string[] authors = { "Charles \"Vysp3r\" Malouin" }; + string[] thanks = { "GNOME Team", "Lahey" }; + + Gtk.AboutDialog aboutDialog = new Gtk.AboutDialog (); + Gtk.Image logo = new Gtk.Image.from_resource ("/com/vysp3r/ProtonPlus/ProtonPlus.png"); + + aboutDialog.set_logo (logo.get_paintable()); + aboutDialog.set_program_name ("ProtonPlus"); + aboutDialog.set_version ("v0.1.0"); + aboutDialog.set_comments ("A simple compatibility tool manager "); + aboutDialog.set_website_label ("Github"); + aboutDialog.set_website ("https://github.com/Vysp3r/ProtonPlus"); + aboutDialog.set_copyright ("ยฉ 2022 Vysp3r"); + aboutDialog.set_license_type (Gtk.License.GPL_3_0); + aboutDialog.set_authors (authors); + aboutDialog.add_credit_section ("Special thanks to", thanks); + + aboutDialog.show (); + } + + private void on_preferences_action () { + new ProtonPlus.Windows.Preferences (this); + } + } +} diff --git a/src/gtk/help-overlay.ui b/src/gtk/help-overlay.ui new file mode 100644 index 0000000..6852f4b --- /dev/null +++ b/src/gtk/help-overlay.ui @@ -0,0 +1,29 @@ + + + + True + + + shortcuts + 10 + + + General + + + Show Shortcuts + win.show-help-overlay + + + + + Quit + app.quit + + + + + + + + \ No newline at end of file diff --git a/src/main.vala b/src/main.vala new file mode 100644 index 0000000..816823f --- /dev/null +++ b/src/main.vala @@ -0,0 +1,9 @@ +int main (string[] args) { + if (Thread.supported () == false) { + stderr.printf ("Threads are not supported!\n"); + return -1; + } + + var app = new ProtonPlus.Application (); + return app.run (args); +} \ No newline at end of file diff --git a/src/manager/file.vala b/src/manager/file.vala new file mode 100644 index 0000000..8f60498 --- /dev/null +++ b/src/manager/file.vala @@ -0,0 +1,61 @@ +namespace ProtonPlus.Manager { + public class File { + public static void Extract (string install_location, string archive_name) { + Archive.Read archive = new Archive.Read (); + archive.support_format_tar (); + archive.support_filter_gzip (); + + int flags; + flags = Archive.ExtractFlags.ACL; + flags |= Archive.ExtractFlags.PERM; + flags |= Archive.ExtractFlags.TIME; + flags |= Archive.ExtractFlags.FFLAGS; + + Archive.WriteDisk ext = new Archive.WriteDisk (); + ext.set_standard_lookup (); + ext.set_options (flags); + + if (archive.open_filename (install_location + archive_name, 1536000) != Archive.Result.OK) return; + + ssize_t r; + + unowned Archive.Entry entry; + + for ( ;; ) { + r = archive.next_header (out entry); + if (r == Archive.Result.EOF) break; + if (r < Archive.Result.WARN) break; + entry.set_pathname (install_location + entry.pathname ()); + r = ext.write_header (entry); + if (entry.size () > 0) { + r = copy_data (archive, ext); + if (r < Archive.Result.WARN) break; + } + r = ext.finish_entry (); + if (r < Archive.Result.WARN) break; + } + + archive.close (); + + GLib.File file = GLib.File.new_for_path (install_location + archive_name); + file.delete (); + + ProtonPlus.Stores.Threads store = ProtonPlus.Stores.Threads.instance (); + store.ProgressBarDone = true; + } + + private static ssize_t copy_data (Archive.Read ar, Archive.WriteDisk aw) { + ssize_t r; + uint8[] buffer; + Archive.int64_t offset; + + for ( ;; ) { + r = ar.read_data_block (out buffer, out offset); + if (r == Archive.Result.EOF) return (Archive.Result.OK); + if (r < Archive.Result.OK) return (r); + r = aw.write_data_block (buffer, offset); + if (r < Archive.Result.OK) return (r); + } + } + } +} diff --git a/src/manager/http.vala b/src/manager/http.vala new file mode 100644 index 0000000..13ba2b1 --- /dev/null +++ b/src/manager/http.vala @@ -0,0 +1,25 @@ +namespace ProtonPlus.Manager { + public class HTTP { + public static string GET (string url) { + var session = new Soup.Session (); + var message = new Soup.Message ("GET", url); + session.set_user_agent ("Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/42.0.2311.135 Safari/537.36 Edge/12.246"); + Bytes bytes = session.send_and_read (message); + return (string) bytes.get_data (); + } + + public static int Download (string download_url, string download_path) { + try { + var file_from_http = GLib.File.new_for_uri (download_url); + GLib.File local_file = GLib.File.new_for_path (download_path); + ProtonPlus.Stores.Threads store = ProtonPlus.Stores.Threads.instance (); + file_from_http.copy (local_file, FileCopyFlags.OVERWRITE, null, (current, total) => { + store.ProgressBar = (current + 0.0d) / (total + 0.0d); + }); + return 0; + } catch (Error e) { + return 1; + } + } + } +} diff --git a/src/manager/preferences.vala b/src/manager/preferences.vala new file mode 100644 index 0000000..c3f34a2 --- /dev/null +++ b/src/manager/preferences.vala @@ -0,0 +1,43 @@ +namespace ProtonPlus.Manager { + public class Preferences { + public static void Load() { + ProtonPlus.Stores.Preferences store = ProtonPlus.Stores.Preferences.instance(); + try { + GLib.File file = GLib.File.new_for_path(GLib.Environment.get_user_config_dir() + "/preferences.json"); + + uint8[] contents; + string etag_out; + file.load_contents(null, out contents, out etag_out); + + Json.Node node = Json.from_string((string) contents); + Json.Object obj = node.get_object(); + + store.CurrentStyle = Models.Preference.FindStyle(obj.get_string_member("style")); + } catch (GLib.IOError.NOT_FOUND e) { + Create(); + Load(); + } + Apply(); + } + + public static void Apply() { + ProtonPlus.Stores.Preferences store = ProtonPlus.Stores.Preferences.instance(); + Adw.StyleManager.get_default().set_color_scheme(store.CurrentStyle.ColorScheme); + } + + public static void Update() { + GLib.File file = GLib.File.new_for_path(GLib.Environment.get_user_config_dir() + "/preferences.json"); + file.delete (); + Create(); + } + + private static void Create() { + GLib.File file = GLib.File.new_for_path(GLib.Environment.get_user_config_dir() + "/preferences.json"); + FileOutputStream os = file.create(FileCreateFlags.PRIVATE); + + ProtonPlus.Stores.Preferences store = ProtonPlus.Stores.Preferences.instance(); + + os.write(store.GetJson().data); + } + } +} diff --git a/src/manager/themes.vala b/src/manager/themes.vala new file mode 100644 index 0000000..4dfa358 --- /dev/null +++ b/src/manager/themes.vala @@ -0,0 +1,11 @@ +namespace ProtonPlus.Manager { + public class Themes { + public static void Load() { + var provider = new Gtk.CssProvider(); + provider.load_from_resource("/com/vysp3r/ProtonPlus/app.css"); + Gtk.StyleContext.add_provider_for_display(Gdk.Display.get_default(), + provider, + Gtk.STYLE_PROVIDER_PRIORITY_APPLICATION); + } + } +} \ No newline at end of file diff --git a/src/meson.build b/src/meson.build new file mode 100644 index 0000000..79add36 --- /dev/null +++ b/src/meson.build @@ -0,0 +1,50 @@ +protonplus_sources = [ + 'main.vala', + 'application.vala', + + 'stores/preferences.vala', + 'stores/threads.vala', + + 'manager/preferences.vala', + 'manager/themes.vala', + 'manager/http.vala', + 'manager/file.vala', + + 'models/preference.vala', + 'models/compatibilitytool.vala', + 'models/location.vala', + 'models/launcher.vala', + + 'widgets/protoncb.vala', + 'widgets/protonrow.vala', + + 'windows/home.vala', + 'windows/home_custom_directory.vala', + 'windows/home_info.vala', + 'windows/preferences.vala', + 'windows/selector.vala', +] + +#vapi_dir = meson.current_source_dir() / 'vapi' + +#add_project_arguments(['--vapidir', vapi_dir], language: 'vala') + +protonplus_deps = [ + dependency('libadwaita-1', version: '>= 1.0'), + dependency('json-glib-1.0'), + dependency('libsoup-3.0'), + dependency('libarchive'), + meson.get_compiler('vala').find_library('posix') +] + +gnome = import('gnome') + +protonplus_sources += gnome.compile_resources('protonplus-resources', + 'protonplus.gresource.xml', + c_name: 'protonplus' +) + +executable('protonplus', protonplus_sources, + vala_args: '--target-glib=2.50', dependencies: protonplus_deps, + install: true, +) \ No newline at end of file diff --git a/src/models/compatibilitytool.vala b/src/models/compatibilitytool.vala new file mode 100644 index 0000000..e658f91 --- /dev/null +++ b/src/models/compatibilitytool.vala @@ -0,0 +1,176 @@ +namespace ProtonPlus.Models { + public class CompatibilityTool : Object { + + public string Title { public get; private set; } + public string Description { public get; private set; } + public string Endpoint { public get; private set; } + public int AssetPosition { public get; private set; } + + public CompatibilityTool (string title, string description, string endpoint, int asset_position) { + this.Title = title; + this.Description = description; + this.Endpoint = endpoint; + this.AssetPosition = asset_position; + } + + public Release[] GetReleases () { + // Get the json from the Tool endpoint + string json = ProtonPlus.Manager.HTTP.GET (Endpoint); + + // Get the root node from the json + Json.Node rootNode = Json.from_string (json); + + // Get the root node array + Json.Array rootNodeArray = rootNode.get_array (); + + // Create an array of Version with the size of the root node array + Release[] releases = new Release[rootNodeArray.get_length ()]; + + // Execute a loop with the number of items contained in the Version array and fill it + for (var i = 0; i < releases.length; i++) { + string label = ""; + string download_url = ""; + string page_url = ""; + + // Get the current node + var tempNode = rootNodeArray.get_element (i); + Json.Object objRoot = tempNode.get_object (); + + // Set the value of label to the tag_name object contained in the current node + label = objRoot.get_string_member ("tag_name"); + + page_url = objRoot.get_string_member ("html_url"); + + // Get the temp node array for the assets + var tempNodeArray = objRoot.get_array_member ("assets"); + + // Verify weither the temp node array has values and if so it set the endpoint to the given download url + if (tempNodeArray.get_length () > 0) { + var test = tempNodeArray.get_element (AssetPosition); + Json.Object objAsset = test.get_object (); + download_url = objAsset.get_string_member ("browser_download_url"); + } + + // Insert in the Version array a new Version with the current node information + releases[i] = new Release (label, download_url, page_url); + } + + // Return the Version array + return releases; + } + + public static Gtk.ListStore GetModel (CompatibilityTool[] tools) { + Gtk.ListStore model = new Gtk.ListStore (2, typeof (string), typeof (CompatibilityTool)); + Gtk.TreeIter iter; + + foreach (var item in tools) { + model.append (out iter); + model.set (iter, 0, item.Title, 1, item, -1); + } + + return model; + } + + public static Gtk.ListStore GetReleasesModel (Release[] releases) { + Gtk.ListStore model = new Gtk.ListStore (2, typeof (string), typeof (Release)); + Gtk.TreeIter iter; + + foreach (var item in releases) { + model.append (out iter); + model.set (iter, 0, item.Label, 1, item, -1); + } + + return model; + } + + public class Release : Object { + public string Label { public get; private set; } + public string Download_URL { public get; private set; } + public string Page_URL { public get; private set; } + + public Release (string label, string download_url, string page_url) { + this.Label = label; + this.Download_URL = download_url; + this.Page_URL = page_url; + } + + public static GLib.ListStore GetModel (List releases) { + GLib.ListStore model = new GLib.ListStore (typeof (Release)); + + foreach (var item in releases) { + model.append (item); + } + + return model; + } + } + + public static CompatibilityTool[] Steam () { + CompatibilityTool[] tools = new CompatibilityTool[5]; + + tools[0] = new CompatibilityTool ("GE-Proton", "Steam compatibility tool for running Windows games with improvements over Valve's default Proton. Use this when you don't know what to choose.", "https://api.github.com/repos/GloriousEggroll/proton-ge-custom/releases", 1); + tools[1] = new CompatibilityTool ("Proton Tkg", "Custom Proton build for running Windows games, built with the Wine-tkg build system.", "https://api.github.com/repos/Frogging-Family/wine-tkg-git/releases", 1); + tools[2] = new CompatibilityTool ("Luxtorpeda", "Luxtorpeda provides Linux-native game engines for specific Windows-only games.", "https://api.github.com/repos/luxtorpeda-dev/luxtorpeda/releases", 0); + tools[3] = new CompatibilityTool ("Boxtron", "Steam Play compatibility tool to run DOS games using native Linux DOSBox.", "https://api.github.com/repos/dreamer/boxtron/releases", 0); + tools[4] = new CompatibilityTool ("Roberta", "Steam Play compatibility tool to run adventure games using native Linux ScummVM.", "https://api.github.com/repos/dreamer/roberta/releases", 1); + + return tools; + } + + public static CompatibilityTool[] Lutris () { + CompatibilityTool[] tools = new CompatibilityTool[6]; + + tools[0] = new CompatibilityTool ("Wine-GE", "Compatibility tool \"Wine\" to run Windows games on Linux. Based on Valve Proton Experimental's bleeding-edge Wine, built for Lutris.Use this when you don't know what to choose.", "https://api.github.com/repos/GloriousEggroll/wine-ge-custom/releases", 1); + tools[1] = new CompatibilityTool ("Lutris-Wine", "Compatibility tool \"Wine\" to run Windows games on Linux. Improved by Lutris to offer better compatibility or performance in certain games.", "https://api.github.com/repos/lutris/wine/releases", 0); + tools[2] = new CompatibilityTool ("Kron4ek Wine-Builds Vanilla", "Compatibility tool \"Wine\" to run Windows games on Linux. Official version from the WineHQ sources, compiled by Kron4ek.", "https://api.github.com/repos/Kron4ek/Wine-Builds/releases", 5); + tools[3] = new CompatibilityTool ("DXVK", "Vulkan based implementation of Direct3D 9, 10 and 11 for Linux/Wine.https://github.com/lutris/docs/blob/master/HowToDXVK.md", "https://api.github.com/repos/doitsujin/dxvk/releases", 0); + tools[4] = new CompatibilityTool ("DXVK Async (Sporif)", "Vulkan based implementation of Direct3D 9, 10 and 11 for Linux/Wine with async patch by Sporif.Warning: Use only with singleplayer games!", "https://api.github.com/repos/Sporif/dxvk-async/releases", 0); + tools[5] = new CompatibilityTool ("DXVK Async (gnusenpai)", "Vulkan based implementation of Direct3D 9, 10 and 11 for Linux/Wine with async patch and RTX fix for Star Citizen by gnusenpai.Warning: Use only with singleplayer games!", "https://api.github.com/repos/gnusenpai/dxvk/releases", 0); + + return tools; + } + + public static CompatibilityTool[] HeroicWine () { + CompatibilityTool[] tools = new CompatibilityTool[1]; + + tools[0] = new CompatibilityTool ("Wine-GE", "Compatibility tool \"Wine\" to run Windows games on Linux. Based on Valve Proton Experimental's bleeding-edge Wine, built for Lutris.Use this when you don't know what to choose.", "https://api.github.com/repos/GloriousEggroll/wine-ge-custom/releases", 1); + + return tools; + } + + public static CompatibilityTool[] HeroicProton () { + CompatibilityTool[] tools = new CompatibilityTool[1]; + + tools[0] = new CompatibilityTool ("GE-Proton", "Steam compatibility tool for running Windows games with improvements over Valve's default Proton. Use this when you don't know what to choose.", "https://api.github.com/repos/GloriousEggroll/proton-ge-custom/releases", 1); + + return tools; + } + + public static CompatibilityTool[] Bottles () { + CompatibilityTool[] tools = new CompatibilityTool[3]; + + tools[0] = new CompatibilityTool ("GE-Proton", "Steam compatibility tool for running Windows games with improvements over Valve's default Proton. Use this when you don't know what to choose.", "https://api.github.com/repos/GloriousEggroll/proton-ge-custom/releases", 1); + tools[1] = new CompatibilityTool ("Wine-GE", "Compatibility tool \"Wine\" to run Windows games on Linux. Based on Valve Proton Experimental's bleeding-edge Wine, built for Lutris.Use this when you don't know what to choose.", "https://api.github.com/repos/GloriousEggroll/wine-ge-custom/releases", 1); + tools[2] = new CompatibilityTool ("Lutris-Wine", "Compatibility tool \"Wine\" to run Windows games on Linux. Improved by Lutris to offer better compatibility or performance in certain games.", "https://api.github.com/repos/lutris/wine/releases", 0); + + return tools; + } + + public static List Installed (ProtonPlus.Models.Location location) { + List installedReleases = new List (); + + Posix.Dir dir = Posix.opendir (location.InstallDirectory); + unowned Posix.DirEnt dirEnt; + int count = 0; + + while ((dirEnt = Posix.readdir (dir)) != null) { + if(count++ > 1) { + string name = (string) dirEnt.d_name; + installedReleases.append (new Release(name, "", "")); + } + } + + return installedReleases; + } + } +} diff --git a/src/models/launcher.vala b/src/models/launcher.vala new file mode 100644 index 0000000..427810d --- /dev/null +++ b/src/models/launcher.vala @@ -0,0 +1,33 @@ +namespace ProtonPlus.Models { + public class Launcher : Object { + public string Label { public get; private set; } + + public Launcher (string label) { + this.Label = label; + } + + public static Gtk.ListStore GetModel () { + Gtk.ListStore model = new Gtk.ListStore (2, typeof (string), typeof (Launcher)); + Gtk.TreeIter iter; + + foreach (var item in All ()) { + model.append (out iter); + model.set (iter, 0, item.Label, 1, item, -1); + } + + return model; + } + + public static Launcher[] All () { + Launcher[] launchers = new Launcher[5]; + + launchers[0] = new Launcher ("Steam"); + launchers[1] = new Launcher ("Lutris"); + launchers[2] = new Launcher ("Heroic Wine"); + launchers[3] = new Launcher ("Heroic Proton"); + launchers[4] = new Launcher ("Bottles"); + + return launchers; + } + } +} diff --git a/src/models/location.vala b/src/models/location.vala new file mode 100644 index 0000000..333ab2c --- /dev/null +++ b/src/models/location.vala @@ -0,0 +1,61 @@ +namespace ProtonPlus.Models { + public class Location : Object { + public string Label { public get; private set; } + public string InstallDirectory { public get; private set; } + public ProtonPlus.Models.CompatibilityTool[] Tools { public get; private set; } + public ProtonPlus.Models.Launcher Launcher { public get; private set; } + + public Location (string label, string install_directory, ProtonPlus.Models.CompatibilityTool[] tools, ProtonPlus.Models.Launcher launcher) { + this.Label = label; + this.InstallDirectory = install_directory; + this.Tools = tools; + this.Launcher = launcher; + } + + public static Gtk.ListStore GetModel () { + Gtk.ListStore model = new Gtk.ListStore (2, typeof (string), typeof (Location)); + Gtk.TreeIter iter; + + foreach (var item in GetInstallLocations ()) { + var dir = Posix.opendir (item.InstallDirectory); + + if (dir != null) { + model.append (out iter); + model.set (iter, 0, item.Label, 1, item, -1); + } + } + + return model; + } + + public static Location[] GetInstallLocations () { + Location[] locations = new Location[11]; + + string home_dir = GLib.Environment.get_home_dir (); + + string[] steam_locations = new string[] { home_dir + "/.local/share/Steam", home_dir + "/.steam/root", home_dir + "/.steam/steam", home_dir + "/.steam/debian-installation" }; + string steam_dir = steam_locations[0]; + foreach (var item in steam_locations) { + var dir = Posix.opendir (item); + + if (dir != null) { + steam_dir = item; + } + } + + locations[0] = new Location ("Steam", steam_dir + "/compatibilitytools.d", ProtonPlus.Models.CompatibilityTool.Steam (), new ProtonPlus.Models.Launcher ("Steam")); + locations[1] = new Location ("Steam (Flatpak)", home_dir + "/.var/app/com.valvesoftware.Steam/data/Steam/compatibilitytools.d", ProtonPlus.Models.CompatibilityTool.Steam (), new ProtonPlus.Models.Launcher ("Steam")); + locations[2] = new Location ("Steam (Snap)", home_dir + "/snap/steam/common/.steam/root/compatibilitytools.d", ProtonPlus.Models.CompatibilityTool.Steam (), new ProtonPlus.Models.Launcher ("Steam")); + locations[3] = new Location ("Lutris", home_dir + "/.local/share/lutris/runners/wine", ProtonPlus.Models.CompatibilityTool.Lutris (), new ProtonPlus.Models.Launcher ("Lutris")); + locations[4] = new Location ("Lutris (Flatpak)", home_dir + "/.var/app/net.lutris.Lutris/data/lutris/runners/wine", ProtonPlus.Models.CompatibilityTool.Lutris (), new ProtonPlus.Models.Launcher ("Lutris")); + locations[5] = new Location ("Heroic Wine", home_dir + "/.config/heroic/tools/wine", ProtonPlus.Models.CompatibilityTool.HeroicWine (), new ProtonPlus.Models.Launcher ("Heroic Wine")); + locations[6] = new Location ("Heroic Proton", home_dir + "/.config/heroic/tools/proton", ProtonPlus.Models.CompatibilityTool.HeroicProton (), new ProtonPlus.Models.Launcher ("Heroic Proton")); + locations[7] = new Location ("Heroic Wine (Flatpak)", home_dir + "/.var/app/com.heroicgameslauncher.hgl/config/heroic/tools/wine", ProtonPlus.Models.CompatibilityTool.HeroicWine (), new ProtonPlus.Models.Launcher ("Heroic Wine")); + locations[8] = new Location ("Heroic Proton (Flatpak)", home_dir + "/.var/app/com.heroicgameslauncher.hgl/config/heroic/tools/proton", ProtonPlus.Models.CompatibilityTool.HeroicProton (), new ProtonPlus.Models.Launcher ("Heroic Proton")); + locations[9] = new Location ("Bottles", home_dir + "/.local/share/bottles/runners", ProtonPlus.Models.CompatibilityTool.Bottles (), new ProtonPlus.Models.Launcher ("Bottles")); + locations[10] = new Location ("Bottles (Flatpak)", home_dir + "/.var/app/com.usebottles.bottles/data/bottles/runners", ProtonPlus.Models.CompatibilityTool.Bottles (), new ProtonPlus.Models.Launcher ("Bottles")); + + return locations; + } + } +} diff --git a/src/models/preference.vala b/src/models/preference.vala new file mode 100644 index 0000000..8402c84 --- /dev/null +++ b/src/models/preference.vala @@ -0,0 +1,61 @@ +namespace ProtonPlus.Models { + public class Preference: Object { + + public string Title { public get; private set; } + public T[] ObjectList { public get; private set; } + + public Preference (string title, T[] object_list) { + this.Title = title; + this.ObjectList = object_list; + } + + public static Style[] GetStyles () { + Style[] styles = new Style[3]; + styles[0] = new Style ("System", Adw.ColorScheme.DEFAULT, 0); + styles[1] = new Style ("Light", Adw.ColorScheme.FORCE_LIGHT, 1); + styles[2] = new Style ("Dark", Adw.ColorScheme.FORCE_DARK, 2); + return styles; + } + + public static Style FindStyle (string label) { + switch (label) { + case "Light": + return Preference.GetStyles ()[1]; + case "Dark": + return Preference.GetStyles ()[2]; + default: + return Preference.GetStyles ()[0]; + } + } + + public static Gtk.ListStore GetStyleModel () { + Gtk.ListStore model = new Gtk.ListStore (2, typeof (string), typeof (Style)); + Gtk.TreeIter iter; + + foreach (var item in GetStyles ()) { + model.append (out iter); + model.set (iter, 0, item.Label, 1, item, -1); + } + + return model; + } + + public class Style : Object { + public string Label { public get; private set; } + public Adw.ColorScheme ColorScheme { public get; private set; } + public int Position { public get; private set; } + + public Style (string label, Adw.ColorScheme color_scheme, int position) { + this.Label = label; + this.ColorScheme = color_scheme; + this.Position = position; + } + } + + public static Preference[] GetPreferences () { + Preference[] preferences = new Preference[1]; + preferences[0] = new Preference