diff --git a/.gitignore b/.gitignore index 9563893..12f8644 100644 --- a/.gitignore +++ b/.gitignore @@ -1,25 +1,25 @@ -# gradle - -.gradle/ -build/ -out/ -classes/ - -# idea - -.idea/ -*.iml -*.ipr -*.iws - -# vscode - -.settings/ -.vscode/ -bin/ +# eclipse +bin +*.launch +.settings +.metadata .classpath .project -# fabric +# idea +out +*.ipr +*.iws +*.iml +.idea -run/ \ No newline at end of file +# gradle +build +.gradle + +# other +eclipse +run + +# Files from Forge MDK +forge*changelog.txt diff --git a/CREDITS.txt b/CREDITS.txt new file mode 100644 index 0000000..a70c53d --- /dev/null +++ b/CREDITS.txt @@ -0,0 +1,65 @@ +Minecraft Forge: Credits/Thank You + +Forge is a set of tools and modifications to the Minecraft base game code to assist +mod developers in creating new and exciting content. It has been in development for +several years now, but I would like to take this time thank a few people who have +helped it along it's way. + +First, the people who originally created the Forge projects way back in Minecraft +alpha. Eloraam of RedPower, and SpaceToad of Buildcraft, without their acceptiance +of me taking over the project, who knows what Minecraft modding would be today. + +Secondly, someone who has worked with me, and developed some of the core features +that allow modding to be as functional, and as simple as it is, cpw. For developing +FML, which stabelized the client and server modding ecosystem. As well as the base +loading system that allows us to modify Minecraft's code as elegently as possible. + +Mezz, who has stepped up as the issue and pull request manager. Helping to keep me +sane as well as guiding the community into creating better additions to Forge. + +Searge, Bspks, Fesh0r, ProfMobious, and all the rest over on the MCP team {of which +I am a part}. For creating some of the core tools needed to make Minecraft modding +both possible, and as stable as can be. + On that note, here is some specific information of the MCP data we use: + * Minecraft Coder Pack (MCP) * + Forge Mod Loader and Minecraft Forge have permission to distribute and automatically + download components of MCP and distribute MCP data files. This permission is not + transitive and others wishing to redistribute the Minecraft Forge source independently + should seek permission of MCP or remove the MCP data files and request their users + to download MCP separately. + +And lastly, the countless community members who have spent time submitting bug reports, +pull requests, and just helping out the community in general. Thank you. + +--LexManos + +========================================================================= + +This is Forge Mod Loader. + +You can find the source code at all times at https://github.com/MinecraftForge/MinecraftForge/tree/1.12.x/src/main/java/net/minecraftforge/fml + +This minecraft mod is a clean open source implementation of a mod loader for minecraft servers +and minecraft clients. + +The code is authored by cpw. + +It began by partially implementing an API defined by the client side ModLoader, authored by Risugami. +http://www.minecraftforum.net/topic/75440- +This support has been dropped as of Minecraft release 1.7, as Risugami no longer maintains ModLoader. + +It also contains suggestions and hints and generous helpings of code from LexManos, author of MinecraftForge. +http://www.minecraftforge.net/ + +Additionally, it contains an implementation of topological sort based on that +published at http://keithschwarz.com/interesting/code/?dir=topological-sort + +It also contains code from the Maven project for performing versioned dependency +resolution. http://maven.apache.org/ + +It also contains a partial repackaging of the javaxdelta library from http://sourceforge.net/projects/javaxdelta/ +with credit to it's authors. + +Forge Mod Loader downloads components from the Minecraft Coder Pack +(http://mcp.ocean-labs.de/index.php/Main_Page) with kind permission from the MCP team. + diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..b0cbe2b --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,520 @@ +Unless noted below, Minecraft Forge, Forge Mod Loader, and all +parts herein are licensed under the terms of the LGPL 2.1 found +here http://www.gnu.org/licenses/old-licenses/lgpl-2.1.txt and +copied below. + +Homepage: http://minecraftforge.net/ + https://github.com/MinecraftForge/MinecraftForge + + +A note on authorship: +All source artifacts are property of their original author, with +the exclusion of the contents of the patches directory and others +copied from it from time to time. Authorship of the contents of +the patches directory is retained by the Minecraft Forge project. +This is because the patches are partially machine generated +artifacts, and are changed heavily due to the way forge works. +Individual attribution within them is impossible. + +Consent: +All contributions to Forge must consent to the release of any +patch content to the Forge project. + +A note on infectivity: +The LGPL is chosen specifically so that projects may depend on Forge +features without being infected with its license. That is the +purpose of the LGPL. Mods and others using this code via ordinary +Java mechanics for referencing libraries are specifically not bound +by Forge's license for the Mod code. + + +=== MCP Data === +This software includes data from the Minecraft Coder Pack (MCP), with kind permission +from them. The license to MCP data is not transitive - distribution of this data by +third parties requires independent licensing from the MCP team. This data is not +redistributable without permission from the MCP team. + +=== Sharing === +I grant permission for some parts of FML to be redistributed outside the terms of the LGPL, for the benefit of +the minecraft modding community. All contributions to these parts should be licensed under the same additional grant. + +-- Runtime patcher -- +License is granted to redistribute the runtime patcher code (src/main/java/net/minecraftforge/fml/common/patcher +and subdirectories) under any alternative open source license as classified by the OSI (http://opensource.org/licenses) + +-- ASM transformers -- +License is granted to redistribute the ASM transformer code (src/main/java/net/minecraftforge/common/asm/ and subdirectories) +under any alternative open source license as classified by the OSI (http://opensource.org/licenses) + +========================================================================= +This software includes portions from the Apache Maven project at +http://maven.apache.org/ specifically the ComparableVersion.java code. It is +included based on guidelines at +http://www.softwarefreedom.org/resources/2007/gpl-non-gpl-collaboration.html +with notices intact. The only change is a non-functional change of package name. + +This software contains a partial repackaging of javaxdelta, a BSD licensed program for generating +binary differences and applying them, sourced from the subversion at http://sourceforge.net/projects/javaxdelta/ +authored by genman, heikok, pivot. +The only changes are to replace some Trove collection types with standard Java collections, and repackaged. +========================================================================= + + + GNU LESSER GENERAL PUBLIC LICENSE + Version 2.1, February 1999 + + Copyright (C) 1991, 1999 Free Software Foundation, Inc. + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + +[This is the first released version of the Lesser GPL. It also counts + as the successor of the GNU Library Public License, version 2, hence + the version number 2.1.] + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +Licenses are intended to guarantee your freedom to share and change +free software--to make sure the software is free for all its users. + + This license, the Lesser General Public License, applies to some +specially designated software packages--typically libraries--of the +Free Software Foundation and other authors who decide to use it. You +can use it too, but we suggest you first think carefully about whether +this license or the ordinary General Public License is the better +strategy to use in any particular case, based on the explanations below. + + When we speak of free software, we are referring to freedom of use, +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 this service if you wish); that you receive source code or can get +it if you want it; that you can change the software and use pieces of +it in new free programs; and that you are informed that you can do +these things. + + To protect your rights, we need to make restrictions that forbid +distributors to deny you these rights or to ask you to surrender these +rights. These restrictions translate to certain responsibilities for +you if you distribute copies of the library or if you modify it. + + For example, if you distribute copies of the library, whether gratis +or for a fee, you must give the recipients all the rights that we gave +you. You must make sure that they, too, receive or can get the source +code. If you link other code with the library, you must provide +complete object files to the recipients, so that they can relink them +with the library after making changes to the library and recompiling +it. And you must show them these terms so they know their rights. + + We protect your rights with a two-step method: (1) we copyright the +library, and (2) we offer you this license, which gives you legal +permission to copy, distribute and/or modify the library. + + To protect each distributor, we want to make it very clear that +there is no warranty for the free library. Also, if the library is +modified by someone else and passed on, the recipients should know +that what they have is not the original version, so that the original +author's reputation will not be affected by problems that might be +introduced by others. + + Finally, software patents pose a constant threat to the existence of +any free program. We wish to make sure that a company cannot +effectively restrict the users of a free program by obtaining a +restrictive license from a patent holder. Therefore, we insist that +any patent license obtained for a version of the library must be +consistent with the full freedom of use specified in this license. + + Most GNU software, including some libraries, is covered by the +ordinary GNU General Public License. This license, the GNU Lesser +General Public License, applies to certain designated libraries, and +is quite different from the ordinary General Public License. We use +this license for certain libraries in order to permit linking those +libraries into non-free programs. + + When a program is linked with a library, whether statically or using +a shared library, the combination of the two is legally speaking a +combined work, a derivative of the original library. The ordinary +General Public License therefore permits such linking only if the +entire combination fits its criteria of freedom. The Lesser General +Public License permits more lax criteria for linking other code with +the library. + + We call this license the "Lesser" General Public License because it +does Less to protect the user's freedom than the ordinary General +Public License. It also provides other free software developers Less +of an advantage over competing non-free programs. These disadvantages +are the reason we use the ordinary General Public License for many +libraries. However, the Lesser license provides advantages in certain +special circumstances. + + For example, on rare occasions, there may be a special need to +encourage the widest possible use of a certain library, so that it becomes +a de-facto standard. To achieve this, non-free programs must be +allowed to use the library. A more frequent case is that a free +library does the same job as widely used non-free libraries. In this +case, there is little to gain by limiting the free library to free +software only, so we use the Lesser General Public License. + + In other cases, permission to use a particular library in non-free +programs enables a greater number of people to use a large body of +free software. For example, permission to use the GNU C Library in +non-free programs enables many more people to use the whole GNU +operating system, as well as its variant, the GNU/Linux operating +system. + + Although the Lesser General Public License is Less protective of the +users' freedom, it does ensure that the user of a program that is +linked with the Library has the freedom and the wherewithal to run +that program using a modified version of the Library. + + The precise terms and conditions for copying, distribution and +modification follow. Pay close attention to the difference between a +"work based on the library" and a "work that uses the library". The +former contains code derived from the library, whereas the latter must +be combined with the library in order to run. + + GNU LESSER GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License Agreement applies to any software library or other +program which contains a notice placed by the copyright holder or +other authorized party saying it may be distributed under the terms of +this Lesser General Public License (also called "this License"). +Each licensee is addressed as "you". + + A "library" means a collection of software functions and/or data +prepared so as to be conveniently linked with application programs +(which use some of those functions and data) to form executables. + + The "Library", below, refers to any such software library or work +which has been distributed under these terms. A "work based on the +Library" means either the Library or any derivative work under +copyright law: that is to say, a work containing the Library or a +portion of it, either verbatim or with modifications and/or translated +straightforwardly into another language. (Hereinafter, translation is +included without limitation in the term "modification".) + + "Source code" for a work means the preferred form of the work for +making modifications to it. For a library, complete source code means +all the source code for all modules it contains, plus any associated +interface definition files, plus the scripts used to control compilation +and installation of the library. + + Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running a program using the Library is not restricted, and output from +such a program is covered only if its contents constitute a work based +on the Library (independent of the use of the Library in a tool for +writing it). Whether that is true depends on what the Library does +and what the program that uses the Library does. + + 1. You may copy and distribute verbatim copies of the Library's +complete source code as you receive it, in any medium, provided that +you conspicuously and appropriately publish on each copy an +appropriate copyright notice and disclaimer of warranty; keep intact +all the notices that refer to this License and to the absence of any +warranty; and distribute a copy of this License along with the +Library. + + You may charge a fee for the physical act of transferring a copy, +and you may at your option offer warranty protection in exchange for a +fee. + + 2. You may modify your copy or copies of the Library or any portion +of it, thus forming a work based on the Library, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) The modified work must itself be a software library. + + b) You must cause the files modified to carry prominent notices + stating that you changed the files and the date of any change. + + c) You must cause the whole of the work to be licensed at no + charge to all third parties under the terms of this License. + + d) If a facility in the modified Library refers to a function or a + table of data to be supplied by an application program that uses + the facility, other than as an argument passed when the facility + is invoked, then you must make a good faith effort to ensure that, + in the event an application does not supply such function or + table, the facility still operates, and performs whatever part of + its purpose remains meaningful. + + (For example, a function in a library to compute square roots has + a purpose that is entirely well-defined independent of the + application. Therefore, Subsection 2d requires that any + application-supplied function or table used by this function must + be optional: if the application does not supply it, the square + root function must still compute square roots.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Library, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Library, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote +it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Library. + +In addition, mere aggregation of another work not based on the Library +with the Library (or with a work based on the Library) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may opt to apply the terms of the ordinary GNU General Public +License instead of this License to a given copy of the Library. To do +this, you must alter all the notices that refer to this License, so +that they refer to the ordinary GNU General Public License, version 2, +instead of to this License. (If a newer version than version 2 of the +ordinary GNU General Public License has appeared, then you can specify +that version instead if you wish.) Do not make any other change in +these notices. + + Once this change is made in a given copy, it is irreversible for +that copy, so the ordinary GNU General Public License applies to all +subsequent copies and derivative works made from that copy. + + This option is useful when you wish to copy part of the code of +the Library into a program that is not a library. + + 4. You may copy and distribute the Library (or a portion or +derivative of it, under Section 2) in object code or executable form +under the terms of Sections 1 and 2 above provided that you accompany +it with the complete corresponding machine-readable source code, which +must be distributed under the terms of Sections 1 and 2 above on a +medium customarily used for software interchange. + + If distribution of object code is made by offering access to copy +from a designated place, then offering equivalent access to copy the +source code from the same place satisfies the requirement to +distribute the source code, even though third parties are not +compelled to copy the source along with the object code. + + 5. A program that contains no derivative of any portion of the +Library, but is designed to work with the Library by being compiled or +linked with it, is called a "work that uses the Library". Such a +work, in isolation, is not a derivative work of the Library, and +therefore falls outside the scope of this License. + + However, linking a "work that uses the Library" with the Library +creates an executable that is a derivative of the Library (because it +contains portions of the Library), rather than a "work that uses the +library". The executable is therefore covered by this License. +Section 6 states terms for distribution of such executables. + + When a "work that uses the Library" uses material from a header file +that is part of the Library, the object code for the work may be a +derivative work of the Library even though the source code is not. +Whether this is true is especially significant if the work can be +linked without the Library, or if the work is itself a library. The +threshold for this to be true is not precisely defined by law. + + If such an object file uses only numerical parameters, data +structure layouts and accessors, and small macros and small inline +functions (ten lines or less in length), then the use of the object +file is unrestricted, regardless of whether it is legally a derivative +work. (Executables containing this object code plus portions of the +Library will still fall under Section 6.) + + Otherwise, if the work is a derivative of the Library, you may +distribute the object code for the work under the terms of Section 6. +Any executables containing that work also fall under Section 6, +whether or not they are linked directly with the Library itself. + + 6. As an exception to the Sections above, you may also combine or +link a "work that uses the Library" with the Library to produce a +work containing portions of the Library, and distribute that work +under terms of your choice, provided that the terms permit +modification of the work for the customer's own use and reverse +engineering for debugging such modifications. + + You must give prominent notice with each copy of the work that the +Library is used in it and that the Library and its use are covered by +this License. You must supply a copy of this License. If the work +during execution displays copyright notices, you must include the +copyright notice for the Library among them, as well as a reference +directing the user to the copy of this License. Also, you must do one +of these things: + + a) Accompany the work with the complete corresponding + machine-readable source code for the Library including whatever + changes were used in the work (which must be distributed under + Sections 1 and 2 above); and, if the work is an executable linked + with the Library, with the complete machine-readable "work that + uses the Library", as object code and/or source code, so that the + user can modify the Library and then relink to produce a modified + executable containing the modified Library. (It is understood + that the user who changes the contents of definitions files in the + Library will not necessarily be able to recompile the application + to use the modified definitions.) + + b) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (1) uses at run time a + copy of the library already present on the user's computer system, + rather than copying library functions into the executable, and (2) + will operate properly with a modified version of the library, if + the user installs one, as long as the modified version is + interface-compatible with the version that the work was made with. + + c) Accompany the work with a written offer, valid for at + least three years, to give the same user the materials + specified in Subsection 6a, above, for a charge no more + than the cost of performing this distribution. + + d) If distribution of the work is made by offering access to copy + from a designated place, offer equivalent access to copy the above + specified materials from the same place. + + e) Verify that the user has already received a copy of these + materials or that you have already sent this user a copy. + + For an executable, the required form of the "work that uses the +Library" must include any data and utility programs needed for +reproducing the executable from it. However, as a special exception, +the materials to be distributed need not include anything that is +normally distributed (in either source or binary form) with the major +components (compiler, kernel, and so on) of the operating system on +which the executable runs, unless that component itself accompanies +the executable. + + It may happen that this requirement contradicts the license +restrictions of other proprietary libraries that do not normally +accompany the operating system. Such a contradiction means you cannot +use both them and the Library together in an executable that you +distribute. + + 7. You may place library facilities that are a work based on the +Library side-by-side in a single library together with other library +facilities not covered by this License, and distribute such a combined +library, provided that the separate distribution of the work based on +the Library and of the other library facilities is otherwise +permitted, and provided that you do these two things: + + a) Accompany the combined library with a copy of the same work + based on the Library, uncombined with any other library + facilities. This must be distributed under the terms of the + Sections above. + + b) Give prominent notice with the combined library of the fact + that part of it is a work based on the Library, and explaining + where to find the accompanying uncombined form of the same work. + + 8. You may not copy, modify, sublicense, link with, or distribute +the Library except as expressly provided under this License. Any +attempt otherwise to copy, modify, sublicense, link with, or +distribute the Library is void, and will automatically terminate your +rights under this License. However, parties who have received copies, +or rights, from you under this License will not have their licenses +terminated so long as such parties remain in full compliance. + + 9. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Library or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Library (or any work based on the +Library), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Library or works based on it. + + 10. Each time you redistribute the Library (or any work based on the +Library), the recipient automatically receives a license from the +original licensor to copy, distribute, link with or modify the Library +subject to these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties with +this License. + + 11. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +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 +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Library at all. For example, if a patent +license would not permit royalty-free redistribution of the Library by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Library. + +If any portion of this section is held invalid or unenforceable under any +particular circumstance, the balance of the section is intended to apply, +and the section as a whole is intended to apply in other circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 12. If the distribution and/or use of the Library is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Library under this License may add +an explicit geographical distribution limitation excluding those countries, +so that distribution is permitted only in or among countries not thus +excluded. In such case, this License incorporates the limitation as if +written in the body of this License. + + 13. The Free Software Foundation may publish revised and/or new +versions of the Lesser 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 Library +specifies a version number of this License which applies to it and +"any later version", you have the option of following the terms and +conditions either of that version or of any later version published by +the Free Software Foundation. If the Library does not specify a +license version number, you may choose any version ever published by +the Free Software Foundation. + + 14. If you wish to incorporate parts of the Library into other free +programs whose distribution conditions are incompatible with these, +write to the author to ask for permission. For software which is +copyrighted by the Free Software Foundation, write to the Free +Software Foundation; we sometimes make exceptions for this. Our +decision will be guided by the two goals of preserving the free status +of all derivatives of our free software and of promoting the sharing +and reuse of software generally. + + NO WARRANTY + + 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO +WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. +EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR +OTHER PARTIES PROVIDE THE LIBRARY "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 +LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME +THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN +WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY +AND/OR REDISTRIBUTE THE LIBRARY 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 +LIBRARY (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 LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF +SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH +DAMAGES. + + END OF TERMS AND CONDITIONS diff --git a/README.txt b/README.txt new file mode 100644 index 0000000..6904b37 --- /dev/null +++ b/README.txt @@ -0,0 +1,53 @@ +------------------------------------------- +Source installation information for modders +------------------------------------------- +This code follows the Minecraft Forge installation methodology. It will apply +some small patches to the vanilla MCP source code, giving you and it access +to some of the data and functions you need to build a successful mod. + +Note also that the patches are built against "unrenamed" MCP source code (aka +srgnames) - this means that you will not be able to read them directly against +normal code. + +Source pack installation information: + +Standalone source installation +============================== + +See the Forge Documentation online for more detailed instructions: +http://mcforge.readthedocs.io/en/latest/gettingstarted/ + +Step 1: Open your command-line and browse to the folder where you extracted the zip file. + +Step 2: You're left with a choice. +If you prefer to use Eclipse: +1. Run the following command: "gradlew genEclipseRuns" (./gradlew genEclipseRuns if you are on Mac/Linux) +2. Open Eclipse, Import > Existing Gradle Project > Select Folder + or run "gradlew eclipse" to generate the project. +(Current Issue) +4. Open Project > Run/Debug Settings > Edit runClient and runServer > Environment +5. Edit MOD_CLASSES to show [modid]%%[Path]; 2 times rather then the generated 4. + +If you prefer to use IntelliJ: +1. Open IDEA, and import project. +2. Select your build.gradle file and have it import. +3. Run the following command: "gradlew genIntellijRuns" (./gradlew genIntellijRuns if you are on Mac/Linux) +4. Refresh the Gradle Project in IDEA if required. + +If at any point you are missing libraries in your IDE, or you've run into problems you can run "gradlew --refresh-dependencies" to refresh the local cache. "gradlew clean" to reset everything {this does not affect your code} and then start the processs again. + +Should it still not work, +Refer to #ForgeGradle on EsperNet for more information about the gradle environment. +or the Forge Project Discord discord.gg/UvedJ9m + +Forge source installation +========================= +MinecraftForge ships with this code and installs it as part of the forge +installation process, no further action is required on your part. + +LexManos' Install Video +======================= +https://www.youtube.com/watch?v=8VEdtQLuLO0&feature=youtu.be + +For more details update more often refer to the Forge Forums: +http://www.minecraftforge.net/forum/index.php/topic,14048.0.html diff --git a/build.gradle b/build.gradle index 3607f22..5c55a1d 100644 --- a/build.gradle +++ b/build.gradle @@ -1,94 +1,151 @@ -plugins { - id 'fabric-loom' version '0.2.6-SNAPSHOT' - id 'maven-publish' -} - -sourceCompatibility = JavaVersion.VERSION_1_8 -targetCompatibility = JavaVersion.VERSION_1_8 - -archivesBaseName = project.archives_base_name -version = project.mod_version -group = project.maven_group - -minecraft { -} - -repositories{ - maven { url 'http://server.bbkr.space:8081/artifactory/libs-release' } -} - - -dependencies { - //to change the versions see the gradle.properties file - minecraft "com.mojang:minecraft:${project.minecraft_version}" - mappings "net.fabricmc:yarn:${project.yarn_mappings}:v2" - modCompile "net.fabricmc:fabric-loader:${project.loader_version}" - - // Fabric API. This is technically optional, but you probably want it anyway. - modCompile "net.fabricmc.fabric-api:fabric-api:${project.fabric_version}" - - modCompile "io.github.cottonmc.cotton:cotton-config:1.0.0-rc.7" - - include "io.github.cottonmc:Jankson-Fabric:2.0.0+j1.2.0" - include "io.github.cottonmc.cotton:cotton-logging:1.0.0-rc.4" - include "io.github.cottonmc.cotton:cotton-config:1.0.0-rc.7" - - include "org.apache.commons:commons-compress:1.9" - include "org.apache.commons:commons-io:1.3.2" - - // PSA: Some older mods, compiled on Loom 0.2.1, might have outdated Maven POMs. - // You may need to force-disable transitiveness on them. -} - -processResources { - inputs.property "version", project.version - - from(sourceSets.main.resources.srcDirs) { - include "fabric.mod.json" - expand "version": project.version - } - - from(sourceSets.main.resources.srcDirs) { - exclude "fabric.mod.json" - } -} - -// ensure that the encoding is set to UTF-8, no matter what the system default is -// this fixes some edge cases with special characters not displaying correctly -// see http://yodaconditions.net/blog/fix-for-java-file-encoding-problems-with-gradle.html -tasks.withType(JavaCompile) { - options.encoding = "UTF-8" -} - -// Loom will automatically attach sourcesJar to a RemapSourcesJar task and to the "build" task -// if it is present. -// If you remove this task, sources will not be generated. -task sourcesJar(type: Jar, dependsOn: classes) { - classifier = "sources" - from sourceSets.main.allSource -} - -jar { - from "LICENSE" -} - -// configure the maven publication -publishing { - publications { - mavenJava(MavenPublication) { - // add all the jars that should be included when publishing to maven - artifact(remapJar) { - builtBy remapJar - } - artifact(sourcesJar) { - builtBy remapSourcesJar - } - } - } - - // select the repositories you want to publish to - repositories { - // uncomment to publish to the local maven - // mavenLocal() - } -} +buildscript { + repositories { + maven { url = 'https://files.minecraftforge.net/maven' } + jcenter() + mavenCentral() + } + dependencies { + classpath group: 'net.minecraftforge.gradle', name: 'ForgeGradle', version: '3.+', changing: true + } +} +apply plugin: 'net.minecraftforge.gradle' +// Only edit below this line, the above code adds and enables the necessary things for Forge to be setup. +apply plugin: 'eclipse' +apply plugin: 'maven-publish' + +version = '1.0' +group = 'net.szum123321.TextileBackup' // http://maven.apache.org/guides/mini/guide-naming-conventions.html +archivesBaseName = 'textile_backup' + +sourceCompatibility = targetCompatibility = compileJava.sourceCompatibility = compileJava.targetCompatibility = '1.8' // Need this here so eclipse task generates correctly. + +minecraft { + // The mappings can be changed at any time, and must be in the following format. + // snapshot_YYYYMMDD Snapshot are built nightly. + // stable_# Stables are built at the discretion of the MCP team. + // Use non-default mappings at your own risk. they may not always work. + // Simply re-run your setup task after changing the mappings to update your workspace. + mappings channel: 'snapshot', version: '20190719-1.14.3' + // makeObfSourceJar = false // an Srg named sources jar is made by default. uncomment this to disable. + + // accessTransformer = file('src/main/resources/META-INF/accesstransformer.cfg') + + // Default run configurations. + // These can be tweaked, removed, or duplicated as needed. + runs { + client { + workingDirectory project.file('run') + + // Recommended logging data for a userdev environment + property 'forge.logging.markers', 'SCAN,REGISTRIES,REGISTRYDUMP' + + // Recommended logging level for the console + property 'forge.logging.console.level', 'debug' + + mods { + examplemod { + source sourceSets.main + } + } + } + + server { + workingDirectory project.file('run') + + // Recommended logging data for a userdev environment + property 'forge.logging.markers', 'SCAN,REGISTRIES,REGISTRYDUMP' + + // Recommended logging level for the console + property 'forge.logging.console.level', 'debug' + + mods { + examplemod { + source sourceSets.main + } + } + } + + data { + workingDirectory project.file('run') + + // Recommended logging data for a userdev environment + property 'forge.logging.markers', 'SCAN,REGISTRIES,REGISTRYDUMP' + + // Recommended logging level for the console + property 'forge.logging.console.level', 'debug' + + args '--mod', 'examplemod', '--all', '--output', file('src/generated/resources/') + + mods { + examplemod { + source sourceSets.main + } + } + } + } +} + +dependencies { + // Specify the version of Minecraft to use, If this is any group other then 'net.minecraft' it is assumed + // that the dep is a ForgeGradle 'patcher' dependency. And it's patches will be applied. + // The userdev artifact is a special name and will get all sorts of transformations applied to it. + minecraft 'net.minecraftforge:forge:1.14.4-28.2.0' + + compile "blue.endless:jankson:1.2.0" + + // You may put jars on which you depend on in ./libs or you may define them like so.. + // compile "some.group:artifact:version:classifier" + // compile "some.group:artifact:version" + + // Real examples + // compile 'com.mod-buildcraft:buildcraft:6.0.8:dev' // adds buildcraft to the dev env + // compile 'com.googlecode.efficient-java-matrix-library:ejml:0.24' // adds ejml to the dev env + + // The 'provided' configuration is for optional dependencies that exist at compile-time but might not at runtime. + // provided 'com.mod-buildcraft:buildcraft:6.0.8:dev' + + // These dependencies get remapped to your current MCP mappings + // deobf 'com.mod-buildcraft:buildcraft:6.0.8:dev' + + // For more info... + // http://www.gradle.org/docs/current/userguide/artifact_dependencies_tutorial.html + // http://www.gradle.org/docs/current/userguide/dependency_management.html + +} + +// Example for how to get properties into the manifest for reading by the runtime.. +jar { + manifest { + attributes([ + "Specification-Title": "examplemod", + "Specification-Vendor": "examplemodsareus", + "Specification-Version": "1", // We are version 1 of ourselves + "Implementation-Title": project.name, + "Implementation-Version": "${version}", + "Implementation-Vendor" :"examplemodsareus", + "Implementation-Timestamp": new Date().format("yyyy-MM-dd'T'HH:mm:ssZ") + ]) + } +} + +// Example configuration to allow publishing using the maven-publish task +// we define a custom artifact that is sourced from the reobfJar output task +// and then declare that to be published +// Note you'll need to add a repository here +def reobfFile = file("$buildDir/reobfJar/output.jar") +def reobfArtifact = artifacts.add('default', reobfFile) { + type 'jar' + builtBy 'reobfJar' +} +publishing { + publications { + mavenJava(MavenPublication) { + artifact reobfArtifact + } + } + repositories { + maven { + url "file:///${project.projectDir}/mcmodsrepo" + } + } +} \ No newline at end of file diff --git a/gradle.properties b/gradle.properties index 6d2e753..878bf1f 100644 --- a/gradle.properties +++ b/gradle.properties @@ -1,14 +1,4 @@ -# Done to increase the memory available to gradle. -org.gradle.jvmargs=-Xmx1G - -minecraft_version=20w14a -yarn_mappings=20w14a+build.1 -loader_version=0.7.9+build.190 - -#Fabric api -fabric_version=0.5.7+build.314-1.16 - -# Mod Properties - mod_version = 1.1.1-1.15 - maven_group = net.szum123321 - archives_base_name = textile_backup \ No newline at end of file +# Sets default memory used for gradle commands. Can be overridden by user or command line properties. +# This is required to provide enough memory for the Minecraft decompilation process. +org.gradle.jvmargs=-Xmx3G +org.gradle.daemon=false \ No newline at end of file diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar index 5c2d1cf..7a3265e 100644 Binary files a/gradle/wrapper/gradle-wrapper.jar and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties index 4b7e1f3..949819d 100644 --- a/gradle/wrapper/gradle-wrapper.properties +++ b/gradle/wrapper/gradle-wrapper.properties @@ -1,5 +1,5 @@ distributionBase=GRADLE_USER_HOME distributionPath=wrapper/dists -distributionUrl=https\://services.gradle.org/distributions/gradle-5.5.1-bin.zip zipStoreBase=GRADLE_USER_HOME zipStorePath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-4.9-bin.zip diff --git a/gradlew b/gradlew index 8e25e6c..cccdd3d 100755 --- a/gradlew +++ b/gradlew @@ -1,21 +1,5 @@ #!/usr/bin/env sh -# -# Copyright 2015 the original author or authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# https://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# - ############################################################################## ## ## Gradle start up script for UN*X @@ -44,7 +28,7 @@ APP_NAME="Gradle" APP_BASE_NAME=`basename "$0"` # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. -DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' +DEFAULT_JVM_OPTS="" # Use the maximum available, or set MAX_FD != -1 to use that value. MAX_FD="maximum" diff --git a/gradlew.bat b/gradlew.bat index 9618d8d..e95643d 100644 --- a/gradlew.bat +++ b/gradlew.bat @@ -1,100 +1,84 @@ -@rem -@rem Copyright 2015 the original author or authors. -@rem -@rem Licensed under the Apache License, Version 2.0 (the "License"); -@rem you may not use this file except in compliance with the License. -@rem You may obtain a copy of the License at -@rem -@rem https://www.apache.org/licenses/LICENSE-2.0 -@rem -@rem Unless required by applicable law or agreed to in writing, software -@rem distributed under the License is distributed on an "AS IS" BASIS, -@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -@rem See the License for the specific language governing permissions and -@rem limitations under the License. -@rem - -@if "%DEBUG%" == "" @echo off -@rem ########################################################################## -@rem -@rem Gradle startup script for Windows -@rem -@rem ########################################################################## - -@rem Set local scope for the variables with windows NT shell -if "%OS%"=="Windows_NT" setlocal - -set DIRNAME=%~dp0 -if "%DIRNAME%" == "" set DIRNAME=. -set APP_BASE_NAME=%~n0 -set APP_HOME=%DIRNAME% - -@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. -set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" - -@rem Find java.exe -if defined JAVA_HOME goto findJavaFromJavaHome - -set JAVA_EXE=java.exe -%JAVA_EXE% -version >NUL 2>&1 -if "%ERRORLEVEL%" == "0" goto init - -echo. -echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. -echo. -echo Please set the JAVA_HOME variable in your environment to match the -echo location of your Java installation. - -goto fail - -:findJavaFromJavaHome -set JAVA_HOME=%JAVA_HOME:"=% -set JAVA_EXE=%JAVA_HOME%/bin/java.exe - -if exist "%JAVA_EXE%" goto init - -echo. -echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% -echo. -echo Please set the JAVA_HOME variable in your environment to match the -echo location of your Java installation. - -goto fail - -:init -@rem Get command-line arguments, handling Windows variants - -if not "%OS%" == "Windows_NT" goto win9xME_args - -:win9xME_args -@rem Slurp the command line arguments. -set CMD_LINE_ARGS= -set _SKIP=2 - -:win9xME_args_slurp -if "x%~1" == "x" goto execute - -set CMD_LINE_ARGS=%* - -:execute -@rem Setup the command line - -set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar - -@rem Execute Gradle -"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% - -:end -@rem End local scope for the variables with windows NT shell -if "%ERRORLEVEL%"=="0" goto mainEnd - -:fail -rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of -rem the _cmd.exe /c_ return code! -if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 -exit /b 1 - -:mainEnd -if "%OS%"=="Windows_NT" endlocal - -:omega +@if "%DEBUG%" == "" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%" == "" set DIRNAME=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS= + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if "%ERRORLEVEL%" == "0" goto init + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto init + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:init +@rem Get command-line arguments, handling Windows variants + +if not "%OS%" == "Windows_NT" goto win9xME_args + +:win9xME_args +@rem Slurp the command line arguments. +set CMD_LINE_ARGS= +set _SKIP=2 + +:win9xME_args_slurp +if "x%~1" == "x" goto execute + +set CMD_LINE_ARGS=%* + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% + +:end +@rem End local scope for the variables with windows NT shell +if "%ERRORLEVEL%"=="0" goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 +exit /b 1 + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/settings.gradle b/settings.gradle deleted file mode 100644 index 5b60df3..0000000 --- a/settings.gradle +++ /dev/null @@ -1,10 +0,0 @@ -pluginManagement { - repositories { - jcenter() - maven { - name = 'Fabric' - url = 'https://maven.fabricmc.net/' - } - gradlePluginPortal() - } -} diff --git a/src/main/java/net/szum123321/textile_backup/ConfigHandler.java b/src/main/java/net/szum123321/textile_backup/ConfigHandler.java deleted file mode 100644 index e37e4e7..0000000 --- a/src/main/java/net/szum123321/textile_backup/ConfigHandler.java +++ /dev/null @@ -1,77 +0,0 @@ -/* - A simple backup mod for Fabric - Copyright (C) 2020 Szum123321 - - 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 . -*/ - -package net.szum123321.textile_backup; - -import blue.endless.jankson.Comment; -import io.github.cottonmc.cotton.config.annotations.ConfigFile; - -import java.util.HashSet; -import java.util.Set; - -@ConfigFile(name = TextileBackup.MOD_ID) -public class ConfigHandler { - @Comment("\nTime between backups in seconds\n") - public long backupInterval = 3600; - - @Comment("\nShould backups be done even if there is no players?\n") - public boolean doBackupsOnEmptyServer = false; - - @Comment("\nShould backups be made on server shutdown\n") - public boolean shutdownBackup = true; - - @Comment("\nA path to backup folder\n") - public String path = "backup/"; - - @Comment("\nThis setting allows you to exclude files form being backuped.\n"+ - "Be very careful when setting it, as it is easy to make your backuped world unusable!\n") - public Set fileBlacklist = new HashSet<>(); - - @Comment("\nShould every world has its won backup folder?\n") - public boolean perWorldBackup = false; - - @Comment("\nMaximum number of backups to keep. If 0 then no backup will be deleted based on its amount\n") - public int backupsToKeep = 10; - - @Comment("\nMaximum age of backups to keep in seconds.\n if 0 then backups will not be deleted based on its age \n") - public long maxAge = 0; - - @Comment("\nMaximum size of backup folder in kilo bytes. \n") - public int maxSize = 0; - - @Comment("\nCompression level \n0 - 9\n") - public int compression = 1; - - @Comment("\nPrint info to game out\n") - public boolean log = true; - - @Comment("\nMinimal permission level required to run commands\n") - public int permissionLevel = 4; - - @Comment("\nPlayer on singleplayer is always allowed to run command. Warning! On lan party everyone will be allowed to run it.\n") - public boolean alwaysSingleplayerAllowed = true; - - @Comment("\nPlayers allowed to run backup commands without sufficient permission level\n") - public Set playerWhitelist = new HashSet<>(); - - @Comment("\nPlayers banned from running backup commands besides their sufficient permission level\n") - public Set playerBlacklist = new HashSet<>(); - - @Comment("\nFormat of date&time used to name backup files.\n") - public String dateTimeFormat = "dd.MM.yyyy_HH-mm-ss"; -} diff --git a/src/main/java/net/szum123321/textile_backup/TextileBackup.java b/src/main/java/net/szum123321/textile_backup/TextileBackup.java deleted file mode 100644 index 054f932..0000000 --- a/src/main/java/net/szum123321/textile_backup/TextileBackup.java +++ /dev/null @@ -1,70 +0,0 @@ -/* - A simple backup mod for Fabric - Copyright (C) 2020 Szum123321 - - 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 . -*/ - -package net.szum123321.textile_backup; - -import com.mojang.brigadier.builder.LiteralArgumentBuilder; -import io.github.cottonmc.cotton.config.ConfigManager; -import io.github.cottonmc.cotton.logging.ModLogger; - -import net.fabricmc.api.ModInitializer; -import net.fabricmc.fabric.api.registry.CommandRegistry; -import net.minecraft.server.command.ServerCommandSource; -import net.szum123321.textile_backup.commands.BlacklistCommand; -import net.szum123321.textile_backup.commands.CleanupCommand; -import net.szum123321.textile_backup.commands.StartBackupCommand; -import net.szum123321.textile_backup.commands.WhitelistCommand; - -public class TextileBackup implements ModInitializer { - public static final String MOD_ID = "textile_backup"; - public static ModLogger logger; - - public static ConfigHandler config; - - @Override - public void onInitialize() { - logger = new ModLogger(this.getClass()); - - logger.info("Loading TextileBackup by Szum123321"); - - config = ConfigManager.loadConfig(ConfigHandler.class); - - registerCommands(); - } - - private void registerCommands(){ - CommandRegistry.INSTANCE.register(false, dispatcher -> dispatcher.register( - LiteralArgumentBuilder.literal("backup") - .requires((ctx) -> { - try { - return ((config.playerWhitelist.contains(ctx.getEntityOrThrow().getEntityName()) || - ctx.hasPermissionLevel(config.permissionLevel)) && - !config.playerBlacklist.contains(ctx.getEntityOrThrow().getEntityName())) || - (ctx.getMinecraftServer().isSinglePlayer() && - config.alwaysSingleplayerAllowed); - }catch (Exception e){ //Command was called from server console. - return true; - } - } - ).then(BlacklistCommand.register()) - .then(CleanupCommand.register()) - .then(StartBackupCommand.register()) - .then(WhitelistCommand.register()) - )); - } -} diff --git a/src/main/java/net/szum123321/textile_backup/commands/BlacklistCommand.java b/src/main/java/net/szum123321/textile_backup/commands/BlacklistCommand.java deleted file mode 100644 index 5a4b926..0000000 --- a/src/main/java/net/szum123321/textile_backup/commands/BlacklistCommand.java +++ /dev/null @@ -1,101 +0,0 @@ -package net.szum123321.textile_backup.commands; - -import com.mojang.brigadier.builder.LiteralArgumentBuilder; -import com.mojang.brigadier.context.CommandContext; -import com.mojang.brigadier.exceptions.CommandSyntaxException; -import io.github.cottonmc.cotton.config.ConfigManager; -import net.minecraft.command.arguments.EntityArgumentType; -import net.minecraft.entity.player.PlayerEntity; -import net.minecraft.server.command.CommandManager; -import net.minecraft.server.command.ServerCommandSource; -import net.minecraft.text.LiteralText; -import net.minecraft.text.TranslatableText; -import net.szum123321.textile_backup.TextileBackup; -import net.szum123321.textile_backup.core.Utilities; - -public class BlacklistCommand { - public static LiteralArgumentBuilder register(){ - return CommandManager.literal("blacklist") - .then(CommandManager.literal("add") - .then(CommandManager.argument("player", EntityArgumentType.player()) - .executes(BlacklistCommand::executeAdd) - ) - ).then(CommandManager.literal("remove") - .then(CommandManager.argument("player", EntityArgumentType.player()) - .executes(BlacklistCommand::executeRemove) - ) - ).then(CommandManager.literal("list") - .executes(ctx -> executeList(ctx.getSource())) - ).executes(ctx -> help(ctx.getSource())); - } - - private static int help(ServerCommandSource source){ - source.sendFeedback(new LiteralText("Available command are: add [player], remove [player], list."), false); - - return 1; - } - - private static int executeList(ServerCommandSource source){ - StringBuilder builder = new StringBuilder(); - - builder.append("Currently on the blacklist are: "); - - for(String name : TextileBackup.config.playerBlacklist){ - builder.append(name); - builder.append(", "); - } - - Utilities.log(builder.toString(), source); - - return 1; - } - - private static int executeAdd(CommandContext ctx) throws CommandSyntaxException { - PlayerEntity player = EntityArgumentType.getPlayer(ctx, "player"); - - if(TextileBackup.config.playerBlacklist.contains(player.getEntityName())) { - ctx.getSource().sendFeedback(new TranslatableText("Player: %s is already blacklisted.", player.getEntityName()), false); - }else{ - TextileBackup.config.playerBlacklist.add(player.getEntityName()); - ConfigManager.saveConfig(TextileBackup.config); - - StringBuilder builder = new StringBuilder(); - - builder.append("Player: "); - builder.append(player.getEntityName()); - builder.append(" added to the blacklist"); - - if(TextileBackup.config.playerWhitelist.contains(player.getEntityName())){ - TextileBackup.config.playerWhitelist.remove(player.getEntityName()); - builder.append(" and removed form the whitelist"); - } - - builder.append(" successfully."); - - Utilities.log(builder.toString(), ctx.getSource()); - } - - return 1; - } - - private static int executeRemove(CommandContext ctx) throws CommandSyntaxException { - PlayerEntity player = EntityArgumentType.getPlayer(ctx, "player"); - - if(!TextileBackup.config.playerBlacklist.contains(player.getEntityName())) { - ctx.getSource().sendFeedback(new TranslatableText("Player: %s newer was blacklisted.", player.getEntityName()), false); - }else{ - TextileBackup.config.playerBlacklist.remove(player.getEntityName()); - ConfigManager.saveConfig(TextileBackup.config); - - StringBuilder builder = new StringBuilder(); - - builder.append("Player: "); - builder.append(player.getEntityName()); - builder.append(" removed from the blacklist successfully."); - - Utilities.log(builder.toString(), ctx.getSource()); - } - - return 1; - } -} diff --git a/src/main/java/net/szum123321/textile_backup/commands/CleanupCommand.java b/src/main/java/net/szum123321/textile_backup/commands/CleanupCommand.java deleted file mode 100644 index e4af2a2..0000000 --- a/src/main/java/net/szum123321/textile_backup/commands/CleanupCommand.java +++ /dev/null @@ -1,40 +0,0 @@ -/* - A simple backup mod for Fabric - Copyright (C) 2020 Szum123321 - - 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 . -*/ - -package net.szum123321.textile_backup.commands; - -import com.mojang.brigadier.builder.LiteralArgumentBuilder; -import net.minecraft.server.command.CommandManager; -import net.minecraft.server.command.ServerCommandSource; -import net.minecraft.text.LiteralText; -import net.minecraft.world.dimension.DimensionType; -import net.szum123321.textile_backup.core.BackupHelper; - -public class CleanupCommand { - public static LiteralArgumentBuilder register(){ - return CommandManager.literal("cleanup") - .executes(ctx -> execute(ctx.getSource())); - } - - private static int execute(ServerCommandSource source){ - BackupHelper.executeFileLimit(source, source.getMinecraftServer().getWorld(DimensionType.OVERWORLD).getLevelProperties().getLevelName()); - source.sendFeedback(new LiteralText("Done"), false); - - return 1; - } -} diff --git a/src/main/java/net/szum123321/textile_backup/commands/StartBackupCommand.java b/src/main/java/net/szum123321/textile_backup/commands/StartBackupCommand.java deleted file mode 100644 index ac9c83c..0000000 --- a/src/main/java/net/szum123321/textile_backup/commands/StartBackupCommand.java +++ /dev/null @@ -1,47 +0,0 @@ -/* - A simple backup mod for Fabric - Copyright (C) 2020 Szum123321 - - 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 . -*/ - -package net.szum123321.textile_backup.commands; - -import com.mojang.brigadier.arguments.StringArgumentType; -import com.mojang.brigadier.builder.LiteralArgumentBuilder; -import com.mojang.brigadier.context.CommandContext; -import net.minecraft.server.command.CommandManager; -import net.minecraft.server.command.ServerCommandSource; -import net.szum123321.textile_backup.core.BackupHelper; - -public class StartBackupCommand { - public static LiteralArgumentBuilder register(){ - return CommandManager.literal("start") - .then(CommandManager.argument("comment", StringArgumentType.string()) - .executes(StartBackupCommand::executeWithComment) - ).executes(ctx -> execute(ctx.getSource())); - } - - private static int executeWithComment(CommandContext source) { - BackupHelper.create(source.getSource().getMinecraftServer(), source.getSource(), true, StringArgumentType.getString(source, "comment").replace("#", "")); - - return 1; - } - - private static int execute(ServerCommandSource source){ - BackupHelper.create(source.getMinecraftServer(), source,true, null); - - return 1; - } -} diff --git a/src/main/java/net/szum123321/textile_backup/commands/WhitelistCommand.java b/src/main/java/net/szum123321/textile_backup/commands/WhitelistCommand.java deleted file mode 100644 index c85a33b..0000000 --- a/src/main/java/net/szum123321/textile_backup/commands/WhitelistCommand.java +++ /dev/null @@ -1,100 +0,0 @@ -package net.szum123321.textile_backup.commands; - -import com.mojang.brigadier.builder.LiteralArgumentBuilder; -import com.mojang.brigadier.context.CommandContext; -import com.mojang.brigadier.exceptions.CommandSyntaxException; -import io.github.cottonmc.cotton.config.ConfigManager; -import net.minecraft.command.arguments.EntityArgumentType; -import net.minecraft.entity.player.PlayerEntity; -import net.minecraft.server.command.CommandManager; -import net.minecraft.server.command.ServerCommandSource; -import net.minecraft.text.LiteralText; -import net.minecraft.text.TranslatableText; -import net.szum123321.textile_backup.TextileBackup; -import net.szum123321.textile_backup.core.Utilities; - -public class WhitelistCommand { - public static LiteralArgumentBuilder register(){ - return CommandManager.literal("whitelist") - .then(CommandManager.literal("add") - .then(CommandManager.argument("player", EntityArgumentType.player()) - .executes(WhitelistCommand::executeAdd) - ) - ).then(CommandManager.literal("remove") - .then(CommandManager.argument("player", EntityArgumentType.player()) - .executes(WhitelistCommand::executeRemove) - ) - ).then(CommandManager.literal("list") - .executes(ctx -> executeList(ctx.getSource())) - ).executes(ctx -> help(ctx.getSource())); - } - - private static int help(ServerCommandSource source){ - source.sendFeedback(new LiteralText("Available command are: add [player], remove [player], list."), false); - - return 1; - } - - private static int executeList(ServerCommandSource source){ - StringBuilder builder = new StringBuilder(); - - builder.append("Currently on the whitelist are: "); - - for(String name : TextileBackup.config.playerWhitelist){ - builder.append(name); - builder.append(", "); - } - - Utilities.log(builder.toString(), source); - - return 1; - } - - private static int executeAdd(CommandContext ctx) throws CommandSyntaxException { - PlayerEntity player = EntityArgumentType.getPlayer(ctx, "player"); - - if(TextileBackup.config.playerWhitelist.contains(player.getEntityName())) { - ctx.getSource().sendFeedback(new TranslatableText("Player: %s is already whitelisted.", player.getEntityName()), false); - }else{ - TextileBackup.config.playerWhitelist.add(player.getEntityName()); - ConfigManager.saveConfig(TextileBackup.config); - - StringBuilder builder = new StringBuilder(); - - builder.append("Player: "); - builder.append(player.getEntityName()); - builder.append(" added to the whitelist"); - - if(TextileBackup.config.playerBlacklist.contains(player.getEntityName())){ - TextileBackup.config.playerBlacklist.remove(player.getEntityName()); - builder.append(" and removed form the blacklist"); - } - - builder.append(" successfully."); - - Utilities.log(builder.toString(), ctx.getSource()); - } - - return 1; - } - - private static int executeRemove(CommandContext ctx) throws CommandSyntaxException { - PlayerEntity player = EntityArgumentType.getPlayer(ctx, "player"); - - if(!TextileBackup.config.playerWhitelist.contains(player.getEntityName())) { - ctx.getSource().sendFeedback(new TranslatableText("Player: %s newer was on the whitelist.", player.getEntityName()), false); - }else{ - TextileBackup.config.playerWhitelist.remove(player.getEntityName()); - ConfigManager.saveConfig(TextileBackup.config); - StringBuilder builder = new StringBuilder(); - - builder.append("Player: "); - builder.append(player.getEntityName()); - builder.append(" removed from the whitelist successfully."); - - Utilities.log(builder.toString(), ctx.getSource()); - } - - return 1; - } -} diff --git a/src/main/java/net/szum123321/textile_backup/core/Compressor.java b/src/main/java/net/szum123321/textile_backup/core/Compressor.java deleted file mode 100644 index 663e54b..0000000 --- a/src/main/java/net/szum123321/textile_backup/core/Compressor.java +++ /dev/null @@ -1,69 +0,0 @@ -/* - A simple backup mod for Fabric - Copyright (C) 2020 Szum123321 - - 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 . -*/ - -package net.szum123321.textile_backup.core; - -import net.minecraft.server.command.ServerCommandSource; -import net.szum123321.textile_backup.TextileBackup; -import org.apache.commons.compress.utils.IOUtils; - -import java.io.File; -import java.io.FileInputStream; -import java.io.FileOutputStream; -import java.io.IOException; -import java.nio.file.Files; -import java.time.LocalDateTime; -import java.util.zip.ZipEntry; -import java.util.zip.ZipOutputStream; - -public class Compressor { - public static void createArchive(File in, File out, ServerCommandSource ctx){ - Utilities.log("Starting compression...", ctx); - - try { - File input = in.getCanonicalFile(); - - ZipOutputStream arc = new ZipOutputStream(new FileOutputStream(out)); - - arc.setLevel(TextileBackup.config.compression); - arc.setComment("Created on: " + Utilities.getDateTimeFormatter().format(LocalDateTime.now())); - - int rootPathLength = input.toString().length() + 1; - - Files.walk(input.toPath()).filter(path -> !path.equals(input.toPath()) && path.toFile().isFile() && !TextileBackup.config.fileBlacklist.contains(path.toString().substring(rootPathLength))).forEach(path -> { - try{ - File file = path.toAbsolutePath().toFile(); - - ZipEntry entry = new ZipEntry(file.getAbsolutePath().substring(rootPathLength)); - arc.putNextEntry(entry); - entry.setSize(file.length()); - IOUtils.copy(new FileInputStream(file), arc); - arc.closeEntry(); - }catch (IOException e){ - TextileBackup.logger.error(e.getMessage()); - } - }); - - arc.close(); - } catch (IOException e) { - TextileBackup.logger.error(e.getMessage()); - } - - Utilities.log("Compression finished", ctx); - } -} diff --git a/src/main/java/net/szum123321/textile_backup/core/Utilities.java b/src/main/java/net/szum123321/textile_backup/core/Utilities.java deleted file mode 100644 index 66ade81..0000000 --- a/src/main/java/net/szum123321/textile_backup/core/Utilities.java +++ /dev/null @@ -1,45 +0,0 @@ -package net.szum123321.textile_backup.core; - -import net.minecraft.server.command.ServerCommandSource; -import net.minecraft.text.LiteralText; -import net.szum123321.textile_backup.TextileBackup; - -import java.time.format.DateTimeFormatter; - -public class Utilities { - public static boolean isWindows(){ - String os = System.getProperty("os.name"); - return os.toLowerCase().startsWith("win"); - } - - public static DateTimeFormatter getDateTimeFormatter(){ - if(!TextileBackup.config.dateTimeFormat.equals("")) - return DateTimeFormatter.ofPattern(TextileBackup.config.dateTimeFormat); - else - return getBackupDateTimeFormatter(); - } - - public static DateTimeFormatter getBackupDateTimeFormatter(){ - if(isWindows()){ - return DateTimeFormatter.ofPattern("dd.MM.yyyy_HH-mm-ss"); - } else { - return DateTimeFormatter.ofPattern("dd.MM.yyyy_HH:mm:ss"); - } - } - - public static void log(String s, ServerCommandSource ctx){ - if(ctx != null) - ctx.sendFeedback(new LiteralText(s), false); - - if(TextileBackup.config.log) - TextileBackup.logger.info(s); - } - - public static void error(String s, ServerCommandSource ctx){ - if(ctx != null) - ctx.sendFeedback(new LiteralText(s), true); - - if(TextileBackup.config.log) - TextileBackup.logger.error(s); - } -} diff --git a/src/main/java/net/szum123321/textile_backup/mixin/MinecraftServerMixin.java b/src/main/java/net/szum123321/textile_backup/mixin/MinecraftServerMixin.java deleted file mode 100644 index 86cb0a7..0000000 --- a/src/main/java/net/szum123321/textile_backup/mixin/MinecraftServerMixin.java +++ /dev/null @@ -1,58 +0,0 @@ -/* - A simple backup mod for Fabric - Copyright (C) 2020 Szum123321 - - 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 . -*/ - -package net.szum123321.textile_backup.mixin; - -import net.minecraft.server.MinecraftServer; -import net.minecraft.server.PlayerManager; -import net.szum123321.textile_backup.TextileBackup; -import net.szum123321.textile_backup.core.BackupHelper; -import org.spongepowered.asm.mixin.Mixin; -import org.spongepowered.asm.mixin.Shadow; -import org.spongepowered.asm.mixin.injection.At; -import org.spongepowered.asm.mixin.injection.Inject; -import org.spongepowered.asm.mixin.injection.callback.CallbackInfo; - -import java.util.function.BooleanSupplier; - -@Mixin(MinecraftServer.class) -public abstract class MinecraftServerMixin { - @Shadow private long timeReference; - - @Shadow public abstract PlayerManager getPlayerManager(); - - private long lastBackup = 0; - - @Inject(method = "tick", at = @At("HEAD")) - public void tick(BooleanSupplier shouldKeepTicking, CallbackInfo ci){ - if(timeReference - lastBackup >= TextileBackup.config.backupInterval * 1000){ - if(getPlayerManager().getCurrentPlayerCount() == 0 && !TextileBackup.config.doBackupsOnEmptyServer) - return; - - lastBackup = timeReference; - - BackupHelper.create((MinecraftServer)(Object)this, null, true, null); - } - } - - @Inject(method = "shutdown", at = @At(value = "INVOKE_ASSIGN", target = "Lnet/minecraft/server/MinecraftServer;save(ZZZ)Z")) - public void onShutdown(CallbackInfo ci){ - if(TextileBackup.config.shutdownBackup) - BackupHelper.create((MinecraftServer)(Object)this, null, false, null); - } -} diff --git a/src/main/java/szum123321/textile_backup/ConfigData.java b/src/main/java/szum123321/textile_backup/ConfigData.java new file mode 100644 index 0000000..55505b3 --- /dev/null +++ b/src/main/java/szum123321/textile_backup/ConfigData.java @@ -0,0 +1,75 @@ +/* + * Simple backup mod made for Fabric and ported to Forge + * Copyright (C) 2020 Szum123321 + * + * 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 . + */ + +package szum123321.textile_backup; + +import blue.endless.jankson.Comment; + +import java.util.HashSet; +import java.util.Set; + +public class ConfigData { + @Comment("\nTime between backups in seconds\n") + public long backupInterval = 3600; + + @Comment("\nShould backups be done even if there is no players?\n") + public boolean doBackupsOnEmptyServer = false; + + @Comment("\nShould backups be made on server shutdown\n") + public boolean shutdownBackup = true; + + @Comment("\nA path to backup folder\n") + public String path = "backup/"; + + @Comment("\nThis setting allows you to exclude files form being backuped.\n"+ + "Be very careful when setting it, as it is easy to make your backuped world unusable!\n") + public Set fileBlacklist = new HashSet<>(); + + @Comment("\nShould every world has its won backup folder?\n") + public boolean perWorldBackup = false; + + @Comment("\nMaximum number of backups to keep. If 0 then no backup will be deleted based on its amount\n") + public int backupsToKeep = 10; + + @Comment("\nMaximum age of backups to keep in seconds.\n if 0 then backups will not be deleted based on its age \n") + public long maxAge = 0; + + @Comment("\nMaximum size of backup folder in kilo bytes. \n") + public int maxSize = 0; + + @Comment("\nCompression level \n0 - 9\n") + public int compression = 1; + + @Comment("\nPrint info to game out\n") + public boolean log = true; + + @Comment("\nMinimal permission level required to run commands\n") + public int permissionLevel = 4; + + @Comment("\nPlayer on singleplayer is always allowed to run command. Warning! On lan party everyone will be allowed to run it.\n") + public boolean alwaysSingleplayerAllowed = true; + + @Comment("\nPlayers allowed to run backup commands without sufficient permission level\n") + public Set playerWhitelist = new HashSet<>(); + + @Comment("\nPlayers banned from running backup commands besides their sufficient permission level\n") + public Set playerBlacklist = new HashSet<>(); + + @Comment("\nFormat of date&time used to name backup files.\n") + public String dateTimeFormat = "dd.MM.yyyy_HH-mm-ss"; +} diff --git a/src/main/java/szum123321/textile_backup/ConfigHandler.java b/src/main/java/szum123321/textile_backup/ConfigHandler.java new file mode 100644 index 0000000..18fd173 --- /dev/null +++ b/src/main/java/szum123321/textile_backup/ConfigHandler.java @@ -0,0 +1,103 @@ +/* + * Simple backup mod made for Fabric and ported to Forge + * Copyright (C) 2020 Szum123321 + * + * 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 . + */ + +package szum123321.textile_backup; + +import blue.endless.jankson.Jankson; +import blue.endless.jankson.api.SyntaxError; +import net.minecraftforge.fml.loading.FMLLoader; + +import java.io.File; +import java.io.FileOutputStream; +import java.io.IOException; + +public class ConfigHandler { + /* + This part here is based on the cotton config by The Cotton Project authors. + License requires me to provide you a copy of their license, so here it goes. + + MIT License + + Copyright (c) 2018 The Cotton Project + + Permission is hereby granted, free of charge, to any person obtaining a copy + of this software and associated documentation files (the "Software"), to deal + in the Software without restriction, including without limitation the rights + to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + copies of the Software, and to permit persons to whom the Software is + furnished to do so, subject to the following conditions: + + The above copyright notice and this permission notice shall be included in all + copies or substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + SOFTWARE. + */ + + private static File getConfigFile() { + return FMLLoader + .getGamePath() + .resolve("config/") + .resolve(TextileBackup.MOD_ID + ".json5") + .toFile(); + } + + public static ConfigData loadConfig(){ + File configFile = getConfigFile(); + + if(!configFile.exists()) { + TextileBackup.logger.info("Creating new config file"); + saveConfig(new ConfigData()); + } + + try { + Jankson jankson = Jankson.builder().build(); + return jankson.fromJson(jankson.load(configFile), ConfigData.class); + } catch (IOException | SyntaxError e) { + TextileBackup.logger.error(e.getMessage()); + } + + TextileBackup.logger.info("Loading default config!"); + return new ConfigData(); + } + + public static void saveConfig(ConfigData configData) { + File configFile = getConfigFile(); + Jankson jankson = Jankson.builder().build(); + + try{ + if(!configFile.exists()){ + configFile.getParentFile().mkdirs(); + configFile.createNewFile(); + } + + FileOutputStream stream = new FileOutputStream(configFile, false); + stream.write(jankson.toJson(configData).toJson(true, true).getBytes()); + stream.flush(); + stream.close(); + + }catch (Exception e){ + e.printStackTrace(); + } + } +} diff --git a/src/main/java/szum123321/textile_backup/TextileBackup.java b/src/main/java/szum123321/textile_backup/TextileBackup.java new file mode 100644 index 0000000..8c92e01 --- /dev/null +++ b/src/main/java/szum123321/textile_backup/TextileBackup.java @@ -0,0 +1,76 @@ +/* + * Simple backup mod made for Fabric and ported to Forge + * Copyright (C) 2020 Szum123321 + * + * 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 . + */ + +package szum123321.textile_backup; + +import net.minecraft.command.Commands; +import net.minecraftforge.common.MinecraftForge; +import net.minecraftforge.eventbus.api.SubscribeEvent; +import net.minecraftforge.fml.common.Mod; +import net.minecraftforge.fml.event.lifecycle.FMLCommonSetupEvent; +import net.minecraftforge.fml.event.lifecycle.ModLifecycleEvent; +import net.minecraftforge.fml.event.server.FMLServerStartingEvent; +import net.minecraftforge.fml.javafmlmod.FMLJavaModLoadingContext; +import szum123321.textile_backup.commands.BlacklistCommand; +import szum123321.textile_backup.commands.CleanupCommand; +import szum123321.textile_backup.commands.StartBackupCommand; +import szum123321.textile_backup.commands.WhitelistCommand; +import org.apache.logging.log4j.LogManager; +import org.apache.logging.log4j.Logger; +import szum123321.textile_backup.core.ServerBackupScheduler; + +@Mod(TextileBackup.MOD_ID) +public class TextileBackup { + public static final String MOD_ID = "textile_backup"; + public static final Logger logger = LogManager.getLogger(MOD_ID); + + public static ConfigData config; + + public TextileBackup() { + FMLJavaModLoadingContext.get().getModEventBus().addListener(this::setup); + } + + public void setup(FMLCommonSetupEvent event){ + + MinecraftForge.EVENT_BUS.register(this); + MinecraftForge.EVENT_BUS.register(ServerBackupScheduler.class); + + config = ConfigHandler.loadConfig(); + logger.info("Now"); + } + + @SubscribeEvent + public void registerCommands(FMLServerStartingEvent event){ + event.getCommandDispatcher().register( + Commands.literal("backup") + .requires(ctx -> { + try { + return ((config.playerWhitelist.contains(ctx.getEntity().getName().getString()) || + ctx.hasPermissionLevel(config.permissionLevel)) && + !config.playerBlacklist.contains(ctx.getEntity().getName().getString())) || + (ctx.getServer().isSinglePlayer() && config.alwaysSingleplayerAllowed); + }catch (Exception e){ //Command was called from server console. + return true; + } + }).then(BlacklistCommand.register()) + .then(CleanupCommand.register()) + .then(StartBackupCommand.register()) + .then(WhitelistCommand.register()) + ); + } +} diff --git a/src/main/java/szum123321/textile_backup/commands/BlacklistCommand.java b/src/main/java/szum123321/textile_backup/commands/BlacklistCommand.java new file mode 100644 index 0000000..1015e04 --- /dev/null +++ b/src/main/java/szum123321/textile_backup/commands/BlacklistCommand.java @@ -0,0 +1,119 @@ +/* + * Simple backup mod made for Fabric and ported to Forge + * Copyright (C) 2020 Szum123321 + * + * 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 . + */ + +package szum123321.textile_backup.commands; + +import com.mojang.brigadier.builder.LiteralArgumentBuilder; +import com.mojang.brigadier.context.CommandContext; +import com.mojang.brigadier.exceptions.CommandSyntaxException; +import net.minecraft.command.CommandSource; +import net.minecraft.command.Commands; +import net.minecraft.command.arguments.EntityArgument; +import net.minecraft.entity.player.PlayerEntity; +import net.minecraft.util.text.StringTextComponent; +import net.minecraft.util.text.TranslationTextComponent; +import szum123321.textile_backup.ConfigHandler; +import szum123321.textile_backup.TextileBackup; +import szum123321.textile_backup.core.Utilities; + +public class BlacklistCommand { + public static LiteralArgumentBuilder register(){ + return Commands.literal("blacklist") + .then(Commands.literal("add") + .then(Commands.argument("player", EntityArgument.player()) + .executes(BlacklistCommand::executeAdd) + ) + ).then(Commands.literal("remove") + .then(Commands.argument("player", EntityArgument.player()) + .executes(BlacklistCommand::executeRemove) + ) + ).then(Commands.literal("list") + .executes(ctx -> executeList(ctx.getSource())) + ).executes(ctx -> help(ctx.getSource())); + } + + private static int help(CommandSource source){ + source.sendFeedback(new StringTextComponent("Available command are: add [player], remove [player], list."), false); + + return 1; + } + + private static int executeList(CommandSource source){ + StringBuilder builder = new StringBuilder(); + + builder.append("Currently on the blacklist are: "); + + for(String name : TextileBackup.config.playerBlacklist){ + builder.append(name); + builder.append(", "); + } + + Utilities.log(builder.toString(), source); + + return 1; + } + + private static int executeAdd(CommandContext ctx) throws CommandSyntaxException { + PlayerEntity player = EntityArgument.getPlayer(ctx, "player"); + + if(TextileBackup.config.playerBlacklist.contains(player.getName().getString())) { + ctx.getSource().sendFeedback(new TranslationTextComponent("Player: %s is already blacklisted.", player.getName()), false); + }else{ + TextileBackup.config.playerBlacklist.add(player.getName().getString()); + ConfigHandler.saveConfig(TextileBackup.config); + + StringBuilder builder = new StringBuilder(); + + builder.append("Player: "); + builder.append(player.getName()); + builder.append(" added to the blacklist"); + + if(TextileBackup.config.playerWhitelist.contains(player.getName().getString())){ + TextileBackup.config.playerWhitelist.remove(player.getName().getString()); + builder.append(" and removed form the whitelist"); + } + + builder.append(" successfully."); + + Utilities.log(builder.toString(), ctx.getSource()); + } + + return 1; + } + + private static int executeRemove(CommandContext ctx) throws CommandSyntaxException { + PlayerEntity player = EntityArgument.getPlayer(ctx, "player"); + + if(!TextileBackup.config.playerBlacklist.contains(player.getName().getString())) { + ctx.getSource().sendFeedback(new TranslationTextComponent("Player: %s newer was blacklisted.", player.getName()), false); + }else{ + TextileBackup.config.playerBlacklist.remove(player.getName().getString()); + ConfigHandler.saveConfig(TextileBackup.config); + + StringBuilder builder = new StringBuilder(); + + builder.append("Player: "); + builder.append(player.getName()); + builder.append(" removed from the blacklist successfully."); + + Utilities.log(builder.toString(), ctx.getSource()); + } + + return 1; + } +} diff --git a/src/main/java/szum123321/textile_backup/commands/CleanupCommand.java b/src/main/java/szum123321/textile_backup/commands/CleanupCommand.java new file mode 100644 index 0000000..c86ea9e --- /dev/null +++ b/src/main/java/szum123321/textile_backup/commands/CleanupCommand.java @@ -0,0 +1,40 @@ +/* + * Simple backup mod made for Fabric and ported to Forge + * Copyright (C) 2020 Szum123321 + * + * 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 . + */ + +package szum123321.textile_backup.commands; + +import com.mojang.brigadier.builder.LiteralArgumentBuilder; +import net.minecraft.command.CommandSource; +import net.minecraft.command.Commands; +import net.minecraft.util.text.StringTextComponent; +import net.minecraft.world.dimension.DimensionType; +import szum123321.textile_backup.core.BackupHelper; + +public class CleanupCommand { + public static LiteralArgumentBuilder register(){ + return Commands.literal("cleanup") + .executes(ctx -> execute(ctx.getSource())); + } + + private static int execute(CommandSource source){ + BackupHelper.executeFileLimit(source, source.getServer().getWorld(DimensionType.OVERWORLD).getWorldInfo().getWorldName()); + source.sendFeedback(new StringTextComponent("Done"), false); + + return 1; + } +} diff --git a/src/main/java/szum123321/textile_backup/commands/StartBackupCommand.java b/src/main/java/szum123321/textile_backup/commands/StartBackupCommand.java new file mode 100644 index 0000000..0cb49c0 --- /dev/null +++ b/src/main/java/szum123321/textile_backup/commands/StartBackupCommand.java @@ -0,0 +1,47 @@ +/* + * Simple backup mod made for Fabric and ported to Forge + * Copyright (C) 2020 Szum123321 + * + * 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 . + */ + +package szum123321.textile_backup.commands; + +import com.mojang.brigadier.arguments.StringArgumentType; +import com.mojang.brigadier.builder.LiteralArgumentBuilder; +import com.mojang.brigadier.context.CommandContext; +import net.minecraft.command.CommandSource; +import net.minecraft.command.Commands; +import szum123321.textile_backup.core.BackupHelper; + +public class StartBackupCommand { + public static LiteralArgumentBuilder register(){ + return Commands.literal("start") + .then(Commands.argument("comment", StringArgumentType.string()) + .executes(StartBackupCommand::executeWithComment) + ).executes(ctx -> execute(ctx.getSource())); + } + + private static int executeWithComment(CommandContext source) { + BackupHelper.create(source.getSource().getServer(), source.getSource(), true, StringArgumentType.getString(source, "comment").replace("#", "")); + + return 1; + } + + private static int execute(CommandSource source){ + BackupHelper.create(source.getServer(), source,true, null); + + return 1; + } +} diff --git a/src/main/java/szum123321/textile_backup/commands/WhitelistCommand.java b/src/main/java/szum123321/textile_backup/commands/WhitelistCommand.java new file mode 100644 index 0000000..7f4e1b8 --- /dev/null +++ b/src/main/java/szum123321/textile_backup/commands/WhitelistCommand.java @@ -0,0 +1,118 @@ +/* + * Simple backup mod made for Fabric and ported to Forge + * Copyright (C) 2020 Szum123321 + * + * 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 . + */ + +package szum123321.textile_backup.commands; + +import com.mojang.brigadier.builder.LiteralArgumentBuilder; +import com.mojang.brigadier.context.CommandContext; +import com.mojang.brigadier.exceptions.CommandSyntaxException; +import net.minecraft.command.CommandSource; +import net.minecraft.command.Commands; +import net.minecraft.command.arguments.EntityArgument; +import net.minecraft.entity.player.PlayerEntity; +import net.minecraft.util.text.StringTextComponent; +import net.minecraft.util.text.TranslationTextComponent; +import szum123321.textile_backup.ConfigHandler; +import szum123321.textile_backup.TextileBackup; +import szum123321.textile_backup.core.Utilities; + +public class WhitelistCommand { + public static LiteralArgumentBuilder register(){ + return Commands.literal("whitelist") + .then(Commands.literal("add") + .then(Commands.argument("player", EntityArgument.player()) + .executes(WhitelistCommand::executeAdd) + ) + ).then(Commands.literal("remove") + .then(Commands.argument("player", EntityArgument.player()) + .executes(WhitelistCommand::executeRemove) + ) + ).then(Commands.literal("list") + .executes(ctx -> executeList(ctx.getSource())) + ).executes(ctx -> help(ctx.getSource())); + } + + private static int help(CommandSource source){ + source.sendFeedback(new StringTextComponent("Available command are: add [player], remove [player], list."), false); + + return 1; + } + + private static int executeList(CommandSource source){ + StringBuilder builder = new StringBuilder(); + + builder.append("Currently on the whitelist are: "); + + for(String name : TextileBackup.config.playerWhitelist){ + builder.append(name); + builder.append(", "); + } + + Utilities.log(builder.toString(), source); + + return 1; + } + + private static int executeAdd(CommandContext ctx) throws CommandSyntaxException { + PlayerEntity player = EntityArgument.getPlayer(ctx, "player"); + + if(TextileBackup.config.playerWhitelist.contains(player.getName().getString())) { + ctx.getSource().sendFeedback(new TranslationTextComponent("Player: %s is already whitelisted.", player.getName()), false); + }else{ + TextileBackup.config.playerWhitelist.add(player.getName().getString()); + ConfigHandler.saveConfig(TextileBackup.config); + + StringBuilder builder = new StringBuilder(); + + builder.append("Player: "); + builder.append(player.getName()); + builder.append(" added to the whitelist"); + + if(TextileBackup.config.playerBlacklist.contains(player.getName().getString())){ + TextileBackup.config.playerBlacklist.remove(player.getName().getString()); + builder.append(" and removed form the blacklist"); + } + + builder.append(" successfully."); + + Utilities.log(builder.toString(), ctx.getSource()); + } + + return 1; + } + + private static int executeRemove(CommandContext ctx) throws CommandSyntaxException { + PlayerEntity player = EntityArgument.getPlayer(ctx, "player"); + + if(!TextileBackup.config.playerWhitelist.contains(player.getName().getString())) { + ctx.getSource().sendFeedback(new TranslationTextComponent("Player: %s newer was on the whitelist.", player.getName()), false); + }else{ + TextileBackup.config.playerWhitelist.remove(player.getName().getString()); + ConfigHandler.saveConfig(TextileBackup.config); + StringBuilder builder = new StringBuilder(); + + builder.append("Player: "); + builder.append(player.getName()); + builder.append(" removed from the whitelist successfully."); + + Utilities.log(builder.toString(), ctx.getSource()); + } + + return 1; + } +} diff --git a/src/main/java/net/szum123321/textile_backup/core/BackupHelper.java b/src/main/java/szum123321/textile_backup/core/BackupHelper.java similarity index 75% rename from src/main/java/net/szum123321/textile_backup/core/BackupHelper.java rename to src/main/java/szum123321/textile_backup/core/BackupHelper.java index 1a33e5c..fbb6c93 100644 --- a/src/main/java/net/szum123321/textile_backup/core/BackupHelper.java +++ b/src/main/java/szum123321/textile_backup/core/BackupHelper.java @@ -1,27 +1,27 @@ /* - A simple backup mod for Fabric - Copyright (C) 2020 Szum123321 + * Simple backup mod made for Fabric and ported to Forge + * Copyright (C) 2020 Szum123321 + * + * 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 . + */ - 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. +package szum123321.textile_backup.core; - 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 . -*/ - -package net.szum123321.textile_backup.core; - -import net.fabricmc.loader.api.FabricLoader; +import net.minecraft.command.CommandSource; import net.minecraft.server.MinecraftServer; -import net.minecraft.server.command.ServerCommandSource; -import net.szum123321.textile_backup.TextileBackup; +import net.minecraftforge.fml.loading.FMLLoader; +import szum123321.textile_backup.TextileBackup; import org.apache.commons.io.FileUtils; import java.io.File; @@ -31,7 +31,7 @@ import java.time.ZoneOffset; import java.util.Arrays; public class BackupHelper { - public static void create(MinecraftServer server, ServerCommandSource ctx, boolean save, String comment) { + public static void create(MinecraftServer server, CommandSource ctx, boolean save, String comment) { LocalDateTime now = LocalDateTime.now(); StringBuilder builder = new StringBuilder(); @@ -57,7 +57,7 @@ public class BackupHelper { thread.start(); } - public static void executeFileLimit(ServerCommandSource ctx, String worldName){ + public static void executeFileLimit(CommandSource ctx, String worldName){ File root = getBackupRootPath(worldName); FileFilter filter = f -> f.getName().endsWith("zip"); @@ -130,10 +130,8 @@ public class BackupHelper { }catch(Exception e){ TextileBackup.logger.error(e.getMessage()); - return FabricLoader - .getInstance() - .getGameDirectory() - .toPath() + return FMLLoader + .getGamePath() .resolve(TextileBackup.config.path) .toFile(); } diff --git a/src/main/java/net/szum123321/textile_backup/core/MakeBackupThread.java b/src/main/java/szum123321/textile_backup/core/MakeBackupThread.java similarity index 55% rename from src/main/java/net/szum123321/textile_backup/core/MakeBackupThread.java rename to src/main/java/szum123321/textile_backup/core/MakeBackupThread.java index 8d40756..c1c7f1d 100644 --- a/src/main/java/net/szum123321/textile_backup/core/MakeBackupThread.java +++ b/src/main/java/szum123321/textile_backup/core/MakeBackupThread.java @@ -1,25 +1,25 @@ /* - A simple backup mod for Fabric - Copyright (C) 2020 Szum123321 + * Simple backup mod made for Fabric and ported to Forge + * Copyright (C) 2020 Szum123321 + * + * 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 . + */ - 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 . -*/ - -package net.szum123321.textile_backup.core; +package szum123321.textile_backup.core; +import net.minecraft.command.CommandSource; import net.minecraft.server.MinecraftServer; -import net.minecraft.server.command.ServerCommandSource; import net.minecraft.world.dimension.DimensionType; import java.io.File; @@ -28,10 +28,10 @@ import java.time.LocalDateTime; public class MakeBackupThread implements Runnable { private MinecraftServer server; - private ServerCommandSource ctx; + private CommandSource ctx; private String comment; - public MakeBackupThread(MinecraftServer server, ServerCommandSource ctx, String comment){ + public MakeBackupThread(MinecraftServer server, CommandSource ctx, String comment){ this.server = server; this.ctx = ctx; this.comment = comment; @@ -42,10 +42,10 @@ public class MakeBackupThread implements Runnable { File world = server .getWorld(DimensionType.OVERWORLD) .getSaveHandler() - .getWorldDir(); + .getWorldDirectory(); File outFile = BackupHelper - .getBackupRootPath(server.getWorld(DimensionType.OVERWORLD).getLevelProperties().getLevelName()) + .getBackupRootPath(server.getWorld(DimensionType.OVERWORLD).getWorldInfo().getWorldName()) .toPath() .resolve(getFileName()) .toFile(); @@ -61,7 +61,7 @@ public class MakeBackupThread implements Runnable { ZipCompressor.createArchive(world, outFile, ctx); - BackupHelper.executeFileLimit(ctx, server.getWorld(DimensionType.OVERWORLD).getLevelProperties().getLevelName()); + BackupHelper.executeFileLimit(ctx, server.getWorld(DimensionType.OVERWORLD).getWorldInfo().getWorldName()); Utilities.log("Done!", ctx); } diff --git a/src/main/java/szum123321/textile_backup/core/ServerBackupScheduler.java b/src/main/java/szum123321/textile_backup/core/ServerBackupScheduler.java new file mode 100644 index 0000000..91ac116 --- /dev/null +++ b/src/main/java/szum123321/textile_backup/core/ServerBackupScheduler.java @@ -0,0 +1,61 @@ +/* + * Simple backup mod made for Fabric and ported to Forge + * Copyright (C) 2020 Szum123321 + * + * 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 . + */ + +package szum123321.textile_backup.core; + +import net.minecraft.server.MinecraftServer; +import net.minecraftforge.event.TickEvent; +import net.minecraftforge.eventbus.api.SubscribeEvent; +import net.minecraftforge.fml.event.server.FMLServerStartingEvent; +import net.minecraftforge.fml.event.server.FMLServerStoppedEvent; +import szum123321.textile_backup.TextileBackup; + +public class ServerBackupScheduler { + private static long lastBackupTime; + private static MinecraftServer server; + + @SubscribeEvent + public static void onServerTick(TickEvent.ServerTickEvent event) { + if(event.phase == TickEvent.Phase.START) { + TextileBackup.logger.info("Diiff: " + (System.currentTimeMillis() - lastBackupTime)); + if(System.currentTimeMillis() - lastBackupTime >= TextileBackup.config.backupInterval * 1000) { + if(server.getPlayerList().getCurrentPlayerCount() > 0 || TextileBackup.config.doBackupsOnEmptyServer) + BackupHelper.create(server, null, true, null); + + TextileBackup.logger.info("Time: " + lastBackupTime); + + lastBackupTime = System.currentTimeMillis(); + } + } + } + + @SubscribeEvent + public static void onServerStarted(FMLServerStartingEvent event) { + server = event.getServer(); + lastBackupTime = System.currentTimeMillis(); + + TextileBackup.logger.info("Server Starting at: " + lastBackupTime); + TextileBackup.logger.info("Interval is: " + TextileBackup.config.backupInterval); + } + + @SubscribeEvent + public static void onServerStopped(FMLServerStoppedEvent event) { + if(TextileBackup.config.shutdownBackup) + BackupHelper.create(event.getServer(), null, false, null); + } +} diff --git a/src/main/java/szum123321/textile_backup/core/Utilities.java b/src/main/java/szum123321/textile_backup/core/Utilities.java new file mode 100644 index 0000000..295ee9e --- /dev/null +++ b/src/main/java/szum123321/textile_backup/core/Utilities.java @@ -0,0 +1,63 @@ +/* + * Simple backup mod made for Fabric and ported to Forge + * Copyright (C) 2020 Szum123321 + * + * 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 . + */ + +package szum123321.textile_backup.core; + +import net.minecraft.command.CommandSource; +import net.minecraft.util.text.StringTextComponent; +import szum123321.textile_backup.TextileBackup; + +import java.time.format.DateTimeFormatter; + +public class Utilities { + public static boolean isWindows(){ + String os = System.getProperty("os.name"); + return os.toLowerCase().startsWith("win"); + } + + public static DateTimeFormatter getDateTimeFormatter(){ + if(!TextileBackup.config.dateTimeFormat.equals("")) + return DateTimeFormatter.ofPattern(TextileBackup.config.dateTimeFormat); + else + return getBackupDateTimeFormatter(); + } + + public static DateTimeFormatter getBackupDateTimeFormatter(){ + if(isWindows()){ + return DateTimeFormatter.ofPattern("dd.MM.yyyy_HH-mm-ss"); + } else { + return DateTimeFormatter.ofPattern("dd.MM.yyyy_HH:mm:ss"); + } + } + + public static void log(String s, CommandSource ctx){ + if(ctx != null) + ctx.sendFeedback(new StringTextComponent(s), false); + + if(TextileBackup.config.log) + TextileBackup.logger.info(s); + } + + public static void error(String s, CommandSource ctx){ + if(ctx != null) + ctx.sendFeedback(new StringTextComponent(s), true); + + if(TextileBackup.config.log) + TextileBackup.logger.error(s); + } +} diff --git a/src/main/java/net/szum123321/textile_backup/core/ZipCompressor.java b/src/main/java/szum123321/textile_backup/core/ZipCompressor.java similarity index 58% rename from src/main/java/net/szum123321/textile_backup/core/ZipCompressor.java rename to src/main/java/szum123321/textile_backup/core/ZipCompressor.java index a4f2ded..36d91f0 100644 --- a/src/main/java/net/szum123321/textile_backup/core/ZipCompressor.java +++ b/src/main/java/szum123321/textile_backup/core/ZipCompressor.java @@ -1,28 +1,25 @@ /* - A simple backup mod for Fabric - Copyright (C) 2020 Szum123321 + * Simple backup mod made for Fabric and ported to Forge + * Copyright (C) 2020 Szum123321 + * + * 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 . + */ - 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. +package szum123321.textile_backup.core; - 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 . -*/ - -package net.szum123321.textile_backup.core; - -import net.minecraft.server.command.ServerCommandSource; -import net.szum123321.textile_backup.TextileBackup; -import org.apache.commons.compress.archivers.tar.TarArchiveEntry; -import org.apache.commons.compress.archivers.tar.TarArchiveOutputStream; -import org.apache.commons.compress.compressors.bzip2.BZip2CompressorOutputStream; +import net.minecraft.command.CommandSource; +import szum123321.textile_backup.TextileBackup; import org.apache.commons.compress.utils.IOUtils; import java.io.File; @@ -35,7 +32,7 @@ import java.util.zip.ZipEntry; import java.util.zip.ZipOutputStream; public class ZipCompressor { - public static void createArchive(File in, File out, ServerCommandSource ctx){ + public static void createArchive(File in, File out, CommandSource ctx){ Utilities.log("Starting compression...", ctx); try (ZipOutputStream arc = new ZipOutputStream(new FileOutputStream(out))){ diff --git a/src/main/resources/META-INF/mods.toml b/src/main/resources/META-INF/mods.toml new file mode 100644 index 0000000..bab0560 --- /dev/null +++ b/src/main/resources/META-INF/mods.toml @@ -0,0 +1,38 @@ +modLoader="javafml" #mandatory +loaderVersion="[28,)" #mandatory (28 is current forge version) +issueTrackerURL="http://my.issue.tracker/" #optional + +[[mods]] #mandatory +# The modid of the mod +modId="textile_backup" #mandatory +version="${file.jarVersion}" #mandatory +displayName="Textile Backup" #mandatory +# A URL to query for updates for this mod. See the JSON update specification +updateJSONURL="http://myurl.me/" #optional +displayURL="http://example.com/" #optional +logoFile="examplemod.png" #optional +credits="Thanks for this example mod goes to Java" #optional +authors="Szum123321" #optional +description=''' + +''' + +# A dependency - use the . to indicate dependency for a specific modid. Dependencies are optional. +[[dependencies.textile_backup]] #optional + # the modid of the dependency + modId="forge" #mandatory + # Does this dependency have to exist - if not, ordering below must be specified + mandatory=true #mandatory + # The version range of the dependency + versionRange="[28,)" #mandatory + # An ordering relationship for the dependency - BEFORE or AFTER required if the relationship is not mandatory + ordering="NONE" + # Side this dependency is applied on - BOTH, CLIENT or SERVER + side="BOTH" +# Here's another dependency +[[dependencies.examplemod]] + modId="minecraft" + mandatory=true + versionRange="[1.14.4]" + ordering="NONE" + side="BOTH" diff --git a/src/main/resources/assets/textile_backup/textile_backup.png b/src/main/resources/assets/textile_backup/textile_backup.png deleted file mode 100644 index 0499833..0000000 Binary files a/src/main/resources/assets/textile_backup/textile_backup.png and /dev/null differ diff --git a/src/main/resources/fabric.mod.json b/src/main/resources/fabric.mod.json deleted file mode 100644 index 73e90a0..0000000 --- a/src/main/resources/fabric.mod.json +++ /dev/null @@ -1,34 +0,0 @@ -{ - "schemaVersion": 1, - "id": "textile_backup", - "version": "${version}", - - "name": "Textile Backup", - "description": "Small, configurable, fully server-sided backup mod for Fabric", - "authors": [ - "Szum123321" - ], - "contact": { - "homepage": "https://www.curseforge.com/minecraft/mc-mods/textile-backup", - "sources": "https://github.com/Szum123321/textile_backup" - }, - - "license": "GPLv3", - "icon": "assets/textile_backup/textile_backup.png", - - "environment": "*", - "entrypoints": { - "main": [ - "net.szum123321.textile_backup.TextileBackup" - ] - }, - "mixins": [ - "textile_backup.mixins.json" - ], - - "depends": { - "fabricloader": ">=0.7.2", - "fabric": "*", - "minecraft": "1.16.*" - } -} diff --git a/src/main/resources/pack.mcmeta b/src/main/resources/pack.mcmeta new file mode 100644 index 0000000..42ab490 --- /dev/null +++ b/src/main/resources/pack.mcmeta @@ -0,0 +1,7 @@ +{ + "pack": { + "description": "examplemod resources", + "pack_format": 4, + "_comment": "A pack_format of 4 requires json lang files. Note: we require v4 pack meta for all mods." + } +} diff --git a/src/main/resources/textile_backup.mixins.json b/src/main/resources/textile_backup.mixins.json deleted file mode 100644 index 437829e..0000000 --- a/src/main/resources/textile_backup.mixins.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "required": true, - "package": "net.szum123321.textile_backup.mixin", - "compatibilityLevel": "JAVA_8", - "mixins": [ - "MinecraftServerMixin" - ], - "client": [ - ], - "injectors": { - "defaultRequire": 1 - } -}