docs: 添加todo.md

LICENSE.txt

@@ -0,0 +1,674 @@
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+  The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works.  By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.  We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors.  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+  To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights.  Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received.  You must make sure that they, too, receive
+or can get the source code.  And you must show them these terms so they
+know their rights.
+
+  Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+  For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software.  For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+  Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so.  This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software.  The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable.  Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products.  If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+  Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary.  To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                       TERMS AND CONDITIONS
+
+  0. Definitions.
+
+  "This License" refers to version 3 of the GNU General Public License.
+
+  "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+  "The Program" refers to any copyrightable work licensed under this
+License.  Each licensee is addressed as "you".  "Licensees" and
+"recipients" may be individuals or organizations.
+
+  To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy.  The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+  A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+  To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy.  Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+  To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies.  Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+  An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License.  If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+  1. Source Code.
+
+  The "source code" for a work means the preferred form of the work
+for making modifications to it.  "Object code" means any non-source
+form of a work.
+
+  A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+  The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form.  A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+  The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities.  However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work.  For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+  The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+  The Corresponding Source for a work in source code form is that
+same work.
+
+  2. Basic Permissions.
+
+  All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met.  This License explicitly affirms your unlimited
+permission to run the unmodified Program.  The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work.  This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+  You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force.  You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright.  Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+  Conveying under any other circumstances is permitted solely under
+the conditions stated below.  Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+  No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+  When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+  4. Conveying Verbatim Copies.
+
+  You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+  You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+  5. Conveying Modified Source Versions.
+
+  You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+    a) The work must carry prominent notices stating that you modified
+    it, and giving a relevant date.
+
+    b) The work must carry prominent notices stating that it is
+    released under this License and any conditions added under section
+    7.  This requirement modifies the requirement in section 4 to
+    "keep intact all notices".
+
+    c) You must license the entire work, as a whole, under this
+    License to anyone who comes into possession of a copy.  This
+    License will therefore apply, along with any applicable section 7
+    additional terms, to the whole of the work, and all its parts,
+    regardless of how they are packaged.  This License gives no
+    permission to license the work in any other way, but it does not
+    invalidate such permission if you have separately received it.
+
+    d) If the work has interactive user interfaces, each must display
+    Appropriate Legal Notices; however, if the Program has interactive
+    interfaces that do not display Appropriate Legal Notices, your
+    work need not make them do so.
+
+  A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit.  Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+  6. Conveying Non-Source Forms.
+
+  You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+    a) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by the
+    Corresponding Source fixed on a durable physical medium
+    customarily used for software interchange.
+
+    b) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by a
+    written offer, valid for at least three years and valid for as
+    long as you offer spare parts or customer support for that product
+    model, to give anyone who possesses the object code either (1) a
+    copy of the Corresponding Source for all the software in the
+    product that is covered by this License, on a durable physical
+    medium customarily used for software interchange, for a price no
+    more than your reasonable cost of physically performing this
+    conveying of source, or (2) access to copy the
+    Corresponding Source from a network server at no charge.
+
+    c) Convey individual copies of the object code with a copy of the
+    written offer to provide the Corresponding Source.  This
+    alternative is allowed only occasionally and noncommercially, and
+    only if you received the object code with such an offer, in accord
+    with subsection 6b.
+
+    d) Convey the object code by offering access from a designated
+    place (gratis or for a charge), and offer equivalent access to the
+    Corresponding Source in the same way through the same place at no
+    further charge.  You need not require recipients to copy the
+    Corresponding Source along with the object code.  If the place to
+    copy the object code is a network server, the Corresponding Source
+    may be on a different server (operated by you or a third party)
+    that supports equivalent copying facilities, provided you maintain
+    clear directions next to the object code saying where to find the
+    Corresponding Source.  Regardless of what server hosts the
+    Corresponding Source, you remain obligated to ensure that it is
+    available for as long as needed to satisfy these requirements.
+
+    e) Convey the object code using peer-to-peer transmission, provided
+    you inform other peers where the object code and Corresponding
+    Source of the work are being offered to the general public at no
+    charge under subsection 6d.
+
+  A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+  A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling.  In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage.  For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product.  A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+  "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source.  The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+  If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information.  But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+  The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed.  Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+  Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+  7. Additional Terms.
+
+  "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law.  If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+  When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it.  (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.)  You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+  Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+    a) Disclaiming warranty or limiting liability differently from the
+    terms of sections 15 and 16 of this License; or
+
+    b) Requiring preservation of specified reasonable legal notices or
+    author attributions in that material or in the Appropriate Legal
+    Notices displayed by works containing it; or
+
+    c) Prohibiting misrepresentation of the origin of that material, or
+    requiring that modified versions of such material be marked in
+    reasonable ways as different from the original version; or
+
+    d) Limiting the use for publicity purposes of names of licensors or
+    authors of the material; or
+
+    e) Declining to grant rights under trademark law for use of some
+    trade names, trademarks, or service marks; or
+
+    f) Requiring indemnification of licensors and authors of that
+    material by anyone who conveys the material (or modified versions of
+    it) with contractual assumptions of liability to the recipient, for
+    any liability that these contractual assumptions directly impose on
+    those licensors and authors.
+
+  All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10.  If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term.  If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+  If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+  Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+  8. Termination.
+
+  You may not propagate or modify a covered work except as expressly
+provided under this License.  Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+  However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+  Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+  Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License.  If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+  9. Acceptance Not Required for Having Copies.
+
+  You are not required to accept this License in order to receive or
+run a copy of the Program.  Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance.  However,
+nothing other than this License grants you permission to propagate or
+modify any covered work.  These actions infringe copyright if you do
+not accept this License.  Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+  10. Automatic Licensing of Downstream Recipients.
+
+  Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License.  You are not responsible
+for enforcing compliance by third parties with this License.
+
+  An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations.  If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+  You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License.  For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+  11. Patents.
+
+  A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based.  The
+work thus licensed is called the contributor's "contributor version".
+
+  A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version.  For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+  Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+  In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement).  To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+  If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients.  "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+  If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+  A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License.  You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+  Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+  12. No Surrender of Others' Freedom.
+
+  If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all.  For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+  13. Use with the GNU Affero General Public License.
+
+  Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work.  The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+  14. Revised Versions of this License.
+
+  The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+  Each version is given a distinguishing version number.  If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation.  If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+  If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+  Later license versions may give you additional or different
+permissions.  However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+  15. Disclaimer of Warranty.
+
+  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+  16. Limitation of Liability.
+
+  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+  17. Interpretation of Sections 15 and 16.
+
+  If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    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 <https://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+  If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+    <program>  Copyright (C) <year>  <name of author>
+    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+  You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+<https://www.gnu.org/licenses/>.
+
+  The GNU General Public License does not permit incorporating your program
+into proprietary programs.  If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.  But first, please read
+<https://www.gnu.org/licenses/why-not-lgpl.html>.

