> For the complete documentation index, see [llms.txt](https://worive.gitbook.io/urbek-modding/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://worive.gitbook.io/urbek-modding/getting-started/mod-folder-structure.md).

# Mod Folder Structure

## The folder itself

The folder must be named in the following format: **ModName\_Author**\
Example: UnlimitedPotatoes\_Worive

## Folder Content

The folder will contain 3 types of files:

* The **3dModels'** folder
* The **icon**'s folder
* The **description.txt** text file
* One or more modding text files.

![Example of mod folder](https://2761210071-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9NrxWhvqNcR47WG8hUBm%2Fuploads%2FDsYyJbVFml3zpjEllmoC%2Fimage.png?alt=media\&token=c67a7e07-c708-4b48-b684-9104840088cb)

## 3dModels Folder

This folder will contain all your MagicaVoxel models, each one of them must have their 3 files:

* modelName.obj
* modelName.mtl
* modelName.png

{% hint style="info" %}
The original .vox file is not necessary for the game to work.
{% endhint %}

**You can check out how to make models via this guide:**

{% content-ref url="/pages/RmeCrVUX8xL15GOGiLOn" %}
[Make a 3D Model](/urbek-modding/getting-started/make-a-3d-model.md)
{% endcontent-ref %}

## Icon Folder

This folder will contain all your building's custom icons. Every icon must meet those conditions:

* 110x110 resolution
* `.png` extension

{% hint style="info" %}
There's an empty icon that you can download freely to make your owns:

<img src="https://2761210071-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9NrxWhvqNcR47WG8hUBm%2Fuploads%2FwhRlliWo5OehKek3PZ00%2FbatVacio.png?alt=media&amp;token=3158b27f-87b8-4876-8bcc-0111be3adab6" alt="" data-size="original">
{% endhint %}

To set an icon for a specific building, you only needs to set the **icon's name as the building's `codeName`.**

Example

{% tabs %}
{% tab title="Example 1" %}
Building with codeName: `myhouse`.

The corresponding icon is: `/icon/`**`myhouse`**`.png`
{% endtab %}

{% tab title="Example 2" %}
Building with codeName: `someNewFancyBuilding`.

The corresponding icon is: `/icon/`**someNewFancyBuilding**`.png`
{% endtab %}
{% endtabs %}

### Lights

Any model name ending with `luz` or `luzRoja` will have light at night from these model positions, yellow and red respectively, depending on the name.

Example

* modelName luz.obj
* modelName luzRoja.obj

## Description Text File

The file `description.txt` is used, as the name itself explains it, to define the description of your mod.

## Modding Text Files

Modding text files work via prefixes (text in the front of the file name), there are 3 types:

* replace
* add3dModels
* newBuildings

{% hint style="info" %}
Every one of these files must end with the extension **.txt**
{% endhint %}

You can have as many of each as you want, if you want to build large mods and want to separate content for your convenience.

### Replace

The file allows you to replace any existing models of the game with another one from your 3dModels' folder.

{% hint style="info" %}
**There's a guide showing you how it works:**
{% endhint %}

{% content-ref url="/pages/36lpdClhV8EOyN7PMIhj" %}
[Replace Models](/urbek-modding/guides/replace-models.md)
{% endcontent-ref %}

### Add 3D Models

The file allows you to add more models to existing buildings for more diversity.

{% hint style="info" %}
**There's a guide showing you how it works:**
{% endhint %}

{% content-ref url="/pages/XQhwY05Lb1gM63lhoyUg" %}
[Adding Models](/urbek-modding/guides/adding-models.md)
{% endcontent-ref %}

### New Buildings

Allows you to add brand-new constructions to the game, where you can configure more than 50 characteristics if you want!

{% hint style="info" %}
**There's a guide showing you how it works:**
{% endhint %}

{% content-ref url="/pages/aUJtXwEYtiPV8iwXGbBZ" %}
[Adding Constructions](/urbek-modding/guides/adding-constructions.md)
{% endcontent-ref %}