Difference between revisions of "Installing Mods"
(Copied from dev wiki) |
(added links; reformatting) |
||
| Line 1: | Line 1: | ||
| − | After downloading a mod (e.g. from the [http://forum.minetest.net/viewforum.php?id=11 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. | + | After downloading a [[Mods|mod]] (e.g. from the [http://forum.minetest.net/viewforum.php?id=11 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 <code>PilzAdam-carts-70cc4f4</code> to <code>carts</code>). You can find the modname in the title of the forum topic. | Make sure that you rename the folder to the modname (e.g. rename <code>PilzAdam-carts-70cc4f4</code> to <code>carts</code>). You can find the modname in the title of the forum topic. | ||
| Line 8: | Line 8: | ||
In 0.4.7 and later the mods are installed globally and enabled per world. | In 0.4.7 and later 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 | + | 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. |
| − | After extracting the mod there you need to enable it for your world. This can either be done in the GUI by clicking on | + | 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. |
Note that new installed mods are disabled for all worlds by default, so you explicitly need to enable them. | Note that new installed mods are disabled for all worlds by default, so you explicitly need to enable them. | ||
== Install directory (Minetest 0.4.6 and earlier) == | == Install directory (Minetest 0.4.6 and earlier) == | ||
| − | In 0.4.6 and earlier the mods are installed game specific, that means that you install the mods for every world that runs the | + | In 0.4.6 and earlier the mods are installed game specific, that means that you install the mods for every world that runs the “minetest” game or the “dwarves” game. |
The common place to install them is <code>$path_user/mods/<gameid>/</code> (<code><gameid></code> is <code>minetest</code> if you run minetest_game). That is <code>minetest-install-directory/mods/<gameid>/</code> in the official windows releases and RUN_IN_PLACE versions on Linux and <code>~/.minetest/mods/<gameid>/</code> in globally installed Minetest versions. | The common place to install them is <code>$path_user/mods/<gameid>/</code> (<code><gameid></code> is <code>minetest</code> if you run minetest_game). That is <code>minetest-install-directory/mods/<gameid>/</code> in the official windows releases and RUN_IN_PLACE versions on Linux and <code>~/.minetest/mods/<gameid>/</code> in globally installed Minetest versions. | ||
| Line 27: | Line 27: | ||
== Example structure == | == Example structure == | ||
| − | In this example the mods | + | In this example the mods “carts” and “tnt” are installed: |
| − | < | + | <pre> |
mods/ | mods/ | ||
├── carts/ | ├── carts/ | ||
| Line 37: | Line 37: | ||
│ ├── textures/ | │ ├── textures/ | ||
│ │ ├── carts_top.png | │ │ ├── carts_top.png | ||
| − | │ │ └── | + | │ │ └── … |
│ └── models/ | │ └── models/ | ||
│ ├── cart.x | │ ├── cart.x | ||
| − | │ └── | + | │ └── … |
└── tnt/ | └── tnt/ | ||
├── init.lua | ├── init.lua | ||
| Line 47: | Line 47: | ||
├── textures/ | ├── textures/ | ||
│ ├── tnt_side.png | │ ├── tnt_side.png | ||
| − | │ └── | + | │ └── … |
└── sounds/ | └── sounds/ | ||
├── tnt_explode.ogg | ├── tnt_explode.ogg | ||
| − | └── | + | └── … |
| − | </ | + | </pre> |
Revision as of 06:17, 2 October 2013
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 (Minetest 0.4.7 and later)
In 0.4.7 and later 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 RUN_IN_PLACE versions on Linux and ~/.minetest/mods/ in globally installed Minetest versions.
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.
Install directory (Minetest 0.4.6 and earlier)
In 0.4.6 and earlier the mods are installed game specific, that means that you install the mods for every world that runs the “minetest” game or the “dwarves” game.
The common place to install them is $path_user/mods/<gameid>/ (<gameid> is minetest if you run minetest_game). That is minetest-install-directory/mods/<gameid>/ in the official windows releases and RUN_IN_PLACE versions on Linux and ~/.minetest/mods/<gameid>/ in globally installed Minetest versions.
The mod will be loaded in every world that runs the game with the gameid <gameid>.
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
└── …