Difference between revisions of "Installing Mods"

From Minetest Wiki
Jump to navigation Jump to search
(→‎Install directory: added folder tree)
Line 11: Line 11:
 
As of 0.4.7, the mods are installed globally and enabled per world.
 
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 [[RUN_IN_PLACE]] versions on Linux and <code>~/.minetest/mods/</code> in globally installed Minetest versions.
+
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 [[RUN_IN_PLACE]] 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 costum made content goes. Unrelevant folders are not expanded.
+
 
 +
* 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>
 
<pre>
 
minetest/
 
minetest/
Line 24: Line 26:
 
│  ├── minetest_game/
 
│  ├── minetest_game/
 
│  ├── minimal/
 
│  ├── minimal/
│  └── ... (installed extra games)
+
│  └── (installed extra games)
 
├── locale/
 
├── locale/
 
├── mods/
 
├── mods/
│  └── ... (installed extra mods and modpacks)
+
│  └── (installed extra mods and modpacks)
 
├── textures/
 
├── textures/
 
│  ├── base/
 
│  ├── base/
 
│  │  └── pack/
 
│  │  └── pack/
│  └── ... (installed extra texturepacks)
+
│  └── (installed extra texturepacks)
 
└── worlds/
 
└── worlds/
     └── ... (saved worlds. Some with exclusive world mods)
+
     └── (saved worlds. Some with exclusive world mods)
 
</pre>
 
</pre>
  
Line 41: Line 43:
  
 
== Additional install directories (all Minetest versions) ==
 
== Additional install directories (all Minetest 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>.
 
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>.
  
Line 48: Line 51:
  
 
In this example the mods “carts” and “tnt” are installed:
 
In this example the mods “carts” and “tnt” are installed:
 +
 
<pre>
 
<pre>
 
     mods/
 
     mods/

Revision as of 19:17, 27 April 2014

Prior to installing any mod, please make sure that you have received it from someone you trust. Malicious code can damage your computer, violate your privacy or cause your computer to take part in illegal activities.

After downloading a mod (e.g. from the Mod Releases forum) you usually have a .zip archive. In order to get the mod running in you have to unpack it in one of the folders where Minetest looks for mods. This depends on what Minetest version you have installed.

Make sure that you rename the folder to the modname (e.g. rename PilzAdam-carts-70cc4f4 to carts). You can find the modname in the title of the forum topic.

If one of the below mentioned directories does not exist, create it.

Install directory

As of 0.4.7, the mods are installed globally and enabled per world.

The common place to install them is $path_user/mods/. That is minetest-install-directory/mods/ in the official Windows releases and on GNU/Linux with RUN_IN_PLACE enabled and ~/.minetest/mods/ 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.
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)

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 new installed mods are disabled for all worlds by default, so you explicitly need to enable them.

Additional install directories (all Minetest versions)

Other places to install mods are world-directory/worldmods/, $path_share/mods/ and $<path_user, path_share>/games/<gameid>/mods/.

Note that users should generally install mods in the normal install directory and not in the additional ones.

Example structure

In this example the mods “carts” and “tnt” are installed:

    mods/
    ├── carts/
    │   ├── depends.txt
    │   ├── init.lua
    │   ├── functions.lua
    │   ├── README.txt
    │   ├── textures/
    │   │   ├── carts_top.png
    │   │   └── …
    │   └── models/
    │       ├── cart.x
    │       └── …
    └── tnt/
        ├── init.lua
        ├── depends.txt
        ├── README.txt
        ├── textures/
        │   ├── tnt_side.png
        │   └── …
        └── sounds/
            ├── tnt_explode.ogg
            └── …