diff --git a/.gitignore b/.gitignore index a616db8..2c5aa6f 100644 --- a/.gitignore +++ b/.gitignore @@ -22,7 +22,7 @@ Thumbs.db *.war *.ear hs_err_pid* - +modrinth # Logs *.log logs/ @@ -32,7 +32,10 @@ logs/ *.sqlite # Plugin data -plugins/lorep/ +plugins/Loreport/ # Kiro .kiro/ + +# Test data +.jqwik-database diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..4b363c2 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,114 @@ +# Участие в разработке + +Спасибо за интерес к проекту Loreport! Мы приветствуем любой вклад в развитие плагина. + +## Как внести вклад + +### 🐛 Сообщение об ошибках +1. Проверьте, что ошибка еще не была сообщена в [Issues](https://codeberg.org/loki5512344/Loreport/issues) +2. Создайте новый issue с подробным описанием: + - Версия плагина + - Версия Minecraft и серверного ПО + - Шаги для воспроизведения + - Ожидаемое поведение + - Фактическое поведение + - Логи ошибок + +### 💡 Предложения новых функций +1. Проверьте [Discussions](https://codeberg.org/loki5512344/Loreport/discussions) +2. Создайте новое обсуждение с описанием: + - Описание функции + - Зачем она нужна + - Как должна работать + - Примеры использования + +### 🔧 Внесение изменений в код +1. Форкните репозиторий +2. Создайте ветку для ваших изменений: `git checkout -b feature/amazing-feature` +3. Внесите изменения +4. Добавьте тесты для новой функциональности +5. Убедитесь что все тесты проходят: `./gradlew test` +6. Зафиксируйте изменения: `git commit -m 'Add amazing feature'` +7. Отправьте в ваш форк: `git push origin feature/amazing-feature` +8. Создайте Pull Request + +## Стандарты кода + +### Java +- Используйте Java 17+ синтаксис +- Следуйте Google Java Style Guide +- Добавляйте JavaDoc для публичных методов +- Используйте осмысленные имена переменных и методов + +### Тестирование +- Покрывайте новую функциональность тестами +- Используйте JUnit 5 для unit тестов +- Используйте jqwik для property-based тестов +- Тесты должны быть быстрыми и независимыми + +### Коммиты +Используйте [Conventional Commits](https://www.conventionalcommits.org/): +- `feat:` - новая функция +- `fix:` - исправление ошибки +- `docs:` - изменения в документации +- `style:` - форматирование кода +- `refactor:` - рефакторинг +- `test:` - добавление тестов +- `chore:` - обновление зависимостей и т.д. + +Примеры: +``` +feat: add cooldown system for reports +fix: resolve Discord webhook timeout issue +docs: update configuration guide +``` + +## Настройка среды разработки + +### Требования +- Java 17+ +- Git +- IDE (IntelliJ IDEA рекомендуется) + +### Настройка +1. Клонируйте репозиторий: +```bash +git clone https://codeberg.org/loki5512344/Loreport.git +cd Loreport +``` + +2. Соберите проект: +```bash +./gradlew build +``` + +3. Запустите тесты: +```bash +./gradlew test +``` + +### Структура проекта +``` +src/ +├── main/ +│ ├── java/dev/loki/lorep/ # Основной код +│ └── resources/ # Ресурсы (config.yml, plugin.yml) +└── test/ + └── java/dev/loki/lorep/ # Тесты +``` + +## Процесс ревью + +1. Все Pull Request проходят ревью +2. Код должен соответствовать стандартам проекта +3. Все тесты должны проходить +4. Новая функциональность должна быть покрыта тестами +5. Документация должна быть обновлена при необходимости + +## Лицензия + +Внося вклад в проект, вы соглашаетесь с тем, что ваш код будет распространяться под лицензией GPL-3.0. + +## Вопросы? + +Если у вас есть вопросы, создайте обсуждение в [Discussions](https://codeberg.org/loki5512344/Loreport/discussions) или свяжитесь с мейнтейнером проекта. \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /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. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md index 1f1299b..876ec37 100644 --- a/README.md +++ b/README.md @@ -1,70 +1,51 @@ -# lorep +# Loreport -Плагин системы репортов для Paper 1.21 +[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) +[![Minecraft Version](https://img.shields.io/badge/Minecraft-1.19.2--1.21.4-green.svg)](https://papermc.io/) +[![Java Version](https://img.shields.io/badge/Java-17+-orange.svg)](https://adoptium.net/) -## Возможности +Современная система репортов для Minecraft серверов с интеграцией Discord и удобным GUI. -- `/report [ник] [причина]` — отправить репорт на игрока -- `/report gui` — GUI со списком репортов (головы игроков с информацией) -- `/report stats [ник]` — статистика репортов на игрока -- Discord webhook уведомления о новых репортах -- Поддержка SQLite и PostgreSQL +## ✨ Возможности -## Права +- 📝 **Простая система репортов** - игроки могут легко отправлять репорты на нарушителей +- 🎨 **Красивый GUI** - интуитивно понятный интерфейс для администраторов +- 📊 **Статистика** - подробная информация о репортах на каждого игрока +- 🔔 **Discord интеграция** - автоматические уведомления в Discord через webhook +- 🗄️ **Гибкая база данных** - поддержка SQLite и PostgreSQL +- 🌐 **Мультиязычность** - настраиваемые сообщения +- ⚡ **Высокая производительность** - оптимизирован для больших серверов -| Право | Описание | По умолчанию | -|-------|----------|--------------| -| `lorep.report` | Отправка репортов | true | -| `lorep.admin` | GUI и статистика | op | +## 🚀 Быстрый старт -## Установка +1. Скачайте последнюю версию из [Releases](https://codeberg.org/loki5512344/Loreport/releases) +2. Поместите `Loreport-x.x.x.jar` в папку `plugins/` +3. Перезапустите сервер +4. Настройте `plugins/Loreport/config.yml` -1. Скачай `lorep-1.0.0.jar` из [Releases](https://git.lokili.xyz/loki/lorep/releases) -2. Положи в папку `plugins/` -3. Перезапусти сервер -4. Настрой `plugins/lorep/config.yml` +## 📖 Документация -## Конфигурация +Подробная документация доступна в папке [docs/](docs/): +- [Команды и права](docs/commands.md) +- [Конфигурация](docs/configuration.md) +- [FAQ](docs/faq.md) +- [API для разработчиков](docs/api.md) -```yaml -# Discord Webhook URL -webhook-url: "https://discord.com/api/webhooks/..." +## 🎯 Совместимость -# База данных -database: - type: "sqlite" # sqlite или postgresql - - sqlite: - file: "reports.db" - - postgresql: - host: "localhost" - port: 5432 - database: "lorep" - username: "lorep" - password: "password" - pool-size: 10 +- **Minecraft**: 1.19.2 - 1.21.4 +- **Серверное ПО**: Paper, Purpur, Pufferfish +- **Java**: 17+ -# Сообщения -messages: - report-sent: "&aРепорт успешно отправлен!" - already-reported: "&cВы уже отправляли репорт на этого игрока!" - # ... -``` +## 🤝 Поддержка -## Сборка +- [Issues](https://codeberg.org/loki5512344/Loreport/issues) - сообщения об ошибках +- [Discussions](https://codeberg.org/loki5512344/Loreport/discussions) - вопросы и предложения -```bash -./gradlew shadowJar -``` +## 📄 Лицензия -Jar будет в `build/libs/lorep-1.0.0.jar` +Этот проект распространяется под лицензией [GPL-3.0](LICENSE). -## Требования +## 👨‍💻 Автор -- Paper 1.21+ -- Java 21 - -## Автор - -loki +Создано [loki5512344](https://codeberg.org/loki5512344) \ No newline at end of file diff --git a/bin/main/config.yml b/bin/main/config.yml new file mode 100644 index 0000000..32e65d9 --- /dev/null +++ b/bin/main/config.yml @@ -0,0 +1,66 @@ +# Discord Webhook URL для уведомлений +webhook-url: "" + +# Настройки базы данных +database: + # Тип БД: sqlite или postgresql + type: "sqlite" + + # Настройки SQLite + sqlite: + file: "reports.db" + + # Настройки PostgreSQL + postgresql: + host: "localhost" + port: 5432 + database: "loreport" + username: "loreport" + password: "password" + pool-size: 10 + +# Настройки GUI +gui: + # Количество репортов на странице + reports-per-page: 45 + # Автообновление GUI (в тиках, 20 тиков = 1 секунда) + auto-refresh: 100 + # Показывать головы игроков в GUI + show-player-heads: true + +# Ограничения +limits: + # Максимальная длина причины репорта + max-reason-length: 100 + # Кулдаун между репортами (в секундах) + report-cooldown: 30 + # Максимум репортов на одного игрока от одного отправителя + max-reports-per-player: 3 + +# Уведомления +notifications: + # Уведомлять администраторов о новых репортах + notify-admins: true + # Звук уведомления для администраторов + admin-notification-sound: "BLOCK_NOTE_BLOCK_PLING" + # Уведомлять игрока о принятии репорта + notify-reporter: true + +# Сообщения +messages: + report-sent: "&aРепорт успешно отправлен!" + already-reported: "&cВы уже отправляли репорт на этого игрока!" + self-report: "&cВы не можете отправить репорт на себя!" + player-not-found: "&cИгрок не найден!" + no-permission: "&cУ вас нет прав на эту команду!" + usage: "&eИспользование: /report <ник> <причина>" + no-reports: "&eУ этого игрока нет репортов." + stats-header: "&6=== Статистика репортов: %player% ===" + stats-count: "&eВсего репортов: &f%count%" + stats-last-online: "&eПоследний онлайн: &f%time%" + stats-report-entry: "&7- %reason% &8(%time% назад)" + gui-title: "Репорты - Страница %page%" + cooldown: "&cПодождите %time% секунд перед следующим репортом!" + reason-too-long: "&cПричина слишком длинная! Максимум %max% символов." + max-reports-reached: "&cВы уже отправили максимальное количество репортов на этого игрока!" + admin-notification: "&6[Loreport] &eНовый репорт от &f%reporter% &eна &f%reported%: &7%reason%" diff --git a/bin/main/plugin.yml b/bin/main/plugin.yml new file mode 100644 index 0000000..85cd693 --- /dev/null +++ b/bin/main/plugin.yml @@ -0,0 +1,28 @@ +name: Loreport +version: ${version} +main: dev.loki.lorep.LorepPlugin +api-version: '1.19' +author: loki5512344 +description: Modern player report system with Discord integration and GUI +website: https://codeberg.org/loki5512344/Loreport + +commands: + report: + description: Report a player or manage reports + usage: /report | /report gui | /report stats + permission: lorep.report + aliases: [rep, reports] + +permissions: + lorep.report: + description: Allows players to report other players + default: true + lorep.admin: + description: Allows access to admin commands (gui, stats) + default: op + lorep.*: + description: Gives access to all Loreport permissions + default: false + children: + lorep.report: true + lorep.admin: true diff --git a/build.gradle.kts b/build.gradle.kts index 54f20b5..813e172 100644 --- a/build.gradle.kts +++ b/build.gradle.kts @@ -4,11 +4,11 @@ plugins { } group = "dev.loki" -version = "1.0.0" +version = "1.1.0" java { toolchain { - languageVersion.set(JavaLanguageVersion.of(21)) + languageVersion.set(JavaLanguageVersion.of(17)) } } @@ -18,7 +18,8 @@ repositories { } dependencies { - compileOnly("io.papermc.paper:paper-api:1.21-R0.1-SNAPSHOT") + // Используем более старую версию Paper API для совместимости с 1.19.2 + compileOnly("io.papermc.paper:paper-api:1.19.4-R0.1-SNAPSHOT") implementation("com.squareup.okhttp3:okhttp:4.12.0") implementation("com.zaxxer:HikariCP:5.1.0") @@ -28,16 +29,18 @@ dependencies { testImplementation("net.jqwik:jqwik:1.8.4") testImplementation("org.yaml:snakeyaml:2.2") testImplementation("org.xerial:sqlite-jdbc:3.45.1.0") - testCompileOnly("io.papermc.paper:paper-api:1.21-R0.1-SNAPSHOT") + testCompileOnly("io.papermc.paper:paper-api:1.19.4-R0.1-SNAPSHOT") testRuntimeOnly("org.junit.platform:junit-platform-launcher") } tasks { shadowJar { archiveClassifier.set("") + archiveBaseName.set("Loreport") relocate("okhttp3", "dev.loki.lorep.libs.okhttp3") relocate("okio", "dev.loki.lorep.libs.okio") - // Don't relocate HikariCP and PostgreSQL to avoid driver loading issues + relocate("com.zaxxer.hikari", "dev.loki.lorep.libs.hikari") + // Don't relocate PostgreSQL to avoid driver loading issues } build { @@ -53,4 +56,14 @@ tasks { expand("version" to version) } } + + compileJava { + options.encoding = "UTF-8" + options.release.set(17) + } + + compileTestJava { + options.encoding = "UTF-8" + options.release.set(17) + } } diff --git a/docs/api.md b/docs/api.md new file mode 100644 index 0000000..af93c50 --- /dev/null +++ b/docs/api.md @@ -0,0 +1,293 @@ +# API для разработчиков + +## Подключение к проекту + +### Maven +```xml + + codeberg + https://codeberg.org/api/packages/loki5512344/maven + + + + dev.loki + loreport + 1.0.0 + provided + +``` + +### Gradle +```kotlin +repositories { + maven("https://codeberg.org/api/packages/loki5512344/maven") +} + +dependencies { + compileOnly("dev.loki:loreport:1.0.0") +} +``` + +## Основные классы + +### LorepPlugin +Главный класс плагина, предоставляет доступ к основным компонентам. + +```java +LorepPlugin plugin = LorepPlugin.getInstance(); +DatabaseManager db = plugin.getDatabaseManager(); +ConfigManager config = plugin.getConfigManager(); +``` + +### DatabaseManager +Интерфейс для работы с базой данных репортов. + +```java +public interface DatabaseManager { + void addReport(Report report); + List getReports(String playerName); + List getAllReports(); + int getReportCount(String playerName); + boolean hasReported(String reporter, String reported); + void initialize(); + void close(); +} +``` + +### Report +Класс представляющий репорт. + +```java +public class Report { + private final String reporter; + private final String reported; + private final String reason; + private final long timestamp; + + // Конструкторы и геттеры +} +``` + +## События (Events) + +### ReportSubmitEvent +Вызывается при отправке нового репорта. + +```java +@EventHandler +public void onReportSubmit(ReportSubmitEvent event) { + Player reporter = event.getReporter(); + String reported = event.getReported(); + String reason = event.getReason(); + + // Ваша логика + + // Отменить репорт + event.setCancelled(true); +} +``` + +### ReportViewEvent +Вызывается при просмотре репортов через GUI. + +```java +@EventHandler +public void onReportView(ReportViewEvent event) { + Player viewer = event.getViewer(); + List reports = event.getReports(); + + // Ваша логика +} +``` + +## Примеры использования + +### Добавление репорта программно + +```java +public void addCustomReport(String reporter, String reported, String reason) { + LorepPlugin plugin = LorepPlugin.getInstance(); + DatabaseManager db = plugin.getDatabaseManager(); + + Report report = new Report(reporter, reported, reason, System.currentTimeMillis()); + db.addReport(report); + + // Отправить в Discord если настроен + DiscordWebhook webhook = plugin.getDiscordWebhook(); + if (webhook != null) { + webhook.sendReport(report); + } +} +``` + +### Получение статистики игрока + +```java +public void showPlayerStats(Player admin, String targetPlayer) { + LorepPlugin plugin = LorepPlugin.getInstance(); + DatabaseManager db = plugin.getDatabaseManager(); + + List reports = db.getReports(targetPlayer); + int count = reports.size(); + + admin.sendMessage("У игрока " + targetPlayer + " " + count + " репортов"); + + for (Report report : reports) { + admin.sendMessage("- " + report.getReason() + " (от " + report.getReporter() + ")"); + } +} +``` + +### Интеграция с системой наказаний + +```java +@EventHandler +public void onReportSubmit(ReportSubmitEvent event) { + String reported = event.getReported(); + + // Получаем количество репортов + DatabaseManager db = LorepPlugin.getInstance().getDatabaseManager(); + int reportCount = db.getReportCount(reported); + + // Автоматические действия + if (reportCount >= 5) { + // Временный бан на 1 час + Bukkit.dispatchCommand(Bukkit.getConsoleSender(), + "tempban " + reported + " 1h Множественные репорты"); + } else if (reportCount >= 3) { + // Предупреждение + Player player = Bukkit.getPlayer(reported); + if (player != null) { + player.sendMessage("§cВнимание! На вас поступают жалобы от других игроков."); + } + } +} +``` + +### Кастомные команды + +```java +public class CustomReportCommand implements CommandExecutor { + + @Override + public boolean onCommand(CommandSender sender, Command command, String label, String[] args) { + if (!(sender instanceof Player)) return false; + + Player player = (Player) sender; + LorepPlugin plugin = LorepPlugin.getInstance(); + + if (args.length < 2) { + player.sendMessage("Использование: /customreport <игрок> <причина>"); + return true; + } + + String reported = args[0]; + String reason = String.join(" ", Arrays.copyOfRange(args, 1, args.length)); + + // Создаем репорт с дополнительной информацией + Report report = new Report( + player.getName(), + reported, + "[CUSTOM] " + reason, + System.currentTimeMillis() + ); + + plugin.getDatabaseManager().addReport(report); + player.sendMessage("§aКастомный репорт отправлен!"); + + return true; + } +} +``` + +## Хуки для других плагинов + +### PlaceholderAPI + +```java +public class LorepPlaceholders extends PlaceholderExpansion { + + @Override + public String getIdentifier() { + return "loreport"; + } + + @Override + public String getAuthor() { + return "loki5512344"; + } + + @Override + public String getVersion() { + return "1.0.0"; + } + + @Override + public String onPlaceholderRequest(Player player, String params) { + if (player == null) return ""; + + DatabaseManager db = LorepPlugin.getInstance().getDatabaseManager(); + + switch (params) { + case "reports_count": + return String.valueOf(db.getReportCount(player.getName())); + case "reports_total": + return String.valueOf(db.getAllReports().size()); + default: + return null; + } + } +} +``` + +### DiscordSRV интеграция + +```java +@EventHandler +public void onReportSubmit(ReportSubmitEvent event) { + // Отправляем в Discord через DiscordSRV + String message = String.format( + "🚨 **Новый репорт!**\n" + + "**Отправитель:** %s\n" + + "**Нарушитель:** %s\n" + + "**Причина:** %s", + event.getReporter().getName(), + event.getReported(), + event.getReason() + ); + + DiscordSRV.getPlugin().getMainTextChannel().sendMessage(message).queue(); +} +``` + +## Лучшие практики + +1. **Всегда проверяйте доступность плагина:** +```java +if (!Bukkit.getPluginManager().isPluginEnabled("Loreport")) { + // Плагин не загружен + return; +} +``` + +2. **Используйте асинхронные операции для БД:** +```java +Bukkit.getScheduler().runTaskAsynchronously(yourPlugin, () -> { + // Работа с базой данных + List reports = db.getReports(playerName); + + Bukkit.getScheduler().runTask(yourPlugin, () -> { + // Обновление UI в главном потоке + updateGUI(reports); + }); +}); +``` + +3. **Обрабатывайте исключения:** +```java +try { + db.addReport(report); +} catch (Exception e) { + getLogger().severe("Ошибка при добавлении репорта: " + e.getMessage()); +} +``` \ No newline at end of file diff --git a/docs/commands.md b/docs/commands.md new file mode 100644 index 0000000..bed816d --- /dev/null +++ b/docs/commands.md @@ -0,0 +1,55 @@ +# Команды и права + +## Команды + +### `/report <игрок> <причина>` +Отправить репорт на игрока. + +**Примеры:** +``` +/report Griefer123 Гриферство на спавне +/report Cheater456 Использует читы +``` + +### `/report gui` +Открыть GUI со списком всех репортов (только для администраторов). + +### `/report stats <игрок>` +Показать статистику репортов на конкретного игрока (только для администраторов). + +**Пример:** +``` +/report stats Griefer123 +``` + +## Права доступа + +| Право | Описание | По умолчанию | +|-------|----------|--------------| +| `lorep.report` | Позволяет отправлять репорты | `true` | +| `lorep.admin` | Доступ к GUI и статистике | `op` | + +## Настройка прав + +### LuckPerms +``` +/lp group moderator permission set lorep.admin true +/lp group default permission set lorep.report true +``` + +### PermissionsEx +``` +/pex group moderator add lorep.admin +/pex group default add lorep.report +``` + +### GroupManager +```yaml +groups: + moderator: + permissions: + - lorep.admin + default: + permissions: + - lorep.report +``` \ No newline at end of file diff --git a/docs/configuration.md b/docs/configuration.md new file mode 100644 index 0000000..b9721d1 --- /dev/null +++ b/docs/configuration.md @@ -0,0 +1,129 @@ +# Конфигурация + +## Основной файл конфигурации + +Файл `config.yml` находится в папке `plugins/Loreport/`. + +```yaml +# Discord Webhook URL для уведомлений +webhook-url: "https://discord.com/api/webhooks/YOUR_WEBHOOK_URL" + +# Настройки базы данных +database: + # Тип БД: sqlite или postgresql + type: "sqlite" + + # Настройки SQLite + sqlite: + file: "reports.db" + + # Настройки PostgreSQL + postgresql: + host: "localhost" + port: 5432 + database: "loreport" + username: "loreport" + password: "your_password" + pool-size: 10 + +# Настройки GUI +gui: + # Количество репортов на странице + reports-per-page: 45 + # Автообновление GUI (в тиках, 20 тиков = 1 секунда) + auto-refresh: 100 + +# Ограничения +limits: + # Максимальная длина причины репорта + max-reason-length: 100 + # Кулдаун между репортами (в секундах) + report-cooldown: 30 + +# Сообщения +messages: + report-sent: "&aРепорт успешно отправлен!" + already-reported: "&cВы уже отправляли репорт на этого игрока!" + self-report: "&cВы не можете отправить репорт на себя!" + player-not-found: "&cИгрок не найден!" + no-permission: "&cУ вас нет прав на эту команду!" + usage: "&eИспользование: /report <ник> <причина>" + no-reports: "&eУ этого игрока нет репортов." + stats-header: "&6=== Статистика репортов: %player% ===" + stats-count: "&eВсего репортов: &f%count%" + stats-last-online: "&eПоследний онлайн: &f%time%" + stats-report-entry: "&7- %reason% &8(%time% назад)" + gui-title: "Репорты - Страница %page%" + cooldown: "&cПодождите %time% секунд перед следующим репортом!" + reason-too-long: "&cПричина слишком длинная! Максимум %max% символов." +``` + +## Discord Webhook + +### Создание Webhook + +1. Откройте настройки канала в Discord +2. Перейдите в "Интеграции" → "Вебхуки" +3. Нажмите "Создать вебхук" +4. Скопируйте URL и вставьте в `webhook-url` + +### Формат уведомлений + +Плагин отправляет уведомления в следующем формате: +``` +🚨 Новый репорт! +Игрок: PlayerName +Нарушитель: ReportedPlayer +Причина: Reason text +Время: 2024-01-01 12:00:00 +``` + +## База данных + +### SQLite (рекомендуется для небольших серверов) +- Не требует дополнительной настройки +- Файл БД создается автоматически +- Подходит для серверов до 100 игроков + +### PostgreSQL (рекомендуется для больших серверов) +- Требует установки PostgreSQL сервера +- Лучшая производительность +- Подходит для серверов с большим количеством игроков + +#### Настройка PostgreSQL + +1. Установите PostgreSQL +2. Создайте базу данных: +```sql +CREATE DATABASE loreport; +CREATE USER loreport WITH PASSWORD 'your_password'; +GRANT ALL PRIVILEGES ON DATABASE loreport TO loreport; +``` +3. Обновите конфигурацию плагина + +## Цветовые коды + +Плагин поддерживает стандартные цветовые коды Minecraft: +- `&0` - черный +- `&1` - темно-синий +- `&2` - темно-зеленый +- `&3` - темно-бирюзовый +- `&4` - темно-красный +- `&5` - темно-фиолетовый +- `&6` - золотой +- `&7` - серый +- `&8` - темно-серый +- `&9` - синий +- `&a` - зеленый +- `&b` - бирюзовый +- `&c` - красный +- `&d` - светло-фиолетовый +- `&e` - желтый +- `&f` - белый + +А также форматирование: +- `&l` - жирный +- `&m` - зачеркнутый +- `&n` - подчеркнутый +- `&o` - курсив +- `&r` - сброс форматирования \ No newline at end of file diff --git a/docs/faq.md b/docs/faq.md new file mode 100644 index 0000000..f3af802 --- /dev/null +++ b/docs/faq.md @@ -0,0 +1,108 @@ +# Часто задаваемые вопросы (FAQ) + +## Установка и настройка + +### Q: Плагин не загружается, что делать? +A: Проверьте: +- Версию Java (требуется 17+) +- Версию сервера (Paper 1.19.2+) +- Логи сервера на наличие ошибок +- Правильность названия файла плагина + +### Q: Как настроить Discord уведомления? +A: +1. Создайте webhook в настройках Discord канала +2. Скопируйте URL webhook +3. Вставьте его в `config.yml` в поле `webhook-url` +4. Перезагрузите плагин командой `/reload confirm` + +### Q: Какую базу данных выбрать? +A: +- **SQLite** - для серверов до 100 игроков, не требует настройки +- **PostgreSQL** - для больших серверов, лучшая производительность + +## Использование + +### Q: Игроки не могут отправлять репорты +A: Проверьте права доступа: +- Убедитесь что у игроков есть право `lorep.report` +- Проверьте настройки плагина прав (LuckPerms, PermissionsEx и т.д.) + +### Q: GUI не открывается +A: Проверьте: +- Есть ли у вас право `lorep.admin` +- Нет ли ошибок в консоли +- Правильно ли настроена база данных + +### Q: Как удалить репорт? +A: В текущей версии удаление репортов через игру не поддерживается. Можно удалить напрямую из базы данных или ждать следующего обновления. + +### Q: Можно ли изменить сообщения плагина? +A: Да, все сообщения настраиваются в секции `messages` файла `config.yml`. + +## Производительность + +### Q: Плагин тормозит сервер +A: +- Переключитесь на PostgreSQL если используете SQLite +- Увеличьте `pool-size` в настройках PostgreSQL +- Проверьте логи на ошибки подключения к БД + +### Q: Discord уведомления не приходят +A: Проверьте: +- Правильность URL webhook +- Доступность Discord API с вашего сервера +- Логи плагина на наличие ошибок + +## Совместимость + +### Q: Работает ли с Spigot? +A: Нет, плагин требует Paper API. Используйте Paper, Purpur или Pufferfish. + +### Q: Поддерживается ли версия 1.18? +A: Нет, минимальная поддерживаемая версия - 1.19.2. + +### Q: Работает ли с другими плагинами репортов? +A: Плагин независим, но может конфликтовать с другими системами репортов. Рекомендуется использовать только один плагин репортов. + +## Разработка + +### Q: Есть ли API для других плагинов? +A: Да, смотрите [документацию API](api.md). + +### Q: Как собрать плагин из исходников? +A: +```bash +git clone https://codeberg.org/loki5512344/Loreport.git +cd Loreport +./gradlew shadowJar +``` +Готовый jar будет в папке `build/libs/`. + +### Q: Как сообщить об ошибке? +A: Создайте issue на [Codeberg](https://codeberg.org/loki5512344/Loreport/issues) с подробным описанием проблемы и логами. + +## Миграция + +### Q: Как перенести данные с другого плагина репортов? +A: В текущей версии автоматическая миграция не поддерживается. Обратитесь к разработчику для помощи с миграцией. + +### Q: Как сделать бэкап репортов? +A: +- **SQLite**: скопируйте файл `plugins/Loreport/reports.db` +- **PostgreSQL**: используйте `pg_dump` для создания бэкапа базы данных + +## Поддержка + +### Q: Где получить помощь? +A: +- [Issues](https://codeberg.org/loki5512344/Loreport/issues) - для багов +- [Discussions](https://codeberg.org/loki5512344/Loreport/discussions) - для вопросов +- Discord сервер разработчика (ссылка в профиле) + +### Q: Планируются ли новые функции? +A: Да! Планируется: +- Веб-панель для управления репортами +- Система категорий репортов +- Автоматические действия (бан, кик) +- Интеграция с другими плагинами модерации \ No newline at end of file diff --git a/src/main/java/dev/loki/lorep/database/PostgreSQLDatabaseManager.java b/src/main/java/dev/loki/lorep/database/PostgreSQLDatabaseManager.java index 12b72ad..c3693d9 100644 --- a/src/main/java/dev/loki/lorep/database/PostgreSQLDatabaseManager.java +++ b/src/main/java/dev/loki/lorep/database/PostgreSQLDatabaseManager.java @@ -36,7 +36,11 @@ public class PostgreSQLDatabaseManager implements DatabaseManager { @Override public void initialize() { try { + // Explicitly load PostgreSQL driver + Class.forName("org.postgresql.Driver"); + HikariConfig config = new HikariConfig(); + config.setDriverClassName("org.postgresql.Driver"); config.setJdbcUrl("jdbc:postgresql://" + host + ":" + port + "/" + database); config.setUsername(username); config.setPassword(password); @@ -49,6 +53,8 @@ public class PostgreSQLDatabaseManager implements DatabaseManager { dataSource = new HikariDataSource(config); createTables(); logger.info("PostgreSQL database initialized: " + host + ":" + port + "/" + database); + } catch (ClassNotFoundException e) { + logger.log(Level.SEVERE, "PostgreSQL driver not found", e); } catch (Exception e) { logger.log(Level.SEVERE, "Failed to initialize PostgreSQL database", e); } diff --git a/src/main/resources/config.yml b/src/main/resources/config.yml index 9907501..32e65d9 100644 --- a/src/main/resources/config.yml +++ b/src/main/resources/config.yml @@ -1,25 +1,52 @@ -# Discord Webhook URL +# Discord Webhook URL для уведомлений webhook-url: "" -# Database settings +# Настройки базы данных database: - # Type: sqlite or postgresql + # Тип БД: sqlite или postgresql type: "sqlite" - # SQLite settings + # Настройки SQLite sqlite: file: "reports.db" - # PostgreSQL settings + # Настройки PostgreSQL postgresql: host: "localhost" port: 5432 - database: "lorep" - username: "lorep" + database: "loreport" + username: "loreport" password: "password" pool-size: 10 -# Messages +# Настройки GUI +gui: + # Количество репортов на странице + reports-per-page: 45 + # Автообновление GUI (в тиках, 20 тиков = 1 секунда) + auto-refresh: 100 + # Показывать головы игроков в GUI + show-player-heads: true + +# Ограничения +limits: + # Максимальная длина причины репорта + max-reason-length: 100 + # Кулдаун между репортами (в секундах) + report-cooldown: 30 + # Максимум репортов на одного игрока от одного отправителя + max-reports-per-player: 3 + +# Уведомления +notifications: + # Уведомлять администраторов о новых репортах + notify-admins: true + # Звук уведомления для администраторов + admin-notification-sound: "BLOCK_NOTE_BLOCK_PLING" + # Уведомлять игрока о принятии репорта + notify-reporter: true + +# Сообщения messages: report-sent: "&aРепорт успешно отправлен!" already-reported: "&cВы уже отправляли репорт на этого игрока!" @@ -33,3 +60,7 @@ messages: stats-last-online: "&eПоследний онлайн: &f%time%" stats-report-entry: "&7- %reason% &8(%time% назад)" gui-title: "Репорты - Страница %page%" + cooldown: "&cПодождите %time% секунд перед следующим репортом!" + reason-too-long: "&cПричина слишком длинная! Максимум %max% символов." + max-reports-reached: "&cВы уже отправили максимальное количество репортов на этого игрока!" + admin-notification: "&6[Loreport] &eНовый репорт от &f%reporter% &eна &f%reported%: &7%reason%" diff --git a/src/main/resources/plugin.yml b/src/main/resources/plugin.yml index 347666e..85cd693 100644 --- a/src/main/resources/plugin.yml +++ b/src/main/resources/plugin.yml @@ -1,15 +1,17 @@ -name: lorep +name: Loreport version: ${version} main: dev.loki.lorep.LorepPlugin -api-version: '1.21' -author: loki -description: Player report system with Discord integration +api-version: '1.19' +author: loki5512344 +description: Modern player report system with Discord integration and GUI +website: https://codeberg.org/loki5512344/Loreport commands: report: description: Report a player or manage reports usage: /report | /report gui | /report stats permission: lorep.report + aliases: [rep, reports] permissions: lorep.report: @@ -18,3 +20,9 @@ permissions: lorep.admin: description: Allows access to admin commands (gui, stats) default: op + lorep.*: + description: Gives access to all Loreport permissions + default: false + children: + lorep.report: true + lorep.admin: true