From c61a479952134496419077f98946820613c493a5 Mon Sep 17 00:00:00 2001 From: wsor4035 <24964441+wsor4035@users.noreply.github.com> Date: Sun, 3 Dec 2023 14:25:54 -0500 Subject: [PATCH 01/14] purge everything --- .github/workflows/luacheck.yml | 18 -- .gitignore | 41 --- .luacheckrc | 16 -- LICENSE | 504 --------------------------------- init.lua | 71 ----- mod.conf | 1 - readme.md | 57 ---- 7 files changed, 708 deletions(-) delete mode 100644 .github/workflows/luacheck.yml delete mode 100644 .gitignore delete mode 100644 .luacheckrc delete mode 100644 LICENSE delete mode 100644 init.lua delete mode 100644 mod.conf delete mode 100644 readme.md diff --git a/.github/workflows/luacheck.yml b/.github/workflows/luacheck.yml deleted file mode 100644 index f24a4b0..0000000 --- a/.github/workflows/luacheck.yml +++ /dev/null @@ -1,18 +0,0 @@ -name: luacheck - -on: [push, pull_request] - -jobs: - build: - - runs-on: ubuntu-latest - timeout-minutes: 10 - - steps: - - uses: actions/checkout@v2.3.4 - - name: apt - run: sudo apt-get install -y luarocks - - name: luacheck install - run: luarocks install --local luacheck - - name: luacheck run - run: $HOME/.luarocks/bin/luacheck ./ diff --git a/.gitignore b/.gitignore deleted file mode 100644 index 6fd0a37..0000000 --- a/.gitignore +++ /dev/null @@ -1,41 +0,0 @@ -# Compiled Lua sources -luac.out - -# luarocks build files -*.src.rock -*.zip -*.tar.gz - -# Object files -*.o -*.os -*.ko -*.obj -*.elf - -# Precompiled Headers -*.gch -*.pch - -# Libraries -*.lib -*.a -*.la -*.lo -*.def -*.exp - -# Shared objects (inc. Windows DLLs) -*.dll -*.so -*.so.* -*.dylib - -# Executables -*.exe -*.out -*.app -*.i*86 -*.x86_64 -*.hex - diff --git a/.luacheckrc b/.luacheckrc deleted file mode 100644 index 129bb9a..0000000 --- a/.luacheckrc +++ /dev/null @@ -1,16 +0,0 @@ -allow_defined_top = true - -globals = { - "controls", -} - -read_globals = { - -- Stdlib - string = {fields = {"split"}}, - table = {fields = {"copy", "getn"}}, - - -- Minetest - "minetest", - "vector", "ItemStack", - "dump" -} diff --git a/LICENSE b/LICENSE deleted file mode 100644 index 8000a6f..0000000 --- a/LICENSE +++ /dev/null @@ -1,504 +0,0 @@ - GNU LESSER GENERAL PUBLIC LICENSE - Version 2.1, February 1999 - - Copyright (C) 1991, 1999 Free Software Foundation, Inc. - 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - -[This is the first released version of the Lesser GPL. It also counts - as the successor of the GNU Library Public License, version 2, hence - the version number 2.1.] - - Preamble - - The licenses for most software are designed to take away your -freedom to share and change it. By contrast, the GNU General Public -Licenses are intended to guarantee your freedom to share and change -free software--to make sure the software is free for all its users. - - This license, the Lesser General Public License, applies to some -specially designated software packages--typically libraries--of the -Free Software Foundation and other authors who decide to use it. You -can use it too, but we suggest you first think carefully about whether -this license or the ordinary General Public License is the better -strategy to use in any particular case, based on the explanations below. - - When we speak of free software, we are referring to freedom of use, -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 this service if you wish); that you receive source code or can get -it if you want it; that you can change the software and use pieces of -it in new free programs; and that you are informed that you can do -these things. - - To protect your rights, we need to make restrictions that forbid -distributors to deny you these rights or to ask you to surrender these -rights. These restrictions translate to certain responsibilities for -you if you distribute copies of the library or if you modify it. - - For example, if you distribute copies of the library, whether gratis -or for a fee, you must give the recipients all the rights that we gave -you. You must make sure that they, too, receive or can get the source -code. If you link other code with the library, you must provide -complete object files to the recipients, so that they can relink them -with the library after making changes to the library and recompiling -it. And you must show them these terms so they know their rights. - - We protect your rights with a two-step method: (1) we copyright the -library, and (2) we offer you this license, which gives you legal -permission to copy, distribute and/or modify the library. - - To protect each distributor, we want to make it very clear that -there is no warranty for the free library. Also, if the library is -modified by someone else and passed on, the recipients should know -that what they have is not the original version, so that the original -author's reputation will not be affected by problems that might be -introduced by others. - - Finally, software patents pose a constant threat to the existence of -any free program. We wish to make sure that a company cannot -effectively restrict the users of a free program by obtaining a -restrictive license from a patent holder. Therefore, we insist that -any patent license obtained for a version of the library must be -consistent with the full freedom of use specified in this license. - - Most GNU software, including some libraries, is covered by the -ordinary GNU General Public License. This license, the GNU Lesser -General Public License, applies to certain designated libraries, and -is quite different from the ordinary General Public License. We use -this license for certain libraries in order to permit linking those -libraries into non-free programs. - - When a program is linked with a library, whether statically or using -a shared library, the combination of the two is legally speaking a -combined work, a derivative of the original library. The ordinary -General Public License therefore permits such linking only if the -entire combination fits its criteria of freedom. The Lesser General -Public License permits more lax criteria for linking other code with -the library. - - We call this license the "Lesser" General Public License because it -does Less to protect the user's freedom than the ordinary General -Public License. It also provides other free software developers Less -of an advantage over competing non-free programs. These disadvantages -are the reason we use the ordinary General Public License for many -libraries. However, the Lesser license provides advantages in certain -special circumstances. - - For example, on rare occasions, there may be a special need to -encourage the widest possible use of a certain library, so that it becomes -a de-facto standard. To achieve this, non-free programs must be -allowed to use the library. A more frequent case is that a free -library does the same job as widely used non-free libraries. In this -case, there is little to gain by limiting the free library to free -software only, so we use the Lesser General Public License. - - In other cases, permission to use a particular library in non-free -programs enables a greater number of people to use a large body of -free software. For example, permission to use the GNU C Library in -non-free programs enables many more people to use the whole GNU -operating system, as well as its variant, the GNU/Linux operating -system. - - Although the Lesser General Public License is Less protective of the -users' freedom, it does ensure that the user of a program that is -linked with the Library has the freedom and the wherewithal to run -that program using a modified version of the Library. - - The precise terms and conditions for copying, distribution and -modification follow. Pay close attention to the difference between a -"work based on the library" and a "work that uses the library". The -former contains code derived from the library, whereas the latter must -be combined with the library in order to run. - - GNU LESSER GENERAL PUBLIC LICENSE - TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION - - 0. This License Agreement applies to any software library or other -program which contains a notice placed by the copyright holder or -other authorized party saying it may be distributed under the terms of -this Lesser General Public License (also called "this License"). -Each licensee is addressed as "you". - - A "library" means a collection of software functions and/or data -prepared so as to be conveniently linked with application programs -(which use some of those functions and data) to form executables. - - The "Library", below, refers to any such software library or work -which has been distributed under these terms. A "work based on the -Library" means either the Library or any derivative work under -copyright law: that is to say, a work containing the Library or a -portion of it, either verbatim or with modifications and/or translated -straightforwardly into another language. (Hereinafter, translation is -included without limitation in the term "modification".) - - "Source code" for a work means the preferred form of the work for -making modifications to it. For a library, complete source code means -all the source code for all modules it contains, plus any associated -interface definition files, plus the scripts used to control compilation -and installation of the library. - - Activities other than copying, distribution and modification are not -covered by this License; they are outside its scope. The act of -running a program using the Library is not restricted, and output from -such a program is covered only if its contents constitute a work based -on the Library (independent of the use of the Library in a tool for -writing it). Whether that is true depends on what the Library does -and what the program that uses the Library does. - - 1. You may copy and distribute verbatim copies of the Library's -complete source code as you receive it, in any medium, provided that -you conspicuously and appropriately publish on each copy an -appropriate copyright notice and disclaimer of warranty; keep intact -all the notices that refer to this License and to the absence of any -warranty; and distribute a copy of this License along with the -Library. - - You may charge a fee for the physical act of transferring a copy, -and you may at your option offer warranty protection in exchange for a -fee. - - 2. You may modify your copy or copies of the Library or any portion -of it, thus forming a work based on the Library, and copy and -distribute such modifications or work under the terms of Section 1 -above, provided that you also meet all of these conditions: - - a) The modified work must itself be a software library. - - b) You must cause the files modified to carry prominent notices - stating that you changed the files and the date of any change. - - c) You must cause the whole of the work to be licensed at no - charge to all third parties under the terms of this License. - - d) If a facility in the modified Library refers to a function or a - table of data to be supplied by an application program that uses - the facility, other than as an argument passed when the facility - is invoked, then you must make a good faith effort to ensure that, - in the event an application does not supply such function or - table, the facility still operates, and performs whatever part of - its purpose remains meaningful. - - (For example, a function in a library to compute square roots has - a purpose that is entirely well-defined independent of the - application. Therefore, Subsection 2d requires that any - application-supplied function or table used by this function must - be optional: if the application does not supply it, the square - root function must still compute square roots.) - -These requirements apply to the modified work as a whole. If -identifiable sections of that work are not derived from the Library, -and can be reasonably considered independent and separate works in -themselves, then this License, and its terms, do not apply to those -sections when you distribute them as separate works. But when you -distribute the same sections as part of a whole which is a work based -on the Library, the distribution of the whole must be on the terms of -this License, whose permissions for other licensees extend to the -entire whole, and thus to each and every part regardless of who wrote -it. - -Thus, it is not the intent of this section to claim rights or contest -your rights to work written entirely by you; rather, the intent is to -exercise the right to control the distribution of derivative or -collective works based on the Library. - -In addition, mere aggregation of another work not based on the Library -with the Library (or with a work based on the Library) on a volume of -a storage or distribution medium does not bring the other work under -the scope of this License. - - 3. You may opt to apply the terms of the ordinary GNU General Public -License instead of this License to a given copy of the Library. To do -this, you must alter all the notices that refer to this License, so -that they refer to the ordinary GNU General Public License, version 2, -instead of to this License. (If a newer version than version 2 of the -ordinary GNU General Public License has appeared, then you can specify -that version instead if you wish.) Do not make any other change in -these notices. - - Once this change is made in a given copy, it is irreversible for -that copy, so the ordinary GNU General Public License applies to all -subsequent copies and derivative works made from that copy. - - This option is useful when you wish to copy part of the code of -the Library into a program that is not a library. - - 4. You may copy and distribute the Library (or a portion or -derivative of it, under Section 2) in object code or executable form -under the terms of Sections 1 and 2 above provided that you accompany -it with the complete corresponding machine-readable source code, which -must be distributed under the terms of Sections 1 and 2 above on a -medium customarily used for software interchange. - - If distribution of object code is made by offering access to copy -from a designated place, then offering equivalent access to copy the -source code from the same place satisfies the requirement to -distribute the source code, even though third parties are not -compelled to copy the source along with the object code. - - 5. A program that contains no derivative of any portion of the -Library, but is designed to work with the Library by being compiled or -linked with it, is called a "work that uses the Library". Such a -work, in isolation, is not a derivative work of the Library, and -therefore falls outside the scope of this License. - - However, linking a "work that uses the Library" with the Library -creates an executable that is a derivative of the Library (because it -contains portions of the Library), rather than a "work that uses the -library". The executable is therefore covered by this License. -Section 6 states terms for distribution of such executables. - - When a "work that uses the Library" uses material from a header file -that is part of the Library, the object code for the work may be a -derivative work of the Library even though the source code is not. -Whether this is true is especially significant if the work can be -linked without the Library, or if the work is itself a library. The -threshold for this to be true is not precisely defined by law. - - If such an object file uses only numerical parameters, data -structure layouts and accessors, and small macros and small inline -functions (ten lines or less in length), then the use of the object -file is unrestricted, regardless of whether it is legally a derivative -work. (Executables containing this object code plus portions of the -Library will still fall under Section 6.) - - Otherwise, if the work is a derivative of the Library, you may -distribute the object code for the work under the terms of Section 6. -Any executables containing that work also fall under Section 6, -whether or not they are linked directly with the Library itself. - - 6. As an exception to the Sections above, you may also combine or -link a "work that uses the Library" with the Library to produce a -work containing portions of the Library, and distribute that work -under terms of your choice, provided that the terms permit -modification of the work for the customer's own use and reverse -engineering for debugging such modifications. - - You must give prominent notice with each copy of the work that the -Library is used in it and that the Library and its use are covered by -this License. You must supply a copy of this License. If the work -during execution displays copyright notices, you must include the -copyright notice for the Library among them, as well as a reference -directing the user to the copy of this License. Also, you must do one -of these things: - - a) Accompany the work with the complete corresponding - machine-readable source code for the Library including whatever - changes were used in the work (which must be distributed under - Sections 1 and 2 above); and, if the work is an executable linked - with the Library, with the complete machine-readable "work that - uses the Library", as object code and/or source code, so that the - user can modify the Library and then relink to produce a modified - executable containing the modified Library. (It is understood - that the user who changes the contents of definitions files in the - Library will not necessarily be able to recompile the application - to use the modified definitions.) - - b) Use a suitable shared library mechanism for linking with the - Library. A suitable mechanism is one that (1) uses at run time a - copy of the library already present on the user's computer system, - rather than copying library functions into the executable, and (2) - will operate properly with a modified version of the library, if - the user installs one, as long as the modified version is - interface-compatible with the version that the work was made with. - - c) Accompany the work with a written offer, valid for at - least three years, to give the same user the materials - specified in Subsection 6a, above, for a charge no more - than the cost of performing this distribution. - - d) If distribution of the work is made by offering access to copy - from a designated place, offer equivalent access to copy the above - specified materials from the same place. - - e) Verify that the user has already received a copy of these - materials or that you have already sent this user a copy. - - For an executable, the required form of the "work that uses the -Library" must include any data and utility programs needed for -reproducing the executable from it. However, as a special exception, -the materials to be distributed need not include anything that is -normally distributed (in either source or binary form) with the major -components (compiler, kernel, and so on) of the operating system on -which the executable runs, unless that component itself accompanies -the executable. - - It may happen that this requirement contradicts the license -restrictions of other proprietary libraries that do not normally -accompany the operating system. Such a contradiction means you cannot -use both them and the Library together in an executable that you -distribute. - - 7. You may place library facilities that are a work based on the -Library side-by-side in a single library together with other library -facilities not covered by this License, and distribute such a combined -library, provided that the separate distribution of the work based on -the Library and of the other library facilities is otherwise -permitted, and provided that you do these two things: - - a) Accompany the combined library with a copy of the same work - based on the Library, uncombined with any other library - facilities. This must be distributed under the terms of the - Sections above. - - b) Give prominent notice with the combined library of the fact - that part of it is a work based on the Library, and explaining - where to find the accompanying uncombined form of the same work. - - 8. You may not copy, modify, sublicense, link with, or distribute -the Library except as expressly provided under this License. Any -attempt otherwise to copy, modify, sublicense, link with, or -distribute the Library is void, and will automatically terminate your -rights under this License. However, parties who have received copies, -or rights, from you under this License will not have their licenses -terminated so long as such parties remain in full compliance. - - 9. You are not required to accept this License, since you have not -signed it. However, nothing else grants you permission to modify or -distribute the Library or its derivative works. These actions are -prohibited by law if you do not accept this License. Therefore, by -modifying or distributing the Library (or any work based on the -Library), you indicate your acceptance of this License to do so, and -all its terms and conditions for copying, distributing or modifying -the Library or works based on it. - - 10. Each time you redistribute the Library (or any work based on the -Library), the recipient automatically receives a license from the -original licensor to copy, distribute, link with or modify the Library -subject to these terms and conditions. You may not impose any further -restrictions on the recipients' exercise of the rights granted herein. -You are not responsible for enforcing compliance by third parties with -this License. - - 11. If, as a consequence of a court judgment or allegation of patent -infringement or for any other reason (not limited to patent issues), -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 -distribute so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you -may not distribute the Library at all. For example, if a patent -license would not permit royalty-free redistribution of the Library by -all those who receive copies directly or indirectly through you, then -the only way you could satisfy both it and this License would be to -refrain entirely from distribution of the Library. - -If any portion of this section is held invalid or unenforceable under any -particular circumstance, the balance of the section is intended to apply, -and the section as a whole is intended to apply in other circumstances. - -It is not the purpose of this section to induce you to infringe any -patents or other property right claims or to contest validity of any -such claims; this section has the sole purpose of protecting the -integrity of the free software distribution system which is -implemented by public license practices. Many people have made -generous contributions to the wide range of software distributed -through that system in reliance on consistent application of that -system; it is up to the author/donor to decide if he or she is willing -to distribute software through any other system and a licensee cannot -impose that choice. - -This section is intended to make thoroughly clear what is believed to -be a consequence of the rest of this License. - - 12. If the distribution and/or use of the Library is restricted in -certain countries either by patents or by copyrighted interfaces, the -original copyright holder who places the Library under this License may add -an explicit geographical distribution limitation excluding those countries, -so that distribution is permitted only in or among countries not thus -excluded. In such case, this License incorporates the limitation as if -written in the body of this License. - - 13. The Free Software Foundation may publish revised and/or new -versions of the Lesser 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 Library -specifies a version number of this License which applies to it and -"any later version", you have the option of following the terms and -conditions either of that version or of any later version published by -the Free Software Foundation. If the Library does not specify a -license version number, you may choose any version ever published by -the Free Software Foundation. - - 14. If you wish to incorporate parts of the Library into other free -programs whose distribution conditions are incompatible with these, -write to the author to ask for permission. For software which is -copyrighted by the Free Software Foundation, write to the Free -Software Foundation; we sometimes make exceptions for this. Our -decision will be guided by the two goals of preserving the free status -of all derivatives of our free software and of promoting the sharing -and reuse of software generally. - - NO WARRANTY - - 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO -WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. -EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR -OTHER PARTIES PROVIDE THE LIBRARY "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 -LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME -THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN -WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY -AND/OR REDISTRIBUTE THE LIBRARY 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 -LIBRARY (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 LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF -SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH -DAMAGES. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Libraries - - If you develop a new library, and you want it to be of the greatest -possible use to the public, we recommend making it free software that -everyone can redistribute and change. You can do so by permitting -redistribution under these terms (or, alternatively, under the terms of the -ordinary General Public License). - - To apply these terms, attach the following notices to the library. It is -safest to attach them to the start of each source file to most effectively -convey the exclusion of warranty; and each file should have at least the -"copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - This library is free software; you can redistribute it and/or - modify it under the terms of the GNU Lesser General Public - License as published by the Free Software Foundation; either - version 2.1 of the License, or (at your option) any later version. - - This library 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 - Lesser General Public License for more details. - - You should have received a copy of the GNU Lesser General Public - License along with this library; if not, write to the Free Software - Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 - USA - -Also add information on how to contact you by electronic and paper mail. - -You should also get your employer (if you work as a programmer) or your -school, if any, to sign a "copyright disclaimer" for the library, if -necessary. Here is a sample; alter the names: - - Yoyodyne, Inc., hereby disclaims all copyright interest in the - library `Frob' (a library for tweaking knobs) written by James Random - Hacker. - - , 1 April 1990 - Ty Coon, President of Vice - -That's all there is to it! diff --git a/init.lua b/init.lua deleted file mode 100644 index bc54ef4..0000000 --- a/init.lua +++ /dev/null @@ -1,71 +0,0 @@ -controls = {} -controls.players = {} - -controls.registered_on_press = {} -function controls.register_on_press(func) - controls.registered_on_press[#controls.registered_on_press+1] = func -end - -controls.registered_on_release = {} -function controls.register_on_release(func) - controls.registered_on_release[#controls.registered_on_release+1] = func -end - -controls.registered_on_hold = {} -function controls.register_on_hold(func) - controls.registered_on_hold[#controls.registered_on_hold+1]=func -end - -minetest.register_on_joinplayer(function(player) - local name = player:get_player_name() - controls.players[name] = { - jump={false}, - right={false}, - left={false}, - LMB={false}, - RMB={false}, - sneak={false}, - aux1={false}, - down={false}, - up={false}, - zoom={false}, - dig={false}, - place={false} - } -end) - -minetest.register_on_leaveplayer(function(player) - local name = player:get_player_name() - controls.players[name] = nil -end) - -minetest.register_globalstep(function() - for _, player in pairs(minetest.get_connected_players()) do - local player_name = player:get_player_name() - local player_controls = player:get_player_control() - for cname, cbool in pairs(player_controls) do - if not controls.players[player_name] then - -- player timed out but is still provided by get_connected_players(), disregard - break - end - - --Press a key - if cbool==true and controls.players[player_name][cname][1]==false then - for _, func in pairs(controls.registered_on_press) do - func(player, cname) - end - controls.players[player_name][cname] = {true, os.clock()} - elseif cbool==true and controls.players[player_name][cname][1]==true then - for _, func in pairs(controls.registered_on_hold) do - func(player, cname, os.clock()-controls.players[player_name][cname][2]) - end - --Release a key - elseif cbool==false and controls.players[player_name][cname][1]==true then - for _, func in pairs(controls.registered_on_release) do - func(player, cname, os.clock()-controls.players[player_name][cname][2]) - end - controls.players[player_name][cname] = {false} - end - end - end -end) diff --git a/mod.conf b/mod.conf deleted file mode 100644 index 8fab3aa..0000000 --- a/mod.conf +++ /dev/null @@ -1 +0,0 @@ -name=controls diff --git a/readme.md b/readme.md deleted file mode 100644 index 7d80a26..0000000 --- a/readme.md +++ /dev/null @@ -1,57 +0,0 @@ - -controls library for minetest - -![](https://github.com/mt-mods/controls/workflows/luacheck/badge.svg) -[![ContentDB](https://content.minetest.net/packages/BuckarooBanzay/controls/shields/downloads/)](https://content.minetest.net/packages/BuckarooBanzay/controls/) - -# Overview - -Utility library for control press/hold/release events - -# API - -## Supported controls - -* jump -* right -* left -* LMB -* RMB -* sneak -* aux1 -* down -* up -* zoom -* dig -* place - -## callbacks - -```lua -controls.register_on_press(function(player, control_name) - -- called on initial key-press - -- control_name: see above -end) - -controls.register_on_release(function(player, control_name, time) - -- called on key-release - -- control_name: see above - -- time: seconds the key was pressed -end) - -controls.register_on_hold(function(player, control_name, time) - -- called every globalstep if the key is pressed - -- control_name: see above - -- time: seconds the key was pressed -end) -``` - - -# References - -used by https://github.com/Arcelmi/minetest-bows.git -Original repo: https://github.com/Arcelmi/minetest-controls - -# License - -LGPL 2.1 (see `LICENSE` file) From a56de07635d7f03168619a8548334322492a1d51 Mon Sep 17 00:00:00 2001 From: wsor4035 <24964441+wsor4035@users.noreply.github.com> Date: Sun, 3 Dec 2023 14:29:42 -0500 Subject: [PATCH 02/14] add biolerplate basic mod setup --- .github/workflows/luacheck.yml | 10 ++++++++++ .luacheckrc | 25 +++++++++++++++++++++++++ init.lua | 0 license | 24 ++++++++++++++++++++++++ 4 files changed, 59 insertions(+) create mode 100644 .github/workflows/luacheck.yml create mode 100644 .luacheckrc create mode 100644 init.lua create mode 100644 license diff --git a/.github/workflows/luacheck.yml b/.github/workflows/luacheck.yml new file mode 100644 index 0000000..b501650 --- /dev/null +++ b/.github/workflows/luacheck.yml @@ -0,0 +1,10 @@ +name: luacheck +on: [push, pull_request] +jobs: + luacheck: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@master + - name: Luacheck + uses: lunarmodules/luacheck@master \ No newline at end of file diff --git a/.luacheckrc b/.luacheckrc new file mode 100644 index 0000000..830ebfd --- /dev/null +++ b/.luacheckrc @@ -0,0 +1,25 @@ +unused_args = false +allow_defined_top = true + +exclude_files = {".luacheckrc"} + +globals = { + "minetest", "core", + + --mod provided + +} + +read_globals = { + string = {fields = {"split"}}, + table = {fields = {"copy", "getn"}}, + + --luac + "math", "table", + + -- Builtin + "vector", "ItemStack", "dump", "DIR_DELIM", "VoxelArea", "Settings", "PcgRandom", "VoxelManip", "PseudoRandom", + + --mod produced + +} \ No newline at end of file diff --git a/init.lua b/init.lua new file mode 100644 index 0000000..e69de29 diff --git a/license b/license new file mode 100644 index 0000000..0f696e4 --- /dev/null +++ b/license @@ -0,0 +1,24 @@ +License of source code +---------------------- + +The MIT License (MIT) + +Copyright (c) 2023 wsor4035(aka wsor) + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. \ No newline at end of file From 6b324423683a8c61118d0b307673d5f7baa6ed4c Mon Sep 17 00:00:00 2001 From: wsor4035 <24964441+wsor4035@users.noreply.github.com> Date: Sun, 3 Dec 2023 14:44:29 -0500 Subject: [PATCH 03/14] add intial api layout and a test mode --- .luacheckrc | 2 +- init.lua | 21 +++++++++++++++++++++ settingtypes.txt | 1 + test.lua | 11 +++++++++++ 4 files changed, 34 insertions(+), 1 deletion(-) create mode 100644 settingtypes.txt create mode 100644 test.lua diff --git a/.luacheckrc b/.luacheckrc index 830ebfd..d9b2fbe 100644 --- a/.luacheckrc +++ b/.luacheckrc @@ -7,7 +7,7 @@ globals = { "minetest", "core", --mod provided - + "controls", } read_globals = { diff --git a/init.lua b/init.lua index e69de29..8e11cc2 100644 --- a/init.lua +++ b/init.lua @@ -0,0 +1,21 @@ +controls = { + modpath = minetest.get_modpath("controls"), + testsmode = minetest.settings:get_bool("controls_enable_tests", false) +} + +--api functions +function controls.register_on_press(callback) + +end + +function controls.register_on_hold(callback) + +end + +function controls.register_on_release(callback) + +end + +if(controls.testsmode) then + dofile(controls.modpath .. "/test.lua") +end \ No newline at end of file diff --git a/settingtypes.txt b/settingtypes.txt new file mode 100644 index 0000000..68a05d8 --- /dev/null +++ b/settingtypes.txt @@ -0,0 +1 @@ +controls_enable_tests (enable testing mode for player controls) bool false \ No newline at end of file diff --git a/test.lua b/test.lua new file mode 100644 index 0000000..6d0be2c --- /dev/null +++ b/test.lua @@ -0,0 +1,11 @@ +controls.register_on_press(function(player, key) + minetest.chat_send_all(player:get_player_name() .. " pressed " .. key) +end) + +controls.register_on_hold(function(player, key, length) + minetest.chat_send_all(player:get_player_name() .. " held " .. key .. " for " .. length .. " seconds") +end) + +controls.register_on_release(function(player, key, length) + minetest.chat_send_all(player:get_player_name() .. " released " .. key .. " after " .. length .. " seconds") +end) \ No newline at end of file From af05a85d89bcee8718459752f91039092965b933 Mon Sep 17 00:00:00 2001 From: wsor4035 <24964441+wsor4035@users.noreply.github.com> Date: Sun, 3 Dec 2023 14:51:55 -0500 Subject: [PATCH 04/14] store callbacks in the traditional minetest way, expand tests --- init.lua | 14 ++++++++++---- test.lua | 7 +++++++ 2 files changed, 17 insertions(+), 4 deletions(-) diff --git a/init.lua b/init.lua index 8e11cc2..235a3fc 100644 --- a/init.lua +++ b/init.lua @@ -1,19 +1,25 @@ controls = { + --util values modpath = minetest.get_modpath("controls"), - testsmode = minetest.settings:get_bool("controls_enable_tests", false) + testsmode = minetest.settings:get_bool("controls_enable_tests", false), + + --location to store callbacks + registered_on_press = {}, + registered_on_hold = {}, + registered_on_release = {}, } --api functions function controls.register_on_press(callback) - + table.insert(controls.registered_on_press, callback) end function controls.register_on_hold(callback) - + table.insert(controls.registered_on_hold, callback) end function controls.register_on_release(callback) - + table.insert(controls.registered_on_release, callback) end if(controls.testsmode) then diff --git a/test.lua b/test.lua index 6d0be2c..9f74784 100644 --- a/test.lua +++ b/test.lua @@ -8,4 +8,11 @@ end) controls.register_on_release(function(player, key, length) minetest.chat_send_all(player:get_player_name() .. " released " .. key .. " after " .. length .. " seconds") +end) + +minetest.register_on_joinplayer(function(player, _) + local pname = player:get_player_name() + minetest.chat_send_player(pname, #controls.registered_on_press .. " registered_on_press callbacks") + minetest.chat_send_player(pname, #controls.registered_on_hold .. " registered_on_hold callbacks") + minetest.chat_send_player(pname, #controls.registered_on_release .. " registered_on_release callbacks") end) \ No newline at end of file From 360c8ce98b4c54e7f9be7c4d8ba4d30c7acdd355 Mon Sep 17 00:00:00 2001 From: wsor4035 <24964441+wsor4035@users.noreply.github.com> Date: Sun, 3 Dec 2023 15:03:02 -0500 Subject: [PATCH 05/14] set up player key store on join --- init.lua | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/init.lua b/init.lua index 235a3fc..baa64bf 100644 --- a/init.lua +++ b/init.lua @@ -7,6 +7,9 @@ controls = { registered_on_press = {}, registered_on_hold = {}, registered_on_release = {}, + + --store player control data + players = {}, } --api functions @@ -22,6 +25,18 @@ function controls.register_on_release(callback) table.insert(controls.registered_on_release, callback) end +minetest.register_on_joinplayer(function(player, _) + local pname = player:get_player_name() + local controls_names = player:get_player_control() + + --note: could hardcode this, but this is more future proof in case minetest adds more controls + controls.players[pname] = {} + for key, _ in pairs(controls_names) do + controls.players[pname][key] = {false} --in theory its false when they join, but hard coding just in case + end +end) + +--tests if(controls.testsmode) then dofile(controls.modpath .. "/test.lua") end \ No newline at end of file From 86eb7ca6047d2e763af6373cc10e37e61be9fa64 Mon Sep 17 00:00:00 2001 From: wsor4035 <24964441+wsor4035@users.noreply.github.com> Date: Sun, 3 Dec 2023 15:13:16 -0500 Subject: [PATCH 06/14] initial event loop and callback testing --- init.lua | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/init.lua b/init.lua index baa64bf..08ecfb3 100644 --- a/init.lua +++ b/init.lua @@ -25,6 +25,7 @@ function controls.register_on_release(callback) table.insert(controls.registered_on_release, callback) end +--set up key store on join minetest.register_on_joinplayer(function(player, _) local pname = player:get_player_name() local controls_names = player:get_player_control() @@ -36,6 +37,30 @@ minetest.register_on_joinplayer(function(player, _) end end) +--discard when leaving +minetest.register_on_leaveplayer(function(player, _) + local pname = player:get_player_name() + controls.players[pname] = nil +end) + +--event loop +minetest.register_globalstep(function(dtime) + for _, player in pairs(minetest.get_connected_players()) do + local pname = player:get_player_name() + local pcontrols = player:get_player_control() + + if not controls.players[pname] then break end --safety check + + for key, key_status in pairs(pcontrols) do + if(key_status) then --yes, this is a hold or press event, intial testing + for _, callback in pairs(controls.registered_on_press) do + callback(player, key) + end + end + end + end +end) + --tests if(controls.testsmode) then dofile(controls.modpath .. "/test.lua") From 2cdcadf6d1a2e981cb4127fd2e3b2a7549593238 Mon Sep 17 00:00:00 2001 From: wsor4035 <24964441+wsor4035@users.noreply.github.com> Date: Sun, 3 Dec 2023 15:15:07 -0500 Subject: [PATCH 07/14] send test data per player as to not be spam nightmare when testing with multiple players --- test.lua | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/test.lua b/test.lua index 9f74784..3bb2e67 100644 --- a/test.lua +++ b/test.lua @@ -1,13 +1,16 @@ controls.register_on_press(function(player, key) - minetest.chat_send_all(player:get_player_name() .. " pressed " .. key) + local pname = player:get_player_name() + minetest.chat_send_player(pname, pname .. " pressed " .. key) end) controls.register_on_hold(function(player, key, length) - minetest.chat_send_all(player:get_player_name() .. " held " .. key .. " for " .. length .. " seconds") + local pname = player:get_player_name() + minetest.chat_send_player(pname, pname .. " held " .. key .. " for " .. length .. " seconds") end) controls.register_on_release(function(player, key, length) - minetest.chat_send_all(player:get_player_name() .. " released " .. key .. " after " .. length .. " seconds") + local pname = player:get_player_name() + minetest.chat_send_player(pname, pname .. " released " .. key .. " after " .. length .. " seconds") end) minetest.register_on_joinplayer(function(player, _) From 9625ab4b153ca02a328c456302661097e6c2b4a6 Mon Sep 17 00:00:00 2001 From: wsor4035 <24964441+wsor4035@users.noreply.github.com> Date: Sun, 3 Dec 2023 15:17:08 -0500 Subject: [PATCH 08/14] add mod.conf --- mod.conf | 2 ++ 1 file changed, 2 insertions(+) create mode 100644 mod.conf diff --git a/mod.conf b/mod.conf new file mode 100644 index 0000000..a27ca56 --- /dev/null +++ b/mod.conf @@ -0,0 +1,2 @@ +name=controls +description=util library for subscribing to events \ No newline at end of file From 4065c68807542264576bdcb31a76bbc8ad622634 Mon Sep 17 00:00:00 2001 From: wsor4035 <24964441+wsor4035@users.noreply.github.com> Date: Sun, 3 Dec 2023 15:31:47 -0500 Subject: [PATCH 09/14] make all the callbacks work --- init.lua | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/init.lua b/init.lua index 08ecfb3..9d4c577 100644 --- a/init.lua +++ b/init.lua @@ -33,7 +33,11 @@ minetest.register_on_joinplayer(function(player, _) --note: could hardcode this, but this is more future proof in case minetest adds more controls controls.players[pname] = {} for key, _ in pairs(controls_names) do - controls.players[pname][key] = {false} --in theory its false when they join, but hard coding just in case + --[[ + in theory the control value is false when they join, but hard coding just in case + consider changing this to named key table instead of numeric for better readability??? + ]] + controls.players[pname][key] = {false} end end) @@ -51,11 +55,23 @@ minetest.register_globalstep(function(dtime) if not controls.players[pname] then break end --safety check + --consider using minetest.get_us_time() instead of os.clock()? would need to convert to seconds however for key, key_status in pairs(pcontrols) do - if(key_status) then --yes, this is a hold or press event, intial testing + if key_status and controls.players[pname][key][1]==false then + --minetest.chat_send_all("hiii") for _, callback in pairs(controls.registered_on_press) do callback(player, key) end + controls.players[pname][key] = {true, os.clock()} + elseif key_status and controls.players[pname][key][1]==true then + for _, callback in pairs(controls.registered_on_hold) do + callback(player, key, os.clock() - controls.players[pname][key][2]) + end + elseif key_status==false and controls.players[pname][key][1]==true then + for _, callback in pairs(controls.registered_on_release) do + callback(player, key, os.clock() - controls.players[pname][key][2]) + end + controls.players[pname][key] = {false} end end end From 521d68c7676ed0553ef667a0ab2fefb66304bfe2 Mon Sep 17 00:00:00 2001 From: wsor4035 <24964441+wsor4035@users.noreply.github.com> Date: Sun, 3 Dec 2023 15:32:47 -0500 Subject: [PATCH 10/14] syntactic sugar --- init.lua | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/init.lua b/init.lua index 9d4c577..80cd450 100644 --- a/init.lua +++ b/init.lua @@ -67,7 +67,7 @@ minetest.register_globalstep(function(dtime) for _, callback in pairs(controls.registered_on_hold) do callback(player, key, os.clock() - controls.players[pname][key][2]) end - elseif key_status==false and controls.players[pname][key][1]==true then + elseif not key_status and controls.players[pname][key][1]==true then for _, callback in pairs(controls.registered_on_release) do callback(player, key, os.clock() - controls.players[pname][key][2]) end From d3554d2702d061dec7522180cf2427243e171335 Mon Sep 17 00:00:00 2001 From: wsor4035 <24964441+wsor4035@users.noreply.github.com> Date: Sun, 3 Dec 2023 15:33:22 -0500 Subject: [PATCH 11/14] remove commented out lazy debug message --- init.lua | 1 - 1 file changed, 1 deletion(-) diff --git a/init.lua b/init.lua index 80cd450..f645356 100644 --- a/init.lua +++ b/init.lua @@ -58,7 +58,6 @@ minetest.register_globalstep(function(dtime) --consider using minetest.get_us_time() instead of os.clock()? would need to convert to seconds however for key, key_status in pairs(pcontrols) do if key_status and controls.players[pname][key][1]==false then - --minetest.chat_send_all("hiii") for _, callback in pairs(controls.registered_on_press) do callback(player, key) end From 5c487bd11a48f65bedc6c9d73bf27cd093edc96d Mon Sep 17 00:00:00 2001 From: wsor4035 <24964441+wsor4035@users.noreply.github.com> Date: Sun, 3 Dec 2023 15:36:53 -0500 Subject: [PATCH 12/14] more sugar --- init.lua | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/init.lua b/init.lua index f645356..c38f0dc 100644 --- a/init.lua +++ b/init.lua @@ -57,16 +57,16 @@ minetest.register_globalstep(function(dtime) --consider using minetest.get_us_time() instead of os.clock()? would need to convert to seconds however for key, key_status in pairs(pcontrols) do - if key_status and controls.players[pname][key][1]==false then + if key_status and not controls.players[pname][key][1] then for _, callback in pairs(controls.registered_on_press) do callback(player, key) end controls.players[pname][key] = {true, os.clock()} - elseif key_status and controls.players[pname][key][1]==true then + elseif key_status and controls.players[pname][key][1] then for _, callback in pairs(controls.registered_on_hold) do callback(player, key, os.clock() - controls.players[pname][key][2]) end - elseif not key_status and controls.players[pname][key][1]==true then + elseif not key_status and controls.players[pname][key][1] then for _, callback in pairs(controls.registered_on_release) do callback(player, key, os.clock() - controls.players[pname][key][2]) end From c712bf662c0eb2aaf9bcd91f41e9c61ecfc608e6 Mon Sep 17 00:00:00 2001 From: wsor4035 <24964441+wsor4035@users.noreply.github.com> Date: Sun, 3 Dec 2023 15:42:52 -0500 Subject: [PATCH 13/14] add spartan readme --- readme.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 readme.md diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..108f4a1 --- /dev/null +++ b/readme.md @@ -0,0 +1,25 @@ +# api + +note: supports all keys minetest does + +```lua +controls.register_on_press(function(player, key) + -- called on key down + -- @player: player object + -- @key: key pressed +end) + +controls.register_on_hold(function(player, key, length) + -- called while key is held + -- @player: player object + -- @key: key pressed + -- @length: length of time key was held in seconds +end) + +controls.register_on_release(function(player, key, length) + -- called on key up + -- @player: player object + -- @key: key pressed + -- @length: length of time key was held in seconds +end) +``` \ No newline at end of file From 75544e1a6f2e5bc16792ecb1cbe5f88faaf9693b Mon Sep 17 00:00:00 2001 From: wsor4035 <24964441+wsor4035@users.noreply.github.com> Date: Sun, 3 Dec 2023 16:30:49 -0500 Subject: [PATCH 14/14] make luk3yx timing change --- init.lua | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/init.lua b/init.lua index c38f0dc..1231935 100644 --- a/init.lua +++ b/init.lua @@ -61,14 +61,14 @@ minetest.register_globalstep(function(dtime) for _, callback in pairs(controls.registered_on_press) do callback(player, key) end - controls.players[pname][key] = {true, os.clock()} + controls.players[pname][key] = {true, minetest.get_us_time()} elseif key_status and controls.players[pname][key][1] then for _, callback in pairs(controls.registered_on_hold) do - callback(player, key, os.clock() - controls.players[pname][key][2]) + callback(player, key, (minetest.get_us_time() - controls.players[pname][key][2]) / 1e6) end elseif not key_status and controls.players[pname][key][1] then for _, callback in pairs(controls.registered_on_release) do - callback(player, key, os.clock() - controls.players[pname][key][2]) + callback(player, key, (minetest.get_us_time() - controls.players[pname][key][2]) / 1e6) end controls.players[pname][key] = {false} end