Add "MINETEST_MOD_PATH" environment variable #11515

emixa-d · 2021-08-05T11:53:48Z

This patch adds an environment variable "MINETEST_MOD_PATH". It functions like "MINETEST_SUBGAME_PATH", but for individual mods. This is necessary for installing minetest mods with Guix (see https://issues.guix.gnu.org/49828), otherwise Minetest won't find the mods.

I tested that installing mods from ContentDB with the built-in installer still works, even if "MINETEST_MOD_PATH" is set.

To do

This PR is Ready for Review.

How to test

Set "MINETEST_MOD_PATH" to "/location/of/some/mod:/location/of/some/other/mod", start Minetest, create a world, select the two mods, start the game, verify the two mods are actually loaded. Test that mods can still be installed with the built-in installer, and they are installed in ~/.minetest/mods, not /location/of/some/mod or /location/of/some/other/mod.

emixa-d · 2021-08-05T12:03:04Z

The patch is rebased on 'master' now.

emixa-d · 2021-09-09T11:56:09Z

It's rebased on latest master (untested).

sfan5 · 2021-09-13T20:27:48Z

Well I guess if we already have MINETEST_SUBGAME_PATH this is fine too.

builtin/mainmenu/pkgmgr.lua

src/content/subgames.cpp

src/script/lua_api/l_mainmenu.cpp

emixa-d · 2021-09-14T13:27:16Z

I'll test the new version and try to write some tests.

Edit: I added a unit test.

Desour

The env variable should be documented somewhere.

src/content/subgames.cpp

emixa-d · 2021-09-14T17:53:35Z

@Desour: The similar environment variable MINETEST_SUBGAME_PATH is documented in doc/minetest.6. Would that be a good location to document MINETEST_MOD_PATH as well, or were you thinking of some other location?

This adds an environment variable MINETEST_MOD_PATH. When it exists, Minetest will look there for mods in addition to ~/.minetest/mods/. Mods can still be installed to ~/.minetest/mods/ with the built-in installer. With thanks to Leo Prikler, sfan5 and DS for reviewing.

The client still needs to be tested manually.

emixa-d · 2021-09-14T18:02:55Z

Changed Desour->DS

emixa-d · 2021-09-14T18:06:44Z

I did a little testing on GNU Guix, which has a patched version of Minetest to support MINETEST_MOD_PATH and has a few mods packages, e.g. mesecons:

$ guix environment --ad-hoc minetest minetest-mesecons -- ./bin/minetest

Check list

can create and start a new world with guix' minetest, and use mesecons in that world
if I use the built-in installer to install ‘Advanced Trains’, and enable it,
I can use both blocks from ‘Advanced Trains’ and mesecons

Even though I installed mesecons via guix, I can still install mesecons from the
built-in installer. However, this results in the ‘mesecons’ mods being displayed
twice in the ‘select mods’ menu, and when the world is started, this results in
‘ModError: Unresolved name conflicts for mods "mesecons_wires", ...’, which doesn't
seem unreasonable?

Now I try to resolve this conflict by deleting the mod from ContentDB via the built-in
(de-)installer, which succeeds! (Though I had to modify fs::RecursiveDelete because
/bin/rm doesn't exist on Guix System.)

Desour · 2021-09-14T23:04:16Z

@Desour: The similar environment variable MINETEST_SUBGAME_PATH is documented in doc/minetest.6. Would that be a good location to document MINETEST_MOD_PATH as well, or were you thinking of some other location?

Sounds fine, I guess.

emixa-d · 2021-09-15T11:57:55Z

The latest version should address everything I think.

sfan5

Pushed some minor changes, hope you don't mind.
Looks good now

emixa-d · 2021-09-16T15:35:26Z

@sfan5: The changes seem fine to me!

SmallJoker

Ok sure, why not?

emixa-d · 2021-10-06T19:14:03Z

I noticed one issue lately, when combining what is in Guix known as ‘profiles’ (Guix uses an early version of this MINETEST_MOD_PATH patch).

If I install minetest and a mod, say homedecor, e.g. with guix install minetest minetest-homedecor-modpack, then the MINETEST_MOD_PATH will be something like

MINETEST_MOD_PATH=$HOME/.guix-profile/share/minetest/mods

and this directory contains homedecor, basic_materials and unifieddyes, as expected. Suppose I want to test out another mod, say coloredwood, in a temporary environment (guix environment --ad-hoc minetest coloredwood), then MINETEST_MOD_PATH becomes

MINETEST_MOD_PATH=/gnu/store/[bla-bla]/share/minetest/mods:$HOME/.guix-profile/share/minetest/mods

where the former directory contains the coloredwood mod and its dependencies unifieddyes and basic_materials, and the latter contains homedecor, basic_materials and unifieddyes. This is all as expected, but it appears minetest doesn't like a mod appearing in multiple places, because if I start Minetest, I see mods appearing multiple times in the ‘select mods’ menu, and on standard error, I see ERROR[Main]: mod "this" has unsatisfied dependencies: "x" "y" messages.

rollerozxa · 2021-12-11T10:06:13Z

It looks like the environment variable doesn't work for loading mods that are split into a modpack, such as WorldEdit. If I have the Awards mod and WorldEdit mod installed into /usr/share/minetest/mods/ and launch Minetest like MINETEST_MOD_PATH="/usr/share/minetest/mods" minetest then the Awards mod will show up and can be enabled, whereas the WorldEdit mod does not show up.

emixa-d · 2021-12-11T10:50:08Z

WorldEdit seems to work fine in guix (using guix shell --pure minetest minetest-worldedit), though guix uses an older version of the patch IIRC.

In guix, MINETEST_MOD_PATH is set to $GUIX_ENVIRONMENT/share/minetest/mods. This directory contains a subdirectory Minetest-WorldEdit, which contains a file modpack.conf, worldedit,'worldedit_brush, ...

Now testing with multiple mods ...

emixa-d · 2021-12-11T10:53:42Z

worldedit + mesecons seems to work for me

rollerozxa · 2021-12-13T17:59:02Z

Oh never mind, it works for me now, I don't know why it didn't work before... sorry 😅

emixa-d changed the title ~~Minetest mod path~~ Add "MINETEST_MOD_PATH" environment variable Aug 5, 2021

emixa-d force-pushed the minetest-mod-path branch from d10ea2a to b729a5b Compare August 5, 2021 12:02

emixa-d marked this pull request as ready for review August 5, 2021 12:03

sfan5 added @ Server / Client / Env. Feature ✨ PRs that add or enhance a feature Roadmap: Needs approval The change is not part of the current roadmap and needs to be approved by coredevs beforehand labels Aug 5, 2021

emixa-d force-pushed the minetest-mod-path branch from b729a5b to 4251309 Compare September 9, 2021 11:52

sfan5 removed the Roadmap: Needs approval The change is not part of the current roadmap and needs to be approved by coredevs beforehand label Sep 13, 2021

sfan5 mentioned this pull request Sep 13, 2021

5.5 release plans #11600

Closed

sfan5 reviewed Sep 13, 2021

View reviewed changes

builtin/mainmenu/pkgmgr.lua Outdated Show resolved Hide resolved

src/content/subgames.cpp Outdated Show resolved Hide resolved

src/script/lua_api/l_mainmenu.cpp Outdated Show resolved Hide resolved

emixa-d force-pushed the minetest-mod-path branch from 4251309 to c55dcd7 Compare September 14, 2021 13:26

Desour reviewed Sep 14, 2021

View reviewed changes

src/content/subgames.cpp Show resolved Hide resolved

src/content/subgames.cpp Outdated Show resolved Hide resolved

emixa-d force-pushed the minetest-mod-path branch 2 times, most recently from 3e25bab to 20d273a Compare September 14, 2021 17:49

emixa-d added 3 commits September 14, 2021 20:02

Test if MINETEST_MOD_PATH works (server)

e514c90

The client still needs to be tested manually.

Document MINETEST_MOD_PATH.

05e31f4

emixa-d force-pushed the minetest-mod-path branch from bd956a1 to 05e31f4 Compare September 14, 2021 18:02

.

73a37e2

sfan5 approved these changes Sep 16, 2021

View reviewed changes

sfan5 added the One approval ✅ ◻️ label Sep 16, 2021

SmallJoker approved these changes Oct 6, 2021

View reviewed changes

SmallJoker added >= Two approvals ✅ ✅ and removed One approval ✅ ◻️ labels Oct 6, 2021

sfan5 merged commit 9fab5d5 into minetest:master Oct 6, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add "MINETEST_MOD_PATH" environment variable #11515

Add "MINETEST_MOD_PATH" environment variable #11515

emixa-d commented Aug 5, 2021 •

edited

Loading

emixa-d commented Aug 5, 2021

emixa-d commented Sep 9, 2021

sfan5 commented Sep 13, 2021

emixa-d commented Sep 14, 2021 •

edited

Loading

Desour left a comment

emixa-d commented Sep 14, 2021

emixa-d commented Sep 14, 2021

emixa-d commented Sep 14, 2021

Desour commented Sep 14, 2021

emixa-d commented Sep 15, 2021

sfan5 left a comment

emixa-d commented Sep 16, 2021

SmallJoker left a comment

emixa-d commented Oct 6, 2021 •

edited

Loading

rollerozxa commented Dec 11, 2021

emixa-d commented Dec 11, 2021

emixa-d commented Dec 11, 2021

rollerozxa commented Dec 13, 2021

Add "MINETEST_MOD_PATH" environment variable #11515

Add "MINETEST_MOD_PATH" environment variable #11515

Conversation

emixa-d commented Aug 5, 2021 • edited Loading

To do

How to test

emixa-d commented Aug 5, 2021

emixa-d commented Sep 9, 2021

sfan5 commented Sep 13, 2021

emixa-d commented Sep 14, 2021 • edited Loading

Desour left a comment

Choose a reason for hiding this comment

emixa-d commented Sep 14, 2021

emixa-d commented Sep 14, 2021

emixa-d commented Sep 14, 2021

Check list

Desour commented Sep 14, 2021

emixa-d commented Sep 15, 2021

sfan5 left a comment

Choose a reason for hiding this comment

emixa-d commented Sep 16, 2021

SmallJoker left a comment

Choose a reason for hiding this comment

emixa-d commented Oct 6, 2021 • edited Loading

rollerozxa commented Dec 11, 2021

emixa-d commented Dec 11, 2021

emixa-d commented Dec 11, 2021

rollerozxa commented Dec 13, 2021

emixa-d commented Aug 5, 2021 •

edited

Loading

emixa-d commented Sep 14, 2021 •

edited

Loading

emixa-d commented Oct 6, 2021 •

edited

Loading