minetest_modding_book/en/chapters/folders.md

---
title: Folder Structure
layout: default
root: ../../
---

## Introduction

Understanding the basic structure of a mod's folder
is an essential skill when creating mods.

* [Mod Folders](#mod-folders)
* [Dependencies](#dependencies)
* [Mod Packs](#mod-packs)
* [Example](#example)

## Mod Folders

Each mod has its own folder where all its Lua code, textures, models, and sounds
are placed. These folders need to be placed in a mod location such as
minetest/mods.

![Find the mod's folder]({{ page.root }}/static/folder_modfolder.jpg)

A "mod name" is used to refer to a mod. Each mod should have a unique mod name.
Mod names can include letters, numbers, and underscores. A good mod name should 
describe what the mod does, and the folder which contains the components of a mod
needs to be given the same name as the mod name.

### Mod Folder Structure
    Mod name (eg: "mymod")
    -    init.lua - the main scripting code file, which runs when the game loads.
    -    (optional) depends.txt - a list of mods that need to be loaded before this mod.
    -    (optional) textures/ - images used by the mod, commonly in the format modname_itemname.png.
    -    (optional) sounds/ - sounds used by the mod.
    -    (optional) models/ - 3d models used by the mod.
    ...and any other Lua files to be included.

Only the init.lua file is required in a mod for it to run on game load; however,
the other items are needed by some mods to perform their functionality.

## Dependencies

The depends text file allows you to specify which mods this mod requires to run and what
needs to be loaded before this mod.

**depends.txt**

    modone
    modtwo
    modthree?

As you can see, each modname is on its own line.

Mod names with a question mark following them are optional dependencies.
If an optional dependency is installed, it is loaded before the mod;
however, if the dependency is not installed, the mod still loads.
This is in contrast to normal dependencies which will cause the current
mod not to work if the dependency is not installed.

## Mod Packs

Mods can be grouped into mod packs which allow multiple mods to be packaged
and moved together. They are useful if you want to supply multiple mods to
a player but don't want to make them download each one individually.

### Mod Pack Folder Structure
    modpackfolder/
    -    modone/
    -    modtwo/
    -    modthree/
    -    modfour/
    -    modpack.txt – signals that this is a mod pack, content does not matter

## Example

Are you confused? Don't worry, here is an example which puts all of this together:

### Mod Folder
    mymod/
    -    textures/
    -    -    mymod_node.png
    -    init.lua
    -    depends.txt


### depends.txt
    default

### init.lua
{% highlight lua %}
print("This file will be run at load time!")

minetest.register_node("mymod:node", {
    description = "This is a node",
    tiles = {
        "mymod_node.png",
        "mymod_node.png",
        "mymod_node.png",
        "mymod_node.png",
        "mymod_node.png",
        "mymod_node.png"
    },
    groups = {cracky = 1}
})
{% endhighlight %}

This mod has the name "mymod". It has two text files: init.lua and depends.txt.\\
The script prints a message and then registers a node – which will be explained in the next chapter.\\
The depends text file adds a dependency on the default mod which is in minetest_game.\\
There is also a texture in textures/ for the node.