README.md

@@ -26,44 +26,44 @@ mod包名为com.le.teleportmirror 。
 
 ## 回城魔镜
 ### 初级回城魔镜
-金锭 指南针 金锭
-铁锭 蓝色染色玻璃板 铁锭
+金锭 指南针 金锭  
+铁锭 蓝色染色玻璃板 铁锭  
 铜锭 铁锭 铜锭
 
 ### 中级回城魔镜
-钻石 末影珍珠 钻石
-青金石 初级回城魔镜 青金石
+钻石 末影珍珠 钻石  
+青金石 初级回城魔镜 青金石  
 红石 紫水晶碎片 红石
 
 ### 高级回城魔镜
-钻石 末影之眼 钻石
-绿宝石 中级回城魔镜 绿宝石
+钻石 末影之眼 钻石  
+绿宝石 中级回城魔镜 绿宝石  
 钻石 烈焰棒 钻石
 
 ### 永久回城魔镜
-潜影壳 紫颂果 潜影壳
-末影珍珠 高级回城魔镜 末影珍珠
+潜影壳 紫颂果 潜影壳  
+末影珍珠 高级回城魔镜 末影珍珠  
 潜影壳 回响碎片 潜影壳
 
 ## 传送魔镜
 ### 初级传送魔镜
-金锭 拴绳 金锭
-铁锭 橙色染色玻璃板 铁锭
+金锭 拴绳 金锭  
+铁锭 橙色染色玻璃板 铁锭  
 铜锭 铁锭 铜锭
 
 ### 中级传送魔镜
-钻石 末影珍珠 钻石
-青金石 初级传送魔镜 青金石
+钻石 末影珍珠 钻石  
+青金石 初级传送魔镜 青金石  
 红石 紫水晶碎片 红石
 
 ### 高级传送魔镜
-钻石 末影之眼 钻石
-绿宝石 中级传送魔镜 绿宝石
+钻石 末影之眼 钻石  
+绿宝石 中级传送魔镜 绿宝石  
 钻石 烈焰棒 钻石
 
 ### 永久传送魔镜
-潜影壳 紫颂果 潜影壳
-末影珍珠 高级传送魔镜 末影珍珠
+潜影壳 紫颂果 潜影壳  
+末影珍珠 高级传送魔镜 末影珍珠  
 潜影壳 回响碎片 潜影壳
 
 # 五、特殊机制

TEMPLATE_LICENSE.txt

@@ -1,24 +0,0 @@
-MIT License
-
-Copyright (c) 2023 NeoForged project
-
-This license applies to the template files as supplied by github.com/NeoForged/MDK
-
-
-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.

TODO.md

@@ -0,0 +1,27 @@
+# TODO
+
+本文件用于规划该项目的当前版本功能。
+
+---
+
+# 高优先级
+- [ ] 添加与xaero小地图的联动传送功能
+
+
+# 中优先级
+- [ ] 项目1
+        解释
+- [ ] 项目2
+        解释
+
+# 低优先级
+- [ ] 项目1
+        解释
+- [ ] 项目2
+        解释
+
+# 灵感
+- [ ] 项目1
+        解释
+- [ ] 项目2
+        解释

