Mod Development: Difference between revisions

[unchecked revision]

[checked revision]

Latest revision as of 17:01, 5 September 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[edit | edit source]

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[edit | edit source]

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[edit | edit source]

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[edit | edit source]

Installing the ModKit

You can now earn a cut of every transaction in worlds that use your mods! Follow this guide to set it up: Registered Mods

Modkit examples

Player Contributed Written Guides[edit | edit source]

Player Contributed Video Guides[edit | edit source]

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[edit | edit source]

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

@@ Line 6: / Line 6: @@
 Documentation of the server and game client code is available at [https://docs.play.eco 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}}.
+You can discuss mods and modding on the {{EcoDiscord}}.
 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.
+{{SLG}} recommends using the latest versions of Visual Studio and Unity.
 * [https://visualstudio.microsoft.com/downloads/ Visual Studio 2022 Community edition] (free)
 * See [https://unity3d.com/get-unity/download/archive Unity Downloads] to download the version of Unity that matches the ProjectVersion.txt in the modkit you are using.
@@ Line 20: / Line 20: @@
 == Official Guides ==
 [[Installing the ModKit]]
+You can now '''earn a cut of every transaction in worlds that use your mods'''!  Follow this guide to set it up: [[Registered Mods]]
 Modkit examples
 * [[Corn-on-the-cob example mod]]
-* [[DiscordAccessMod example mod]]
-* [[EchoCommand example mod]]
-* [[EcopediaPage example mod]]
 * [[Flag example mod]]
 == Player Contributed Written Guides ==
@@ Line 35: / Line 34: @@
 <youtube dimensions="400x240" description="Making Your First Item PT2 - World Objects (Unity)" container="frame">-4JcxeB27jU</youtube>
 <youtube dimensions="400x240" description="Using Other Mods within Your Own Mod" container="frame">hu-Jsk67vdw</youtube>
-== Migrating to new versions ==
-[[Migrating Mods from 9.5 to 9.6]]
 == Other Resources ==