Mod Development: Difference between revisions

[checked revision]

Revision as of 12:16, 13 June 2024

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 Eco Discord server.

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.

Visual Studio 2022 Community edition (free)
See Unity Downloads to download the version of Unity that matches the ProjectVersion.txt in the modkit you are using.

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

Migrating to new versions

Migrating Mods from 9.5 to 9.6

Other Resources

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

@@ Line 9: / Line 9: @@
 We have multiple channels:
-* [https://discord.gg/HXNz478 #mod-ads] for advertising your own mods.
+* '''#mod-ads''' for advertising your own mods.
-* [https://discord.gg/jGmsQNb #mod-dev] for talk about the development of mods.
+* '''#mod-dev''' for talk about the development of mods.
-* [https://discord.gg/4DgYJAC #mod-talk] for general talk about mods, such as what existing mods to use or how to make basic changes to the game.
+* '''#mod-talk''' for general talk about mods, such as what existing mods to use or how to make basic changes to the game.
-* [https://discord.gg/VDxVg3W #mod-help] for issues with mods.
+* '''#mod-help''' for issues with mods.
 == Tools ==
 Strange Loop Games recommends using the latest versions of Visual Studio and Unity.