diff --git a/.github/dependabot.yml b/.github/dependabot.yml deleted file mode 100644 index 6668d3c..0000000 --- a/.github/dependabot.yml +++ /dev/null @@ -1,7 +0,0 @@ -version: 2 -updates: -- package-ecosystem: gitsubmodule - directory: "/" - schedule: - interval: daily - open-pull-requests-limit: 20 diff --git a/.github/workflows/luacheck.yml b/.github/workflows/luacheck.yml index 58a3310..18088bc 100644 --- a/.github/workflows/luacheck.yml +++ b/.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 ./ \ No newline at end of file + - name: Checkout + uses: actions/checkout@main + - name: Luacheck + uses: lunarmodules/luacheck@master diff --git a/.luacheckrc b/.luacheckrc index e7d839d..8e8ff9a 100644 --- a/.luacheckrc +++ b/.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"}}, - table = {fields = {"copy", "getn"}}, - - --luac - "math", "table", - - -- Builtin - "vector", "ItemStack", "dump", "DIR_DELIM", "VoxelArea", "Settings", "PcgRandom", "VoxelManip", "PseudoRandom", - - --mod produced - "default", "mcl_sounds", "ks_sounds", "nodes_nature", "fl_stone", "fl_topsoil", "fl_trees", "hades_sounds", "rp_sounds", -} \ No newline at end of file + "default", + "mcl_sounds", + "ks_sounds", + "nodes_nature", + "fl_stone", + "fl_topsoil", + "fl_trees", + "hades_sounds", + "rp_sounds", +} diff --git a/README.md b/README.md index c079f4b..14ab537 100644 --- a/README.md +++ b/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: -* MisterE, OgelGames, and Blockhead for naming advice/suggestion -* luk3yx, Blockhead, Buckaroo for bouncing ideas on the concept of this mod +Provides cross compatibility between games and mods for sounds and crafting materials. -## 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 \ No newline at end of file +## Supported games and mods + +**Games** +* Minetest Game +* MineClone2 +* Mineclonia +* Hades Revisited +* Farlands Reloaded +* Exile +* KSurvive 2 + +**Mods** +* `basic_materials` +* `mesecons_materials` +* `moreores` diff --git a/mod.conf b/mod.conf index 3ff63d9..79eb4ff 100644 --- a/mod.conf +++ b/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 \ No newline at end of file +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