diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 00000000..9b425256 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,9 @@ +root = true + +[*] +indent_size = 4 +indent_style = tab +end_of_line = crlf +charset = utf-8 +trim_trailing_whitespace = true +insert_final_newline = true \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..ed4304db --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + fxserver-esx_bankerjob + Copyright (C) 2015 Jérémie N'gadi + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + fxserver-esx_bankerjob Copyright (C) 2015 Jérémie N'gadi + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 00000000..5ce9a720 --- /dev/null +++ b/README.md @@ -0,0 +1,44 @@ +# esx_bankerjob + +## Requirements + +- [cron](https://github.com/ESX-Org/cron) +- [esx_addonaccount](https://github.com/ESX-Org/esx_addonaccount) +- [esx_society](https://github.com/ESX-Org/esx_society) + +## Download & Installation + +### Using [fvm](https://github.com/qlaffont/fvm-installer) +``` +fvm install --save --folder=esx esx-org/esx_bankerjob +``` + +### Using Git +``` +cd resources +git clone https://github.com/ESX-Org/esx_bankerjob [esx]/esx_bankerjob +``` + +### Manually +- Download https://github.com/ESX-Org/esx_bankerjob/archive/master.zip +- Put it in the `[esx]` directory + +## Installation +- Import `esx_bankerjob.sql` in your database +- Add this in your `server.cfg`: + +``` +start esx_bankerjob +``` + +# Legal +### License +esx_bankerjob - bank script + +Copyright (C) 2015-2020 Jérémie N'gadi + +This program Is free software: you can redistribute it And/Or modify it under the terms Of the GNU General Public License As published by the Free Software Foundation, either version 3 Of the License, Or (at your option) any later version. + +This program Is distributed In the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty Of MERCHANTABILITY Or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License For more details. + +You should have received a copy Of the GNU General Public License along with this program. If Not, see http://www.gnu.org/licenses/. \ No newline at end of file diff --git a/client/main.lua b/client/main.lua new file mode 100644 index 00000000..36467b27 --- /dev/null +++ b/client/main.lua @@ -0,0 +1,245 @@ +local CurrentActionData, CurrentAction, CurrentActionMsg, hasAlreadyEnteredMarker, lastZone = {} +ESX = nil + +Citizen.CreateThread(function () + while ESX == nil do + TriggerEvent('esx:getSharedObject', function(obj) ESX = obj end) + Citizen.Wait(0) + end + + while ESX.GetPlayerData().job == nil do + Citizen.Wait(100) + end + + ESX.PlayerData = ESX.GetPlayerData() +end) + +RegisterNetEvent('esx:playerLoaded') +AddEventHandler('esx:playerLoaded', function (xPlayer) + ESX.PlayerData = xPlayer +end) + +RegisterNetEvent('esx:setJob') +AddEventHandler('esx:setJob', function (job) + ESX.PlayerData.job = job +end) + +function OpenBankActionsMenu() + local elements = { + {label = _U('customers'), value = 'customers'}, + {label = _U('billing'), value = 'billing'} + } + + if ESX.PlayerData.job.grade_name == 'boss' then + table.insert(elements, { label = _U('boss_actions'), value = 'boss_actions' }) + end + + ESX.UI.Menu.CloseAll() + + ESX.UI.Menu.Open('default', GetCurrentResourceName(), 'bank_actions', { + title = _U('bank'), + align = 'top-left', + elements = elements + }, function(data, menu) + if data.current.value == 'customers' then + OpenCustomersMenu() + elseif data.current.value == 'billing' then + ESX.UI.Menu.Open('dialog', GetCurrentResourceName(), 'billing', { + title = _U('bill_amount') + }, function(data, menu) + local amount = tonumber(data.value) + + if amount == nil then + ESX.ShowNotification(_U('invalid_amount')) + else + menu.close() + + local closestPlayer, closestDistance = ESX.Game.GetClosestPlayer() + + if closestPlayer == -1 or closestDistance > 5.0 then + ESX.ShowNotification(_U('no_player_nearby')) + else + TriggerServerEvent('esx_billing:sendBill', GetPlayerServerId(closestPlayer), 'society_banker', 'Banque', amount) + end + end + end, function(data, menu) + menu.close() + end) + elseif data.current.value == 'boss_actions' then + TriggerEvent('esx_society:openBossMenu', 'banker', function (data, menu) + menu.close() + end, {wash = false}) + end + end, function(data, menu) + menu.close() + + CurrentAction = 'bank_actions_menu' + CurrentActionMsg = _U('press_input_context_to_open_menu') + CurrentActionData = {} + end) +end + +function OpenCustomersMenu() + ESX.TriggerServerCallback('esx_bankerjob:getCustomers', function(customers) + local elements = { + head = { _U('customer'), _U('balance'), _U('actions') }, + rows = {} + } + + for i=1, #customers do + table.insert(elements.rows, { + data = customers[i], + cols = { + customers[i].name, + customers[i].bankSavings, + '{{' .. _U('deposit') .. '|deposit}} {{' .. _U('withdraw') .. '|withdraw}}' + } + }) + end + + ESX.UI.Menu.Open('list', GetCurrentResourceName(), 'customers', elements, function(data, menu) + local customer = data.data + + if data.value == 'deposit' then + menu.close() + + ESX.UI.Menu.Open('dialog', GetCurrentResourceName(), 'customer_deposit_amount', { + title = _U('amount') + }, function(data2, menu2) + local amount = tonumber(data2.value) + + if amount == nil then + ESX.ShowNotification(_U('invalid_amount')) + else + menu2.close() + TriggerServerEvent('esx_bankerjob:customerDeposit', customer.source, amount) + OpenCustomersMenu() + end + end, function(data2, menu2) + menu2.close() + OpenCustomersMenu() + end) + elseif data.value == 'withdraw' then + menu.close() + + ESX.UI.Menu.Open('dialog', GetCurrentResourceName(), 'customer_withdraw_amount', { + title = _U('amount') + }, function(data2, menu2) + local amount = tonumber(data2.value) + + if amount == nil then + ESX.ShowNotification(_U('invalid_amount')) + else + menu2.close() + TriggerServerEvent('esx_bankerjob:customerWithdraw', customer.source, amount) + OpenCustomersMenu() + end + end, function(data2, menu2) + menu2.close() + OpenCustomersMenu() + end) + end + end, function(data, menu) + menu.close() + end) + end) +end + +AddEventHandler('esx_bankerjob:hasEnteredMarker', function (zone) + if zone == 'BankActions' and ESX.PlayerData.job and ESX.PlayerData.job.name == 'banker' then + CurrentAction = 'bank_actions_menu' + CurrentActionMsg = _U('press_input_context_to_open_menu') + CurrentActionData = {} + end +end) + +AddEventHandler('esx_bankerjob:hasExitedMarker', function (zone) + CurrentAction = nil + ESX.UI.Menu.CloseAll() +end) + +-- Create Blips +Citizen.CreateThread(function() + local blip = AddBlipForCoord(Config.Zones.BankActions.Coords) + + SetBlipSprite(blip, 108) + SetBlipColour(blip, 30) + SetBlipAsShortRange(blip, true) + + BeginTextCommandSetBlipName('STRING') + AddTextComponentSubstringPlayerName(_U('bank')) + EndTextCommandSetBlipName(blip) +end) + +-- Draw marker & activate menu when player is inside marker +Citizen.CreateThread(function() + while true do + Citizen.Wait(0) + + if ESX.PlayerData.job and ESX.PlayerData.job.name == 'banker' then + local playerCoords = GetEntityCoords(PlayerPedId()) + local isInMarker, letSleep, currentZone = false, true + + for k,v in pairs(Config.Zones) do + local distance = #(playerCoords - v.Coords) + + if v.Type ~= -1 and distance < Config.DrawDistance then + letSleep = false + DrawMarker(v.Type, v.Coords, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, v.Size.x, v.Size.y, v.Size.z, v.Color.r, v.Color.g, v.Color.b, 100, false, true, 2, false, nil, nil, false) + end + + if distance < v.Size.x then + isInMarker, currentZone, letSleep = true, k, false + end + end + + if isInMarker and not hasAlreadyEnteredMarker then + hasAlreadyEnteredMarker, lastZone = true, currentZone + TriggerEvent('esx_bankerjob:hasEnteredMarker', currentZone) + end + + if not isInMarker and hasAlreadyEnteredMarker then + hasAlreadyEnteredMarker = false + TriggerEvent('esx_bankerjob:hasExitedMarker', lastZone) + end + + if letSleep then + Citizen.Wait(500) + end + else + Citizen.Wait(500) + end + end +end) + +-- Key Controls +Citizen.CreateThread(function() + while true do + Citizen.Wait(0) + + if CurrentAction then + ESX.ShowHelpNotification(CurrentActionMsg) + + if IsControlJustReleased(0, 38) and ESX.PlayerData.job and ESX.PlayerData.job.name == 'banker' then + if CurrentAction == 'bank_actions_menu' then + OpenBankActionsMenu() + end + + CurrentAction = nil + end + else + Citizen.Wait(500) + end + end +end) + +RegisterNetEvent('esx_phone:loaded') +AddEventHandler('esx_phone:loaded', function (phoneNumber, contacts) + local specialContact = { + name = _U('phone_label'), + number = 'banker', + base64Icon = 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAIAAAACACAMAAAD04JH5AAAABGdBTUEAALGPC/xhBQAAAwBQTFRFAAAAJUO2JUS4JkW7Jka+L0y5M0+7O1e9J0fBKEjEKEnHKUrJKUvMKk3PK07SK0/VLFHaLVLeLVPgLlTjOl7kO1/lQFu/RmDBTmbEU2vHXHLIR2jmSGnnVHPoVXToaX7NYX7pYn/qbIHPd4rReYzTbojre5PtfZTuhZbWh5jYiJ7vkqHblqnwl6rxoK3fpLXzsb/1u8Xovsr2ydHty9X419zy5Oj25ur88vT78vT88/X9////AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAATuU7PwAAAQB0Uk5T////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////AFP3ByUAAAAJcEhZcwAADsIAAA7CARUoSoAAAAAYdEVYdFNvZnR3YXJlAHBhaW50Lm5ldCA0LjEuNv1OCegAAAUoSURBVHhe5ZvrdtQ2FEZjoCmFltsQ2gYCA4VA06GUhktK3v+5ppK8bUu2jnTk26zV7l+JbH1nR7Y0QglH+zHstpsBb7hWSLHAjnpxttylp0zgKXWSXHCzjgKBxxRQcE4XBVqBc6LV0C+LTqDgh+/Y0TmNRoDAcjRPIi8w6qdvyI9CTiAy4csgRyQjQMoUHhMlkBSYNPodpMVJCdB/OqlBkAXO6D0LZEYQBeg5F+L6LAnQbz7OCO4jCNBrVojuERUoXvh1kB4SE1ioftwgIjDr6x9CBZ+hwGI/v4UaHgOBRetHDAYC3LgYlGnpC3DbcvSX5Z4Ady1Jb+McCnDPslALAoEFJ6AP1WoCAW5YHMo5fAEuL4//GngCM+1/NFDR4glwcRUoaegEuFTEp+vr6298XUS3P2kFRuy/X5rylvd8XwJVPQEu6Dn5Rn3Dc9r0PKVsK1D8BtrR7yh/DtRtBWjWckHhjr+5oobCCNCo5BlFQ95yVUldeJTAVyoOOOEGFXws1gIlb8AHqsX4yj0qXGUEaFLQTD2JgilZTwQnoN6G+VNP4iX35ukEaMgSTj0J9ZQsFRhOPYlP9MjRCKhewfjUk9BNyUaAb5OIU0/iGR1T2EMsncBfpJagmZK1QPb8NTf1JD7QX6YW4BuJE+LGkJuSGgHd1JP4hxQJK5A+f1esPGkeEBTHCvClADHjOb5HUpQVBE6rH4iKsYJAVVU3yIpwlhV4Tg58NnnwhCbLFW0WmuCjayMswv4o/Q5agvfQ5TmuaHHQZvhIi+MJjdUjsgbsj/LbccJqCDQElWgzvKPFcUpjVUmTYX/EFwn8legX8izeEPxGk+UzbYZLmix3SeuhEbC4PKJ8CppvERWyokB8MuxWFIhOhu2qAtVD4jrO1hWohuvyygLVHQJb1haobpLYsLpA/1U8gEC4Lh9CIFiXDyJQ/USs4TAC1W1yDybQrssrr4Q+dfD54QTqybDuh1GP+yZ4zY/jIWZd3h+9oUQamzi/gNmkZHfFYBMXEKiq/73Aq0ML2H+aqc7pbeJSAqohsIn/RYFfDy1QH9FcUCSFTVxMQDMENnF+ge8OLWBqOwHFYblNXE5AMQQ2cXaB77UC3hGJ/y/+L7QZvtBkuaTN4J/cRLCla4G0QXBU2Z1Q/EGL4x2NVXVKi6M+IZJwpRUC70lz0NcQVGoPg6pjWhwvaIziKiOQOKl6O+ms9PKYahFcZQTkISBoPOIgvK4rIyDORGImQL0BdeFGQBwCUiZAvT6/U7gRkN4CUsbjz1Af6rYC0hBMPq4X3kKqegKSATlj+ZOCfSjqC0i/vBvzC6uGq259CKGmoROQp+I9es2H2Qk1eAKywSP6zQYFLb5A4jeoN+g5D9Rz+ALyEGw2d+g7B6yBNYFAyuABvadjN2IdoUByf0r/yVALQoH0H/TdImEaVGroCaQewmbzIxlToE5LXyBt8JCU8TSfQS0DgbTB1BfhFUU6hgIZg9tEjcJbARsiAhmD+4SN4GcK+MQEMgajF+bh+BuiAhmDkQvz4P1zxAVyf1hzl8wSSO4jCOQObsoXZnIHSALZx0CuknD995EFcgYlC3Pw+ReSEMg9Bv1GibwoKYGZ5mNk9fFIC+TOjzTzkSSJjEDu76yyGyVSZLICmeeQno/xtSdAIZBZlqgVQVFeKZB+EMJ8pGcOpYCBchEiGyV3/qRCL5A4ROhtlORlL0KJgIWSfShtSM/6IaUCltjW2W2Uoh/4GcYI1Oy2rcj2XPe/rIfs9/8CuOBqaLBm2ZcAAAAASUVORK5CYII=' + } + + TriggerEvent('esx_phone:addSpecialContact', specialContact.name, specialContact.number, specialContact.base64Icon) +end) \ No newline at end of file diff --git a/config.lua b/config.lua new file mode 100644 index 00000000..bbc0f77f --- /dev/null +++ b/config.lua @@ -0,0 +1,13 @@ +Config = {} +Config.DrawDistance = 100.0 +Config.BankSavingPercentage = 2.5 +Config.Locale = 'en' + +Config.Zones = { + BankActions = { + Coords = vector3(260.1, 204.3, 109.2), + Size = {x = 1.5, y = 1.5, z = 1.0}, + Color = {r = 102, g = 102, b = 204}, + Type = 1 + } +} diff --git a/esx_bankerjob.sql b/esx_bankerjob.sql new file mode 100644 index 00000000..6af26e3e --- /dev/null +++ b/esx_bankerjob.sql @@ -0,0 +1,18 @@ +USE `es_extended`; + +INSERT INTO `addon_account` (name, label, shared) VALUES + ('society_banker','Banque',1), + ('bank_savings','Livret Bleu',0) +; + +INSERT INTO `jobs` (name, label) VALUES + ('banker','Banquier') +; + +INSERT INTO `job_grades` (job_name, grade, name, label, salary, skin_male, skin_female) VALUES + ('banker',0,'advisor','Conseiller',10,'{}','{}'), + ('banker',1,'banker','Banquier',20,'{}','{}'), + ('banker',2,'business_banker',"Banquier d\'affaire",30,'{}','{}'), + ('banker',3,'trader','Trader',40,'{}','{}'), + ('banker',4,'boss','Patron',0,'{}','{}') +; diff --git a/fxmanifest.lua b/fxmanifest.lua new file mode 100644 index 00000000..ea46e12e --- /dev/null +++ b/fxmanifest.lua @@ -0,0 +1,37 @@ +fx_version 'adamant' + +game 'gta5' + +description 'ESX Banker job' + +version '1.0.1' + +server_scripts { + '@async/async.lua', + '@mysql-async/lib/MySQL.lua', + '@es_extended/locale.lua', + 'config.lua', + 'locales/de.lua', + 'locales/br.lua', + 'locales/en.lua', + 'locales/es.lua', + 'locales/fi.lua', + 'locales/fr.lua', + 'locales/sv.lua', + 'server/main.lua' +} + +client_scripts { + '@es_extended/locale.lua', + 'config.lua', + 'locales/de.lua', + 'locales/br.lua', + 'locales/en.lua', + 'locales/es.lua', + 'locales/fi.lua', + 'locales/fr.lua', + 'locales/sv.lua', + 'client/main.lua' +} + +dependency 'es_extended' diff --git a/locales/br.lua b/locales/br.lua new file mode 100644 index 00000000..d712da29 --- /dev/null +++ b/locales/br.lua @@ -0,0 +1,18 @@ +Locales['br'] = { + ['actions'] = 'ações', + ['amount'] = 'quantidade', + ['balance'] = 'saldo', + ['bank'] = 'banco', + ['bill_amount'] = 'montante de dinheiro', + ['billing'] = 'faturamento', + ['customer'] = 'cliente', + ['customers'] = 'clientes', + ['deposit'] = 'depositar', + ['invalid_amount'] = 'quantidade inválida', + ['no_player_nearby'] = 'nenhum jogador nas proximidades', + ['press_input_context_to_open_menu'] = 'pressione ~INPUT_CONTEXT~ para abrir o menu', + ['withdraw'] = 'sacar', + ['boss_actions'] = 'boss Actions', + ['phone_receive'] = 'bank Customer', + ['phone_label'] = 'bank', +} diff --git a/locales/de.lua b/locales/de.lua new file mode 100644 index 00000000..900975f0 --- /dev/null +++ b/locales/de.lua @@ -0,0 +1,18 @@ +Locales['de'] = { + ['actions'] = 'Aktionen', + ['amount'] = 'Betrag', + ['balance'] = 'Kontostand', + ['bank'] = 'Bank', + ['bill_amount'] = 'Rechnungsbetrag', + ['billing'] = 'Rechnung', + ['customer'] = 'Kunde', + ['customers'] = 'Client', + ['deposit'] = 'einzahlen', + ['invalid_amount'] = 'ungültiger Betrag', + ['no_player_nearby'] = 'kein Spieler in der Nähe', + ['press_input_context_to_open_menu'] = 'Drücke ~INPUT_CONTEXT~ um das Menü zu öffnen', + ['withdraw'] = 'Abheben', + ['boss_actions'] = 'boss Actions', + ['phone_receive'] = 'Bankkunde', + ['phone_label'] = 'bank', +} diff --git a/locales/en.lua b/locales/en.lua new file mode 100644 index 00000000..0cd40693 --- /dev/null +++ b/locales/en.lua @@ -0,0 +1,18 @@ +Locales['en'] = { + ['actions'] = 'actions', + ['amount'] = 'amount', + ['balance'] = 'balance', + ['bank'] = 'bank', + ['bill_amount'] = 'bill amount', + ['billing'] = 'billing', + ['customer'] = 'customer', + ['customers'] = 'clients', + ['deposit'] = 'deposit', + ['invalid_amount'] = 'invalid amount', + ['no_player_nearby'] = 'no player nearby', + ['press_input_context_to_open_menu'] = 'press ~INPUT_CONTEXT~ to open the ~g~Bank Menu~s~.', + ['withdraw'] = 'withdraw', + ['boss_actions'] = 'boss Actions', + ['phone_receive'] = 'bank Customer', + ['phone_label'] = 'bank', +} diff --git a/locales/es.lua b/locales/es.lua new file mode 100644 index 00000000..0f1788b2 --- /dev/null +++ b/locales/es.lua @@ -0,0 +1,17 @@ +Locales['es'] = { + ['actions'] = 'acciones', + ['amount'] = 'cantidad', + ['balance'] = 'balance', + ['bank'] = 'Banco', + ['bill_amount'] = 'total de la factura', + ['billing'] = 'facturación', + ['customer'] = 'cliente', + ['customers'] = 'Clientes', + ['deposit'] = 'depositar', + ['invalid_amount'] = 'Monto invalido', + ['no_player_nearby'] = 'no hay jugadores cerca', +['press_input_context_to_open_menu'] = 'presione ~INPUT_CONTEXT~ para abrir el ~g~Menú del banc ~s~.', + ['withdraw'] = 'retirar', + ['boss_actions'] = 'Acciones del jefe', + ['phone_receive'] = 'Cliente bancario', + ['phone_label'] = 'banco', diff --git a/locales/fi.lua b/locales/fi.lua new file mode 100644 index 00000000..2865bcb2 --- /dev/null +++ b/locales/fi.lua @@ -0,0 +1,18 @@ +Locales['fi'] = { + ['actions'] = 'toiminnot', + ['amount'] = 'määrä', + ['balance'] = 'balanssi', + ['bank'] = 'Pankki', + ['bill_amount'] = 'laskun määrä', + ['billing'] = 'laskutus', + ['customer'] = 'asiakas', + ['customers'] = 'asiakkaat', + ['deposit'] = 'talletus', + ['invalid_amount'] = 'virheellinen määrä', + ['no_player_nearby'] = 'ei pelaajia lähettyvillä', + ['press_input_context_to_open_menu'] = 'Paina ~INPUT_CONTEXT~ avataksesi valikon', + ['withdraw'] = 'nosta', + ['boss_actions'] = 'pomo valinnat', + ['phone_receive'] = 'pankin asiakas', + ['phone_label'] = 'bank', +} diff --git a/locales/fr.lua b/locales/fr.lua new file mode 100644 index 00000000..864c9ff4 --- /dev/null +++ b/locales/fr.lua @@ -0,0 +1,18 @@ +Locales['fr'] = { + ['actions'] = 'actions', + ['amount'] = 'montant', + ['balance'] = 'solde', + ['bank'] = 'banque', + ['bill_amount'] = 'montant de la facture', + ['billing'] = 'facturation', + ['customer'] = 'client', + ['customers'] = 'clients', + ['deposit'] = 'virement', + ['invalid_amount'] = 'montant invalide', + ['no_player_nearby'] = 'aucun joueur à proximité', + ['press_input_context_to_open_menu'] = 'appuyez sur ~INPUT_CONTEXT~ pour ouvrir le menu', + ['withdraw'] = 'retrait', + ['boss_actions'] = 'action Patron', + ['phone_receive'] = 'client Banque', + ['phone_label'] = 'banque', +} diff --git a/locales/sv.lua b/locales/sv.lua new file mode 100644 index 00000000..eaef4ade --- /dev/null +++ b/locales/sv.lua @@ -0,0 +1,18 @@ +Locales['sv'] = { + ['actions'] = 'handling', + ['amount'] = 'belopp', + ['balance'] = 'balans', + ['bank'] = 'bank', + ['bill_amount'] = 'räkning belopp', + ['billing'] = 'räkning', + ['customer'] = 'kund', + ['customers'] = 'kunder', + ['deposit'] = 'insättning', + ['invalid_amount'] = 'ogiltig belopp', + ['no_player_nearby'] = 'det hittades inga spelare i närheten.', + ['press_input_context_to_open_menu'] = 'tryck ~INPUT_CONTEXT~ för att öppna ~g~bankmenyn~s~.', + ['withdraw'] = 'ta ut', + ['boss_actions'] = 'chef handlingar', + ['phone_receive'] = 'bank meddelande mottaget', + ['phone_label'] = 'bank', +} diff --git a/localization/de_esx_bankerjob.sql b/localization/de_esx_bankerjob.sql new file mode 100644 index 00000000..155cc2a0 --- /dev/null +++ b/localization/de_esx_bankerjob.sql @@ -0,0 +1,18 @@ +USE `es_extended`; + +INSERT INTO `addon_account` (name, label, shared) VALUES + ('society_banker','Bank',1), + ('bank_savings','Bank',0) +; + +INSERT INTO `jobs` (name, label) VALUES + ('banker','Banker') +; + +INSERT INTO `job_grades` (job_name, grade, name, label, salary, skin_male, skin_female) VALUES + ('banker',0,'advisor','Berater',10,'{}','{}'), + ('banker',1,'banker','Banker',20,'{}','{}'), + ('banker',2,'business_banker','Business Banker',30,'{}','{}'), + ('banker',3,'trader','Trader',40,'{}','{}'), + ('banker',4,'boss','Boss',0,'{}','{}') +; diff --git a/localization/en_esx_bankerjob.sql b/localization/en_esx_bankerjob.sql new file mode 100644 index 00000000..6a5c75bf --- /dev/null +++ b/localization/en_esx_bankerjob.sql @@ -0,0 +1,18 @@ +USE `es_extended`; + +INSERT INTO `addon_account` (name, label, shared) VALUES + ('society_banker','Bank',1), + ('bank_savings','Bank Savings',0) +; + +INSERT INTO `jobs` (name, label) VALUES + ('banker','Banker') +; + +INSERT INTO `job_grades` (job_name, grade, name, label, salary, skin_male, skin_female) VALUES + ('banker',0,'advisor','Advisor',10,'{}','{}'), + ('banker',1,'banker','Banker',20,'{}','{}'), + ('banker',2,'business_banker','Business Banker',30,'{}','{}'), + ('banker',3,'trader','Trader',40,'{}','{}'), + ('banker',4,'boss','Lead Banker',0,'{}','{}') +; diff --git a/localization/esx_es_esx_bankerjob.sql b/localization/esx_es_esx_bankerjob.sql new file mode 100644 index 00000000..1b60b113 --- /dev/null +++ b/localization/esx_es_esx_bankerjob.sql @@ -0,0 +1,18 @@ +USE `essentialmode`; + +INSERT INTO `addon_account` (name, label, shared) VALUES + ('society_banker','Bank',1), + ('bank_savings','Ahorro bancario',0) +; + +INSERT INTO `jobs` (name, label) VALUES + ('banker','Banquero') +; + +INSERT INTO `job_grades` (job_name, grade, name, label, salary, skin_male, skin_female) VALUES + ('banker',0,'advisor','Asesores',10,'{}','{}'), + ('banker',1,'banker','Banquero',20,'{}','{}'), + ('banker',2,'business_banker','Banquero de negocios',30,'{}','{}'), + ('banker',3,'trader','Comerciante',40,'{}','{}'), + ('banker',4,'boss','Banquero principal',0,'{}','{}') +; diff --git a/localization/fi_esx_bankerjob.sql b/localization/fi_esx_bankerjob.sql new file mode 100644 index 00000000..fc78330f --- /dev/null +++ b/localization/fi_esx_bankerjob.sql @@ -0,0 +1,18 @@ +USE `es_extended`; + +INSERT INTO `addon_account` (name, label, shared) VALUES + ('society_banker','Pankki',1), + ('bank_savings','Pankki',0) +; + +INSERT INTO `jobs` (name, label) VALUES + ('banker','Pankkiiri') +; + +INSERT INTO `job_grades` (job_name, grade, name, label, salary, skin_male, skin_female) VALUES + ('banker',0,'advisor','Konsultti',10,'{}','{}'), + ('banker',1,'banker','Pankkiiri',20,'{}','{}'), + ('banker',2,'business_banker','Yritys Pankkiiri',30,'{}','{}'), + ('banker',3,'trader','Välittäjä',40,'{}','{}'), + ('banker',4,'boss','Pomo',0,'{}','{}') +; diff --git a/localization/sv_esx_bankerjob.sql b/localization/sv_esx_bankerjob.sql new file mode 100644 index 00000000..0b8e5876 --- /dev/null +++ b/localization/sv_esx_bankerjob.sql @@ -0,0 +1,18 @@ +USE `es_extended`; + +INSERT INTO `addon_account` (name, label, shared) VALUES + ('society_banker','Bank',1), + ('bank_savings','Bank',0) +; + +INSERT INTO `jobs` (name, label) VALUES + ('banker','Banktjänsteman') +; + +INSERT INTO `job_grades` (job_name, grade, name, label, salary, skin_male, skin_female) VALUES + ('banker',0,'advisor','Rådgivare',10,'{}','{}'), + ('banker',1,'banker','Banktjänsteman',20,'{}','{}'), + ('banker',2,'business_banker','Företagstjänsteman',30,'{}','{}'), + ('banker',3,'trader','Köpman',40,'{}','{}'), + ('banker',4,'boss','VD',0,'{}','{}') +; diff --git a/server/main.lua b/server/main.lua new file mode 100644 index 00000000..96f5130e --- /dev/null +++ b/server/main.lua @@ -0,0 +1,112 @@ +ESX = nil + +TriggerEvent('esx:getSharedObject', function(obj) ESX = obj end) + +TriggerEvent('esx_phone:registerNumber', 'banker', _('phone_receive'), false, false) +TriggerEvent('esx_society:registerSociety', 'banker', _U('phone_label'), 'society_banker', 'society_banker', 'society_banker', {type = 'public'}) + +RegisterServerEvent('esx_bankerjob:customerDeposit') +AddEventHandler('esx_bankerjob:customerDeposit', function (target, amount) + local xPlayer = ESX.GetPlayerFromId(target) + + TriggerEvent('esx_addonaccount:getSharedAccount', 'society_banker', function (account) + if amount > 0 and account.money >= amount then + account.removeMoney(amount) + + TriggerEvent('esx_addonaccount:getAccount', 'bank_savings', xPlayer.identifier, function (account) + account.addMoney(amount) + end) + else + TriggerClientEvent('esx:showNotification', xPlayer.source, _U('invalid_amount')) + end + end) +end) + +RegisterServerEvent('esx_bankerjob:customerWithdraw') +AddEventHandler('esx_bankerjob:customerWithdraw', function (target, amount) + local xPlayer = ESX.GetPlayerFromId(target) + + TriggerEvent('esx_addonaccount:getAccount', 'bank_savings', xPlayer.identifier, function (account) + if amount > 0 and account.money >= amount then + account.removeMoney(amount) + + TriggerEvent('esx_addonaccount:getSharedAccount', 'society_banker', function (account) + account.addMoney(amount) + end) + else + TriggerClientEvent('esx:showNotification', xPlayer.source, _U('invalid_amount')) + end + end) +end) + +ESX.RegisterServerCallback('esx_bankerjob:getCustomers', function (source, cb) + local xPlayers = ESX.GetPlayers() + local customers = {} + + for i=1, #xPlayers do + local xPlayer = ESX.GetPlayerFromId(xPlayers[i]) + + TriggerEvent('esx_addonaccount:getAccount', 'bank_savings', xPlayer.identifier, function(account) + table.insert(customers, { + source = xPlayer.source, + name = xPlayer.name, + bankSavings = account.money + }) + end) + end + + cb(customers) +end) + +function CalculateBankSavings(d, h, m) + local asyncTasks = {} + + MySQL.Async.fetchAll('SELECT * FROM addon_account_data WHERE account_name = @account_name', { + ['@account_name'] = 'bank_savings' + }, function(result) + local bankInterests = 0 + + for i=1, #result, 1 do + local xPlayer = ESX.GetPlayerFromIdentifier(result[i].owner) + + if xPlayer then + TriggerEvent('esx_addonaccount:getAccount', 'bank_savings', xPlayer.identifier, function(account) + local interests = math.floor(account.money / 100 * Config.BankSavingPercentage) + bankInterests = bankInterests + interests + + table.insert(asyncTasks, function(cb) + account.addMoney(interests) + end) + end) + else + local interests = math.floor(result[i].money / 100 * Config.BankSavingPercentage) + local newMoney = result[i].money + interests + bankInterests = bankInterests + interests + + local scope = function(newMoney, owner) + table.insert(asyncTasks, function(cb) + MySQL.Async.execute('UPDATE addon_account_data SET money = @money WHERE owner = @owner AND account_name = @account_name', { + ['@money'] = newMoney, + ['@owner'] = owner, + ['@account_name'] = 'bank_savings', + }, function(rowsChanged) + cb() + end) + end) + end + + scope(newMoney, result[i].owner) + end + end + + TriggerEvent('esx_addonaccount:getSharedAccount', 'society_banker', function(account) + account.addMoney(bankInterests) + end) + + Async.parallelLimit(asyncTasks, 5, function(results) + print('[BANK] Calculated interests') + end) + end) +end + +TriggerEvent('cron:runAt', 22, 0, CalculateBankSavings)