├── LICENSE ├── README.md ├── _types.lua ├── assets ├── bank.png ├── basket.png ├── circle.png ├── dollar.png ├── dot.png ├── eye.png ├── garage.png ├── hex.png ├── hood.png ├── hook.png ├── location.png ├── lock.png ├── person.png ├── radial.png ├── scissors.png ├── shirt.png ├── square.png ├── trunk.png ├── unlock.png ├── wheel.png └── worm.png ├── client ├── init.lua └── modules │ ├── config.lua │ ├── sprite.lua │ ├── sprites.lua │ └── textures.lua └── fxmanifest.lua /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 | # bl_sprites 2 | ## Description 3 | Interactive World Sprites that provide players extra info. 4 | 5 | ### Dependencies: 6 | - [ox_lib](https://github.com/overextended/ox_lib) 7 | 8 | ### [PREVIEW](https://youtu.be/vmtox_rdTOE) 9 | 10 | ### [DOCUMENTATION](https://docs.byte-labs.net/bl_sprites) 11 | 12 | ### [Create own/edit sprites](https://www.figma.com/file/lCa8qRBuXazc4jXBpaHAuC/Byte-Labs-Sprites?type=design&node-id=0%3A1&mode=design&t=PI6EaFRVr89TyzA4-1) 13 | 14 | ### Example 15 | ```lua 16 | local CreateSprite = exports.bl_sprites 17 | 18 | local test = CreateSprite:sprite({ 19 | coords = GetEntityCoords(PlayerPedId()), 20 | key = "R", 21 | shape = "circle", 22 | spriteIndicator = true, 23 | colour = {255, 0, 0, 255}, 24 | distance = 5.0, 25 | scale = 0.05, 26 | canInteract = function() 27 | return true 28 | end, 29 | nearby = function() 30 | print('nearby') 31 | end, 32 | onEnter = function() 33 | print('onEnter') 34 | end, 35 | onExit = function() 36 | print('onExit') 37 | end, 38 | }) 39 | 40 | -- test is an sprite class that have options data and the 2 below function 41 | 42 | Wait(2000) 43 | test:updateTargetData('scale', 0.08) 44 | 45 | Wait(2000) 46 | test:removeSprite() 47 | ``` 48 | -------------------------------------------------------------------------------- /_types.lua: -------------------------------------------------------------------------------- 1 | 2 | 3 | ---@class SpriteParamBase 4 | ---@field public id? integer @ The handle id of the sprite. Assigned on creation 5 | ---@field public spriteType? 'default' | 'entity' | 'bone' @ The type of the sprites. Assigned on creation 6 | ---@field public key? string @ The displayed in the middle of the sprite 7 | ---@field public colour? number[] @ The colour of the sprite. RGB array 8 | ---@field public keyColour? number[] @ The colour of the key. RGB array 9 | ---@field public shape? string @ The shape of the sprite 10 | ---@field public scale? number @ Multiplier for the sprite size 11 | ---@field public distance? number @ The distance from the sprite to the player 12 | ---@field public onEnter? function @ The function to call when the player enters the sprite 13 | ---@field public onExit? function @ The function to call when the player exits the sprite 14 | ---@field public nearby? function @ The function to call when the player is nearby the sprite 15 | ---@field public sprite? string @ The sprite name 16 | ---@field public keySprite? string @ The key sprite name 17 | ---@field public spriteIndicator? boolean @ Whether to display the sprite indicator 18 | 19 | ---@class DefinedSpriteParam : SpriteParamBase 20 | ---@field public coords vector3 @ The coordinates of the sprite 21 | 22 | ---@class EntitySpriteParam : SpriteParamBase 23 | ---@field public entity number @ The entity to track the bone of 24 | 25 | ---@class BoneSpriteParam : SpriteParamBase 26 | ---@field public boneId number @ Bone id 27 | ---@field public entity number @ The entity to track the bone of 28 | 29 | ---@class ActiveSprite : SpriteParamBase 30 | 31 | -------------------------------------------------------------------------------- /assets/bank.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Byte-Labs-Studio/bl_sprites/dabb5c80866fc7fd92474cd2606c3246a1b5ea44/assets/bank.png -------------------------------------------------------------------------------- /assets/basket.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Byte-Labs-Studio/bl_sprites/dabb5c80866fc7fd92474cd2606c3246a1b5ea44/assets/basket.png -------------------------------------------------------------------------------- /assets/circle.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Byte-Labs-Studio/bl_sprites/dabb5c80866fc7fd92474cd2606c3246a1b5ea44/assets/circle.png -------------------------------------------------------------------------------- /assets/dollar.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Byte-Labs-Studio/bl_sprites/dabb5c80866fc7fd92474cd2606c3246a1b5ea44/assets/dollar.png -------------------------------------------------------------------------------- /assets/dot.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Byte-Labs-Studio/bl_sprites/dabb5c80866fc7fd92474cd2606c3246a1b5ea44/assets/dot.png -------------------------------------------------------------------------------- /assets/eye.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Byte-Labs-Studio/bl_sprites/dabb5c80866fc7fd92474cd2606c3246a1b5ea44/assets/eye.png -------------------------------------------------------------------------------- /assets/garage.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Byte-Labs-Studio/bl_sprites/dabb5c80866fc7fd92474cd2606c3246a1b5ea44/assets/garage.png -------------------------------------------------------------------------------- /assets/hex.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Byte-Labs-Studio/bl_sprites/dabb5c80866fc7fd92474cd2606c3246a1b5ea44/assets/hex.png -------------------------------------------------------------------------------- /assets/hood.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Byte-Labs-Studio/bl_sprites/dabb5c80866fc7fd92474cd2606c3246a1b5ea44/assets/hood.png -------------------------------------------------------------------------------- /assets/hook.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Byte-Labs-Studio/bl_sprites/dabb5c80866fc7fd92474cd2606c3246a1b5ea44/assets/hook.png -------------------------------------------------------------------------------- /assets/location.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Byte-Labs-Studio/bl_sprites/dabb5c80866fc7fd92474cd2606c3246a1b5ea44/assets/location.png -------------------------------------------------------------------------------- /assets/lock.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Byte-Labs-Studio/bl_sprites/dabb5c80866fc7fd92474cd2606c3246a1b5ea44/assets/lock.png -------------------------------------------------------------------------------- /assets/person.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Byte-Labs-Studio/bl_sprites/dabb5c80866fc7fd92474cd2606c3246a1b5ea44/assets/person.png -------------------------------------------------------------------------------- /assets/radial.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Byte-Labs-Studio/bl_sprites/dabb5c80866fc7fd92474cd2606c3246a1b5ea44/assets/radial.png -------------------------------------------------------------------------------- /assets/scissors.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Byte-Labs-Studio/bl_sprites/dabb5c80866fc7fd92474cd2606c3246a1b5ea44/assets/scissors.png -------------------------------------------------------------------------------- /assets/shirt.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Byte-Labs-Studio/bl_sprites/dabb5c80866fc7fd92474cd2606c3246a1b5ea44/assets/shirt.png -------------------------------------------------------------------------------- /assets/square.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Byte-Labs-Studio/bl_sprites/dabb5c80866fc7fd92474cd2606c3246a1b5ea44/assets/square.png -------------------------------------------------------------------------------- /assets/trunk.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Byte-Labs-Studio/bl_sprites/dabb5c80866fc7fd92474cd2606c3246a1b5ea44/assets/trunk.png -------------------------------------------------------------------------------- /assets/unlock.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Byte-Labs-Studio/bl_sprites/dabb5c80866fc7fd92474cd2606c3246a1b5ea44/assets/unlock.png -------------------------------------------------------------------------------- /assets/wheel.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Byte-Labs-Studio/bl_sprites/dabb5c80866fc7fd92474cd2606c3246a1b5ea44/assets/wheel.png -------------------------------------------------------------------------------- /assets/worm.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Byte-Labs-Studio/bl_sprites/dabb5c80866fc7fd92474cd2606c3246a1b5ea44/assets/worm.png -------------------------------------------------------------------------------- /client/init.lua: -------------------------------------------------------------------------------- 1 | require "client.modules.textures" 2 | local sprites = require "client.modules.sprites" 3 | local config = require "client.modules.config" 4 | local CreateSprite = require "client.modules.sprite" 5 | local myPed = nil 6 | local keySpriteScaleModifier, txtDict in config 7 | local GetAspectRatio, SetDrawOrigin, DrawSprite, BeginTextCommandDisplayText, AddTextComponentSubstringPlayerName, SetTextScale, SetTextCentre, SetTextFont, SetTextColour, EndTextCommandDisplayText, ClearDrawOrigin, GetEntityCoords, GetScreenCoordFromWorldCoord = GetAspectRatio, SetDrawOrigin, DrawSprite, BeginTextCommandDisplayText, AddTextComponentSubstringPlayerName, SetTextScale, SetTextCentre, SetTextFont, SetTextColour, EndTextCommandDisplayText, ClearDrawOrigin, GetEntityCoords, GetScreenCoordFromWorldCoord 8 | local table_unpack = table.unpack 9 | local math_exp, math_floor = math.exp, math.floor 10 | 11 | local inViews = {} 12 | local spriteIndicators = {} 13 | 14 | local function drawSprite(sprite, scaleModifier) 15 | if sprite.canInteract then 16 | local success, resp = pcall(sprite.canInteract) 17 | if not success or not resp then return end 18 | end 19 | 20 | local id = sprite.id 21 | 22 | local ratio = GetAspectRatio(true) 23 | local coords = sprite.coords 24 | SetDrawOrigin(coords.x, coords.y, coords.z) 25 | 26 | if sprite.spriteIndicator then 27 | local _, x, y = GetScreenCoordFromWorldCoord(coords.x, coords.y, coords.z) 28 | 29 | local inScreen = x > 0.3 and y > 0.25 and x < 0.7 and y < 0.75 30 | 31 | if inScreen then 32 | if not inViews[id] then 33 | inViews[id] = 0.1 34 | end 35 | 36 | if inViews[id] < 1.0 then 37 | inViews[id] = inViews[id] + 0.1 > 1.0 and 1.0 or inViews[id] + 0.1 38 | end 39 | 40 | if spriteIndicators[id] then 41 | spriteIndicators[id] = spriteIndicators[id] - 0.1 < 0.0 and 0.0 or spriteIndicators[id] - 0.1 42 | if spriteIndicators[id] <= 0.0 then 43 | spriteIndicators[id] = nil 44 | end 45 | end 46 | else 47 | if inViews[id] then 48 | inViews[id] = inViews[id] - 0.1 < 0.0 and 0.0 or inViews[id] - 0.1 49 | if inViews[id] <= 0.0 then 50 | inViews[id] = nil 51 | end 52 | end 53 | 54 | if not spriteIndicators[id] then 55 | spriteIndicators[id] = 0.1 56 | end 57 | 58 | if spriteIndicators[id] < 1.0 then 59 | spriteIndicators[id] = spriteIndicators[id] + 0.1 > 1.0 and 1.0 or spriteIndicators[id] + 0.1 60 | end 61 | end 62 | else 63 | inViews[id] = 1.0 64 | end 65 | 66 | local scale = scaleModifier and sprite.scale * scaleModifier or sprite.scale 67 | scale = math_floor(scale * 10000) / 10000 68 | 69 | if inViews[id] and sprite.sprite or not sprite.spriteIndicator and sprite.sprite then 70 | scale = scale * math_exp(-0.15 * sprite.currentDistance) 71 | local r, g, b, a = table_unpack(sprite.colour) 72 | 73 | local spriteScale = scale > 0.02 and scale or 0.02 * inViews[id] 74 | DrawSprite(txtDict, sprite.sprite, 0, 0, spriteScale, spriteScale * ratio, 0.0, r, g, b, a or 255) 75 | end 76 | 77 | if sprite.sprite and spriteIndicators[id] then 78 | local indicatorScaleModifier = spriteIndicators[id] 79 | local indicatorConfig = config.spriteIndicator 80 | 81 | local indicatorScale = indicatorConfig.scale * math_exp(-0.15 * sprite.currentDistance) * indicatorScaleModifier * (scaleModifier or 1.0) 82 | local r, g, b, a = table_unpack(sprite.colour) 83 | 84 | DrawSprite(txtDict, indicatorConfig.shape, 0, 0, indicatorScale, indicatorScale * ratio, 0.0, r, g, b, a or 255) 85 | end 86 | 87 | if (inViews[id] and sprite.key and not spriteIndicators[id]) or (not sprite.spriteIndicator and sprite.key) then 88 | if sprite.keySprite then 89 | local r, g, b, a = table_unpack(sprite.keyColour) 90 | scale = scale * keySpriteScaleModifier 91 | scale = scale <= 0.005 and 0.005 or scale 92 | DrawSprite(txtDict, sprite.key, 0, 0, scale, scale * ratio, 0.0, r, g, b, a or 255) 93 | else 94 | BeginTextCommandDisplayText('STRING') 95 | AddTextComponentSubstringPlayerName(sprite.key) 96 | 97 | SetTextScale(1.0, scale * 14) 98 | SetTextCentre(true) 99 | SetTextFont(2) 100 | 101 | local r, g, b = table_unpack(sprite.keyColour) 102 | SetTextColour(r, g, b, 255) 103 | EndTextCommandDisplayText(0, -(scale * 0.5)) 104 | end 105 | end 106 | 107 | ClearDrawOrigin() 108 | end 109 | 110 | CreateThread(function() 111 | local Wait, GetWorldPositionOfEntityBone, pairs = Wait, GetWorldPositionOfEntityBone, pairs 112 | while true do 113 | Wait(250) 114 | for _,v in pairs(sprites.entities) do 115 | local boneId = v.boneId 116 | local netId = v.netId 117 | local entity = netId and NetworkDoesEntityExistWithNetworkId(netId) and NetToVeh(netId) or v.entity 118 | if DoesEntityExist(entity) then 119 | v.coords = boneId and GetWorldPositionOfEntityBone(entity, boneId) or GetEntityCoords(entity) 120 | end 121 | end 122 | end 123 | end) 124 | 125 | CreateThread(function() 126 | local deep_clone = lib.table.deepclone 127 | 128 | local activeSprites = sprites.active 129 | lib.requestStreamedTextureDict(txtDict) 130 | 131 | ---@type table 132 | local oldSprites = {} 133 | 134 | ---@type table Number is the scale, so it can scale in 135 | local newSprites = {} 136 | 137 | ---@type table Store here because it wont be in the activeSprites table anymore 138 | local removeActiveSprites = {} 139 | 140 | ---@type table Number is the scale, so it can scale out 141 | local removeSprites = {} 142 | 143 | local _wait = 0 144 | 145 | myPed = cache.ped 146 | local Wait, pairs, next = Wait, pairs, next 147 | while true do 148 | Wait(_wait) 149 | 150 | for k, v in pairs(oldSprites) do 151 | if not activeSprites[k] then 152 | removeActiveSprites[k] = deep_clone(v) 153 | oldSprites[k] = nil 154 | end 155 | end 156 | 157 | for k, v in pairs(activeSprites) do 158 | if not oldSprites[k] then 159 | newSprites[k] = 0.1 160 | oldSprites[k] = v 161 | end 162 | 163 | local newSprite = newSprites[k] 164 | if newSprite and newSprite < 1.0 then 165 | newSprites[k] += 0.1 166 | if newSprites[k] > 1.0 then 167 | newSprites[k] = nil 168 | end 169 | end 170 | 171 | drawSprite(v, newSprites[k]) 172 | end 173 | 174 | for k, v in pairs(removeActiveSprites) do 175 | removeSprites[k] = removeSprites[k] or 1.0 176 | 177 | if removeSprites[k] > 0.0 then 178 | removeSprites[k] -= 0.1 179 | if removeSprites[k] <= 0.0 then 180 | removeSprites[k] = nil 181 | removeActiveSprites[k] = nil 182 | else 183 | drawSprite(v, removeSprites[k] or 0) 184 | end 185 | end 186 | end 187 | 188 | local refreshCoords = (next(activeSprites) or next(removeSprites) or next(newSprites)) and true or false 189 | if refreshCoords then 190 | sprites.playerCoords = GetEntityCoords(myPed) 191 | _wait = 0 192 | else 193 | _wait = 250 194 | end 195 | 196 | oldSprites = deep_clone(activeSprites) 197 | end 198 | end) 199 | 200 | lib.onCache('ped', function(value) 201 | myPed = value 202 | end) 203 | 204 | exports('spriteOnEntity', function(data) 205 | return CreateSprite:defineSpriteOnEntity(data) 206 | end) 207 | 208 | exports('getClosestSprite', function() 209 | return CreateSprite:getClosestSprite() 210 | end) 211 | 212 | exports('spriteOnBone', function(data) 213 | return CreateSprite:defineSpriteOnBone(data) 214 | end) 215 | 216 | exports('sprite', function(data) 217 | return CreateSprite:defineSprite(data) 218 | end) 219 | 220 | exports('updateTargetData', function(id, key, value) 221 | if type(id) == 'table' then 222 | id = id.id 223 | end 224 | 225 | local sprite = sprites.active[id] 226 | if not sprite then return end 227 | 228 | sprite:updateTargetData(key, value) 229 | end) 230 | -------------------------------------------------------------------------------- /client/modules/config.lua: -------------------------------------------------------------------------------- 1 | return { 2 | 3 | txtDict = 'byte_sprites', 4 | 5 | ---@comment multiplier on top of the scale 6 | keySpriteScaleModifier = 0.4, 7 | 8 | shapes = { 9 | 'circle', 10 | 'square', 11 | 'hex' 12 | }, 13 | 14 | keySprites = { 15 | 'eye', 16 | 'lock', 17 | 'unlock', 18 | 'radial', 19 | 'location', 20 | 'wheel', 21 | 'trunk', 22 | 'hood', 23 | 'person', 24 | 'basket', 25 | 'bank', 26 | 'dollar', 27 | 'garage', 28 | 'shirt', 29 | 'scissors', 30 | 'worm', 31 | 'hook', 32 | 'dot' 33 | }, 34 | 35 | 36 | ---@type SpriteParamBase 37 | default = { 38 | key = '', 39 | colour = {134, 133, 239, 255}, 40 | keyColour = {255, 255, 255, 255}, 41 | shape = '', 42 | scale = 0.05, 43 | distance = 10, 44 | }, 45 | 46 | spriteIndicatorDefault = true, 47 | 48 | spriteIndicator = { 49 | shape = 'circle', 50 | scale = 0.02, 51 | } 52 | } -------------------------------------------------------------------------------- /client/modules/sprite.lua: -------------------------------------------------------------------------------- 1 | local sprites = require "client.modules.sprites" 2 | local config = require "client.modules.config" 3 | local lib_points = lib.points 4 | 5 | local Sprite = {} 6 | Sprite.__index = Sprite 7 | 8 | local GetWorldPositionOfEntityBone, vec3, GetEntityCoords = GetWorldPositionOfEntityBone, vec3, GetEntityCoords 9 | 10 | local function baseConstructor(data) 11 | if not data then 12 | return 13 | end 14 | 15 | local default = config.default 16 | local shapes = config.shapes 17 | local keySprites = config.keySprites 18 | 19 | local contains = lib.table.contains 20 | 21 | local type = data.type or 'default' 22 | local key = data.key or default.key 23 | local keySprite = contains(keySprites, data.key) 24 | local colour = data.colour or default.colour 25 | local keyColour = data.keyColour or default.keyColour 26 | local shape = contains(shapes, data.shape) and data.shape or default.shape 27 | local scale = data.scale or default.scale 28 | local distance = data.distance or default.distance 29 | local spriteIndicator = data.spriteIndicator or config.spriteIndicatorDefault 30 | 31 | local coords, entity, boneId, onEnter, onExit, nearby, canInteract, offset in data 32 | local selectedSprite = contains(shapes, data.shape) and shape or false 33 | 34 | coords = type == 'entity' and GetEntityCoords(entity) or type == 'bone' and GetWorldPositionOfEntityBone(entity, boneId) or vec3(coords.x, coords.y, coords.z) 35 | offset = offset or vec3(0,0,0) 36 | 37 | local netId = NetworkGetEntityIsNetworked(entity) and VehToNet(entity) 38 | local spriteData = lib_points.new({ 39 | type = type, 40 | key = key, 41 | canInteract = canInteract, 42 | keySprite = keySprite, 43 | data = data.data, 44 | sprite = selectedSprite, 45 | scale = scale, 46 | colour = colour, 47 | keyColour = keyColour, 48 | distance = distance, 49 | spriteIndicator = spriteIndicator, 50 | coords = coords, 51 | 52 | entity = entity, 53 | netId = netId, 54 | boneId = boneId, 55 | 56 | offset = offset, 57 | 58 | onEnter = function(self) 59 | local id = self.id 60 | sprites.active[id] = self 61 | 62 | if sprites.entities[id] then 63 | sprites.entities[id] = nil 64 | end 65 | 66 | if onEnter then 67 | onEnter(self) 68 | end 69 | end, 70 | 71 | onExit = function(self) 72 | local id = self.id 73 | sprites.active[id] = nil 74 | sprites.entities[id] = (type == 'entity' or type == 'bone') and self or nil 75 | if onExit then 76 | onExit(self) 77 | end 78 | end, 79 | 80 | nearby = function(self) 81 | if type ~= 'default' then 82 | entity = netId and NetworkDoesEntityExistWithNetworkId(netId) and NetToVeh(netId) or entity 83 | coords = type == 'entity' and GetEntityCoords(entity) or type == 'bone' and GetWorldPositionOfEntityBone(entity, boneId) + offset or coords 84 | self.coords = coords 85 | end 86 | 87 | self.currentDistance = #(sprites.playerCoords - coords) 88 | if nearby then 89 | nearby(self) 90 | end 91 | end, 92 | 93 | updateTargetData = function(self, key, value) 94 | local sprite = sprites.active[self.id] 95 | if not sprite then return end 96 | if key == 'key' then 97 | sprite.keySprite = contains(keySprites, value) 98 | end 99 | sprite[key] = value 100 | end, 101 | 102 | removeSprite = function(self) 103 | local id = self.id 104 | if not id then return end 105 | 106 | self:remove() 107 | sprites.active[id] = nil 108 | if sprites.entities[id] then 109 | sprites.entities[id] = nil 110 | end 111 | end 112 | }) 113 | 114 | if #(GetEntityCoords(cache.ped) - coords) > distance then 115 | sprites.entities[spriteData.id] = (type == 'entity' or type == 'bone') and spriteData or nil 116 | end 117 | 118 | spriteData.resource = GetInvokingResource() 119 | 120 | spriteData.eventHandler = AddEventHandler('onResourceStop', function(resourceName) 121 | if resourceName ~= spriteData.resource then return end 122 | spriteData:removeSprite() 123 | RemoveEventHandler(spriteData.eventHandler) 124 | Wait(1000) 125 | spriteData = nil 126 | end) 127 | 128 | spriteData = setmetatable(spriteData, Sprite) 129 | 130 | return spriteData 131 | end 132 | 133 | function Sprite:getClosestSprite(onlyInvokingResource) 134 | for k, v in pairs(sprites.active) do 135 | if (not onlyInvokingResource or GetInvokingResource() == v.resource) and v.isClosest then 136 | return v 137 | end 138 | end 139 | end 140 | 141 | ---@param data DefinedSpriteParam 142 | function Sprite:defineSprite(data) 143 | data.type = "default" 144 | return baseConstructor(data) 145 | end 146 | 147 | ---@param data EntitySpriteParam 148 | function Sprite:defineSpriteOnEntity(data) 149 | data.type = "entity" 150 | return baseConstructor(data) 151 | end 152 | 153 | ---@param data BoneSpriteParam 154 | function Sprite:defineSpriteOnBone(data) 155 | data.type = "bone" 156 | return baseConstructor(data) 157 | end 158 | 159 | return Sprite -------------------------------------------------------------------------------- /client/modules/sprites.lua: -------------------------------------------------------------------------------- 1 | 2 | local sprites = {} 3 | 4 | sprites.playerCoords = vector3(0, 0, 0) 5 | 6 | ---@type table 7 | sprites.active = {} 8 | sprites.entities = {} 9 | 10 | return sprites -------------------------------------------------------------------------------- /client/modules/textures.lua: -------------------------------------------------------------------------------- 1 | 2 | local config = require "client.modules.config" 3 | 4 | local txd = CreateRuntimeTxd('byte_sprites') 5 | for i = 1, #config.shapes do 6 | local img = config.shapes[i] 7 | CreateRuntimeTextureFromImage(txd, img, 'assets/' .. img .. '.png') 8 | end 9 | 10 | for i = 1, #config.keySprites do 11 | local img = config.keySprites[i] 12 | CreateRuntimeTextureFromImage(txd, img, 'assets/' .. img .. '.png') 13 | end -------------------------------------------------------------------------------- /fxmanifest.lua: -------------------------------------------------------------------------------- 1 | fx_version 'cerulean' 2 | 3 | game "gta5" 4 | 5 | author "Byte Labs" 6 | version '1.0.1' 7 | description 'Byte Labs Sprites' 8 | repository 'https://github.com/Byte-Labs-Project/bl_sprites' 9 | 10 | lua54 'yes' 11 | 12 | shared_script { 13 | '@ox_lib/init.lua', 14 | } 15 | 16 | client_script { 17 | 'client/init.lua', 18 | } 19 | 20 | files { 21 | 'client/modules/*.lua', 22 | 'assets/*.png' 23 | } --------------------------------------------------------------------------------