Mod Development

A checked version of this page, approved on 9 July 2022, was based on this revision.

NOTE: The modding system is under heavy development. APIs are expected to change, which may break existing mods! Feel free to update any information on this wiki that is out of date.

To get started on developing mods, see Installing the ModKit. For some example mods, see the EcoModKit repository.

Documentation

Documentation of the server and game client code is available at https://docs.play.eco. This is updated when the game is released to the latest version.

Discord

You can discuss mods and modding on the Template:Eco Discord.

We have multiple channels:

#mod-ads for advertising your own mods.
#mod-dev for talk about the development of mods.
#mod-talk for general talk about mods, such as what existing mods to use or how to make basic changes to the game.
#mod-help for issues with mods.

Tools

Strange Loop Games recommends using the latest versions of Visual Studio and Unity.

Official Guides

Installing the ModKit

Modkit examples

Player Contributed Written Guides

Player Contributed Video Guides

Getting Setup To Make Mods In Eco

Making Your First Item In Eco

Making Your First Item PT2 - World Objects (Unity)

Using Other Mods within Your Own Mod

Other Resources

Eco Modkit (check Wiki tab for documentation)
Tutorial: Ceiling Fan Light