Difference between revisions of "Installing Mods"

From Luanti Wiki
Jump to navigation Jump to search
(Rewrite security considerations to be more up to date and slightly less fearmongering)
(rename Minetest to Luanti)
(2 intermediate revisions by one other user not shown)
Line 2: Line 2:
 
__NOTOC__
 
__NOTOC__
 
== Security considerations ==
 
== Security considerations ==
−
'''Mods are by default run in a secure environment that restricts access to the filesystem and execution of external programs, however not all sandboxes are 100% secure. Additionally do not mark mods as trusted or disable mod security altogether if you are not aware of what you are doing, as they will run unsandboxed at the same privileges as Minetest. This applies not only to malicious mods but benign ones with security vulnerabilities. Excercise caution when downloading mods outside of official channels such as ContentDB where mods are vetted by the community for safety and security.'''
+
'''Mods are by default run in a secure environment that restricts access to the filesystem and execution of external programs, however not all sandboxes are 100% secure. Additionally do not mark mods as trusted or disable mod security altogether if you are not aware of what you are doing, as they will run unsandboxed at the same privileges as Luanti. This applies not only to malicious mods but benign ones with security vulnerabilities. Excercise caution when downloading mods outside of official channels such as ContentDB where mods are vetted by the community for safety and security.'''
  
 
== Installing a mod ==
 
