diff --git a/autobahn/sounds/autobahn_motor.ogg b/autobahn/sounds/autobahn_motor.ogg index 498304f..53b1614 100644 Binary files a/autobahn/sounds/autobahn_motor.ogg and b/autobahn/sounds/autobahn_motor.ogg differ diff --git a/doclib/LICENSE.txt b/doclib/LICENSE.txt new file mode 100644 index 0000000..3e42177 --- /dev/null +++ b/doclib/LICENSE.txt @@ -0,0 +1,669 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + A library to generate ingame manuals based on markdown files. + Copyright (C) 2023 Joachim Stolberg + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +. + +============================================================================== + +Joachim Stolberg, CC BY-SA 3.0: + +* doclib_book.png +* doclib_book_inv.png +* doclib_demo_img*.png diff --git a/doclib/README.md b/doclib/README.md new file mode 100644 index 0000000..7d78645 --- /dev/null +++ b/doclib/README.md @@ -0,0 +1,118 @@ +DocLib [doclib] +=============== + +**A library to generate ingame manuals based on markdown files.** + +Browse on: [GitHub](https://github.com/joe7575/doclib) + +Download: [GitHub](https://github.com/joe7575/doclib/archive/main.zip) + +![DocLib](https://github.com/joe7575/doclib/blob/main/screenshot.png) + + +### Introduction + +DocLib is used to generate a manual as ingame documentation. +The manual content is generated based on markdown files. + +An advantage of this solution is the dual use of the documentation: + +- A markdown file as web solution e. g. on GitHub +- A book as ingame manual + +To generate a manual for your mod: + +- Create your documentation as markdown file +- Copy the python script `markdown_to_lua.py` to your mod folder +- Add your markdown file to the python script (the last few lines) +- Install mistune with `pip install mistune==0.8.4` +- Run the script with `python markdown_to_lua.py` +- Implement the book node according to `node.lua` + + +### Supported Markdown Markups + +- Heading +- List +- Code block + +In addition DocLib supports image links for the ingame manual: + +- for node images: `[doclib:manual|image]` +- for PNG images: `[doclib_book_inv.png|image]` + +See examples in `manual_EN.md`. + + +### Construction Plans + +This is a feature, mainly used by the mod techage to show construction plans of +multi-block machines. But it can be used for any other mod, too. + +![Plan](https://github.com/joe7575/doclib/blob/main/construction_plan.png) + +A construction plan is a map with up to 12 * 10 fields. +Each field can contain a node/item, text, or an image. + +The arrangement is defined via a Lua table. + +- Unused field elements are set to `false` +- For a text field (red mark) a table like `{"text", "Pointless Demo"}` is used +- For an item field (yellow mark) a table like `{"item", "doclib_demo_img2.png", "Tooltip 1"}` is used. + The third value is a tooltip. It can be a string, a node name, or `nil` for no tooltip. +- For an image field (blue mark) a table like `{"img", "doclib_book_inv.png", "2,2"}` is used. + The third value is the image size in fields (width x height). + +This is an example of a map with 12 * 10 fields from the demo code in `node.lua`: + +```lua + +local ITEM1 = {"item", "doclib_demo_img1.png"} +local ITEM2 = {"item", "doclib_demo_img2.png", "Tooltip 1"} +local ITEM3 = {"item", "doclib_demo_img3.png", "Tooltip 2"} +local ITEM4 = {"item", "doclib_demo_img4.png", "Tooltip 3"} +local ITEM5 = {"item", "doclib_book_inv.png", "doclib:manual"} +local ITEM6 = {"item", "doclib:manual", "doclib:manual"} +local IMG_1 = {"img", "doclib_book_inv.png", "2,2"} +local TEXT1 = {"text", "Top view"} +local TEXT2 = {"text", "Pointless Demo"} +local TEXT3 = {"text", "End"} + +local plan1 = { + {TEXT2, false, false, false, false, false, false, false, false, false, false, ITEM4}, + {false, false, false, TEXT1, false, false, false, false, IMG_1, false, false, false}, + {false, false, false, false, false, false, false, false, false, false, false, false}, + {false, false, false, false, ITEM1, false, false, false, false, false, false, false}, + {false, false, false, ITEM4, ITEM5, ITEM2, false, false, false, false, false, false}, + {false, false, false, false, ITEM3, false, false, false, false, false, false, false}, + {false, false, false, false, ITEM6, false, false, false, false, false, false, false}, + {false, false, false, false, false, false, false, false, false, false, false, false}, + {false, false, false, false, false, false, false, false, false, false, false, false}, + {TEXT3, false, false, false, false, false, false, false, false, false, false, ITEM4}, +} + +doclib.add_manual_plan("doclib", "EN", "demo1", plan1) +``` + +With `doclib.add_manual_plan` the plan is stored under the name "demo1". + + +### License + +Copyright (C) 2023 Joachim Stolberg + +Code: Licensed under the GNU AGPL version 3. See LICENSE.txt +Textures: CC BY-SA 3.0 + + +### Dependencies + +none + + +### History + +- 2023-07-30 V1.00 * First commit + + + diff --git a/doclib/api.lua b/doclib/api.lua new file mode 100644 index 0000000..1e736fa --- /dev/null +++ b/doclib/api.lua @@ -0,0 +1,57 @@ +--[[ + + DocLib + ====== + + Copyright (C) 2023 Joachim Stolberg + + AGPL v3 + See LICENSE.txt for more information + + A library to generate ingame manuals based on markdown files. + +]]-- + +function doclib.create_manual(mod, language, settings) + doclib.manual = doclib.manual or {} + doclib.manual[mod] = doclib.manual[mod] or {} + doclib.manual[mod][language] = doclib.manual[mod][language] or {settings = settings, + content = { + aTitles = {}, + aTexts = {}, + aImages = {}, + aPlans = {}, + kvImages = {}, + kvPlans = {}, + } + } +end + +function doclib.add_to_manual(mod, language, content) + local manual = doclib.manual[mod][language] + + for _, item in ipairs(content.titles) do + table.insert(manual.content.aTitles, item) + end + for _, item in ipairs(content.texts) do + table.insert(manual.content.aTexts, item) + end + for _, item in ipairs(content.images) do + table.insert(manual.content.aImages, item) + end + for _, item in ipairs(content.plans) do + table.insert(manual.content.aPlans, item) + end +end + +-- Replace image tag from the markdown file with real PNG file name or node name +function doclib.add_manual_image(mod, language, name, image) + local manual = doclib.manual[mod][language] + manual.content.kvImages[name] = image +end + +-- Replace plan tag from the markdown file with real Lua plan table +function doclib.add_manual_plan(mod, language, name, plan) + local manual = doclib.manual[mod][language] + manual.content.kvPlans[name] = plan +end diff --git a/doclib/construction_plan.png b/doclib/construction_plan.png new file mode 100644 index 0000000..542daad Binary files /dev/null and b/doclib/construction_plan.png differ diff --git a/doclib/formspec.lua b/doclib/formspec.lua new file mode 100644 index 0000000..3eeb139 --- /dev/null +++ b/doclib/formspec.lua @@ -0,0 +1,155 @@ +--[[ + + DocLib + ====== + + Copyright (C) 2023 Joachim Stolberg + + AGPL v3 + See LICENSE.txt for more information + + A library to generate ingame manuals based on markdown files. + +]]-- + +-- for lazy programmers +local S = doclib.S +local P2S = function(pos) if pos then return minetest.pos_to_string(pos) end end +local S2P = minetest.string_to_pos +local M = minetest.get_meta + +local function get_text(text, x_offs, y_offs) + if text == "top_view" then + return "label[" .. x_offs .. "," .. y_offs .. ";" .. S("Top view") .. "]" + elseif text == "side_view" then + return "label[" .. x_offs .. "," .. y_offs .. ";" .. S("Side view") .. "]" + elseif text == "sectional_view" then + return "label[" .. x_offs .. "," .. y_offs .. ";" .. S("Sectional view") .. "]" + end + return "label[" .. x_offs .. "," .. y_offs .. ";" .. minetest.formspec_escape(text) .. "]" +end + +local function get_image(image, size, x_offs, y_offs) + size = size or "2.2,2.2" + return "image[" .. x_offs .. "," .. y_offs .. ";" .. size .. ";" .. image .. "]" +end + +local function get_item(item, tooltip, x_offs, y_offs) + local ndef = minetest.registered_nodes[tooltip] + if ndef and ndef.description then + tooltip = minetest.formspec_escape(ndef.description) + else + tooltip = minetest.formspec_escape(tooltip) or "" + end + tooltip = "tooltip[" .. x_offs .. "," .. y_offs .. ";1,1;" .. tooltip .. ";#0C3D32;#FFFFFF]" + + if string.find(item, ":") then + return "item_image[" .. x_offs .. "," .. y_offs .. ";1,1;" .. item .. "]", tooltip + else + return "image[" .. x_offs .. "," .. y_offs .. ";1,1;" .. item .. "]", tooltip + end +end + +local function get_item_data(tbl, x_offs, y_offs) + if type(tbl) == "table" then + local ttype = tbl[1] + if ttype == "item" then + return get_item(tbl[2], tbl[3], x_offs, y_offs) + elseif ttype == "img" then + return get_image(tbl[2], tbl[3], x_offs, y_offs), "" + elseif ttype == "text" then + return get_text(tbl[2], x_offs, y_offs), "" + else + return "", "" + end + end +end + +-- formspec images +local function plan(images) + local tbl = {} + if images == "none" then return "label[1,3;"..S("No plan available") .."]" end + for y=1,#images do + for x=1,#images[1] do + local item = images[y][x] or false + if item ~= false then + local x_offs, y_offs = (x-1) * 0.9, (y-1) * 0.9 + 0.8 + local image, tooltip = get_item_data(item, x_offs, y_offs) + tbl[#tbl+1] = image + if tooltip then + tbl[#tbl+1] = tooltip + end + end + end + end + return table.concat(tbl) +end + +local function formspec_help(meta, manual) + local idx = meta:get_int("doclib_index") + local box = "box[9.4,1.5;1.15,1.25;#BBBBBB]" + local bttn, symbol + + if manual.content.aPlans[idx] ~= "" then + bttn = "button[9.6,1;1,1;plan;" .. S("Plan") .. "]" + elseif manual.content.aImages[idx] ~= "" then + local name = manual.content.aImages[idx] or "" + local item = manual.content.kvImages[name] or name + if string.find(item, ":") then + bttn = box .. "item_image[9.45,1.55;1.3,1.3;" .. item .. "]" + else + bttn = "image[9.4,1.5;1.4,1.4;" .. item .. "]" + end + else + bttn = box + end + + if string.find(manual.settings.symbol_item, ":") then + symbol = "item_image[9.6,0;1,1;" .. manual.settings.symbol_item .. "]" + else + symbol = "image[9.6,0;1,1;" .. manual.settings.symbol_item .. "]" + end + + return "size[11,10]" .. + symbol .. + "tablecolumns[tree,width=1;text,width=10,align=inline]" .. + "tableoptions[opendepth=1]" .. + "table[0.1,0;9,5;page;" .. table.concat(manual.content.aTitles, ",") .. ";" .. idx .. "]" .. + bttn .. + "box[0,5.75;10.775,4.45;#000000]" .. + "style_type[textarea;textcolor=#FFFFFF]" .. + "textarea[0.3,5.7;11,5.3;;;" .. (manual.content.aTexts[idx] or "") .. "]" +end + +local function formspec_plan(meta, manual) + local idx = meta:get_int("doclib_index") + local name = manual.content.aPlans[idx] or "none" + local tbl = manual.content.kvPlans[name] or {} + local titel = string.sub(manual.content.aTitles[idx] or "", 3) or "unknown" + + return "size[11,10]" .. + "label[0,0;"..titel..":]" .. + "button[10,0;1,0.8;back;<<]" .. + plan(tbl) +end + +function doclib.formspec(pos, mod, language, fields) + local manual = doclib.manual[mod][language] + local meta = M(pos) + + if not fields then + meta:set_int("doclib_index", 1) + return formspec_help(meta, manual) + elseif fields.plan then + return formspec_plan(meta, manual) + elseif fields.back then + return formspec_help(meta, manual) + elseif fields.page then + local evt = minetest.explode_table_event(fields.page) + if evt.type == "CHG" then + local idx = tonumber(evt.row) + meta:set_int("doclib_index", idx) + end + end + return formspec_help(meta, manual) +end diff --git a/doclib/init.lua b/doclib/init.lua new file mode 100644 index 0000000..78f8380 --- /dev/null +++ b/doclib/init.lua @@ -0,0 +1,27 @@ +--[[ + + DocLib + ====== + + Copyright (C) 2023 Joachim Stolberg + + AGPL v3 + See LICENSE.txt for more information + + A library to generate ingame manuals based on markdown files. + +]]-- + +doclib = {} + +-- Version for compatibility checks, see readme.md/history +doclib.version = 1.0 + +-- Load support for I18n. +doclib.S = minetest.get_translator("doclib") + +local MP = minetest.get_modpath("doclib") + +dofile(MP.."/formspec.lua") +dofile(MP.."/api.lua") +--dofile(MP.."/node.lua") -- only for testing purposes diff --git a/doclib/manual_EN.lua b/doclib/manual_EN.lua new file mode 100644 index 0000000..d99cb41 --- /dev/null +++ b/doclib/manual_EN.lua @@ -0,0 +1,76 @@ +return { + titles = { + "1,Heading 1", + "2,Heading 2", + "3,Heading 3", + "2,Text Block", + "2,Lists", + "2,Code", + "2,Construction plan", + }, + texts = { + "This is some demo text to demonstrate the generation of ingame manuals from\n".. + "markdown files.\n".. + "To open sub-chapters\\, click on the plus sign.\n".. + "\n".. + "\n".. + "\n", + "This is a second-level heading.\n".. + "\n".. + "\n".. + "\n", + "This is a third-level heading.\n".. + "\n".. + "\n".. + "\n", + "Lorem ipsum dolor sit amet\\, consetetur sadipscing elitr\\, sed diam nonumy\n".. + "eirmod tempor invidunt ut labore et dolore magna aliquyam erat\\, sed diam\n".. + "voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet\n".. + "clita kasd gubergren\\, no sea takimata sanctus est Lorem ipsum dolor sit\n".. + "amet. Lorem ipsum dolor sit amet\\, consetetur sadipscing elitr\\, sed diam\n".. + "nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat\\,\n".. + "sed diam voluptua.\n".. + "\n".. + "\n".. + "\n", + "This is a list:\n".. + "\n".. + " - List\n".. + " - List\n".. + " - List\n".. + "\n".. + "\n".. + "\n", + "This is a code block:\n".. + "\n".. + " doclib.create_manual(\"doclib\"\\, \"EN\"\\, settings)\n".. + " local content = dofile(MP..\"/manual_EN.lua\") \n".. + " doclib.add_to_manual(\"doclib\"\\, \"EN\"\\, content)\n".. + "\n".. + "\n".. + "\n", + "This is an example\\, how to make plans/block diagrams.\n".. + "Click an the button on the right.\n".. + "\n".. + "\n".. + "\n", + }, + images = { + "doclib_demo_img1.png", + "doclib_demo_img2.png", + "doclib_demo_img3.png", + "doclib:manual", + "default:dirt", + "doclib_demo_img4.png", + "", + }, + plans = { + "", + "", + "", + "", + "", + "", + "demo1", + } +} \ No newline at end of file diff --git a/doclib/manual_EN.md b/doclib/manual_EN.md new file mode 100644 index 0000000..5d03c73 --- /dev/null +++ b/doclib/manual_EN.md @@ -0,0 +1,62 @@ +# Heading 1 + +This is some demo text to demonstrate the generation of ingame manuals from +markdown files. +To open sub-chapters, click on the plus sign. + +[doclib_demo_img1.png|image] + +## Heading 2 + +This is a second-level heading. + +[doclib_demo_img2.png|image] + +### Heading 3 + +This is a third-level heading. + +[doclib_demo_img3.png|image] + +## Text Block + +Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy +eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam +voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet +clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit +amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam +nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, +sed diam voluptua. + +[doclib:manual|image] + +## Lists + +This is a list: + +- List +- List +- List + +[default:dirt|image] + +## Code + +This is a code block: + +``` +doclib.create_manual("doclib", "EN", settings) +local content = dofile(MP.."/manual_EN.lua") +doclib.add_to_manual("doclib", "EN", content) +``` + +[doclib_demo_img4.png|image] + + +## Construction plan + +This is an example, how to make plans/block diagrams. +Click an the button on the right. + +[demo1|plan] + diff --git a/doclib/markdown_to_lua.py b/doclib/markdown_to_lua.py new file mode 100644 index 0000000..ddc2761 --- /dev/null +++ b/doclib/markdown_to_lua.py @@ -0,0 +1,203 @@ +#!/usr/bin/env python +# -*- coding: utf-8 -*- + +# install mistune v0.8.4 with: pip install mistune==0.8.4 + +import re +import mistune + +assert(mistune.__version__ == "0.8.4") + +__version__ = "1.0" + +class WikiLinkInlineLexer(mistune.InlineLexer): + def enable_wiki_link(self): + # add wiki_link rules + self.rules.wiki_link = re.compile( + r'\[' # [ + r'([\s\S]+?\|[\s\S]+?)' # name| img-type + r'\](?!\])' # ] + ) + + # Add wiki_link parser to default rules + # you can insert it some place you like + # but place matters, maybe 3 is not good + self.default_rules.insert(3, 'wiki_link') + + def output_wiki_link(self, m): + text = m.group(1) + name, itype = text.split('|') + # you can create an custom render + # you can also return the html if you like + return self.renderer.wiki_link(name, itype) + +class MarkdownToLua(mistune.Renderer): + def __init__(self, *args, **kwargs): + mistune.Renderer.__init__(self, *args, **kwargs) + self.item_name = "" + self.plan_table = "" + self.is_first_header = True + self.text_chunck = [] + self.lTitle = [] + self.lText = [] + self.lItemName = [] + self.lPlanTable = [] + print("Markdown-to-Lua v%s" % __version__) + + def m2l_formspec_escape(self, text): + text = text.replace("\\", "") + text = text.replace("[", "\\\\[") + text = text.replace("]", "\\\\]") + text = text.replace(";", "\\\\;") + text = text.replace(",", "\\\\,") + text = text.replace('"', '\\"') + text = text.replace('\n', '\\n') + return text + + def m2l_add_last_paragraph(self): + """ + Used to add a text block before the next header or at the end of the document + """ + self.lText.append(self.text_chunck) + self.text_chunck = [] + self.lItemName.append(self.item_name) + self.item_name = "" + self.lPlanTable.append(self.plan_table) + self.plan_table = "" + ## + ## Block Level + ## + def block_code(self, code, lang): + text = self.m2l_formspec_escape(code.strip()) + lines = text.split("\\n") + lines = [" " + item for item in lines] + self.text_chunck.extend(lines) + self.text_chunck.append("") + return "" + + def header(self, text, level, raw=None): + if not self.is_first_header: + self.m2l_add_last_paragraph() + self.is_first_header = False + self.lTitle.append("%u,%s" % (level, self.m2l_formspec_escape(text))) + return "" + + def hrule(self): + self.text_chunck.append("\n----------------------------------------------------\n") + return "" + + def paragraph(self, text): + lines = text.split("\\n") + [""] + self.text_chunck.extend(lines) + return "" + + def list(self, body, ordered=True): + lines = body.split("\n") + self.text_chunck.extend(lines) + return "" + + def list_item(self, text): + return " - %s\n" % text.strip() + ## + ## Span Level + ## + def emphasis(self, text): + return "*%s*" % self.m2l_formspec_escape(text) + + def double_emphasis(self, text): + return "*%s*" % self.m2l_formspec_escape(text) + + def codespan(self, text): + return "'%s'" % self.m2l_formspec_escape(text) + + def text(self, text): + return self.m2l_formspec_escape(text) + + def link(self, link, title, content): + """ + Used for plans and images: + [myimage](/image/) + [myplan](/plan/) + """ + if link == "/image/": + self.item_name = content + elif link == "/plan/": + self.plan_table = content + return content + + def wiki_link(self, name, itype): + """ + Used for plans and images: + [myimage|image] + [myplan|plan] + """ + if itype == "image": + self.item_name = name + elif itype == "plan": + self.plan_table = name + return "" + + def autolink(self, link, is_email=False): + return link + + def linebreak(self): + return "\\n" + + def newline(self): + return "\\n" + + def inline_html(self, text): + #print(text) + pass + + def parse_md_file(self, src_name): + print(" - Read MD file '%s'" % src_name) + inline = WikiLinkInlineLexer(self) + # enable the feature + inline.enable_wiki_link() + md = mistune.Markdown(renderer=self, inline=inline) + md.renderer.src_name = src_name + md.render(open(src_name, 'r').read()) + md.renderer.m2l_add_last_paragraph() + + def lua_table(self, key, lData): + lOut = [] + lOut.append(" %s = {" % key) + for line in lData: + lOut.append(' "%s",' % line) + lOut.append(" }") + return "\n".join(lOut) + + def lua_text_table(self, key, lData): + lOut = [] + lOut.append(" %s = {" % key) + for lines in lData: + for line in lines[:-1]: + line = line.replace('
', '\\n') + lOut.append(' "%s\\n"..' % line) + if len(lines) > 0: + lOut.append(' "%s\\n",' % lines[-1]) + else: + lOut.append(' "",') + lOut.append(" }") + return "\n".join(lOut) + + def gen_lua_file(self, dest_name): + print(" - Write Lua file '%s'" % dest_name) + lOut = [] + s = ",\n".join([self.lua_table("titles", self.lTitle), + self.lua_text_table("texts", self.lText), + self.lua_table("images", self.lItemName), + self.lua_table("plans", self.lPlanTable)]) + open(dest_name, "w").write("return {\n%s\n}" % s) + print("done.") + +m2l = MarkdownToLua() +m2l.parse_md_file("./manual_EN.md") +m2l.gen_lua_file("./manual_EN.lua") + +#m2l = MarkdownToLua() +#m2l.parse_md_file("./manual_DE.md") +#m2l.gen_lua_file("./manual_DE.lua") + +# You can add further languages diff --git a/doclib/mod.conf b/doclib/mod.conf new file mode 100644 index 0000000..04a0cc9 --- /dev/null +++ b/doclib/mod.conf @@ -0,0 +1,3 @@ +name = doclib +description = A library to generate ingame manuals based on markdown files. +author = joe7575 diff --git a/doclib/node.lua b/doclib/node.lua new file mode 100644 index 0000000..e887407 --- /dev/null +++ b/doclib/node.lua @@ -0,0 +1,100 @@ +--[[ + + DocLib + ====== + + Copyright (C) 2023 Joachim Stolberg + + AGPL v3 + See LICENSE.txt for more information + + A library to generate ingame manuals based on markdown files. + +]]-- + +-- for lazy programmers +local S = doclib.S +local P2S = function(pos) if pos then return minetest.pos_to_string(pos) end end +local S2P = minetest.string_to_pos +local M = minetest.get_meta +local MP = minetest.get_modpath("doclib") + +local settings = { + symbol_item = "doclib_book_inv.png", -- can be a PGN file or a item, like: "mod:name" +} + +doclib.create_manual("doclib", "EN", settings) +local content = dofile(MP.."/manual_EN.lua") +doclib.add_to_manual("doclib", "EN", content) + +minetest.register_node("doclib:manual", { + description = "DocLib Manual (EN)", + inventory_image = "doclib_book_inv.png", + tiles = { + -- up, down, right, left, back, front + "doclib_book.png", + "doclib_book.png", + "doclib_book.png^[transformR270", + "doclib_book.png^[transformR90", + "doclib_book.png^[transformR180", + "doclib_book.png" + }, + drawtype = "nodebox", + node_box = { + type = "fixed", + fixed = { + { -8/32, -16/32, -12/32, 8/32, -12/32, 12/32}, + }, + }, + + after_place_node = function(pos, placer, itemstack) + M(pos):set_string("infotext", "DocLib Manual (EN)") + M(pos):set_string("formspec", doclib.formspec(pos, "doclib", "EN")) + end, + + on_receive_fields = function(pos, formname, fields, player) + local player_name = player:get_player_name() + if minetest.is_protected(pos, player_name) then + return + end + M(pos):set_string("formspec", doclib.formspec(pos, "doclib", "EN", fields)) + end, + + paramtype = "light", + sunlight_propagates = true, + paramtype2 = "facedir", + use_texture_alpha = "clip", + is_ground_content = false, + groups = {choppy = 2, oddly_breakable_by_hand = 2, flammable = 2}, +}) + + +-- +-- Demo plan 1 +-- +local ITEM1 = {"item", "doclib_demo_img1.png"} +local ITEM2 = {"item", "doclib_demo_img2.png", "Tooltip 1"} +local ITEM3 = {"item", "doclib_demo_img3.png", "Tooltip 2"} +local ITEM4 = {"item", "doclib_demo_img4.png", "Tooltip 3"} +local ITEM5 = {"item", "doclib_book_inv.png", "doclib:manual"} +local ITEM6 = {"item", "doclib:manual", "doclib:manual"} +local IMG_1 = {"img", "doclib_book_inv.png", "2,2"} +local TEXT1 = {"text", "Top view"} +local TEXT2 = {"text", "Pointless Demo"} +local TEXT3 = {"text", "End"} + +-- The maximum plan size is 12 fields wide and 10 fields high +local plan1 = { + {TEXT2, false, false, false, false, false, false, false, false, false, false, ITEM4}, + {false, false, false, TEXT1, false, false, false, false, IMG_1, false, false, false}, + {false, false, false, false, false, false, false, false, false, false, false, false}, + {false, false, false, false, ITEM1, false, false, false, false, false, false, false}, + {false, false, false, ITEM4, ITEM5, ITEM2, false, false, false, false, false, false}, + {false, false, false, false, ITEM3, false, false, false, false, false, false, false}, + {false, false, false, false, ITEM6, false, false, false, false, false, false, false}, + {false, false, false, false, false, false, false, false, false, false, false, false}, + {false, false, false, false, false, false, false, false, false, false, false, false}, + {TEXT3, false, false, false, false, false, false, false, false, false, false, ITEM4}, +} + +doclib.add_manual_plan("doclib", "EN", "demo1", plan1) diff --git a/doclib/screenshot.png b/doclib/screenshot.png new file mode 100644 index 0000000..baa6e38 Binary files /dev/null and b/doclib/screenshot.png differ diff --git a/doclib/textures/book.xcf b/doclib/textures/book.xcf new file mode 100644 index 0000000..97643c6 Binary files /dev/null and b/doclib/textures/book.xcf differ diff --git a/doclib/textures/doclib_book.png b/doclib/textures/doclib_book.png new file mode 100644 index 0000000..6f5fb66 Binary files /dev/null and b/doclib/textures/doclib_book.png differ diff --git a/doclib/textures/doclib_book_inv.png b/doclib/textures/doclib_book_inv.png new file mode 100644 index 0000000..87fbd27 Binary files /dev/null and b/doclib/textures/doclib_book_inv.png differ diff --git a/doclib/textures/doclib_demo_img1.png b/doclib/textures/doclib_demo_img1.png new file mode 100644 index 0000000..c6bf658 Binary files /dev/null and b/doclib/textures/doclib_demo_img1.png differ diff --git a/doclib/textures/doclib_demo_img2.png b/doclib/textures/doclib_demo_img2.png new file mode 100644 index 0000000..d6c3a3c Binary files /dev/null and b/doclib/textures/doclib_demo_img2.png differ diff --git a/doclib/textures/doclib_demo_img3.png b/doclib/textures/doclib_demo_img3.png new file mode 100644 index 0000000..7437493 Binary files /dev/null and b/doclib/textures/doclib_demo_img3.png differ diff --git a/doclib/textures/doclib_demo_img4.png b/doclib/textures/doclib_demo_img4.png new file mode 100644 index 0000000..dc9bab3 Binary files /dev/null and b/doclib/textures/doclib_demo_img4.png differ diff --git a/lcdlib/README.md b/lcdlib/README.md index 4a658a1..4279006 100644 --- a/lcdlib/README.md +++ b/lcdlib/README.md @@ -2,6 +2,12 @@ This LCD Lib is based on Display Lib and Font Lib from Pierre-Yves Rollo +### History + +- v1.03 (2923-08-20): Add legacy mode as default mode. +- v1.02 (2923-08-19): If a text string begins with a "\t" character, the line is centered on the display. + + **Dependancies**: none **License**: LGPL diff --git a/lcdlib/init.lua b/lcdlib/init.lua index cbbc200..bf426c5 100644 --- a/lcdlib/init.lua +++ b/lcdlib/init.lua @@ -24,7 +24,7 @@ lcdlib = {} lcdlib.registered_fonts = {} -- Version for compatibility checks -lcdlib.version = 1.01 +lcdlib.version = 1.03 -- Local functions ------------------ @@ -177,10 +177,13 @@ end -- @param maxlines Maximum number of lines -- @param valign Vertical text align ("top" or "center") -- @param color Color of the text +-- @param mode (Optional parameter): +-- If true, use "\t" to center the text, otherwise the text will be left-aligned +-- If "false" or "nil", use "<" to left-align the text, otherwise the text will be centered (legacy mode) -- @return Texture string function lcdlib.make_multiline_texture(font_name, text, width, height, - maxlines, valign, color, y_offs) + maxlines, valign, color, y_offs, mode) local texture = "" local lines = {} local textheight = 0 @@ -188,12 +191,22 @@ function lcdlib.make_multiline_texture(font_name, text, width, height, h = get_font(font_name).height for num, line in pairs(split_lines(text, maxlines)) do - if line:byte(1) == 60 then -- '<' - lines[num] = { text = line:sub(2,-1), width = width - 4, height = h, } + if mode then + if line:byte(1) == 9 then -- '\t' + line = line:sub(2,-1) + w, h = lcdlib.get_text_size(font_name, line) + lines[num] = {text = line, width = w, height = h} + else + lines[num] = {text = line, width = width - 4, height = h} + end else - w, h = lcdlib.get_text_size(font_name, line) - lines[num] = { text = line, width = w, height = h, } - end + if line:byte(1) == 60 then -- '<' + lines[num] = {text = line:sub(2,-1), width = width - 4, height = h} + else + w, h = lcdlib.get_text_size(font_name, line) + lines[num] = {text = line, width = w, height = h} + end + end textheight = textheight + h end diff --git a/minecart/README.md b/minecart/README.md index 6d86656..c6b41d0 100644 --- a/minecart/README.md +++ b/minecart/README.md @@ -26,8 +26,7 @@ license). 3. https://github.com/stujones11/railcart/ -Minecart Features ------------------ +## Minecart Features The mod Minecart has its own cart (called Minecart) in addition to the standard cart. Minecarts are used for automated item transport on private and public rail networks. @@ -41,14 +40,14 @@ The mod features are: - protection of minecarts and cargo - Minecarts run through unloaded areas (only the stations/hopper have to be loaded) - Extra Minecart privs for rail workers -- Ingame documentation (German and English), based on the mod "doc" +- Ingame documentation (German and English), based on the mod "doc" and/or + doclib/techage - API to register carts from other mods - chat command `/mycart ` to output cart state and location - Command interface for Techage (Lua and ICTA) and for Beduino Controllers -Technical Background --------------------- +## Technical Background The Minecart can "run" through unloaded areas. This is done by means of recorded and stored routes. If the area is unloaded the cart will simply follow the @@ -56,39 +55,11 @@ predefined route until an area is loaded again. In this case the cart will be spawned and run as usual. -Introduction ------------- - -1. Place your rails and build a route with two endpoints. Junctions are allowed - as long as each route has its own start and endpoint. -2. Place a Railway Buffer at both endpoints. (buffers are always needed, - they store the route and timing information) -3. Give both Railway Buffers unique station names, like Oxford and Cambridge -4. Place a Minecart at a buffer and give it a cart number (1..999) -5. Drive from buffer to buffer in both directions using the Minecart(!) to record the - routes (use 'right-left' keys to control the Minecart) -6. Punch the buffers to check the connection data (e.g. "Oxford: connected to Cambridge") -7. Optional: Configure the Minecart waiting time in both buffers. The Minecart - will then start automatically after the configured time -8. Optional: Protect your rail network with the Protection Landmarks (one Landmark - at least every 16 nodes/meters) -9. Place a Minecart in front of the buffer and check whether it starts after the - configured time -10. Check the cart state via the chat command: `/mycart ` - `` is the cart number, or get a list of carts with `/mycart` -11. Drop items into the Minecart and punch the cart to start it, or "sneak+click" the - Minecart to get cart and items back -12. Dig the cart with 'sneak+click' (as usual). The items will be drop down. -13. To retrieve lost carts, use the chat command: /stopcart - - - ## Manual see [Wiki](https://github.com/joe7575/minecart/wiki) - ## Command Interface ### Techage ICTA Controller @@ -128,10 +99,7 @@ The Cart Terminal has a Beduino command interface with the commands: | Distance | 130 | [cart-id] | [distance] | Returns the distance from the cart to the Cart Terminal | - - -History -------- +# History 2019-04-19 v0.01 first commit 2019-04-21 v0.02 functional, with junctions support @@ -156,4 +124,5 @@ History 2021-09-02 V2.01 Chat command /stopcart added 2021-10-18 V2.02 Cart reproduction bug fixed 2023-01-04 V2.03 Techage and Beduino command interface added -2023-02-05 V2.04 New API functions added, EOL blanks removed +2023-02-05 V2.04 New API functions added, EOL blanks removed +2023-08-25 V2.05 Support for doclib added diff --git a/minecart/init.lua b/minecart/init.lua index 6c09b98..b6b0744 100644 --- a/minecart/init.lua +++ b/minecart/init.lua @@ -13,7 +13,7 @@ minecart = {} -- Version for compatibility checks, see readme.md/history -minecart.version = 2.04 +minecart.version = 2.05 minecart.hopper_enabled = minetest.settings:get_bool("minecart_hopper_enabled") ~= false minecart.teleport_enabled = minetest.settings:get_bool("minecart_teleport_enabled") == true @@ -47,4 +47,5 @@ if minecart.hopper_enabled then end dofile(MP .. "/doc.lua") +dofile(MP .. "/manual.lua") minetest.log("info", "[MOD] Minecart loaded") diff --git a/minecart/manual.lua b/minecart/manual.lua new file mode 100644 index 0000000..c18593c --- /dev/null +++ b/minecart/manual.lua @@ -0,0 +1,145 @@ +--[[ + + Minecart + ======== + + Copyright (C) 2019-2023 Joachim Stolberg + + MIT + See license.txt for more information + + InGame Documentation for techage or doclib + +]]-- + +local MP = minetest.get_modpath("minecart") + +minetest.register_on_mods_loaded(function() + if minetest.global_exists("techage") then + + -- Use the Techage Construction Board + local content = dofile(MP.."/manual_EN.lua") + doclib.add_to_manual("techage", "EN", content) + local content = dofile(MP.."/manual_DE.lua") + doclib.add_to_manual("techage", "DE", content) + + elseif minetest.global_exists("doclib") then + + -- Create own manual book + local settings = { + symbol_item = "minecart_manual_image.png", + } + + doclib.create_manual("minecart", "EN", settings) + local content = dofile(MP.."/manual_EN.lua") + doclib.add_to_manual("minecart", "EN", content) + + doclib.create_manual("minecart", "DE", settings) + local content = dofile(MP.."/manual_DE.lua") + doclib.add_to_manual("minecart", "DE", content) + + minetest.register_node("minecart:manual", { + description = "Minecart Manual (EN)", + inventory_image = "minecart_book_inv.png", + tiles = { + -- up, down, right, left, back, front + "minecart_book.png", + "minecart_book.png", + "minecart_book.png^[transformR270", + "minecart_book.png^[transformR90", + "minecart_book.png^[transformR180", + "minecart_book.png" + }, + drawtype = "nodebox", + node_box = { + type = "fixed", + fixed = { + { -8/32, -16/32, -12/32, 8/32, -12/32, 12/32}, + }, + }, + + after_place_node = function(pos, placer, itemstack) + minetest.get_meta(pos):set_string("infotext", "Minecart Manual (EN)") + minetest.get_meta(pos):set_string("formspec", doclib.formspec(pos, "minecart", "EN")) + end, + + on_receive_fields = function(pos, formname, fields, player) + local player_name = player:get_player_name() + if minetest.is_protected(pos, player_name) then + return + end + minetest.get_meta(pos):set_string("formspec", doclib.formspec(pos, "minecart", "EN", fields)) + end, + + paramtype = "light", + sunlight_propagates = true, + paramtype2 = "facedir", + use_texture_alpha = "clip", + is_ground_content = false, + groups = {choppy = 2, oddly_breakable_by_hand = 2, flammable = 2}, + }) + + minetest.register_node("minecart:handbuch", { + description = "Minecart Handbuch (DE)", + inventory_image = "minecart_book_inv.png", + tiles = { + -- up, down, right, left, back, front + "minecart_book.png", + "minecart_book.png", + "minecart_book.png^[transformR270", + "minecart_book.png^[transformR90", + "minecart_book.png^[transformR180", + "minecart_book.png" + }, + drawtype = "nodebox", + node_box = { + type = "fixed", + fixed = { + { -8/32, -16/32, -12/32, 8/32, -12/32, 12/32}, + }, + }, + + after_place_node = function(pos, placer, itemstack) + minetest.get_meta(pos):set_string("infotext", "Minecart Handbuch (DE)") + minetest.get_meta(pos):set_string("formspec", doclib.formspec(pos, "minecart", "DE")) + end, + + on_receive_fields = function(pos, formname, fields, player) + local player_name = player:get_player_name() + if minetest.is_protected(pos, player_name) then + return + end + minetest.get_meta(pos):set_string("formspec", doclib.formspec(pos, "minecart", "DE", fields)) + end, + + paramtype = "light", + sunlight_propagates = true, + paramtype2 = "facedir", + use_texture_alpha = "clip", + is_ground_content = false, + groups = {choppy = 2, oddly_breakable_by_hand = 2, flammable = 2}, + }) + + minetest.register_craft({ + output = "minecart:manual", + recipe = { + {"dye:red", "default:paper", "default:paper"}, + {"dye:black", "default:paper", "default:paper"}, + {"dye:red", "default:paper", "default:paper"}, + }, + }) + + minetest.register_craft({ + type = "shapeless", + output = "minecart:handbuch", + recipe = {"minecart:manual"}, + }) + + minetest.register_craft({ + type = "shapeless", + output = "minecart:manual", + recipe = {"minecart:handbuch"}, + }) + + end +end) \ No newline at end of file diff --git a/minecart/manual_DE.lua b/minecart/manual_DE.lua new file mode 100644 index 0000000..b3f79d0 --- /dev/null +++ b/minecart/manual_DE.lua @@ -0,0 +1,126 @@ +return { + titles = { + "1,Minecart", + "2,Kurzanleitung", + "2,Minecart-Blöcke", + "3,Wagen", + "3,Puffer", + "3,Landmarken", + "3,Trichter/Hopper", + "3,Wagenschieber (Cart Pusher)", + "3,Geschwindigkeitsbegrenzungsschilder", + "2,Chat-Befehle", + "2,Online-Handbuch", + }, + texts = { + "Die Mod Minecart verfügt zusätzlich zu den Standard-Wagen/Loren über eigene Wagen\n".. + "(Minecart genannt).\n".. + "Minecarts werden für den automatisierten Gütertransport auf privaten und öffentlichen\n".. + "Schienennetzen eingesetzt.\n".. + "\n".. + "Die Hauptmerkmale sind:\n".. + "\n".. + " - Gütertransport von Station zu Station\n".. + " - Wagen können durch unbeladene Bereiche (Mapblocks) fahren\n(es müssen nur beide Stationen geladen sein)\n".. + " - Automatisiertes Be-/Entladen von Minecarts mittels Minecart Hopper\n".. + " - Die Schienen können durch Landmarken geschützt werden\n".. + "\n".. + "Wenn die Mod Techage verfügbar ist:\n".. + "\n".. + " - Sind zwei zusätzliche Wagen für den Transport von Gegenständen und Flüssigkeiten verfügbar\n".. + " - Können diese Wagen mit Hilfe von Techage Schiebern und Pumpen be- und entladen werden\n".. + "\n".. + "Du kannst:\n".. + "\n".. + " - den Wagen mit einem Rechtsklick besteigen\n".. + " - den Wagen mit einem Sprung oder Rechtsklick wieder verlassen\n".. + " - den Wagen mit einem Linksklick anschieben/starten\n".. + "\n".. + "Aber Minecarts haben ihren Besitzer und du kannst fremde Minecarts nicht starten\\, stoppen oder entfernen.\n".. + "Minecarts können nur am Puffer/Prellbock gestartet werden. Wenn ein Minecarts unterwegs stehen bleibt\\,\n".. + "entferne es und platziere es wieder an einer Puffer-Position.\n".. + "\n".. + "\n".. + "\n", + " - Platziere die Schienen und baue eine Route mit zwei Endpunkten.\nKreuzungen sind erlaubt\\, solange jede Route einen eigenen Start- und Endpunkt hat.\n".. + " - Platziere an beiden Endpunkten einen Prellbock/Puffer (Puffer werden immer benötigt\\,\nsie speichern die Routen- und Zeitinformationen).\n".. + " - Gebe beiden Prellböcken eindeutige Bahnhofsnamen\\, z. B. Stuttgart und München.\n".. + " - Stelle ein Minecart an einen Puffer und gebe ihm eine Wagennummer (1..999).\n".. + " - Fahre mit dem Minecart(!) von Puffer zu Puffer in beide Richtungen\\, um die\nStecke aufzuzeichnen (verwende die Rechts/Links-Tasten\\, um das Minecart zu steuern).\n".. + " - Schlage auf die Puffer\\, um die Verbindungsdaten zu überprüfen\n (z. B. \"Stuttgart: verbunden mit München\").\n".. + " - Optional: Konfiguriere die Minecart-Wartezeit in beiden Puffern.\nDas Minecart startet dann automatisch nach der konfigurierten Zeit.\n".. + " - Stelle ein Minecart vor den Puffer und prüfe\\, ob es nach der konfigurierten Zeit\nstartet.\n".. + " - Lege Gegenstände in das Minecart und schlage auf den Wagen\\, um ihn zu starten.\n".. + " - Entferne den Wagen mit Shift + Rechts-Click“.\n".. + "\n".. + "\n".. + "\n", + "\n".. + "\n", + "Wird hauptsächlich zum Transport von Gegenständen verwendet. Du kannst Gegenstände\n".. + "in das Minecart legen und auf den Wagen schlagen\\, um ihn zu starten.\n".. + "\n".. + "\n".. + "\n", + "Wird als Prellbock an beiden Schienenenden verwendet. Wird benötigt\\, um die\n".. + "Routen der Minecarts aufzeichnen und speichern zu können.\n".. + "\n".. + "\n".. + "\n", + "Schütze deine Schienen mit den Landmarken (mindestens alle 16 Blöcke in\n".. + "der Nähe der Schiene eine Landmarke).\n".. + "\n".. + "\n".. + "\n", + "Wird zum Laden/Entladen von Minecarts verwendet. Der Hopper kann Gegenstände\n".. + "zu/von Truhen schieben/ziehen und Gegenstände zu/von Minecarts abgeben/abholen.\n".. + "Um ein Minecart zu entladen\\, platziere den Trichter unterhalb der Schiene.\n".. + "Um das Minecart zu beladen\\, platziere den Trichter direkt neben dem Minecart.\n".. + "\n".. + "\n".. + "\n", + "Wenn mehrere Wagen auf einer Strecke fahren\\, kann es vorkommen\\, dass eine Pufferposition\n".. + "bereits belegt ist und ein Wagen daher früher stoppt.\n".. + "In diesem Fall dient der Wagenschieber dazu\\, den Wagen wieder in Richtung Puffer zu schieben.\n".. + "Dieser Block muss im Abstand von 2 m vor dem Puffer unter der Schiene platziert werden.\n".. + "\n".. + "\n".. + "\n", + "Begrenze die Geschwindigkeit der Minecarts mit Geschwindigkeitsbegrenzungsschildern.\n".. + "\n".. + "\n".. + "\n", + " - Befehl „/mycart “\\, um den Status und den Standort des Minecarts auszugeben\n".. + " - Befehl „/stopcart “\\, um verlorene Minecarts abzurufen\n".. + "\n", + "Ein umfassendes Handbuch ist online verfügbar.\n".. + "Siehe: https://github.com/joe7575/minecart/wiki\n".. + "\n", + }, + images = { + "minecart_manual_image.png", + "minecart_manual_image.png", + "minecart:cart", + "minecart:cart", + "minecart:buffer", + "minecart:landmark", + "minecart:hopper", + "minecart:cart_pusher", + "minecart:speed2", + "", + "", + }, + plans = { + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + } +} \ No newline at end of file diff --git a/minecart/manual_DE.md b/minecart/manual_DE.md new file mode 100644 index 0000000..be3116f --- /dev/null +++ b/minecart/manual_DE.md @@ -0,0 +1,121 @@ +# Minecart + +Die Mod Minecart verfügt zusätzlich zu den Standard-Wagen/Loren über eigene Wagen +(Minecart genannt). +Minecarts werden für den automatisierten Gütertransport auf privaten und öffentlichen +Schienennetzen eingesetzt. + +Die Hauptmerkmale sind: + +- Gütertransport von Station zu Station +- Wagen können durch unbeladene Bereiche (Mapblocks) fahren + (es müssen nur beide Stationen geladen sein) +- Automatisiertes Be-/Entladen von Minecarts mittels Minecart Hopper +- Die Schienen können durch Landmarken geschützt werden + +Wenn die Mod Techage verfügbar ist: + +- Sind zwei zusätzliche Wagen für den Transport von Gegenständen und Flüssigkeiten verfügbar +- Können diese Wagen mit Hilfe von Techage Schiebern und Pumpen be- und entladen werden + +Du kannst: + +- den Wagen mit einem Rechtsklick besteigen +- den Wagen mit einem Sprung oder Rechtsklick wieder verlassen +- den Wagen mit einem Linksklick anschieben/starten + +Aber Minecarts haben ihren Besitzer und du kannst fremde Minecarts nicht starten, stoppen oder entfernen. +Minecarts können nur am Puffer/Prellbock gestartet werden. Wenn ein Minecarts unterwegs stehen bleibt, +entferne es und platziere es wieder an einer Puffer-Position. + +[minecart_manual_image.png|image] + + +## Kurzanleitung + +1. Platziere die Schienen und baue eine Route mit zwei Endpunkten. + Kreuzungen sind erlaubt, solange jede Route einen eigenen Start- und Endpunkt hat. +2. Platziere an beiden Endpunkten einen Prellbock/Puffer (Puffer werden immer benötigt, + sie speichern die Routen- und Zeitinformationen). +3. Gebe beiden Prellböcken eindeutige Bahnhofsnamen, z. B. Stuttgart und München. +4. Stelle ein Minecart an einen Puffer und gebe ihm eine Wagennummer (1..999). +5. Fahre mit dem Minecart(!) von Puffer zu Puffer in beide Richtungen, um die + Stecke aufzuzeichnen (verwende die Rechts/Links-Tasten, um das Minecart zu steuern). +6. Schlage auf die Puffer, um die Verbindungsdaten zu überprüfen + (z. B. "Stuttgart: verbunden mit München"). +7. Optional: Konfiguriere die Minecart-Wartezeit in beiden Puffern. + Das Minecart startet dann automatisch nach der konfigurierten Zeit. +9. Stelle ein Minecart vor den Puffer und prüfe, ob es nach der konfigurierten Zeit + startet. +10. Lege Gegenstände in das Minecart und schlage auf den Wagen, um ihn zu starten. +11. Entferne den Wagen mit Shift + Rechts-Click“. + +[minecart_manual_image.png|image] + + +## Minecart-Blöcke + +[minecart:cart|image] + + +### Wagen + +Wird hauptsächlich zum Transport von Gegenständen verwendet. Du kannst Gegenstände +in das Minecart legen und auf den Wagen schlagen, um ihn zu starten. + +[minecart:cart|image] + + +### Puffer + +Wird als Prellbock an beiden Schienenenden verwendet. Wird benötigt, um die +Routen der Minecarts aufzeichnen und speichern zu können. + +[minecart:buffer|image] + + +### Landmarken + +Schütze deine Schienen mit den Landmarken (mindestens alle 16 Blöcke in +der Nähe der Schiene eine Landmarke). + +[minecart:landmark|image] + + +### Trichter/Hopper + +Wird zum Laden/Entladen von Minecarts verwendet. Der Hopper kann Gegenstände +zu/von Truhen schieben/ziehen und Gegenstände zu/von Minecarts abgeben/abholen. +Um ein Minecart zu entladen, platziere den Trichter unterhalb der Schiene. +Um das Minecart zu beladen, platziere den Trichter direkt neben dem Minecart. + +[minecart:hopper|image] + + +### Wagenschieber (Cart Pusher) + +Wenn mehrere Wagen auf einer Strecke fahren, kann es vorkommen, dass eine Pufferposition +bereits belegt ist und ein Wagen daher früher stoppt. +In diesem Fall dient der Wagenschieber dazu, den Wagen wieder in Richtung Puffer zu schieben. +Dieser Block muss im Abstand von 2 m vor dem Puffer unter der Schiene platziert werden. + +[minecart:cart_pusher|image] + + +### Geschwindigkeitsbegrenzungsschilder + +Begrenze die Geschwindigkeit der Minecarts mit Geschwindigkeitsbegrenzungsschildern. + +[minecart:speed2|image] + + +## Chat-Befehle + +- Befehl „/mycart “, um den Status und den Standort des Minecarts auszugeben +- Befehl „/stopcart “, um verlorene Minecarts abzurufen + + +## Online-Handbuch + +Ein umfassendes Handbuch ist online verfügbar. +Siehe: https://github.com/joe7575/minecart/wiki diff --git a/minecart/manual_EN.lua b/minecart/manual_EN.lua new file mode 100644 index 0000000..f96c265 --- /dev/null +++ b/minecart/manual_EN.lua @@ -0,0 +1,120 @@ +return { + titles = { + "1,Minecart", + "2,Quick start guide", + "2,Minecart Blocks", + "3,Cart", + "3,Buffer", + "3,Landmark", + "3,Hopper", + "3,Cart pusher", + "3,Speed limit signs", + "2,Chat commands", + "2,Online manual", + }, + texts = { + "The mod Minecart has its own carts (called Minecart) in addition to the standard carts.\n".. + "Minecarts are used for automated item transport on private and public rail networks.\n".. + "The main features are:\n".. + "\n".. + " - Item transport from station to station\n".. + " - Carts can run through unloaded areas (only both stations have to be loaded)\n".. + " - Automated loading/unloading of Minecarts by means of the Minecart Hopper\n".. + " - The rails can be protected by means of landmarks\n".. + "\n".. + "If the mod Techage is available\\, then:\n".. + "\n".. + " - Two additional carts for item and liquid transportation are available\n".. + " - Carts can be loaded/unloaded by means of Techage pusher and pumps\n".. + "\n".. + "You can:\n".. + "\n".. + " - Enter the cart with a right-click\n".. + " - Leave the cart with a jump or a right-click\n".. + " - Push/start the cart with a left-click\n".. + "\n".. + "But carts have their owner and you can't start\\, stop\\, or remove foreign carts.\n".. + "Carts can only be started at the buffer. If a cart stops on the way\\,\n".. + "remove it and place it at the buffer position.\n".. + "\n".. + "\n".. + "\n", + " - Place your rails and build a route with two endpoints.\nJunctions are allowed as long as each route has its own start and endpoint.\n".. + " - Place a Railway Buffer at both endpoints (buffers are always needed\\,\nthey store the route and timing information).\n".. + " - Give both Railway Buffers unique station names\\, like Oxford and Cambridge.\n".. + " - Place a Minecart at a buffer and give it a cart number (1..999)\n".. + " - Drive from buffer to buffer in both directions using the Minecart(!) to\nrecord the routes (use 'right-left' keys to control the Minecart).\n".. + " - Punch the buffers to check the connection data\n(e.g. 'Oxford: connected to Cambridge').\n".. + " - Optional: Configure the Minecart waiting time in both buffers.\nThe Minecart will then start automatically after the configured time.\n".. + " - Place a Minecart in front of the buffer and check whether it starts\nafter the configured time.\n".. + " - Drop items into the Minecart and punch the cart to start it.\n".. + " - Dig the cart with 'sneak+click' (as usual). The items will be drop down.\n".. + "\n".. + "\n".. + "\n", + "\n".. + "\n", + "Primary used to transport items. You can drop items into the Minecart and punch the cart to get started. \n".. + "Sneak+click the cart to get cart and items back.\n".. + "\n".. + "\n".. + "\n", + "Used as buffer on both rail ends. Needed to be able to record the cart routes.\n".. + "\n".. + "\n".. + "\n", + "Protect your rails with the Landmarks (one Landmark at least every 16 blocks near the rail.\n".. + "\n".. + "\n".. + "\n", + "Used to load/unload Minecarts. The Hopper can push/pull items to/from chests\n".. + "and drop/pickup items to/from Minecarts. To unload a Minecart place the hopper \n".. + "below the rail. To load the Minecart\\, place the hopper right next to the Minecart.\n".. + "\n".. + "\n".. + "\n", + "If several carts are running on one route\\, it can happen that a buffer position\n".. + "is already occupied and one cart therefore stops earlier.\n".. + "In this case\\, the cart pusher is used to push the cart towards the buffer again.\n".. + "This block must be placed under the rail at a distance of 2 m in front of the buffer.\n".. + "\n".. + "\n".. + "\n", + "Limit the cart speed with speed limit signs.\n".. + "\n".. + "\n".. + "\n", + " - Command '/mycart ' to output cart state and location\n".. + " - Command '/stopcart ' to retrieve lost carts\n".. + "\n", + "A comprehensive manual is available online.\n".. + "See: https://github.com/joe7575/minecart/wiki\n".. + "\n", + }, + images = { + "minecart_manual_image.png", + "minecart_manual_image.png", + "minecart:cart", + "minecart:cart", + "minecart:buffer", + "minecart:landmark", + "minecart:hopper", + "minecart:cart_pusher", + "minecart:speed2", + "", + "", + }, + plans = { + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + } +} \ No newline at end of file diff --git a/minecart/manual_EN.md b/minecart/manual_EN.md new file mode 100644 index 0000000..8de0401 --- /dev/null +++ b/minecart/manual_EN.md @@ -0,0 +1,114 @@ +# Minecart + +The mod Minecart has its own carts (called Minecart) in addition to the standard carts. +Minecarts are used for automated item transport on private and public rail networks. +The main features are: + +- Item transport from station to station +- Carts can run through unloaded areas (only both stations have to be loaded) +- Automated loading/unloading of Minecarts by means of the Minecart Hopper +- The rails can be protected by means of landmarks + +If the mod Techage is available, then: + +- Two additional carts for item and liquid transportation are available +- Carts can be loaded/unloaded by means of Techage pusher and pumps + +You can: + +- Enter the cart with a right-click +- Leave the cart with a jump or a right-click +- Push/start the cart with a left-click + +But carts have their owner and you can't start, stop, or remove foreign carts. +Carts can only be started at the buffer. If a cart stops on the way, +remove it and place it at the buffer position. + +[minecart_manual_image.png|image] + + +## Quick start guide + +1. Place your rails and build a route with two endpoints. + Junctions are allowed as long as each route has its own start and endpoint. +2. Place a Railway Buffer at both endpoints (buffers are always needed, + they store the route and timing information). +3. Give both Railway Buffers unique station names, like Oxford and Cambridge. +4. Place a Minecart at a buffer and give it a cart number (1..999) +5. Drive from buffer to buffer in both directions using the Minecart(!) to + record the routes (use 'right-left' keys to control the Minecart). +6. Punch the buffers to check the connection data + (e.g. 'Oxford: connected to Cambridge'). +7. Optional: Configure the Minecart waiting time in both buffers. + The Minecart will then start automatically after the configured time. +9. Place a Minecart in front of the buffer and check whether it starts + after the configured time. +10. Drop items into the Minecart and punch the cart to start it. +11. Dig the cart with 'sneak+click' (as usual). The items will be drop down. + +[minecart_manual_image.png|image] + + +## Minecart Blocks + +[minecart:cart|image] + + +### Cart + +Primary used to transport items. You can drop items into the Minecart and punch the cart to get started. +Sneak+click the cart to get cart and items back. + +[minecart:cart|image] + + +### Buffer + +Used as buffer on both rail ends. Needed to be able to record the cart routes. + +[minecart:buffer|image] + + +### Landmark + +Protect your rails with the Landmarks (one Landmark at least every 16 blocks near the rail. + +[minecart:landmark|image] + + +### Hopper + +Used to load/unload Minecarts. The Hopper can push/pull items to/from chests +and drop/pickup items to/from Minecarts. To unload a Minecart place the hopper +below the rail. To load the Minecart, place the hopper right next to the Minecart. + +[minecart:hopper|image] + + +### Cart pusher + +If several carts are running on one route, it can happen that a buffer position +is already occupied and one cart therefore stops earlier. +In this case, the cart pusher is used to push the cart towards the buffer again. +This block must be placed under the rail at a distance of 2 m in front of the buffer. + +[minecart:cart_pusher|image] + + +### Speed limit signs + +Limit the cart speed with speed limit signs. + +[minecart:speed2|image] + + +## Chat commands + +- Command `/mycart ` to output cart state and location +- Command `/stopcart ` to retrieve lost carts + + +## Online manual + +A comprehensive manual is available online. +See: https://github.com/joe7575/minecart/wiki \ No newline at end of file diff --git a/minecart/markdown_to_lua.py b/minecart/markdown_to_lua.py new file mode 100644 index 0000000..4093f2d --- /dev/null +++ b/minecart/markdown_to_lua.py @@ -0,0 +1,201 @@ +#!/usr/bin/env python +# -*- coding: utf-8 -*- + +# install mistune v0.8.4 with: pip install mistune==0.8.4 + +import re +import mistune + +assert(mistune.__version__ == "0.8.4") + +__version__ = "1.0" + +class WikiLinkInlineLexer(mistune.InlineLexer): + def enable_wiki_link(self): + # add wiki_link rules + self.rules.wiki_link = re.compile( + r'\[' # [ + r'([\s\S]+?\|[\s\S]+?)' # name| img-type + r'\](?!\])' # ] + ) + + # Add wiki_link parser to default rules + # you can insert it some place you like + # but place matters, maybe 3 is not good + self.default_rules.insert(3, 'wiki_link') + + def output_wiki_link(self, m): + text = m.group(1) + name, itype = text.split('|') + # you can create an custom render + # you can also return the html if you like + return self.renderer.wiki_link(name, itype) + +class MarkdownToLua(mistune.Renderer): + def __init__(self, *args, **kwargs): + mistune.Renderer.__init__(self, *args, **kwargs) + self.item_name = "" + self.plan_table = "" + self.is_first_header = True + self.text_chunck = [] + self.lTitle = [] + self.lText = [] + self.lItemName = [] + self.lPlanTable = [] + print("Markdown-to-Lua v%s" % __version__) + + def m2l_formspec_escape(self, text): + text = text.replace("\\", "") + text = text.replace("[", "\\\\[") + text = text.replace("]", "\\\\]") + text = text.replace(";", "\\\\;") + text = text.replace(",", "\\\\,") + text = text.replace('"', '\\"') + text = text.replace('\n', '\\n') + return text + + def m2l_add_last_paragraph(self): + """ + Used to add a text block before the next header or at the end of the document + """ + self.lText.append(self.text_chunck) + self.text_chunck = [] + self.lItemName.append(self.item_name) + self.item_name = "" + self.lPlanTable.append(self.plan_table) + self.plan_table = "" + ## + ## Block Level + ## + def block_code(self, code, lang): + text = self.m2l_formspec_escape(code.strip()) + lines = text.split("\\n") + lines = [" " + item for item in lines] + self.text_chunck.extend(lines) + self.text_chunck.append("") + return "" + + def header(self, text, level, raw=None): + if not self.is_first_header: + self.m2l_add_last_paragraph() + self.is_first_header = False + self.lTitle.append("%u,%s" % (level, self.m2l_formspec_escape(text))) + return "" + + def hrule(self): + self.text_chunck.append("\n----------------------------------------------------\n") + return "" + + def paragraph(self, text): + lines = text.split("\\n") + [""] + self.text_chunck.extend(lines) + return "" + + def list(self, body, ordered=True): + lines = body.split("\n") + self.text_chunck.extend(lines) + return "" + + def list_item(self, text): + return " - %s\n" % text.strip() + ## + ## Span Level + ## + def emphasis(self, text): + return "*%s*" % self.m2l_formspec_escape(text) + + def double_emphasis(self, text): + return "*%s*" % self.m2l_formspec_escape(text) + + def codespan(self, text): + return "'%s'" % self.m2l_formspec_escape(text) + + def text(self, text): + return self.m2l_formspec_escape(text) + + def link(self, link, title, content): + """ + Used for plans and images: + [myimage](/image/) + [myplan](/plan/) + """ + if link == "/image/": + self.item_name = content + elif link == "/plan/": + self.plan_table = content + return content + + def wiki_link(self, name, itype): + """ + Used for plans and images: + [myimage|image] + [myplan|plan] + """ + if itype == "image": + self.item_name = name + elif itype == "plan": + self.plan_table = name + return "" + + def autolink(self, link, is_email=False): + return link + + def linebreak(self): + return "\\n" + + def newline(self): + return "\\n" + + def inline_html(self, text): + #print(text) + pass + + def parse_md_file(self, src_name): + print(" - Read MD file '%s'" % src_name) + inline = WikiLinkInlineLexer(self) + # enable the feature + inline.enable_wiki_link() + md = mistune.Markdown(renderer=self, inline=inline) + md.renderer.src_name = src_name + md.render(open(src_name, 'r').read()) + md.renderer.m2l_add_last_paragraph() + + def lua_table(self, key, lData): + lOut = [] + lOut.append(" %s = {" % key) + for line in lData: + lOut.append(' "%s",' % line) + lOut.append(" }") + return "\n".join(lOut) + + def lua_text_table(self, key, lData): + lOut = [] + lOut.append(" %s = {" % key) + for lines in lData: + for line in lines[:-1]: + line = line.replace('
', '\\n') + lOut.append(' "%s\\n"..' % line) + if len(lines) > 0: + lOut.append(' "%s\\n",' % lines[-1]) + else: + lOut.append(' "",') + lOut.append(" }") + return "\n".join(lOut) + + def gen_lua_file(self, dest_name): + print(" - Write Lua file '%s'" % dest_name) + lOut = [] + s = ",\n".join([self.lua_table("titles", self.lTitle), + self.lua_text_table("texts", self.lText), + self.lua_table("images", self.lItemName), + self.lua_table("plans", self.lPlanTable)]) + open(dest_name, "w").write("return {\n%s\n}" % s) + print("done.") + +m2l = MarkdownToLua() +m2l.parse_md_file("./manual_EN.md") +m2l.gen_lua_file("./manual_EN.lua") + +m2l = MarkdownToLua() +m2l.parse_md_file("./manual_DE.md") +m2l.gen_lua_file("./manual_DE.lua") diff --git a/minecart/mod.conf b/minecart/mod.conf index 7b9a9ac..73d9cb1 100644 --- a/minecart/mod.conf +++ b/minecart/mod.conf @@ -1,4 +1,4 @@ name=minecart depends = default,carts -optional_depends = doc +optional_depends = doc, doclib description = Minecart, the lean railway transportation automation system diff --git a/minecart/textures/minecart_book.png b/minecart/textures/minecart_book.png new file mode 100644 index 0000000..a3e1ec0 Binary files /dev/null and b/minecart/textures/minecart_book.png differ diff --git a/minecart/textures/minecart_book_inv.png b/minecart/textures/minecart_book_inv.png new file mode 100644 index 0000000..ac0e24b Binary files /dev/null and b/minecart/textures/minecart_book_inv.png differ diff --git a/minecart/textures/minecart_manual_image.png b/minecart/textures/minecart_manual_image.png new file mode 100644 index 0000000..f5edfb4 Binary files /dev/null and b/minecart/textures/minecart_manual_image.png differ diff --git a/signs_bot/README.md b/signs_bot/README.md index 650d9a2..4d4df98 100644 --- a/signs_bot/README.md +++ b/signs_bot/README.md @@ -10,180 +10,24 @@ Download: [GitHub](https://github.com/joe7575/signs_bot/archive/master.zip) ![Signs Bot](https://github.com/joe7575/signs_bot/blob/master/screenshot.png) -The bot can only be controlled by signs that are placed in its path. -The bot starts running after starting until it encounters a sign. There, the commands are then processed on the sign. -The bot can also put himself signs in the way, which he then works off. -There is also a sign that can be programmed by the player, which then are processed by the bot. +### Introduction +See [manual](https://github.com/joe7575/signs_bot/blob/master/manual_EN.md) -There are also the following blocks: -- Sensors: These can send a signal to an actuator if they are connected to the actuator. -- Actuators: These perform an action when they receive a signal from a sensor. +The mod has an in-game help to all blocks and signs. +If 'techage' is installed, the techage ingame manual will be expanded. +If techage is not installed, it is recommended that you have installed the +mod doclib. -Sensors must be connected (paired) with actuators. This is what the Connection Tool does. Click on both blocks one after the other. -A successful pairing is indicated by a ping / pong noise. -When pairing, the state of the actuator is important. In the case of the bot box, for example, the states "on" and "off", in the case of the control unit 1,2,3,4, etc. -The state of the actuator is saved with the pairing and restored by the signal. For example, the robot can be switched on via a node sensor. - -An actuator can receive signals from many sensors. A sensor can only be connected to an actuator. However, if several actuators are to be controlled by one sensor, a signal extender block must be used. This connects to a sensor when it is placed next to the sensor. This extender can then be paired with another actuator. - -Sensors are: -- Bot Sensor: Sends a signal when the robot passes by -- Node Sensor: Sends a signal when it detects a change (tree, cactus, flower, etc.) in front of the sensor (over 3 positions) -- Crop Sensor: Sends a signal when, for example, the wheat is fully grown -- Bot Chest: Sends a signal depending on the chest state. Possible states are "empty", "not empty", "almost full". The state to be sent is defined while pairing. - -Actuators are: -- Control Unit: Can place up to 4 signs and steer the bot e.g. in different directions. -- Signs Bot Box: Can be turned off and on - -In addition, there are currently the following blocks: -- The duplicator is used to copy Command Signs, i.e. the signs with their own commands. -- Bot Flap: The "cat flap" is a door for the bot, which he opens automatically and closes behind him. -- Sensor Extender for controlling additional actuators from one sensor signal -- A Timer can be used to start the Bot cyclically -- A Delayer can be used to delay and queue signals - -More information: -- Using the signs "take" and "add", the bot can pick items from Chests and put them in. The signs must be placed on the box. So far, only a few blocks are supported with Inventory. -- The Control Unit can be charged with up to 4 labels. To do this, place a label next to the Control Unit and click on the Control Unit. The sign is only stored under this number. -- The inventory of the Signs Bot Box is intended to represent the inventory of the Robot. As long as the robot is on the road, of course you have no access. - -The copy function can be used to clone node cubes up to 5x3x3 nodes. There is the pattern shield for the template position and the copy shield for the "3x3x3" copy. Since the bot also copies air blocks, the function can also be used for mining or tunnels. The items to be placed must be in the inventory. Items that the bot degrades are in Inventory afterwards. If there are missing items in the inventory during copying, he will set "missing items" blocks, which dissolve into air when degrading. - -In-game help: -The mod has an in-game help to all blocks and signs. Therefore, it is highly recommended that you have installed the mods 'doc' and 'unified_inventory'. - -### Commands: -The commands are also all described as help in the "Sign command" node. -All blocks or signs that are set are taken from the bot inventory. -Any blocks or signs removed will be added back to the Bot Inventory. -`` is always the bot internal inventory stack (1..8). -For all Inventory commands applies: If the bot inventory stack specified by `` is full, so that nothing more can be done, or just empty, so that nothing more can be removed, the next slot will automatically be used. - - move - to follow one or more steps forward without signs - cond_move - walk to the next sign and work it off - turn_left - turn left - turn_right - turn right - turn_around - turn around - backward - one step backward - turn_off - turn off the robot / back to the box - pause - wait one or more seconds - move_up - move up (maximum 2 times) - move_down - move down - fall_down - fall into a hole/chasm (up to 10 blocks) - take_item - take one or more items from a box - add_item - put one or more items in a box - add_fuel - for furnaces or similar - place_front - Set block in front of the robot - place_left - Set block to the left - place_right - set block to the right - place_below - set block under the robot - place_above - set block above the robot - dig_front - remove block in front of the robot - dig_left - remove block on the left - dig_right - remove block on the right - dig_below - dig block under the robot - dig_above - dig block above the robot - rotate_item - rotate a block in front of the robot - set_param2 - set param2 of the block in front of the robot - place_sign - set sign - place_sign_behind - put a sign behind the bot - dig_sign - remove the sign - trash_sign - Remove the sign, clear data and add to the item Inventory - stop - Bot stops until the shield is removed - pickup_items - pickup items (in a 3x3 field) - drop_items - drop items - harvest - harvest a 3x3 field (farming) - cutting - cut a 3x3 flower field - sow_seed - a 3x3 field sowing / planting - plant_sapling - plant a sapling in front of the robot - pattern - save the blocks behind the shield (up to 5x3x3) as template - copy - make a copy of "pattern". Size is e.g. 3x3 (see ingame help) - punch_cart - Punch a rail cart to start it - add_compost - Put 2 leaves into the compost barrel - take_compost - Take a compost item from the barrel - print - Output chat message for debug purposes - take_water - Take water with empty bucket - fill_cauldron - Fill the xdecor cauldron for a soup - take_soup - Take boiling soup into empty bowl from cauldron - flame_on - Make fire - flame_off - Put out the fire - -#### Techage specific commands - - ignite - Ignite the techage charcoal lighter - low_batt - Turn the bot off if the battery power is below the - given value in percent (1..99) - jump_low_batt