├── LICENSE ├── README.md ├── lib ├── togaarc.lua └── togagrid.lua └── toga.tosc /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 | 2 | # toga 3 | TouchOSC grid and arc controller for monome norns 4 | 5 | ## Demo Video 6 | https://www.instagram.com/p/CS4JRtonRD7/ 7 | 8 | ## Instruction 9 | 1. Install **toga**: from maiden type: `;install https://github.com/wangpy/toga` 10 | 2. Edit script you want to use **toga** with (similar to [how to edit script to add midigrid support](https://norns.community/en/authors/jaggednz/midigrid#how-to-edit-a-script)) 11 | 1. Find occurence of "grid.connect()" in the script code and insert the following line above: 12 | ``` 13 | local grid = util.file_exists(_path.code.."toga") and include "toga/lib/togagrid" or grid 14 | ``` 15 | - If the script is already edited to support **midigrid**, you can add the support on midigrid library script file: add the line above to line 1 in **code/midigrid/lib/midigrid.lua**. When no midigrid-supported device is connected, toga grid will be initialized. 16 | 2. Find occurence of "grid.connect()" in the script code and insert the following line above: 17 | ``` 18 | local arc = util.file_exists(_path.code.."toga") and include "toga/lib/togaarc" or arc 19 | ``` 20 | 3. Select the edited script on norns to load 21 | 3. Download **toga.tosc** controller file and import to TouchOSC (new version, not working with Mk1). 22 | 4. Set up connections to norns: 23 | 1. Choose UDP 24 | 2. Look up norns IP address in **SYSTEM** -> **WIFI** and input to **Host** field 25 | 3. Input 10111 to **Send Port** 26 | 4. Input 8002 to **Receive Port** (any unused port number should work) 27 | 5. Run the TouchOSC controller (by clicking Play button). 28 | 6. Tap the upper-right green button to connect to norns. The green button should light up and the controller should be running. 29 | 7. (Optional) Adding default TouchOSC client address: 30 | 1. Open **code/toga/lib/togagrid.lua** file 31 | 2. Find the line `-- UNCOMMENT to add default touchosc client` 32 | 3. Remove leading `--` in the line below, and edit the IP address in the line. 33 | 4. Open **code/toga/lib/togaarc.lua** file and repeat the step 2 and 3. 34 | 5. Reload the script on norns. Now **toga** will automatically connect to the TouchOSC controller when the script is loaded. 35 | 36 | ## Forum 37 | https://llllllll.co/t/toga-touchosc-grid-and-arc-controller-for-monome-norns/47902 38 | -------------------------------------------------------------------------------- /lib/togaarc.lua: -------------------------------------------------------------------------------- 1 | local togaarc = { 2 | old_arc = nil, 3 | old_osc_in = nil, 4 | cols = 4, 5 | rows = 64, 6 | old_buffer = nil, 7 | new_buffer = nil, 8 | encoder_pos = nil, 9 | dest = {}, 10 | cleanup_done = false, 11 | key = nil, -- key event callback 12 | delta = nil -- delta event callback 13 | } 14 | 15 | function togaarc:connect() 16 | if _ENV.togaarc then return _ENV.togaarc end 17 | togaarc:init() 18 | _ENV.togaarc = togaarc 19 | return togaarc 20 | end 21 | 22 | function create_buffer(width,height) 23 | local new_buffer = {} 24 | 25 | for r = 1,width do 26 | new_buffer[r] = {} 27 | for c = 1,height do 28 | new_buffer[r][c] = 0 29 | end 30 | end 31 | 32 | return new_buffer 33 | end 34 | 35 | function togaarc:init() 36 | -- UNCOMMENT to add default touchosc client 37 | --table.insert(self.dest, {"192.168.0.123",8002}) 38 | 39 | self.encoder_pos = {} 40 | for i = 1,self.cols do 41 | self.encoder_pos[i] = -1 42 | end 43 | 44 | self.old_buffer = create_buffer(self.cols, self.rows) 45 | self.new_buffer = create_buffer(self.cols, self.rows) 46 | self:hook_osc_in() 47 | self:refresh(true) 48 | 49 | self.old_arc = arc.connect() 50 | if self.old_arc then 51 | self.old_arc.key = function(x, s) 52 | if togaarc.key then 53 | togaarc.key(x, s) 54 | end 55 | end 56 | self.old_arc.delta = function(x, delta) 57 | if togaarc.delta then 58 | togaarc.delta(x, delta) 59 | end 60 | end 61 | end 62 | 63 | self:send_connected(nil, true) 64 | end 65 | 66 | function string.starts(String,Start) 67 | return string.sub(String,1,string.len(Start))==Start 68 | end 69 | 70 | function togaarc:get_encoder_delta(i, pos) 71 | local delta = 0 72 | if self.encoder_pos[i] ~= -1 then 73 | delta = pos - self.encoder_pos[i] 74 | if delta > 0.5 then 75 | delta = 1 - delta 76 | elseif delta < -0.5 then 77 | delta = -1 - delta 78 | end 79 | end 80 | self.encoder_pos[i] = pos 81 | return delta 82 | end 83 | 84 | -- @static 85 | function togaarc.osc_in(path, args, from) 86 | local consumed = false 87 | if not togaarc.cleanup_done then 88 | local x, y, z 89 | --print("togaarc_osc_in", dump(path), dump(args), dump(from)) 90 | if string.starts(path, "/toga_connection") then 91 | print("togaarc connect!", togaarc.cleanup_done) 92 | local added = false 93 | for d, dest in pairs(togaarc.dest) do 94 | if dest[1] == from[1] and dest[2] == from[2] then 95 | added = true 96 | end 97 | end 98 | if not added then 99 | print("togaarc: add new toga client", from[1]..":"..from[2]) 100 | table.insert(togaarc.dest, from) 101 | togaarc:refresh(true, from) 102 | end 103 | -- echo back anyway to update connection button value 104 | togaarc:send_connected(from, true) 105 | -- do not consume the event so togagrid can also add the new touchosc client. 106 | elseif string.starts(path, "/togaarc/knob") then 107 | path = string.sub(path, 14) 108 | x = tonumber(string.sub(path,1,1)) 109 | if string.starts(string.sub(path,2), "/button1") then 110 | --print("togaarc button", x, args[1]) 111 | if togaarc.key then 112 | togaarc.key(x, args[1]) 113 | else 114 | print("arc.key is not defined!") 115 | end 116 | elseif string.starts(string.sub(path,2), "/encoder1") then 117 | local delta = togaarc:get_encoder_delta(x, args[1]) 118 | --print("togaarc encoder", x, args[1], delta) 119 | delta = tonumber(string.format("%.0f", delta*500)) 120 | if delta ~= 0 then 121 | if togaarc.delta then 122 | togaarc.delta(x, delta) 123 | else 124 | --print("arc.delta is not defined!") 125 | end 126 | end 127 | end 128 | consumed = true 129 | end 130 | end 131 | 132 | if not consumed then 133 | -- invoking original osc.event callback 134 | togaarc.old_osc_in(path, args, from) 135 | end 136 | end 137 | 138 | function togaarc:hook_osc_in() 139 | if self.old_osc_in ~= nil then return end 140 | --print("togaarc: hook old osc_in") 141 | self.old_osc_in = osc.event 142 | osc.event = togaarc.osc_in 143 | end 144 | 145 | -- @static 146 | function togaarc.cleanup() 147 | if togaarc.old_cleanup then 148 | togaarc.old_cleanup() 149 | end 150 | if not togaarc.cleanup_done then 151 | togaarc:send_connected(nil, false) 152 | togaarc.cleanup_done = true 153 | end 154 | end 155 | 156 | function togaarc:hook_cleanup() 157 | if self.old_cleanup ~= nil then return end 158 | --print("togaarc: hook old cleaup") 159 | self.old_cleanup = grid.cleanup 160 | grid.cleanup = togaarc.cleanup 161 | end 162 | 163 | function togaarc:all(z) 164 | for c = 1,self.cols do 165 | for r = 1,self.rows do 166 | self.new_buffer[c][r] = z 167 | end 168 | end 169 | 170 | if self.old_arc then 171 | self.old_arc:all(z) 172 | end 173 | end 174 | 175 | function togaarc:segment(ring, from, to, level) 176 | -- from arc:segment() 177 | local tau = math.pi * 2 178 | 179 | local function overlap(a, b, c, d) 180 | if a > b then 181 | return overlap(a, tau, c, d) + overlap(0, b, c, d) 182 | elseif c > d then 183 | return overlap(a, b, c, tau) + overlap(a, b, 0, d) 184 | else 185 | return math.max(0, math.min(b, d) - math.max(a, c)) 186 | end 187 | end 188 | 189 | local function overlap_segments(a, b, c, d) 190 | a = a % tau 191 | b = b % tau 192 | c = c % tau 193 | d = d % tau 194 | 195 | return overlap(a, b, c, d) 196 | end 197 | 198 | local m = {} 199 | local sl = tau / 64 200 | 201 | for i=1, 64 do 202 | local sa = tau / 64 * (i - 1) 203 | local sb = tau / 64 * i 204 | 205 | local o = overlap_segments(from, to, sa, sb) 206 | m[i] = util.round(o / sl * level) 207 | self:led(ring, i, m[i]) 208 | end 209 | 210 | -- we call old_arc:led() in togaarc:led() so no need to call old_arc:segment() here 211 | end 212 | 213 | function togaarc:led(x, y, z) 214 | if x > self.cols or y > self.rows then return end 215 | self.new_buffer[x][y] = z 216 | 217 | if self.old_arc then 218 | self.old_arc:led(x, y, z) 219 | end 220 | end 221 | 222 | function togaarc:refresh(force_refresh, target_dest) 223 | for c = 1,self.cols do 224 | for r = 1,self.rows do 225 | if force_refresh or self.new_buffer[c][r] ~= self.old_buffer[c][r] then 226 | self.old_buffer[c][r] = self.new_buffer[c][r] 227 | self:update_led(c, r, target_dest) 228 | end 229 | end 230 | end 231 | 232 | if self.old_arc then 233 | self.old_arc:refresh() 234 | end 235 | end 236 | 237 | function togaarc:cleanup() 238 | if self.old_arc then 239 | self.old_arc:cleanup() 240 | end 241 | self.cleanup_done = true 242 | end 243 | 244 | function togaarc:update_led(c, r, target_dest) 245 | local z = self.new_buffer[c][r] 246 | for g = 1,2 do 247 | local addr = string.format("/togaarc/knob%d/group%d/button%d", c, g, r) 248 | --print("togaarc osc.send", addr, z) 249 | for d, dest in pairs(self.dest) do 250 | if target_dest and (target_dest[1] ~= dest[1] or target_dest[2] ~= dest[2]) then 251 | -- do nothing 252 | else 253 | osc.send(dest, addr, {z / 15.0}) 254 | end 255 | end 256 | end 257 | end 258 | 259 | function togaarc:send_connected(target_dest, connected) 260 | for d, dest in pairs(self.dest) do 261 | if target_dest and (target_dest[1] ~= dest[1] or target_dest[2] ~= dest[2]) then 262 | -- do nothing 263 | else 264 | osc.send(dest, "/toga_connection", {connected and 1.0 or 0.0}) 265 | end 266 | end 267 | end 268 | 269 | return togaarc -------------------------------------------------------------------------------- /lib/togagrid.lua: -------------------------------------------------------------------------------- 1 | -- UNCOMMENT TO add midigrid plugin 2 | --local grid = util.file_exists(_path.code.."midigrid") and include "midigrid/lib/mg_128" or grid 3 | 4 | local togagrid = { 5 | device = nil, -- needed by cheat codes 2 6 | cols = 16, 7 | rows = 8, 8 | old_buffer = nil, 9 | new_buffer = nil, 10 | dest = {}, 11 | cleanup_done = false, 12 | old_grid = nil, 13 | old_osc_in = nil, 14 | old_cleanup = nil, 15 | key = nil -- key event callback 16 | } 17 | 18 | function togagrid:connect() 19 | if _ENV.togagrid then return _ENV.togagrid end 20 | togagrid:init() 21 | _ENV.togagrid = togagrid 22 | return togagrid 23 | end 24 | 25 | function create_buffer(width,height) 26 | local new_buffer = {} 27 | 28 | for r = 1,width do 29 | new_buffer[r] = {} 30 | for c = 1,height do 31 | new_buffer[r][c] = 0 32 | end 33 | end 34 | 35 | return new_buffer 36 | end 37 | 38 | function togagrid:init() 39 | -- UNCOMMENT to add default touchosc client 40 | --table.insert(self.dest, {"192.168.0.123",8002}) 41 | 42 | self.device = self 43 | self.old_buffer = create_buffer(self.cols, self.rows) 44 | self.new_buffer = create_buffer(self.cols, self.rows) 45 | self:hook_osc_in() 46 | self:hook_cleanup() 47 | self:refresh(true) 48 | 49 | self.old_grid = grid.connect() 50 | if self.old_grid then 51 | self.old_grid.key = function(x, y, z) 52 | if togagrid.key then 53 | togagrid.key(x, y, z) 54 | else 55 | --print("grid.key is not defined!") 56 | end 57 | end 58 | end 59 | 60 | self:send_connected(nil, true) 61 | end 62 | 63 | function string.starts(String,Start) 64 | return string.sub(String,1,string.len(Start))==Start 65 | end 66 | 67 | -- @static 68 | function togagrid.osc_in(path, args, from) 69 | local consumed = false 70 | if not togagrid.cleanup_done then 71 | local x, y, z, i 72 | --print("togagrid_osc_in", dump(path), dump(args), dump(from)) 73 | if string.starts(path, "/toga_connection") then 74 | print("togagrid connect!") 75 | local added = false 76 | for d, dest in pairs(togagrid.dest) do 77 | if dest[1] == from[1] and dest[2] == from[2] then 78 | added = true 79 | end 80 | end 81 | if not added then 82 | print("togagrid: add new toga client", from[1]..":"..from[2]) 83 | table.insert(togagrid.dest, from) 84 | togagrid:refresh(true, from) 85 | end 86 | -- echo back anyway to update connection button value 87 | togagrid:send_connected(from, true) 88 | -- do not consume the event so togaarc can also add the new touchosc client. 89 | elseif string.starts(path, "/togagrid/") then 90 | i = tonumber(string.sub(path,11)) 91 | x = ((i-1) % 16) + 1 92 | y = (i-1) // 16 + 1 93 | z = args[1] // 1 94 | --print("togagrid_osc_in togagrid", i, x, y, z) 95 | if togagrid.key then 96 | togagrid.key(x, y, z) 97 | end 98 | if z == 0 then 99 | -- send button status to touchosc again after release event, which erased button value 100 | togagrid:update_led(x, y) 101 | end 102 | consumed = true 103 | end 104 | end 105 | 106 | if not consumed then 107 | -- invoking original osc.event callback 108 | togagrid.old_osc_in(path, args, from) 109 | end 110 | end 111 | 112 | function togagrid:hook_osc_in() 113 | if self.old_osc_in ~= nil then return end 114 | --print("togagrid: hook old osc_in") 115 | self.old_osc_in = osc.event 116 | osc.event = togagrid.osc_in 117 | end 118 | 119 | -- @static 120 | function togagrid.cleanup() 121 | if togagrid.old_cleanup then 122 | togagrid.old_cleanup() 123 | end 124 | if not togagrid.cleanup_done then 125 | togagrid:send_connected(nil, false) 126 | togagrid.cleanup_done = true 127 | end 128 | end 129 | 130 | function togagrid:hook_cleanup() 131 | if self.old_cleanup ~= nil then return end 132 | --print("togagrid: hook old cleaup") 133 | self.old_cleanup = grid.cleanup 134 | grid.cleanup = togagrid.cleanup 135 | end 136 | 137 | function togagrid:rotation(val) 138 | if self.old_grid then 139 | self.old_grid:rotation(val) 140 | end 141 | end 142 | 143 | function togagrid:all(z) 144 | for r = 1,self.rows do 145 | for c = 1,self.cols do 146 | self.new_buffer[c][r] = z 147 | end 148 | end 149 | 150 | if self.old_grid then 151 | self.old_grid:all(z) 152 | end 153 | end 154 | 155 | function togagrid:led(x, y, z) 156 | if x > self.cols or y > self.rows then return end 157 | self.new_buffer[x][y] = z 158 | 159 | 160 | if self.old_grid then 161 | self.old_grid:led(x, y, z) 162 | end 163 | end 164 | 165 | function togagrid:refresh(force_refresh, target_dest) 166 | for r = 1,self.rows do 167 | for c = 1,self.cols do 168 | if force_refresh or self.new_buffer[c][r] ~= self.old_buffer[c][r] then 169 | self.old_buffer[c][r] = self.new_buffer[c][r] 170 | self:update_led(c, r, target_dest) 171 | end 172 | end 173 | end 174 | 175 | if self.old_grid then 176 | self.old_grid:refresh() 177 | end 178 | end 179 | 180 | function togagrid:intensity(i) 181 | if self.old_grid then 182 | self.old_grid:intensity(i) 183 | end 184 | end 185 | 186 | function transform_to_button_x(z) 187 | local linear = z / 15.0 188 | return 0.9 * math.pow(linear, 1.5) 189 | end 190 | 191 | function togagrid:update_led(c, r, target_dest) 192 | local z = self.new_buffer[c][r] 193 | local i = c + (r-1) * self.cols 194 | local addr = string.format("/togagrid/%d", i) 195 | --print("togagrid osc.send", addr, z) 196 | for d, dest in pairs(self.dest) do 197 | if target_dest and (target_dest[1] ~= dest[1] or target_dest[2] ~= dest[2]) then 198 | -- do nothing 199 | else 200 | osc.send(dest, addr, {z / 15.0}) 201 | end 202 | end 203 | end 204 | 205 | function togagrid:send_connected(target_dest, connected) 206 | for d, dest in pairs(self.dest) do 207 | if target_dest and (target_dest[1] ~= dest[1] or target_dest[2] ~= dest[2]) then 208 | -- do nothing 209 | else 210 | osc.send(dest, "/toga_connection", {connected and 1.0 or 0.0}) 211 | end 212 | end 213 | end 214 | 215 | return togagrid -------------------------------------------------------------------------------- /toga.tosc: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/wangpy/toga/b42898d15c8148163fcc95b469edff78436b37b8/toga.tosc --------------------------------------------------------------------------------