== Installing a mod ==
−
Mods can be installed from the ContentDB using the Content tab's Browse online content button in versions 5.0 and above. Mods downloaded this way are automatically installed.
+
Mods can be installed from ContentDB in the "Browse online content" button in Luanti 5.0+. Mods downloaded this way are automatically installed and get checked for updates. See [https://content.minetest.net/help/installing/ Installing content].
  
−
[[Mods|Mods]] are usually distributed in a Zip archive. In order to get the mod running, you have to extract it into one of the folders where Minetest looks for mods. This depends on what Minetest version you have installed.
+
For mods downloaded manually, you would clone the source repository or extract the Zip archive into your mods folder.
  
−
You may have to change the folder name to the “technical” mod name (e.g. rename <code>PilzAdam-carts-70cc4f4</code> to <code>carts</code>). You can usually find the mod name in the title of the forum topic—It is the last name within the square brackets in the topic title.
+
To find your mods folder, go into the "About" tab and press the "Open User Data Directory" button. If there isn't already a mods folder there then create it.
−
For example, if the title is <code>[Mod] Lol Mod [1.0] [anotherlolmod]</code>, then the folder must be renamed to <code>anotherlolmod</code>.
 
−
 
 
−
If one of the below mentioned directories does not exist, create it.
 
−
 
 
−
== Installing a modpack ==
 
−
A modpack is installed in the same way as a mod, but you are usually not required to change the directory name of the modpack. Just make sure the name does not collide with that of any other installed mod or modpack.
 
−
 
 
−
== Installation directory ==
 
−
 
 
−
As of 0.4.7, the mods are installed globally and enabled per [[world]].
 
−
 
 
−
The common place to install them is <code>$path_user/mods/</code>. That is <code>minetest-install-directory/mods/</code> in the official Windows releases and on GNU/Linux with <code>RUN_IN_PLACE</code> enabled and '''<code>~/.minetest/mods/</code>''' in globally installed Minetest versions.
 
−
 
 
−
* Location of the mods folder within the folder structure of a run-in-place installation of Minetest, including some of the folders Minetest adds after some usage as client and server, as well as the positions (…) that custom-made content goes. Unrelevant folders are not expanded.
 
−
 
 
−
<pre>
 
−
minetest/
 
−
├── bin/
 
−
├── builtin/
 
−
├── cache/
 
−
├── client/
 
−
├── doc/
 
−
├── fonts/
 
−
├── games/
 
−
│  ├── minetest_game/
 
−
│  ├── minimal/
 
−
│  └── … (installed extra games)
 
−
├── locale/
 
−
├── mods/
 
−
│  └── … (installed extra mods and modpacks)
 
−
├── textures/
 
−
│  ├── base/
 
−
│  │  └── pack/
 
−
│  └── … (installed extra texturepacks)
 
−
└── worlds/
 
−
    └── … (saved worlds. Some with exclusive world mods)
 
−
</pre>
 
  
 
After extracting the mod there you need to enable it for your world. This can either be done in the GUI by clicking on “Configure” in the world selection, or by adding <code>load_mod_<modname> = true</code> in the world.mt file in the world directory.
 
After extracting the mod there you need to enable it for your world. This can either be done in the GUI by clicking on “Configure” in the world selection, or by adding <code>load_mod_<modname> = true</code> in the world.mt file in the world directory.
Line 52: Line 15:
 
Note that newly installed mods are disabled for all worlds by default, so you explicitly need to enable them.
 
Note that newly installed mods are disabled for all worlds by default, so you explicitly need to enable them.
  
−
== Additional install directories (all Minetest versions) ==
+
== Additional install directories (all Luanti versions) ==
  
−
Other places to install mods are <code>world-directory/worldmods/</code>, <code>$path_share/mods/</code> and <code>$<path_user, path_share>/games/<gameid>/mods/</code>. <code>$path_share</code> and <code>$path_user</code> are only relevant to system-wide installs of Minetest (currently, possible only on Linux). As mentioned above, Minetest on Windows and portable builds operate within their install directory itself, which corresponds to both <code>$path_share</code> and <code>$path_user</code>.
+
Other places to install mods are <code>world-directory/worldmods/</code>, <code>$path_share/mods/</code> and <code>$<path_user, path_share>/games/<gameid>/mods/</code>. <code>$path_share</code> and <code>$path_user</code> are only relevant to system-wide installs of Luanti (currently, possible only on Linux). As mentioned above, Luanti on Windows and portable builds operate within their install directory itself, which corresponds to both <code>$path_share</code> and <code>$path_user</code>.
  
 
Note that users should generally install mods in the normal install directory and not in the additional ones. Note that having copies of the same mod in different places may easily generate mod conflicts.
 
Note that users should generally install mods in the normal install directory and not in the additional ones. Note that having copies of the same mod in different places may easily generate mod conflicts.
Line 63: Line 26:
 
*In the <code>/mods</code> folder technically parallel to the <code>/bin</code> folder the executable is in.
 
*In the <code>/mods</code> folder technically parallel to the <code>/bin</code> folder the executable is in.
  
−
On different installations this may very well also be in some other Minetest location such as a shared, <code>system/game</code>, user or hidden folder. Only mods in this place are '''togglable'''. Mods in this folder can be run with any world created by any game. This is therefore an easy place to create mod conflicts that might even crash Minetest.
+
On different installations this may very well also be in some other Luanti location such as a shared, <code>system/game</code>, user or hidden folder. Only mods in this place are '''togglable'''. Mods in this folder can be run with any world created by any game. This is therefore an easy place to create mod conflicts that might even crash Luanti.
  
 
*In a <code>/games/<some_game>/mods</code> folder.
 
*In a <code>/games/<some_game>/mods</code> folder.
Line 74: Line 37:
  
 
Mods in a worldmods folder are '''not togglable''' and will run on and only on that specific world, and cannot be accessed from any other world.
 
Mods in a worldmods folder are '''not togglable''' and will run on and only on that specific world, and cannot be accessed from any other world.
−
 
−
== Example structure ==
 
−
 
−
In this example the mods “<code>digtron</code>” and “<code>tnt</code>”, and the modpack “<code>mesecons</code>” are installed:
 
−
 
−
<pre>
 
−
    mods/
 
−
    ├── digtron/
 
−
    │  ├── init.lua
 
−
    │  ├── mod.conf
 
−
    │  ├── awards.lua
 
−
    │  ├── README.md
 
−
    │  ├── sounds/
 
−
    │  │  ├── buzzer.ogg
 
−
    │  │  └── …
 
−
    │  └── textures/
 
−
    │      ├── digtron_axel_side.png
 
−
    │      └── …
 
−
    ├── tnt/
 
−
    │  ├── init.lua
 
−
    │  ├── mod.conf
 
−
    │  ├── README.txt
 
−
    │  ├── textures/
 
−
    │  │  ├── tnt_side.png
 
−
    │  │  └── …
 
−
    │  └── sounds/
 
−
    │      ├── tnt_explode.ogg
 
−
    │      └── …
 
−
    └── mesecons/
 
−
        ├── modpack.txt
 
−
        ├── mesecons/
 
−
        │  ├── init.lua
 
−
        │  └── …
 
−
        ├── mesecons_alias/
 
−
        │  ├── init.lua
 
−
        │  └── …
 
−
        ├── mesecons_blinkyplant/
 
−
        │  ├── init.lua
 
−
        │  └── …
 
−
        ├── mesecons_button/
 
−
        │  ├── init.lua
 
−
        │  └── …
 
−
        ├── …
 
−
</pre>
 
  
  
 
[[Category:Mods]]
 
[[Category:Mods]]
 
[[Category:Tutorials]]
 
[[Category:Tutorials]]

Revision as of 23:13, 22 October 2024

Languages Language: English

Security considerations

Mods are by default run in a secure environment that restricts access to the filesystem and execution of external programs, however not all sandboxes are 100% secure. Additionally do not mark mods as trusted or disable mod security altogether if you are not aware of what you are doing, as they will run unsandboxed at the same privileges as Luanti. This applies not only to malicious mods but benign ones with security vulnerabilities. Excercise caution when downloading mods outside of official channels such as ContentDB where mods are vetted by the community for safety and security.

Installing a mod

Mods can be installed from ContentDB in the "Browse online content" button in Luanti 5.0+. Mods downloaded this way are automatically installed and get checked for updates. See Installing content.

For mods downloaded manually, you would clone the source repository or extract the Zip archive into your mods folder.

To find your mods folder, go into the "About" tab and press the "Open User Data Directory" button. If there isn't already a mods folder there then create it.

After extracting the mod there you need to enable it for your world. This can either be done in the GUI by clicking on “Configure” in the world selection, or by adding load_mod_<modname> = true in the world.mt file in the world directory.

Note that newly installed mods are disabled for all worlds by default, so you explicitly need to enable them.

Additional install directories (all Luanti versions)

Other places to install mods are world-directory/worldmods/, $path_share/mods/ and $<path_user, path_share>/games/<gameid>/mods/. $path_share and $path_user are only relevant to system-wide installs of Luanti (currently, possible only on Linux). As mentioned above, Luanti on Windows and portable builds operate within their install directory itself, which corresponds to both $path_share and $path_user.

Note that users should generally install mods in the normal install directory and not in the additional ones. Note that having copies of the same mod in different places may easily generate mod conflicts.


Differences between the three kinds of places mods can be loaded from:

  • In the /mods folder technically parallel to the /bin folder the executable is in.

On different installations this may very well also be in some other Luanti location such as a shared, system/game, user or hidden folder. Only mods in this place are togglable. Mods in this folder can be run with any world created by any game. This is therefore an easy place to create mod conflicts that might even crash Luanti.

  • In a /games/<some_game>/mods folder.

In case of "Minetest Game", this could be a sub-folder of <someplace>/minetest/games/minetest_game/mods or <some_other_place>/minetest(or ~/.minetest)/games/minetest_game/mods.

Mods loaded from such locations are considered to be an essential part of said game and are not togglable. These mods apply to all worlds created with this game but not to any world created by another game (although many games may include the same mods)

  • In a /worlds/<name_of_some_world>/worldmods folder inside the sub-folder of a specific world.

Mods in a worldmods folder are not togglable and will run on and only on that specific world, and cannot be accessed from any other world.

Retrieved from "http://wiki.luanti.org/index.php?title=Installing_Mods&oldid=28469"