Standardize

.github/workflows/luacheck.yml

@@ -1,13 +1,10 @@
 name: luacheck
 on: [push, pull_request]
 jobs:
-  build:
+  luacheck:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@master
-    - 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 ./
+      - name: Checkout
+        uses: actions/checkout@main
+      - name: Luacheck
+        uses: lunarmodules/luacheck@master

.luacheckrc

@@ -1,7 +1,12 @@
 globals = {
-    "minetest", "basic_materials", "crafting",
+	"basic_materials"
 }
 
 read_globals = {
-    "default", "xcompat",
+	-- Luanti
+	"minetest", "core",
+
+	-- Dependencies
+	"default", "xcompat",
+	"crafting"
 }

README.md

@@ -1,23 +1,17 @@
 # Basic Materials mod
 
-mod that adds basic material nodes and items
+[![ContentDB](https://content.luanti.org/packages/mt-mods/basic_materials/shields/downloads/)](https://content.luanti.org/packages/mt-mods/basic_materials/)
+[![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0)
+_[Forum Topic](https://forum.luanti.org/viewtopic.php?t=21000)_
 
-## Install
+Provides a small selection of "basic" materials and items, things like steel bars and chains, wire, plastic strips and sheets, and more.
 
-### Option 1: use content tab in minetest
+## Dependencies
 
-* click the content tab
-* search for basic materials
-* click install on basic materials
+- Luanti/Minetest v5.10
+- [Xcompat](https://github.com/mt-mods/xcompat)
 
-### Option 2: download from [ContentDB](https://content.minetest.net/packages/VanessaE/basic_materials/)
+## License
 
-* click the above link or search for basic materials on ContentDB
-* select the download button on the basic materials page
-* extract the zip downloaded from the previous step
-* place in your mods folder
-
-### Option 3: use git
-
-* `git clone https://github.com/mt-mods/basic_materials.git`
-* `cd basic_materials`
+Code: [LGPL v3](https://www.gnu.org/licenses/lgpl-3.0#license-text)
+Media: [CC-by-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/legalcode.txt)

aliases.lua

@@ -1,34 +1,34 @@
-minetest.register_alias("homedecor:plastic_sheeting", "basic_materials:plastic_sheet")
-minetest.register_alias("homedecor:plastic_strips",   "basic_materials:plastic_strip")
-minetest.register_alias("homedecor:empty_spool",      "basic_materials:empty_spool")
-minetest.register_alias("homedecor:oil_extract",      "basic_materials:oil_extract")
-minetest.register_alias("homedecor:paraffin",         "basic_materials:paraffin")
-minetest.register_alias("homedecor:plastic_base",     "basic_materials:paraffin")
-minetest.register_alias("homedecor:terracotta_base",  "basic_materials:terracotta_base")
-minetest.register_alias("gloopblocks:wet_cement",     "basic_materials:wet_cement")
-minetest.register_alias("gloopblocks:cement",         "basic_materials:cement_block")
-minetest.register_alias("technic:concrete",           "basic_materials:concrete_block")
-minetest.register_alias("homedecor:ic",                     "basic_materials:ic")
-minetest.register_alias("homedecor:motor",                  "basic_materials:motor")
-minetest.register_alias("technic:motor",                    "basic_materials:motor")
-minetest.register_alias("homedecor:heating_element",        "basic_materials:heating_element")
-minetest.register_alias("homedecor:power_crystal",          "basic_materials:energy_crystal_simple")
-minetest.register_alias("homedecor:copper_wire",           "basic_materials:copper_wire")
-minetest.register_alias("technic:fine_copper_wire",        "basic_materials:copper_wire")
-minetest.register_alias("technic:fine_silver_wire",        "basic_materials:silver_wire")
-minetest.register_alias("technic:fine_gold_wire",          "basic_materials:gold_wire")
-minetest.register_alias("homedecor:steel_wire",            "basic_materials:steel_wire")
-minetest.register_alias("homedecor:brass_ingot",           "basic_materials:brass_ingot")
-minetest.register_alias("technic:brass_ingot",             "basic_materials:brass_ingot")
-minetest.register_alias("technic:brass_block",             "basic_materials:brass_block")
-minetest.register_alias("homedecor:copper_strip",          "basic_materials:copper_strip")
-minetest.register_alias("homedecor:steel_strip",           "basic_materials:steel_strip")
-minetest.register_alias("homedecor:chainlink_brass",       "basic_materials:chainlink_brass")
-minetest.register_alias("chains:chain",                    "basic_materials:chain_steel")
-minetest.register_alias("chains:chain_brass",              "basic_materials:chain_brass")
-minetest.register_alias("pipeworks:gear",                  "basic_materials:gear_steel")
-minetest.register_alias("technic:rebar",                  "basic_materials:steel_bar")
+core.register_alias("homedecor:plastic_sheeting", "basic_materials:plastic_sheet")
+core.register_alias("homedecor:plastic_strips", "basic_materials:plastic_strip")
+core.register_alias("homedecor:empty_spool", "basic_materials:empty_spool")
+core.register_alias("homedecor:oil_extract", "basic_materials:oil_extract")
+core.register_alias("homedecor:paraffin", "basic_materials:paraffin")
+core.register_alias("homedecor:plastic_base", "basic_materials:paraffin")
+core.register_alias("homedecor:terracotta_base", "basic_materials:terracotta_base")
+core.register_alias("gloopblocks:wet_cement", "basic_materials:wet_cement")
+core.register_alias("gloopblocks:cement", "basic_materials:cement_block")
+core.register_alias("technic:concrete", "basic_materials:concrete_block")
+core.register_alias("homedecor:ic", "basic_materials:ic")
+core.register_alias("homedecor:motor", "basic_materials:motor")
+core.register_alias("technic:motor", "basic_materials:motor")
+core.register_alias("homedecor:heating_element", "basic_materials:heating_element")
+core.register_alias("homedecor:power_crystal", "basic_materials:energy_crystal_simple")
+core.register_alias("homedecor:copper_wire", "basic_materials:copper_wire")
+core.register_alias("technic:fine_copper_wire", "basic_materials:copper_wire")
+core.register_alias("technic:fine_silver_wire", "basic_materials:silver_wire")
+core.register_alias("technic:fine_gold_wire", "basic_materials:gold_wire")
+core.register_alias("homedecor:steel_wire", "basic_materials:steel_wire")
+core.register_alias("homedecor:brass_ingot", "basic_materials:brass_ingot")
+core.register_alias("technic:brass_ingot", "basic_materials:brass_ingot")
+core.register_alias("technic:brass_block", "basic_materials:brass_block")
+core.register_alias("homedecor:copper_strip", "basic_materials:copper_strip")
+core.register_alias("homedecor:steel_strip", "basic_materials:steel_strip")
+core.register_alias("homedecor:chainlink_brass", "basic_materials:chainlink_brass")
+core.register_alias("chains:chain", "basic_materials:chain_steel")
+core.register_alias("chains:chain_brass", "basic_materials:chain_brass")
+core.register_alias("pipeworks:gear", "basic_materials:gear_steel")
+core.register_alias("technic:rebar", "basic_materials:steel_bar")
 
-minetest.register_alias_force("mesecons_materials:silicon", "basic_materials:silicon")
-minetest.register_alias_force("glooptest:chainlink",       "basic_materials:chainlink_steel")
-minetest.register_alias_force("homedecor:chainlink_steel", "basic_materials:chainlink_steel")
+core.register_alias_force("mesecons_materials:silicon", "basic_materials:silicon")
+core.register_alias_force("glooptest:chainlink", "basic_materials:chainlink_steel")
+core.register_alias_force("homedecor:chainlink_steel", "basic_materials:chainlink_steel")

craftitems.lua

@@ -1,188 +1,187 @@
-local S = minetest.get_translator("basic_materials")
+local S = core.get_translator("basic_materials")
 
-minetest.register_craftitem("basic_materials:plastic_sheet", {
+core.register_craftitem("basic_materials:plastic_sheet", {
 	description = S("Plastic sheet"),
 	inventory_image = "basic_materials_plastic_sheet.png",
 })
 
-minetest.register_craftitem("basic_materials:plastic_strip", {
+core.register_craftitem("basic_materials:plastic_strip", {
 	description = S("Plastic strips"),
 	groups = { strip = 1 },
 	inventory_image = "basic_materials_plastic_strip.png",
 })
 
-minetest.register_craftitem("basic_materials:empty_spool", {
+core.register_craftitem("basic_materials:empty_spool", {
 	description = S("Empty wire spool"),
-	inventory_image = "basic_materials_empty_spool.png"
+	inventory_image = "basic_materials_empty_spool.png",
 })
 
-minetest.register_craftitem("basic_materials:oil_extract", {
+core.register_craftitem("basic_materials:oil_extract", {
 	description = S("Oil extract"),
 	inventory_image = "basic_materials_oil_extract.png",
 })
 
-minetest.register_craftitem("basic_materials:paraffin", {
+core.register_craftitem("basic_materials:paraffin", {
 	description = S("Unprocessed paraffin"),
 	inventory_image = "basic_materials_paraffin.png",
 })
 
-minetest.register_craftitem("basic_materials:terracotta_base", {
+core.register_craftitem("basic_materials:terracotta_base", {
 	description = S("Uncooked Terracotta Base"),
 	inventory_image = "basic_materials_terracotta_base.png",
 })
 
-minetest.register_craftitem("basic_materials:wet_cement", {
+core.register_craftitem("basic_materials:wet_cement", {
 	description = S("Wet Cement"),
 	inventory_image = "basic_materials_wet_cement.png",
 })
 
-minetest.register_craftitem("basic_materials:silicon", {
+core.register_craftitem("basic_materials:silicon", {
 	description = S("Silicon lump"),
 	inventory_image = "basic_materials_silicon.png",
 })
 
-minetest.register_craftitem("basic_materials:ic", {
+core.register_craftitem("basic_materials:ic", {
 	description = S("Simple Integrated Circuit"),
 	inventory_image = "basic_materials_ic.png",
 })
 
-minetest.register_craftitem("basic_materials:motor", {
+core.register_craftitem("basic_materials:motor", {
 	description = S("Simple Motor"),
 	inventory_image = "basic_materials_motor.png",
 })
 
-minetest.register_craftitem("basic_materials:heating_element", {
+core.register_craftitem("basic_materials:heating_element", {
 	description = S("Heating element"),
 	inventory_image = "basic_materials_heating_element.png",
 })
 
-minetest.register_craftitem("basic_materials:energy_crystal_simple", {
+core.register_craftitem("basic_materials:energy_crystal_simple", {
 	description = S("Simple energy crystal"),
 	inventory_image = "basic_materials_energy_crystal.png",
 })
 
-minetest.register_craftitem("basic_materials:steel_wire", {
+core.register_craftitem("basic_materials:steel_wire", {
 	description = S("Spool of steel wire"),
 	groups = { wire = 1 },
-	inventory_image = "basic_materials_steel_wire.png"
+	inventory_image = "basic_materials_steel_wire.png",
 })
 
-minetest.register_craftitem("basic_materials:copper_wire", {
+core.register_craftitem("basic_materials:copper_wire", {
 	description = S("Spool of copper wire"),
 	groups = { wire = 1 },
-	inventory_image = "basic_materials_copper_wire.png"
+	inventory_image = "basic_materials_copper_wire.png",
 })
 
-minetest.register_craftitem("basic_materials:silver_wire", {
+core.register_craftitem("basic_materials:silver_wire", {
 	description = S("Spool of silver wire"),
 	groups = { wire = 1 },
-	inventory_image = "basic_materials_silver_wire.png"
+	inventory_image = "basic_materials_silver_wire.png",
 })
 
-minetest.register_craftitem("basic_materials:gold_wire", {
+core.register_craftitem("basic_materials:gold_wire", {
 	description = S("Spool of gold wire"),
 	groups = { wire = 1 },
-	inventory_image = "basic_materials_gold_wire.png"
+	inventory_image = "basic_materials_gold_wire.png",
 })
 
-minetest.register_craftitem("basic_materials:stainless_steel_wire", {
+core.register_craftitem("basic_materials:stainless_steel_wire", {
 	description = S("Spool of stainless steel wire"),
 	groups = { wire = 1 },
-	inventory_image = "basic_materials_stainless_steel_wire.png"
+	inventory_image = "basic_materials_stainless_steel_wire.png",
 })
 
-minetest.register_craftitem("basic_materials:aluminum_wire", {
+core.register_craftitem("basic_materials:aluminum_wire", {
 	description = S("Spool of aluminum wire"),
 	groups = { wire = 1 },
-	inventory_image = "basic_materials_aluminum_wire.png"
+	inventory_image = "basic_materials_aluminum_wire.png",
 })
 
-minetest.register_craftitem("basic_materials:steel_strip", {
+core.register_craftitem("basic_materials:steel_strip", {
 	description = S("Steel Strip"),
 	groups = { strip = 1 },
-	inventory_image = "basic_materials_steel_strip.png"
+	inventory_image = "basic_materials_steel_strip.png",
 })
 
-minetest.register_craftitem("basic_materials:copper_strip", {
+core.register_craftitem("basic_materials:copper_strip", {
 	description = S("Copper Strip"),
 	groups = { strip = 1 },
-	inventory_image = "basic_materials_copper_strip.png"
+	inventory_image = "basic_materials_copper_strip.png",
 })
 
-minetest.register_craftitem("basic_materials:lead_strip", {
+core.register_craftitem("basic_materials:lead_strip", {
 	description = S("Lead Strip"),
 	groups = { strip = 1 },
-	inventory_image = "basic_materials_lead_strip.png"
+	inventory_image = "basic_materials_lead_strip.png",
 })
 
-minetest.register_craftitem("basic_materials:gold_strip", {
+core.register_craftitem("basic_materials:gold_strip", {
 	description = S("Gold Strip"),
 	groups = { strip = 1 },
-	inventory_image = "basic_materials_gold_strip.png"
+	inventory_image = "basic_materials_gold_strip.png",
 })
 
-minetest.register_craftitem("basic_materials:stainless_steel_strip", {
+core.register_craftitem("basic_materials:stainless_steel_strip", {
 	description = S("Stainless Steel Strip"),
 	groups = { strip = 1 },
-	inventory_image = "basic_materials_stainless_steel_strip.png"
+	inventory_image = "basic_materials_stainless_steel_strip.png",
 })
 
-minetest.register_craftitem("basic_materials:aluminum_strip", {
+core.register_craftitem("basic_materials:aluminum_strip", {
 	description = S("Aluminum Strip"),
 	groups = { strip = 1 },
-	inventory_image = "basic_materials_aluminum_strip.png"
+	inventory_image = "basic_materials_aluminum_strip.png",
 })
 
-minetest.register_craftitem("basic_materials:steel_bar", {
+core.register_craftitem("basic_materials:steel_bar", {
 	description = S("Steel Bar"),
 	inventory_image = "basic_materials_steel_bar.png",
 })
 
-minetest.register_craftitem("basic_materials:carbon_steel_bar", {
+core.register_craftitem("basic_materials:carbon_steel_bar", {
 	description = S("Carbon Steel Bar"),
 	inventory_image = "basic_materials_carbon_steel_bar.png",
 })
 
-minetest.register_craftitem("basic_materials:stainless_steel_bar", {
+core.register_craftitem("basic_materials:stainless_steel_bar", {
 	description = S("Stainless Steel Bar"),
 	inventory_image = "basic_materials_stainless_steel_bar.png",
 })
 
-minetest.register_craftitem("basic_materials:aluminum_bar", {
+core.register_craftitem("basic_materials:aluminum_bar", {
 	description = S("Aluminum Bar"),
 	inventory_image = "basic_materials_aluminum_bar.png",
 })
 
-minetest.register_craftitem("basic_materials:chainlink_brass", {
+core.register_craftitem("basic_materials:chainlink_brass", {
 	description = S("Chainlinks (brass)"),
 	groups = { chainlinks = 1 },
-	inventory_image = "basic_materials_chainlink_brass.png"
+	inventory_image = "basic_materials_chainlink_brass.png",
 })
 
-minetest.register_craftitem("basic_materials:chainlink_steel", {
+core.register_craftitem("basic_materials:chainlink_steel", {
 	description = S("Chainlinks (steel)"),
 	groups = { chainlinks = 1 },
-	inventory_image = "basic_materials_chainlink_steel.png"
+	inventory_image = "basic_materials_chainlink_steel.png",
 })
 
-minetest.register_craftitem("basic_materials:brass_ingot", {
+core.register_craftitem("basic_materials:brass_ingot", {
 	description = S("Brass Ingot"),
 	inventory_image = "basic_materials_brass_ingot.png",
 })
 
-minetest.register_craftitem("basic_materials:gear_steel", {
+core.register_craftitem("basic_materials:gear_steel", {
 	description = S("Steel gear"),
-	inventory_image = "basic_materials_gear_steel.png"
+	inventory_image = "basic_materials_gear_steel.png",
 })
 
-minetest.register_craftitem("basic_materials:padlock", {
+core.register_craftitem("basic_materials:padlock", {
 	description = S("Padlock"),
-	inventory_image = "basic_materials_padlock.png"
+	inventory_image = "basic_materials_padlock.png",
 })
 
-if minetest.get_modpath("hades_materials") then
-	minetest.register_alias_force("basic_materials:plastic_sheet", "hades_materials:plastic_sheeting")
-	minetest.register_alias_force("basic_materials:paraffin", "hades_materials:plastic_base")
-	minetest.register_alias_force("basic_materials:silicon", "hades_materials:silicon")
+if core.get_modpath("hades_materials") then
+	core.register_alias_force("basic_materials:plastic_sheet", "hades_materials:plastic_sheeting")
+	core.register_alias_force("basic_materials:paraffin", "hades_materials:plastic_base")
+	core.register_alias_force("basic_materials:silicon", "hades_materials:silicon")
 end
-

init.lua

@@ -6,9 +6,9 @@
 
 basic_materials = {}
 basic_materials.mod = { author = "Vanessa Dannenberg" }
-basic_materials.modpath = minetest.get_modpath("basic_materials")
+basic_materials.modpath = core.get_modpath("basic_materials")
 
 dofile(basic_materials.modpath .. "/nodes.lua")
 dofile(basic_materials.modpath .. "/craftitems.lua")
 dofile(basic_materials.modpath .. "/crafts.lua")
-dofile(basic_materials.modpath .. "/aliases.lua")
+dofile(basic_materials.modpath .. "/aliases.lua")