Installing the ModKit

What is ModKit

ModKit is the freely available code and 3D assets used to modify Eco's game play.

With ModKit you can create new:

• World Objects* - Objects in the game server (e.g. workbenches)
• Items* - These are the icons for items and world objects.
• Block Sets* - The variations of a block's shape for building.
• Emoji Sets* - A collection of icon assets (PNG / sprite sheets).
• Plugins - These are code that changes how the server behaves (from adding a recipe to adding a new mechanic).

* Requires Unity

Get ModKit

The Game Downloads section where the ModKit download is. 4/20/2026

1. Go to https://play.eco/account and login (create your account, if necessary).
2. Then on the account page find the Game Downloads section. Inside of that section there will be a button titled ModKit.
   1. If targeting the current release, click on the only button that says ModKit near the top of that section.
   2. If targeting the staging (preview of next release) version, click the More Downloads button in the top right. Then find the ModKit button in the bottom section. The button will be under a header that says "For advanced users that want to test the most recent, unstable version".
   3. Unsure? Go with the current release version.
3. Let it download.
4. Unzip or Extract the ModKit archive.

Installing ModKit

Installing Unity

Shows the Unity Hub's editor installation screen. 4/20/2026

1. Determine what version of Unity editor is needed. As of 4/20/2026, the Unity editor is Unity 6.3.
   1. Look for the ProjectVersion.txt file inside the ModKit folder.
   2. Find the line that looks like m_EditorVersion: 0000.0.000.
   3. Figure the matching Unity editor version.
      1. For 6000.3.6f1 that means install Unity 6.3.
      2. If it was 2030.1.1de then install Unity 2030.1 (this version doesn't exist, just using it as an example).
   4. If the version has LTS in it, just ignore that. It just means Long Term Support and doesn't change that version's number. For example, if given 6000.3.6f1 then it is reasonable that both Unity 6.3 and Unity 6.3 LTS will be compatible.
2. Go to https://unity.com/.
3. Download and install the Unity Hub. Note: On first start Unity Hub will being downloading the most recent version of the Unity editor. View this by clicking on the download icon in the very top-right of the window (just left of the exit button on windows). If it is not downloading the version determined in step 1, cancel that download. Save some time and disk space this way.
4. Install the correct version of Unity engine.
   1. On the left menu find Installs and navigate to that page.
   2. In the top right click the Install Editor button.
   3. A pop-up should appear where you can search, scroll, and find the version determined in step 1.

The Unity Project

3D (Built-In Render Pipeline) project setup on Unity Hub. 4/20/2026

ModKit is just a bundle of assets that is imported into a Unity project. If you already have a project you'd like to use the ModKit, open that project and skip to the Importing ModKit section below.

To create a new project, open Unity Hub and follow along:

1. On the left menu find Projects and navigate to that page.
2. In the top right click the + New Project button.
3. Here select the 3D (Built-In Render Pipeline) template. It may have to download the template first.
4. If you installed multiple versions of Unity, double check the Editor version box here. Make sure the first four numbers and the numbers after the first dot (e.g.6000.3) match what is in the ProjectVersion.txt file.
5. Name the project.
6. Select where it will save to.
7. Consider using a Source Control Provider. Optional.
8. Click + Create project.
9. The Unity editor will setup this project. This process may take several minutes.

Importing ModKit

Note: Importing ModKit into a pre-existing project will override some of the project's settings. Make a backup of your work proceeding!

Open the project you want to load ModKit into and follow along:

1. From the top toolbar find and open the Assets drop down
2. Hover the Import Package option to expand the sub-menu
3. Select and click on Custom Package... A file browser should appear.
4. Navigate to the ModKit folder.
5. Select the EcoModKit.unitypackage file.
6. Press Open.
7. A warning will pop-up.
   1. If this is a fresh new project, click Import.
   2. If this is a project with stuff in it, make a backup copy before continuing. Continue by clicking Import.
8. A window will pop-up titled Import Unity Package. It's listing all the changes being made.
9. Click Next.
10. The window will now show any destructive changes it's going to make.
11. Continue when ready by clicking Import.
12. The editor will import the ModKit assets. This process may take a few minutes.
13. Install Text Mesh Pro features.
    1. From the top toolbar find and open the Window drop down.
    2. Hover TextMeshPro to expand the sub-menu.
    3. Select Import TextMeshPro Essential Resources
    4. Review the import screen showing changes made.
    5. Click Import.

For older versions only (Unity 2019.# and Unity 2020.#) of the Unity editor there are more steps:

1. From the top toolbar find and open the Window drop down.
2. Hover Package Management to open the sub-menu.
3. Select Package Manager.
4. The Package Manager window should pop-up.
5. In the top-left find and click the In Project tab.
6. From it, select Unity Registry.
7. Select Collections from the list.
   1. In Unity 2019.#, if the Collections package is missing turn on Preview packages. To turn that feature on, find the Advanced drop down inside the Package Manager. From the Advanced drop down, check Show preview packages.
   2. In Unity 2020.#, some packages are hidden entirely. Install these packages by clicking on the + (add) button in the Package Manager. Select the Add packages from git URL option. Input com.unity.collections and click the Add button.
8. Go down the list and click Install on all list items.

Using ModKit

ModKit Template Scene Asset. 4/20/2026

In Unity's editor, ModKit assets can be found at Assets/EcoModKit.

Read the README files in Assets/EcoModKit/README.md and Assets/EcoModKit/Docs/README.md. The second one explains better what can be accomplished with ModKit.

See the ModKit tutorials on Mod Development page for guides on how to use ModKit and Unity to construct a mod.

Exporting

Once finished with developing a mod's assets in Unity, it must be exported. ModKit provides a special script for this purpose. Open your Unity project and follow along to export:

1. From the top toolbar find and open Eco Tools drop down.
2. Hover Mod Kit and expand the sub-menu.
3. Select Build Current Bundle.
4. A file explorer will pop-up.
   1. Select where to save the mod's assets.
   2. Give them a name.
5. Unity will build the package. This may take several minutes.
6. Once it finishes, that file ending in .unity3d is the asset you distribute and use in the Mods folder at ../Eco Server/Mods/UserCode.

Happy Modding!