Minor fixes and cleanup (#3)

.github/dependabot.yml

@@ -1,7 +0,0 @@
-version: 2
-updates:
-- package-ecosystem: gitsubmodule
-  directory: "/"
-  schedule:
-    interval: daily
-  open-pull-requests-limit: 20

.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: Checkout
-    - name: apt
+        uses: actions/checkout@main
-      run: sudo apt-get install -y luarocks
+      - name: Luacheck
-    - name: luacheck install
+        uses: lunarmodules/luacheck@master
-      run: luarocks install --local luacheck
-    - name: luacheck run
-      run: $HOME/.luarocks/bin/luacheck ./

.luacheckrc

@@ -1,22 +1,17 @@
-unused_args = false
-allow_defined_top = true
-
-exclude_files = {".luacheckrc"}
 
 globals = {
-    "minetest", "xcompat",
+	"minetest",
+	"xcompat",
 }
 
 read_globals = {
-    string = {fields = {"split"}},
+	"default",
-    table = {fields = {"copy", "getn"}},
+	"mcl_sounds",
-
+	"ks_sounds",
-    --luac
+	"nodes_nature",
-    "math", "table",
+	"fl_stone",
-
+	"fl_topsoil",
-    -- Builtin
+	"fl_trees",
-    "vector", "ItemStack", "dump", "DIR_DELIM", "VoxelArea", "Settings", "PcgRandom", "VoxelManip", "PseudoRandom",
+	"hades_sounds",
-
+	"rp_sounds",
-    --mod produced
+}
-    "default", "mcl_sounds", "ks_sounds", "nodes_nature", "fl_stone", "fl_topsoil", "fl_trees", "hades_sounds", "rp_sounds",
-}

README.md

@@ -1,15 +1,30 @@
-# xcompat
+# XCompat
 
-a mod that aims to facilitate other mods to be game agnostic by handling sounds and crafting
+[![luacheck](https://github.com/mt-mods/xcompat/workflows/luacheck/badge.svg)](https://github.com/mt-mods/xcompat/actions)
+[![ContentDB](https://content.minetest.net/packages/mt-mods/xcompat/shields/downloads/)](https://content.minetest.net/packages/mt-mods/xcompat/)
 
-thanks to:
+Provides cross compatibility between games and mods for sounds and crafting materials.
-* MisterE, OgelGames, and Blockhead for naming advice/suggestion
-* luk3yx, Blockhead, Buckaroo for bouncing ideas on the concept of this mod
 
-## Installing
+Thanks to:
+* MisterE, OgelGames, and Blockhead for naming advice/suggestion.
+* luk3yx, Blockhead, BuckarooBanzai for bouncing ideas on the concept of this mod.
 
-clone via git or install via contentdb (soon)
+## Usage
 
-## Dev Docs
+See [DEV.md](DEV.md) for detailed documentation.
 
-Can be found at /DEV.md
+## Supported games and mods
+
+**Games**
+* Minetest Game
+* MineClone2
+* Mineclonia
+* Hades Revisited
+* Farlands Reloaded
+* Exile
+* KSurvive 2
+
+**Mods**
+* `basic_materials`
+* `mesecons_materials`
+* `moreores`

mod.conf

@@ -1,2 +1,3 @@
 name = xcompat
-optional_depends = default, fl_stone, fl_trees, mcl_sounds, hades_sounds, ks_sounds, nodes_nature, fl_topsoil, fl_trees
+description = Provides cross compatibility between mods and games for sounds and crafting materials.
+optional_depends = default, fl_stone, fl_trees, mcl_sounds, hades_sounds, ks_sounds, nodes_nature, fl_topsoil, fl_trees