Eco - English Wiki - User contributions [en]

Mod Development

2021-04-10T01:22:15Z

Kye: /* Tools */

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.

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.

== Discord ==
You can discuss mods and modding on the [https://www.discord.gg/eco Eco Discord].

We have multiple channels:
* [https://discord.gg/HXNz478 #mod-ads] for advertising your own mods
* [https://discord.gg/jGmsQNb #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.
* [https://discord.gg/VDxVg3W #mod-help] for issues with mods
* [https://discord.gg/qvDPzGv #mod-tutorials] for links to tutorials
== Tools ==
Strange Loop Games recommends using the latest versions of Visual Studio and Unity.
* Visual Studio 2019
* Unity 2019.4.15f1 for Eco 9.2.4
== Official Guides ==
[[Installing the ModKit]]
<youtube dimensions="400x240" description="Eco New Flag Mod, with animations and materials setup" container="frame">ESETpMIfHl4</youtube>
== Player Contributed Guides ==
* [https://docs.google.com/document/d/1zQFcIxWZcPSZgc3PzbsXHj373Z_ndUW_Q7HfI3iFV5E/edit FZM. Eco Mod Tutorial: Creating New Constructable Blocks]
<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>
== Other Resources ==
* [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]
* [https://github.com/StrangeLoopGames/EcoModKit/wiki/ Eco Modding Wiki] (Wiki for Modding Tutorials)
[[Category: Modding]]

Modding

2021-04-10T01:21:03Z

Kye: /* Installing Mods */

[[File:mods.jpg|Modding a [[Torch]] in Unity|thumb|600px]]
Modding is how the base game is extended with new features such as blocks, animals and additional game play rules. Some mods only change server-side functionality, while others may add additional visualizations and interactions on the client side. Mods may be developed by [[Strange Loop Games]] or independent developers and added to the game by server admins. There is no charge for access to the API and all of the tooling for mod development is freely available.
== Installing Mods ==
Most mods can be installed by placing the mod's files into the Mods folder of an Eco server. Mods may add new files or replace some of the files already found in the Mods folder. Many mod authors will have instructions for installing their mod(s).

Mods that affect the client, such as custom items and models, only need to be installed on the server. The client will automatically receive the information it needs to run the mod from the server.

Server owners can now use [http://Mod.io Mod.io] and modders should consider putting mods there.

Here is a simple video on how to install mods to your eco server:
<youtube dimensions="400x240" description="How To Install A Mod Onto An Eco Server" container="frame">7pTrGbWl20E</youtube>
== Existing Mods ==
'''NOTE:''' It is against Eco Wiki rules to post advertisements for specific mods ''anywhere'' on the Wiki.

For now, most mods are hosted on third-party websites. The best places to find mods currently are:
* [https://eco.mod.io/ Mod.io] — Official host for Eco mods, with API available for mod management. This is the recommended place to download mods, especially if you are new to modding.
* [https://forum.play.eco/filebase/ Eco Forums filebase] — Many more mods than Mod.io, but has no API and is not searchable.
* [https://forum.play.eco/board/10-modding/ Eco Modding Forums] — The modding section of the official forums.
* [https://discord.com/invite/eco Eco Discord server] — The offical Discord server has several modding channels.
== Mod Development ==
See [[Mod Development]]
== Localization ==
=== Crowdin localization testing ===
# Go to [https://crowdin.com/project/eco-by-strange-loop-games Crowdin Site].
# Download latest archive [https://crowdin.com/backend/download/project/eco-by-strange-loop-games.zip archive].
# Go to Eco Server directory.
# Create folder if not exists `Mods\Translations`.
# Extract `defaultstrings.csv` into the `Mods\Translations` directory.
# You need to restart the server to use changed files.
Also you can open the CSV file and edit in in any text editor to test your translations without Crowdin.
=== Mods Translation ===
From previous article [Crowdin localization testing] you can get `.csv` file for reference. You should follow same format, but you can use any file name and put into under your mod directory into `Translations` directory. I.e. `Mods\MySuperMod\Translations\MySuperModStrings.csv`.
[[Category: Modding]]

Mod Development

2021-04-10T01:20:09Z

Kye:

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.

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.

== Discord ==
You can discuss mods and modding on the [https://www.discord.gg/eco Eco Discord].

We have multiple channels:
* [https://discord.gg/HXNz478 #mod-ads] for advertising your own mods
* [https://discord.gg/jGmsQNb #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.
* [https://discord.gg/VDxVg3W #mod-help] for issues with mods
* [https://discord.gg/qvDPzGv #mod-tutorials] for links to tutorials
== Tools ==
Strange Loop Games recommends using the latest versions of Visual Studio and Unity.
* Visual Studio 2019
* Unity 2019.4.x (latest available)
== Official Guides ==
[[Installing the ModKit]]
<youtube dimensions="400x240" description="Eco New Flag Mod, with animations and materials setup" container="frame">ESETpMIfHl4</youtube>
== Player Contributed Guides ==
* [https://docs.google.com/document/d/1zQFcIxWZcPSZgc3PzbsXHj373Z_ndUW_Q7HfI3iFV5E/edit FZM. Eco Mod Tutorial: Creating New Constructable Blocks]
<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>
== Other Resources ==
* [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]
* [https://github.com/StrangeLoopGames/EcoModKit/wiki/ Eco Modding Wiki] (Wiki for Modding Tutorials)
[[Category: Modding]]

Modding

2021-04-10T01:11:07Z

Kye: /* Installing Mods */

[[File:mods.jpg|Modding a [[Torch]] in Unity|thumb|600px]]
Modding is how the base game is extended with new features such as blocks, animals and additional game play rules. Some mods only change server-side functionality, while others may add additional visualizations and interactions on the client side. Mods may be developed by [[Strange Loop Games]] or independent developers and added to the game by server admins. There is no charge for access to the API and all of the tooling for mod development is freely available.
== Installing Mods ==
Most mods can be installed by placing the mod's files into the Mods folder of an Eco server. Mods may add new files or replace some of the files already found in the Mods folder. Many mod authors will have instructions for installing their mod(s).

Mods that affect the client, such as custom items and models, only need to be installed on the server. The client will automatically receive the information it needs to run the mod from the server.

Server owners can now use [http://Mod.io Mod.io] and modders should consider putting mods there.

Here is a simple video on how to install mods to your eco server:
<youtube dimensions="400x240" description="Eco New Flag Mod, with animations and materials setup" container="frame">7pTrGbWl20E</youtube>

== Existing Mods ==
'''NOTE:''' It is against Eco Wiki rules to post advertisements for specific mods ''anywhere'' on the Wiki.

For now, most mods are hosted on third-party websites. The best places to find mods currently are:
* [https://eco.mod.io/ Mod.io] — Official host for Eco mods, with API available for mod management. This is the recommended place to download mods, especially if you are new to modding.
* [https://forum.play.eco/filebase/ Eco Forums filebase] — Many more mods than Mod.io, but has no API and is not searchable.
* [https://forum.play.eco/board/10-modding/ Eco Modding Forums] — The modding section of the official forums.
* [https://discord.com/invite/eco Eco Discord server] — The offical Discord server has several modding channels.
== Mod Development ==
See [[Mod Development]]
== Localization ==
=== Crowdin localization testing ===
# Go to [https://crowdin.com/project/eco-by-strange-loop-games Crowdin Site].
# Download latest archive [https://crowdin.com/backend/download/project/eco-by-strange-loop-games.zip archive].
# Go to Eco Server directory.
# Create folder if not exists `Mods\Translations`.
# Extract `defaultstrings.csv` into the `Mods\Translations` directory.
# You need to restart the server to use changed files.
Also you can open the CSV file and edit in in any text editor to test your translations without Crowdin.
=== Mods Translation ===
From previous article [Crowdin localization testing] you can get `.csv` file for reference. You should follow same format, but you can use any file name and put into under your mod directory into `Translations` directory. I.e. `Mods\MySuperMod\Translations\MySuperModStrings.csv`.
[[Category: Modding]]

Modding

2021-04-10T01:07:43Z

Kye: /* Installing Mods */

[[File:mods.jpg|Modding a [[Torch]] in Unity|thumb|600px]]
Modding is how the base game is extended with new features such as blocks, animals and additional game play rules. Some mods only change server-side functionality, while others may add additional visualizations and interactions on the client side. Mods may be developed by [[Strange Loop Games]] or independent developers and added to the game by server admins. There is no charge for access to the API and all of the tooling for mod development is freely available.
== Installing Mods ==
Most mods can be installed by placing the mod's files into the Mods folder of an Eco server. Mods may add new files or replace some of the files already found in the Mods folder. Many mod authors will have instructions for installing their mod(s).

Mods that affect the client, such as custom items and models, only need to be installed on the server. The client will automatically receive the information it needs to run the mod from the server.

Server owners can now use [http://Mod.io Mod.io] and modders should consider putting mods there.

Here is a simple video on how to install mods to your eco server:<syntaxhighlight lang="html">
<iframe width="560" height="315" src="https://www.youtube.com/embed/7pTrGbWl20E" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
</syntaxhighlight>

== Existing Mods ==
'''NOTE:''' It is against Eco Wiki rules to post advertisements for specific mods ''anywhere'' on the Wiki.

For now, most mods are hosted on third-party websites. The best places to find mods currently are:
* [https://eco.mod.io/ Mod.io] — Official host for Eco mods, with API available for mod management. This is the recommended place to download mods, especially if you are new to modding.
* [https://forum.play.eco/filebase/ Eco Forums filebase] — Many more mods than Mod.io, but has no API and is not searchable.
* [https://forum.play.eco/board/10-modding/ Eco Modding Forums] — The modding section of the official forums.
* [https://discord.com/invite/eco Eco Discord server] — The offical Discord server has several modding channels.
== Mod Development ==
See [[Mod Development]]
== Localization ==
=== Crowdin localization testing ===
# Go to [https://crowdin.com/project/eco-by-strange-loop-games Crowdin Site].
# Download latest archive [https://crowdin.com/backend/download/project/eco-by-strange-loop-games.zip archive].
# Go to Eco Server directory.
# Create folder if not exists `Mods\Translations`.
# Extract `defaultstrings.csv` into the `Mods\Translations` directory.
# You need to restart the server to use changed files.
Also you can open the CSV file and edit in in any text editor to test your translations without Crowdin.
=== Mods Translation ===
From previous article [Crowdin localization testing] you can get `.csv` file for reference. You should follow same format, but you can use any file name and put into under your mod directory into `Translations` directory. I.e. `Mods\MySuperMod\Translations\MySuperModStrings.csv`.
[[Category: Modding]]

Modding

2021-04-10T01:05:17Z

Kye: /* Installing Mods */

[[File:mods.jpg|Modding a [[Torch]] in Unity|thumb|600px]]
Modding is how the base game is extended with new features such as blocks, animals and additional game play rules. Some mods only change server-side functionality, while others may add additional visualizations and interactions on the client side. Mods may be developed by [[Strange Loop Games]] or independent developers and added to the game by server admins. There is no charge for access to the API and all of the tooling for mod development is freely available.
== Installing Mods ==
Most mods can be installed by placing the mod's files into the Mods folder of an Eco server. Mods may add new files or replace some of the files already found in the Mods folder. Many mod authors will have instructions for installing their mod(s).

Mods that affect the client, such as custom items and models, only need to be installed on the server. The client will automatically receive the information it needs to run the mod from the server.

Server owners can now use [http://Mod.io Mod.io] and modders should consider putting mods there.

Here is a simple video on how to install mods to your eco server:

https://www.youtube.com/watch?v=7pTrGbWl20E
== Existing Mods ==
'''NOTE:''' It is against Eco Wiki rules to post advertisements for specific mods ''anywhere'' on the Wiki.

For now, most mods are hosted on third-party websites. The best places to find mods currently are:
* [https://eco.mod.io/ Mod.io] — Official host for Eco mods, with API available for mod management. This is the recommended place to download mods, especially if you are new to modding.
* [https://forum.play.eco/filebase/ Eco Forums filebase] — Many more mods than Mod.io, but has no API and is not searchable.
* [https://forum.play.eco/board/10-modding/ Eco Modding Forums] — The modding section of the official forums.
* [https://discord.com/invite/eco Eco Discord server] — The offical Discord server has several modding channels.
== Mod Development ==
See [[Mod Development]]
== Localization ==
=== Crowdin localization testing ===
# Go to [https://crowdin.com/project/eco-by-strange-loop-games Crowdin Site].
# Download latest archive [https://crowdin.com/backend/download/project/eco-by-strange-loop-games.zip archive].
# Go to Eco Server directory.
# Create folder if not exists `Mods\Translations`.
# Extract `defaultstrings.csv` into the `Mods\Translations` directory.
# You need to restart the server to use changed files.
Also you can open the CSV file and edit in in any text editor to test your translations without Crowdin.
=== Mods Translation ===
From previous article [Crowdin localization testing] you can get `.csv` file for reference. You should follow same format, but you can use any file name and put into under your mod directory into `Translations` directory. I.e. `Mods\MySuperMod\Translations\MySuperModStrings.csv`.
[[Category: Modding]]

Modding

2021-04-10T01:04:51Z

Kye: /* Installing Mods */

[[File:mods.jpg|Modding a [[Torch]] in Unity|thumb|600px]]
Modding is how the base game is extended with new features such as blocks, animals and additional game play rules. Some mods only change server-side functionality, while others may add additional visualizations and interactions on the client side. Mods may be developed by [[Strange Loop Games]] or independent developers and added to the game by server admins. There is no charge for access to the API and all of the tooling for mod development is freely available.
== Installing Mods ==
Most mods can be installed by placing the mod's files into the Mods folder of an Eco server. Mods may add new files or replace some of the files already found in the Mods folder. Many mod authors will have instructions for installing their mod(s).

Mods that affect the client, such as custom items and models, only need to be installed on the server. The client will automatically receive the information it needs to run the mod from the server.

Server owners can now use [http://Mod.io Mod.io] and modders should consider putting mods there.

Here is a simple video on how to install mods to your eco server:

[https://www.youtube.com/watch?v=7pTrGbWl20E]
== Existing Mods ==
'''NOTE:''' It is against Eco Wiki rules to post advertisements for specific mods ''anywhere'' on the Wiki.

For now, most mods are hosted on third-party websites. The best places to find mods currently are:
* [https://eco.mod.io/ Mod.io] — Official host for Eco mods, with API available for mod management. This is the recommended place to download mods, especially if you are new to modding.
* [https://forum.play.eco/filebase/ Eco Forums filebase] — Many more mods than Mod.io, but has no API and is not searchable.
* [https://forum.play.eco/board/10-modding/ Eco Modding Forums] — The modding section of the official forums.
* [https://discord.com/invite/eco Eco Discord server] — The offical Discord server has several modding channels.
== Mod Development ==
See [[Mod Development]]
== Localization ==
=== Crowdin localization testing ===
# Go to [https://crowdin.com/project/eco-by-strange-loop-games Crowdin Site].
# Download latest archive [https://crowdin.com/backend/download/project/eco-by-strange-loop-games.zip archive].
# Go to Eco Server directory.
# Create folder if not exists `Mods\Translations`.
# Extract `defaultstrings.csv` into the `Mods\Translations` directory.
# You need to restart the server to use changed files.
Also you can open the CSV file and edit in in any text editor to test your translations without Crowdin.
=== Mods Translation ===
From previous article [Crowdin localization testing] you can get `.csv` file for reference. You should follow same format, but you can use any file name and put into under your mod directory into `Translations` directory. I.e. `Mods\MySuperMod\Translations\MySuperModStrings.csv`.
[[Category: Modding]]