Minor improvements and changes

.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@v4
+      - name: Luacheck
+        uses: lunarmodules/luacheck@master

.luacheckrc

@@ -1,3 +1,12 @@
 allow_defined_top = true
 unused_args = false
 max_line_length = 999
+
+read_globals = {
+  string = {fields = {"split", "trim"}},
+  table = {fields = {"copy", "getn"}},
+}
+
+globals = {
+  "minetest", "player_api", "vector", "armor"
+}

LICENSE.md

@@ -1,4 +1,46 @@
-# GNU LESSER GENERAL PUBLIC LICENSE
+# License for textures/media
+
+Copyright (C) 2023 David Leal ([email protected])\
+Copyright (C) Various other Minetest developers/contributors
+
+[David Leal](https://github.com/Panquesito7) ([CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/)):
+
+- All sounds and textures in the `textures/` and `sounds/` folders.
+
+[Mircea Kitsune](https://github.com/MirceaKitsune) and [contributors](https://github.com/minetest/minetest_game/blob/master/mods/player_api/README.txt#L17-L18) ([CC BY-SA 3.0](https://creativecommons.org/licenses/by-sa/3.0/)):
+
+- `models/character_wj.b3d` - [`models/character.b3d`](https://github.com/minetest/minetest_game/blob/master/mods/player_api/models/character.b3d)
+- `models/character.blend` - [`models/character.blend`](https://github.com/minetest/minetest_game/blob/master/mods/player_api/models/character.blend)
+
+## [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/) license statement
+
+### You are free to
+
+**Share** — copy and redistribute the material in any medium or format.\
+**Adapt** — remix, transform, and build upon the material
+for any purpose, even commercially.
+
+_The licensor cannot revoke these freedoms as long as you follow the license terms._
+
+### Under the following terms
+
+**Attribution** — You must give [appropriate credit](https://wiki.creativecommons.org/wiki/License_Versions#Detailed_attribution_comparison_chart), provide a link to the license, and [indicate if changes were made](https://wiki.creativecommons.org/wiki/License_Versions#Modifications_and_adaptations_must_be_marked_as_such). You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.\
+**ShareAlike** — If you remix, transform, or build upon the material, you must distribute your contributions under the [same license](https://creativecommons.org/share-your-work/licensing-considerations/compatible-licenses) as the original.
+
+**No additional restrictions** — You may not apply legal terms or [technological measures](https://wiki.creativecommons.org/wiki/License_Versions#Application_of_effective_technological_measures_by_users_of_CC-licensed_works_prohibited) that legally restrict others from doing anything the license permits.
+
+### Notices
+
+You do not have to comply with the license for elements of the material in the public domain or where your use is permitted by an applicable [exception or limitation](https://creativecommons.org/faq/#Do_Creative_Commons_licenses_affect_exceptions_and_limitations_to_copyright.2C_such_as_fair_dealing_and_fair_use.3F).\
+No warranties are given. The license may not give you all of the permissions necessary for your intended use. For example, other rights such as [publicity, privacy, or moral rights](https://wiki.creativecommons.org/wiki/Considerations_for_licensors_and_licensees) may limit how you use the material.
+
+### For more details
+
+<https://creativecommons.org/licenses/by-sa/4.0/>
+
+## License for source code
+
+                    GNU LESSER GENERAL PUBLIC LICENSE
 
 Version 2.1, February 1999
 

README.md

@@ -1,5 +1,10 @@
 # Minetest Wall Jump
 
+> **Note**
+>
+> The mod is still WIP and is still missing a lot of stuff, cleanup, and other things.\
+> However, it is very stable and playable without any major issues. Thank you!
+
 Allows the player to perform multiple wall jumps on Minetest!\
 The mod has a variety of settings and customizations, from the number of wall jumps to configuring all the values for specific nodes or groups, which allows you to create a unique experience for your server. You can also configure specific armors to have different physics and values.
 
@@ -8,12 +13,16 @@ The mod has a variety of settings and customizations, from the number of wall ju
 
 ## Settings
 
+TODO: Add a list of settings found in settingtypes.txt here
+
 <!-- Add a list of settings found in settingtypes.txt here -->
 
 To configure the Realistic Mode (RLM), check out the `realistic_mode.lua` file.
 
 ### Configuring the RLM mode
 
+TODO: Add a guide on how to configure the RLM mode
+
 <!-- Add a guide on how to configure the RLM mode -->
 
 ## Known bugs
@@ -44,3 +53,4 @@ For further information or help, see:\
 - Add an in-game RLM configuration menu (?).
 - Adjust the readme.
 - Update the sounds to have higher quality.
+- Clean up and tweak the code.

init.lua

@@ -163,7 +163,6 @@ local function is_player_on_block(player, get_data, y_vel)
     }
 
     local closest_node_pos, closest_offset, closest_node = nil, nil, nil
-    local closest_distance = math.huge
 
     for _, offset in pairs(offsets) do
         local node_pos = vector.add(pos, offset)
@@ -174,8 +173,7 @@ local function is_player_on_block(player, get_data, y_vel)
         if node_def and node_def.walkable then
             if get_data then
                 local distance = vector.distance(pos, node_pos)
-                if distance < closest_distance then
-                    closest_distance = distance
+                if distance < math.huge then
                     closest_node_pos = node_pos
                     closest_offset = offset
                     closest_node = node.name
@@ -598,8 +596,6 @@ local function player_jump(player, dtime)
                 local node_pos, node_dir, name = is_player_on_block(player, true)
                 local def = minetest.registered_nodes[name]
                 if node_pos then
-                    pos = player:get_pos()
-
                     -- Particle effects.
                     local particle_def = {
                         amount = 1,

realistic_mode.lua

@@ -80,7 +80,7 @@ wall_jump.realistic_mode.nodes = { }
 -- 3D Armor settings.
 wall_jump.realistic_mode.armor = { }
 
-local realistic_mode = minetest.settings:get_bool("wall_jump.rlm") or true -- FALSE BY DEFAULT!
+local realistic_mode = minetest.settings:get_bool("wall_jump.rlm") or false
 local mode_only = minetest.settings:get("wall_jump.rlm.only_mode") or "both"
 
 local keep_def_settings = minetest.settings:get_bool("wall_jump.rlm.keep_default_settings") or true