Installing the ModKit: Difference between revisions
| [unchecked revision] | [unchecked revision] |
Minor changes to the procedure I discovered while installing using 6000.2.9f1 |
Updating. Adding more detail, but mostly just spreading previous steps into step-by-step instructions. |
||
| Line 1: | Line 1: | ||
= 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: | ||
# Go to https://play.eco/account and | |||
# | * '''World Objects*''' - Objects in the game server (e.g. workbenches) | ||
# Unzip the ModKit archive to a | * '''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). | |||
<nowiki>*</nowiki> Requires Unity | |||
= Get ModKit = | |||
[[File:Eco - Game Downloads - ModKit - Marked Up.png|thumb|The ''Game Downloads'' section where the ''ModKit'' download is. <u>4/20/2026</u>]] | |||
# Go to https://play.eco/account and login (create your account, if necessary). | |||
# Then on the account page find the ''Game Downloads'' section. Inside of that section there will be a button titled ''ModKit.'' | |||
## <u>If targeting the current release</u>, click on the only button that says ''ModKit'' near the top of that section. | |||
## I<u>f targeting the staging (preview of next release) version</u>, 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". | |||
## <u>Unsure</u><u>?</u> Go with the current release version. | |||
# Let it download. | |||
# Unzip or Extract the ModKit archive. | |||
= Installing ModKit = | |||
== Installing Unity == | |||
[[File:Eco - Unity Installer - Engine Install Screen.png|thumb|Shows the Unity Hub's editor installation screen. <u>4/20/2026</u>]] | |||
# Determine what version of Unity editor is needed. <u>As of 4/20/2026</u>, the Unity editor is <code>Unity 6.3</code>. | |||
## Look for the <code>ProjectVersion.txt</code> file inside the ModKit folder. | |||
## Find the line that looks like <code>m_EditorVersion: 0000.0.000</code>. | |||
## Figure the matching Unity editor version. | |||
### For <code>6000.3.6f1</code> that means install ''Unity 6.3.'' | |||
### If it was <code>2030.1.1de</code> then install ''Unity 2030.1'' (this version doesn't exist, just using it as an example). | |||
## 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 <code>6000.3.6f1</code> then it is reasonable that both ''Unity 6.3'' and ''Unity 6.3 LTS'' will be compatible. | |||
# Go to <code><nowiki>https://unity.com/</nowiki></code>. | |||
# 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. | |||
# Install the correct version of Unity engine. | |||
## On the left menu find ''Installs'' and navigate to that page. | |||
## In the top right click the ''Install Editor'' button. | |||
## A pop-up should appear where you can search, scroll, and find the version determined in step 1. | |||
== The Unity Project == | |||
[[File:Eco - Unity Installer - Project Creation.png|thumb|''Universal 3D'' project setup on Unity Hub. <u>4/20/2026</u>]] | |||
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: | |||
# On the left menu find ''Projects'' and navigate to that page. | |||
# In the top right click the ''+ New Project'' button. | |||
# Here select the ''Universal 3D'' template. | |||
# <u>If you installed multiple versions of Unity</u>'','' double check the ''Editor version'' box here. Make sure the first four numbers and the numbers after the first dot (e.g.<code>6000.3</code>) match what is in the <code>ProjectVersion.txt</code> file. | |||
# Name the project. | |||
# Select where it will save to. | |||
# Consider using a ''Source Control Provider''. Optional. | |||
# Click ''+ Create project''. | |||
# 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: | |||
# From the top toolbar find and open the ''Assets'' drop down | |||
# Hover the ''Import Package'' option to expand the sub-menu | |||
# Select and click on ''Custom Package...'' A file browser should appear. | |||
# Navigate to the ModKit folder. | |||
# Select the <code>EcoModKit.unitypackage</code> file. | |||
# Press ''Open''. | |||
# A warning will pop-up. | |||
## If this is a fresh new project'','' click ''Import.'' | |||
## If this is a project with stuff in it, make a backup copy before continuing. Continue by clicking ''Import''. | |||
# A window will pop-up titled ''Import Unity Package''. It's listing all the changes being made. | |||
# Click ''Next.'' | |||
# The window will now show any destructive changes it's going to make. | |||
# Continue when ready by clicking ''Import.'' | |||
# The editor will import the ModKit assets. This process may take a few minutes. | |||
# Install Text Mesh Pro features. | |||
## From the top toolbar find and open the ''Window'' drop down. | |||
## Hover ''TextMeshPro'' to expand the sub-menu. | |||
## Select ''Import TextMeshPro Essential Resources'' | |||
## Review the import screen showing changes made. | |||
## Click ''Import''. | |||
<u>For older versions only</u> (<code>Unity 2019.#</code> and <code>Unity 2020.#</code>) of the Unity editor there are more steps: | |||
# From the top toolbar find and open the ''Window'' drop down. | |||
# Hover ''Package Management'' to open the sub-menu. | |||
# Select ''Package Manager''. | |||
# The ''Package Manager'' window should pop-up. | |||
# In the top-left find and click the ''In Project'' tab. | |||
# From it, select ''Unity Registry''. | |||
# Select ''Collections'' from the list. | |||
## In <code>Unity 2019.#</code>, 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.'' | |||
## In <code>Unity 2020.#</code>, 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 <code>com.unity.collections</code> and click the ''Add'' button. | |||
# Go down the list and click ''Install'' on all list items. | |||
= Using ModKit = | |||
[[File:Eco - Unity - ModKit - TemplateScene.png|thumb|ModKit ''Template Scene'' Asset. <u>4/20/2026</u>]] | |||
In Unity's editor, ModKit assets can be found at <code>Assets/EcoModKit</code>. | |||
Read the ''README'' files in <code>Assets/EcoModKit/README.md</code> and <code>Assets/EcoModKit/Docs/README.md</code>. The second one explains better what can be accomplished with ModKit. | |||
For more tutorials on using ModKit see the [[Mod Development]] page. | |||
[[Category: Modding]] | [[Category: Modding]] | ||
Revision as of 20:44, 20 April 2026
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

- Go to https://play.eco/account and login (create your account, if necessary).
- Then on the account page find the Game Downloads section. Inside of that section there will be a button titled ModKit.
- If targeting the current release, click on the only button that says ModKit near the top of that section.
- 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".
- Unsure? Go with the current release version.
- Let it download.
- Unzip or Extract the ModKit archive.
Installing ModKit
Installing Unity

- Determine what version of Unity editor is needed. As of 4/20/2026, the Unity editor is
Unity 6.3.- Look for the
ProjectVersion.txtfile inside the ModKit folder. - Find the line that looks like
m_EditorVersion: 0000.0.000. - Figure the matching Unity editor version.
- For
6000.3.6f1that means install Unity 6.3. - If it was
2030.1.1dethen install Unity 2030.1 (this version doesn't exist, just using it as an example).
- For
- 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.6f1then it is reasonable that both Unity 6.3 and Unity 6.3 LTS will be compatible.
- Look for the
- Go to
https://unity.com/. - 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.
- Install the correct version of Unity engine.
- On the left menu find Installs and navigate to that page.
- In the top right click the Install Editor button.
- A pop-up should appear where you can search, scroll, and find the version determined in step 1.
The Unity Project

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:
- On the left menu find Projects and navigate to that page.
- In the top right click the + New Project button.
- Here select the Universal 3D template.
- 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 theProjectVersion.txtfile. - Name the project.
- Select where it will save to.
- Consider using a Source Control Provider. Optional.
- Click + Create project.
- 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:
- From the top toolbar find and open the Assets drop down
- Hover the Import Package option to expand the sub-menu
- Select and click on Custom Package... A file browser should appear.
- Navigate to the ModKit folder.
- Select the
EcoModKit.unitypackagefile. - Press Open.
- A warning will pop-up.
- If this is a fresh new project, click Import.
- If this is a project with stuff in it, make a backup copy before continuing. Continue by clicking Import.
- A window will pop-up titled Import Unity Package. It's listing all the changes being made.
- Click Next.
- The window will now show any destructive changes it's going to make.
- Continue when ready by clicking Import.
- The editor will import the ModKit assets. This process may take a few minutes.
- Install Text Mesh Pro features.
- From the top toolbar find and open the Window drop down.
- Hover TextMeshPro to expand the sub-menu.
- Select Import TextMeshPro Essential Resources
- Review the import screen showing changes made.
- Click Import.
For older versions only (Unity 2019.# and Unity 2020.#) of the Unity editor there are more steps:
- From the top toolbar find and open the Window drop down.
- Hover Package Management to open the sub-menu.
- Select Package Manager.
- The Package Manager window should pop-up.
- In the top-left find and click the In Project tab.
- From it, select Unity Registry.
- Select Collections from the list.
- 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. - 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. Inputcom.unity.collectionsand click the Add button.
- In
- Go down the list and click Install on all list items.
Using ModKit

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.
For more tutorials on using ModKit see the Mod Development page.