Mod Development: Difference between revisions

From Eco - English Wiki
[unchecked revision][checked revision]
No edit summary
 
(37 intermediate revisions by 14 users not shown)
Line 1: Line 1:
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.
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.


For those wanting to learn about how to develop mods, the [https://github.com/StrangeLoopGames/EcoModKit/wiki Eco ModKit wiki] is a great place to start.
To get started on developing mods, see [[Installing the ModKit]]. For some example mods, see the [https://github.com/StrangeLoopGames/EcoModKit EcoModKit] repository.
== Documentation ==
[[File:Eco Modkit Docs.png|link=https://docs.play.eco]]<br>
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 {{EcoDiscord}}.


It contains a link to download the modkit, as well as tutorials on how to make different types of mods. Read through each tutorial to learn how to use the Eco ModKit.
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 ==
{{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.


You can also discuss mods and modding on the [https://discord.gg/Puk7cNv Eco Discord].
== Official Guides ==
[[Installing the ModKit]]


== Tools ==
You can now '''earn a cut of every transaction in worlds that use your mods'''!  Follow this guide to set it up: [[Registered Mods]]
Strange Loop Games recommends using the latest versions of Visual Studio and Unity.
 
* Visual Studio 2019
Modkit examples
* Unity 2019.3
* [[Corn-on-the-cob example mod]]
* [[Flag example mod]]
== Player Contributed Written Guides ==
* [https://docs.google.com/document/d/1zQFcIxWZcPSZgc3PzbsXHj373Z_ndUW_Q7HfI3iFV5E/ FZM. Eco Mod Tutorial: Creating New Constructable Blocks]
* [https://docs.google.com/document/d/1SGDqJoKlHYL16j94L5jISO8281w-uoKuQeAm9KcUOmY/ Eco Mod Tutorial: The Item Class]
== Player Contributed Video Guides ==
<youtube dimensions="400x240" description="Getting Setup To Make Mods In Eco" container="frame">VamhpTr-wG8</youtube>
<youtube dimensions="400x240" description="Making Your First Item In Eco" container="frame">By75wsj_R2o</youtube>
<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>


== Player Contributed Guides ==
== Other Resources ==
[https://docs.google.com/document/d/1zQFcIxWZcPSZgc3PzbsXHj373Z_ndUW_Q7HfI3iFV5E/edit FZM. Eco Mod Tutorial: Creating New Constructable Blocks]
* [https://github.com/StrangeLoopGames/EcoModKit Eco Modkit] (check Wiki tab for documentation)
* [https://github.com/StrangeLoopGames/EcoModKit/wiki/Tutorial-Ceiling-Fan-Light Tutorial: Ceiling Fan Light]
[[Category: Modding]]

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.

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]