diff --git a/.idea/indexLayout.xml b/.idea/indexLayout.xml new file mode 100644 index 0000000..7b08163 --- /dev/null +++ b/.idea/indexLayout.xml @@ -0,0 +1,8 @@ + + + + + + + + \ No newline at end of file diff --git a/.idea/projectSettingsUpdater.xml b/.idea/projectSettingsUpdater.xml new file mode 100644 index 0000000..64af657 --- /dev/null +++ b/.idea/projectSettingsUpdater.xml @@ -0,0 +1,7 @@ + + + + + \ No newline at end of file diff --git a/.idea/vcs.xml b/.idea/vcs.xml new file mode 100644 index 0000000..35eb1dd --- /dev/null +++ b/.idea/vcs.xml @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/.idea/workspace.xml b/.idea/workspace.xml new file mode 100644 index 0000000..a973b1e --- /dev/null +++ b/.idea/workspace.xml @@ -0,0 +1,73 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + 1776109424996 + + + + + + + + + + + + + \ No newline at end of file diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..9e26dfe --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1 @@ +{} \ No newline at end of file diff --git a/OmegaLeo.HelperLib.Changelog/LICENSE.md b/OmegaLeo.HelperLib.Changelog/LICENSE.md index ca8f2dd..0ad25db 100755 --- a/OmegaLeo.HelperLib.Changelog/LICENSE.md +++ b/OmegaLeo.HelperLib.Changelog/LICENSE.md @@ -1,21 +1,661 @@ -MIT License - -Copyright (c) 2024 Nuno "Omega Leo" Diogo - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. \ No newline at end of file + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 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 Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are 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. + + 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. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + 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 Affero 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. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + 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 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 work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero 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 Affero 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 Affero 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 Affero 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 Affero 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 Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + 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 AGPL, see +. diff --git a/OmegaLeo.HelperLib.ChangelogHandler/OmegaLeo.HelperLib.ChangelogHandler.csproj b/OmegaLeo.HelperLib.ChangelogHandler/OmegaLeo.HelperLib.ChangelogHandler.csproj index 78b815e..04e1b0e 100755 --- a/OmegaLeo.HelperLib.ChangelogHandler/OmegaLeo.HelperLib.ChangelogHandler.csproj +++ b/OmegaLeo.HelperLib.ChangelogHandler/OmegaLeo.HelperLib.ChangelogHandler.csproj @@ -10,6 +10,7 @@ + diff --git a/OmegaLeo.HelperLib.ChangelogHandler/Program.cs b/OmegaLeo.HelperLib.ChangelogHandler/Program.cs index 29ba424..5b71cc8 100755 --- a/OmegaLeo.HelperLib.ChangelogHandler/Program.cs +++ b/OmegaLeo.HelperLib.ChangelogHandler/Program.cs @@ -18,6 +18,7 @@ {Path.Join(root, "OmegaLeo.HelperLib.Game", "CHANGELOG.md"), typeof(OmegaLeo.HelperLib.Game.Models.ConsoleCommand).Assembly}, {Path.Join(root, "OmegaLeo.HelperLib.Documentation", "CHANGELOG.md"), typeof(OmegaLeo.HelperLib.Documentation.Helpers.DocumentationHelperTool).Assembly}, {Path.Join(root, "OmegaLeo.HelperLib.Shared", "CHANGELOG.md"), typeof(OmegaLeo.HelperLib.Shared.Attributes.ChangelogAttribute).Assembly}, + {Path.Join(root, "OmegaLeo.HelperLib.Steamworks", "CHANGELOG.md"), typeof(OmegaLeo.HelperLib.Steamworks.SteamManager).Assembly}, }; foreach (var changelog in changelogs) diff --git a/OmegaLeo.HelperLib.ConsoleApp/OmegaLeo.HelperLib.ConsoleApp.csproj b/OmegaLeo.HelperLib.ConsoleApp/OmegaLeo.HelperLib.ConsoleApp.csproj index 649c15b..6a4357e 100755 --- a/OmegaLeo.HelperLib.ConsoleApp/OmegaLeo.HelperLib.ConsoleApp.csproj +++ b/OmegaLeo.HelperLib.ConsoleApp/OmegaLeo.HelperLib.ConsoleApp.csproj @@ -2,14 +2,25 @@ Exe - net8.0 + net9.0 enable enable + + + + + + + + Always + + + diff --git a/OmegaLeo.HelperLib.ConsoleApp/Program.cs b/OmegaLeo.HelperLib.ConsoleApp/Program.cs index e56ba62..03af9f7 100755 --- a/OmegaLeo.HelperLib.ConsoleApp/Program.cs +++ b/OmegaLeo.HelperLib.ConsoleApp/Program.cs @@ -2,101 +2,121 @@ // /media/omegaleo/Development/Library Dev/HelperLib -using System.Reflection; -using OmegaLeo.HelperLib.Extensions; -using OmegaLeo.HelperLib.Helpers; -using LibGit2Sharp; -using OmegaLeo.HelperLib.Changelog.Tools; -using OmegaLeo.HelperLib.Git; -using OmegaLeo.HelperLib.Git.Models; - -Console.WriteLine("Insert repo path to check changes:"); -var repo = Console.ReadLine(); - -if (repo.IsNullOrEmpty()) +using Microsoft.Extensions.Logging; +using OmegaLeo.HelperLib.Steamworks; + +public class Program { - repo = "/media/omegaleo/Development/Library Dev/HelperLib"; -} + public static void Main() + { + using var loggerFactory = LoggerFactory.Create(builder => + { + builder + .SetMinimumLevel(LogLevel.Information) + .AddSimpleConsole(options => + { + options.SingleLine = true; + options.TimestampFormat = "HH:mm:ss "; + }); + }); -var git = new GitClient(repo); + var steamLogger = loggerFactory.CreateLogger(); + var achievementLogger = loggerFactory.CreateLogger(); -var result = BenchmarkUtility.Record(() => -{ - var changes = git.GetChanges(); + SteamManager.ConfigureLogger(steamLogger); + SteamManager.ConfigureAppId(480); // 480 is the AppId for Spacewar, a test app provided by Valve - if (changes.FolderName.IsNotNullOrEmpty()) - { - RecursiveOutput(new List() { changes }); + var steam = SteamManager.Instance; + if (steam.IsSteamworksInitialized) + { + steamLogger.LogInformation("Welcome {SteamName}", steam.GetSteamName()); + } - var option = 99; + steamLogger.LogInformation("--- Steam wrapper smoke tests ---"); - while (option != 0) + // Utils (read-only) + steamLogger.LogInformation("Utils available: {Available}", steam.Utils.IsAvailable); + if (steam.Utils.IsAvailable) { - ShowOptions(); - if (option != 99) - { - switch (option) - { - case 1: - Console.WriteLine("Write the commit message"); - var msg = Console.ReadLine(); - - while (msg.IsNullOrEmpty()) - { - Console.WriteLine("Empty message detected, please write a commit message..."); - msg = Console.ReadLine(); - } - - var signature = new Signature("Nuno 'Omega Leo' Diogo", "nunodiogo@omegaleo.pt", - DateTimeOffset.Now); - git.Commit(msg, signature); - - break; - case 2: - git.Push(); - break; - default: - Console.WriteLine("Invalid Option!"); - break; - } - } - - int.TryParse(Console.ReadLine(), out option); + steamLogger.LogInformation("AppId: {AppId}, Country: {Country}, Overlay: {Overlay}", + steam.Utils.GetAppId(), + steam.Utils.GetIpCountry(), + steam.Utils.IsOverlayEnabled()); + } + + // Friends (read-only) + steamLogger.LogInformation("Friends available: {Available}", steam.Friends.IsAvailable); + if (steam.Friends.IsAvailable) + { + // 65535 tests all friend relationship flags for quick smoke coverage. + var friendCount = steam.Friends.GetFriendCount(65535); + steamLogger.LogInformation("Friend count (all flags): {FriendCount}", friendCount); } - } - else - { - Console.WriteLine("No changes found in specified repository"); - } -}); -Console.WriteLine($"Time for checking for changes: {result} ms"); + // Remote storage (read-only) + steamLogger.LogInformation("RemoteStorage available: {Available}", steam.RemoteStorage.IsAvailable); + if (steam.RemoteStorage.IsAvailable) + { + steamLogger.LogInformation("Cloud enabled: {Enabled}, file count: {Count}", + steam.RemoteStorage.IsCloudEnabledForApp(), + steam.RemoteStorage.GetFileCount()); + } -Console.ReadLine(); + // User stats (safe read/request) + steamLogger.LogInformation("UserStats available: {Available}", steam.UserStats.IsAvailable); + if (steam.UserStats.IsAvailable) + { + var globalStatsCall = steam.UserStats.RequestGlobalStats(7); + steamLogger.LogInformation("RequestGlobalStats call handle: {Handle}", globalStatsCall); + } + // UGC (safe query/subscription read) + steamLogger.LogInformation("UGC subscribed count: {Count}", steam.Ugc.GetNumSubscribedItems()); + var ugcQuery = steam.Ugc.CreateQueryAllUgcRequest(queryType: 0, matchingType: 0, creatorAppId: 480, consumerAppId: 480, page: 1); + if (ugcQuery != 0) + { + var ugcCall = steam.Ugc.SendQueryUgcRequest(ugcQuery); + steamLogger.LogInformation("UGC query handle: {QueryHandle}, call handle: {CallHandle}", ugcQuery, ugcCall); + steam.Ugc.ReleaseQueryUgcRequest(ugcQuery); + } + else + { + steamLogger.LogWarning("UGC query handle returned 0 (unsupported on this runtime or invalid params)."); + } -void RecursiveOutput(List folders, int depth = 0) -{ - foreach (var folder in folders) - { - Console.WriteLine($"{new string('\t', depth)}>{folder.FolderName}"); - if (folder.SubFolders.Any()) + // Matchmaking (safe request) + steamLogger.LogInformation("Matchmaking available: {Available}", steam.Matchmaking.IsAvailable); + if (steam.Matchmaking.IsAvailable) { - RecursiveOutput(folder.SubFolders, depth + 1); + steam.Matchmaking.AddRequestLobbyListResultCountFilter(10); + var lobbyListCall = steam.Matchmaking.RequestLobbyList(); + steamLogger.LogInformation("RequestLobbyList call handle: {Handle}", lobbyListCall); } - foreach (var change in folder.ChangesInFolder) + // Remote Play + steamLogger.LogInformation("RemotePlay sessions: {SessionCount}", steam.RemotePlay.GetSessionCount()); + + // Other read-only status checks + steamLogger.LogInformation("Screenshots hooked: {Hooked}", steam.Screenshots.IsScreenshotsHooked()); + steamLogger.LogInformation("Music enabled: {Enabled}, playing: {Playing}, volume: {Volume}", + steam.Music.IsEnabled(), steam.Music.IsPlaying(), steam.Music.GetVolume()); + if (steam.Video.IsBroadcasting(out var viewers)) { - Console.WriteLine($"{new string('\t', depth + 1)}>{Path.GetFileName(change.Path)} ({change.Status})"); + steamLogger.LogInformation("Video broadcasting viewers: {Viewers}", viewers); + } + else + { + steamLogger.LogInformation("Video broadcasting is not active."); } - } -} -void ShowOptions() -{ - Console.Clear(); - Console.WriteLine(new string('=', 20)); - Console.WriteLine("What do you want to do in this repository?"); - Console.WriteLine("1. Commit all changes"); - Console.WriteLine("2. Push"); + steamLogger.LogInformation("--- End smoke tests ---"); + + // Call this in your game loop (Unity Update, Godot _Process, etc.) + steam.Update(); + + var achievements = new AchievementManager(achievementLogger); + achievements.UnlockAchievement("NEW_ACHIEVEMENT_0_4"); + + steam.Shutdown(); + } } \ No newline at end of file diff --git a/OmegaLeo.HelperLib.ConsoleApp/steam_appid.txt b/OmegaLeo.HelperLib.ConsoleApp/steam_appid.txt new file mode 100644 index 0000000..7ad8022 --- /dev/null +++ b/OmegaLeo.HelperLib.ConsoleApp/steam_appid.txt @@ -0,0 +1 @@ +480 \ No newline at end of file diff --git a/OmegaLeo.HelperLib.Documentation/Helpers/DocumentationHelper.cs b/OmegaLeo.HelperLib.Documentation/Helpers/DocumentationHelper.cs index 3a34b13..8031e77 100755 --- a/OmegaLeo.HelperLib.Documentation/Helpers/DocumentationHelper.cs +++ b/OmegaLeo.HelperLib.Documentation/Helpers/DocumentationHelper.cs @@ -12,6 +12,7 @@ namespace OmegaLeo.HelperLib.Documentation.Helpers { [Changelog("1.2.0", "Migrated DocumentationHelper library from NetFlow.DocumentationHelper.Library to it's own package in OmegaLeo.HelperLib", "January 26, 2026")] + [Changelog("1.3.0", "GenerateDocumentation now includes method parameters and return type in the generated documentation", "April 14, 2026")] public static class DocumentationHelperTool { [Documentation("GenerateDocumentation (bool generateForPackageAssembly)", @@ -21,6 +22,8 @@ public static class DocumentationHelperTool **Title**: Title what we're generating documentation for **Description**: Description of what we're generating documentation for, this can contain usage examples and can use the args array to pass names(e.g.: This method uses this methodology) **Args**: Array of strings that describe the parameters of the method or class +**MethodParameters**: Reflected parameter signature list for documented methods (e.g. `value: int`, `name: string`) +**ReturnType**: Reflected return type for documented methods (e.g. `bool`, `List`) **CodeExample**: A code example of how to use the method or class *Note: If generateForPackageAssembly is set to true, this will generate documentation for the library as well.*", @@ -146,7 +149,12 @@ static DocumentationStructure GetDocumentation(Type type, string assemblyName) var propertyDocs = type.GetProperties().SelectMany(p => p.GetCustomAttributes(typeof(DocumentationAttribute), true).Select(x => (DocumentationAttribute)x)); var methodDocs = type.GetMethods().SelectMany(m => - m.GetCustomAttributes(typeof(DocumentationAttribute), true).Select(x => (DocumentationAttribute)x)); + m.GetCustomAttributes(typeof(DocumentationAttribute), true) + .Select(x => new + { + Method = m, + Attribute = (DocumentationAttribute)x + })); var docStructure = new DocumentationStructure(assemblyName, type.Name); @@ -165,13 +173,94 @@ static DocumentationStructure GetDocumentation(Type type, string assemblyName) docStructure.AddDescription(new DocumentationDescription(doc.Title, doc.Description, doc.Args, doc.CodeExample)); } - foreach (var doc in methodDocs) + foreach (var methodDoc in methodDocs) { - docStructure.AddDescription(new DocumentationDescription(doc.Title, doc.Description, doc.Args, doc.CodeExample)); + var reflectedParameters = GetMethodParameters(methodDoc.Method); + var returnType = GetFriendlyTypeName(methodDoc.Method.ReturnType); + + var mergedParameters = (methodDoc.Attribute.Args ?? Array.Empty()) + .Concat(reflectedParameters) + .ToArray(); + + docStructure.AddDescription(new DocumentationDescription( + methodDoc.Attribute.Title, + methodDoc.Attribute.Description, + mergedParameters, + methodDoc.Attribute.CodeExample, + reflectedParameters, + returnType)); } return docStructure; } + + static string[] GetMethodParameters(MethodInfo method) + { + return method.GetParameters() + .Select(parameter => + { + var prefix = parameter.IsOut + ? "out " + : parameter.ParameterType.IsByRef + ? "ref " + : string.Empty; + + var parameterType = parameter.ParameterType.IsByRef + ? parameter.ParameterType.GetElementType() ?? parameter.ParameterType + : parameter.ParameterType; + + return $"{parameter.Name}: {prefix}{GetFriendlyTypeName(parameterType)}"; + }) + .ToArray(); + } + + static string GetFriendlyTypeName(Type type) + { + if (type == typeof(void)) return "void"; + if (type == typeof(bool)) return "bool"; + if (type == typeof(byte)) return "byte"; + if (type == typeof(sbyte)) return "sbyte"; + if (type == typeof(char)) return "char"; + if (type == typeof(decimal)) return "decimal"; + if (type == typeof(double)) return "double"; + if (type == typeof(float)) return "float"; + if (type == typeof(int)) return "int"; + if (type == typeof(uint)) return "uint"; + if (type == typeof(long)) return "long"; + if (type == typeof(ulong)) return "ulong"; + if (type == typeof(short)) return "short"; + if (type == typeof(ushort)) return "ushort"; + if (type == typeof(string)) return "string"; + if (type == typeof(object)) return "object"; + + if (type.IsArray) + { + return $"{GetFriendlyTypeName(type.GetElementType() ?? typeof(object))}[]"; + } + + if (type.IsGenericType) + { + var name = type.Name; + var tickIndex = name.IndexOf('`'); + if (tickIndex > 0) + { + name = name.Substring(0, tickIndex); + } + + var genericArguments = type.GetGenericArguments() + .Select(GetFriendlyTypeName); + + return $"{name}<{string.Join(", ", genericArguments)}>"; + } + + var nullable = Nullable.GetUnderlyingType(type); + if (nullable != null) + { + return $"{GetFriendlyTypeName(nullable)}?"; + } + + return type.Name; + } static Dictionary loadedXmlDocumentation = new Dictionary(); diff --git a/OmegaLeo.HelperLib.Documentation/LICENSE.md b/OmegaLeo.HelperLib.Documentation/LICENSE.md new file mode 100755 index 0000000..0ad25db --- /dev/null +++ b/OmegaLeo.HelperLib.Documentation/LICENSE.md @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 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 Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are 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. + + 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. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + 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 Affero 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. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + 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 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 work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero 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 Affero 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 Affero 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 Affero 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 Affero 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 Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + 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 AGPL, see +. diff --git a/OmegaLeo.HelperLib.Documentation/Models/DocumentationStructure.cs b/OmegaLeo.HelperLib.Documentation/Models/DocumentationStructure.cs index 8bbef75..c155293 100755 --- a/OmegaLeo.HelperLib.Documentation/Models/DocumentationStructure.cs +++ b/OmegaLeo.HelperLib.Documentation/Models/DocumentationStructure.cs @@ -29,6 +29,8 @@ public class DocumentationDescription public string Title; public string Description; public string[] Parameters; + public string[] MethodParameters; + public string ReturnType; public string CodeExample = string.Empty; [Documentation(nameof(DocumentationDescription), "Description of the current Documented object", new [] @@ -36,13 +38,17 @@ public class DocumentationDescription "title - Name of the object", "description - Description of what the object does", "parameters - The parameters for the object (in case of a method with parameters)", + "methodParameters - Reflected method parameter list when the documented member is a method", + "returnType - Reflected return type when the documented member is a method", "codeExample - Code example of how to use the object" })] - public DocumentationDescription(string title, string description, string[] parameters = default, string codeExample = "") + public DocumentationDescription(string title, string description, string[]? parameters = null, string codeExample = "", string[]? methodParameters = null, string returnType = "") { Title = title; Description = description; Parameters = parameters ?? Array.Empty(); + MethodParameters = methodParameters ?? Array.Empty(); + ReturnType = returnType ?? string.Empty; CodeExample = codeExample; } } diff --git a/OmegaLeo.HelperLib.Game/LICENSE.md b/OmegaLeo.HelperLib.Game/LICENSE.md new file mode 100755 index 0000000..0ad25db --- /dev/null +++ b/OmegaLeo.HelperLib.Game/LICENSE.md @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 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 Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are 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. + + 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. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + 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 Affero 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. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + 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 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 work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero 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 Affero 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 Affero 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 Affero 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 Affero 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 Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + 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 AGPL, see +. diff --git a/OmegaLeo.HelperLib.Shared/LICENSE.md b/OmegaLeo.HelperLib.Shared/LICENSE.md new file mode 100755 index 0000000..0ad25db --- /dev/null +++ b/OmegaLeo.HelperLib.Shared/LICENSE.md @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 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 Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are 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. + + 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. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + 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 Affero 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. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + 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 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 work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero 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 Affero 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 Affero 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 Affero 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 Affero 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 Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + 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 AGPL, see +. diff --git a/OmegaLeo.HelperLib.Steamworks/.gitignore b/OmegaLeo.HelperLib.Steamworks/.gitignore new file mode 100644 index 0000000..a505c1e --- /dev/null +++ b/OmegaLeo.HelperLib.Steamworks/.gitignore @@ -0,0 +1 @@ +runtimes/ \ No newline at end of file diff --git a/OmegaLeo.HelperLib.Steamworks/AchievementManager.cs b/OmegaLeo.HelperLib.Steamworks/AchievementManager.cs new file mode 100644 index 0000000..1d3aa53 --- /dev/null +++ b/OmegaLeo.HelperLib.Steamworks/AchievementManager.cs @@ -0,0 +1,42 @@ +using Microsoft.Extensions.Logging; +using OmegaLeo.HelperLib.Shared.Attributes; + +namespace OmegaLeo.HelperLib.Steamworks +{ + [Documentation(nameof(AchievementManager), "Provides helper methods for unlocking and querying Steam achievements.", null, + @"```csharp +var achievements = new AchievementManager(logger); +achievements.UnlockAchievement(""ACH_WIN_ONE_GAME""); +```")] + public class AchievementManager + { + private readonly ILogger _logger; + + public AchievementManager(ILogger logger = null) + { + _logger = logger ?? SteamManager.Logger; + } + + [Documentation(nameof(UnlockAchievement), "Attempts to unlock the provided achievement and store user stats.", new[] { "achievementId: Steam achievement identifier to unlock." }, null)] + public void UnlockAchievement(string achievementId) + { + if (SteamManager.Instance.IsSteamworksInitialized) + { + SteamNativeApi.SetAchievement(achievementId); + SteamNativeApi.StoreStats(); // Don't forget to store the stats + _logger.LogInformation("Attempting to unlock achievement: {AchievementId}", achievementId); + } + } + + [Documentation(nameof(IsAchievementUnlocked), "Checks whether a Steam achievement is currently unlocked.", new[] { "achievementId: Steam achievement identifier to check.", "unlocked: True when the achievement is unlocked." }, null)] + public bool IsAchievementUnlocked(string achievementId, out bool unlocked) + { + unlocked = false; + if (SteamManager.Instance.IsSteamworksInitialized) + { + return SteamNativeApi.GetAchievement(achievementId, out unlocked); + } + return false; + } + } +} diff --git a/OmegaLeo.HelperLib.Steamworks/LICENSE.md b/OmegaLeo.HelperLib.Steamworks/LICENSE.md new file mode 100755 index 0000000..0ad25db --- /dev/null +++ b/OmegaLeo.HelperLib.Steamworks/LICENSE.md @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 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 Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are 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. + + 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. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + 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 Affero 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. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + 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 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 work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero 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 Affero 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 Affero 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 Affero 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 Affero 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 Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + 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 AGPL, see +. diff --git a/OmegaLeo.HelperLib.Steamworks/OmegaLeo.HelperLib.Steamworks.csproj b/OmegaLeo.HelperLib.Steamworks/OmegaLeo.HelperLib.Steamworks.csproj new file mode 100644 index 0000000..3e45300 --- /dev/null +++ b/OmegaLeo.HelperLib.Steamworks/OmegaLeo.HelperLib.Steamworks.csproj @@ -0,0 +1,26 @@ + + + + netstandard2.1 + 9 + + + + + + + true + runtimes\%(RecursiveDir)%(Filename)%(Extension) + PreserveNewest + + + + + + + + + + + + diff --git a/OmegaLeo.HelperLib.Steamworks/README.md b/OmegaLeo.HelperLib.Steamworks/README.md new file mode 100644 index 0000000..f679e78 --- /dev/null +++ b/OmegaLeo.HelperLib.Steamworks/README.md @@ -0,0 +1,102 @@ +# OmegaLeo's Helper Library - Steamworks +Lightweight Steamworks helper library for C# game projects. + +This package provides a simple Steam API wrapper for common tasks like initialization, callback processing, player name lookup, and achievements. + +## Features +- Simple Steam initialization via `SteamManager.Instance` +- Per-frame callback runner with `SteamManager.Update()` +- Safe shutdown with `SteamManager.Shutdown()` +- Player persona name access with `SteamManager.GetSteamName()` +- Achievement helpers via `AchievementManager` +- Steam Workshop (UGC) helpers via `SteamManager.Instance.Ugc` +- Steam Remote Play helpers via `SteamManager.Instance.RemotePlay` +- Additional interface managers: Controller, Friends, GameServer, Input, Inventory, Matchmaking, Parties, RemoteStorage, Screenshots, UserStats, Utils, Video, and more. +- Includes native Steam runtime files in NuGet package `runtimes/` + +## Installation +```bash +dotnet add package OmegaLeo.HelperLib.Steamworks +``` + +## Quick Start +```cs +using OmegaLeo.HelperLib.Steamworks; + +// Optional but recommended for local/editor runs. +SteamManager.ConfigureAppId(480); // Replace with your real AppId. + +var steam = SteamManager.Instance; +if (steam.IsSteamworksInitialized) +{ + Console.WriteLine($"Welcome {steam.GetSteamName()}"); +} + +// Call this in your game loop (Unity Update, Godot _Process, etc.) +steam.Update(); + +var achievements = new AchievementManager(); +achievements.UnlockAchievement("ACH_FIRST_WIN"); + +// Steam Workshop (UGC) example +var subscribedIds = steam.Ugc.GetSubscribedItems(); + +// Steam Remote Play example +var remotePlaySessionCount = steam.RemotePlay.GetSessionCount(); + +steam.Shutdown(); +``` + +## More API Examples +```cs +var steam = SteamManager.Instance; + +// Friends / rich presence +steam.Friends.SetRichPresence("status", "In Match"); +steam.Friends.SetRichPresence("map", "Arena_01"); +var friendName = steam.Friends.GetFriendPersonaName(76561198000000000UL); +var friendStatus = steam.Friends.GetFriendRichPresence(76561198000000000UL, "status"); + +// Remote storage +var saveBytes = System.Text.Encoding.UTF8.GetBytes("save-data-v1"); +steam.RemoteStorage.FileWrite("save_slot_1.dat", saveBytes); +if (steam.RemoteStorage.FileRead("save_slot_1.dat", out var loadedBytes)) +{ + var loadedText = System.Text.Encoding.UTF8.GetString(loadedBytes); +} + +// User stats +steam.UserStats.SetStatInt32("KILLS", 25); +steam.UserStats.StoreStats(); +steam.UserStats.RequestGlobalStats(7); + +// UGC update convenience APIs (existing item) +var options = new SteamUgcItemUpdateOptions +{ + Title = "My Workshop Item", + Description = "Updated description.", + Tags = new[] { "map", "coop" }, + ContentFolder = "/absolute/path/to/content", + PreviewFile = "/absolute/path/to/preview.png" +}; +var submitCallHandle = steam.Ugc.UpdateItem(480, 123456789012345678UL, options, "Updated content", out var failedStep); + +// Fluent session alternative +var session = steam.Ugc.BeginUpdateSession(480, 123456789012345678UL) + .WithTitle("My Workshop Item") + .WithDescription("Updated description") + .WithTags("map", "coop") + .WithContentFolder("/absolute/path/to/content") + .WithPreviewFile("/absolute/path/to/preview.png"); +var submitCallHandle2 = session.Submit("Updated content", out var failedStep2); +``` + +## Notes +- Steam must be running and your app must be launched in a valid Steam context. +- Configure your AppId before first access to `SteamManager.Instance`. +- `SteamManager.Update()` should be called continuously during runtime. +- If Steam is unavailable, `GetSteamName()` falls back to `"Player"`. + +## License +Open source under the AGPL v3 License. See the repository `LICENSE` for details. + diff --git a/OmegaLeo.HelperLib.Steamworks/SteamExtendedManagers.cs b/OmegaLeo.HelperLib.Steamworks/SteamExtendedManagers.cs new file mode 100644 index 0000000..a281d66 --- /dev/null +++ b/OmegaLeo.HelperLib.Steamworks/SteamExtendedManagers.cs @@ -0,0 +1,401 @@ +using OmegaLeo.HelperLib.Shared.Attributes; + +namespace OmegaLeo.HelperLib.Steamworks +{ + [Documentation(nameof(SteamControllerManager), "Provides access checks for ISteamController.", null, null)] + public class SteamControllerManager + { + public bool IsAvailable => SteamNativeApi.IsSteamControllerAvailable(); + } + + [Documentation(nameof(SteamFriendsManager), "Provides access checks for ISteamFriends.", null, null)] + public class SteamFriendsManager + { + public bool IsAvailable => SteamNativeApi.IsSteamFriendsAvailable(); + + [Documentation(nameof(GetFriendCount), "Gets the friend count filtered by Steam friend flags.", new[] { "friendFlags: Bitmask value matching Steam EFriendFlags." }, null)] + public int GetFriendCount(int friendFlags) + { + return SteamNativeApi.GetFriendCount(friendFlags); + } + + [Documentation(nameof(GetFriendPersonaName), "Gets the persona name of a friend by SteamID64.", new[] { "steamIdFriend: Friend SteamID64." }, null)] + public string GetFriendPersonaName(ulong steamIdFriend) + { + return SteamNativeApi.GetFriendPersonaName(steamIdFriend); + } + + [Documentation(nameof(ActivateGameOverlayInviteDialog), "Opens the Steam invite dialog for a lobby.", new[] { "steamIdLobby: Lobby SteamID64." }, null)] + public void ActivateGameOverlayInviteDialog(ulong steamIdLobby) + { + SteamNativeApi.FriendsActivateGameOverlayInviteDialog(steamIdLobby); + } + + [Documentation(nameof(SetRichPresence), "Sets a rich presence key/value pair for the local user.", new[] { "key: Rich presence key.", "value: Rich presence value." }, null)] + public bool SetRichPresence(string key, string value) + { + return SteamNativeApi.FriendsSetRichPresence(key, value); + } + + [Documentation(nameof(ClearRichPresence), "Clears all rich presence values for the local user.", null, null)] + public void ClearRichPresence() + { + SteamNativeApi.FriendsClearRichPresence(); + } + + [Documentation(nameof(GetFriendRichPresence), "Gets a rich presence value for a specific friend.", new[] { "steamIdFriend: Friend SteamID64.", "key: Rich presence key." }, null)] + public string GetFriendRichPresence(ulong steamIdFriend, string key) + { + return SteamNativeApi.FriendsGetFriendRichPresence(steamIdFriend, key); + } + + [Documentation(nameof(InviteUserToGame), "Invites a friend to the current game session using a connect string.", new[] { "steamIdFriend: Friend SteamID64.", "connectString: Game connect string passed through Steam invite." }, null)] + public bool InviteUserToGame(ulong steamIdFriend, string connectString) + { + return SteamNativeApi.FriendsInviteUserToGame(steamIdFriend, connectString); + } + } + + [Documentation(nameof(SteamGameCoordinatorManager), "Provides access checks for ISteamGameCoordinator.", null, null)] + public class SteamGameCoordinatorManager + { + public bool IsAvailable => SteamNativeApi.IsSteamGameCoordinatorAvailable(); + } + + [Documentation(nameof(SteamGameServerManager), "Provides access checks for ISteamGameServer.", null, null)] + public class SteamGameServerManager + { + public bool IsAvailable => SteamNativeApi.IsSteamGameServerAvailable(); + } + + [Documentation(nameof(SteamGameServerStatsManager), "Provides access checks for ISteamGameServerStats.", null, null)] + public class SteamGameServerStatsManager + { + public bool IsAvailable => SteamNativeApi.IsSteamGameServerStatsAvailable(); + } + + [Documentation(nameof(SteamHtmlSurfaceManager), "Provides access checks for ISteamHTMLSurface.", null, null)] + public class SteamHtmlSurfaceManager + { + public bool IsAvailable => SteamNativeApi.IsSteamHtmlSurfaceAvailable(); + } + + [Documentation(nameof(SteamInputManager), "Provides access checks for ISteamInput.", null, null)] + public class SteamInputManager + { + public bool IsAvailable => SteamNativeApi.IsSteamInputAvailable(); + + [Documentation(nameof(Init), "Initializes Steam Input for the application.", new[] { "explicitlyCallRunFrame: Set true when your game will manually call RunFrame each frame." }, null)] + public bool Init(bool explicitlyCallRunFrame = false) + { + return SteamNativeApi.InputInit(explicitlyCallRunFrame); + } + + [Documentation(nameof(Shutdown), "Shuts down Steam Input.", null, null)] + public bool Shutdown() + { + return SteamNativeApi.InputShutdown(); + } + + [Documentation(nameof(RunFrame), "Runs a Steam Input frame update.", null, null)] + public void RunFrame() + { + SteamNativeApi.InputRunFrame(); + } + } + + [Documentation(nameof(SteamInventoryManager), "Provides access checks for ISteamInventory.", null, null)] + public class SteamInventoryManager + { + public bool IsAvailable => SteamNativeApi.IsSteamInventoryAvailable(); + + [Documentation(nameof(LoadItemDefinitions), "Requests latest inventory item definitions from Steam.", null, null)] + public bool LoadItemDefinitions() + { + return SteamNativeApi.InventoryLoadItemDefinitions(); + } + + [Documentation(nameof(GetAllItems), "Requests all inventory items and returns a result handle.", new[] { "inventoryResultHandle: Inventory result handle to use with additional inventory API calls." }, null)] + public bool GetAllItems(out int inventoryResultHandle) + { + return SteamNativeApi.InventoryGetAllItems(out inventoryResultHandle); + } + + [Documentation(nameof(DestroyResult), "Releases an inventory result handle returned from Steam Inventory API calls.", new[] { "inventoryResultHandle: Inventory result handle to release." }, null)] + public void DestroyResult(int inventoryResultHandle) + { + SteamNativeApi.InventoryDestroyResult(inventoryResultHandle); + } + } + + [Documentation(nameof(SteamMatchmakingManager), "Provides access checks for ISteamMatchmaking.", null, null)] + public class SteamMatchmakingManager + { + public bool IsAvailable => SteamNativeApi.IsSteamMatchmakingAvailable(); + + [Documentation(nameof(RequestLobbyList), "Requests a lobby list and returns a Steam API call handle.", null, null)] + public ulong RequestLobbyList() + { + return SteamNativeApi.MatchmakingRequestLobbyList(); + } + + [Documentation(nameof(AddRequestLobbyListResultCountFilter), "Sets the maximum number of lobbies returned by RequestLobbyList.", new[] { "maxResults: Maximum number of lobby results." }, null)] + public void AddRequestLobbyListResultCountFilter(int maxResults) + { + SteamNativeApi.MatchmakingAddRequestLobbyListResultCountFilter(maxResults); + } + + [Documentation(nameof(CreateLobby), "Creates a lobby and returns a Steam API call handle.", new[] { "lobbyType: Numeric ELobbyType value.", "maxMembers: Maximum lobby member count." }, null)] + public ulong CreateLobby(int lobbyType, int maxMembers) + { + return SteamNativeApi.MatchmakingCreateLobby(lobbyType, maxMembers); + } + + [Documentation(nameof(JoinLobby), "Joins a lobby by SteamID64 and returns a Steam API call handle.", new[] { "steamIdLobby: Lobby SteamID64." }, null)] + public ulong JoinLobby(ulong steamIdLobby) + { + return SteamNativeApi.MatchmakingJoinLobby(steamIdLobby); + } + + [Documentation(nameof(LeaveLobby), "Leaves a lobby by SteamID64.", new[] { "steamIdLobby: Lobby SteamID64." }, null)] + public void LeaveLobby(ulong steamIdLobby) + { + SteamNativeApi.MatchmakingLeaveLobby(steamIdLobby); + } + + [Documentation(nameof(GetNumLobbyMembers), "Gets the number of members currently in a lobby.", new[] { "steamIdLobby: Lobby SteamID64." }, null)] + public int GetNumLobbyMembers(ulong steamIdLobby) + { + return SteamNativeApi.MatchmakingGetNumLobbyMembers(steamIdLobby); + } + } + + [Documentation(nameof(SteamMatchmakingServersManager), "Provides access checks for ISteamMatchmakingServers.", null, null)] + public class SteamMatchmakingServersManager + { + public bool IsAvailable => SteamNativeApi.IsSteamMatchmakingServersAvailable(); + } + + [Documentation(nameof(SteamMusicManager), "Provides access checks for ISteamMusic.", null, null)] + public class SteamMusicManager + { + public bool IsAvailable => SteamNativeApi.IsSteamMusicAvailable(); + + [Documentation(nameof(IsEnabled), "Checks whether Steam Music is enabled.", null, null)] + public bool IsEnabled() + { + return SteamNativeApi.MusicIsEnabled(); + } + + [Documentation(nameof(IsPlaying), "Checks whether Steam Music is currently playing.", null, null)] + public bool IsPlaying() + { + return SteamNativeApi.MusicIsPlaying(); + } + + [Documentation(nameof(Play), "Starts Steam Music playback.", null, null)] + public void Play() + { + SteamNativeApi.MusicPlay(); + } + + [Documentation(nameof(Pause), "Pauses Steam Music playback.", null, null)] + public void Pause() + { + SteamNativeApi.MusicPause(); + } + + [Documentation(nameof(PlayNext), "Advances to the next music track.", null, null)] + public void PlayNext() + { + SteamNativeApi.MusicPlayNext(); + } + + [Documentation(nameof(PlayPrevious), "Moves to the previous music track.", null, null)] + public void PlayPrevious() + { + SteamNativeApi.MusicPlayPrevious(); + } + + [Documentation(nameof(GetVolume), "Gets Steam Music volume (0..1 range).", null, null)] + public float GetVolume() + { + return SteamNativeApi.MusicGetVolume(); + } + + [Documentation(nameof(SetVolume), "Sets Steam Music volume (0..1 range).", new[] { "volume: New volume value." }, null)] + public void SetVolume(float volume) + { + SteamNativeApi.MusicSetVolume(volume); + } + } + + [Documentation(nameof(SteamPartiesManager), "Provides access checks for ISteamParties.", null, null)] + public class SteamPartiesManager + { + public bool IsAvailable => SteamNativeApi.IsSteamPartiesAvailable(); + } + + [Documentation(nameof(SteamRemoteStorageManager), "Provides access checks for ISteamRemoteStorage.", null, null)] + public class SteamRemoteStorageManager + { + public bool IsAvailable => SteamNativeApi.IsSteamRemoteStorageAvailable(); + + [Documentation(nameof(FileExists), "Checks whether a file exists in Steam Remote Storage.", new[] { "fileName: Cloud file path/name." }, null)] + public bool FileExists(string fileName) + { + return SteamNativeApi.RemoteStorageFileExists(fileName); + } + + [Documentation(nameof(GetFileCount), "Gets the number of files in Steam Remote Storage for the current app/user context.", null, null)] + public int GetFileCount() + { + return SteamNativeApi.RemoteStorageGetFileCount(); + } + + [Documentation(nameof(IsCloudEnabledForApp), "Checks whether Steam Cloud is enabled for this app.", null, null)] + public bool IsCloudEnabledForApp() + { + return SteamNativeApi.RemoteStorageIsCloudEnabledForApp(); + } + + [Documentation(nameof(FileWrite), "Writes a byte array to a Steam Cloud file.", new[] { "fileName: Cloud file path/name.", "data: Raw file bytes to write." }, null)] + public bool FileWrite(string fileName, byte[] data) + { + return SteamNativeApi.RemoteStorageFileWrite(fileName, data); + } + + [Documentation(nameof(FileRead), "Reads a Steam Cloud file into a byte array.", new[] { "fileName: Cloud file path/name.", "data: Output file bytes when read succeeds." }, null)] + public bool FileRead(string fileName, out byte[] data) + { + return SteamNativeApi.RemoteStorageFileRead(fileName, out data); + } + + [Documentation(nameof(FileDelete), "Deletes a Steam Cloud file.", new[] { "fileName: Cloud file path/name." }, null)] + public bool FileDelete(string fileName) + { + return SteamNativeApi.RemoteStorageFileDelete(fileName); + } + + [Documentation(nameof(GetFileSize), "Gets file size in bytes for a Steam Cloud file.", new[] { "fileName: Cloud file path/name." }, null)] + public int GetFileSize(string fileName) + { + return SteamNativeApi.RemoteStorageGetFileSize(fileName); + } + } + + [Documentation(nameof(SteamScreenshotsManager), "Provides access checks for ISteamScreenshots.", null, null)] + public class SteamScreenshotsManager + { + public bool IsAvailable => SteamNativeApi.IsSteamScreenshotsAvailable(); + + [Documentation(nameof(AddScreenshotToLibrary), "Adds an existing screenshot to the Steam screenshot library.", new[] { "fileNameJpg: Screenshot image path.", "fileNameThumbnail: Thumbnail path.", "width: Image width.", "height: Image height." }, null)] + public uint AddScreenshotToLibrary(string fileNameJpg, string fileNameThumbnail, int width, int height) + { + return SteamNativeApi.ScreenshotsAddScreenshotToLibrary(fileNameJpg, fileNameThumbnail, width, height); + } + + [Documentation(nameof(TriggerScreenshot), "Triggers an in-game screenshot event.", null, null)] + public void TriggerScreenshot() + { + SteamNativeApi.ScreenshotsTriggerScreenshot(); + } + + [Documentation(nameof(HookScreenshots), "Enables or disables screenshot hooks for custom handling.", new[] { "hook: True to hook screenshots." }, null)] + public void HookScreenshots(bool hook) + { + SteamNativeApi.ScreenshotsHookScreenshots(hook); + } + + [Documentation(nameof(IsScreenshotsHooked), "Checks whether screenshot hooks are currently enabled.", null, null)] + public bool IsScreenshotsHooked() + { + return SteamNativeApi.ScreenshotsIsScreenshotsHooked(); + } + } + + [Documentation(nameof(SteamUserStatsManager), "Provides access checks for ISteamUserStats.", null, null)] + public class SteamUserStatsManager + { + public bool IsAvailable => SteamNativeApi.IsSteamUserStatsAvailable(); + + [Documentation(nameof(RequestUserStats), "Requests user stats for a target SteamID64 and returns a Steam API call handle.", new[] { "steamIdUser: Target SteamID64." }, null)] + public ulong RequestUserStats(ulong steamIdUser) + { + return SteamNativeApi.UserStatsRequestUserStats(steamIdUser); + } + + [Documentation(nameof(RequestGlobalStats), "Requests global stats history and returns a Steam API call handle.", new[] { "historyDays: Number of days of history to request." }, null)] + public ulong RequestGlobalStats(int historyDays) + { + return SteamNativeApi.UserStatsRequestGlobalStats(historyDays); + } + + [Documentation(nameof(ResetAllStats), "Resets local user stats, optionally including achievements.", new[] { "achievementsToo: True to also clear achievement state." }, null)] + public bool ResetAllStats(bool achievementsToo) + { + return SteamNativeApi.UserStatsResetAllStats(achievementsToo); + } + + [Documentation(nameof(GetStatInt32), "Gets a named integer stat value.", new[] { "name: Stat API name.", "data: Output integer stat value." }, null)] + public bool GetStatInt32(string name, out int data) + { + return SteamNativeApi.UserStatsGetStatInt32(name, out data); + } + + [Documentation(nameof(SetStatInt32), "Sets a named integer stat value.", new[] { "name: Stat API name.", "data: Integer stat value to set." }, null)] + public bool SetStatInt32(string name, int data) + { + return SteamNativeApi.UserStatsSetStatInt32(name, data); + } + + [Documentation(nameof(StoreStats), "Stores pending stats and achievement changes to Steam.", null, null)] + public bool StoreStats() + { + return SteamNativeApi.StoreStats(); + } + } + + [Documentation(nameof(SteamUtilsManager), "Provides access checks for ISteamUtils.", null, null)] + public class SteamUtilsManager + { + public bool IsAvailable => SteamNativeApi.IsSteamUtilsAvailable(); + + [Documentation(nameof(GetAppId), "Gets the current Steam AppId reported by SteamUtils.", null, null)] + public uint GetAppId() + { + return SteamNativeApi.GetAppId(); + } + + [Documentation(nameof(GetIpCountry), "Gets the two-letter country code inferred by Steam based on the current IP.", null, null)] + public string GetIpCountry() + { + return SteamNativeApi.GetIpCountry(); + } + + [Documentation(nameof(IsOverlayEnabled), "Checks whether Steam Overlay is currently enabled.", null, null)] + public bool IsOverlayEnabled() + { + return SteamNativeApi.IsOverlayEnabled(); + } + } + + [Documentation(nameof(SteamVideoManager), "Provides access checks for ISteamVideo.", null, null)] + public class SteamVideoManager + { + public bool IsAvailable => SteamNativeApi.IsSteamVideoAvailable(); + + [Documentation(nameof(GetVideoUrl), "Requests a video URL for a given Steam video app id.", new[] { "videoAppId: Steam video app id." }, null)] + public void GetVideoUrl(uint videoAppId) + { + SteamNativeApi.VideoGetVideoUrl(videoAppId); + } + + [Documentation(nameof(IsBroadcasting), "Checks whether the user is broadcasting and returns current viewer count.", new[] { "numberOfViewers: Viewer count output when broadcasting." }, null)] + public bool IsBroadcasting(out int numberOfViewers) + { + return SteamNativeApi.VideoIsBroadcasting(out numberOfViewers); + } + } +} + diff --git a/OmegaLeo.HelperLib.Steamworks/SteamManager.cs b/OmegaLeo.HelperLib.Steamworks/SteamManager.cs new file mode 100644 index 0000000..541a04d --- /dev/null +++ b/OmegaLeo.HelperLib.Steamworks/SteamManager.cs @@ -0,0 +1,180 @@ +using System; +using Microsoft.Extensions.Logging; +using Microsoft.Extensions.Logging.Abstractions; +using OmegaLeo.HelperLib.Shared.Attributes; + +namespace OmegaLeo.HelperLib.Steamworks +{ + [Documentation(nameof(SteamManager), "Manages Steamworks initialization, callback polling, and shutdown for applications using the Steam API.", null, + @"```csharp +SteamManager.ConfigureLogger(logger); +SteamManager.ConfigureAppId(480); +var steam = SteamManager.Instance; +steam.Update(); +```")] + public class SteamManager + { + private static SteamManager _instance; + private static uint? _configuredAppId; + private static ILogger _logger = NullLogger.Instance; + private static readonly SteamUgcManager UgcManager = new SteamUgcManager(); + private static readonly SteamRemotePlayManager RemotePlayManager = new SteamRemotePlayManager(); + private static readonly SteamControllerManager ControllerManager = new SteamControllerManager(); + private static readonly SteamFriendsManager FriendsManager = new SteamFriendsManager(); + private static readonly SteamGameCoordinatorManager GameCoordinatorManager = new SteamGameCoordinatorManager(); + private static readonly SteamGameServerManager GameServerManager = new SteamGameServerManager(); + private static readonly SteamGameServerStatsManager GameServerStatsManager = new SteamGameServerStatsManager(); + private static readonly SteamHtmlSurfaceManager HtmlSurfaceManager = new SteamHtmlSurfaceManager(); + private static readonly SteamInputManager InputManager = new SteamInputManager(); + private static readonly SteamInventoryManager InventoryManager = new SteamInventoryManager(); + private static readonly SteamMatchmakingManager MatchmakingManager = new SteamMatchmakingManager(); + private static readonly SteamMatchmakingServersManager MatchmakingServersManager = new SteamMatchmakingServersManager(); + private static readonly SteamMusicManager MusicManager = new SteamMusicManager(); + private static readonly SteamPartiesManager PartiesManager = new SteamPartiesManager(); + private static readonly SteamRemoteStorageManager RemoteStorageManager = new SteamRemoteStorageManager(); + private static readonly SteamScreenshotsManager ScreenshotsManager = new SteamScreenshotsManager(); + private static readonly SteamUserStatsManager UserStatsManager = new SteamUserStatsManager(); + private static readonly SteamUtilsManager UtilsManager = new SteamUtilsManager(); + private static readonly SteamVideoManager VideoManager = new SteamVideoManager(); + [Documentation(nameof(Instance), "Singleton access to the Steam manager.", null, null)] + public static SteamManager Instance => _instance ??= new SteamManager(); + + internal static ILogger Logger => _logger; + + [Documentation(nameof(ConfigureLogger), "Configures the logger used by Steamworks helper classes.", new[] { "logger: ILogger instance to receive Steamworks logs." }, null)] + public static void ConfigureLogger(ILogger logger) + { + _logger = logger ?? NullLogger.Instance; + } + + [Documentation(nameof(ConfigureAppId), "Configures the Steam AppId used during initialization. Must be called before accessing the singleton instance.", new[] { "appId: Steam application identifier." }, null)] + public static bool ConfigureAppId(uint appId) + { + if (appId == 0) + { + return false; + } + + // AppId must be configured before the singleton is created. + if (_instance != null) + { + return false; + } + + _configuredAppId = appId; + SteamNativeApi.ConfigureAppId(appId); + return true; + } + + [Documentation(nameof(IsSteamworksInitialized), "Indicates whether Steamworks is initialized and ready for API calls.", null, null)] + public bool IsSteamworksInitialized { get; private set; } + + [Documentation(nameof(Ugc), "Provides access to Steam Workshop (UGC) helper operations.", null, null)] + public SteamUgcManager Ugc => UgcManager; + + [Documentation(nameof(RemotePlay), "Provides access to Steam Remote Play helper operations.", null, null)] + public SteamRemotePlayManager RemotePlay => RemotePlayManager; + + [Documentation(nameof(Controller), "Provides access to ISteamController bindings.", null, null)] + public SteamControllerManager Controller => ControllerManager; + + [Documentation(nameof(Friends), "Provides access to ISteamFriends bindings.", null, null)] + public SteamFriendsManager Friends => FriendsManager; + + [Documentation(nameof(GameCoordinator), "Provides access to ISteamGameCoordinator bindings.", null, null)] + public SteamGameCoordinatorManager GameCoordinator => GameCoordinatorManager; + + [Documentation(nameof(GameServer), "Provides access to ISteamGameServer bindings.", null, null)] + public SteamGameServerManager GameServer => GameServerManager; + + [Documentation(nameof(GameServerStats), "Provides access to ISteamGameServerStats bindings.", null, null)] + public SteamGameServerStatsManager GameServerStats => GameServerStatsManager; + + [Documentation(nameof(HtmlSurface), "Provides access to ISteamHTMLSurface bindings.", null, null)] + public SteamHtmlSurfaceManager HtmlSurface => HtmlSurfaceManager; + + [Documentation(nameof(Input), "Provides access to ISteamInput bindings.", null, null)] + public SteamInputManager Input => InputManager; + + [Documentation(nameof(Inventory), "Provides access to ISteamInventory bindings.", null, null)] + public SteamInventoryManager Inventory => InventoryManager; + + [Documentation(nameof(Matchmaking), "Provides access to ISteamMatchmaking bindings.", null, null)] + public SteamMatchmakingManager Matchmaking => MatchmakingManager; + + [Documentation(nameof(MatchmakingServers), "Provides access to ISteamMatchmakingServers bindings.", null, null)] + public SteamMatchmakingServersManager MatchmakingServers => MatchmakingServersManager; + + [Documentation(nameof(Music), "Provides access to ISteamMusic bindings.", null, null)] + public SteamMusicManager Music => MusicManager; + + [Documentation(nameof(Parties), "Provides access to ISteamParties bindings.", null, null)] + public SteamPartiesManager Parties => PartiesManager; + + [Documentation(nameof(RemoteStorage), "Provides access to ISteamRemoteStorage bindings.", null, null)] + public SteamRemoteStorageManager RemoteStorage => RemoteStorageManager; + + [Documentation(nameof(Screenshots), "Provides access to ISteamScreenshots bindings.", null, null)] + public SteamScreenshotsManager Screenshots => ScreenshotsManager; + + [Documentation(nameof(UserStats), "Provides access to ISteamUserStats bindings.", null, null)] + public SteamUserStatsManager UserStats => UserStatsManager; + + [Documentation(nameof(Utils), "Provides access to ISteamUtils bindings.", null, null)] + public SteamUtilsManager Utils => UtilsManager; + + [Documentation(nameof(Video), "Provides access to ISteamVideo bindings.", null, null)] + public SteamVideoManager Video => VideoManager; + + private SteamManager() + { + try + { + // Attempt to initialize Steamworks + if (SteamNativeApi.Initialize(_configuredAppId)) + { + IsSteamworksInitialized = true; + _logger.LogInformation("Steamworks initialized successfully."); + } + else + { + _logger.LogWarning("Steamworks initialization failed. Ensure Steam is running and AppId context is valid."); + } + } + catch (Exception e) + { + _logger.LogError(e, "An exception occurred during Steamworks initialization."); + } + } + + // This must be called from your game's main loop (e.g., Update in Unity/Godot) + [Documentation(nameof(Update), "Executes Steamworks callbacks. Call every frame from your game loop.", null, null)] + public void Update() + { + if (IsSteamworksInitialized) + { + SteamNativeApi.RunCallbacks(); + } + } + + [Documentation(nameof(Shutdown), "Shuts down Steamworks and clears the initialized state.", null, null)] + public void Shutdown() + { + if (IsSteamworksInitialized) + { + SteamNativeApi.Shutdown(); + IsSteamworksInitialized = false; + } + } + + [Documentation(nameof(GetSteamName), "Gets the current Steam persona name. Returns \"Player\" when Steamworks is unavailable.", null, null)] + public string GetSteamName() + { + if (IsSteamworksInitialized) + { + return SteamNativeApi.GetPersonaName(); + } + return "Player"; + } + } +} diff --git a/OmegaLeo.HelperLib.Steamworks/SteamNativeApi.cs b/OmegaLeo.HelperLib.Steamworks/SteamNativeApi.cs new file mode 100644 index 0000000..f36535c --- /dev/null +++ b/OmegaLeo.HelperLib.Steamworks/SteamNativeApi.cs @@ -0,0 +1,1863 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Runtime.InteropServices; + +namespace OmegaLeo.HelperLib.Steamworks +{ + internal static class SteamNativeApi + { + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + [return: MarshalAs(UnmanagedType.I1)] + private delegate bool SteamApiInitDelegate(); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate void SteamApiVoidDelegate(); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate IntPtr SteamFriendsAccessorDelegate(); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate IntPtr SteamUserStatsAccessorDelegate(); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate IntPtr SteamUgcAccessorDelegate(); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate IntPtr SteamRemotePlayAccessorDelegate(); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate IntPtr SteamInterfaceAccessorDelegate(); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate IntPtr SteamFriendsGetPersonaNameDelegate(IntPtr steamFriends); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + [return: MarshalAs(UnmanagedType.I1)] + private delegate bool SteamUserStatsSetAchievementDelegate(IntPtr steamUserStats, [MarshalAs(UnmanagedType.LPStr)] string achievementId); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + [return: MarshalAs(UnmanagedType.I1)] + private delegate bool SteamUserStatsStoreStatsDelegate(IntPtr steamUserStats); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + [return: MarshalAs(UnmanagedType.I1)] + private delegate bool SteamUserStatsGetAchievementDelegate(IntPtr steamUserStats, [MarshalAs(UnmanagedType.LPStr)] string achievementId, [MarshalAs(UnmanagedType.I1)] out bool achieved); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate ulong SteamUgcCreateQueryAllRequestDelegate(IntPtr steamUgc, uint queryType, uint matchingType, uint creatorAppId, uint consumerAppId, uint page); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate ulong SteamUgcSendQueryRequestDelegate(IntPtr steamUgc, ulong queryHandle); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + [return: MarshalAs(UnmanagedType.I1)] + private delegate bool SteamUgcReleaseQueryRequestDelegate(IntPtr steamUgc, ulong queryHandle); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate uint SteamUgcGetNumSubscribedItemsDelegate(IntPtr steamUgc); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate uint SteamUgcGetSubscribedItemsDelegate(IntPtr steamUgc, [Out] ulong[] items, uint maxEntries); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate ulong SteamUgcSubscribeItemDelegate(IntPtr steamUgc, ulong publishedFileId); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate ulong SteamUgcUnsubscribeItemDelegate(IntPtr steamUgc, ulong publishedFileId); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate ulong SteamUgcCreateItemDelegate(IntPtr steamUgc, uint consumerAppId, uint fileType); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate ulong SteamUgcStartItemUpdateDelegate(IntPtr steamUgc, uint consumerAppId, ulong publishedFileId); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + [return: MarshalAs(UnmanagedType.I1)] + private delegate bool SteamUgcSetItemTitleDelegate(IntPtr steamUgc, ulong updateHandle, [MarshalAs(UnmanagedType.LPStr)] string title); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + [return: MarshalAs(UnmanagedType.I1)] + private delegate bool SteamUgcSetItemDescriptionDelegate(IntPtr steamUgc, ulong updateHandle, [MarshalAs(UnmanagedType.LPStr)] string description); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + [return: MarshalAs(UnmanagedType.I1)] + private delegate bool SteamUgcSetItemMetadataDelegate(IntPtr steamUgc, ulong updateHandle, [MarshalAs(UnmanagedType.LPStr)] string metadata); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + [return: MarshalAs(UnmanagedType.I1)] + private delegate bool SteamUgcSetItemVisibilityDelegate(IntPtr steamUgc, ulong updateHandle, uint visibility); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + [return: MarshalAs(UnmanagedType.I1)] + private delegate bool SteamUgcSetItemTagsDelegate(IntPtr steamUgc, ulong updateHandle, IntPtr tags); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + [return: MarshalAs(UnmanagedType.I1)] + private delegate bool SteamUgcSetItemContentDelegate(IntPtr steamUgc, ulong updateHandle, [MarshalAs(UnmanagedType.LPStr)] string contentFolder); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + [return: MarshalAs(UnmanagedType.I1)] + private delegate bool SteamUgcSetItemPreviewDelegate(IntPtr steamUgc, ulong updateHandle, [MarshalAs(UnmanagedType.LPStr)] string previewFile); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate ulong SteamUgcSubmitItemUpdateDelegate(IntPtr steamUgc, ulong updateHandle, [MarshalAs(UnmanagedType.LPStr)] string changeNote); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate uint SteamUgcGetItemUpdateProgressDelegate(IntPtr steamUgc, ulong updateHandle, out ulong bytesProcessed, out ulong bytesTotal); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate uint SteamRemotePlayGetSessionCountDelegate(IntPtr steamRemotePlay); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate uint SteamRemotePlayGetSessionIdDelegate(IntPtr steamRemotePlay, int sessionIndex); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate ulong SteamRemotePlayGetSessionSteamIdDelegate(IntPtr steamRemotePlay, uint sessionId); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate IntPtr SteamRemotePlayGetSessionClientNameDelegate(IntPtr steamRemotePlay, uint sessionId); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate int SteamRemotePlayGetSessionClientFormFactorDelegate(IntPtr steamRemotePlay, uint sessionId); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + [return: MarshalAs(UnmanagedType.I1)] + private delegate bool SteamRemotePlayGetSessionClientResolutionDelegate(IntPtr steamRemotePlay, uint sessionId, out int resolutionX, out int resolutionY); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate int SteamFriendsGetFriendCountDelegate(IntPtr steamFriends, int friendFlags); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate IntPtr SteamFriendsGetFriendPersonaNameDelegate(IntPtr steamFriends, ulong steamIdFriend); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate void SteamFriendsActivateGameOverlayInviteDialogDelegate(IntPtr steamFriends, ulong steamIdLobby); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + [return: MarshalAs(UnmanagedType.I1)] + private delegate bool SteamFriendsSetRichPresenceDelegate(IntPtr steamFriends, [MarshalAs(UnmanagedType.LPStr)] string key, [MarshalAs(UnmanagedType.LPStr)] string value); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate void SteamFriendsClearRichPresenceDelegate(IntPtr steamFriends); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate IntPtr SteamFriendsGetFriendRichPresenceDelegate(IntPtr steamFriends, ulong steamIdFriend, [MarshalAs(UnmanagedType.LPStr)] string key); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + [return: MarshalAs(UnmanagedType.I1)] + private delegate bool SteamFriendsInviteUserToGameDelegate(IntPtr steamFriends, ulong steamIdFriend, [MarshalAs(UnmanagedType.LPStr)] string connectString); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate uint SteamUtilsGetAppIdDelegate(IntPtr steamUtils); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate IntPtr SteamUtilsGetIpCountryDelegate(IntPtr steamUtils); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + [return: MarshalAs(UnmanagedType.I1)] + private delegate bool SteamUtilsIsOverlayEnabledDelegate(IntPtr steamUtils); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + [return: MarshalAs(UnmanagedType.I1)] + private delegate bool SteamRemoteStorageFileExistsDelegate(IntPtr steamRemoteStorage, [MarshalAs(UnmanagedType.LPStr)] string fileName); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate int SteamRemoteStorageGetFileCountDelegate(IntPtr steamRemoteStorage); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + [return: MarshalAs(UnmanagedType.I1)] + private delegate bool SteamRemoteStorageIsCloudEnabledForAppDelegate(IntPtr steamRemoteStorage); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + [return: MarshalAs(UnmanagedType.I1)] + private delegate bool SteamRemoteStorageFileWriteDelegate(IntPtr steamRemoteStorage, [MarshalAs(UnmanagedType.LPStr)] string fileName, byte[] data, int dataSize); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate int SteamRemoteStorageFileReadDelegate(IntPtr steamRemoteStorage, [MarshalAs(UnmanagedType.LPStr)] string fileName, [Out] byte[] dataBuffer, int dataToRead); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + [return: MarshalAs(UnmanagedType.I1)] + private delegate bool SteamRemoteStorageFileDeleteDelegate(IntPtr steamRemoteStorage, [MarshalAs(UnmanagedType.LPStr)] string fileName); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate int SteamRemoteStorageGetFileSizeDelegate(IntPtr steamRemoteStorage, [MarshalAs(UnmanagedType.LPStr)] string fileName); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + [return: MarshalAs(UnmanagedType.I1)] + private delegate bool SteamInputInitDelegate(IntPtr steamInput, [MarshalAs(UnmanagedType.I1)] bool explicitlyCallRunFrame); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + [return: MarshalAs(UnmanagedType.I1)] + private delegate bool SteamInputShutdownDelegate(IntPtr steamInput); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate void SteamInputRunFrameDelegate(IntPtr steamInput, [MarshalAs(UnmanagedType.I1)] bool reservedValue); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + [return: MarshalAs(UnmanagedType.I1)] + private delegate bool SteamInventoryLoadItemDefinitionsDelegate(IntPtr steamInventory); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + [return: MarshalAs(UnmanagedType.I1)] + private delegate bool SteamInventoryGetAllItemsDelegate(IntPtr steamInventory, out int inventoryResultHandle); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate void SteamInventoryDestroyResultDelegate(IntPtr steamInventory, int inventoryResultHandle); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate ulong SteamMatchmakingRequestLobbyListDelegate(IntPtr steamMatchmaking); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate void SteamMatchmakingAddRequestLobbyListResultCountFilterDelegate(IntPtr steamMatchmaking, int maxResults); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate ulong SteamMatchmakingCreateLobbyDelegate(IntPtr steamMatchmaking, int lobbyType, int maxMembers); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate ulong SteamMatchmakingJoinLobbyDelegate(IntPtr steamMatchmaking, ulong steamIdLobby); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate void SteamMatchmakingLeaveLobbyDelegate(IntPtr steamMatchmaking, ulong steamIdLobby); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate int SteamMatchmakingGetNumLobbyMembersDelegate(IntPtr steamMatchmaking, ulong steamIdLobby); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate uint SteamScreenshotsAddScreenshotToLibraryDelegate(IntPtr steamScreenshots, [MarshalAs(UnmanagedType.LPStr)] string fileNameJpg, [MarshalAs(UnmanagedType.LPStr)] string fileNameThumbnail, int width, int height); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate void SteamScreenshotsTriggerScreenshotDelegate(IntPtr steamScreenshots); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate void SteamScreenshotsHookScreenshotsDelegate(IntPtr steamScreenshots, [MarshalAs(UnmanagedType.I1)] bool hook); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + [return: MarshalAs(UnmanagedType.I1)] + private delegate bool SteamScreenshotsIsScreenshotsHookedDelegate(IntPtr steamScreenshots); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + [return: MarshalAs(UnmanagedType.I1)] + private delegate bool SteamMusicIsEnabledDelegate(IntPtr steamMusic); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + [return: MarshalAs(UnmanagedType.I1)] + private delegate bool SteamMusicIsPlayingDelegate(IntPtr steamMusic); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate void SteamMusicPlayDelegate(IntPtr steamMusic); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate void SteamMusicPauseDelegate(IntPtr steamMusic); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate void SteamMusicPlayNextDelegate(IntPtr steamMusic); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate void SteamMusicPlayPreviousDelegate(IntPtr steamMusic); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate float SteamMusicGetVolumeDelegate(IntPtr steamMusic); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate void SteamMusicSetVolumeDelegate(IntPtr steamMusic, float volume); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate void SteamVideoGetVideoUrlDelegate(IntPtr steamVideo, uint videoAppId); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + [return: MarshalAs(UnmanagedType.I1)] + private delegate bool SteamVideoIsBroadcastingDelegate(IntPtr steamVideo, out int numberOfViewers); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate ulong SteamUserStatsRequestUserStatsDelegate(IntPtr steamUserStats, ulong steamIdUser); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + private delegate ulong SteamUserStatsRequestGlobalStatsDelegate(IntPtr steamUserStats, int historyDays); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + [return: MarshalAs(UnmanagedType.I1)] + private delegate bool SteamUserStatsResetAllStatsDelegate(IntPtr steamUserStats, [MarshalAs(UnmanagedType.I1)] bool achievementsToo); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + [return: MarshalAs(UnmanagedType.I1)] + private delegate bool SteamUserStatsGetStatInt32Delegate(IntPtr steamUserStats, [MarshalAs(UnmanagedType.LPStr)] string name, out int data); + + [UnmanagedFunctionPointer(CallingConvention.Cdecl)] + [return: MarshalAs(UnmanagedType.I1)] + private delegate bool SteamUserStatsSetStatInt32Delegate(IntPtr steamUserStats, [MarshalAs(UnmanagedType.LPStr)] string name, int data); + + private static readonly object SyncRoot = new object(); + + private static IntPtr _libraryHandle; + private static bool _libraryLoaded; + private static bool _initialized; + + private static SteamApiInitDelegate _steamApiInit; + private static SteamApiVoidDelegate _steamApiShutdown; + private static SteamApiVoidDelegate _steamApiRunCallbacks; + private static SteamFriendsAccessorDelegate _steamFriendsAccessor; + private static SteamUserStatsAccessorDelegate _steamUserStatsAccessor; + private static SteamUgcAccessorDelegate _steamUgcAccessor; + private static SteamRemotePlayAccessorDelegate _steamRemotePlayAccessor; + private static SteamFriendsGetPersonaNameDelegate _steamFriendsGetPersonaName; + private static SteamUserStatsSetAchievementDelegate _steamUserStatsSetAchievement; + private static SteamUserStatsStoreStatsDelegate _steamUserStatsStoreStats; + private static SteamUserStatsGetAchievementDelegate _steamUserStatsGetAchievement; + private static SteamUgcCreateQueryAllRequestDelegate _steamUgcCreateQueryAllRequest; + private static SteamUgcSendQueryRequestDelegate _steamUgcSendQueryRequest; + private static SteamUgcReleaseQueryRequestDelegate _steamUgcReleaseQueryRequest; + private static SteamUgcGetNumSubscribedItemsDelegate _steamUgcGetNumSubscribedItems; + private static SteamUgcGetSubscribedItemsDelegate _steamUgcGetSubscribedItems; + private static SteamUgcSubscribeItemDelegate _steamUgcSubscribeItem; + private static SteamUgcUnsubscribeItemDelegate _steamUgcUnsubscribeItem; + private static SteamUgcCreateItemDelegate _steamUgcCreateItem; + private static SteamUgcStartItemUpdateDelegate _steamUgcStartItemUpdate; + private static SteamUgcSetItemTitleDelegate _steamUgcSetItemTitle; + private static SteamUgcSetItemDescriptionDelegate _steamUgcSetItemDescription; + private static SteamUgcSetItemMetadataDelegate _steamUgcSetItemMetadata; + private static SteamUgcSetItemVisibilityDelegate _steamUgcSetItemVisibility; + private static SteamUgcSetItemTagsDelegate _steamUgcSetItemTags; + private static SteamUgcSetItemContentDelegate _steamUgcSetItemContent; + private static SteamUgcSetItemPreviewDelegate _steamUgcSetItemPreview; + private static SteamUgcSubmitItemUpdateDelegate _steamUgcSubmitItemUpdate; + private static SteamUgcGetItemUpdateProgressDelegate _steamUgcGetItemUpdateProgress; + private static SteamRemotePlayGetSessionCountDelegate _steamRemotePlayGetSessionCount; + private static SteamRemotePlayGetSessionIdDelegate _steamRemotePlayGetSessionId; + private static SteamRemotePlayGetSessionSteamIdDelegate _steamRemotePlayGetSessionSteamId; + private static SteamRemotePlayGetSessionClientNameDelegate _steamRemotePlayGetSessionClientName; + private static SteamRemotePlayGetSessionClientFormFactorDelegate _steamRemotePlayGetSessionClientFormFactor; + private static SteamRemotePlayGetSessionClientResolutionDelegate _steamRemotePlayGetSessionClientResolution; + private static SteamFriendsGetFriendCountDelegate _steamFriendsGetFriendCount; + private static SteamFriendsGetFriendPersonaNameDelegate _steamFriendsGetFriendPersonaName; + private static SteamFriendsActivateGameOverlayInviteDialogDelegate _steamFriendsActivateGameOverlayInviteDialog; + private static SteamFriendsSetRichPresenceDelegate _steamFriendsSetRichPresence; + private static SteamFriendsClearRichPresenceDelegate _steamFriendsClearRichPresence; + private static SteamFriendsGetFriendRichPresenceDelegate _steamFriendsGetFriendRichPresence; + private static SteamFriendsInviteUserToGameDelegate _steamFriendsInviteUserToGame; + private static SteamUtilsGetAppIdDelegate _steamUtilsGetAppId; + private static SteamUtilsGetIpCountryDelegate _steamUtilsGetIpCountry; + private static SteamUtilsIsOverlayEnabledDelegate _steamUtilsIsOverlayEnabled; + private static SteamRemoteStorageFileExistsDelegate _steamRemoteStorageFileExists; + private static SteamRemoteStorageGetFileCountDelegate _steamRemoteStorageGetFileCount; + private static SteamRemoteStorageIsCloudEnabledForAppDelegate _steamRemoteStorageIsCloudEnabledForApp; + private static SteamRemoteStorageFileWriteDelegate _steamRemoteStorageFileWrite; + private static SteamRemoteStorageFileReadDelegate _steamRemoteStorageFileRead; + private static SteamRemoteStorageFileDeleteDelegate _steamRemoteStorageFileDelete; + private static SteamRemoteStorageGetFileSizeDelegate _steamRemoteStorageGetFileSize; + private static SteamInputInitDelegate _steamInputInit; + private static SteamInputShutdownDelegate _steamInputShutdown; + private static SteamInputRunFrameDelegate _steamInputRunFrame; + private static SteamInventoryLoadItemDefinitionsDelegate _steamInventoryLoadItemDefinitions; + private static SteamInventoryGetAllItemsDelegate _steamInventoryGetAllItems; + private static SteamInventoryDestroyResultDelegate _steamInventoryDestroyResult; + private static SteamMatchmakingRequestLobbyListDelegate _steamMatchmakingRequestLobbyList; + private static SteamMatchmakingAddRequestLobbyListResultCountFilterDelegate _steamMatchmakingAddRequestLobbyListResultCountFilter; + private static SteamMatchmakingCreateLobbyDelegate _steamMatchmakingCreateLobby; + private static SteamMatchmakingJoinLobbyDelegate _steamMatchmakingJoinLobby; + private static SteamMatchmakingLeaveLobbyDelegate _steamMatchmakingLeaveLobby; + private static SteamMatchmakingGetNumLobbyMembersDelegate _steamMatchmakingGetNumLobbyMembers; + private static SteamScreenshotsAddScreenshotToLibraryDelegate _steamScreenshotsAddScreenshotToLibrary; + private static SteamScreenshotsTriggerScreenshotDelegate _steamScreenshotsTriggerScreenshot; + private static SteamScreenshotsHookScreenshotsDelegate _steamScreenshotsHookScreenshots; + private static SteamScreenshotsIsScreenshotsHookedDelegate _steamScreenshotsIsScreenshotsHooked; + private static SteamMusicIsEnabledDelegate _steamMusicIsEnabled; + private static SteamMusicIsPlayingDelegate _steamMusicIsPlaying; + private static SteamMusicPlayDelegate _steamMusicPlay; + private static SteamMusicPauseDelegate _steamMusicPause; + private static SteamMusicPlayNextDelegate _steamMusicPlayNext; + private static SteamMusicPlayPreviousDelegate _steamMusicPlayPrevious; + private static SteamMusicGetVolumeDelegate _steamMusicGetVolume; + private static SteamMusicSetVolumeDelegate _steamMusicSetVolume; + private static SteamVideoGetVideoUrlDelegate _steamVideoGetVideoUrl; + private static SteamVideoIsBroadcastingDelegate _steamVideoIsBroadcasting; + private static SteamUserStatsRequestUserStatsDelegate _steamUserStatsRequestUserStats; + private static SteamUserStatsRequestGlobalStatsDelegate _steamUserStatsRequestGlobalStats; + private static SteamUserStatsResetAllStatsDelegate _steamUserStatsResetAllStats; + private static SteamUserStatsGetStatInt32Delegate _steamUserStatsGetStatInt32; + private static SteamUserStatsSetStatInt32Delegate _steamUserStatsSetStatInt32; + + private static IntPtr _steamFriends; + private static IntPtr _steamUserStats; + private static IntPtr _steamUgc; + private static IntPtr _steamRemotePlay; + + private static readonly Dictionary AdditionalInterfaceAccessors = new Dictionary(); + private static readonly Dictionary AdditionalInterfacePointers = new Dictionary(); + + private const string InterfaceSteamController = "SteamController"; + private const string InterfaceSteamGameCoordinator = "SteamGameCoordinator"; + private const string InterfaceSteamGameServer = "SteamGameServer"; + private const string InterfaceSteamGameServerStats = "SteamGameServerStats"; + private const string InterfaceSteamHtmlSurface = "SteamHTMLSurface"; + private const string InterfaceSteamInput = "SteamInput"; + private const string InterfaceSteamInventory = "SteamInventory"; + private const string InterfaceSteamMatchmaking = "SteamMatchmaking"; + private const string InterfaceSteamMatchmakingServers = "SteamMatchmakingServers"; + private const string InterfaceSteamMusic = "SteamMusic"; + private const string InterfaceSteamParties = "SteamParties"; + private const string InterfaceSteamRemoteStorage = "SteamRemoteStorage"; + private const string InterfaceSteamScreenshots = "SteamScreenshots"; + private const string InterfaceSteamUtils = "SteamUtils"; + private const string InterfaceSteamVideo = "SteamVideo"; + + public static bool IsAvailable => EnsureLoaded(); + + public static bool Initialize(uint? appId = null) + { + lock (SyncRoot) + { + if (appId.HasValue && appId.Value > 0) + { + ConfigureAppId(appId.Value); + } + + if (_initialized) + { + return true; + } + + if (!EnsureLoaded()) + { + return false; + } + + if (_steamApiInit == null) + { + return false; + } + + _initialized = _steamApiInit(); + if (_initialized) + { + CacheInterfaces(); + } + + return _initialized; + } + } + + public static void ConfigureAppId(uint appId) + { + if (appId == 0) + { + return; + } + + lock (SyncRoot) + { + ApplyAppIdEnvironment(appId); + TryWriteSteamAppIdFile(appId); + } + } + + public static void Shutdown() + { + lock (SyncRoot) + { + if (!_initialized) + { + return; + } + + _steamApiShutdown?.Invoke(); + _initialized = false; + _steamFriends = IntPtr.Zero; + _steamUserStats = IntPtr.Zero; + _steamUgc = IntPtr.Zero; + _steamRemotePlay = IntPtr.Zero; + AdditionalInterfacePointers.Clear(); + } + } + + public static void RunCallbacks() + { + if (!_initialized) + { + return; + } + + _steamApiRunCallbacks?.Invoke(); + } + + public static string GetPersonaName() + { + if (!EnsureReady()) + { + return string.Empty; + } + + var namePtr = _steamFriendsGetPersonaName?.Invoke(_steamFriends) ?? IntPtr.Zero; + return namePtr == IntPtr.Zero ? string.Empty : Marshal.PtrToStringAnsi(namePtr) ?? string.Empty; + } + + public static bool SetAchievement(string achievementId) + { + if (!EnsureReady()) + { + return false; + } + + return _steamUserStatsSetAchievement?.Invoke(_steamUserStats, achievementId) ?? false; + } + + public static bool StoreStats() + { + if (!EnsureReady()) + { + return false; + } + + return _steamUserStatsStoreStats?.Invoke(_steamUserStats) ?? false; + } + + public static bool GetAchievement(string achievementId, out bool achieved) + { + achieved = false; + + if (!EnsureReady()) + { + return false; + } + + return _steamUserStatsGetAchievement?.Invoke(_steamUserStats, achievementId, out achieved) ?? false; + } + + public static ulong CreateQueryAllUgcRequest(uint queryType, uint matchingType, uint creatorAppId, uint consumerAppId, uint page) + { + if (!EnsureUgcReady()) + { + return 0; + } + + return _steamUgcCreateQueryAllRequest?.Invoke(_steamUgc, queryType, matchingType, creatorAppId, consumerAppId, page) ?? 0; + } + + public static ulong SendQueryUgcRequest(ulong queryHandle) + { + if (!EnsureUgcReady()) + { + return 0; + } + + return _steamUgcSendQueryRequest?.Invoke(_steamUgc, queryHandle) ?? 0; + } + + public static bool ReleaseQueryUgcRequest(ulong queryHandle) + { + if (!EnsureUgcReady()) + { + return false; + } + + return _steamUgcReleaseQueryRequest?.Invoke(_steamUgc, queryHandle) ?? false; + } + + public static uint GetNumSubscribedItems() + { + if (!EnsureUgcReady()) + { + return 0; + } + + return _steamUgcGetNumSubscribedItems?.Invoke(_steamUgc) ?? 0; + } + + public static ulong[] GetSubscribedItems(uint maxEntries) + { + if (!EnsureUgcReady() || maxEntries == 0) + { + return Array.Empty(); + } + + var buffer = new ulong[maxEntries]; + var count = _steamUgcGetSubscribedItems?.Invoke(_steamUgc, buffer, maxEntries) ?? 0; + if (count == 0) + { + return Array.Empty(); + } + + if (count == buffer.Length) + { + return buffer; + } + + var result = new ulong[count]; + Array.Copy(buffer, result, count); + return result; + } + + public static ulong SubscribeItem(ulong publishedFileId) + { + if (!EnsureUgcReady()) + { + return 0; + } + + return _steamUgcSubscribeItem?.Invoke(_steamUgc, publishedFileId) ?? 0; + } + + public static ulong UnsubscribeItem(ulong publishedFileId) + { + if (!EnsureUgcReady()) + { + return 0; + } + + return _steamUgcUnsubscribeItem?.Invoke(_steamUgc, publishedFileId) ?? 0; + } + + public static ulong CreateItem(uint consumerAppId, uint fileType) + { + if (!EnsureUgcReady()) + { + return 0; + } + + return _steamUgcCreateItem?.Invoke(_steamUgc, consumerAppId, fileType) ?? 0; + } + + public static ulong StartItemUpdate(uint consumerAppId, ulong publishedFileId) + { + if (!EnsureUgcReady()) + { + return 0; + } + + return _steamUgcStartItemUpdate?.Invoke(_steamUgc, consumerAppId, publishedFileId) ?? 0; + } + + public static bool SetItemTitle(ulong updateHandle, string title) + { + if (!EnsureUgcReady()) + { + return false; + } + + return _steamUgcSetItemTitle?.Invoke(_steamUgc, updateHandle, title) ?? false; + } + + public static bool SetItemDescription(ulong updateHandle, string description) + { + if (!EnsureUgcReady()) + { + return false; + } + + return _steamUgcSetItemDescription?.Invoke(_steamUgc, updateHandle, description) ?? false; + } + + public static bool SetItemMetadata(ulong updateHandle, string metadata) + { + if (!EnsureUgcReady()) + { + return false; + } + + return _steamUgcSetItemMetadata?.Invoke(_steamUgc, updateHandle, metadata) ?? false; + } + + public static bool SetItemVisibility(ulong updateHandle, uint visibility) + { + if (!EnsureUgcReady()) + { + return false; + } + + return _steamUgcSetItemVisibility?.Invoke(_steamUgc, updateHandle, visibility) ?? false; + } + + public static bool SetItemTags(ulong updateHandle, string[] tags) + { + if (!EnsureUgcReady() || tags == null) + { + return false; + } + + return WithSteamStringArray(tags, nativePtr => _steamUgcSetItemTags?.Invoke(_steamUgc, updateHandle, nativePtr) ?? false); + } + + public static bool SetItemContent(ulong updateHandle, string contentFolder) + { + if (!EnsureUgcReady()) + { + return false; + } + + return _steamUgcSetItemContent?.Invoke(_steamUgc, updateHandle, contentFolder) ?? false; + } + + public static bool SetItemPreview(ulong updateHandle, string previewFile) + { + if (!EnsureUgcReady()) + { + return false; + } + + return _steamUgcSetItemPreview?.Invoke(_steamUgc, updateHandle, previewFile) ?? false; + } + + public static ulong SubmitItemUpdate(ulong updateHandle, string changeNote) + { + if (!EnsureUgcReady()) + { + return 0; + } + + return _steamUgcSubmitItemUpdate?.Invoke(_steamUgc, updateHandle, changeNote ?? string.Empty) ?? 0; + } + + public static uint GetItemUpdateProgress(ulong updateHandle, out ulong bytesProcessed, out ulong bytesTotal) + { + bytesProcessed = 0; + bytesTotal = 0; + + if (!EnsureUgcReady()) + { + return 0; + } + + return _steamUgcGetItemUpdateProgress?.Invoke(_steamUgc, updateHandle, out bytesProcessed, out bytesTotal) ?? 0; + } + + public static uint GetRemotePlaySessionCount() + { + if (!EnsureRemotePlayReady()) + { + return 0; + } + + return _steamRemotePlayGetSessionCount?.Invoke(_steamRemotePlay) ?? 0; + } + + public static uint GetRemotePlaySessionId(int sessionIndex) + { + if (!EnsureRemotePlayReady()) + { + return 0; + } + + return _steamRemotePlayGetSessionId?.Invoke(_steamRemotePlay, sessionIndex) ?? 0; + } + + public static ulong GetRemotePlaySessionSteamId(uint sessionId) + { + if (!EnsureRemotePlayReady()) + { + return 0; + } + + return _steamRemotePlayGetSessionSteamId?.Invoke(_steamRemotePlay, sessionId) ?? 0; + } + + public static string GetRemotePlaySessionClientName(uint sessionId) + { + if (!EnsureRemotePlayReady()) + { + return string.Empty; + } + + var namePtr = _steamRemotePlayGetSessionClientName?.Invoke(_steamRemotePlay, sessionId) ?? IntPtr.Zero; + return namePtr == IntPtr.Zero ? string.Empty : Marshal.PtrToStringAnsi(namePtr) ?? string.Empty; + } + + public static int GetRemotePlaySessionClientFormFactor(uint sessionId) + { + if (!EnsureRemotePlayReady()) + { + return 0; + } + + return _steamRemotePlayGetSessionClientFormFactor?.Invoke(_steamRemotePlay, sessionId) ?? 0; + } + + public static bool TryGetRemotePlaySessionClientResolution(uint sessionId, out int resolutionX, out int resolutionY) + { + resolutionX = 0; + resolutionY = 0; + + if (!EnsureRemotePlayReady()) + { + return false; + } + + return _steamRemotePlayGetSessionClientResolution?.Invoke(_steamRemotePlay, sessionId, out resolutionX, out resolutionY) ?? false; + } + + public static bool IsSteamControllerAvailable() => EnsureAdditionalInterfaceReady(InterfaceSteamController); + + public static bool IsSteamFriendsAvailable() => EnsureFriendsReady(); + + public static bool IsSteamGameCoordinatorAvailable() => EnsureAdditionalInterfaceReady(InterfaceSteamGameCoordinator); + + public static bool IsSteamGameServerAvailable() => EnsureAdditionalInterfaceReady(InterfaceSteamGameServer); + + public static bool IsSteamGameServerStatsAvailable() => EnsureAdditionalInterfaceReady(InterfaceSteamGameServerStats); + + public static bool IsSteamHtmlSurfaceAvailable() => EnsureAdditionalInterfaceReady(InterfaceSteamHtmlSurface); + + public static bool IsSteamInputAvailable() => EnsureAdditionalInterfaceReady(InterfaceSteamInput); + + public static bool IsSteamInventoryAvailable() => EnsureAdditionalInterfaceReady(InterfaceSteamInventory); + + public static bool IsSteamMatchmakingAvailable() => EnsureAdditionalInterfaceReady(InterfaceSteamMatchmaking); + + public static bool IsSteamMatchmakingServersAvailable() => EnsureAdditionalInterfaceReady(InterfaceSteamMatchmakingServers); + + public static bool IsSteamMusicAvailable() => EnsureAdditionalInterfaceReady(InterfaceSteamMusic); + + public static bool IsSteamPartiesAvailable() => EnsureAdditionalInterfaceReady(InterfaceSteamParties); + + public static bool IsSteamRemoteStorageAvailable() => EnsureAdditionalInterfaceReady(InterfaceSteamRemoteStorage); + + public static bool IsSteamScreenshotsAvailable() => EnsureAdditionalInterfaceReady(InterfaceSteamScreenshots); + + public static bool IsSteamUserStatsAvailable() => EnsureUserStatsReady(); + + public static bool IsSteamUgcAvailable() => EnsureUgcReady(); + + public static bool IsSteamRemotePlayAvailable() => EnsureRemotePlayReady(); + + public static bool IsSteamUtilsAvailable() => EnsureAdditionalInterfaceReady(InterfaceSteamUtils); + + public static bool IsSteamVideoAvailable() => EnsureAdditionalInterfaceReady(InterfaceSteamVideo); + + public static int GetFriendCount(int friendFlags) + { + if (!EnsureFriendsReady()) + { + return 0; + } + + return _steamFriendsGetFriendCount?.Invoke(_steamFriends, friendFlags) ?? 0; + } + + public static string GetFriendPersonaName(ulong steamIdFriend) + { + if (!EnsureFriendsReady()) + { + return string.Empty; + } + + var namePtr = _steamFriendsGetFriendPersonaName?.Invoke(_steamFriends, steamIdFriend) ?? IntPtr.Zero; + return namePtr == IntPtr.Zero ? string.Empty : Marshal.PtrToStringAnsi(namePtr) ?? string.Empty; + } + + public static void FriendsActivateGameOverlayInviteDialog(ulong steamIdLobby) + { + if (!EnsureFriendsReady()) + { + return; + } + + _steamFriendsActivateGameOverlayInviteDialog?.Invoke(_steamFriends, steamIdLobby); + } + + public static bool FriendsSetRichPresence(string key, string value) + { + if (!EnsureFriendsReady()) + { + return false; + } + + return _steamFriendsSetRichPresence?.Invoke(_steamFriends, key, value) ?? false; + } + + public static void FriendsClearRichPresence() + { + if (!EnsureFriendsReady()) + { + return; + } + + _steamFriendsClearRichPresence?.Invoke(_steamFriends); + } + + public static string FriendsGetFriendRichPresence(ulong steamIdFriend, string key) + { + if (!EnsureFriendsReady()) + { + return string.Empty; + } + + var valuePtr = _steamFriendsGetFriendRichPresence?.Invoke(_steamFriends, steamIdFriend, key) ?? IntPtr.Zero; + return valuePtr == IntPtr.Zero ? string.Empty : Marshal.PtrToStringAnsi(valuePtr) ?? string.Empty; + } + + public static bool FriendsInviteUserToGame(ulong steamIdFriend, string connectString) + { + if (!EnsureFriendsReady()) + { + return false; + } + + return _steamFriendsInviteUserToGame?.Invoke(_steamFriends, steamIdFriend, connectString) ?? false; + } + + public static uint GetAppId() + { + if (!EnsureAdditionalInterfaceReady(InterfaceSteamUtils)) + { + return 0; + } + + var steamUtils = GetAdditionalInterfacePointer(InterfaceSteamUtils); + return _steamUtilsGetAppId?.Invoke(steamUtils) ?? 0; + } + + public static string GetIpCountry() + { + if (!EnsureAdditionalInterfaceReady(InterfaceSteamUtils)) + { + return string.Empty; + } + + var steamUtils = GetAdditionalInterfacePointer(InterfaceSteamUtils); + var countryPtr = _steamUtilsGetIpCountry?.Invoke(steamUtils) ?? IntPtr.Zero; + return countryPtr == IntPtr.Zero ? string.Empty : Marshal.PtrToStringAnsi(countryPtr) ?? string.Empty; + } + + public static bool IsOverlayEnabled() + { + if (!EnsureAdditionalInterfaceReady(InterfaceSteamUtils)) + { + return false; + } + + var steamUtils = GetAdditionalInterfacePointer(InterfaceSteamUtils); + return _steamUtilsIsOverlayEnabled?.Invoke(steamUtils) ?? false; + } + + public static bool RemoteStorageFileExists(string fileName) + { + if (!EnsureAdditionalInterfaceReady(InterfaceSteamRemoteStorage)) + { + return false; + } + + var steamRemoteStorage = GetAdditionalInterfacePointer(InterfaceSteamRemoteStorage); + return _steamRemoteStorageFileExists?.Invoke(steamRemoteStorage, fileName) ?? false; + } + + public static int RemoteStorageGetFileCount() + { + if (!EnsureAdditionalInterfaceReady(InterfaceSteamRemoteStorage)) + { + return 0; + } + + var steamRemoteStorage = GetAdditionalInterfacePointer(InterfaceSteamRemoteStorage); + return _steamRemoteStorageGetFileCount?.Invoke(steamRemoteStorage) ?? 0; + } + + public static bool RemoteStorageIsCloudEnabledForApp() + { + if (!EnsureAdditionalInterfaceReady(InterfaceSteamRemoteStorage)) + { + return false; + } + + var steamRemoteStorage = GetAdditionalInterfacePointer(InterfaceSteamRemoteStorage); + return _steamRemoteStorageIsCloudEnabledForApp?.Invoke(steamRemoteStorage) ?? false; + } + + public static bool RemoteStorageFileWrite(string fileName, byte[] data) + { + if (!EnsureAdditionalInterfaceReady(InterfaceSteamRemoteStorage) || data == null) + { + return false; + } + + var steamRemoteStorage = GetAdditionalInterfacePointer(InterfaceSteamRemoteStorage); + return _steamRemoteStorageFileWrite?.Invoke(steamRemoteStorage, fileName, data, data.Length) ?? false; + } + + public static bool RemoteStorageFileRead(string fileName, out byte[] data) + { + data = Array.Empty(); + + if (!EnsureAdditionalInterfaceReady(InterfaceSteamRemoteStorage)) + { + return false; + } + + var steamRemoteStorage = GetAdditionalInterfacePointer(InterfaceSteamRemoteStorage); + var size = _steamRemoteStorageGetFileSize?.Invoke(steamRemoteStorage, fileName) ?? -1; + if (size <= 0) + { + return false; + } + + var buffer = new byte[size]; + var bytesRead = _steamRemoteStorageFileRead?.Invoke(steamRemoteStorage, fileName, buffer, size) ?? 0; + if (bytesRead <= 0) + { + return false; + } + + if (bytesRead != size) + { + var resized = new byte[bytesRead]; + Array.Copy(buffer, resized, bytesRead); + data = resized; + return true; + } + + data = buffer; + return true; + } + + public static bool RemoteStorageFileDelete(string fileName) + { + if (!EnsureAdditionalInterfaceReady(InterfaceSteamRemoteStorage)) + { + return false; + } + + var steamRemoteStorage = GetAdditionalInterfacePointer(InterfaceSteamRemoteStorage); + return _steamRemoteStorageFileDelete?.Invoke(steamRemoteStorage, fileName) ?? false; + } + + public static int RemoteStorageGetFileSize(string fileName) + { + if (!EnsureAdditionalInterfaceReady(InterfaceSteamRemoteStorage)) + { + return 0; + } + + var steamRemoteStorage = GetAdditionalInterfacePointer(InterfaceSteamRemoteStorage); + return _steamRemoteStorageGetFileSize?.Invoke(steamRemoteStorage, fileName) ?? 0; + } + + public static bool InputInit(bool explicitlyCallRunFrame) + { + if (!EnsureAdditionalInterfaceReady(InterfaceSteamInput)) + { + return false; + } + + var steamInput = GetAdditionalInterfacePointer(InterfaceSteamInput); + return _steamInputInit?.Invoke(steamInput, explicitlyCallRunFrame) ?? false; + } + + public static bool InputShutdown() + { + if (!EnsureAdditionalInterfaceReady(InterfaceSteamInput)) + { + return false; + } + + var steamInput = GetAdditionalInterfacePointer(InterfaceSteamInput); + return _steamInputShutdown?.Invoke(steamInput) ?? false; + } + + public static void InputRunFrame() + { + if (!EnsureAdditionalInterfaceReady(InterfaceSteamInput)) + { + return; + } + + var steamInput = GetAdditionalInterfacePointer(InterfaceSteamInput); + _steamInputRunFrame?.Invoke(steamInput, false); + } + + public static bool InventoryLoadItemDefinitions() + { + if (!EnsureAdditionalInterfaceReady(InterfaceSteamInventory)) + { + return false; + } + + var steamInventory = GetAdditionalInterfacePointer(InterfaceSteamInventory); + return _steamInventoryLoadItemDefinitions?.Invoke(steamInventory) ?? false; + } + + public static bool InventoryGetAllItems(out int inventoryResultHandle) + { + inventoryResultHandle = 0; + + if (!EnsureAdditionalInterfaceReady(InterfaceSteamInventory)) + { + return false; + } + + var steamInventory = GetAdditionalInterfacePointer(InterfaceSteamInventory); + return _steamInventoryGetAllItems?.Invoke(steamInventory, out inventoryResultHandle) ?? false; + } + + public static void InventoryDestroyResult(int inventoryResultHandle) + { + if (!EnsureAdditionalInterfaceReady(InterfaceSteamInventory)) + { + return; + } + + var steamInventory = GetAdditionalInterfacePointer(InterfaceSteamInventory); + _steamInventoryDestroyResult?.Invoke(steamInventory, inventoryResultHandle); + } + + public static ulong MatchmakingRequestLobbyList() + { + if (!EnsureAdditionalInterfaceReady(InterfaceSteamMatchmaking)) + { + return 0; + } + + var steamMatchmaking = GetAdditionalInterfacePointer(InterfaceSteamMatchmaking); + return _steamMatchmakingRequestLobbyList?.Invoke(steamMatchmaking) ?? 0; + } + + public static void MatchmakingAddRequestLobbyListResultCountFilter(int maxResults) + { + if (!EnsureAdditionalInterfaceReady(InterfaceSteamMatchmaking)) + { + return; + } + + var steamMatchmaking = GetAdditionalInterfacePointer(InterfaceSteamMatchmaking); + _steamMatchmakingAddRequestLobbyListResultCountFilter?.Invoke(steamMatchmaking, maxResults); + } + + public static ulong MatchmakingCreateLobby(int lobbyType, int maxMembers) + { + if (!EnsureAdditionalInterfaceReady(InterfaceSteamMatchmaking)) + { + return 0; + } + + var steamMatchmaking = GetAdditionalInterfacePointer(InterfaceSteamMatchmaking); + return _steamMatchmakingCreateLobby?.Invoke(steamMatchmaking, lobbyType, maxMembers) ?? 0; + } + + public static ulong MatchmakingJoinLobby(ulong steamIdLobby) + { + if (!EnsureAdditionalInterfaceReady(InterfaceSteamMatchmaking)) + { + return 0; + } + + var steamMatchmaking = GetAdditionalInterfacePointer(InterfaceSteamMatchmaking); + return _steamMatchmakingJoinLobby?.Invoke(steamMatchmaking, steamIdLobby) ?? 0; + } + + public static void MatchmakingLeaveLobby(ulong steamIdLobby) + { + if (!EnsureAdditionalInterfaceReady(InterfaceSteamMatchmaking)) + { + return; + } + + var steamMatchmaking = GetAdditionalInterfacePointer(InterfaceSteamMatchmaking); + _steamMatchmakingLeaveLobby?.Invoke(steamMatchmaking, steamIdLobby); + } + + public static int MatchmakingGetNumLobbyMembers(ulong steamIdLobby) + { + if (!EnsureAdditionalInterfaceReady(InterfaceSteamMatchmaking)) + { + return 0; + } + + var steamMatchmaking = GetAdditionalInterfacePointer(InterfaceSteamMatchmaking); + return _steamMatchmakingGetNumLobbyMembers?.Invoke(steamMatchmaking, steamIdLobby) ?? 0; + } + + public static uint ScreenshotsAddScreenshotToLibrary(string fileNameJpg, string fileNameThumbnail, int width, int height) + { + if (!EnsureAdditionalInterfaceReady(InterfaceSteamScreenshots)) + { + return 0; + } + + var steamScreenshots = GetAdditionalInterfacePointer(InterfaceSteamScreenshots); + return _steamScreenshotsAddScreenshotToLibrary?.Invoke(steamScreenshots, fileNameJpg, fileNameThumbnail, width, height) ?? 0; + } + + public static void ScreenshotsTriggerScreenshot() + { + if (!EnsureAdditionalInterfaceReady(InterfaceSteamScreenshots)) + { + return; + } + + var steamScreenshots = GetAdditionalInterfacePointer(InterfaceSteamScreenshots); + _steamScreenshotsTriggerScreenshot?.Invoke(steamScreenshots); + } + + public static void ScreenshotsHookScreenshots(bool hook) + { + if (!EnsureAdditionalInterfaceReady(InterfaceSteamScreenshots)) + { + return; + } + + var steamScreenshots = GetAdditionalInterfacePointer(InterfaceSteamScreenshots); + _steamScreenshotsHookScreenshots?.Invoke(steamScreenshots, hook); + } + + public static bool ScreenshotsIsScreenshotsHooked() + { + if (!EnsureAdditionalInterfaceReady(InterfaceSteamScreenshots)) + { + return false; + } + + var steamScreenshots = GetAdditionalInterfacePointer(InterfaceSteamScreenshots); + return _steamScreenshotsIsScreenshotsHooked?.Invoke(steamScreenshots) ?? false; + } + + public static bool MusicIsEnabled() + { + if (!EnsureAdditionalInterfaceReady(InterfaceSteamMusic)) + { + return false; + } + + var steamMusic = GetAdditionalInterfacePointer(InterfaceSteamMusic); + return _steamMusicIsEnabled?.Invoke(steamMusic) ?? false; + } + + public static bool MusicIsPlaying() + { + if (!EnsureAdditionalInterfaceReady(InterfaceSteamMusic)) + { + return false; + } + + var steamMusic = GetAdditionalInterfacePointer(InterfaceSteamMusic); + return _steamMusicIsPlaying?.Invoke(steamMusic) ?? false; + } + + public static void MusicPlay() + { + if (!EnsureAdditionalInterfaceReady(InterfaceSteamMusic)) + { + return; + } + + var steamMusic = GetAdditionalInterfacePointer(InterfaceSteamMusic); + _steamMusicPlay?.Invoke(steamMusic); + } + + public static void MusicPause() + { + if (!EnsureAdditionalInterfaceReady(InterfaceSteamMusic)) + { + return; + } + + var steamMusic = GetAdditionalInterfacePointer(InterfaceSteamMusic); + _steamMusicPause?.Invoke(steamMusic); + } + + public static void MusicPlayNext() + { + if (!EnsureAdditionalInterfaceReady(InterfaceSteamMusic)) + { + return; + } + + var steamMusic = GetAdditionalInterfacePointer(InterfaceSteamMusic); + _steamMusicPlayNext?.Invoke(steamMusic); + } + + public static void MusicPlayPrevious() + { + if (!EnsureAdditionalInterfaceReady(InterfaceSteamMusic)) + { + return; + } + + var steamMusic = GetAdditionalInterfacePointer(InterfaceSteamMusic); + _steamMusicPlayPrevious?.Invoke(steamMusic); + } + + public static float MusicGetVolume() + { + if (!EnsureAdditionalInterfaceReady(InterfaceSteamMusic)) + { + return 0f; + } + + var steamMusic = GetAdditionalInterfacePointer(InterfaceSteamMusic); + return _steamMusicGetVolume?.Invoke(steamMusic) ?? 0f; + } + + public static void MusicSetVolume(float volume) + { + if (!EnsureAdditionalInterfaceReady(InterfaceSteamMusic)) + { + return; + } + + var steamMusic = GetAdditionalInterfacePointer(InterfaceSteamMusic); + _steamMusicSetVolume?.Invoke(steamMusic, volume); + } + + public static void VideoGetVideoUrl(uint videoAppId) + { + if (!EnsureAdditionalInterfaceReady(InterfaceSteamVideo)) + { + return; + } + + var steamVideo = GetAdditionalInterfacePointer(InterfaceSteamVideo); + _steamVideoGetVideoUrl?.Invoke(steamVideo, videoAppId); + } + + public static bool VideoIsBroadcasting(out int numberOfViewers) + { + numberOfViewers = 0; + + if (!EnsureAdditionalInterfaceReady(InterfaceSteamVideo)) + { + return false; + } + + var steamVideo = GetAdditionalInterfacePointer(InterfaceSteamVideo); + return _steamVideoIsBroadcasting?.Invoke(steamVideo, out numberOfViewers) ?? false; + } + + public static ulong UserStatsRequestUserStats(ulong steamIdUser) + { + if (!EnsureUserStatsReady()) + { + return 0; + } + + return _steamUserStatsRequestUserStats?.Invoke(_steamUserStats, steamIdUser) ?? 0; + } + + public static ulong UserStatsRequestGlobalStats(int historyDays) + { + if (!EnsureUserStatsReady()) + { + return 0; + } + + return _steamUserStatsRequestGlobalStats?.Invoke(_steamUserStats, historyDays) ?? 0; + } + + public static bool UserStatsResetAllStats(bool achievementsToo) + { + if (!EnsureUserStatsReady()) + { + return false; + } + + return _steamUserStatsResetAllStats?.Invoke(_steamUserStats, achievementsToo) ?? false; + } + + public static bool UserStatsGetStatInt32(string name, out int data) + { + data = 0; + + if (!EnsureUserStatsReady()) + { + return false; + } + + return _steamUserStatsGetStatInt32?.Invoke(_steamUserStats, name, out data) ?? false; + } + + public static bool UserStatsSetStatInt32(string name, int data) + { + if (!EnsureUserStatsReady()) + { + return false; + } + + return _steamUserStatsSetStatInt32?.Invoke(_steamUserStats, name, data) ?? false; + } + + private static bool EnsureReady() + { + if (!EnsureLoaded()) + { + return false; + } + + if (!_initialized) + { + return false; + } + + if (_steamFriends == IntPtr.Zero || _steamUserStats == IntPtr.Zero) + { + CacheInterfaces(); + } + + return _steamFriends != IntPtr.Zero && _steamUserStats != IntPtr.Zero; + } + + private static bool EnsureFriendsReady() + { + if (!EnsureLoaded() || !_initialized) + { + return false; + } + + if (_steamFriends == IntPtr.Zero) + { + CacheInterfaces(); + } + + return _steamFriends != IntPtr.Zero; + } + + private static bool EnsureUserStatsReady() + { + if (!EnsureLoaded() || !_initialized) + { + return false; + } + + if (_steamUserStats == IntPtr.Zero) + { + CacheInterfaces(); + } + + return _steamUserStats != IntPtr.Zero; + } + + private static bool EnsureUgcReady() + { + if (!EnsureLoaded()) + { + return false; + } + + if (!_initialized) + { + return false; + } + + if (_steamUgc == IntPtr.Zero) + { + CacheInterfaces(); + } + + return _steamUgc != IntPtr.Zero; + } + + private static bool EnsureRemotePlayReady() + { + if (!EnsureLoaded()) + { + return false; + } + + if (!_initialized) + { + return false; + } + + if (_steamRemotePlay == IntPtr.Zero) + { + CacheInterfaces(); + } + + return _steamRemotePlay != IntPtr.Zero; + } + + private static bool EnsureAdditionalInterfaceReady(string key) + { + if (!EnsureLoaded() || !_initialized) + { + return false; + } + + if (!AdditionalInterfacePointers.TryGetValue(key, out var pointer) || pointer == IntPtr.Zero) + { + CacheAdditionalInterface(key); + AdditionalInterfacePointers.TryGetValue(key, out pointer); + } + + return pointer != IntPtr.Zero; + } + + private static bool EnsureLoaded() + { + lock (SyncRoot) + { + if (_libraryLoaded) + { + return true; + } + + foreach (var candidate in GetLibraryCandidates()) + { + try + { + _libraryHandle = LoadUnmanagedLibrary(candidate); + _libraryLoaded = _libraryHandle != IntPtr.Zero; + if (_libraryLoaded) + { + BindDelegates(); + return true; + } + } + catch + { + // Try the next candidate. + } + } + + return false; + } + } + + private static void BindDelegates() + { + _steamApiInit = + Bind("SteamAPI_Init") + ?? Bind("SteamAPI_InitSafe"); + _steamApiShutdown = Bind("SteamAPI_Shutdown"); + _steamApiRunCallbacks = Bind("SteamAPI_RunCallbacks"); + _steamFriendsAccessor = BindInterfaceAccessor("SteamFriends", "ISteamFriends"); + _steamUserStatsAccessor = BindInterfaceAccessor("SteamUserStats", "ISteamUserStats"); + _steamUgcAccessor = BindInterfaceAccessor("SteamUGC", "ISteamUGC"); + _steamRemotePlayAccessor = BindInterfaceAccessor("SteamRemotePlay", "ISteamRemotePlay"); + _steamFriendsGetPersonaName = Bind("SteamAPI_ISteamFriends_GetPersonaName"); + _steamUserStatsSetAchievement = Bind("SteamAPI_ISteamUserStats_SetAchievement"); + _steamUserStatsStoreStats = Bind("SteamAPI_ISteamUserStats_StoreStats"); + _steamUserStatsGetAchievement = Bind("SteamAPI_ISteamUserStats_GetAchievement"); + _steamUgcCreateQueryAllRequest = Bind("SteamAPI_ISteamUGC_CreateQueryAllUGCRequest"); + _steamUgcSendQueryRequest = Bind("SteamAPI_ISteamUGC_SendQueryUGCRequest"); + _steamUgcReleaseQueryRequest = Bind("SteamAPI_ISteamUGC_ReleaseQueryUGCRequest"); + _steamUgcGetNumSubscribedItems = Bind("SteamAPI_ISteamUGC_GetNumSubscribedItems"); + _steamUgcGetSubscribedItems = Bind("SteamAPI_ISteamUGC_GetSubscribedItems"); + _steamUgcSubscribeItem = Bind("SteamAPI_ISteamUGC_SubscribeItem"); + _steamUgcUnsubscribeItem = Bind("SteamAPI_ISteamUGC_UnsubscribeItem"); + _steamUgcCreateItem = Bind("SteamAPI_ISteamUGC_CreateItem"); + _steamUgcStartItemUpdate = Bind("SteamAPI_ISteamUGC_StartItemUpdate"); + _steamUgcSetItemTitle = Bind("SteamAPI_ISteamUGC_SetItemTitle"); + _steamUgcSetItemDescription = Bind("SteamAPI_ISteamUGC_SetItemDescription"); + _steamUgcSetItemMetadata = Bind("SteamAPI_ISteamUGC_SetItemMetadata"); + _steamUgcSetItemVisibility = Bind("SteamAPI_ISteamUGC_SetItemVisibility"); + _steamUgcSetItemTags = Bind("SteamAPI_ISteamUGC_SetItemTags"); + _steamUgcSetItemContent = Bind("SteamAPI_ISteamUGC_SetItemContent"); + _steamUgcSetItemPreview = Bind("SteamAPI_ISteamUGC_SetItemPreview"); + _steamUgcSubmitItemUpdate = Bind("SteamAPI_ISteamUGC_SubmitItemUpdate"); + _steamUgcGetItemUpdateProgress = Bind("SteamAPI_ISteamUGC_GetItemUpdateProgress"); + _steamRemotePlayGetSessionCount = Bind("SteamAPI_ISteamRemotePlay_GetSessionCount"); + _steamRemotePlayGetSessionId = Bind("SteamAPI_ISteamRemotePlay_GetSessionID"); + _steamRemotePlayGetSessionSteamId = Bind("SteamAPI_ISteamRemotePlay_GetSessionSteamID"); + _steamRemotePlayGetSessionClientName = Bind("SteamAPI_ISteamRemotePlay_GetSessionClientName"); + _steamRemotePlayGetSessionClientFormFactor = Bind("SteamAPI_ISteamRemotePlay_GetSessionClientFormFactor"); + _steamRemotePlayGetSessionClientResolution = Bind("SteamAPI_ISteamRemotePlay_BGetSessionClientResolution"); + _steamFriendsGetFriendCount = Bind("SteamAPI_ISteamFriends_GetFriendCount"); + _steamFriendsGetFriendPersonaName = Bind("SteamAPI_ISteamFriends_GetFriendPersonaName"); + _steamFriendsActivateGameOverlayInviteDialog = Bind("SteamAPI_ISteamFriends_ActivateGameOverlayInviteDialog"); + _steamFriendsSetRichPresence = Bind("SteamAPI_ISteamFriends_SetRichPresence"); + _steamFriendsClearRichPresence = Bind("SteamAPI_ISteamFriends_ClearRichPresence"); + _steamFriendsGetFriendRichPresence = Bind("SteamAPI_ISteamFriends_GetFriendRichPresence"); + _steamFriendsInviteUserToGame = Bind("SteamAPI_ISteamFriends_InviteUserToGame"); + _steamUtilsGetAppId = Bind("SteamAPI_ISteamUtils_GetAppID"); + _steamUtilsGetIpCountry = Bind("SteamAPI_ISteamUtils_GetIPCountry"); + _steamUtilsIsOverlayEnabled = Bind("SteamAPI_ISteamUtils_IsOverlayEnabled"); + _steamRemoteStorageFileExists = Bind("SteamAPI_ISteamRemoteStorage_FileExists"); + _steamRemoteStorageGetFileCount = Bind("SteamAPI_ISteamRemoteStorage_GetFileCount"); + _steamRemoteStorageIsCloudEnabledForApp = Bind("SteamAPI_ISteamRemoteStorage_IsCloudEnabledForApp"); + _steamRemoteStorageFileWrite = Bind("SteamAPI_ISteamRemoteStorage_FileWrite"); + _steamRemoteStorageFileRead = Bind("SteamAPI_ISteamRemoteStorage_FileRead"); + _steamRemoteStorageFileDelete = Bind("SteamAPI_ISteamRemoteStorage_FileDelete"); + _steamRemoteStorageGetFileSize = Bind("SteamAPI_ISteamRemoteStorage_GetFileSize"); + _steamInputInit = Bind("SteamAPI_ISteamInput_Init"); + _steamInputShutdown = Bind("SteamAPI_ISteamInput_Shutdown"); + _steamInputRunFrame = Bind("SteamAPI_ISteamInput_RunFrame"); + _steamInventoryLoadItemDefinitions = Bind("SteamAPI_ISteamInventory_LoadItemDefinitions"); + _steamInventoryGetAllItems = Bind("SteamAPI_ISteamInventory_GetAllItems"); + _steamInventoryDestroyResult = Bind("SteamAPI_ISteamInventory_DestroyResult"); + _steamMatchmakingRequestLobbyList = Bind("SteamAPI_ISteamMatchmaking_RequestLobbyList"); + _steamMatchmakingAddRequestLobbyListResultCountFilter = Bind("SteamAPI_ISteamMatchmaking_AddRequestLobbyListResultCountFilter"); + _steamMatchmakingCreateLobby = Bind("SteamAPI_ISteamMatchmaking_CreateLobby"); + _steamMatchmakingJoinLobby = Bind("SteamAPI_ISteamMatchmaking_JoinLobby"); + _steamMatchmakingLeaveLobby = Bind("SteamAPI_ISteamMatchmaking_LeaveLobby"); + _steamMatchmakingGetNumLobbyMembers = Bind("SteamAPI_ISteamMatchmaking_GetNumLobbyMembers"); + _steamScreenshotsAddScreenshotToLibrary = Bind("SteamAPI_ISteamScreenshots_AddScreenshotToLibrary"); + _steamScreenshotsTriggerScreenshot = Bind("SteamAPI_ISteamScreenshots_TriggerScreenshot"); + _steamScreenshotsHookScreenshots = Bind("SteamAPI_ISteamScreenshots_HookScreenshots"); + _steamScreenshotsIsScreenshotsHooked = Bind("SteamAPI_ISteamScreenshots_IsScreenshotsHooked"); + _steamMusicIsEnabled = Bind("SteamAPI_ISteamMusic_BIsEnabled"); + _steamMusicIsPlaying = Bind("SteamAPI_ISteamMusic_BIsPlaying"); + _steamMusicPlay = Bind("SteamAPI_ISteamMusic_Play"); + _steamMusicPause = Bind("SteamAPI_ISteamMusic_Pause"); + _steamMusicPlayNext = Bind("SteamAPI_ISteamMusic_PlayNext"); + _steamMusicPlayPrevious = Bind("SteamAPI_ISteamMusic_PlayPrevious"); + _steamMusicGetVolume = Bind("SteamAPI_ISteamMusic_GetVolume"); + _steamMusicSetVolume = Bind("SteamAPI_ISteamMusic_SetVolume"); + _steamVideoGetVideoUrl = Bind("SteamAPI_ISteamVideo_GetVideoURL"); + _steamVideoIsBroadcasting = Bind("SteamAPI_ISteamVideo_IsBroadcasting"); + _steamUserStatsRequestUserStats = Bind("SteamAPI_ISteamUserStats_RequestUserStats"); + _steamUserStatsRequestGlobalStats = Bind("SteamAPI_ISteamUserStats_RequestGlobalStats"); + _steamUserStatsResetAllStats = Bind("SteamAPI_ISteamUserStats_ResetAllStats"); + _steamUserStatsGetStatInt32 = Bind("SteamAPI_ISteamUserStats_GetStatInt32"); + _steamUserStatsSetStatInt32 = Bind("SteamAPI_ISteamUserStats_SetStatInt32"); + + // Additional interface accessors requested for broad API coverage. + BindAdditionalInterfaceAccessor(InterfaceSteamController, "SteamController", "ISteamController"); + BindAdditionalInterfaceAccessor(InterfaceSteamGameCoordinator, "SteamGameCoordinator", "ISteamGameCoordinator"); + BindAdditionalInterfaceAccessor(InterfaceSteamGameServer, "SteamGameServer", "ISteamGameServer"); + BindAdditionalInterfaceAccessor(InterfaceSteamGameServerStats, "SteamGameServerStats", "ISteamGameServerStats"); + BindAdditionalInterfaceAccessor(InterfaceSteamHtmlSurface, "SteamHTMLSurface", "ISteamHTMLSurface"); + BindAdditionalInterfaceAccessor(InterfaceSteamInput, "SteamInput", "ISteamInput"); + BindAdditionalInterfaceAccessor(InterfaceSteamInventory, "SteamInventory", "ISteamInventory"); + BindAdditionalInterfaceAccessor(InterfaceSteamMatchmaking, "SteamMatchmaking", "ISteamMatchmaking"); + BindAdditionalInterfaceAccessor(InterfaceSteamMatchmakingServers, "SteamMatchmakingServers", "ISteamMatchmakingServers"); + BindAdditionalInterfaceAccessor(InterfaceSteamMusic, "SteamMusic", "ISteamMusic"); + BindAdditionalInterfaceAccessor(InterfaceSteamParties, "SteamParties", "ISteamParties"); + BindAdditionalInterfaceAccessor(InterfaceSteamRemoteStorage, "SteamRemoteStorage", "ISteamRemoteStorage"); + BindAdditionalInterfaceAccessor(InterfaceSteamScreenshots, "SteamScreenshots", "ISteamScreenshots"); + BindAdditionalInterfaceAccessor(InterfaceSteamUtils, "SteamUtils", "ISteamUtils"); + BindAdditionalInterfaceAccessor(InterfaceSteamVideo, "SteamVideo", "ISteamVideo"); + } + + private static T Bind(string exportName) where T : class + { + return TryGetExport(_libraryHandle, exportName, out var export) + ? Marshal.GetDelegateForFunctionPointer(export, typeof(T)) as T + : null; + } + + private static T BindInterfaceAccessor(string friendlyName, string interfaceName) where T : class + { + for (var version = 1; version <= 64; version++) + { + var exportName = $"SteamAPI_{friendlyName}_v{version:000}"; + if (TryGetExport(_libraryHandle, exportName, out var export) || + TryGetExport(_libraryHandle, $"SteamAPI_{interfaceName}_v{version:000}", out export)) + { + return Marshal.GetDelegateForFunctionPointer(export, typeof(T)) as T; + } + } + + return null; + } + + private static void CacheInterfaces() + { + _steamFriends = _steamFriendsAccessor?.Invoke() ?? IntPtr.Zero; + _steamUserStats = _steamUserStatsAccessor?.Invoke() ?? IntPtr.Zero; + _steamUgc = _steamUgcAccessor?.Invoke() ?? IntPtr.Zero; + _steamRemotePlay = _steamRemotePlayAccessor?.Invoke() ?? IntPtr.Zero; + + CacheAdditionalInterfaces(); + } + + private static void BindAdditionalInterfaceAccessor(string key, string friendlyName, string interfaceName) + { + AdditionalInterfaceAccessors[key] = BindInterfaceAccessor(friendlyName, interfaceName); + } + + private static void CacheAdditionalInterfaces() + { + foreach (var key in AdditionalInterfaceAccessors.Keys) + { + CacheAdditionalInterface(key); + } + } + + private static void CacheAdditionalInterface(string key) + { + if (!AdditionalInterfaceAccessors.TryGetValue(key, out var accessor)) + { + AdditionalInterfacePointers[key] = IntPtr.Zero; + return; + } + + AdditionalInterfacePointers[key] = accessor?.Invoke() ?? IntPtr.Zero; + } + + private static IntPtr GetAdditionalInterfacePointer(string key) + { + return AdditionalInterfacePointers.TryGetValue(key, out var pointer) ? pointer : IntPtr.Zero; + } + + [StructLayout(LayoutKind.Sequential)] + private struct SteamParamStringArrayNative + { + public IntPtr Strings; + public int NumStrings; + } + + private static bool WithSteamStringArray(string[] values, Func action) + { + var stringPointers = new IntPtr[values.Length]; + IntPtr arrayPtr = IntPtr.Zero; + IntPtr structPtr = IntPtr.Zero; + + try + { + for (var i = 0; i < values.Length; i++) + { + stringPointers[i] = Marshal.StringToHGlobalAnsi(values[i] ?? string.Empty); + } + + arrayPtr = Marshal.AllocHGlobal(IntPtr.Size * values.Length); + Marshal.Copy(stringPointers, 0, arrayPtr, values.Length); + + var native = new SteamParamStringArrayNative + { + Strings = arrayPtr, + NumStrings = values.Length + }; + + structPtr = Marshal.AllocHGlobal(Marshal.SizeOf()); + Marshal.StructureToPtr(native, structPtr, false); + + return action(structPtr); + } + finally + { + if (structPtr != IntPtr.Zero) + { + Marshal.FreeHGlobal(structPtr); + } + + if (arrayPtr != IntPtr.Zero) + { + Marshal.FreeHGlobal(arrayPtr); + } + + for (var i = 0; i < stringPointers.Length; i++) + { + if (stringPointers[i] != IntPtr.Zero) + { + Marshal.FreeHGlobal(stringPointers[i]); + } + } + } + } + + private static string[] GetLibraryCandidates() + { + var libraryName = GetLibraryFileName(); + var runtimeIdentifier = GetRuntimeIdentifier(); + + return new[] + { + Path.Combine(AppContext.BaseDirectory, "runtimes", runtimeIdentifier, "native", libraryName), + Path.Combine(AppContext.BaseDirectory, libraryName), + libraryName + }; + } + + private static string GetRuntimeIdentifier() + { + if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows)) + { + return Environment.Is64BitProcess ? "win-x64" : "win-x86"; + } + + if (RuntimeInformation.IsOSPlatform(OSPlatform.OSX)) + { + return Environment.Is64BitProcess ? "osx-x64" : "osx-x86"; + } + + return Environment.Is64BitProcess ? "linux-x64" : "linux-x86"; + } + + private static string GetLibraryFileName() + { + if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows)) + { + return Environment.Is64BitProcess ? "steam_api64.dll" : "steam_api.dll"; + } + + if (RuntimeInformation.IsOSPlatform(OSPlatform.OSX)) + { + return "libsteam_api.dylib"; + } + + return "libsteam_api.so"; + } + + private static void ApplyAppIdEnvironment(uint appId) + { + var appIdValue = appId.ToString(); + Environment.SetEnvironmentVariable("SteamAppId", appIdValue); + Environment.SetEnvironmentVariable("SteamGameId", appIdValue); + } + + private static void TryWriteSteamAppIdFile(uint appId) + { + var appIdValue = appId.ToString(); + var candidatePaths = new[] + { + Path.Combine(AppContext.BaseDirectory, "steam_appid.txt"), + Path.Combine(Directory.GetCurrentDirectory(), "steam_appid.txt") + }; + + foreach (var path in candidatePaths) + { + try + { + File.WriteAllText(path, appIdValue); + } + catch + { + // Ignore write failures and continue with other candidates. + } + } + } + + private static IntPtr LoadUnmanagedLibrary(string path) + { + if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows)) + { + return LoadLibraryWindows(path); + } + + if (RuntimeInformation.IsOSPlatform(OSPlatform.OSX)) + { + return DlopenMac(path, RtldNow); + } + + return DlopenLinux(path, RtldNow); + } + + private static bool TryGetExport(IntPtr libraryHandle, string exportName, out IntPtr export) + { + if (libraryHandle == IntPtr.Zero) + { + export = IntPtr.Zero; + return false; + } + + if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows)) + { + export = GetProcAddressWindows(libraryHandle, exportName); + return export != IntPtr.Zero; + } + + export = RuntimeInformation.IsOSPlatform(OSPlatform.OSX) + ? DlsymMac(libraryHandle, exportName) + : DlsymLinux(libraryHandle, exportName); + return export != IntPtr.Zero; + } + + [DllImport("kernel32.dll", CharSet = CharSet.Unicode, SetLastError = true, EntryPoint = "LoadLibraryW")] + private static extern IntPtr LoadLibraryWindows(string lpFileName); + + [DllImport("kernel32.dll", CharSet = CharSet.Ansi, SetLastError = true, EntryPoint = "GetProcAddress")] + private static extern IntPtr GetProcAddressWindows(IntPtr hModule, string procName); + + [DllImport("libdl.so.2", EntryPoint = "dlopen")] + private static extern IntPtr DlopenLinux(string fileName, int flags); + + [DllImport("libdl.so.2", EntryPoint = "dlsym")] + private static extern IntPtr DlsymLinux(IntPtr handle, string symbol); + + [DllImport("libSystem.B.dylib", EntryPoint = "dlopen")] + private static extern IntPtr DlopenMac(string fileName, int flags); + + [DllImport("libSystem.B.dylib", EntryPoint = "dlsym")] + private static extern IntPtr DlsymMac(IntPtr handle, string symbol); + + private const int RtldNow = 2; + + } +} + diff --git a/OmegaLeo.HelperLib.Steamworks/SteamRemotePlayManager.cs b/OmegaLeo.HelperLib.Steamworks/SteamRemotePlayManager.cs new file mode 100644 index 0000000..1f2841a --- /dev/null +++ b/OmegaLeo.HelperLib.Steamworks/SteamRemotePlayManager.cs @@ -0,0 +1,49 @@ +using OmegaLeo.HelperLib.Shared.Attributes; + +namespace OmegaLeo.HelperLib.Steamworks +{ + [Documentation(nameof(SteamRemotePlayManager), "Provides helper methods for Steam Remote Play session inspection.", null, + @"```csharp +var remotePlay = SteamManager.Instance.RemotePlay; +var sessionCount = remotePlay.GetSessionCount(); +```")] + public class SteamRemotePlayManager + { + [Documentation(nameof(GetSessionCount), "Gets the number of active Remote Play sessions for the current user.", null, null)] + public uint GetSessionCount() + { + return SteamNativeApi.GetRemotePlaySessionCount(); + } + + [Documentation(nameof(GetSessionId), "Gets a Remote Play session ID by zero-based session index.", new[] { "sessionIndex: Zero-based index into the active sessions list." }, null)] + public uint GetSessionId(int sessionIndex) + { + return SteamNativeApi.GetRemotePlaySessionId(sessionIndex); + } + + [Documentation(nameof(GetSessionSteamId), "Gets the SteamID for the remote user in a session.", new[] { "sessionId: Remote Play session ID." }, null)] + public ulong GetSessionSteamId(uint sessionId) + { + return SteamNativeApi.GetRemotePlaySessionSteamId(sessionId); + } + + [Documentation(nameof(GetSessionClientName), "Gets the client device name for a remote session.", new[] { "sessionId: Remote Play session ID." }, null)] + public string GetSessionClientName(uint sessionId) + { + return SteamNativeApi.GetRemotePlaySessionClientName(sessionId); + } + + [Documentation(nameof(GetSessionClientFormFactor), "Gets the client form-factor value for a session (matches Steam's ESteamDeviceFormFactor numeric values).", new[] { "sessionId: Remote Play session ID." }, null)] + public int GetSessionClientFormFactor(uint sessionId) + { + return SteamNativeApi.GetRemotePlaySessionClientFormFactor(sessionId); + } + + [Documentation(nameof(TryGetSessionClientResolution), "Gets the streaming client resolution for a session.", new[] { "sessionId: Remote Play session ID.", "resolutionX: Width output.", "resolutionY: Height output." }, null)] + public bool TryGetSessionClientResolution(uint sessionId, out int resolutionX, out int resolutionY) + { + return SteamNativeApi.TryGetRemotePlaySessionClientResolution(sessionId, out resolutionX, out resolutionY); + } + } +} + diff --git a/OmegaLeo.HelperLib.Steamworks/SteamUgcItemUpdateOptions.cs b/OmegaLeo.HelperLib.Steamworks/SteamUgcItemUpdateOptions.cs new file mode 100644 index 0000000..98ccc30 --- /dev/null +++ b/OmegaLeo.HelperLib.Steamworks/SteamUgcItemUpdateOptions.cs @@ -0,0 +1,30 @@ +using OmegaLeo.HelperLib.Shared.Attributes; + +namespace OmegaLeo.HelperLib.Steamworks +{ + [Documentation(nameof(SteamUgcItemUpdateOptions), "Declarative update payload for workshop item editing convenience APIs.", null, null)] + public class SteamUgcItemUpdateOptions + { + [Documentation(nameof(Title), "Workshop item title.", null, null)] + public string Title { get; set; } + + [Documentation(nameof(Description), "Workshop item description.", null, null)] + public string Description { get; set; } + + [Documentation(nameof(Metadata), "Workshop item metadata string.", null, null)] + public string Metadata { get; set; } + + [Documentation(nameof(Visibility), "Numeric ERemoteStoragePublishedFileVisibility value.", null, null)] + public uint? Visibility { get; set; } + + [Documentation(nameof(Tags), "Workshop tag list.", null, null)] + public string[] Tags { get; set; } + + [Documentation(nameof(ContentFolder), "Absolute path to workshop content folder.", null, null)] + public string ContentFolder { get; set; } + + [Documentation(nameof(PreviewFile), "Absolute path to workshop preview image.", null, null)] + public string PreviewFile { get; set; } + } +} + diff --git a/OmegaLeo.HelperLib.Steamworks/SteamUgcItemUpdateSession.cs b/OmegaLeo.HelperLib.Steamworks/SteamUgcItemUpdateSession.cs new file mode 100644 index 0000000..7409fd8 --- /dev/null +++ b/OmegaLeo.HelperLib.Steamworks/SteamUgcItemUpdateSession.cs @@ -0,0 +1,73 @@ +using OmegaLeo.HelperLib.Shared.Attributes; + +namespace OmegaLeo.HelperLib.Steamworks +{ + [Documentation(nameof(SteamUgcItemUpdateSession), "Fluent helper for editing and submitting a workshop item update.", null, null)] + public class SteamUgcItemUpdateSession + { + private readonly SteamUgcManager _ugcManager; + private readonly uint _consumerAppId; + private readonly ulong _publishedFileId; + private readonly SteamUgcItemUpdateOptions _options = new SteamUgcItemUpdateOptions(); + + internal SteamUgcItemUpdateSession(SteamUgcManager ugcManager, uint consumerAppId, ulong publishedFileId) + { + _ugcManager = ugcManager; + _consumerAppId = consumerAppId; + _publishedFileId = publishedFileId; + } + + public SteamUgcItemUpdateSession WithTitle(string title) + { + _options.Title = title; + return this; + } + + public SteamUgcItemUpdateSession WithDescription(string description) + { + _options.Description = description; + return this; + } + + public SteamUgcItemUpdateSession WithMetadata(string metadata) + { + _options.Metadata = metadata; + return this; + } + + public SteamUgcItemUpdateSession WithVisibility(uint visibility) + { + _options.Visibility = visibility; + return this; + } + + public SteamUgcItemUpdateSession WithTags(params string[] tags) + { + _options.Tags = tags; + return this; + } + + public SteamUgcItemUpdateSession WithContentFolder(string contentFolder) + { + _options.ContentFolder = contentFolder; + return this; + } + + public SteamUgcItemUpdateSession WithPreviewFile(string previewFile) + { + _options.PreviewFile = previewFile; + return this; + } + + [Documentation(nameof(Submit), "Submits the fluent update session and returns a Steam API call handle.", new[] + { + "changeNote: Changelog note for this update.", + "failedStep: Name of the failed step if submission returns 0." + }, null)] + public ulong Submit(string changeNote, out string failedStep) + { + return _ugcManager.UpdateItem(_consumerAppId, _publishedFileId, _options, changeNote, out failedStep); + } + } +} + diff --git a/OmegaLeo.HelperLib.Steamworks/SteamUgcManager.cs b/OmegaLeo.HelperLib.Steamworks/SteamUgcManager.cs new file mode 100644 index 0000000..7deda32 --- /dev/null +++ b/OmegaLeo.HelperLib.Steamworks/SteamUgcManager.cs @@ -0,0 +1,240 @@ +using OmegaLeo.HelperLib.Shared.Attributes; + +namespace OmegaLeo.HelperLib.Steamworks +{ + [Documentation(nameof(SteamUgcManager), "Provides helper methods for common Steam Workshop (UGC) operations such as queries and subscriptions.", null, + @"```csharp +var ugc = new SteamUgcManager(); +var items = ugc.GetSubscribedItems(); +```")] + public class SteamUgcManager + { + [Documentation(nameof(BeginUpdateSession), "Begins a fluent UGC update session for an existing workshop item.", new[] + { + "consumerAppId: Your game AppId.", + "publishedFileId: Existing workshop item ID." + }, null)] + public SteamUgcItemUpdateSession BeginUpdateSession(uint consumerAppId, ulong publishedFileId) + { + return new SteamUgcItemUpdateSession(this, consumerAppId, publishedFileId); + } + + [Documentation(nameof(ApplyItemUpdate), "Applies all non-null/non-empty fields from a UGC update options object to an existing update handle.", new[] + { + "updateHandle: Handle from StartItemUpdate.", + "options: Options object containing fields to apply.", + "failedStep: Name of the field that failed to apply, if any." + }, null)] + public bool ApplyItemUpdate(ulong updateHandle, SteamUgcItemUpdateOptions options, out string failedStep) + { + failedStep = string.Empty; + + if (updateHandle == 0 || options == null) + { + failedStep = "InvalidArguments"; + return false; + } + + if (!string.IsNullOrWhiteSpace(options.Title) && !SetItemTitle(updateHandle, options.Title)) + { + failedStep = nameof(options.Title); + return false; + } + + if (!string.IsNullOrWhiteSpace(options.Description) && !SetItemDescription(updateHandle, options.Description)) + { + failedStep = nameof(options.Description); + return false; + } + + if (!string.IsNullOrWhiteSpace(options.Metadata) && !SetItemMetadata(updateHandle, options.Metadata)) + { + failedStep = nameof(options.Metadata); + return false; + } + + if (options.Visibility.HasValue && !SetItemVisibility(updateHandle, options.Visibility.Value)) + { + failedStep = nameof(options.Visibility); + return false; + } + + if (options.Tags != null && options.Tags.Length > 0 && !SetItemTags(updateHandle, options.Tags)) + { + failedStep = nameof(options.Tags); + return false; + } + + if (!string.IsNullOrWhiteSpace(options.ContentFolder) && !SetItemContent(updateHandle, options.ContentFolder)) + { + failedStep = nameof(options.ContentFolder); + return false; + } + + if (!string.IsNullOrWhiteSpace(options.PreviewFile) && !SetItemPreview(updateHandle, options.PreviewFile)) + { + failedStep = nameof(options.PreviewFile); + return false; + } + + return true; + } + + [Documentation(nameof(UpdateItem), "Convenience method that starts an item update, applies option fields, and submits the update in one call.", new[] + { + "consumerAppId: Your game AppId.", + "publishedFileId: Existing workshop item ID.", + "options: Options object containing fields to update.", + "changeNote: Changelog note for submission.", + "failedStep: Name of the failed step when the call returns 0." + }, null)] + public ulong UpdateItem(uint consumerAppId, ulong publishedFileId, SteamUgcItemUpdateOptions options, string changeNote, out string failedStep) + { + failedStep = string.Empty; + + var updateHandle = StartItemUpdate(consumerAppId, publishedFileId); + if (updateHandle == 0) + { + failedStep = nameof(StartItemUpdate); + return 0; + } + + if (!ApplyItemUpdate(updateHandle, options, out failedStep)) + { + return 0; + } + + var submitHandle = SubmitItemUpdate(updateHandle, changeNote); + if (submitHandle == 0) + { + failedStep = nameof(SubmitItemUpdate); + } + + return submitHandle; + } + + [Documentation(nameof(CreateItem), "Creates a new Workshop item and returns a Steam API call handle.", new[] + { + "consumerAppId: Your game AppId.", + "fileType: Numeric EWorkshopFileType value." + }, null)] + public ulong CreateItem(uint consumerAppId, uint fileType) + { + return SteamNativeApi.CreateItem(consumerAppId, fileType); + } + + [Documentation(nameof(StartItemUpdate), "Starts an update transaction for an existing Workshop item.", new[] + { + "consumerAppId: Your game AppId.", + "publishedFileId: Existing workshop item ID." + }, null)] + public ulong StartItemUpdate(uint consumerAppId, ulong publishedFileId) + { + return SteamNativeApi.StartItemUpdate(consumerAppId, publishedFileId); + } + + [Documentation(nameof(SetItemTitle), "Sets workshop item title for a pending update.", new[] { "updateHandle: Handle from StartItemUpdate.", "title: New item title." }, null)] + public bool SetItemTitle(ulong updateHandle, string title) + { + return SteamNativeApi.SetItemTitle(updateHandle, title); + } + + [Documentation(nameof(SetItemDescription), "Sets workshop item description for a pending update.", new[] { "updateHandle: Handle from StartItemUpdate.", "description: New item description." }, null)] + public bool SetItemDescription(ulong updateHandle, string description) + { + return SteamNativeApi.SetItemDescription(updateHandle, description); + } + + [Documentation(nameof(SetItemMetadata), "Sets workshop item metadata for a pending update.", new[] { "updateHandle: Handle from StartItemUpdate.", "metadata: Metadata string (up to Steam's size limits)." }, null)] + public bool SetItemMetadata(ulong updateHandle, string metadata) + { + return SteamNativeApi.SetItemMetadata(updateHandle, metadata); + } + + [Documentation(nameof(SetItemVisibility), "Sets workshop item visibility for a pending update.", new[] { "updateHandle: Handle from StartItemUpdate.", "visibility: Numeric ERemoteStoragePublishedFileVisibility value." }, null)] + public bool SetItemVisibility(ulong updateHandle, uint visibility) + { + return SteamNativeApi.SetItemVisibility(updateHandle, visibility); + } + + [Documentation(nameof(SetItemTags), "Sets workshop item tags for a pending update.", new[] { "updateHandle: Handle from StartItemUpdate.", "tags: Array of tag strings." }, null)] + public bool SetItemTags(ulong updateHandle, string[] tags) + { + return SteamNativeApi.SetItemTags(updateHandle, tags); + } + + [Documentation(nameof(SetItemContent), "Sets workshop item content folder path for a pending update.", new[] { "updateHandle: Handle from StartItemUpdate.", "contentFolder: Absolute path to content folder." }, null)] + public bool SetItemContent(ulong updateHandle, string contentFolder) + { + return SteamNativeApi.SetItemContent(updateHandle, contentFolder); + } + + [Documentation(nameof(SetItemPreview), "Sets workshop item preview image path for a pending update.", new[] { "updateHandle: Handle from StartItemUpdate.", "previewFile: Absolute path to preview image file." }, null)] + public bool SetItemPreview(ulong updateHandle, string previewFile) + { + return SteamNativeApi.SetItemPreview(updateHandle, previewFile); + } + + [Documentation(nameof(SubmitItemUpdate), "Submits a pending workshop item update and returns a Steam API call handle.", new[] { "updateHandle: Handle from StartItemUpdate.", "changeNote: Changelog note for the update." }, null)] + public ulong SubmitItemUpdate(ulong updateHandle, string changeNote) + { + return SteamNativeApi.SubmitItemUpdate(updateHandle, changeNote); + } + + [Documentation(nameof(GetItemUpdateProgress), "Gets progress state for a pending item update upload.", new[] { "updateHandle: Handle from StartItemUpdate.", "bytesProcessed: Uploaded bytes output.", "bytesTotal: Total bytes output." }, null)] + public uint GetItemUpdateProgress(ulong updateHandle, out ulong bytesProcessed, out ulong bytesTotal) + { + return SteamNativeApi.GetItemUpdateProgress(updateHandle, out bytesProcessed, out bytesTotal); + } + + [Documentation(nameof(CreateQueryAllUgcRequest), "Creates a UGC query request handle for workshop discovery.", new[] + { + "queryType: Numeric EUGCQuery value from Steamworks docs.", + "matchingType: Numeric EUGCMatchingUGCType value from Steamworks docs.", + "creatorAppId: AppId filter for creator app.", + "consumerAppId: AppId filter for consumer app.", + "page: Query page number, starting at 1." + }, null)] + public ulong CreateQueryAllUgcRequest(uint queryType, uint matchingType, uint creatorAppId, uint consumerAppId, uint page = 1) + { + return SteamNativeApi.CreateQueryAllUgcRequest(queryType, matchingType, creatorAppId, consumerAppId, page); + } + + [Documentation(nameof(SendQueryUgcRequest), "Submits an existing UGC query request and returns a Steam API call handle.", new[] { "queryHandle: UGC query handle returned from CreateQueryAllUgcRequest." }, null)] + public ulong SendQueryUgcRequest(ulong queryHandle) + { + return SteamNativeApi.SendQueryUgcRequest(queryHandle); + } + + [Documentation(nameof(ReleaseQueryUgcRequest), "Releases a UGC query handle after you are done with query results.", new[] { "queryHandle: UGC query handle to release." }, null)] + public bool ReleaseQueryUgcRequest(ulong queryHandle) + { + return SteamNativeApi.ReleaseQueryUgcRequest(queryHandle); + } + + [Documentation(nameof(GetNumSubscribedItems), "Gets the number of workshop items the current user is subscribed to.", null, null)] + public uint GetNumSubscribedItems() + { + return SteamNativeApi.GetNumSubscribedItems(); + } + + [Documentation(nameof(GetSubscribedItems), "Gets subscribed workshop item IDs for the current user.", new[] { "maxEntries: Maximum number of subscribed IDs to retrieve." }, null)] + public ulong[] GetSubscribedItems(uint maxEntries = 1024) + { + return SteamNativeApi.GetSubscribedItems(maxEntries); + } + + [Documentation(nameof(SubscribeItem), "Subscribes the current user to a workshop item.", new[] { "publishedFileId: Published file ID of the workshop item." }, null)] + public ulong SubscribeItem(ulong publishedFileId) + { + return SteamNativeApi.SubscribeItem(publishedFileId); + } + + [Documentation(nameof(UnsubscribeItem), "Unsubscribes the current user from a workshop item.", new[] { "publishedFileId: Published file ID of the workshop item." }, null)] + public ulong UnsubscribeItem(ulong publishedFileId) + { + return SteamNativeApi.UnsubscribeItem(publishedFileId); + } + } +} + diff --git a/OmegaLeo.HelperLib.Web/Controllers/HomeController.cs b/OmegaLeo.HelperLib.Web/Controllers/HomeController.cs index 12def41..6647869 100755 --- a/OmegaLeo.HelperLib.Web/Controllers/HomeController.cs +++ b/OmegaLeo.HelperLib.Web/Controllers/HomeController.cs @@ -69,6 +69,13 @@ private void InitializeLibraries() "Library of shared attributes and utilities used across other OmegaLeo.HelperLib packages", "OmegaLeo.HelperLib.Shared" ), + ["steamworks"] = GenerateLibraryDocs( + typeof(OmegaLeo.HelperLib.Steamworks.SteamManager).Assembly, + Path.Combine(root, "changelogs", "OmegaLeo.HelperLib.Steamworks.CHANGELOG.md"), + "Steamworks Library", + "Helpers for integrating with the Steamworks API", + "OmegaLeo.HelperLib.Steamworks" + ) }; _logger.LogInformation("Initialized {Count} libraries", _libraryCache.Count); diff --git a/OmegaLeo.HelperLib.Web/OmegaLeo.HelperLib.Web.csproj b/OmegaLeo.HelperLib.Web/OmegaLeo.HelperLib.Web.csproj index 3c4ef0d..a79f80f 100755 --- a/OmegaLeo.HelperLib.Web/OmegaLeo.HelperLib.Web.csproj +++ b/OmegaLeo.HelperLib.Web/OmegaLeo.HelperLib.Web.csproj @@ -9,6 +9,7 @@ + diff --git a/OmegaLeo.HelperLib.Web/Views/Home/Library.cshtml b/OmegaLeo.HelperLib.Web/Views/Home/Library.cshtml index d896565..7fb739a 100755 --- a/OmegaLeo.HelperLib.Web/Views/Home/Library.cshtml +++ b/OmegaLeo.HelperLib.Web/Views/Home/Library.cshtml @@ -81,9 +81,44 @@ @foreach (var desc in classDoc.Descriptions) { + var methodParameters = desc.MethodParameters ?? Array.Empty(); + var attributeParameters = desc.Parameters ?? Array.Empty(); + var methodParameterSet = new HashSet(methodParameters, StringComparer.OrdinalIgnoreCase); + var filteredAttributeParameters = attributeParameters + .Where(p => !methodParameterSet.Contains(p)) + .Distinct(StringComparer.OrdinalIgnoreCase) + .ToArray(); + @desc.Title @Html.Raw(Markdig.Markdown.ToHtml(desc.Description))
+ @if (desc.ReturnType.IsNotNullOrEmpty()) + { + Returns: @desc.ReturnType
+ } + + @if (methodParameters.Any()) + { + Parameters: +
    + @foreach (var methodParameter in methodParameters) + { +
  • @methodParameter
    • + } +
+ } + + @if (filteredAttributeParameters.Any()) + { + Attribute Args: +
    + @foreach (var attributeParameter in filteredAttributeParameters) + { +
  • @attributeParameter
    • + } +
+ } + @if (desc.CodeExample.IsNotNullOrEmpty()) { Example:
diff --git a/OmegaLeo.HelperLib.Web/Views/Shared/_Layout.cshtml b/OmegaLeo.HelperLib.Web/Views/Shared/_Layout.cshtml index 5cce3cb..8ff3042 100755 --- a/OmegaLeo.HelperLib.Web/Views/Shared/_Layout.cshtml +++ b/OmegaLeo.HelperLib.Web/Views/Shared/_Layout.cshtml @@ -39,6 +39,9 @@
  • Shared Components
    • +
  • + Steamworks +
      • diff --git a/OmegaLeo.HelperLib.sln b/OmegaLeo.HelperLib.sln index 68544d6..37b7602 100755 --- a/OmegaLeo.HelperLib.sln +++ b/OmegaLeo.HelperLib.sln @@ -32,40 +32,131 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "OmegaLeo.HelperLib.Document EndProject Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "OmegaLeo.HelperLib.Shared", "OmegaLeo.HelperLib.Shared\OmegaLeo.HelperLib.Shared.csproj", "{FE6CA992-8BEB-41DD-A8E4-60FCEF96C59A}" EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "OmegaLeo.HelperLib.Steamworks", "OmegaLeo.HelperLib.Steamworks\OmegaLeo.HelperLib.Steamworks.csproj", "{23C447DC-3188-4319-8307-E31852EF45C7}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "OmegaLeo.HelperLib.ConsoleApp", "OmegaLeo.HelperLib.ConsoleApp\OmegaLeo.HelperLib.ConsoleApp.csproj", "{C5FD0FDC-0007-48AB-86C7-D8CB05126B86}" +EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution Debug|Any CPU = Debug|Any CPU + Debug|x64 = Debug|x64 + Debug|x86 = Debug|x86 Release|Any CPU = Release|Any CPU + Release|x64 = Release|x64 + Release|x86 = Release|x86 EndGlobalSection GlobalSection(ProjectConfigurationPlatforms) = postSolution {A7256931-5D66-46FA-BA50-22B2FA4CD9E9}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {A7256931-5D66-46FA-BA50-22B2FA4CD9E9}.Debug|Any CPU.Build.0 = Debug|Any CPU + {A7256931-5D66-46FA-BA50-22B2FA4CD9E9}.Debug|x64.ActiveCfg = Debug|Any CPU + {A7256931-5D66-46FA-BA50-22B2FA4CD9E9}.Debug|x64.Build.0 = Debug|Any CPU + {A7256931-5D66-46FA-BA50-22B2FA4CD9E9}.Debug|x86.ActiveCfg = Debug|Any CPU + {A7256931-5D66-46FA-BA50-22B2FA4CD9E9}.Debug|x86.Build.0 = Debug|Any CPU {A7256931-5D66-46FA-BA50-22B2FA4CD9E9}.Release|Any CPU.ActiveCfg = Release|Any CPU {A7256931-5D66-46FA-BA50-22B2FA4CD9E9}.Release|Any CPU.Build.0 = Release|Any CPU + {A7256931-5D66-46FA-BA50-22B2FA4CD9E9}.Release|x64.ActiveCfg = Release|Any CPU + {A7256931-5D66-46FA-BA50-22B2FA4CD9E9}.Release|x64.Build.0 = Release|Any CPU + {A7256931-5D66-46FA-BA50-22B2FA4CD9E9}.Release|x86.ActiveCfg = Release|Any CPU + {A7256931-5D66-46FA-BA50-22B2FA4CD9E9}.Release|x86.Build.0 = Release|Any CPU {378D8125-66B5-42B8-9881-33F951E5E04A}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {378D8125-66B5-42B8-9881-33F951E5E04A}.Debug|Any CPU.Build.0 = Debug|Any CPU + {378D8125-66B5-42B8-9881-33F951E5E04A}.Debug|x64.ActiveCfg = Debug|Any CPU + {378D8125-66B5-42B8-9881-33F951E5E04A}.Debug|x64.Build.0 = Debug|Any CPU + {378D8125-66B5-42B8-9881-33F951E5E04A}.Debug|x86.ActiveCfg = Debug|Any CPU + {378D8125-66B5-42B8-9881-33F951E5E04A}.Debug|x86.Build.0 = Debug|Any CPU {378D8125-66B5-42B8-9881-33F951E5E04A}.Release|Any CPU.ActiveCfg = Release|Any CPU {378D8125-66B5-42B8-9881-33F951E5E04A}.Release|Any CPU.Build.0 = Release|Any CPU + {378D8125-66B5-42B8-9881-33F951E5E04A}.Release|x64.ActiveCfg = Release|Any CPU + {378D8125-66B5-42B8-9881-33F951E5E04A}.Release|x64.Build.0 = Release|Any CPU + {378D8125-66B5-42B8-9881-33F951E5E04A}.Release|x86.ActiveCfg = Release|Any CPU + {378D8125-66B5-42B8-9881-33F951E5E04A}.Release|x86.Build.0 = Release|Any CPU {359536F7-02DE-43E9-A383-D83853227B0F}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {359536F7-02DE-43E9-A383-D83853227B0F}.Debug|Any CPU.Build.0 = Debug|Any CPU + {359536F7-02DE-43E9-A383-D83853227B0F}.Debug|x64.ActiveCfg = Debug|Any CPU + {359536F7-02DE-43E9-A383-D83853227B0F}.Debug|x64.Build.0 = Debug|Any CPU + {359536F7-02DE-43E9-A383-D83853227B0F}.Debug|x86.ActiveCfg = Debug|Any CPU + {359536F7-02DE-43E9-A383-D83853227B0F}.Debug|x86.Build.0 = Debug|Any CPU {359536F7-02DE-43E9-A383-D83853227B0F}.Release|Any CPU.ActiveCfg = Release|Any CPU {359536F7-02DE-43E9-A383-D83853227B0F}.Release|Any CPU.Build.0 = Release|Any CPU + {359536F7-02DE-43E9-A383-D83853227B0F}.Release|x64.ActiveCfg = Release|Any CPU + {359536F7-02DE-43E9-A383-D83853227B0F}.Release|x64.Build.0 = Release|Any CPU + {359536F7-02DE-43E9-A383-D83853227B0F}.Release|x86.ActiveCfg = Release|Any CPU + {359536F7-02DE-43E9-A383-D83853227B0F}.Release|x86.Build.0 = Release|Any CPU {1EA64C6B-D5D2-47EB-8255-5BAE2EE1385A}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {1EA64C6B-D5D2-47EB-8255-5BAE2EE1385A}.Debug|Any CPU.Build.0 = Debug|Any CPU + {1EA64C6B-D5D2-47EB-8255-5BAE2EE1385A}.Debug|x64.ActiveCfg = Debug|Any CPU + {1EA64C6B-D5D2-47EB-8255-5BAE2EE1385A}.Debug|x64.Build.0 = Debug|Any CPU + {1EA64C6B-D5D2-47EB-8255-5BAE2EE1385A}.Debug|x86.ActiveCfg = Debug|Any CPU + {1EA64C6B-D5D2-47EB-8255-5BAE2EE1385A}.Debug|x86.Build.0 = Debug|Any CPU {1EA64C6B-D5D2-47EB-8255-5BAE2EE1385A}.Release|Any CPU.ActiveCfg = Release|Any CPU {1EA64C6B-D5D2-47EB-8255-5BAE2EE1385A}.Release|Any CPU.Build.0 = Release|Any CPU + {1EA64C6B-D5D2-47EB-8255-5BAE2EE1385A}.Release|x64.ActiveCfg = Release|Any CPU + {1EA64C6B-D5D2-47EB-8255-5BAE2EE1385A}.Release|x64.Build.0 = Release|Any CPU + {1EA64C6B-D5D2-47EB-8255-5BAE2EE1385A}.Release|x86.ActiveCfg = Release|Any CPU + {1EA64C6B-D5D2-47EB-8255-5BAE2EE1385A}.Release|x86.Build.0 = Release|Any CPU {488BC3EA-9B7A-4251-B802-22EB098D6494}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {488BC3EA-9B7A-4251-B802-22EB098D6494}.Debug|Any CPU.Build.0 = Debug|Any CPU + {488BC3EA-9B7A-4251-B802-22EB098D6494}.Debug|x64.ActiveCfg = Debug|Any CPU + {488BC3EA-9B7A-4251-B802-22EB098D6494}.Debug|x64.Build.0 = Debug|Any CPU + {488BC3EA-9B7A-4251-B802-22EB098D6494}.Debug|x86.ActiveCfg = Debug|Any CPU + {488BC3EA-9B7A-4251-B802-22EB098D6494}.Debug|x86.Build.0 = Debug|Any CPU {488BC3EA-9B7A-4251-B802-22EB098D6494}.Release|Any CPU.ActiveCfg = Release|Any CPU {488BC3EA-9B7A-4251-B802-22EB098D6494}.Release|Any CPU.Build.0 = Release|Any CPU + {488BC3EA-9B7A-4251-B802-22EB098D6494}.Release|x64.ActiveCfg = Release|Any CPU + {488BC3EA-9B7A-4251-B802-22EB098D6494}.Release|x64.Build.0 = Release|Any CPU + {488BC3EA-9B7A-4251-B802-22EB098D6494}.Release|x86.ActiveCfg = Release|Any CPU + {488BC3EA-9B7A-4251-B802-22EB098D6494}.Release|x86.Build.0 = Release|Any CPU {AE69480D-5956-46CB-9028-E4723735E37E}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {AE69480D-5956-46CB-9028-E4723735E37E}.Debug|Any CPU.Build.0 = Debug|Any CPU + {AE69480D-5956-46CB-9028-E4723735E37E}.Debug|x64.ActiveCfg = Debug|Any CPU + {AE69480D-5956-46CB-9028-E4723735E37E}.Debug|x64.Build.0 = Debug|Any CPU + {AE69480D-5956-46CB-9028-E4723735E37E}.Debug|x86.ActiveCfg = Debug|Any CPU + {AE69480D-5956-46CB-9028-E4723735E37E}.Debug|x86.Build.0 = Debug|Any CPU {AE69480D-5956-46CB-9028-E4723735E37E}.Release|Any CPU.ActiveCfg = Release|Any CPU {AE69480D-5956-46CB-9028-E4723735E37E}.Release|Any CPU.Build.0 = Release|Any CPU + {AE69480D-5956-46CB-9028-E4723735E37E}.Release|x64.ActiveCfg = Release|Any CPU + {AE69480D-5956-46CB-9028-E4723735E37E}.Release|x64.Build.0 = Release|Any CPU + {AE69480D-5956-46CB-9028-E4723735E37E}.Release|x86.ActiveCfg = Release|Any CPU + {AE69480D-5956-46CB-9028-E4723735E37E}.Release|x86.Build.0 = Release|Any CPU {FE6CA992-8BEB-41DD-A8E4-60FCEF96C59A}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {FE6CA992-8BEB-41DD-A8E4-60FCEF96C59A}.Debug|Any CPU.Build.0 = Debug|Any CPU + {FE6CA992-8BEB-41DD-A8E4-60FCEF96C59A}.Debug|x64.ActiveCfg = Debug|Any CPU + {FE6CA992-8BEB-41DD-A8E4-60FCEF96C59A}.Debug|x64.Build.0 = Debug|Any CPU + {FE6CA992-8BEB-41DD-A8E4-60FCEF96C59A}.Debug|x86.ActiveCfg = Debug|Any CPU + {FE6CA992-8BEB-41DD-A8E4-60FCEF96C59A}.Debug|x86.Build.0 = Debug|Any CPU {FE6CA992-8BEB-41DD-A8E4-60FCEF96C59A}.Release|Any CPU.ActiveCfg = Release|Any CPU {FE6CA992-8BEB-41DD-A8E4-60FCEF96C59A}.Release|Any CPU.Build.0 = Release|Any CPU + {FE6CA992-8BEB-41DD-A8E4-60FCEF96C59A}.Release|x64.ActiveCfg = Release|Any CPU + {FE6CA992-8BEB-41DD-A8E4-60FCEF96C59A}.Release|x64.Build.0 = Release|Any CPU + {FE6CA992-8BEB-41DD-A8E4-60FCEF96C59A}.Release|x86.ActiveCfg = Release|Any CPU + {FE6CA992-8BEB-41DD-A8E4-60FCEF96C59A}.Release|x86.Build.0 = Release|Any CPU + {23C447DC-3188-4319-8307-E31852EF45C7}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {23C447DC-3188-4319-8307-E31852EF45C7}.Debug|Any CPU.Build.0 = Debug|Any CPU + {23C447DC-3188-4319-8307-E31852EF45C7}.Debug|x64.ActiveCfg = Debug|Any CPU + {23C447DC-3188-4319-8307-E31852EF45C7}.Debug|x64.Build.0 = Debug|Any CPU + {23C447DC-3188-4319-8307-E31852EF45C7}.Debug|x86.ActiveCfg = Debug|Any CPU + {23C447DC-3188-4319-8307-E31852EF45C7}.Debug|x86.Build.0 = Debug|Any CPU + {23C447DC-3188-4319-8307-E31852EF45C7}.Release|Any CPU.ActiveCfg = Release|Any CPU + {23C447DC-3188-4319-8307-E31852EF45C7}.Release|Any CPU.Build.0 = Release|Any CPU + {23C447DC-3188-4319-8307-E31852EF45C7}.Release|x64.ActiveCfg = Release|Any CPU + {23C447DC-3188-4319-8307-E31852EF45C7}.Release|x64.Build.0 = Release|Any CPU + {23C447DC-3188-4319-8307-E31852EF45C7}.Release|x86.ActiveCfg = Release|Any CPU + {23C447DC-3188-4319-8307-E31852EF45C7}.Release|x86.Build.0 = Release|Any CPU + {C5FD0FDC-0007-48AB-86C7-D8CB05126B86}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {C5FD0FDC-0007-48AB-86C7-D8CB05126B86}.Debug|Any CPU.Build.0 = Debug|Any CPU + {C5FD0FDC-0007-48AB-86C7-D8CB05126B86}.Debug|x64.ActiveCfg = Debug|Any CPU + {C5FD0FDC-0007-48AB-86C7-D8CB05126B86}.Debug|x64.Build.0 = Debug|Any CPU + {C5FD0FDC-0007-48AB-86C7-D8CB05126B86}.Debug|x86.ActiveCfg = Debug|Any CPU + {C5FD0FDC-0007-48AB-86C7-D8CB05126B86}.Debug|x86.Build.0 = Debug|Any CPU + {C5FD0FDC-0007-48AB-86C7-D8CB05126B86}.Release|Any CPU.ActiveCfg = Release|Any CPU + {C5FD0FDC-0007-48AB-86C7-D8CB05126B86}.Release|Any CPU.Build.0 = Release|Any CPU + {C5FD0FDC-0007-48AB-86C7-D8CB05126B86}.Release|x64.ActiveCfg = Release|Any CPU + {C5FD0FDC-0007-48AB-86C7-D8CB05126B86}.Release|x64.Build.0 = Release|Any CPU + {C5FD0FDC-0007-48AB-86C7-D8CB05126B86}.Release|x86.ActiveCfg = Release|Any CPU + {C5FD0FDC-0007-48AB-86C7-D8CB05126B86}.Release|x86.Build.0 = Release|Any CPU + EndGlobalSection + GlobalSection(SolutionProperties) = preSolution + HideSolutionNode = FALSE EndGlobalSection GlobalSection(NestedProjects) = preSolution {750F2E9A-2703-4732-98D7-29C658368E48} = {00CF0543-37F3-41DE-B78F-8ADA6DE796ED} diff --git a/OmegaLeo.HelperLib.sln.DotSettings.user b/OmegaLeo.HelperLib.sln.DotSettings.user index b291b2c..6eac453 100755 --- a/OmegaLeo.HelperLib.sln.DotSettings.user +++ b/OmegaLeo.HelperLib.sln.DotSettings.user @@ -1,7 +1,10 @@  + True + True ForceIncluded ForceIncluded ForceIncluded + ForceIncluded ForceIncluded ForceIncluded ForceIncluded diff --git a/OmegaLeo.HelperLib/LICENSE.md b/OmegaLeo.HelperLib/LICENSE.md index ca8f2dd..0ad25db 100755 --- a/OmegaLeo.HelperLib/LICENSE.md +++ b/OmegaLeo.HelperLib/LICENSE.md @@ -1,21 +1,661 @@ -MIT License - -Copyright (c) 2024 Nuno "Omega Leo" Diogo - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. \ No newline at end of file + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 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 Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are 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. + + 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. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + 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 Affero 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. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + 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 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 work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero 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 Affero 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 Affero 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 Affero 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 Affero 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 Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + 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 AGPL, see +. diff --git a/steam_appid.txt b/steam_appid.txt new file mode 100644 index 0000000..7ad8022 --- /dev/null +++ b/steam_appid.txt @@ -0,0 +1 @@ +480 \ No newline at end of file