├── .gitignore ├── LICENSE ├── README.md ├── README_zh.md ├── img.png ├── lang ├── en_us.yml └── zh_cn.yml ├── mcdreforged.plugin.json ├── requirements.txt └── where_is ├── __init__.py ├── config.py ├── constants.py ├── dimensions.py ├── entry.py ├── node.py ├── online_players.py ├── position.py └── utils.py /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | pip-wheel-metadata/ 24 | share/python-wheels/ 25 | *.egg-info/ 26 | .installed.cfg 27 | *.egg 28 | MANIFEST 29 | 30 | # PyInstaller 31 | # Usually these files are written by a python script from a template 32 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 33 | *.manifest 34 | *.spec 35 | 36 | # Installer logs 37 | pip-log.txt 38 | pip-delete-this-directory.txt 39 | 40 | # Unit test / coverage reports 41 | htmlcov/ 42 | .tox/ 43 | .nox/ 44 | .coverage 45 | .coverage.* 46 | .cache 47 | nosetests.xml 48 | coverage.xml 49 | *.cover 50 | *.py,cover 51 | .hypothesis/ 52 | .pytest_cache/ 53 | 54 | # Translations 55 | *.mo 56 | *.pot 57 | 58 | # Django stuff: 59 | *.log 60 | local_settings.py 61 | db.sqlite3 62 | db.sqlite3-journal 63 | 64 | # Flask stuff: 65 | instance/ 66 | .webassets-cache 67 | 68 | # Scrapy stuff: 69 | .scrapy 70 | 71 | # Sphinx documentation 72 | docs/_build/ 73 | 74 | # PyBuilder 75 | target/ 76 | 77 | # Jupyter Notebook 78 | .ipynb_checkpoints 79 | 80 | # IPython 81 | profile_default/ 82 | ipython_config.py 83 | 84 | # pyenv 85 | .python-version 86 | 87 | # pipenv 88 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 89 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 90 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 91 | # install all needed dependencies. 92 | #Pipfile.lock 93 | 94 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow 95 | __pypackages__/ 96 | 97 | # Celery stuff 98 | celerybeat-schedule 99 | celerybeat.pid 100 | 101 | # SageMath parsed files 102 | *.sage.py 103 | 104 | # Environments 105 | .env 106 | .venv 107 | env/ 108 | venv/ 109 | ENV/ 110 | env.bak/ 111 | venv.bak/ 112 | 113 | # Spyder project settings 114 | .spyderproject 115 | .spyproject 116 | 117 | # Rope project settings 118 | .ropeproject 119 | 120 | # mkdocs documentation 121 | /site 122 | 123 | # mypy 124 | .mypy_cache/ 125 | .dmypy.json 126 | dmypy.json 127 | 128 | # Pyre type checker 129 | .pyre/ 130 | 131 | # IDE 132 | /.idea/ 133 | 134 | # MCDR 135 | *.mcdr 136 | 137 | # KDE Dolphin 138 | .directory 139 | 140 | # Dependency 141 | /minecraft_data_api 142 | 143 | # Old reference 144 | /whereis.py 145 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | **English** | [简体中文](README_zh.md) 2 | 3 | Where Is 4 | ------- 5 | 6 | A [MCDReforged](https://github.com/Fallen-Breath/MCDReforged) plugin, inspired by [Fallen_Breath's](https://github.com/Fallen-Breath) [Here](https://github.com/TISUnion/Here) and [Ivan-1F's](https://github.com/Ivan-1F) [Where](https://github.com/Ivan-1F/MCDReforged-Plugins/tree/master/where) 7 | 8 | ## Dependencies 9 | 10 | [MinecraftDataAPI](https://github.com/MCDReforged/MinecraftDataAPI/) 11 | 12 | [MCDReforged](https://github.com/Fallen-Breath/MCDReforged) >= 2.12.0 13 | 14 | > Changed in v2.2: 15 | > 16 | > No longer supports MCDR v2.11 or earlier 17 | 18 | ## Commands 19 | 20 | 1. `!!whereis` or `!!vris`（can be modified in config）：Show coordinate of other player 21 | 22 | Command format: `!!whereis [args(optional)]` (multiple players allowed) 23 | 24 | ​ Optional arguments could be following values (multiple arguments should be divided by space): 25 | 26 | ​ `-a`, `--all` means broadcasting coordinate to all the players and highlight target player 27 | 28 | ​ `-s`, `--sudo` allows querying coordinate of protected players 29 | 30 | Both 2 arguments requires `admin` permission level in the config file of this plugin 31 | 32 | > Changed in v2.2: 33 | > 34 | > No longer supports arguments like `-as` and `-sa`, multiple players allowed 35 | 36 | 2. `!!here` (can be modified in config）: Broadcast your current coordinate 37 | 38 | > New in v2.1: 39 | > 40 | > Inline `!!here` command divided by space can be responded if enabled 41 | 42 | Optional argument can be used with both commands: (unavailable for inline `!!here`) 43 | 44 | ​ `-h`, `--highlight` Set highlight target player time, overrides config settings 45 | 46 | > Players won't be highlighted if their location is only queried, not broadcast 47 | 48 | > New in v2.2: 49 | > 50 | > New optional argument `-h ` introduced 51 | 52 | 53 | ## Config File 54 | 55 | Several features can be modified with configuration file, which will be generated automatically in `config/where_is/config.json` 56 | 57 | Calling `!!MCDR plg reload where_is` to reload is required to make it loaded after modifying 58 | 59 | Here is the config items in the file 60 | 61 | > [!WARNING] 62 | > These 2 items which are marked with asterisk below should be configured manually before you update to 2.x or you'll lose all the configuration during loading the new version!!! You can ignore this message if you haven't install this plugin before 63 | 64 | | Keys | Value type | Default value | Introduction | 65 | |----------------------------------|---------------------------------|-------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 66 | | `enable_where_is` | `bool` | `true` | Set it to `true` to enable query other player location | 67 | | `enable_here` | `bool` | `true` | Set it to `true` to enable broadcast your location | 68 | | `enable_inline_here` | `bool` | `false` | Set it to `true` to make inline here enabled. | 69 | | *`command_prefix` | `dict`(which includes 2 items) | In the following sheets | Command prefix of this plugin | 70 | | `broadcast_to_console` | `bool` | `true` | `!!here` or `!!vris -a` will also send message to server console | 71 | | `permission_requirements` | `dict`(which includes 3 items) | In the following sheets | Minimum permission of commands | 72 | | *`hightlight_time` | ``dict`(which includes 2 items) | In the following sheets | Highlight player time when coordinates are broadcasted to all the ones. | 73 | | `display_waypoints` | `dict`(which includes 2 items) | In the following sheets | If the text would include waypoint text of minimap | 74 | | `query_timeout` | `int` | `3` | Timeout of Minecraft Data API (seconds) | 75 | | `click_to_teleport` | `bool` | `true` | Allow player click to fill the teleport command (still requires operator permission) | 76 | | `location_protection` | `dict`(which includes 5 items) | In the following sheets | Player coordinate protection configuration | 77 | | `dimension_translation_mode` | `Literal['mcdr', 'minecraft']` | `'mcdr'` | `mcdr`: MCDReforged translates dimension names; `minecraft`: Minecraft translates dimension names. In 1.19 and later versions, using `mcdr` will avoid translation failure due to these dimension key change. | 78 | | `custom_dimension_name` | `Dict[str, Dict[str, str]]` | Too long to show | A mapping of dimension name translation for `mcdr` translation mode. This fist layer keys are the languages. The second layer keys are the dimension IDs (Non-vanilla dimensions are allowed. vanilla dimensions are required to fill and should omit the namespace). | 79 | | `custom_vanilla_translation_key` | `Dict[str, str]` | Too long to show | A mapping of dimension translation keys for `minecraft` translation mode. (Non-vanilla dimensions are allowed. vanilla dimensions are required to fill and should omit the namespace). | 80 | 81 | > New in v2.1: 82 | > 83 | > New configuration items: `inline_here` and `custom_vanilla_translation_key` 84 | 85 | In the sheet above, the items which have stable items is showing below: 86 | 87 | **The asterisked items contents goes here:** 88 | 89 | | Keys of`command_prefix` | Value type | Default value | Introduction | 90 | |-------------------------|------------|-------------------------|---------------------------------------| 91 | | `where_is` | `str` | ['!!vris', '!!whereis'] | Command prefix to query locations | 92 | | `here` | `str` | ['!!here'] | Command prefix to broadcast locations | 93 | 94 | | Keys of`highlight_time` | Value type | Default value | Introduction | 95 | |-------------------------|------------|---------------|----------------------------------------------------------------------------| 96 | | `where_is` | `int` | `0` | Highlight player time when querying other player's location and broadcast | 97 | | `here` | `int` | `15` | Highlight player time when broadcasting your location | 98 | 99 | The rest are the regular items: 100 | 101 | | Keys of`permission_requirements` | Value type | Default value | Introduction | 102 | |----------------------------------|------------|---------------|--------------------------------------------------------------------------| 103 | | `where_is` | `int` | `1` | Permissions which allows query location without extra arguments | 104 | | `here` | `int` | `0` | Permissions which allows broadcast your location without extra arguments | 105 | | `admin` | `int` | `3` | Permissions which allows query location with extra arguments | 106 | 107 | | Keys of`display_waypoints` | Value type | Default value | Introduction | 108 | |----------------------------|------------|---------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| 109 | | `voxelmap` | `bool` | `true` | If it is `true` a text (`[+V]`) will be displayed, click to highlight the location, ctrl-click to add waypoint to [Voxelmap](https://www.curseforge.com/minecraft/mc-mods/voxelmap) | 110 | | `xaero_minimap` | `bool` | `true` | If it is `true` a text (`[+X]`) will be displayed, click to add waypoint to [Xaero's Minimap](https://chocolateminecraft.com/minimap2.php) | 111 | 112 | | Keys of`location_protection` | Value type | Default value | Introduction | 113 | |------------------------------|------------|-----------------------------------------------------------|---------------------------------------------------------------------------------------| 114 | | `enable_whitelist` | `bool` | `false` | Enable querying whitelist, which blocks the player **NOT** in this list being queried | 115 | | `enable_blacklist` | `bool` | `true` | Enable querying whitelist, which blocks the player in this list being queried | 116 | | `whitelist` | `list` | empty list | whitelist, which blocks the player **NOT** in this list being queried | 117 | | `blacklist` | `list` | empty list | Enable querying whitelist, which blocks the player in this list being queried | 118 | | `protected_text` | `dict` | `'en_us': 'He/She\'s in your heart!', 'zh_cn': 'Ta在你心里!'` | Text replied when querying blocked, supports language preference of MCDReforged | 119 | 120 | ## Example 121 | 122 | ![](img.png) 123 | -------------------------------------------------------------------------------- /README_zh.md: -------------------------------------------------------------------------------- 1 | **简体中文** | [English](README.md) 2 | 3 | Where Is 4 | ------- 5 | 6 | 一个 [MCDReforged](https://github.com/Fallen-Breath/MCDReforged) 的插件, 受到 [Fallen_Breath](https://github.com/Fallen-Breath) 的 [Here](https://github.com/TISUnion/Here) and [Ivan-1F](https://github.com/Ivan-1F) 的 [Where](https://github.com/Ivan-1F/MCDReforged-Plugins/tree/master/where) 启发 7 | 8 | ## 依赖 9 | 10 | [MinecraftDataAPI](https://github.com/MCDReforged/MinecraftDataAPI/) 11 | 12 | [MCDReforged](https://github.com/Fallen-Breath/MCDReforged) >= 2.12.0 13 | 14 | > 于 2.2 版本变更: 15 | > 16 | > 不再支持 MCDR 2.11 及更早版本 17 | 18 | ## 指令 19 | 20 | 1. `!!whereis` 或者 `!!vris`（可在配置文件中修改）：显示一个其他玩家的坐标。 21 | 22 | 指令格式: `!!whereis <玩家> [参数(可选)]` （可以写多个玩家） 23 | 24 | ​ 可选参数可以为以下值（多个参数使用空格隔开）： 25 | 26 | ​ `-a`, `--all` 意为向所有玩家发送坐标并高亮该玩家 27 | 28 | ​ `-s`, `--sudo` 意为提权，允许查看受保护的玩家的坐标 29 | 30 | ​ 两个参数均需要插件配置中设置的 `admin` 等级来执行 31 | 32 | > 于 2.2 版本变更: 33 | > 34 | > 不再支持 `-as` 或 `-sa` 形式的参数，允许添加多个玩家 35 | 36 | 2. `!!here` （可在配置文件中修改）: 广播自己当前的坐标 37 | 38 | > 2.1 新版功能: 39 | > 40 | > 在启用了配置项的情况下, 聊天行中空格隔开的 `!!here` 指令可以被响应 41 | 42 | 两条指令均可使用的可选参数: (对行中 `!!here` 无效) 43 | 44 | ​ `-h`, `--highlight` <时长> 设定目标玩家的高亮时长 45 | 46 | > 其位置仅被查询而非被广播的情况下，不能高亮玩家 47 | 48 | > 2.2 新版功能: 49 | > 50 | > 引入了新可选参数 `-h ` 51 | 52 | ## 配置文件 53 | 54 | 部分特性可由配置文件控制，默认自动生成于 `config/where_is/config.json`。 55 | 56 | 修改配置文件之后需要使用`!!MCDR plg reload where_is`重载方可生效。 57 | 58 | 以下为配置文件内容 59 | 60 | > [!WARNING] 61 | > 下方被星号标记的两项的值须在更新到2.x版本前手动配置，否则您将在加载新版本时丢失本插件的全部配置，若您此前从未安装过本插件可无视该条信息 62 | 63 | | 键 | 值的类型 | 默认值 | 说明 | 64 | |----------------------------------|--------------------------------|----------|------------------------------------------------------------------------------------------| 65 | | `enable_where_is` | `bool` | `true` | 设置为`true`以启用查询玩家坐标的功能 | 66 | | `enable_here` | `bool` | `true` | 设置为`true`以启用广播自己坐标的功能 | 67 | | `enable_here` | `bool` | `false` | 设置为 `true` 以允许聊天中任意 here 指令解析功能 | 68 | | *`command_prefix` | `dict`(含固定的2个项目) | 见下表 | 插件指令前缀 | 69 | | `broadcast_to_console` | `bool` | `true` | `!!here` 或 `!!vris -a` 会将坐标信息同时显示在服务端控制台 | 70 | | `permission_requirements` | `dict`(含固定的3个项目) | 见下表 | 指令要求的最小权限等级 | 71 | | *`hightlight_time` | `dict`(含固定的2个项目) | 见下表 | 当包含 `-a` 参数时高亮玩家的时间 | 72 | | `display_waypoints` | `dict`(含固定的2个项目) | 见下表 | 是否显示小地图坐标点 | 73 | | `query_timeout` | `int` | `3` | Minecraft Data API的超时时间 | 74 | | `click_to_teleport` | `bool` | `true` | 允许玩家点击补全传送指令 (仍需OP以执行) | 75 | | `location_protection` | `dict`(含固定的5个项目) | 见下表 | 玩家坐标保护相关设定 | 76 | | `dimension_translation_mode` | `Literal['mcdr', 'minecraft']` | `'mcdr'` | `mcdr`: 维度名称由MCDR翻译; `minecraft`: 维度名称由Minecraft翻译。在1.19及以上版本，用`mcdr`项可以避免因翻译键名改动造成的翻译失败 | 77 | | `custom_dimension_name` | `Dict[str, Dict[str, str]` | 内容过长不便展示 | 由 MCDR 翻译的维度名称的翻译键值映射。首层键名为语言，二级键名为维度ID（支持非原版维度，原版维度必须填写且应去掉命名空间） | 78 | | `custom_vanilla_translation_key` | `Dict[str, str]` | 内容过长不便展示 | 由 Minecraft 翻译的维度键名映射 （支持非原版维度，原版维度必须填写且应去掉命名空间）. | 79 | 80 | 81 | > 2.1 新版功能: 82 | > 83 | > 新的配置项目: `inline_here` 和 `custom_vanilla_translation_key` 84 | 85 | 86 | 上述提到的含固定键值对的的配置项如下: 87 | 88 | **上述星标项的配置内容：** 89 | 90 | | `command_prefix` 的键 | 值类型 | 默认值 | 说明 | 91 | |---------------------|-------------|---------------------------|-------------| 92 | | `where_is` | `List[str]` | `['!!vris', '!!whereis']` | 查询玩家坐标的指令前缀 | 93 | | `here` | `List[str]` | `['!!here']` | 广播自己坐标的指令前缀 | 94 | 95 | | `highlight_time` 的键 | 值类型 | 默认值 | 说明 | 96 | |---------------------|-------|------|------------------------| 97 | | `where_is` | `int` | `0` | 当查询其他玩家并广播其坐标时玩家被高亮的时长 | 98 | | `here` | `int` | `15` | 当广播自己坐标时自己被高亮的时长 | 99 | 100 | 其余为常规项： 101 | 102 | | `permission_requirements` 的键 | 值类型 | 默认值 | 说明 | 103 | |------------------------------|-------|-----|-------------------------| 104 | | `where_is` | `int` | `1` | 允许查询其他玩家坐标的最小权限要求 | 105 | | `here` | `int` | `0` | 允许广播自己的坐标的最小权限要求 | 106 | | `admin` | `int` | `3` | 允许附带额外参数查询其他玩家坐标的最小权限要求 | 107 | 108 | | `display_waypoints`的键 | 值类型 | 默认值 | 说明 | 109 | |-----------------------|--------|--------|------------------------------------------------------------------------------------------------------------------------| 110 | | `voxelmap` | `bool` | `true` | 为 `true` 时显示一个附带点击事件的文本 (`[+V]`) 点击高亮坐标，Ctrl点击添加坐标点到 [Voxelmap](https://www.curseforge.com/minecraft/mc-mods/voxelmap) | 111 | | `xaero_minimap` | `bool` | `true` | 为 `true` 时显示一个附带点击事件的文本 (`[+x]`) , 点击添加路径点到 [Xaero's Minimap](https://chocolateminecraft.com/minimap2.php) | 112 | 113 | | `location_protection` 的键 | 值类型 | 默认值 | 说明 | 114 | |--------------------------|--------|----------------------------------------------------------|---------------------------------| 115 | | `enable_whitelist` | `bool` | `false` | 启用查询白名单，启用时限制白名单外的玩家被查询 | 116 | | `enable_blacklist` | `bool` | `true` | 启用查询黑名单，启用时限制黑名单内的玩家被查询 | 117 | | `whitelist` | `list` | 空列表 | 白名单，限制除此之外的玩家被查询 | 118 | | `blacklist` | `list` | 空列表 | 黑名单，限制该列表内的玩家被查询 | 119 | | `protected_text` | `dict` | `'en_us': 'He/She\'s in your heart!' 'zh_cn': 'Ta在你心里!'` | 当玩家被阻止查询时显示的信息，提供了MCDR语言偏好设置的支持 | 120 | 121 | ## 示例 122 | 123 | ![](img.png) 124 | -------------------------------------------------------------------------------- /img.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Lazy-Bing-Server/WhereIs-MCDR/c3ca30a0fc7c1d517d9f96f849be052016d9b714/img.png -------------------------------------------------------------------------------- /lang/en_us.yml: -------------------------------------------------------------------------------- 1 | where_is: 2 | help: 3 | detailed: | 4 | §7--------§9 {name} §rv{ver} §7--------§r 5 | Query other player's location 6 | §d[Basic usage]§r 7 | §7{vris} §5§3 [optional]§r Query player's location 8 | §7{here} §3[optional]§r §rBroadcast your own location 9 | §d[Advanced usage]§r 10 | Argument §5§r allows multiple players 11 | Argument §3[optional]§r for command §7{vris}§r: 12 | §8> §b-a§7, §b--all§r Broadcast player's location 13 | §8> §b-s§7, §b--sudo§r Allow to query protected player 14 | Argument §3[optional]§r for both commands: 15 | §8> §b-h§7, §b--highlight§6 §r Set highlight time 16 | vris: Query location of other player 17 | here: Broadcast your own location 18 | suggest: Click to fill command §7{} 19 | err: 20 | generic: "Error occurred: {}" 21 | not_online: "Required player {} is not online" 22 | perm_denied: "Permission denied" 23 | invalid_args: "Invalid argument" 24 | not_player: This operation can only be performed by player 25 | warn: 26 | duplicated_here: "Duplicated function between this plugin and Here, this function will not be triggered while Here exists" 27 | hover: 28 | tp: ": Click to teleport to" 29 | voxel: "§bVoxelmap§r: Click to highlight the location, or Ctrl-Click to add waypoint" 30 | xaero: '§6Xaeros Minimap§r: Click to add waypoint' 31 | default_dim: 32 | overworld: 'Overworld' 33 | the_nether: 'Nether' 34 | the_end: 'The End' 35 | cfg: 36 | vanilla_dim_missed: 'Vanilla dimension translations for language "{0}" not found: {1}' 37 | dim_key_missed: 'Vanilla dimension translation key not found: {0}' -------------------------------------------------------------------------------- /lang/zh_cn.yml: -------------------------------------------------------------------------------- 1 | where_is: 2 | help: 3 | detailed: | 4 | §7--------§9 {name} §rv{ver} §7--------§r 5 | 查询其他玩家的位置 6 | §d【基础用法】§r 7 | §7{vris} §5<玩家>§3 [可选参数]§r 查询玩家的位置 8 | §7{here} §r广播你自己的位置 9 | §d【进阶用法】§r 10 | 参数 §5<玩家>§r 允许添加多个玩家 11 | 指令 §7{vris}§r 的 §3[可选参数]§r 可为: 12 | §8> §b-a§7, §b--all§r 广播查询到的玩家位置 13 | §8> §b-s§7, §b--sudo§r 允许查询受保护的玩家 14 | 适用于所有指令的参数 §3[可选参数]§r: 15 | §8> §b-h§7, §b--highlight§6 <时长>§r 设置高亮时长 16 | vris: 查询其他玩家的位置 17 | here: 广播你自己的位置 18 | suggest: 点击填入指令 §7{} 19 | err: 20 | generic: "出现错误: §4{}" 21 | not_online: "玩家 §4{}§c 不在线" 22 | perm_denied: "权限不足" 23 | invalid_args: "无效的参数" 24 | not_player: 该操作仅可由玩家执行 25 | warn: 26 | duplicated_here: "本插件与Here存在功能重复，本插件的Here功能暂停工作" 27 | hover: 28 | tp: ': 点击以传送到' 29 | voxel: "§bVoxelmap§r: 点此以高亮坐标点, 或者Ctrl点击添加路径点" 30 | xaero: '§6Xaeros Minimap§r: 点击添加路径点' 31 | default_dim: 32 | overworld: '主世界' 33 | the_nether: '下界' 34 | the_end: '末地' 35 | cfg: 36 | vanilla_dim_missed: '适用于语言 "{0}" 的原版维度名称未找到: {1}' 37 | dim_key_missed: '原版维度翻译键未找到: {0}' -------------------------------------------------------------------------------- /mcdreforged.plugin.json: -------------------------------------------------------------------------------- 1 | { 2 | "id": "where_is", 3 | "version": "2.2.1", 4 | "name": "Where Is", 5 | "description": { 6 | "en_us": "Query players' coordinates", 7 | "zh_cn": "查询玩家的坐标" 8 | }, 9 | "author": [ 10 | "Ra1ny_Yuki" 11 | ], 12 | "link": "https://github.com/Lazy-Bing-Server/WhereIs-MCDR", 13 | "dependencies": { 14 | "minecraft_data_api": "*", 15 | "mcdreforged": ">=2.12.0" 16 | }, 17 | "entrypoint": "where_is.entry", 18 | "resources": [ 19 | "lang", "LICENSE" 20 | ] 21 | } -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | # Add your python package requirements here, just like regular requirements.txt 2 | 3 | mcdreforged>=2.1.3 -------------------------------------------------------------------------------- /where_is/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Lazy-Bing-Server/WhereIs-MCDR/c3ca30a0fc7c1d517d9f96f849be052016d9b714/where_is/__init__.py -------------------------------------------------------------------------------- /where_is/config.py: -------------------------------------------------------------------------------- 1 | from mcdreforged.api.utils import Serializable 2 | from mcdreforged.api.types import CommandSource, PlayerCommandSource, PluginServerInterface 3 | from enum import Enum 4 | from typing import List, Union, Dict 5 | 6 | from where_is.utils import ntr 7 | from where_is.constants import psi, OVERWORLD_SHORT, NETHER_SHORT, END_SHORT, REG_TO_ID 8 | 9 | 10 | class PermissionReq(Serializable): 11 | where_is: int = 1 12 | here: int = 0 13 | admin: int = 3 14 | 15 | def query_is_allowed(self, source: CommandSource): 16 | return source.has_permission(self.where_is) 17 | 18 | def broadcast_is_allowed(self, source: CommandSource): 19 | return source.has_permission(self.here) 20 | 21 | def is_admin(self, source: CommandSource): 22 | return source.has_permission(self.admin) 23 | 24 | 25 | class DisplayWaypoints(Serializable): 26 | voxelmap: bool = True 27 | xaeros_minimap: bool = True 28 | 29 | 30 | class LocationProtection(Serializable): 31 | enable_whitelist: bool = False 32 | enable_blacklist: bool = True 33 | whitelist: List[str] = [] 34 | blacklist: List[str] = [] 35 | protected_text: Dict[str, str] = { 36 | 'en_us': 'He/She\'s in your heart!', 37 | 'zh_cn': 'Ta在你心里!' 38 | } 39 | 40 | def is_allowed(self, source: CommandSource, target: str): 41 | if source.is_console: 42 | return True 43 | elif isinstance(source, PlayerCommandSource): 44 | if self.enable_whitelist and target not in self.whitelist: 45 | return False 46 | if self.enable_blacklist and target in self.blacklist: 47 | return False 48 | return True 49 | else: 50 | return False 51 | 52 | def register_tr(self, server: PluginServerInterface): 53 | for lang, value in self.protected_text.items(): 54 | server.register_translation(lang, {'where_is.err.player_protected': value}) 55 | 56 | 57 | class TranslationMode(Enum): 58 | mcdr = True 59 | minecraft = False 60 | 61 | 62 | class CommandPrefix(Serializable): 63 | where_is: Union[List[str], str] = ['!!vris', '!!whereis'] 64 | here: Union[List[str], str] = ['!!here'] 65 | 66 | @property 67 | def where_is_prefixes(self) -> List[str]: 68 | if isinstance(self.where_is, str): 69 | return [self.where_is] 70 | return self.where_is 71 | 72 | @property 73 | def here_prefixes(self) -> List[str]: 74 | if isinstance(self.here, str): 75 | return [self.here] 76 | return self.here 77 | 78 | 79 | class HighlightTimePreference(Serializable): 80 | where_is: int = 0 81 | here: int = 15 82 | 83 | 84 | class Config(Serializable): 85 | enable_here: bool = True 86 | enable_where_is: bool = True 87 | enable_inline_here: bool = False 88 | command_prefix: CommandPrefix = CommandPrefix.get_default() 89 | broadcast_to_console: bool = True 90 | permission_requirements: PermissionReq = PermissionReq.get_default() 91 | highlight_time: HighlightTimePreference = HighlightTimePreference.get_default() 92 | display_waypoints: DisplayWaypoints = DisplayWaypoints.get_default() 93 | query_timeout: int = 3 94 | click_to_teleport: bool = True 95 | location_protection: LocationProtection = LocationProtection.get_default() 96 | dimension_translation_mode: TranslationMode = TranslationMode.mcdr 97 | custom_dimension_name: Dict[str, Dict[str, str]] = { 98 | "en_us": { 99 | OVERWORLD_SHORT: "Overworld", 100 | NETHER_SHORT: "Nether", 101 | END_SHORT: "The End" 102 | }, 103 | "zh_cn": { 104 | OVERWORLD_SHORT: "主世界", 105 | NETHER_SHORT: "下界", 106 | END_SHORT: "末地" 107 | } 108 | } 109 | custom_vanilla_translation_key: Dict[str, str] = { 110 | OVERWORLD_SHORT: 'createWorld.customize.preset.overworld', 111 | NETHER_SHORT: 'advancements.nether.root.title', 112 | END_SHORT: 'advancements.end.root.title' 113 | } 114 | # Enable this option will result in invalid MCDR language pref while calling "!!here" 115 | # But enable this may relieve the emotion of code OCD patients xD 116 | here_use_broadcast: bool 117 | 118 | @classmethod 119 | def load(cls) -> 'Config': 120 | cfg = psi.load_config_simple(target_class=cls) 121 | 122 | for lang, mappings in cfg.custom_dimension_name.copy().items(): 123 | for key, value in mappings.copy().items(): 124 | cfg.custom_dimension_name[lang][key] = value.strip() 125 | if cfg.custom_dimension_name[lang][key] == '': 126 | del cfg.custom_dimension_name[lang][key] 127 | 128 | requires_save = False 129 | for lang, mappings in cfg.custom_dimension_name.copy().items(): 130 | missing = [] 131 | for key, value in cls.get_default().custom_dimension_name[lang].items(): 132 | if key not in mappings.keys(): 133 | cfg.custom_dimension_name[lang][key] = value 134 | requires_save = True 135 | missing.append(key) 136 | if len(missing) > 0: 137 | psi.logger.info(ntr('cfg.vanilla_dim_missed', lang, ', '.join(missing))) 138 | 139 | missing = [] 140 | for key, value in cls.get_default().custom_vanilla_translation_key.items(): 141 | if key not in cfg.custom_vanilla_translation_key.keys(): 142 | cfg.custom_vanilla_translation_key[key] = value 143 | requires_save = True 144 | missing.append(key) 145 | if len(missing) > 0: 146 | psi.logger.info(ntr('cfg.dim_key_missed', ', '.join(missing))) 147 | 148 | if requires_save: 149 | psi.save_config_simple(cfg) 150 | return cfg 151 | 152 | @property 153 | def translate_dim_with_mcdr(self): 154 | return self.dimension_translation_mode.value 155 | 156 | def get_translation_key_mappings(self): 157 | ret = {} 158 | for key, value in self.custom_vanilla_translation_key.items(): 159 | id_ = REG_TO_ID.get(f"minecraft:{key}") 160 | if id_ is not None: 161 | ret[id_] = value 162 | else: 163 | ret[key] = value 164 | return ret 165 | 166 | @property 167 | def ocd(self): 168 | return self.serialize().get('here_use_broadcast', False) 169 | 170 | 171 | config = Config.load() 172 | -------------------------------------------------------------------------------- /where_is/constants.py: -------------------------------------------------------------------------------- 1 | from mcdreforged.api.types import ServerInterface 2 | 3 | OVERWORLD_SHORT = "overworld" 4 | OVERWORLD = f'minecraft:{OVERWORLD_SHORT}' 5 | NETHER_SHORT = "the_nether" 6 | NETHER = f'minecraft:{NETHER_SHORT}' 7 | END_SHORT = "the_end" 8 | END = f'minecraft:{END_SHORT}' 9 | REG_TO_ID = { 10 | OVERWORLD: 0, 11 | NETHER: -1, 12 | END: 1 13 | } 14 | ID_TO_REG = dict([(v, k) for k, v in REG_TO_ID.items()]) 15 | 16 | psi = ServerInterface.get_instance().as_plugin_server_interface() 17 | DEBUG = True 18 | -------------------------------------------------------------------------------- /where_is/dimensions.py: -------------------------------------------------------------------------------- 1 | from abc import ABC 2 | from typing import Tuple 3 | 4 | from mcdreforged.api.rtext import RColor, RTextBase, RTextTranslation 5 | from where_is.config import config 6 | from where_is.constants import OVERWORLD, NETHER, END, REG_TO_ID, ID_TO_REG, OVERWORLD_SHORT, NETHER_SHORT, END_SHORT 7 | from where_is.utils import rtr, dim_tr, debug 8 | from where_is.position import Position 9 | 10 | """ 11 | Copied from TISUnion/Here 12 | Original repository: https://github.com/TISUnion/Here 13 | 14 | Licensed under GNU General Public License v3.0 15 | """ 16 | 17 | 18 | class Dimension(ABC): 19 | def get_id(self) -> str: # 0 20 | raise NotImplementedError() 21 | 22 | def get_reg_key(self) -> str: # minecraft:overworld 23 | raise NotImplementedError() 24 | 25 | def get_color(self) -> RColor: 26 | return { 27 | OVERWORLD: RColor.dark_green, 28 | NETHER: RColor.dark_red, 29 | END: RColor.dark_purple 30 | }.get(self.get_reg_key(), RColor.gray) 31 | 32 | def get_coordinate_color(self) -> RColor: 33 | return { 34 | OVERWORLD: RColor.green, 35 | NETHER: RColor.red, 36 | END: RColor.light_purple 37 | }.get(self.get_reg_key(), RColor.white) 38 | 39 | def get_rtext(self) -> RTextBase: 40 | raise NotImplementedError() 41 | 42 | def has_opposite(self) -> bool: 43 | raise NotImplementedError() 44 | 45 | def get_opposite(self, pos: Position) -> Tuple['Dimension', Position]: 46 | raise NotImplementedError() 47 | 48 | 49 | class LegacyDimension(Dimension): 50 | def __init__(self, dim_id: int): 51 | assert isinstance(dim_id, int) and -1 <= dim_id <= 1 52 | self.dim_id = dim_id 53 | 54 | def get_id(self) -> int: 55 | return self.dim_id 56 | 57 | def get_reg_key(self) -> str: 58 | return ID_TO_REG[self.dim_id] 59 | 60 | def get_rtext(self) -> RTextBase: 61 | if config.translate_dim_with_mcdr: 62 | return rtr({ 63 | 0: f'dim.{OVERWORLD_SHORT}', 64 | -1: f'dim.{NETHER_SHORT}', 65 | 1: f'dim.{END_SHORT}' 66 | }[self.dim_id]).set_color(self.get_color()) 67 | return RTextTranslation(config.get_translation_key_mappings()[self.dim_id], color=self.get_color()) 68 | 69 | def has_opposite(self) -> bool: 70 | return self.dim_id in (0, -1) 71 | 72 | def get_opposite(self, pos: Position) -> Tuple['Dimension', Position]: 73 | # 0 -> -1 74 | # -1 -> 0 75 | if self.dim_id == 0: # overworld 76 | return LegacyDimension(-1), pos.to_nether() 77 | elif self.dim_id == -1: # nether 78 | return LegacyDimension(0), pos.to_overworld() 79 | raise RuntimeError('Legacy dimension -1 (the end) does not have opposite dimension') 80 | 81 | 82 | class CustomDimension(Dimension): 83 | def __init__(self, reg_key: str): 84 | self.reg_key = reg_key 85 | 86 | def get_id(self) -> str: 87 | raise RuntimeError('Custom dimension {} does not have integer id'.format(self.reg_key)) 88 | 89 | def get_reg_key(self) -> str: 90 | return self.reg_key 91 | 92 | def get_rtext(self) -> RTextBase: 93 | translation_key_mappings = config.get_translation_key_mappings() 94 | if config.translate_dim_with_mcdr or self.reg_key not in translation_key_mappings: 95 | return rtr(f"dim.{self.reg_key}").set_translator(dim_tr).set_color(self.get_color()) 96 | else: 97 | return RTextTranslation(config.get_translation_key_mappings()[self.reg_key], color=self.get_color()) 98 | 99 | def has_opposite(self) -> bool: 100 | return False 101 | 102 | def get_opposite(self, pos: Position) -> Tuple['Dimension', Position]: 103 | raise RuntimeError('Custom dimension {} does not have opposite dimension'.format(self.reg_key)) 104 | 105 | 106 | def get_dimension(text: str) -> Dimension: 107 | """ 108 | text can be: 109 | - int id: 0 110 | - str registry key: minecraft:overworld 111 | """ 112 | try: 113 | return LegacyDimension(int(text)) 114 | except: 115 | pass 116 | debug(text) 117 | if text in REG_TO_ID.keys(): 118 | return LegacyDimension(REG_TO_ID[text]) 119 | return CustomDimension(text) 120 | -------------------------------------------------------------------------------- /where_is/entry.py: -------------------------------------------------------------------------------- 1 | import re 2 | from typing import Optional, Union, List 3 | 4 | from mcdreforged.api.all import * 5 | from minecraft_data_api import get_player_info, get_player_dimension 6 | 7 | from where_is.config import config 8 | from where_is.constants import psi 9 | from where_is.dimensions import get_dimension, Dimension, LegacyDimension 10 | from where_is.position import Position 11 | from where_is.online_players import online_players 12 | from where_is.utils import rtr, debug, ntr, named_thread, MessageText 13 | from where_is.node import QuotableTextList 14 | 15 | 16 | PLAYER_LIST = 'player_list' 17 | SUDO_COUNT = 'sudo_count' 18 | ALL_COUNT = 'all_count' 19 | HIGHLIGHT_TIME = 'highlight_time' 20 | 21 | 22 | def htr( 23 | translation_key: str, 24 | *args, 25 | prefixes: Optional[List[str]] = None, 26 | suggest_prefix: Optional[str] = None, 27 | **kwargs, 28 | ) -> RTextMCDRTranslation: 29 | prefixes = prefixes or [""] 30 | 31 | def __get_regex_result(line: str): 32 | pattern = r"(?<=§7){}[\S ]*?(?=§)" 33 | for prefix in prefixes: 34 | result = re.search(pattern.format(prefix), line) 35 | if result is not None: 36 | return result 37 | return None 38 | 39 | def __htr(key: str, *inner_args, **inner_kwargs) -> MessageText: 40 | nonlocal suggest_prefix 41 | original = ntr(key, *inner_args, **inner_kwargs) 42 | processed: List[MessageText] = [] 43 | if not isinstance(original, str): 44 | return key 45 | for line in original.splitlines(): 46 | result = __get_regex_result(line) 47 | if result is not None: 48 | command = result.group().strip() + " " 49 | if suggest_prefix is not None: 50 | command = suggest_prefix.strip() + " " + command 51 | processed.append( 52 | RText(line) 53 | .c(RAction.suggest_command, command) 54 | .h(rtr("help.suggest", command)) 55 | ) 56 | 57 | debug(f'Rich help line: "{line}"') 58 | debug( 59 | "Suggest prefix: {}".format( 60 | f'"{suggest_prefix}"' 61 | if isinstance(suggest_prefix, str) 62 | else suggest_prefix 63 | ) 64 | ) 65 | debug(f'Suggest command: "{command}"') 66 | else: 67 | processed.append(line) 68 | return RTextBase.join("\n", processed) 69 | 70 | return rtr(translation_key, *args, **kwargs).set_translator(__htr) 71 | 72 | 73 | @named_thread 74 | def where_is(source: CommandSource, context: CommandContext): 75 | player_list = context.get(PLAYER_LIST, []) 76 | sudo = context.get(SUDO_COUNT, 0) > 0 77 | to_all = context.get(ALL_COUNT, 0) > 0 78 | highlight_time = context.get(HIGHLIGHT_TIME) 79 | if len(player_list) == 0: 80 | where_is_help(source, context) 81 | for player in player_list: 82 | _where_is(source, player, sudo=sudo, to_all=to_all, highlight_time=highlight_time) 83 | 84 | 85 | def where_is_help(source: CommandSource, context: CommandContext): 86 | current_prefix = context.command.split(' ')[0] 87 | meta = psi.get_self_metadata() 88 | version = meta.version 89 | version_str = ".".join([str(n) for n in version.component]) 90 | if version.pre is not None: 91 | version_str += "-" + str(version.pre) 92 | source.reply(htr( 93 | 'help.detailed', 94 | vris=current_prefix, 95 | here=config.command_prefix.here_prefixes[0], 96 | name=meta.name, 97 | ver=version_str, 98 | prefixes=[current_prefix, config.command_prefix.here_prefixes[0]] 99 | )) 100 | 101 | 102 | def _where_is( 103 | source: CommandSource, 104 | target_player: str, 105 | sudo: bool = False, 106 | to_all: bool = False, 107 | highlight_time: Optional[int] = None 108 | ): 109 | highlight_time = highlight_time or config.highlight_time.where_is 110 | debug("Highlight time: {} s".format(highlight_time)) 111 | if not sudo and not config.location_protection.is_allowed(source, target_player): 112 | source.reply(rtr('err.player_protected').set_color(RColor.red)) 113 | return 114 | if target_player not in online_players.get_player_list(): 115 | source.reply(rtr('err.not_online', target_player).set_color(RColor.red)) 116 | return 117 | try: 118 | coordinate = get_player_pos(target_player, timeout=config.query_timeout) 119 | dimension = get_dimension(get_player_dimension(target_player, timeout=config.query_timeout)) 120 | rtext = where_is_text(target_player, coordinate, dimension) 121 | except Exception as exc: 122 | source.reply(rtr("err.generic", str(exc)).set_color(RColor.red)) 123 | psi.logger.exception('Unexpected exception occurred while querying player location') 124 | return 125 | 126 | if to_all: 127 | say(rtext) 128 | if highlight_time > 0: 129 | psi.execute( 130 | f'effect give {target_player} minecraft:glowing {highlight_time} 0 true' 131 | ) 132 | else: 133 | source.reply(rtext) 134 | 135 | 136 | @named_thread 137 | def here(source: PlayerCommandSource, context: Optional[CommandContext] = None): 138 | highlight_time = config.highlight_time.here 139 | if context is not None: 140 | highlight_time = context.get(HIGHLIGHT_TIME, highlight_time) 141 | if psi.get_plugin_metadata('here') is not None: 142 | psi.logger.warning(ntr('warn.duplicated_here')) 143 | return 144 | try: 145 | coordinate = get_player_pos(source.player, timeout=config.query_timeout) 146 | dimension = get_dimension(get_player_dimension(source.player, timeout=config.query_timeout)) 147 | rtext = where_is_text(source.player, coordinate, dimension) 148 | except Exception as exc: 149 | source.reply(rtr("err.generic", str(exc)).set_color(RColor.red)) 150 | psi.logger.exception('Unexpected exception occurred while broadcasting player location') 151 | return 152 | 153 | say(rtext) 154 | if highlight_time > 0: 155 | psi.execute( 156 | f'effect give {source.player} minecraft:glowing {config.highlight_time.here} 0 true' 157 | ) 158 | 159 | 160 | def coordinate_text(x: float, y: float, z: float, dimension: Dimension): 161 | coord = RText('[{}, {}, {}]'.format(int(x), int(y), int(z)), dimension.get_coordinate_color()) 162 | if config.click_to_teleport: 163 | return ( 164 | coord.h(dimension.get_rtext() + rtr('hover.tp') + coord.copy()). 165 | c(RAction.suggest_command, '/execute in {} run tp {} {} {}'.format( 166 | dimension.get_reg_key(), int(x), int(y), int(z))) 167 | ) 168 | else: 169 | return coord.h(dimension.get_rtext()) 170 | 171 | 172 | def where_is_text(target_player: str, pos: Position, dim: Dimension) -> RTextBase: 173 | x, y, z = pos.x, pos.y, pos.z 174 | 175 | # basic text: someone @ dimension [x, y, z] 176 | texts = RTextList(RText(target_player, RColor.yellow), ' @ ', dim.get_rtext(), ' ', 177 | coordinate_text(x, y, z, dim)) 178 | 179 | if config.display_waypoints.voxelmap: 180 | texts.append(' ', RText('[+V]', RColor.aqua).h(rtr('hover.voxel')).c( 181 | RAction.run_command, '/newWaypoint x:{}, y:{}, z:{}, dim:{}'.format( 182 | int(x), int(y), int(z), dim.get_reg_key() 183 | ) 184 | )) 185 | 186 | # click event to add waypoint 187 | if config.display_waypoints.xaeros_minimap: 188 | command = "xaero_waypoint_add:{}'s Location:{}:{}:{}:{}:6:false:0".format( 189 | target_player, target_player[0], int(x), int(y), int(z)) 190 | if isinstance(dim, LegacyDimension): 191 | command += ':Internal_{}_waypoints'.format(dim.get_reg_key().replace('minecraft:', '').strip()) 192 | texts.append(' ', RText('[+X]', RColor.gold).h(rtr('hover.xaero')).c(RAction.run_command, command)) 193 | 194 | # coordinate conversion between overworld and nether 195 | if dim.has_opposite(): 196 | oppo_dim, oppo_pos = dim.get_opposite(pos) 197 | arrow = RText('->', RColor.gray) 198 | texts.append(RText.format( 199 | ' {} {}', 200 | arrow.copy().h(RText.format('{} {} {}', dim.get_rtext(), arrow, oppo_dim.get_rtext())), 201 | coordinate_text(oppo_pos.x, oppo_pos.y, oppo_pos.z, oppo_dim) 202 | )) 203 | 204 | return texts 205 | 206 | 207 | # Should be run in new thread 208 | def get_player_pos(player: str, *, timeout: Optional[float] = None) -> Position: 209 | pos = get_player_info(player, 'Pos', timeout=timeout) 210 | if pos is None: 211 | raise ValueError('Fail to query the coordinate of player {}'.format(player)) 212 | return Position(x=float(pos[0]), y=float(pos[1]), z=float(pos[2])) 213 | 214 | 215 | def say(text: Union[str, RTextBase]): 216 | if config.ocd: 217 | if config.broadcast_to_console: 218 | psi.broadcast(text) 219 | else: 220 | psi.say(text) 221 | else: 222 | if config.broadcast_to_console: 223 | for line in RTextBase.from_any(text).to_colored_text().splitlines(): 224 | psi.logger.info(line) 225 | # Tell each player separately to apply language preference 226 | player_list = online_players.get_player_list() 227 | if len(player_list) >= 1: 228 | for player in player_list: 229 | psi.tell(player, text) 230 | 231 | 232 | def on_user_info(server: PluginServerInterface, info: Info): 233 | if config.enable_here and config.enable_inline_here: 234 | source = info.get_command_source() 235 | if ( 236 | source.has_permission(config.permission_requirements.here) 237 | and isinstance(source, PlayerCommandSource) 238 | ): 239 | args = info.content.split(' ') 240 | for prefix in config.command_prefix.here_prefixes: 241 | if prefix in args: 242 | here(source) 243 | break 244 | 245 | 246 | def register_commands(server: PluginServerInterface): 247 | if config.enable_where_is: 248 | where_is_root = Literal(config.command_prefix.where_is_prefixes).requires( 249 | config.permission_requirements.query_is_allowed 250 | ).runs(where_is) 251 | where_is_root.then( 252 | QuotableTextList('player', PLAYER_LIST).suggests( 253 | lambda: online_players.get_player_list() 254 | ).redirects(where_is_root) 255 | ) 256 | where_is_root.then( 257 | CountingLiteral({"-s", "--sudo"}, SUDO_COUNT).requires( 258 | config.permission_requirements.is_admin 259 | ).redirects(where_is_root) 260 | ) 261 | where_is_root.then( 262 | CountingLiteral({"-a", "--all"}, ALL_COUNT).requires( 263 | config.permission_requirements.is_admin 264 | ).redirects(where_is_root) 265 | ) 266 | where_is_root.then( 267 | Literal({"-h", "--highlight"}).then( 268 | Integer(HIGHLIGHT_TIME).redirects(where_is_root) 269 | ) 270 | ) 271 | server.register_command(where_is_root) 272 | 273 | if config.enable_here and not config.enable_inline_here: 274 | here_root = Literal(config.command_prefix.here_prefixes).requires( 275 | config.permission_requirements.broadcast_is_allowed, 276 | lambda: rtr('err.perm_denied') 277 | ).requires( 278 | lambda src: src.is_player, 279 | lambda: rtr('err.not_player') 280 | ).runs(here) 281 | here_root.then( 282 | Literal('highlight').then( 283 | Integer(HIGHLIGHT_TIME).redirects(here_root) 284 | ) 285 | ) 286 | server.register_command(here_root) 287 | 288 | 289 | def register_help_messages(server: PluginServerInterface): 290 | if config.enable_where_is: 291 | for pre in config.command_prefix.where_is_prefixes: 292 | server.register_help_message( 293 | pre, rtr('help.vris'), permission=config.permission_requirements.where_is 294 | ) 295 | if config.enable_here: 296 | for pre in config.command_prefix.here_prefixes: 297 | server.register_help_message( 298 | pre, rtr('help.here'), permission=config.permission_requirements.here 299 | ) 300 | 301 | 302 | def register_customized_translations(server: PluginServerInterface): 303 | for lang, mappings in config.custom_dimension_name.items(): 304 | server.register_translation(lang, {'where_is': {'dim': config.custom_dimension_name[lang]}}) 305 | config.location_protection.register_tr(server) 306 | 307 | 308 | def on_load(server: PluginServerInterface, prev_modules): 309 | online_players.register_event_listeners() 310 | register_help_messages(server) 311 | register_customized_translations(server) 312 | register_commands(server) 313 | -------------------------------------------------------------------------------- /where_is/node.py: -------------------------------------------------------------------------------- 1 | from mcdreforged.api.all import QuotableText, CommandContext, ParseResult 2 | 3 | from typing import Iterable 4 | 5 | 6 | class QuotableTextList(QuotableText): 7 | def __init__(self, name: str or Iterable[str], list_key: str): 8 | super().__init__(name) 9 | self.__list_key = list_key 10 | 11 | def get_list_key(self): 12 | return self.__list_key 13 | 14 | def _on_visited(self, context: CommandContext, parse_result: "ParseResult"): 15 | context[self.__list_key] = context.get(self.__list_key, []) + [parse_result.value] 16 | -------------------------------------------------------------------------------- /where_is/online_players.py: -------------------------------------------------------------------------------- 1 | from mcdreforged.api.all import MCDRPluginEvents 2 | 3 | from threading import RLock 4 | 5 | from typing import List 6 | 7 | from where_is.utils import named_thread, psi, debug 8 | from where_is.config import config 9 | 10 | 11 | class OnlinePlayers: 12 | def __init__(self): 13 | self.__lock = RLock() 14 | self.__players: List[str] = [] 15 | self.__limit = 0 16 | self.__enabled = False 17 | 18 | def get_player_list(self, refresh: bool = False): 19 | with self.__lock: 20 | if refresh: 21 | self.__refresh_online_players() 22 | return self.__players.copy() 23 | 24 | def get_player_limit(self, refresh: bool = False): 25 | with self.__lock: 26 | if refresh: 27 | self.__refresh_online_players() 28 | return self.__limit 29 | 30 | @named_thread 31 | def __add_player(self, player: str): 32 | with self.__lock: 33 | if self.__enabled and player not in self.__players: 34 | self.__players.append(player) 35 | 36 | @named_thread 37 | def __remove_player(self, player: str): 38 | with self.__lock: 39 | if self.__enabled and player in self.__players: 40 | self.__players.remove(player) 41 | 42 | @named_thread 43 | def __refresh_online_players(self): 44 | with self.__lock: 45 | if not psi.is_server_startup(): 46 | return 47 | api = psi.get_plugin_instance("minecraft_data_api") 48 | player_tuple = api.get_server_player_list( 49 | timeout=config.query_timeout 50 | ) 51 | if player_tuple is not None: 52 | count, self.__limit, self.__players = player_tuple 53 | debug( 54 | "Player list refreshed: " 55 | + ", ".join(self.__players) 56 | + f" (max {self.__limit})" 57 | ) 58 | if count != len(self.__players): 59 | psi.logger.warning( 60 | "Incorrect player count found while refreshing player list" 61 | ) 62 | 63 | @named_thread 64 | def __enable_player_join(self): 65 | with self.__lock: 66 | self.__enabled = True 67 | debug("Player list counting enabled") 68 | 69 | @named_thread 70 | def __clear_online_players(self): 71 | with self.__lock: 72 | self.__limit, self.__players = None, [] 73 | debug("Cleared online player cache") 74 | 75 | def register_event_listeners(self): 76 | psi.register_event_listener( 77 | MCDRPluginEvents.PLUGIN_LOADED, 78 | lambda *args, **kwargs: self.__refresh_online_players(), 79 | ) 80 | psi.register_event_listener( 81 | MCDRPluginEvents.SERVER_START, 82 | lambda *args, **kwargs: self.__enable_player_join(), 83 | ) 84 | psi.register_event_listener( 85 | MCDRPluginEvents.PLAYER_JOINED, 86 | lambda _, player, __: self.__add_player(player), 87 | ) 88 | psi.register_event_listener( 89 | MCDRPluginEvents.PLAYER_LEFT, lambda _, player: self.__remove_player(player) 90 | ) 91 | psi.register_event_listener( 92 | MCDRPluginEvents.SERVER_STOP, 93 | lambda *args, **kwargs: self.__clear_online_players(), 94 | ) 95 | 96 | 97 | online_players = OnlinePlayers() 98 | -------------------------------------------------------------------------------- /where_is/position.py: -------------------------------------------------------------------------------- 1 | import copy 2 | 3 | 4 | class Position: 5 | def __init__(self, x: float, y: float, z: float): 6 | self.x = x 7 | self.y = y 8 | self.z = z 9 | 10 | def to_nether(self): 11 | ret = self.copy() 12 | ret.x = ret.x / 8 13 | ret.z = ret.z / 8 14 | return ret 15 | 16 | def to_overworld(self): 17 | ret = self.copy() 18 | ret.x = ret.x * 8 19 | ret.z = ret.z * 8 20 | return ret 21 | 22 | def copy(self): 23 | return copy.copy(self) 24 | 25 | def __str__(self): 26 | return f'{self.x}, {self.y}, {self.z}' 27 | -------------------------------------------------------------------------------- /where_is/utils.py: -------------------------------------------------------------------------------- 1 | import inspect 2 | import functools 3 | import threading 4 | from typing import Optional, Callable, Union 5 | 6 | from mcdreforged.api.decorator import FunctionThread 7 | from mcdreforged.api.rtext import RTextBase, RTextMCDRTranslation 8 | 9 | from where_is.constants import psi, DEBUG 10 | 11 | MessageText: type = Union[str, RTextBase] 12 | TRANSLATION_KEY_PREFIX = psi.get_self_metadata().id + '.' 13 | 14 | 15 | # Utilities 16 | def rtr( 17 | translation_key: str, 18 | *args, 19 | _vris_rtr_with_prefix: bool = True, 20 | **kwargs 21 | ) -> RTextMCDRTranslation: 22 | if _vris_rtr_with_prefix and not translation_key.startswith(TRANSLATION_KEY_PREFIX): 23 | translation_key = f"{TRANSLATION_KEY_PREFIX}{translation_key}" 24 | return RTextMCDRTranslation(translation_key, *args, **kwargs).set_translator(ntr) 25 | 26 | 27 | def debug(msg: Union[str, RTextBase]): 28 | psi.logger.debug(msg, no_check=DEBUG) 29 | 30 | 31 | def ntr( 32 | translation_key: str, 33 | *args, 34 | _mcdr_tr_language: Optional[str] = None, 35 | _mcdr_tr_allow_failure: bool = True, 36 | _vris_ntr_default_fallback: Optional[MessageText] = None, 37 | _vris_ntr_log_error_message: bool = True, 38 | **kwargs 39 | ) -> MessageText: 40 | try: 41 | return psi.tr( 42 | translation_key, *args, 43 | _mcdr_tr_language=_mcdr_tr_language, 44 | _mcdr_tr_allow_failure=False, 45 | **kwargs 46 | ) 47 | except (KeyError, ValueError): 48 | fallback_language = psi.get_mcdr_language() 49 | try: 50 | if fallback_language == 'en_us': 51 | raise KeyError(translation_key) 52 | return psi.tr( 53 | translation_key, *args, _mcdr_tr_language='en_us', 54 | language='en_us', allow_failure=False, **kwargs 55 | ) 56 | except (KeyError, ValueError): 57 | languages = [] 58 | for item in (_mcdr_tr_language, fallback_language, 'en_us'): 59 | if item not in languages: 60 | languages.append(item) 61 | languages = ', '.join(languages) 62 | if _mcdr_tr_allow_failure: 63 | if _vris_ntr_log_error_message: 64 | psi.logger.error(f'Error translate text "{translation_key}" to language {languages}') 65 | if _vris_ntr_default_fallback is None: 66 | return translation_key 67 | return _vris_ntr_default_fallback 68 | else: 69 | raise KeyError(f'Translation key "{translation_key}" not found with language {languages}') 70 | 71 | 72 | def dim_tr(key: str, *args, lang: Optional[str] = None, allow_failure: bool = True, **kwargs): 73 | try: 74 | return ntr(key, *args, lang=lang, _mcdr_tr_allow_failure=False, **kwargs) 75 | except Exception as exc: 76 | if not allow_failure: 77 | raise exc 78 | if key.startswith('where_is.dim.'): 79 | return key[13:] 80 | else: 81 | return key 82 | 83 | 84 | def to_camel_case(string: str, divider: str = ' ', upper: bool = True) -> str: 85 | word_list = [capitalize(item) for item in string.split(divider)] 86 | if not upper: 87 | first_word_char_list = list(word_list[0]) 88 | first_word_char_list[0] = first_word_char_list[0].lower() 89 | word_list[0] = ''.join(first_word_char_list) 90 | return ''.join(word_list) 91 | 92 | 93 | def capitalize(string: str) -> str: 94 | if len(string) == 0: 95 | return string 96 | char_list = list(string) 97 | char_list[0] = char_list[0].upper() 98 | return ''.join(char_list) 99 | 100 | 101 | def get_thread_prefix() -> str: 102 | return to_camel_case(psi.get_self_metadata().name, divider=' ') + '_' 103 | 104 | 105 | def named_thread(arg: Optional[Union[str, Callable]] = None) -> Callable: 106 | def wrapper(func): 107 | @functools.wraps(func) 108 | def wrap(*args, **kwargs): 109 | def try_func(): 110 | try: 111 | return func(*args, **kwargs) 112 | except Exception as e: 113 | psi.logger.exception('Error running thread {}'.format(threading.current_thread().name), exc_info=e) 114 | 115 | prefix = get_thread_prefix() 116 | thread = FunctionThread(target=try_func, args=[], kwargs={}, name=prefix + thread_name) 117 | thread.start() 118 | return thread 119 | 120 | wrap.__signature__ = inspect.signature(func) 121 | wrap.original = func 122 | return wrap 123 | 124 | # Directly use @new_thread without ending brackets case, e.g. @new_thread 125 | if isinstance(arg, Callable): 126 | thread_name = to_camel_case(arg.__name__, divider="_") 127 | return wrapper(arg) 128 | # Use @new_thread with ending brackets case, e.g. @new_thread('A'), @new_thread() 129 | else: 130 | thread_name = arg 131 | return wrapper 132 | --------------------------------------------------------------------------------