Eco Client API

This section documents the available code apis for the Eco client. This documentation will automatically update with each new version of Eco showing only the latest available APIs.

Installing the Modkit

The Unity modkit package can be downloaded from our website at https://www.play.eco. Login to your account and navigate to the "Game Download" section of your account page and click "Modkit" to download the latest Eco modkit files.

Once you have the Modkit zip file unzipped follow these steps to setup your Eco Modkit client Unity project:

1. Check the ProjectVersion.txt file in the ModKit folder, you will need a version that matches the year and first number exactly, but matching or higher than the third is ok.
2. Install Unity if necessary
3. Create a new Unity project, selected "3D" as the template.
4. Click on the "Assets" menu, then "Import Package", then "Custom Package...". Select EcoModKit.unitypackage in the ModKit folder and press "Open", then select "Import".
5. Select the "Window" menu, then click "Open Package Manager". If in the top left it says "In Project", click it and select "Unity Registry". Select "Collections" from the list and then click "Install" down the bottom right.
   1. Unity 2019.x: If you don't see the "Collections" package then you will have to turn on "Preview packages". Look for the "Advanced" drop down button in the "Package manager" and check "Show preview packages".
   2. Unity 2020.x: In this version of Unity some packages are hidden entirely. You can install the package by clicking on the add(plus) button in the "package manager" windows a click "Add package from git URL". Next input "com.unity.collections" and click add.
6. You are now ready to go!