gradle.properties

@@ -32,7 +32,7 @@ mod_name=Teleport Mirror
 # The license of the mod. Review your options at https://choosealicense.com/. All Rights Reserved is the default.
 mod_license=MIT
 # The mod version. See https://semver.org/
-mod_version=1.0.2
+mod_version=1.0.3
 # The group ID for the mod. It is only important when publishing as an artifact to a Maven repository.
 # This should match the base package used for the mod sources.
 # See https://maven.apache.org/guides/mini/guide-naming-conventions.html

src/main/java/com/le/teleportmirror/Config.java

@@ -2,6 +2,22 @@ package com.le.teleportmirror;
 
 import net.neoforged.neoforge.common.ModConfigSpec;
 
+/**
+ * Mod 配置项
+ * <p>
+ * 使用 NeoForge 的 {@link ModConfigSpec} 定义所有可配置项。
+ * 所有配置项按功能分为以下几个部分：
+ * <ul>
+ *   <li>General - 通用设置（冷却时间、蓄力时间）</li>
+ *   <li>Cross-Dimension - 跨维度传送开关</li>
+ *   <li>Teleport Restrictions - 传送限制（同队伍限制）</li>
+ *   <li>Durability - 各级魔镜耐久度</li>
+ *   <li>Food Cost - 饱食度/饱和度消耗</li>
+ *   <li>Side Effects - 副作用效果配置</li>
+ *   <li>Recipe Toggles - 配方启用开关</li>
+ *   <li>Recipe Overrides - 自定义配方覆盖</li>
+ * </ul>
+ */
 public class Config {
     private static final ModConfigSpec.Builder BUILDER = new ModConfigSpec.Builder();
 

src/main/java/com/le/teleportmirror/MirrorItem.java

@@ -20,34 +20,60 @@ import net.minecraft.world.item.ItemStack;
 import net.minecraft.world.item.UseAnim;
 import net.minecraft.world.level.Level;
 
+/**
+ * 魔镜物品类
+ * <p>
+ * 魔镜是一个可蓄力使用的物品，长按右键蓄力完成后触发传送效果。
+ * 支持两种功能类型（回城/传送）和四个等级（初级/中级/高级/永久）。
+ * <p>
+ * 使用流程：
+ * <ol>
+ *   <li>玩家右键开始蓄力（显示弓的动画）</li>
+ *   <li>达到蓄力时间后触发效果</li>
+ *   <li>回城魔镜直接传送；传送魔镜打开玩家选择界面</li>
+ *   <li>消耗耐久、附加副作用、设置冷却</li>
+ * </ol>
+ */
 public class MirrorItem extends Item {
+    /** 魔镜等级 */
     private final MirrorTier tier;
+    /** 魔镜功能类型 */
     private final MirrorType type;
 
+    /**
+     * @param tier 魔镜等级
+     * @param type 魔镜类型（回城或传送）
+     * @param properties 物品属性（耐久度、堆叠数等）
+     */
     public MirrorItem(MirrorTier tier, MirrorType type, Properties properties) {
         super(properties);
         this.tier = tier;
         this.type = type;
     }
 
+    /** 获取魔镜等级 */
     public MirrorTier getTier() {
         return tier;
     }
 
+    /** 获取魔镜功能类型 */
     public MirrorType getMirrorType() {
         return type;
     }
 
+    /** 使用弓的拉动动画来表现蓄力过程 */
     @Override
     public UseAnim getUseAnimation(ItemStack stack) {
         return UseAnim.BOW;
     }
 
+    /** 允许无限蓄力（实际在 onUseTick 中检测是否达到蓄力阈值） */
     @Override
     public int getUseDuration(ItemStack stack, LivingEntity entity) {
         return 72000;
     }
 
+    /** 右键开始使用魔镜，若在冷却中则无法使用 */
     @Override
     public InteractionResultHolder<ItemStack> use(Level level, Player player, InteractionHand hand) {
         ItemStack stack = player.getItemInHand(hand);
@@ -58,6 +84,10 @@ public class MirrorItem extends Item {
         return InteractionResultHolder.consume(stack);
     }
 
+    /**
+     * 每 tick 调用，检测蓄力是否达到设定阈值。
+     * 到达阈值后停止蓄力，并根据魔镜类型执行回城传送或打开玩家选择界面。
+     */
     @Override
     public void onUseTick(Level level, LivingEntity livingEntity, ItemStack stack, int remainingUseDuration) {
         if (level.isClientSide) {
@@ -86,6 +116,9 @@ public class MirrorItem extends Item {
     public void releaseUsing(ItemStack stack, Level level, LivingEntity entity, int timeCharged) {
     }
 
+    /**
+     * 检查当前等级的魔镜是否允许跨维度传送
+     */
     private boolean canCrossDimension() {
         return switch (tier) {
             case BASIC -> Config.ALLOW_CROSS_DIMENSION_BASIC.get();
@@ -95,6 +128,12 @@ public class MirrorItem extends Item {
         };
     }
 
+    /**
+     * 执行回城传送：将玩家传送到其重生点或世界出生点
+     *
+     * @param player 使用魔镜的玩家
+     * @param stack 魔镜物品堆
+     */
     private void performReturnTeleport(ServerPlayer player, ItemStack stack) {
         ServerLevel serverLevel = player.serverLevel();
         BlockPos targetPos;
@@ -102,6 +141,7 @@ public class MirrorItem extends Item {
         ResourceKey<Level> respawnDimension = player.getRespawnDimension();
         BlockPos respawnPos = player.getRespawnPosition();
 
+        // 优先使用玩家的重生点（床/重生锚）
         if (respawnPos != null) {
             targetLevel = player.server.getLevel(respawnDimension);
             if (targetLevel == null) {
@@ -109,6 +149,7 @@ public class MirrorItem extends Item {
             }
             targetPos = respawnPos;
         } else {
+            // 否则使用主世界的全局出生点
             targetLevel = player.server.getLevel(Level.OVERWORLD);
             if (targetLevel == null) {
                 targetLevel = serverLevel;
@@ -128,6 +169,13 @@ public class MirrorItem extends Item {
         targetLevel.playSound(null, targetPos, SoundEvents.ENDERMAN_TELEPORT, SoundSource.PLAYERS, 1.0f, 1.0f);
     }
 
+    /**
+     * 执行传送到目标玩家身边
+     *
+     * @param player 使用魔镜的玩家
+     * @param target 目标玩家
+     * @param stack 魔镜物品堆
+     */
     public void performTeleportToPlayer(ServerPlayer player, ServerPlayer target, ItemStack stack) {
         ServerLevel targetLevel = target.serverLevel();
         BlockPos targetPos = target.blockPosition();
@@ -144,6 +192,10 @@ public class MirrorItem extends Item {
         targetLevel.playSound(null, targetPos, SoundEvents.ENDERMAN_TELEPORT, SoundSource.PLAYERS, 1.0f, 1.0f);
     }
 
+    /**
+     * 获取配置中的最大耐久度
+     * 永久等级返回 {@link Integer#MAX_VALUE}
+     */
     private int getConfigMaxDamage() {
         return switch (tier) {
             case BASIC -> Config.BASIC_DURABILITY.get();
@@ -153,6 +205,9 @@ public class MirrorItem extends Item {
         };
     }
 
+    /**
+     * 消耗一次魔镜使用：附加副作用、设置冷却、扣除耐久
+     */
     private void consumeMirrorUse(ServerPlayer player, ItemStack stack) {
         applySideEffects(player);
         applyCooldown(player);
@@ -160,6 +215,7 @@ public class MirrorItem extends Item {
         if (!tier.isPermanent()) {
             int maxDamage = getConfigMaxDamage();
             if (stack.getDamageValue() + 1 >= maxDamage) {
+                // 耐久耗尽，物品销毁
                 stack.shrink(1);
                 player.level().playSound(null, player.blockPosition(),
                         SoundEvents.ITEM_BREAK, SoundSource.PLAYERS, 1.0f, 1.0f);
@@ -169,11 +225,13 @@ public class MirrorItem extends Item {
         }
     }
 
+    /** 设置冷却时间（以 tick 为单位，1秒=20tick） */
     private void applyCooldown(Player player) {
         int cooldownTicks = Config.COOLDOWN_SECONDS.get() * 20;
         player.getCooldowns().addCooldown(this, cooldownTicks);
     }
 
+    /** 根据魔镜类型和等级获取副作用配置字符串 */
     private String getEffectsConfig() {
         return switch (type) {
             case RETURN -> switch (tier) {
@@ -191,6 +249,7 @@ public class MirrorItem extends Item {
         };
     }
 
+    /** 根据魔镜等级获取饱食度消耗配置字符串 */
     private String getFoodLevelConfig() {
         return switch (tier) {
             case BASIC -> Config.FOOD_LEVEL_BASIC.get();
@@ -200,6 +259,7 @@ public class MirrorItem extends Item {
         };
     }
 
+    /** 根据魔镜等级获取饱和度消耗配置字符串 */
     private String getSaturationConfig() {
         return switch (tier) {
             case BASIC -> Config.SATURATION_COST_BASIC.get();
@@ -209,6 +269,10 @@ public class MirrorItem extends Item {
         };
     }
 
+    /**
+     * 给玩家附加副作用效果和饱食度消耗
+     * 副作用配置格式："effect_id,dur_seconds,amplifier;..."
+     */
     private void applySideEffects(Player player) {
         String effectsConfig = getEffectsConfig();
         if (effectsConfig == null || effectsConfig.isBlank()) {
@@ -245,12 +309,21 @@ public class MirrorItem extends Item {
         applyFoodCost(player);
     }
 
+    /** 扣减饱食度和饱和度 */
     private void applyFoodCost(Player player) {
         FoodData foodData = player.getFoodData();
         applyCostValue(getFoodLevelConfig(), (float) foodData.getFoodLevel(), newVal -> foodData.setFoodLevel(newVal.intValue()));
         applyCostValue(getSaturationConfig(), foodData.getSaturationLevel(), newVal -> foodData.setSaturation(newVal));
     }
 
+    /**
+     * 通用数值扣减方法
+     * 支持百分比模式（以%结尾）和固定值模式
+     *
+     * @param config 配置字符串，如 "50%" 或 "4.0"
+     * @param currentValue 当前数值
+     * @param setter 数值设置回调
+     */
     private void applyCostValue(String config, float currentValue, java.util.function.Consumer<Float> setter) {
         if (config == null || config.isBlank()) {
             return;
@@ -272,11 +345,13 @@ public class MirrorItem extends Item {
         }
     }
 
+    /** 魔镜不可附魔 */
     @Override
     public boolean isEnchantable(ItemStack stack) {
         return false;
     }
 
+    /** 永久魔镜显示附魔光效 */
     @Override
     public boolean isFoil(ItemStack stack) {
         return tier == MirrorTier.PERMANENT;

src/main/java/com/le/teleportmirror/MirrorNetwork.java

@@ -15,8 +15,22 @@ import java.util.ArrayList;
 import java.util.List;
 import java.util.UUID;
 
+/**
+ * 魔镜的网络通信层
+ * <p>
+ * 负责定义和注册自定义网络负载（CustomPacketPayload），
+ * 处理客户端与服务端之间的魔镜相关通信：
+ * <ul>
+ *   <li>OpenPlayerSelectionPayload - 服务端→客户端，打开玩家选择界面</li>
+ *   <li>RequestTeleportPayload - 客户端→服务端，请求传送到目标玩家</li>
+ * </ul>
+ */
 public class MirrorNetwork {
 
+    /**
+     * 注册所有的网络负载处理器
+     * 在 RegisterPayloadHandlersEvent 事件中调用
+     */
     public static void registerPayloads(final RegisterPayloadHandlersEvent event) {
         final PayloadRegistrar registrar = event.registrar(TeleportMirrorMod.MODID).versioned("1.0.0");
 
@@ -33,15 +47,23 @@ public class MirrorNetwork {
         );
     }
 
+    /**
+     * 向指定客户端发送打开玩家选择界面的请求
+     *
+     * @param player 目标玩家
+     * @param tier 魔镜等级
+     */
     public static void sendOpenSelectionToClient(ServerPlayer player, MirrorTier tier) {
         List<String> names = new ArrayList<>();
         List<UUID> uuids = new ArrayList<>();
         boolean teamOnly = Config.TELEPORT_TEAM_ONLY.get();
 
         for (ServerPlayer onlinePlayer : player.server.getPlayerList().getPlayers()) {
+            // 排除使用者自身
             if (onlinePlayer.getUUID().equals(player.getUUID())) {
                 continue;
             }
+            // 如果开启了同队伍限制，仅保留同队伍玩家
             if (teamOnly) {
                 var playerTeam = player.getTeam();
                 var targetTeam = onlinePlayer.getTeam();
@@ -59,6 +81,10 @@ public class MirrorNetwork {
         PacketDistributor.sendToPlayer(player, new OpenPlayerSelectionPayload(names, uuids, tier.getName()));
     }
 
+    /**
+     * 处理服务端发来的打开选择界面负载
+     * 通过反射调用客户端专用类以避免在服务端加载客户端代码
+     */
     private static void handleOpenSelection(OpenPlayerSelectionPayload payload, IPayloadContext context) {
         context.enqueueWork(() -> {
             try {
@@ -71,6 +97,10 @@ public class MirrorNetwork {
         });
     }
 
+    /**
+     * 处理客户端发来的传送请求
+     * 验证玩家手中的魔镜类型和等级后执行传送
+     */
     private static void handleRequestTeleport(RequestTeleportPayload payload, IPayloadContext context) {
         context.enqueueWork(() -> {
             ServerPlayer sender = (ServerPlayer) context.player();
@@ -84,6 +114,7 @@ public class MirrorNetwork {
             ItemStack mainHand = sender.getMainHandItem();
             ItemStack offHand = sender.getOffhandItem();
 
+            // 检查主手和副手中是否有正确的传送魔镜
             ItemStack mirrorStack = null;
             if (mainHand.getItem() instanceof MirrorItem mirrorItem && mirrorItem.getMirrorType() == MirrorType.TELEPORT) {
                 mirrorStack = mainHand;
@@ -104,6 +135,9 @@ public class MirrorNetwork {
         });
     }
 
+    /**
+     * 打开玩家选择界面的网络负载（服务端 → 客户端）
+     */
     public record OpenPlayerSelectionPayload(List<String> playerNames, List<UUID> playerUuids,
             String tierName) implements CustomPacketPayload {
         public static final Type<OpenPlayerSelectionPayload> TYPE = new Type<>(
@@ -140,6 +174,9 @@ public class MirrorNetwork {
         }
     }
 
+    /**
+     * 请求传送到目标玩家的网络负载（客户端 → 服务端）
+     */
     public record RequestTeleportPayload(UUID targetUuid, String tierName) implements CustomPacketPayload {
         public static final Type<RequestTeleportPayload> TYPE = new Type<>(
                 ResourceLocation.fromNamespaceAndPath(TeleportMirrorMod.MODID, "request_teleport"));

src/main/java/com/le/teleportmirror/MirrorNetworkClient.java

@@ -5,9 +5,21 @@ import net.minecraft.client.Minecraft;
 import net.neoforged.api.distmarker.Dist;
 import net.neoforged.api.distmarker.OnlyIn;
 
+/**
+ * 客户端网络处理器
+ * <p>
+ * 仅编译到客户端（通过 @OnlyIn(Dist.CLIENT) 注解），
+ * 负责接收服务端发来的网络负载并打开对应的客户端界面。
+ * 在专用服务端环境中此类不会被加载。
+ */
 @OnlyIn(Dist.CLIENT)
 public class MirrorNetworkClient {
 
+    /**
+     * 接收服务端发送的玩家选择请求，在客户端打开玩家选择界面
+     *
+     * @param payload 包含可选玩家列表、UUID 和魔镜等级的网络负载
+     */
     public static void openPlayerSelection(MirrorNetwork.OpenPlayerSelectionPayload payload) {
         Minecraft client = Minecraft.getInstance();
         MirrorTier tier = MirrorTier.valueOf(payload.tierName().toUpperCase());

src/main/java/com/le/teleportmirror/MirrorTier.java

@@ -1,12 +1,25 @@
 package com.le.teleportmirror;
 
+/**
+ * 魔镜的等级
+ * <p>
+ * 不同等级影响耐久度、冷却时间、副作用强度等属性
+ * <ul>
+ *   <li>BASIC (初级) - 默认耐久10</li>
+ *   <li>INTERMEDIATE (中级) - 默认耐久50</li>
+ *   <li>ADVANCED (高级) - 默认耐久100</li>
+ *   <li>PERMANENT (永久) - 无限耐久，无副作用</li>
+ * </ul>
+ */
 public enum MirrorTier {
     BASIC(10, "basic"),
     INTERMEDIATE(50, "intermediate"),
     ADVANCED(100, "advanced"),
     PERMANENT(-1, "permanent");
 
+    /** 默认耐久度 */
     private final int defaultDurability;
+    /** 等级名称，用于注册和序列化 */
     private final String name;
 
     MirrorTier(int defaultDurability, String name) {
@@ -14,14 +27,17 @@ public enum MirrorTier {
         this.name = name;
     }
 
+    /** 获取该等级的默认耐久度 */
     public int getDefaultDurability() {
         return defaultDurability;
     }
 
+    /** 获取等级名称 */
     public String getName() {
         return name;
     }
 
+    /** 是否为永久等级（无限耐久） */
     public boolean isPermanent() {
         return this == PERMANENT;
     }

src/main/java/com/le/teleportmirror/MirrorType.java

@@ -1,15 +1,23 @@
 package com.le.teleportmirror;
 
+/**
+ * 魔镜的功能类型
+ * <p>
+ * RETURN - 回城魔镜：将使用者传送回出生点
+ * TELEPORT - 传送魔镜：将使用者传送到另一个玩家身边
+ */
 public enum MirrorType {
     RETURN("return"),
     TELEPORT("teleport");
 
+    /** 类型名称，用于注册和序列化 */
     private final String name;
 
     MirrorType(String name) {
         this.name = name;
     }
 
+    /** 获取类型名称 */
     public String getName() {
         return name;
     }

src/main/java/com/le/teleportmirror/TeleportMirrorMod.java

@@ -30,46 +30,74 @@ import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 
+/**
+ * Teleport Mirror Mod 主类
+ * <p>
+ * NeoForge Mod 的入口点（通过 {@link Mod} 注解）。
+ * 负责：
+ * <ul>
+ *   <li>注册所有魔镜物品（8种：回城/传送 × 4个等级）</li>
+ *   <li>创建创造模式标签页</li>
+ *   <li>注册配置文件</li>
+ *   <li>注册网络负载处理器</li>
+ *   <li>在服务端启动时注入配置覆盖的配方</li>
+ * </ul>
+ */
 @Mod(TeleportMirrorMod.MODID)
 public class TeleportMirrorMod {
     public static final String MODID = "teleportmirror";
 
+    /** 物品注册器 */
     public static final DeferredRegister.Items ITEMS = DeferredRegister.createItems(MODID);
+    /** 创造模式标签页注册器 */
     public static final DeferredRegister<CreativeModeTab> CREATIVE_MODE_TABS =
             DeferredRegister.create(Registries.CREATIVE_MODE_TAB, MODID);
 
+    // ==================== 回城魔镜 ====================
+
+    /** 初级回城魔镜 */
     public static final DeferredItem<MirrorItem> BASIC_RETURN_MIRROR = ITEMS.register("basic_return_mirror",
             () -> new MirrorItem(MirrorTier.BASIC, MirrorType.RETURN,
                     new Item.Properties().stacksTo(1).durability(MirrorTier.BASIC.getDefaultDurability())));
 
+    /** 中级回城魔镜 */
     public static final DeferredItem<MirrorItem> INTERMEDIATE_RETURN_MIRROR = ITEMS.register("intermediate_return_mirror",
             () -> new MirrorItem(MirrorTier.INTERMEDIATE, MirrorType.RETURN,
                     new Item.Properties().stacksTo(1).durability(MirrorTier.INTERMEDIATE.getDefaultDurability())));
 
+    /** 高级回城魔镜 */
     public static final DeferredItem<MirrorItem> ADVANCED_RETURN_MIRROR = ITEMS.register("advanced_return_mirror",
             () -> new MirrorItem(MirrorTier.ADVANCED, MirrorType.RETURN,
                     new Item.Properties().stacksTo(1).durability(MirrorTier.ADVANCED.getDefaultDurability())));
 
+    /** 永久回城魔镜 */
     public static final DeferredItem<MirrorItem> PERMANENT_RETURN_MIRROR = ITEMS.register("permanent_return_mirror",
             () -> new MirrorItem(MirrorTier.PERMANENT, MirrorType.RETURN,
                     new Item.Properties().stacksTo(1)));
 
+    // ==================== 传送魔镜 ====================
+
+    /** 初级传送魔镜 */
     public static final DeferredItem<MirrorItem> BASIC_TELEPORT_MIRROR = ITEMS.register("basic_teleport_mirror",
             () -> new MirrorItem(MirrorTier.BASIC, MirrorType.TELEPORT,
                     new Item.Properties().stacksTo(1).durability(MirrorTier.BASIC.getDefaultDurability())));
 
+    /** 中级传送魔镜 */
     public static final DeferredItem<MirrorItem> INTERMEDIATE_TELEPORT_MIRROR = ITEMS.register("intermediate_teleport_mirror",
             () -> new MirrorItem(MirrorTier.INTERMEDIATE, MirrorType.TELEPORT,
                     new Item.Properties().stacksTo(1).durability(MirrorTier.INTERMEDIATE.getDefaultDurability())));
 
+    /** 高级传送魔镜 */
     public static final DeferredItem<MirrorItem> ADVANCED_TELEPORT_MIRROR = ITEMS.register("advanced_teleport_mirror",
             () -> new MirrorItem(MirrorTier.ADVANCED, MirrorType.TELEPORT,
                     new Item.Properties().stacksTo(1).durability(MirrorTier.ADVANCED.getDefaultDurability())));
 
+    /** 永久传送魔镜 */
     public static final DeferredItem<MirrorItem> PERMANENT_TELEPORT_MIRROR = ITEMS.register("permanent_teleport_mirror",
             () -> new MirrorItem(MirrorTier.PERMANENT, MirrorType.TELEPORT,
                     new Item.Properties().stacksTo(1)));
 
+    /** 创造模式 "魔镜" 标签页，包含所有8种魔镜 */
     public static final DeferredHolder<CreativeModeTab, CreativeModeTab> MIRROR_TAB =
             CREATIVE_MODE_TABS.register("mirror_tab", () -> CreativeModeTab.builder()
                     .title(Component.translatable("itemGroup.teleportmirror"))
@@ -86,6 +114,11 @@ public class TeleportMirrorMod {
                         output.accept(PERMANENT_TELEPORT_MIRROR.get());
                     }).build());
 
+    /**
+     * Mod 构造器
+     * 注册物品、创造标签页、配置文件、网络负载处理器，
+     * 并在服务端启动时注入配置覆盖的配方
+     */
     public TeleportMirrorMod(IEventBus modEventBus, ModContainer modContainer) {
         ITEMS.register(modEventBus);
         CREATIVE_MODE_TABS.register(modEventBus);
@@ -96,14 +129,19 @@ public class TeleportMirrorMod {
         NeoForge.EVENT_BUS.addListener(this::onServerStarted);
     }
 
+    /** 注册网络负载处理器 */
     private void onRegisterPayloads(final RegisterPayloadHandlersEvent event) {
         MirrorNetwork.registerPayloads(event);
     }
 
+    /** 服务端启动后，注入配置覆盖的配方 */
     private void onServerStarted(final ServerStartedEvent event) {
         registerConfigRecipes(event.getServer().getRecipeManager());
     }
 
+    /**
+     * 检查所有8种魔镜的配方配置，将配置覆盖的配方注入到配方管理器
+     */
     private void registerConfigRecipes(net.minecraft.world.item.crafting.RecipeManager manager) {
         tryRegisterRecipe(manager, Config.ENABLE_BASIC_RECIPE.get(),
                 Config.RECIPE_OVERRIDE_RETURN_BASIC.get(), BASIC_RETURN_MIRROR.get(), "basic_return_mirror");
@@ -123,6 +161,19 @@ public class TeleportMirrorMod {
                 Config.RECIPE_OVERRIDE_TELEPORT_PERMANENT.get(), PERMANENT_TELEPORT_MIRROR.get(), "permanent_teleport_mirror");
     }
 
+    /**
+     * 尝试将配置覆盖的配方注入到配方管理器
+     * <p>
+     * 如果 override 为空则跳过（使用默认 JSON 配方）。
+     * 如果 enabled 为 false 也跳过（配方被禁用）。
+     * 通过反射访问配方管理器的内部 Map 来注入动态配方。
+     *
+     * @param manager 配方管理器
+     * @param enabled 配方是否启用
+     * @param override 配方覆盖字符串
+     * @param result 配方输出物品
+     * @param name 配方名称
+     */
     @SuppressWarnings("unchecked")
     private void tryRegisterRecipe(net.minecraft.world.item.crafting.RecipeManager manager,
             boolean enabled, String override, Item result, String name) {
@@ -150,6 +201,17 @@ public class TeleportMirrorMod {
         }
     }
 
+    /**
+     * 将配方覆盖字符串解析为 RecipeHolder
+     * <p>
+     * 格式："row1;row2;row3|key=item_id;..."
+     * 示例：" C ;CGC; C |C=minecraft:copper_ingot;G=minecraft:glass_pane"
+     *
+     * @param override 配方覆盖字符串
+     * @param result 配方输出物品
+     * @param name 配方名称
+     * @return 解析后的 RecipeHolder，解析失败返回 null
+     */
     private RecipeHolder<?> parseRecipeOverride(String override, Item result, String name) {
         String[] parts = override.split("\\|");
         if (parts.length < 2) return null;

src/main/java/com/le/teleportmirror/screen/PlayerSelectionScreen.java

@@ -11,13 +11,35 @@ import net.neoforged.neoforge.network.PacketDistributor;
 import java.util.List;
 import java.util.UUID;
 
+/**
+ * 玩家选择界面
+ * <p>
+ * 当玩家使用传送魔镜长按右键蓄力完成后，客户端会打开此界面。
+ * 界面列出当前在线的可选玩家，玩家点击按钮选择目标后，
+ * 通过网络包向服务端发送传送请求，服务端执行实际传送逻辑。
+ * <p>
+ * 支持分页：每页最多显示 {@value #BUTTONS_PER_PAGE} 名玩家，
+ * 通过滚动按钮切换页码。
+ * <p>
+ * 该界面不暂停游戏（isPauseScreen 返回 false）。
+ */
 public class PlayerSelectionScreen extends Screen {
+    /** 可选玩家名称列表 */
     private final List<String> playerNames;
+    /** 可选玩家 UUID 列表（与 playerNames 一一对应） */
     private final List<UUID> playerUuids;
+    /** 当前使用的魔镜等级 */
     private final MirrorTier tier;
+    /** 当前滚动偏移量 */
     private int scrollOffset = 0;
+    /** 每页最多显示的玩家按钮数量 */
     private static final int BUTTONS_PER_PAGE = 8;
 
+    /**
+     * @param playerNames 可选玩家的显示名称
+     * @param playerUuids 可选玩家的 UUID
+     * @param tier 魔镜等级
+     */
     public PlayerSelectionScreen(List<String> playerNames, List<UUID> playerUuids, MirrorTier tier) {
         super(Component.translatable("screen.teleportmirror.select_player"));
         this.playerNames = playerNames;
@@ -31,6 +53,10 @@ public class PlayerSelectionScreen extends Screen {
         rebuildButtons();
     }
 
+    /**
+     * 重建按钮布局
+     * 根据 scrollOffset 显示当前页的玩家按钮，以及滚动按钮和取消按钮
+     */
     private void rebuildButtons() {
         this.clearWidgets();
 
@@ -55,15 +81,16 @@ public class PlayerSelectionScreen extends Screen {
                     .build());
         }
 
+        // 如果玩家数量超过单页容量，显示滚动按钮
         if (playerNames.size() > BUTTONS_PER_PAGE) {
             this.addRenderableWidget(Button.builder(
-                    Component.literal("\u25B2"),
+                    Component.literal("\u25B2"), // 上箭头 ▲
                     btn -> { scrollOffset = Math.max(0, scrollOffset - 1); rebuildButtons(); })
                     .pos(centerX + buttonWidth / 2 + 5, startY)
                     .size(20, 20)
                     .build());
             this.addRenderableWidget(Button.builder(
-                    Component.literal("\u25BC"),
+                    Component.literal("\u25BC"), // 下箭头 ▼
                     btn -> { scrollOffset = Math.min(maxOffset, scrollOffset + 1); rebuildButtons(); })
                     .pos(centerX + buttonWidth / 2 + 5, startY + BUTTONS_PER_PAGE * (buttonHeight + spacing) - spacing)
                     .size(20, 20)
@@ -78,6 +105,11 @@ public class PlayerSelectionScreen extends Screen {
                 .build());
     }
 
+    /**
+     * 玩家点击某个目标后，向服务端发送传送请求并关闭界面
+     *
+     * @param index 所选玩家在列表中的索引
+     */
     private void selectPlayer(int index) {
         if (index >= 0 && index < playerUuids.size()) {
             UUID targetUuid = playerUuids.get(index);