├── LICENSE ├── README.md ├── init.lua ├── mod.conf └── screenshot.png /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 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # wielded_light mod for Minetest 2 | 3 | Idea taken from torches_wieldlight in https://github.com/minetest-mods/torches, but written from scratch and usable for all shining items. 4 | 5 | ![Screenshot](https://github.com/bell07/minetest-wielded_light/raw/master/screenshot.png) 6 | 7 | All bright nodes with light value > 2 lighten the player environment if wielded, with value fewer by 2. (Torch 13->11 for example) 8 | 9 | Dependencies: none 10 | 11 | License: [GPL-3](https://github.com/bell07/minetest-wielded_light/blob/master/LICENSE) 12 | 13 | 14 | Shining API: 15 | 16 | `function wielded_light.update_light(pos, light_level)` 17 | Enable or update the shining at pos with light_level for 0.6 seconds. Can be used in any on_step call to get other entitys shining for example 18 | 19 | 20 | `wielded_light.register_item_light(itemname, light_level)` 21 | Override or set custom light level to an item. This does not change the item/node definition, just the lighting in this mod. 22 | 23 | `function wielded_light.update_light_by_item(stack, pos)` 24 | Update light at pos using item shining settings -from registered item_light or from item definition 25 | -------------------------------------------------------------------------------- /init.lua: -------------------------------------------------------------------------------- 1 | local mod_name = minetest.get_current_modname() 2 | 3 | -- Node replacements that emit light 4 | -- Sets of lighting_node={ node=original_node, level=light_level } 5 | local lighting_nodes = {} 6 | 7 | -- The nodes that can be replaced with lighting nodes 8 | -- Sets of original_node={ [1]=lighting_node_1, [2]=lighting_node_2, ... } 9 | local lightable_nodes = {} 10 | 11 | -- Prefixes used for each node so we can avoid overlap 12 | -- Pairs of prefix=original_node 13 | local lighting_prefixes = {} 14 | 15 | -- node_name=true pairs of lightable nodes that are liquids and can flood some light sources 16 | local lightable_liquids = {} 17 | 18 | -- How often will the positions of lights be recalculated 19 | local update_interval = 0.2 20 | 21 | -- How long until a previously lit node should be updated - reduces flicker 22 | local removal_delay = update_interval * 0.5 23 | 24 | -- How often will a node attempt to check itself for deletion 25 | local cleanup_interval = update_interval * 3 26 | 27 | -- How far in the future will the position be projected based on the velocity 28 | local velocity_projection = update_interval * 1 29 | 30 | -- How many light levels should an item held in the hand be reduced by, compared to the placed node 31 | -- does not apply to manually registered light levels 32 | local level_delta = 2 33 | 34 | -- item=light_level pairs of registered wielded lights 35 | local shiny_items = {} 36 | 37 | -- List of custom callbacks for each update step 38 | local update_callbacks = {} 39 | local update_player_callbacks = {} 40 | 41 | -- position={id=light_level} sets of known about light sources and their levels by position 42 | local active_lights = {} 43 | 44 | --[[ Sets of entities being tracked, in the form: 45 | entity_id = { 46 | obj = entity, 47 | items = { 48 | category_id..entity_id = { 49 | level = light_level, 50 | item? = item_name 51 | } 52 | }, 53 | update = true | false, 54 | pos? = position_vector, 55 | offset? = offset_vector, 56 | } 57 | ]] 58 | local tracked_entities = {} 59 | 60 | -- position=true pairs of positions that need to be recaculated this update step 61 | local light_recalcs = {} 62 | 63 | --[[ 64 | Using 2-digit hex codes for categories 65 | Starts at 00, ends at FF 66 | This makes it easier extract `uid` from `cat_id..uid` by slicing off 2 characters 67 | The category ID must be of a fixed length (2 characters) 68 | ]] 69 | local cat_id = 0 70 | local cat_codes = {} 71 | local function get_light_category_id(cat) 72 | -- If the category id does not already exist generate a new one 73 | if not cat_codes[cat] then 74 | if cat_id >= 256 then 75 | error("Wielded item category limit exceeded, maximum 256 wield categories") 76 | end 77 | local code = string.format("%02x", cat_id) 78 | cat_id = cat_id+1 79 | cat_codes[cat] = code 80 | end 81 | -- If the category id does exist, return it 82 | return cat_codes[cat] 83 | end 84 | 85 | -- Log an error coming from this mod 86 | local function error_log(message, ...) 87 | minetest.log("error", "[Wielded Light] " .. (message:format(...))) 88 | end 89 | 90 | -- Is a node lightable and a liquid capable of flooding some light sources 91 | local function is_lightable_liquid(pos) 92 | local node = minetest.get_node_or_nil(pos) 93 | if not node then return end 94 | return lightable_liquids[node.name] 95 | end 96 | 97 | -- Check if an entity instance still exists in the world 98 | local function is_entity_valid(entity) 99 | return entity and (entity.obj:is_player() or (entity.obj:get_luaentity() and entity.obj:get_luaentity().name) or false) 100 | end 101 | 102 | -- Check whether a node was registered by the wield_light mod 103 | local function is_wieldlight_node(pos_vec) 104 | local name = string.sub(minetest.get_node(pos_vec).name, 1, #mod_name) 105 | return name == mod_name 106 | end 107 | 108 | -- Get the projected position of an entity based on its velocity, rounded to the nearest block 109 | local function entity_pos(obj, offset) 110 | local velocity 111 | if (minetest.features.direct_velocity_on_players or not obj:is_player()) and obj.get_velocity then 112 | velocity = obj:get_velocity() 113 | else 114 | velocity = obj:get_player_velocity() 115 | end 116 | 117 | return wielded_light.get_light_position( 118 | vector.round( 119 | vector.add( 120 | vector.add( 121 | offset or { x=0, y=0, z=0 }, 122 | obj:get_pos() 123 | ), 124 | vector.multiply( 125 | velocity or { x=0, y=0, z=0 }, 126 | velocity_projection 127 | ) 128 | ) 129 | ) 130 | ) 131 | end 132 | 133 | -- Add light to active light list and mark position for update 134 | local function add_light(pos, id, light_level) 135 | if not active_lights[pos] then 136 | active_lights[pos] = {} 137 | end 138 | if active_lights[pos][id] ~= light_level then 139 | -- minetest.log("error", "add "..id.." "..pos.." "..tostring(light_level)) 140 | active_lights[pos][id] = light_level 141 | light_recalcs[pos] = true 142 | end 143 | end 144 | 145 | -- Remove light from active light list and mark position for update 146 | local function remove_light(pos, id) 147 | if not active_lights[pos] then return end 148 | -- minetest.log("error", "rem "..id.." "..pos) 149 | active_lights[pos][id] = nil 150 | minetest.after(removal_delay, function () 151 | light_recalcs[pos] = true 152 | end) 153 | end 154 | 155 | -- Track an entity's position and update its light, will be called on every update step 156 | local function update_entity(entity) 157 | local pos = entity_pos(entity.obj, entity.offset) 158 | local pos_str = pos and minetest.pos_to_string(pos) 159 | 160 | -- If the position has changed, remove the old light and mark the entity for update 161 | if entity.pos and pos_str ~= entity.pos then 162 | entity.update = true 163 | for id,_ in pairs(entity.items) do 164 | remove_light(entity.pos, id) 165 | end 166 | end 167 | 168 | -- Update the recorded position 169 | entity.pos = pos_str 170 | 171 | -- If the position is still loaded, pump the timer up so it doesn't get removed 172 | if pos then 173 | -- If the entity is marked for an update, add the light in the position if it emits light 174 | if entity.update then 175 | for id, item in pairs(entity.items) do 176 | if item.level > 0 and not (item.floodable and is_lightable_liquid(pos)) then 177 | add_light(pos_str, id, item.level) 178 | else 179 | remove_light(pos_str, id) 180 | end 181 | end 182 | end 183 | end 184 | if active_lights[pos_str] then 185 | if is_wieldlight_node(pos) then 186 | minetest.get_node_timer(pos):start(cleanup_interval) 187 | end 188 | end 189 | entity.update = false 190 | end 191 | 192 | 193 | -- Save the original nodes timer if it has one 194 | local function save_timer(pos_vec) 195 | local timer = minetest.get_node_timer(pos_vec) 196 | if timer:is_started() then 197 | local meta = minetest.get_meta(pos_vec) 198 | meta:set_float("saved_timer_timeout", timer:get_timeout()) 199 | meta:set_float("saved_timer_elapsed", timer:get_elapsed()) 200 | end 201 | end 202 | 203 | -- Restore the original nodes timer if it had one 204 | local function restore_timer(pos_vec) 205 | local meta = minetest.get_meta(pos_vec) 206 | local timeout = meta:get_float("saved_timer_timeout") 207 | if timeout > 0 then 208 | local elapsed = meta:get_float("saved_timer_elapsed") 209 | local timer = minetest.get_node_timer(pos_vec) 210 | timer:set(timeout, elapsed) 211 | meta:set_string("saved_timer_timeout","") 212 | meta:set_string("saved_timer_elapsed","") 213 | end 214 | end 215 | 216 | -- Replace a lighting node with its original counterpart 217 | local function reset_lighting_node(pos) 218 | local existing_node = minetest.get_node(pos) 219 | local lighting_node = wielded_light.get_lighting_node(existing_node.name) 220 | if not lighting_node then 221 | return 222 | end 223 | minetest.swap_node(pos, { name = lighting_node.node,param2 = existing_node.param2 }) 224 | restore_timer(pos) 225 | end 226 | 227 | -- Will be run once the node timer expires 228 | local function cleanup_timer_callback(pos, elapsed) 229 | local pos_str = minetest.pos_to_string(pos) 230 | local lights = active_lights[pos_str] 231 | -- If no active lights for this position, remove itself 232 | if not lights then 233 | reset_lighting_node(pos) 234 | else 235 | -- Clean up any tracked entities for this position that no longer exist 236 | for id,_ in pairs(lights) do 237 | local uid = string.sub(id,3) 238 | local entity = tracked_entities[uid] 239 | if not is_entity_valid(entity) then 240 | remove_light(pos_str, id) 241 | end 242 | end 243 | minetest.get_node_timer(pos):start(cleanup_interval) 244 | end 245 | end 246 | 247 | 248 | -- Recalculate the total light level for a given position and update the light level there 249 | local function recalc_light(pos) 250 | -- If not in active lights list we can't do anything 251 | if not active_lights[pos] then return end 252 | 253 | -- Calculate the light level of the node 254 | local any_light = false 255 | local max_light = 0 256 | for id, light_level in pairs(active_lights[pos]) do 257 | any_light = true 258 | if light_level > max_light then 259 | max_light = light_level 260 | end 261 | end 262 | 263 | -- Convert the position back to a vector 264 | local pos_vec = minetest.string_to_pos(pos) 265 | 266 | -- If no items in this position, delete it from the list and remove any light node 267 | if not any_light then 268 | active_lights[pos] = nil 269 | reset_lighting_node(pos_vec) 270 | return 271 | end 272 | 273 | -- If no light in this position remove any light node 274 | if max_light == 0 then 275 | reset_lighting_node(pos_vec) 276 | return 277 | end 278 | 279 | -- Limit the light level 280 | max_light = math.min(max_light, minetest.LIGHT_MAX) 281 | 282 | -- Get the current light level in this position 283 | local existing_node = minetest.get_node(pos_vec) 284 | local name = existing_node.name 285 | local old_value = wielded_light.level_of_lighting_node(name) or 0 286 | 287 | -- If the light level has changed, set the coresponding light node and initiate the cleanup timer 288 | if old_value ~= max_light then 289 | local node_name 290 | if lightable_nodes[name] then 291 | node_name = name 292 | elseif lighting_nodes[name] then 293 | node_name = lighting_nodes[name].node 294 | end 295 | if node_name then 296 | if not is_wieldlight_node(pos_vec) then 297 | save_timer(pos_vec) 298 | end 299 | 300 | minetest.swap_node(pos_vec, { 301 | name = lightable_nodes[node_name][max_light], 302 | param2 = existing_node.param2 303 | }) 304 | minetest.get_node_timer(pos_vec):start(cleanup_interval) 305 | else 306 | active_lights[pos] = nil 307 | end 308 | end 309 | end 310 | 311 | local timer = 0 312 | -- Will be run on every global step 313 | local function global_timer_callback(dtime) 314 | -- Only run once per update interval, global step will be called much more often than that 315 | timer = timer + dtime; 316 | if timer < update_interval then 317 | return 318 | end 319 | timer = 0 320 | 321 | -- Run all custom player callbacks for each player 322 | local connected_players = minetest.get_connected_players() 323 | for _,callback in pairs(update_player_callbacks) do 324 | for _, player in pairs(connected_players) do 325 | callback(player) 326 | end 327 | end 328 | 329 | -- Run all custom callbacks 330 | for _,callback in pairs(update_callbacks) do 331 | callback() 332 | end 333 | 334 | -- Look at each tracked entity and update its position 335 | for uid, entity in pairs(tracked_entities) do 336 | if is_entity_valid(entity) then 337 | update_entity(entity) 338 | else 339 | -- If the entity no longer exists, stop tracking it 340 | tracked_entities[uid] = nil 341 | end 342 | end 343 | 344 | -- Recalculate light levels 345 | for pos,_ in pairs(light_recalcs) do 346 | recalc_light(pos) 347 | end 348 | light_recalcs = {} 349 | end 350 | 351 | --- Shining API --- 352 | wielded_light = {} 353 | 354 | -- Registers a callback to be called every time the update interval is passed 355 | function wielded_light.register_lightstep(callback) 356 | table.insert(update_callbacks, callback) 357 | end 358 | 359 | -- Registers a callback to be called for each player every time the update interval is passed 360 | function wielded_light.register_player_lightstep(callback) 361 | table.insert(update_player_callbacks, callback) 362 | end 363 | 364 | -- Returns the node name for a given light level 365 | function wielded_light.lighting_node_of_level(light_level, prefix) 366 | return mod_name..":"..(prefix or "")..light_level 367 | end 368 | 369 | -- Gets the light level for a given node name, inverse of lighting_node_of_level 370 | function wielded_light.level_of_lighting_node(node_name) 371 | local lighting_node = wielded_light.get_lighting_node(node_name) 372 | if lighting_node then 373 | return lighting_node.level 374 | end 375 | end 376 | 377 | -- Check if a node name is one of the wielded light nodes 378 | function wielded_light.get_lighting_node(node_name) 379 | return lighting_nodes[node_name] 380 | end 381 | 382 | -- Register any node as lightable, register all light level variations for it 383 | function wielded_light.register_lightable_node(node_name, property_overrides, custom_prefix) 384 | -- Node name must be string 385 | if type(node_name) ~= "string" then 386 | error_log("You must provide a node name to be registered as lightable, '%s' given.", type(node_name)) 387 | return 388 | end 389 | 390 | -- Node must already be registered 391 | local original_definition = minetest.registered_nodes[node_name] 392 | if not original_definition then 393 | error_log("The node '%s' cannot be registered as lightable because it does not exist.", node_name) 394 | return 395 | end 396 | 397 | -- Decide the prefix for the lighting node 398 | local prefix = custom_prefix or node_name:gsub(":", "_", 1, true) .. "_" 399 | if lighting_prefixes[prefix] then 400 | error_log("The lighting prefix '%s' cannot be used for '%s' as it is already used for '%s'.", prefix, node_name, lighting_prefixes[prefix]) 401 | return 402 | end 403 | lighting_prefixes[prefix] = node_name 404 | 405 | -- Default for property overrides 406 | if not property_overrides then property_overrides = {} end 407 | 408 | -- Copy the node definition and provide required settings for a lighting node 409 | local new_definition = table.copy(original_definition) 410 | new_definition.on_timer = cleanup_timer_callback 411 | new_definition.paramtype = "light" 412 | new_definition.mod_origin = mod_name 413 | new_definition.groups = new_definition.groups or {} 414 | new_definition.groups.not_in_creative_inventory = 1 415 | -- Make sure original node is dropped if a lit node is dug 416 | if not new_definition.drop then 417 | new_definition.drop = node_name 418 | end 419 | 420 | -- Allow any properties to be overridden on registration 421 | for prop, val in pairs(property_overrides) do 422 | new_definition[prop] = val 423 | end 424 | 425 | -- If it's a liquid, we need to stop it flowing 426 | if new_definition.groups.liquid then 427 | new_definition.liquid_range = 0 428 | lightable_liquids[node_name] = true 429 | end 430 | 431 | -- Register the lighting nodes 432 | lightable_nodes[node_name] = {} 433 | for i=1, minetest.LIGHT_MAX do 434 | local lighting_node_name = wielded_light.lighting_node_of_level(i, prefix) 435 | 436 | -- Index for quick finding later 437 | lightable_nodes[node_name][i] = lighting_node_name 438 | lighting_nodes[lighting_node_name] = { 439 | node = node_name, 440 | level = i 441 | } 442 | 443 | -- Copy the base definition and apply the light level 444 | local level_definition = table.copy(new_definition) 445 | level_definition.light_source = i 446 | 447 | -- If it's a liquid, we need to stop it replacing itself with the original 448 | if level_definition.groups.liquid then 449 | level_definition.liquid_alternative_source = lighting_node_name 450 | level_definition.liquid_alternative_flowing = lighting_node_name 451 | end 452 | 453 | minetest.register_node(":"..lighting_node_name, level_definition) 454 | end 455 | end 456 | 457 | -- Check if node can have a wielded light node placed in it 458 | function wielded_light.is_lightable_node(node_pos) 459 | local name = minetest.get_node(node_pos).name 460 | if lightable_nodes[name] then 461 | return true 462 | elseif wielded_light.get_lighting_node(name) then 463 | return true 464 | end 465 | return false 466 | end 467 | 468 | -- Gets the closest position to pos that's a lightable node 469 | function wielded_light.get_light_position(pos) 470 | local around_vector = { 471 | {x=0, y=0, z=0}, 472 | {x=0, y=1, z=0}, {x=0, y=-1, z=0}, 473 | {x=1, y=0, z=0}, {x=-1, y=0, z=0}, 474 | {x=0, y=0, z=1}, {x=0, y=0, z=-1}, 475 | } 476 | for _, around in ipairs(around_vector) do 477 | local light_pos = vector.add(pos, around) 478 | if wielded_light.is_lightable_node(light_pos) then 479 | return light_pos 480 | end 481 | end 482 | end 483 | 484 | -- Gets the emitted light level of a given item name 485 | function wielded_light.get_light_def(item_name) 486 | -- Invalid item? No light 487 | if not item_name or item_name == "" then 488 | return 0, false 489 | end 490 | 491 | -- If the item is cached return the cached level 492 | local cached_definition = shiny_items[item_name] 493 | if cached_definition then 494 | return cached_definition.level, cached_definition.floodable 495 | end 496 | 497 | -- Get the item definition 498 | local stack = ItemStack(item_name) 499 | local itemdef = stack:get_definition() 500 | 501 | -- If invalid, no light 502 | if not itemdef then 503 | return 0, false 504 | end 505 | 506 | -- Get the light level of an item from its definition 507 | -- Reduce the light level by level_delta - original functionality 508 | -- Limit between 0 and the max light level 509 | return math.min(math.max((itemdef.light_source or 0) - level_delta, 0), minetest.LIGHT_MAX), itemdef.floodable 510 | end 511 | 512 | -- Register an item as shining 513 | function wielded_light.register_item_light(item_name, light_level, floodable) 514 | if shiny_items[item_name] then 515 | if light_level then 516 | shiny_items[item_name].level = light_level 517 | end 518 | if floodable ~= nil then 519 | shiny_items[item_name].floodable = floodable 520 | end 521 | else 522 | if floodable == nil then 523 | local stack = ItemStack(item_name) 524 | local itemdef = stack:get_definition() 525 | floodable = itemdef.floodable 526 | end 527 | shiny_items[item_name] = { 528 | level = light_level, 529 | floodable = floodable or false 530 | } 531 | end 532 | end 533 | 534 | -- Mark an item as floodable or not 535 | function wielded_light.register_item_floodable(item_name, floodable) 536 | if floodable == nil then floodable = true end 537 | if shiny_items[item_name] then 538 | shiny_items[item_name].floodable = floodable 539 | else 540 | local calced_level = wielded_light.get_light_def(item_name) 541 | shiny_items[item_name] = { 542 | level = calced_level, 543 | floodable = floodable 544 | } 545 | end 546 | end 547 | 548 | -- Keep track of an item entity. Should be called once for an item 549 | function wielded_light.track_item_entity(obj, cat, item) 550 | if not is_entity_valid({ obj=obj }) then return end 551 | 552 | local light_level, light_is_floodable = wielded_light.get_light_def(item) 553 | -- If the item does not emit light do not track it 554 | if light_level <= 0 then return end 555 | 556 | -- Generate the uid for the item and the id for the light category 557 | local uid = tostring(obj) 558 | local id = get_light_category_id(cat)..uid 559 | 560 | -- Create the main tracking object for this item instance if it does not already exist 561 | if not tracked_entities[uid] then 562 | tracked_entities[uid] = { obj=obj, items={}, update = true } 563 | end 564 | 565 | -- Create the item tracking object for this item + category 566 | tracked_entities[uid].items[id] = { level=light_level, floodable=light_is_floodable } 567 | 568 | -- Add the light in on creation so it's immediate 569 | local pos = entity_pos(obj) 570 | local pos_str = pos and minetest.pos_to_string(pos) 571 | if pos_str then 572 | if not (light_is_floodable and is_lightable_liquid(pos)) then 573 | add_light(pos_str, id, light_level) 574 | end 575 | end 576 | tracked_entities[uid].pos = pos_str 577 | end 578 | 579 | -- A player's light should appear near their head not their feet 580 | local player_height_offset = { x=0, y=1, z=0 } 581 | 582 | -- Keep track of a user / player entity. Should be called as often as the user updates 583 | function wielded_light.track_user_entity(obj, cat, item) 584 | -- Generate the uid for the player and the id for the light category 585 | local uid = tostring(obj) 586 | local id = get_light_category_id(cat)..uid 587 | 588 | -- Create the main tracking object for this player instance if it does not already exist 589 | if not tracked_entities[uid] then 590 | tracked_entities[uid] = { obj=obj, items={}, offset = player_height_offset, update = true } 591 | end 592 | 593 | local tracked_entity = tracked_entities[uid] 594 | local tracked_item = tracked_entity.items[id] 595 | 596 | -- If the item being tracked for the player changes, update the item tracking object for this item + category 597 | if not tracked_item or tracked_item.item ~= item then 598 | local light_level, light_is_floodable = wielded_light.get_light_def(item) 599 | tracked_entity.items[id] = { level=light_level, item=item, floodable=light_is_floodable } 600 | tracked_entity.update = true 601 | end 602 | end 603 | 604 | 605 | -- Setup -- 606 | 607 | -- Wielded item shining globalstep 608 | minetest.register_globalstep(global_timer_callback) 609 | 610 | -- Dropped item on_step override 611 | -- https://github.com/minetest/minetest/issues/6909 612 | local builtin_item = minetest.registered_entities["__builtin:item"] 613 | local item = { 614 | on_step = function(self, dtime, ...) 615 | builtin_item.on_step(self, dtime, ...) 616 | -- Register an item once for tracking 617 | -- If it's already being tracked, exit 618 | if self.wielded_light then return end 619 | self.wielded_light = true 620 | local stack = ItemStack(self.itemstring) 621 | local item_name = stack:get_name() 622 | wielded_light.track_item_entity(self.object, "item", item_name) 623 | end 624 | } 625 | setmetatable(item, {__index = builtin_item}) 626 | minetest.register_entity(":__builtin:item", item) 627 | 628 | -- Track a player's wielded item 629 | wielded_light.register_player_lightstep(function (player) 630 | wielded_light.track_user_entity(player, "wield", player:get_wielded_item():get_name()) 631 | end) 632 | 633 | -- Register helper nodes 634 | wielded_light.register_lightable_node("air", nil, "") 635 | 636 | if minetest.get_modpath("default") then 637 | wielded_light.register_lightable_node("default:water_source", nil, "water_") 638 | wielded_light.register_lightable_node("default:river_water_source", nil, "river_water_") 639 | elseif minetest.get_modpath("hades_core") then 640 | wielded_light.register_lightable_node("hades_core:water_source", nil, "water_") 641 | else 642 | error_log("Not running in a supported game, lightable water disabled") 643 | end 644 | 645 | ---TEST 646 | --wielded_light.register_item_light('default:dirt', 14) 647 | -------------------------------------------------------------------------------- /mod.conf: -------------------------------------------------------------------------------- 1 | name = wielded_light 2 | optional_depends = default, hades_core, builtin_item 3 | -------------------------------------------------------------------------------- /screenshot.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/minetest-mods/wielded_light/3dfc2623598e095954b0a97f6bac6da7096cdf10/screenshot.png --------------------------------------------------------------------------------