Eco - English Wiki - User contributions [en]

Helpful Examples for Modding

2026-05-25T19:45:22Z

WugWugg: /* Players Interactions */

= Introduction =
Covers helpful examples of complex topics within Eco modding. Provides example code snippets.

Here's a project file structure that covers all the basic functionality:
MyProject
├─ Plugin.cs
├─ Logger.cs
├─ ChatCommands.cs
└─ Registration.cs

= Plugin.cs =
Here's the structure to start with:<syntaxhighlight lang="c#" line="1">
namespace MyProject
{
[SupportedOSPlatform("windows7.0")]
public class MyProjectPlugin
{
// Used with chat commands and for release tracking
public const string VERSION = "v0.0.0";
}
}
</syntaxhighlight><code>[SupportedOSPlatform("windows7.0")]</code> is here to silence some annoying warnings. It's optional.

<code>VERSION</code> is defined here because it's the main code and when that code gets an update the version number should change too.

This example is using semantic versioning. It uses 3 numbers: major version, minor version, and patch version. It can be useful to help communicate how big of an update is made. For example, <code>v2.0.0</code> is a whole major version away from <code>v1.0.0</code>. That indicates a lot of changes. But something like <code>v1.0.1</code> is only a small patch away from <code>v1.0.0</code>. That signals something very trivial has changed. To get a better understanding Google "semantic versioning" and read more.

With all that said, <code>v1</code>, <code>v2</code>, <code>v3</code>... <code>v1058</code>. Is perfectly valid way of versioning too!

=== IModKitPlugin ===
This is what makes Eco's code include this mods code into the game. ''Generally'', this is implemented only once per mod.<syntaxhighlight lang="c#" line="1">using Eco.Core.Plugins.Interfaces;
using Eco.Shared.Localization;

namespace MyProject
{
[SupportedOSPlatform("windows7.0")]
public class MyProjectPlugin : IModKitPlugin
{
// Used with chat commands and for release tracking
public const string VERSION = "v0.0.0";

#region IModKitPlugin
public string GetCategory() => "Mods";

private string _status = "Created...";
public string GetStatus() => Localizer.DoStr($"Status: {_status}");
#endregion
}
}</syntaxhighlight>'''Line 4:''' Added<code>IModKitPlugin</code>to the class.

The <code>#region IModKiPlugin</code> and <code>#endregion</code> is optional and just let's the editor know how to collapse code that is related.

The two fields that this interface needs are <code>GetCategory()</code> and <code>GetStatus()</code>.

'''Line 13:''' Some mod author's prefer to set the category to their mod in specific. For example, "MyProject" instead of the general purpose "Mods". This value will affect where it shows up on the Server GUI.

'''Line 15-16:''' <code>_status</code> is defined as private to only allow this class to alter it's status. See sections on <code>IInitializablePlugin</code> and <code>IShutdownablePlugin</code> to see usage.

This interface on it's own doesn't ''do'' much. It just gets Eco to pickup on the mod and inject it into the runtime.

=== IInitializablePlugin and IShutdownablePlugin ===
These two interfaces aren't required to be implemented at the same time, but often are. That's because Eco is very event-driven. Meaning often mods are waiting and listening for an event to happen before doing something. To do that listening part, the mod must register <u>and release</u> itself as to that event.

One example of a method used to listen to game actions is <code>ActionUtil.AddListener()</code>. This method will be used and explained in the further section on <code>IGameActionAware</code> below. For now, the point is that method needs called once on mod startup and once on mod shutdown. Another example would be listening to store's offers changing with <code>StoreItemData.SellOffersChangedEvent.AddUnique()</code> which let's the mod respond to trade offers changing. While this store even won't be covered here, it's being mentioned to show how there are many different event sources in Eco's code. If the mod registers as a listener, then it needs to remove itself as a listener.

The <code>Initialize</code> function is the first "hook" this mod gets to run code. From here you can access different services and inspect the world. For example, to get a list of all stores:

<code>var stores = WorldObjectManager.GetWorldObjectsFromComponent(typeof(StoreComponent));</code>

Outlining all the managers and services in Eco is beyond this page's scope, but the point is to demonstrate that at this point in the code the game is largely loaded and running.<syntaxhighlight lang="c#" line="1">using Eco.Core.Plugins.Interfaces;
using Eco.Core.Utils;
using Eco.Gameplay.Components.Store.Internal;
using Eco.Gameplay.GameActions;
using Eco.Shared.Localization;

namespace MyProject
{
[SupportedOSPlatform("windows7.0")]
[Priority(PriorityAttribute.Normal)] // VeryHigh, High, Normal, Low, VeryLow
public class MyProjectPlugin: IModKitPlugin, IInitializablePlugin, IShutdownablePlugin
{
#region IModKitPlugin

#region IInitializablePlugin
public void Initialize(TimedTask timer)
{
_status = "Initializing...";
// Example Listeners:
// StoreItemData.SellOffersChangedEvent.AddUnique(HandleOffersChanged);
// ActionUtil.AddListener(this);
//
// To see when this function is called try something like and run the game:
// Logger.Debug("Initializing MyProject")
_status = "Running";
}
#endregion

#region IShutdownablePlugin
public Task ShutdownAsync()
{
_status = "Stopping...";
// Example Cleanup:
//StoreItemData.SellOffersChangedEvent.Remove(HandleOffersChanged);
//ActionUtil.RemoveListener(this);
//
// To see when this function is called try something like and run the game:
// Logger.Debug("Cleaning Up MyProject")
_status = "Stopped";
return Task.CompletedTask;
}
#endregion
}
}</syntaxhighlight>'''Line 10:''' This attribute sets the mod's load priority. It controls when the mod is loaded in relation to other mods. <code>PriorityAttribute.VeryHigh</code> is for things that need to start-up first and stop last. It's not recommended to use this priority unless you know what you are doing. <code>PriorityAttribute.VeryLow</code> will do the opposite. It will try to load your mod last and stop it first. Useful if you want to wait for other mods to load in and make their changes first.

'''Line 11:''' Added <code>IInitializablePlugin</code> and <code>IShutdownablePlugin</code> to the class.

'''Line 14:''' Notice how <code>TimedTask timer</code> isn't being used. That's because for most mods are quick to initialize and don't need to report back on their progress. That's what this timer does. It's a way for the mod to say "Still loading... 50% done". You could use it though, something <code>timer.LoadPercentage = (float)doneWork / (float)totalWork;</code> to report progress. Again, most mods don't need this because they start in seconds, but nice to know about.

'''Note:''' While it should technically be possible to alter recipes at this point, it's still very tricky to programatically do it. Changes at this point through <code>RecipeManager</code> tend to result in crashes or only paritial lists of recipes returned. Don't let this stop your mod though, just be aware!

=== IConfigurablePlugin ===
This interface tells Eco that there should be a config file to load and save to when you load this mod.<syntaxhighlight lang="c#" line="1">
using Eco.Core.Plugins;
using Eco.Core.Plugins.Interfaces;
using Eco.Core.Utils;
using Eco.Gameplay.Components.Store;
using Eco.Gameplay.Components.Store.Internal;
using Eco.Gameplay.GameActions;
using Eco.Gameplay.Items;
using Eco.Gameplay.Items.Recipes;
using Eco.Gameplay.Objects;
using Eco.Mods.TechTree;
using Eco.Shared.Localization;
using Eco.Shared.Utils;
using System.Runtime.Versioning;

namespace MyProject
{

[Localized]
public class MyProjectConfiguration : Singleton<MyProjectConfiguration>
{
[LocDescription("Optional. Name of the effect to use.")]
public string EffectName { get; set; } = string.Empty;

[LocDescription("Required, but has default. The amount of minutes that must pass.")]
public int Duration { get; set; } = 30;
}

[SupportedOSPlatform("windows7.0")]
public class MyProjectPlugin: IModKitPlugin, IInitializablePlugin, IShutdownablePlugin, IConfigurablePlugin
{
#region IModKitPlugin

#region IIInitializablePlugin

#region IShutdownablePlugin

#region IConfigurablePlugin
readonly PluginConfig<MyProjectConfiguration> config = new("MyProject");
public ThreadSafeAction<object, string> ParamChanged { get; set; } = new();
public IPluginConfig PluginConfig => this.config;
public object GetEditObject() => this.config.Config;
public void OnEditObjectChanged(object o, string param)
{
if (param == "Duration")
{
Logger.Info($"Someone changed the MyProject's duration: {config.Config.Duration}");
}
// Notify downstream
ParamChanged.Invoke(o, param);
// Write changes to config file
this.SaveConfig();
}
#endregion

}
}
</syntaxhighlight>'''Line 18:''' <code>[Localized]</code> makes it so that the variable names are translated and localized for the user on the server GUI. Example, duration (English) might become durée (French) if the user's game detects that as their local.

'''Line 19:''' The configuration doesn't need to implement <code>Singleton<MyProjectConfiguration></code> but it's helpful if the mod grows in complexity. What the singleton pattern allows is code from anywhere to get access to the same instance of data. No need to pass it around. If any part of the code wants to see into the config do: <code>MyProjectConfiguration.Obj.Duration</code>, for example. It might not seem super useful, but as code grows in size it becomes very convenient.

'''Line 21:''' <code>[LocDescription()]</code> Adds a description to the variable in the server GUI and translates it for the user.

'''Line 29:''' Added <code>IConfigurablePlugin</code> to the class.

'''Line 38:''' Creates and loads from file the configuration. <code>new("MyProject")</code> is doing a lot of work here. Under the hood Eco is looking for the file in the <code>.../Eco Server/Configs</code> directory. In this case it's looking for <code>MyProject.eco</code>. It also will make the <code>MyProject.eco.template</code> file from default values too.

'''Line 39:''' This is the hook for other code to listen for changes to this mods config. Not crazy useful, but make sure it does get called when a changed happens. It's impossible to know if later on some code will use that! Be nice and hook it up. See: line 49 notes.

'''Line 40:''' Public access to this mods config as <code>config</code> is private by default.

'''Line 42-47:''' Require method for this interface and example showing how to detect what changed. At this point <code>o</code>, <code>config.Config</code>, and <code>MyProjectConfiguration.Obj</code> reference the same data. <code>o</code> is annoying to use since it's passed as <code>object</code>, but the underlying data should be of the form <code>MyProjectConfiguration</code>.

'''Line 49:''' This is the code that actually forwards changes to other parts listening to this mod's configuration changes. While that doesn't seem like it would happen offen, it's easy to hookup. The mod is responsible for doing this manually!

'''Line 51:''' Saves the config out to file, <code>MyProject.eco</code>. The mod is responsible for saving changes to disk!

=== IGameActionAware ===
This is where most mod ideas hook into the engine. This interface allows the mod to be notified when any game action occurs.

With that said, be careful here and code efficiently becuase the <code>ActionPerformed</code> function is called a lot! The first thing the mod should do is filter to exactly the type of action it is waiting for before doing any computation, if possible.<syntaxhighlight lang="c#" line="1">
using Eco.Core.Plugins;
using Eco.Core.Plugins.Interfaces;
using Eco.Core.Utils;
using Eco.Gameplay.Aliases;
using Eco.Gameplay.Components.Store;
using Eco.Gameplay.Components.Store.Internal;
using Eco.Gameplay.GameActions;
using Eco.Gameplay.Items;
using Eco.Gameplay.Items.Recipes;
using Eco.Gameplay.Objects;
using Eco.Gameplay.Property;
using Eco.Mods.TechTree;
using Eco.Shared.Localization;
using Eco.Shared.Utils;
using System.Runtime.Versioning;

namespace MyProject
{
// ...

[SupportedOSPlatform("windows7.0")]
public class MyProjectPlugin: IModKitPlugin, IInitializablePlugin, IShutdownablePlugin, IConfigurablePlugin, IGameActionAware
{
#region IModKitPlugin

#region IIInitializablePlugin

#region IShutdownablePlugin

#region IConfigurablePlugin

#region IGameActionAware
public async void ActionPerformed(GameAction action)
{
if (action is ChatSent chat)
{
Logger.Info($"{chat.Citizen} said {chat.Message}");
}
}

public LazyResult ShouldOverrideAuth(IAlias? alias, IOwned? property, GameAction? action)
{
return LazyResult.FailedNoMessage;
}
#endregion

}
}
</syntaxhighlight>'''Line 22:''' Added <code>IGameActionAware</code> to the class

'''Line 33:''' Method that will be called any time there's a game action happening. See a list of game actions here: <code><nowiki>https://docs.play.eco/api/server/eco.gameplay/Eco.Gameplay.GameActions.html</nowiki></code>

'''Line 35:''' Example of filtering to just <code>ChatSent</code> actions.

'''Line 41:''' This is often not used and the method can be left as is. What it does is tell the game if this action should be allowed because of speical ruling. Think: laws that allow a player to hunt on other peoples deeds. That law would be overriding the normal authorization checks. ''Generally'', the mod can return <code>LazyResult.FailedNoMessage</code> to say 'No, don't create a special exception for this action'.

=== IWorkerPlugin ===
Here this example just covers a basic worker pattern that runs a task after a delay.

This code will be repeatedly called. Be very efficient with what you do here because it's easy to tank a server's performance by doing expensive computations every loop (4 times a second in this example).<syntaxhighlight lang="c#" line="1">
using Eco.Core.Plugins;
using Eco.Core.Plugins.Interfaces;
using Eco.Core.Utils;
using Eco.Core.Utils.Logging;
using Eco.Gameplay.Aliases;
using Eco.Gameplay.Components.Store;
using Eco.Gameplay.Components.Store.Internal;
using Eco.Gameplay.GameActions;
using Eco.Gameplay.Items;
using Eco.Gameplay.Items.Recipes;
using Eco.Gameplay.Objects;
using Eco.Gameplay.Property;
using Eco.Mods.TechTree;
using Eco.Shared.Localization;
using Eco.Shared.Utils;
using Eco.Simulation.Time;
using System.Runtime.Versioning;

namespace MyProject
{

// ...

[SupportedOSPlatform("windows7.0")]
[Worker(Repeatable = true, ThreadPriority = ThreadPriority.Normal)]
public class MyProjectPlugin: IModKitPlugin, IInitializablePlugin, IShutdownablePlugin, IConfigurablePlugin, IGameActionAware, IWorkerPlugin
{
#region IModKitPlugin

#region IIInitializablePlugin

#region IShutdownablePlugin

#region IConfigurablePlugin

#region IGameActionAware

#region IWorkerPlugin
public const int DELAY_MS = 250;
public async Task DoWork(CancellationToken token)
{
while (!token.IsCancellationRequested)
{
try
{
await Task.Delay(DELAY_MS, token);
// Scan the world for something...
// do work on it
}
catch (OperationCanceledException) when (token.IsCancellationRequested) { break; }
catch (Exception e)
{
Logger.Info($"worker crashed: {e}");
}
}
// Stop and cleanup
}
#endregion
}
}

</syntaxhighlight>'''Line 25:''' This declares the working as something that will run more than once and that it should have a normal threading priority (interrupted only when something with higher priority needs to run).

'''Line 42:''' Creates the loop that keeps this repeating. Without it Eco would just call this once and be done! In this the mod is also checking that it hasn't been told to cancel this work. If it has been told to cancel it's wise to save and cleanup before stopping because sooner or later something will end this thread. It might not be nice about it either.

'''Line 46:''' This is the line that creates a delay between calls. Very necessary. Without it we would run as many times as the server could handle. Maxing out the CPU! This would be bad and most people might uninstall the mod becuase of performance issues like lag. Adjust the <code>DELAY_MS</code> to give enough time between calls that the server can get to other things, but not so long that this mod is clunky and slow to react. It's a balance.

'''Line 50:''' Catching the cancellation and gracefully breaking the while loop.

'''Line 53:''' Catching all other exceptions and logging them.

'''Line 56:''' If the mod had cleanup to do from this thread, it would do it here.

= Logger.cs =
To write to the logs I use the class <code>Eco.Core.Utils.Logging.NLogManager</code>.

The Logger.cs file:<syntaxhighlight lang="c#" line="1">
using Eco.Core.Utils.Logging;
using Eco.Gameplay.Systems.Messaging.Notifications;
using Eco.Shared.Localization;
using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Runtime.Versioning;
using System.Text;

namespace MyProject
{
static class Logger
{
const string NAME = "MyProject";

[Conditional("DEBUG")]
public static void Debug(string message)
{
NLogManager.GetEcoLogWriter().Write($"[{NAME}] {message}\n");
}

[Conditional("DEBUG")]
[SupportedOSPlatform("windows7.0")]

public static void NewsFeed(string message)
{
NotificationManager.ServerMessageToAll(Localizer.DoStr(message));
}

public static void Info(string message)
{
NLogManager.GetEcoLogWriter().Write($"[{NAME}] {message}\n");
}
}
}

</syntaxhighlight>Now in the project it is possible to use this with <code>Logger.Info("Hello, World!")</code>. It will print out <code>[MyProject] Hello, World!</code> to the logs.

<code>Logger.Debug("Debug Message")</code> will do the same thing as Info. In this case printing <code>[MyProject] Debug Message</code> to the logs, but notice the line above it -- <code>[Conditional("DEBUG")]</code>. This line keeps any calls to this method from getting into a release build. They just won't exists and no message will be printed. Use this for printing things that are only helpful during development. Rest assured it's not spamming the logs or the news feed (notice that method has a conditional attribute too).

Additionally, <code>Logger.NewsFeed("Hello")</code> will print <code>Hello</code> in the games feed (the place where you see messages for people logging in and out, other trades, people learning skills, etc.).

<code>[SupportedOSPlatform("windows7.0")]</code> Is only there to prevent the warnings from popping up and is completely optional.

= ChatCommands.cs =
Having a version number is important because it helps the users know what will work with their Eco version. While it's helpful to include the version number in the name of the DLL, it's also helpful to provide a way for users to check in case that file is renamed/lost. Here's a basic chat command that prints the mod's version out:<syntaxhighlight lang="c#" line="1">
using Eco.Gameplay.Systems.Chat;
using Eco.Gameplay.Systems.Messaging.Chat.Commands;
using System;
using System.Collections.Generic;
using System.Runtime.Versioning;
using System.Text;

namespace MyProject
{
[ChatCommandHandler]
[SupportedOSPlatform("windows7.0")]
public static class MyProjectCommands
{
[ChatCommand("myproject", ChatAuthorizationLevel.Moderator)]
public static void myproject(IChatClient chat)
{
chat.MsgLoc($"Version: {MyProjectPlugin.VERSION}");
}
}
}
</syntaxhighlight>This adds the command <code>/myproject</code> to Eco. When ran it would reply something like <code>Version: v0.0.1</code> to the in-game chat.

Note (line 17): <code>MyProjectPlugin.VERSION</code> is not defined in this project. Instead it's defined inside of the plugin's main code, <code>Plugin.cs</code>, because it's mostly changed when the main code changes.

= Registration.cs =
See page [[Registered Mods]] for more information about why register and additional steps necessary.<syntaxhighlight lang="c#" line="1">
using Eco.Core.Plugins.Interfaces;
using Eco.Shared.Localization;
using System;
using System.Collections.Generic;
using System.Text;

namespace MyProject
{
public class MyProjectRegistration : IModInit
{
public static ModRegistration Register() => new()
{
ModName = "MyProject",
ModDescription = Localizer.DoStr($"MyProject does something new!"),
ModDisplayName = "My Project"
};
}
}

</syntaxhighlight>Change the values of <code>ModName</code>, <code>ModDescription</code>, <code>ModDisplayName</code> to something that fits the mod.

The key in this file is the <code>IModInit</code> interface that's being implemented on line 9. This is what Eco's code will look for when trying to find mods to be registered.

Note: At the time of writing if <code>IModInit</code> was implemented for the same class that <code>IModKitPlugin</code> was the mod would crash. That's why it's being done with a separate class here.

= Players Interactions =

=== Game Messages ===
broadcast, side-message, on-screen, notification

=== Player Choices ===
Go through popups types

=== Other Popups ===
<code>Player.OpenInfoPanel</code>

From 3D Asset to Working Worktable

2026-04-30T18:49:27Z

WugWugg:

= Introduction =
Below is a guide on how to take an 3D asset from the Unity Store and make a working workbench in Eco. This includes:
* Creating a recipe to craft the modded table
* Creating recipes so the player can use the modded table to craft something
* Using Blender to generate a modded icon (seen when holding it in inventory)
* Using Blender to adjust the origin point of the model
* How to setup all this in a Unity scene and package for Eco

= Setup =

* Already have setup '''ModKit + Unity'''
** See: [[Installing the ModKit]]
* Have a '''3D model'''
** Just following along? Find the one used here at <code><nowiki>https://assetstore.unity.com/packages/3d/props/low-poly-medieval-market-stalls-314286</nowiki></code>
* A '''C# IDE''' (notepad++, Visual Studio, etc.)
** Highly encouraged to have an Intellisense setup and linked to the '''Reference Assemblies'''. Optional, but its really worth the time to figure out because it will help quickly correct small typos and trivial mistakes.
** See: [[Getting Started with Eco Modding in Visual Studio 2022]] (generally the same steps apply if using a new version of Visual Studio)
* '''Blender''' installed
** Homepage: <code><nowiki>https://www.blender.org/</nowiki></code>

== Importing the Assets ==

# Open the Unity editor to the project.
# From the top toolbar open the ''Window'' drop down.
# Hover ''Package Management'' to open sub-menu.
# Select ''Package Manager''.
# The ''Package Manager'' window will pop-up.
# Install the package containing the assets you want to use...
## <u>If not using Unity Registry</u>...
### Find the ''+▾'' button in the top left and open the drop down.
### Install the package from one of those options.
## <u>If using Unity Registry</u>...
### Visit <code><nowiki>https://assetstore.unity.com</nowiki></code> and sign in.
### Search for the asset desired.
### Go to it's page (e.g. <code><nowiki>https://assetstore.unity.com/packages/3d/props/low-poly-medieval-market-stalls-314286</nowiki></code>) and click the big blue button, ''Add to My Assets.''
### Now, in the Unity editor and back at the ''Package Manager'' window.
### Find ''My Assets'' on the left menu and navigate to it.
### Click the ''⟳'' button in the lower-right.
### The asset should be in the list now. Use the search to filter if needed.
### Click on the asset in the list. For those following along, ''Low Poly Medieval Market Stalls''.
### In the right panel, find the ''Download ⤓'' button. Click it.
### Once downloaded, a new button should show up, it'll say something like ''⊕ Import 1.0 to project'' . Click it.
### The ''Import Unity Package'' window will pop-up.
### Select ''Import'' on it.
# Verify you can find your assets from the explorer. If following along, the assets are at <code>Assets/PolyRonin/Medieval Market Stalls</code>.
# Load in a demo scene, if provided, and make sure everything looks okay.
## For those following along, double click on the ''Demo'' scene at <code>Assets/PolyRonin/Medieval Market Stalls/Demo.unity</code>.

[[File:Eco - Unity - View Modes.png|thumb|Underlined in red are the different draw mode buttons. <u>4/20/26</u>]]
If something seems off, check the different draw modes and see if changing those allow the scene to render as expected (see picture).

= Creating The Worktable =
This guide will create the worktable in this order:

# Create the item that represents the worktable
# Make a recipe to craft the worktable item
# Make the worktable item something that places a world object
# Give the worktable functionality by adding recipes to it

== Creating the Item ==

=== Item Icon ===
[[File:TeamstersStall - StallOnly - 256x256.png|thumb|A large (256x256px) icon created of Stall4 from the medieval assets.]]
# Open <u>Blender</u>.
# Delete everything in the ''Scene Collection''. Find this section in the top-right of the application.
# From the top toolbar, open the ''File'' drop down.
# Hover ''Import'' to open the sub-menu.
# Select the type of 3D asset. For those using medieval assets, select ''FBX (.fbx)''.
# Find the asset on the computer...<br>'''Tip:''' Use Unity to find the <code>.fbx</code> asset.
## For the medieval assets, that's in <code>Assets/PolyRonin/Medieval Market Stalls/Meshes/medieval-market-stalls-1.fbx</code>.
## Right click on it and select ''Show in explorer''.
## Now copy the address of that folder from Explorer. It might look like <code>C:\Users\Wug\EcoMod--WikiDemo\WikiDemo\Assets\PolyRonin\Medieval Market Stalls\Meshes</code>.
## Paste that in the address bar of the <u>Blender</u> import pop-up.
# Select the blue ''Import FBX'' button''.''
# Be in the ''Layout'' workspace (top toolbar) and in the ''Object Mode...''
## Find the drop down in the second toolbar from the top that has options like ''Object Mode, Edit Mode, Sculpt Mode,'' etc.
## Select ''Object Mode'' from that drop down.
# Change the Viewport Shading to Material Preview or Rendered. This is on the second toolbar down, far right of center, but before ''Scene Collection'' section.
# If you see purple models, Blender will need help finding textures for these meshes...
## From the top toolbar, open the ''File'' drop down.
## Hover ''External Data'' to open the sub-menu.
## Select ''Find Missing Files...''
## Point this to the whole directory that the 3D assets came in. For the medieval pack, <code>C:\Users\</code><code>Wug\EcoMod--WikiDemo\WikiDemo\Assets\PolyRonin</code>.
## The proper textures/materials should have now loaded in. If it hasn't, consult Google because without the textures the following steps won't produce a usable icon.
# Add a source of light...
## Still be in the ''Layout'' workspace (top toolbar) and in the ''Object Mode...''
### Find the drop down in the second toolbar from the top that has options like ''Object Mode, Edit Mode, Sculpt Mode,'' etc.
### Select ''Object Mode'' from that drop down.
## From the toolbar just under that one, find and open the ''Add'' drop down.
## Hover ''Light'' to open that sub-menu.
## Click ''Sun''.
# Add a camera...
## In the ''Layout'' workspace (top toolbar) and in the ''Object Mode...''
### Find the drop down in the second toolbar from the top that has options like ''Object Mode, Edit Mode, Sculpt Mode,'' etc.
### Select ''Object Mode'' from that drop down.
## From the second toolbar down, find and open the ''Add'' drop down.
## Select ''Camera''.
# Setup the scene with the object placement and lighting direction desired.<br>'''Tip:''' To reset the editor to something selected press the period key <u>on the numpad</u>. Without a numpad, use ''View'' (second toolbar from the top) and select ''Frame Selected'' from it. Alternatively, just set the zoom to zoom to the mouse position: ''Edit'' (top toolbar), ''Preferences'' (from drop down), ''Navigation'' (on left menu), ''Zoom to Mouse Position'' (In the zoom section). This makes moving around a lot more natural feeling.
# Setup the rendering camera...
## Go to ''Rendering'' tab on the top toolbar
## On the right there will be a side-panel open, it should be the ''Render'' tab. Confirm that.
## Change ''Render Engine'' to ''Cycles''.
## Look down below in the same tab for the ''Film'' section.
## Expand it and find the ''Transparent'' checkbox and section. Click it so that it has a check mark. This will make the icon's background transparent.
## Now, go to the ''Output'' tab <u>on the side panel</u>. The tab is just below the current one.
## In the ''Format'' section set ''Resolution X'' to ''64.'' And ''Y'' to ''64'' as well. This will make the icon generated a 64 by 64 pixel image.
# Go back to the ''Layout'' tab from the top toolbar.
# Center your view on the object (numpad period or ''View > Frame Selected''). Adjust it so that the object is how it should be for the icon.
# Align the camera to the view...
## Make sure the editor is in ''Layout'' workspace (top toolbar) and in the ''Object Mode...''
### Find the drop down in the second toolbar from the top that has options like ''Object Mode, Edit Mode, Sculpt Mode,'' etc.
### Select ''Object Mode'' from that drop down.
## Find ''View'' from the second from the top toolbar and open the drop down.
## Hover ''Align View'' to open the sub-menu.
## Select ''Align Active Camera To View''.
## If the view is slightly off, there is a lock icon on the right side of this panel. Use it to "lock" controls to the camera and tweak it's view.
# Now return to the ''Rendering'' tab from the top toolbar.
# Press the F12 key to start the render. This should complete quickly since 64x64 pixels is a very small render.
# A window should popup, ''Blender Render''. This is the icon!
# From the top tool bar of this ''Blender Render'' window, open the ''Image'' drop down.
# Select ''Save As...'' to save somewhere on the computer.
# Return to step 13 and repeat to do larger images if desired. Create a 128 by 128 pixel image too. It will make things smoother later.
# Save the Blender scene. Not only will it be used later, this will make making a new icon with a small tweak that much easier.
## ''File'' drop down from top toolbar.
## ''Save As...'' to save the Blender scene to the computer.
## Save it to <code>Assets/WikiDemo/MedievalStall - Icon Scene.blend</code>.

=== Adding to Unity Scene ===
The developers explain how to create an item in one of ModKit's read me files (See: <code>Assets/EcoModKit/Docs/README.md</code>), but this guide will explain it below.

Additionally, '''TheKye''' on YouTube covers this in their ''Creating Your First Item'' and ''Creating Your First Item Pt 2'' videos.

Use those additional resource to help troubleshoot issues with item's icons.

# Open <u>Unity</u>.
# In the left panel, the ''Hierarchy'' tab should be selected.
# Select the top-most object there. It should be a scene. If the editor last loaded the ''Demo'' scene from the medieval assets, it'll be named ''Demo''.
# Right click on this scene and select ''Add New Scene'' from the menu.
# Right click again on the old scene (''Demo'') and select ''Remove Scene''.
# Let it save if the changes to the old scene are important. Discard if it was open just for exploration's sake.
# Right click the new, ''Untitled'' scene. Click ''Save Scene As...''
# Save it to <code>Assets/WikiDemo.unity</code>.
# Delete <u>anything</u> in the scene.
# Right click the scene, hover ''GameObject'', and select ''Create Empty'' from the sub-menu.
# Name this new object ''Objects''.
# Select the newly created ''Objects'' object from the ''Hierarchy'' menu.
# On the far right side of the screen, in the ''Inspector'' menu, click the ''Add Component'' button.
# Type in ''ModkitPrefabContainer''. Click on the component from the search to add it. The component now should be listed in the ''Inspector''.
# In the ''Hierarchy'' panel right click the scene, hover ''GameObject'', and select ''Create Empty''.
# Name this new object ''Items''.
# Right click the scene, hover ''GameObject'', and select ''Create Empty''.
# Name this new object ''Emoji''.
# Select the newly created ''Emoji'' object, find the ''Inspector'' menu (far-right), and click the ''Add Component'' button.
# Type in ''ChatEmoteSetOld''. Click on the component from the search to add it. That component should now be listed in the ''Inspector''.
# Right click the scene, hover ''GameObject'', and select ''Create Empty''.
# Name this new object ''BlockSets''.
# Select the newly created ''BlockSets'' object, find the ''Inspector'' menu (far-right), and click ''Add Component''.
# Search for ''BlockSetContainer''. Click on the component from the search to add it. The ''Inspector'' should now show that component as added.
#Go to <code>Assets/EcoModKit/Prefabs</code> in the Unity project window.
# Find the prefab ''ItemTemplate''.
# Drag it onto the ''Items'' object in the ''Hierarchy'' panel. It should add it as a <u>child</u> of the ''Items'' object.
# Right click on the new ''ItemTemplate'' object, hover ''Prefab'', and select ''Unpack Completely''.
# Right click on the ''ItemTemplate'' object and select ''Rename''. Name this what you want the item to be called. Example: ''MedievalStallItem''.
# Set this item's background...
## Here's the default backgrounds (blue = item, brown = block, green = food): <br>[[File:Eco - Item - Background.png|border|frameless]] [[File:Eco - Block - Background.png|frameless]] [[File:Eco - Food - Background.png|frameless]]
## Download or prepare the background and add it to the <code>Assets</code> folder in Unity.
### To follow along lockstep, put the background in a new <code>Assets/WikiDemo</code> folder.
### Right click on <code>Assets</code> folder, hover ''Create'', select ''Folder''.
### Name the folder ''WikiDemo''.
## Configure Unity to use these as sprites...
### Select the background(s) added (Ctrl+Click each one).
### In the ''Inspector'', find ''TextureType'' and change that to ''Sprite (2D and UI)''.
### Again in the ''Inspector'', find ''SpriteMode'' and change that to ''Single''.
### Then scroll and go to the bottom of the ''Inspector'' and find the ''Apply'' button.
### This will apply those changes to that file and all other ones highlighted.
## Select the item being created (''MedievalStallItem'').
## In the ''Inspector'' panel (far-right), scroll and find the ''Item Template (Script)'' section.
## In here find the ''Background'' input. It'll say ''Background (Image)'' in it. If clicked that text to reveal and highlight the related object in the ''Hierarchy'' panel.
## Select the revealed, and highlighted object ''Background''.
## In the ''Inspector'' panel, scroll and find the ''Image'' component section.
## Inside that component's section, find ''Source Image''. It'll say ''Missing (Sprite)''. Click the ''⦿'' button to the right.
## The ''Select Sprite'' popup will show. Make sure the ''Assets'' tab is selected, and find the backgrounds desired.
#Create the foreground image...
##This is easily accomplished in MS Paint.
##Get to the background image file in a <u>file explorer</u>.
##Right click on it, hover ''Open with...'', and select ''Paint''.
##The solid background should be displayed.
##Open the ''File'' menu from the top toolbar.
##Hover ''Import to Canvas'' and select ''From a File''.
##Find the icon in the file browser and import it. Match the size of the background image to have it nicely center itself.
##Now ''File'' from the top toolbar.
##Hover ''Save As...'' and select ''PNG''.
##Save this to the <code>Assets/WikiDemo</code> folder in Unity.
##Configure Unity to use these as sprites...
### Select the foreground image.
### In the ''Inspector'', find ''TextureType'' and change that to ''Sprite (2D and UI)''.
### Again in the ''Inspector'', find ''SpriteMode'' and change that to ''Single''.
### Then scroll and go to the bottom of the ''Inspector'' and find the ''Apply'' button.
### This will apply those changes to that file and all other ones highlighted.
#Set this item's foreground...
## Copy the item's icon into the <code>Assets</code> folder.
## Configure Unity to use it as a sprite (see the previous step's ''Set this item's background...'' instructions)
## Select the item being created (''MedievalStallItem'').
## In the ''Inspector'' panel (far-right), scroll and find the ''Item Template (Script)'' section.
## In here find the ''Foreground'' input. It'll say ''Foreground (Image)'' in it. If clicked that text to reveal and highlight the related object in the ''Hierarchy'' panel.
## Select the revealed, and highlighted object ''Foreground''.
## Use the ''Inspector'', find the ''Image'' component, within that component find the ''Source Image'' input. It will say ''Missing (Sprite)''.
## Click the ''⦿'' button to the right of that input.
## From the ''Select Sprite'' popup, ensure the ''Assets'' tab is being searched, and find the icon just created.

=== Export From Unity ===

# Open the ''File'' menu from the top toolbar.
# Select ''Save.'' Save it to the <code>Assets/WikiDemo</code> folder.<br>'''Note:''' Do not skip. The scene must be saved for the ModKit build to work properly.
# Open the ''Eco Tools'' menu from the top toolbar.
# Hover ''Mod Kit'' to open the sub-menu.
# Select ''Build Current Bundle''.
# Have it output the bundle to <code>/Eco Server/Mods/UserCode/WikiDemo.unity3d</code>
# Wait for this to build. This may take a few minutes.

=== Coding the Item ===
For this guide, all code will be placed in a single <code>.cs</code> file and will not be compiled into a <code>.dll</code>.

# Create a <code>.cs</code> file: <code>/Eco Server/Mods/UserCode/WikiDemo.cs</code>
# Put the following into the newly created file:
<syntaxhighlight lang="c#" line="1">using Eco.Core.Items;
using Eco.Gameplay.Items;
using Eco.Shared.Localization;
using Eco.Shared.Serialization;

namespace WikiDemo
{
#region Item
[Serialized] // Tells the save/load system this object needs to be serialized.
[LocDisplayName("Market Stall")] // Defines the localized name of the item.
[Weight(100)] // Defines how heavy this is.
[Ecopedia("Work Stations", "Craft Tables", createAsSubPage: true)]
[LocDescription("A medieval market stall.")] //The tooltip description for the item.
public partial class MedievalStallItem: Item { }
#endregion
}</syntaxhighlight>'''Line 8:''' A region tag. Lets the editor know it can collapse all of that code as a section. The following examples in this guide will just show <code>#region Item</code> in their code examples.

'''Line 13:''' The implementation of <code>Item</code> means that Eco will find this and look for Unity assets that matching this class' name, <code>MedivalStallItem</code>. While this doesn't do anything fancy, it completes the first step towards a new workbench.

=== Checkpoint #1 ===
[[File:Eco - Hotbar With Modded Icon.png|thumb|Shows the medieval stall as a modded icon in-game.]]
Make sure everything is running smoothly by doing the following:

# Double-check that the <code>WikiDemo.unity3d</code> and the <code>WikiDemo.cs</code> files are in <code>/Eco Server/Mods/UserCode</code> folder.
# Start the server and connect to it.
# Test it out by typing <code>/give MedievalStall</code> in chat.
## It's also possible to do <code>/give Market Stall</code> to get the item. How? Line 10: of the the above code declares that name as this item's "common name". Neat.
# The item should appear in the players inventory with a working icon.

== Code the Item's Recipe ==
The following goes over how to add a new class and implement the <code>RecipeFamily</code> interface.<syntaxhighlight lang="c#" line="1">using Eco.Core.Items;
using Eco.Gameplay.Components;
using Eco.Gameplay.Items;
using Eco.Gameplay.Items.Recipes;
using Eco.Gameplay.Skills;
using Eco.Mods.TechTree;
using Eco.Shared.Localization;
using Eco.Shared.Serialization;
using System.Runtime.Versioning;
using System.Collections.Generic;

namespace WikiDemo
{
#region Item

#region Recipe
[RequiresSkill(typeof(CarpentrySkill), 3)]
[Ecopedia("Work Stations", "Craft Tables", subPageName: "Market Stall")]
public partial class MedievalStallRecipe : RecipeFamily
{
[SupportedOSPlatform("windows7.0")]
public MedievalStallRecipe()
{
var recipe = new Recipe();
recipe.Init(
name: "MedievalStallItem",
displayName: Localizer.DoStr("Market Stall"),
ingredients: new List<IngredientElement>
{
new IngredientElement("Wood", 40, typeof(CarpentrySkill)),
new IngredientElement(typeof(CottonFabricItem), 30, typeof(CarpentrySkill)),
new IngredientElement(typeof(HempMooringRopeItem), 5, true)
},
items: new List<CraftingElement>
{
new CraftingElement<MedievalStallItem>(1)
}
);
this.Recipes = new List<Recipe> { recipe };
this.LaborInCalories = CreateLaborInCaloriesValue(800, typeof(CarpentrySkill));
this.CraftMinutes = CreateCraftTimeValue(typeof(MedievalStallRecipe), 10f, typeof(CarpentrySkill));

// Perform pre/post initialization for user mods and initialize our recipe instance with the display name "Market Stall"
this.ModsPreInitialize();
this.Initialize(displayText: Localizer.DoStr("Market Stall"), recipeType: typeof(MedievalStallRecipe));
this.ModsPostInitialize();

// Register our RecipeFamily instance to a work table (in this case the Carpentry Table) so it can be crafted.
CraftingComponent.AddRecipe(tableType: typeof(CarpentryTableObject), recipeFamily: this); // NOTE: The table must be the object instance!
}

/// <summary>Hook for other mods to customize RecipeFamily before initialization.</summary>
partial void ModsPreInitialize();

/// <summary>Hook for other mods to customize RecipeFamily after initialization, but before registration. You can change skill requirements here.</summary>
partial void ModsPostInitialize();
}
#endregion
}</syntaxhighlight>'''Line 10:''' Eco will need this explicitly added to the file. Visual Studio will not add this line automatically. It's used for the <code>List<T></code> objects found in this code.

'''Line 14:''' "Collapsed" <code>Item</code> section. See the earlier sections in this guide for the code that belongs there.

'''Line 17:''' Sets the required skill and skill level to craft this recipe.

'''Line 21:''' <code>[SupportedOSPlatform("windows7.0")]</code> is here to silence some annoying warnings in Visual Studio. It's optional.

'''Line 30-32:''' Declares the input ingredients used for crafting. <code>CarpentrySkill</code> as defined by line 31. In this example the <code>HempMooringRope</code> is a static input. A static input will not be modified by skills, upgrade modules, or game settings.<br>'''Note:''' It seems that at the time of writing (4/21/2026, Eco v13.0.2) the only way to get an ingredient to be a dynamic value that is reduced by the table's upgrade is to pass <code>typeof(Skill)</code> to it; Passing either <code>true</code> or <code>false</code> makes the this input static.

'''Line 34:''' The <code>items</code> list declares what items are <u>output</u> by this recipe.

'''Line 36:''' This line declares that one medieval stall is output from this recipe. Functionally this links this recipe to the <code>MedievalStallItem</code> (aka "Market Stall") item created in the last step.

'''Line 40:''' Amount of calories needed to craft this item. For a static value (not modified by upgrades or skill levels) change this line to: <code>this.LaborInCalories = CreateLaborInCaloriesValue(800);</code>. As it's written in the example, this item's calorie cost will be dynamic (modified by upgrades and skill levels). The skill level that will modify it is declared on line 16.

'''Line 41:''' Minutes needed to craft. Both static and dynamic values for crafting time can be modified by the world difficulty settings. For a static value change this line to: <code>this.CraftMinutes = CreateCraftTimeValue(10f);</code>. As it's written in the example, this item's craft time will be dynamic.

'''Line 49:''' This line assigns the recipe to a workbench. <u>Do not assign</u> to itself because then the first table could never be made. It's recommend to use a preexisting vanilla table.
=== Checkpoint #2 ===
Check the functionality at this point -- it should be possible to see the recipe in the crafting table.

# Have the <code>.unity3d</code> and the <code>.cs</code> file in the <code>/Eco Server/Mods/UserCode</code> folder.
# Start the server and log in.
# Type <code>/give Carpentry Table</code>.
# Place the Carpentry Table down and interact to see the what can be crafted.
# Find the newly added recipe under the name ''Market Stall.''
# Type <code>/give Basic Upgrade 4</code>.
# Put the basic upgrade into the table.
# Go back to the recipe for the ''Market Stall'' and make sure the Wood and the Cotton fabric inputs now require less, but the Hemp Mooring Rope still is the same.<br>'''Note:''' In case the recipe hasn't changed close that table's window and interact with it again. It should for the recipes to refresh now that the upgrade is in it.

== Create the World Object ==
=== Preparing the 3D Asset ===
# Open <u>Blender</u>.
# Load the 3D object created earlier for icon rendering -- <code>Assets/WikiDemo/MedievalStall - Icon Scene.blend</code>.
# Cleanup the scene...
## Delete any light source. Use the ''Scene Collection'' panel on the top-right side of the screen. These will have a 💡 icon and by default are named something like "sun", "point", "spot" or "area".<br>'''Note:''' If your model is a light source or has one in it, you can leave that light source. The point here is to remove the ambient lights used for icon rendering.
## Delete any camera(s). Again, use the ''Scene Collection'' panel. These have a 🎥 icon and by default are named something like "camera".
# <u>If there are multiple different 3D assets in the scene</u> (like bags, crates, jars, ect.), join them all together...
## Select all of the meshes by holding ''Shift'' and clicking on each one in the ''Scene Collection'' panel (right side of window).<br>'''Tip:''' Quickly select a group of them by selecting one near the top. Then hold ''Shift'', ''Ctrl,'' and click on one near the bottom. This will both the one at the top and the one at the bottom, but also every item in between. Neat!
## Be in ''Layout'' workspace (top toolbar) and in the ''Object Mode...''
### Find the drop down in the second toolbar from the top that has options like ''Object Mode, Edit Mode, Sculpt Mode,'' etc.
### Select ''Object Mode'' from that drop down.
## Find and open the ''Object'' menu (second toolbar down from the top).
## Select ''Join''.
## In the ''Scene Collection'' panel, double click on the name of the newly joined mesh.
# Rename the joined mesh to <code>MedievalStallMesh</code>.
# Add and position a reference cube...
## Make sure the editor is in ''Layout'' view (top toolbar) and in the ''Object Mode...''
### Find the drop down in the second toolbar from the top that has options like ''Object Mode, Edit Mode, Sculpt Mode,'' etc.
### Select ''Object Mode'' from that drop down.
## Then, add a reference cube. Open the ''Add'' menu (second top toolbar down).
## Hover ''Mesh''.
## Select ''Cube.''
## Open the ''View'' menu (second toolbar down).
## Select ''Sidebar''.
## A new panel will have expanded.
## Along the right side of that panel there's buttons (''Item, Tool, View, Animation''). Find and click the ''Item'' button.
## Find and expand the ''Transform'' section
## Set the ''Location...''
### ''X'' to ''1''.
### ''Y'' to ''1''.
### ''Z'' to ''1''.
## The bottom corner of the cube should be touching the where green and red axis lines meet.
# Move the reference cube's origin to <code>(0, 0, 0)</code>...
## Be in ''Layout'' workspace (top toolbar) and in the ''Object Mode...''
### Find the drop down in the second toolbar from the top that has options like ''Object Mode, Edit Mode, Sculpt Mode,'' etc.
### Select ''Object Mode'' from that drop down.
## Open the ''View'' menu (second toolbar down).
## Select ''Sidebar''.
## A new panel will have expanded.
## Along the right side of that panel there's buttons (''Item, Tool, View, Animation''). Find and click the ''View'' button.
## Find and expand the ''3D Cursor'' section.
## Set the 3D cursor's ''Location''...
### ''X'' to ''0''.
### ''Y'' to ''0''.
### ''Z'' to ''0.''
## Now in the ''Scene Collection'' panel, click on the ''Cube'' mesh to highlight and select it.
## Open the ''Object'' menu from the second toolbar down from the top.
## Hover ''Set Origin''.
## Select ''Origin to 3D Cursor''.
# Set the reference cube's dimensions...
## Be in ''Layout'' workspace (top toolbar) and in the ''Object Mode...''
### Find the drop down in the second toolbar from the top that has options like ''Object Mode, Edit Mode, Sculpt Mode,'' etc.
### Select ''Object Mode'' from that drop down.
## Open the ''View'' menu (second toolbar down).
## Select and check the ''Sidebar'' option''.''
## The ''Sidebar'' menu just expanded over on the right side of the screen.
## To the right of the ''Sidebar'', find and click the ''Item'' button.
## Expand the ''Transform'' section.
## Set the ''Dimensions...'''''<br>Note:''' These dimensions only make sense for the asset being used for this guide. If using a different one, set the dimensions to the size of the box that model should fit in.
### ''X'' to ''4''.
### ''Y'' to ''3''.
### ''Z'' to ''3''.
# Adjust the position and scale of the ''MedievalStallMesh'' to fit inside a box.
## Be in ''Layout'' workspace (top toolbar) and in the ''Object Mode...''
### Find the drop down in the second toolbar from the top that has options like ''Object Mode, Edit Mode, Sculpt Mode,'' etc.
### Select ''Object Mode'' from that drop down.
## On the left side of the screen there's a column of icons. Hover over them to see their names.
## Select the ''Move'' tool.
## Click on the Medieval Stall to select it. Zoom out and reposition the camera so that the blue, green, and red arrows are visible.<br>'''Tip:''' By holding the middle-mouse button and dragging the scene will rotate. By holding the middle-mouse button and the ''Shift'' key, the scene will pan.<br>'''Tip:''' If panning or rotating the scene becomes slow or frustrating (especially after zooming), try selecting 3D asset from the ''Scene Collection'' panel, opening the ''View'' menu (second toolbar from top), and selecting ''Frame Selected''. This will reset the view onto that object and controls should feel normal again.
## Click and hold one of the arrows. Move the mouse to drag the 3D asset towards the box.
## Move the 3D asset around till it's <u>completely inside the box</u>. If it cannot fit and is too big, continue to the next step.<br>'''Tip:''' To select the 3D asset once it disappears, use the ''Scene Collection'' panel. Click on it there and the blue, green, and red arrows will show up again for it.<br>'''Tip:''' There are preset views. To use them go to the ''View'' menu (second toolbar from top)'','' hover ''Viewpoint'', and select the view that would be most helpful.
## Find the ''Scale'' tool from the left side of the screen.
## Now the blue, green, and red "arrows" don't really look like arrows anymore. They are lines with boxes at the end.
## Click and hold on those lines to adjust the scale of the 3D asset to make it fit inside the box.<br>'''Tip:''' There are little colored boxes in between the lines that can be dragged to scale the 3D asset more proportionally.
## Continue using the ''Move'' and ''Scale'' tools till the model fits. This will take patience and time.<br>'''Tip:''' Hide the reference cube to see what is happening with the 3D asset. Go to the ''Scene Collections'' panel and click the 👁 button to hide it. Click that button again to show it.
# Move the reference cube's origin to <code>(0.5, 0.5, 0.5)</code>...
## Be in ''Layout'' workspace (top toolbar) and in the ''Object Mode...''
### Find the drop down in the second toolbar from the top that has options like ''Object Mode, Edit Mode, Sculpt Mode,'' etc.
### Select ''Object Mode'' from that drop down.
## Open the ''View'' menu (second toolbar down).
## Select ''Sidebar''.
## A new panel will have expanded.
## Along the right side of that panel there's buttons (''Item, Tool, View, Animation''). Find and click the ''View'' button.
## Find and expand the ''3D Cursor'' section.
## Set the 3D cursor's ''Location''...
### ''X'' to ''0''.5.
### ''Y'' to ''0.5''.
### ''Z'' to ''0.5.''
## Select the ''MedievalStallMesh'' using the ''Scene Collection'' panel.
## Open the ''Object'' menu (second toolbar down).
## Hover ''Set Origin''.
## Select ''Origin to 3D Cursor''.
# Select the reference cube named ''Cube'' from the ''Scene Collections'' panel.
# Open ''Object'' menu (second toolbar down).
# Select ''Delete''.
# Move the ''MedievalStallMesh'' to <code>(0, 0, 0)</code>...
## Be in ''Layout'' workspace (top toolbar) and in the ''Object Mode...''
### Find the drop down in the second toolbar from the top that has options like ''Object Mode, Edit Mode, Sculpt Mode,'' etc.
### Select ''Object Mode'' from that drop down.
## Open the ''View'' menu (second toolbar down).
## Select ''Sidebar''.
## A new panel will have expanded.
## Along the right side of that panel there's buttons (''Item, Tool, View, Animation''). Find and click the ''Item'' button.
## Make sure the ''MedievalStallMesh'' is selected. Use the ''Scene Collection'' panel if needed.
## Find and expand the ''Transform'' section
## Set the ''Location...''
### ''X'' to 0.
### ''Y'' to 0.
### ''Z'' to 0.
# Make sure the ''MedievalStallMesh'' is selected. Use the ''Scene Collection'' panel if needed.
# Open the ''Object'' menu.
# Hover ''Apply''.
# Select ''All Transformations''.<br>'''Note:''' This step bakes all of the changes into the mesh. It's very important.
# Open the ''File'' menu from the top toolbar.
# Hover ''Export'' to open the sub-menu.
# Select ''FBX (.fbx)''
# A ''Blender File View'' window will pop-up.
# On the right side of this window there's a ⚙️ icon. Click it to expand the settings region.
# In the expanded region find the ''Include'' section and expand it. Change the following:
## Find ''Object Types'' and only select ''Mesh.'' No other option should be highlighted for this setting.
# In the settings region scroll and find the ''Transform'' section and expand it. Change the following:
## Find ''Apply Scalings'' and set it to ''FBX All''.
## Just below that find ''Forward'' and set it to ''Z Forward''.
## Ensure that the next setting down, ''Up'', changed to ''Y Up''.
## Find ''Apply Unit'' and make sure it's checked.
## Next, find ''Use Space Transform'' check it.
## Lastly, find ''Apply Transform'' and check it too.
# Save it to <code>Assets/WikiDemo/MedievalStall.fbx</code>.
# Save the Blender scene...
## ''File'' drop down from top toolbar.
## ''Save As...'' to save the Blender scene to the computer.
## Save it to <code>Assets/WikiDemo/MedievalStall - Eco Ready Scene.blend</code>.

=== Add to Unity Scene ===

# Open <u>Unity</u>.
# Select the <code>.fbx</code> file in the project window.
# Open the ''Eco Tools'' menu from the top toolbar.
# Hover ''Mod Kit''.
# Select ''World Object Setup.''
# A ''World Object Setup'' window will pop-up.
# Make sure that ''Selected Objects'' reads ''MedievalStall.''
# Also make sure that ''World Object Type'' is set to ''World Object''.
# Press the ''Setup World Objects'' button.
# Notice in the project window that a new <code>.prefab</code> file was created -- <code>MedievalStallObject.prefab</code>
# Select the <code>.prefab</code>.
# In the ''Inspector'' panel find the ''Transform'' component.
# Change this component's ''Rotation...''
## ''X'' to ''0.''
## ''Y'' to ''0.''
## ''Z'' to ''0.''
# In the ''Inspector'' panel find the ''Box Collider'' component.
#Find the ''⋮'' icon (all the way to the right of the words ''Box Collider)'' and click on it.
#Select ''Reset'' from the menu. This will regenerate the box collider now that the rotation has changed.
#Look in the ''Inspector'' panel and find the ''World Object (Script)'' component.
# That component has a checkbox ''Override Occupancy''. Check it.
# A new field should've expanded below it called ''Size''.
# Set the ''Size''...<br>'''Note:''' This size similar to the size of the reference cube from earlier, but the Y and Z coordinates get flipped! So if in Blender it was <code>(1, 2, 3)</code> then in Unity its <code>(1, 3, 2)</code>.
## ''X'' to ''4''.
## ''Y'' to ''3''.
## ''Z'' to ''3''.
# Select ''Objects'' from ''Hierarchy'' panel (left-side of the window).
# Find the ''Modkit Prefab Container (Script)'' component. This component was added earlier, if it's not there add it now.
# Expand the ''Prefabs'' section in that component.
# Click the ''+'' button to add an item to the list.
# Either...
## Click the ''⦿'' button, switch to the ''Assets'' tab, find or search for ''MedievalStallObject'', and double click on it. Make sure it's the medieval stall <u>object</u> with the <code>.prefab</code> ending.
## Drag the <code>.prefab</code> file onto the ''⦿'' button
# Open the ''File'' menu from top toolbar and select ''Save''.<br>'''Note:''' Do not skip. The scene must be saved for the ModKit build to work properly.
# Open the ''Eco Tools'' menu from the top toolbar.
# Hover ''Mod Kit''.
# Select ''Build Current Bundle''.
# Save the bundle to <code>/Eco Server/Mods/UserCode/WikiDemo.unity3d</code>

=== Coding the World Object ===
The following collapses the <code>#region Recipe</code>. Please see the earlier section [[#Code the Item's Recipe|Code the Item's Recipe]] to get the code that belongs there.

Add the new <code>using</code> lines, replace the <code>#region Item</code> section, and replace the <code>#region Object</code> sections using the following:<syntaxhighlight lang="c#" line="1">using Eco.Core.Items;
using Eco.Gameplay.Components;
using Eco.Gameplay.Items;
using Eco.Gameplay.Items.Recipes;
using Eco.Gameplay.Objects;
using Eco.Gameplay.Skills;
using Eco.Mods.TechTree;
using Eco.Shared.Localization;
using Eco.Shared.Serialization;
using System.Collections.Generic;
using System.Runtime.Versioning;
using System;
using Eco.Core.Controller;
using Eco.Gameplay.Systems.NewTooltip;
using Eco.Shared.Items;
using Eco.Gameplay.Occupancy;
using Eco.Shared.Math;
using Eco.Gameplay.Components.Auth;

namespace WikiDemo
{
#region Item
[Serialized] // Tells the save/load system this object needs to be serialized.
[SupportedOSPlatform("windows7.0")]
[LocDisplayName("Market Stall")] // Defines the localized name of the item.
[Weight(3000)] // Defines how heavy this is.
[Ecopedia("Work Stations", "Craft Tables", createAsSubPage: true)]
[LocDescription("A medieval market stall.")] //The tooltip description for the item.
public partial class MedievalStallItem : WorldObjectItem<MedievalStallObject>, IPersistentData
{
[Serialized, SyncToView, NewTooltipChildren(CacheAs.Instance, flags: TTFlags.AllowNonControllerTypeForChildren)] public object? PersistentData { get; set; }

protected override OccupancyContext GetOccupancyContext => new SideAttachedContext(
DirectionAxisFlags.Down, // Read: every occupied block on the bottom must be supported
WorldObject.GetOccupancyInfo(this.WorldObjectType)
);
}
#endregion

#region Recipe

#region Object
[Serialized]
[SupportedOSPlatform("windows7.0")]
[RequireComponent(typeof(CraftingComponent))]
[RequireComponent(typeof(MinimapComponent))]
[RequireComponent(typeof(LinkComponent))]
[RequireComponent(typeof(OccupancyRequirementComponent))]
[Tag("Usable")]
[Ecopedia("Work Stations", "Craft Tables", subPageName: "Market Stall")]
public partial class MedievalStallObject : WorldObject, IRepresentsItem
{
public Type RepresentedItemType => typeof(MedievalStallItem);

static MedievalStallObject()
{
WorldObject.AddOccupancy<MedievalStallObject>(CalculateBoxOccupancy(4, 3, 3));
}

protected override void Initialize()
{
this.ModsPreInitialize();
this.GetComponent<LinkComponent>().Initialize(15);
this.GetComponent<MinimapComponent>().SetCategory(Localizer.DoStr("Crafting"));
this.ModsPostInitialize();
}

/// <summary>Hook for mods to customize WorldObject before initialization. You can change housing values here.</summary>
partial void ModsPreInitialize();
/// <summary>Hook for mods to customize WorldObject after initialization.</summary>
partial void ModsPostInitialize();

/// <summary>
/// Calculates the blocks that this item will occupy when placed. All coordinates are offsets relative to this 3D model's origin
/// point. This function can only be used to calculate a box shape; there can be no gaps. All blocks will be of the
/// BlockOccupancyType.None type.
/// </summary>
///
/// Examples:
/// * Imagine a 1x1x1 cube. The origin point of the 3D model is the middle of the bottom-left cube. The only block the
/// cube would occupy would be the same one the origin point is in. In offset coordinates, the only block the cube occupies
/// is (0,0,0) from the origin point.
/// * Image a 1x5x1 flag pole. Again the origin point of the 3D model is in the middle of the bottom most cube. The only
/// blocks the flage pole occupies is the one the origin point is in and the 4 above that one. In offset coordinates, that
/// would be (0,0,0) + (0,1,0) + (0,2,0) + (0,3,0) + (0,4,0).
/// <returns></returns>
private static List<BlockOccupancy> CalculateBoxOccupancy(int sizeX, int sizeY, int sizeZ)
{
var cells = new List<BlockOccupancy>(sizeX * sizeY * sizeZ);
for (int x = 0; x < sizeX; x++)
for (int y = 0; y < sizeY; y++)
for (int z = 0; z < sizeZ; z++)
cells.Add(new BlockOccupancy(new Vector3i(x, y, z)));
return cells;
}
}
#endregion
}
</syntaxhighlight>'''Line 30:''' This changes from implementing <code>Item</code> to <code>WorldObjectItem<MedievalStallObject></code>. This is what tell Eco that this item has the ability to place a world object into the world.

'''Line 32:''' This defines the object where <code>PersistentData</code> is stored. Other components like a ''PartsComponet'' would store the information of the table parts' durability in here. in this example, this line is illustrative and doesn't have any components using it.

'''Line 34:''' Sets the type of occupancy context this world object has. Occupancy is the system used to determine what space blocks and object are in. The <code>SideAttachContext</code> means that this object must have a certain side supported for it to be attached to the world and valid to be placed.

'''Line 35:''' Defines the bottom side as the side this object uses to attach.

'''Line 36:''' This line is getting the list of blocks occupied from a static lookup in <code>WorldObject</code> for the <code>MedievalStallObject</code>. See line 60 to see this value set.

'''Line 41:''' The "collapsed" Recipe section. See earlier sections in this guide to see what code belongs here.

'''Line 46:''' Adds a <code>CraftComponent</code> to the table. This component lets players use this table to craft something on.

'''Line 47:''' <code>MinimapComponent</code> this registers the object with the minimap. This makes it so when a player places a medieval stall, the minimap shows it. Related: line 67.

'''Line 48:''' <code>LinkComponent</code> allows storage linking. Related: line 66.

'''Line 49:''' <code>OccupancyRequirementComponent</code> defines this object as having and occupying physical space. Related: line 60.

'''Line 50:''' Assigns a tag to this object. Like how the tag ''Wood'' in Eco refers to all the different types of logs. In this case, the ''MedievalStallObject'' is being added to the <code>Usable</code> tag.

'''Line 52:''' Declares the <code>MedievalStallObject</code>. It's important that this class name is matches exactly the <code>.prefab</code> file name because the name is what links them.

'''Line 54:''' Declares the item that is given when this world object is picked up.

'''Line 58:''' This sets the occupancy for the world object in the simulation. This must also be set for the object in addition to the ''Override Occupancy'' and ''Size'' setting previously set on the Unity <code>.prefab</code>. That's because the settings in Unity are used client side. This sets the occupancy on the server side. They both need to be set and be matching for things to work right.

'''Line 64:''' Initializes the <code>LinkComponent</code> with a base 15 block radius. Know that this value is just the base value and that server settings will determine the actual game play radius.

'''Line 65:''' Initializes the <code>MinimapComponent</code> and add this object to the <code>Crafting</code> category.

=== Checkpoint ===

[[File:WikiDemo - Medieval Stall - Checkpoint -3.png|thumb|The Medieval Stall modded into Eco.]]
'''Warning:''' In ''Eco'' v13.0.2, free-placed objects may display misaligned ghost cubes, even when configured correctly in your mod. This is a visual-only base-game bug — placement still works as expected, even if the object appears red near edges. 

# Have the <code>.unity3d</code> and the <code>.cs</code> file in the <code>/Eco Server/Mods/UserCode</code> folder.
# Start the server and log in.
# Type <code>/give MedievalStall</code>.
# Place the stall down. '''Pro-tip:''' Put down a floor of <u>flat roof</u> tiles made of ''Reinforced Concrete''. This will show you where the occupancy of your object is when you place it because the roof tiles will change shape under the object. Neat!
# It should look and function like a normal workbench.

The <code>WikiDemo.unity3d</code> and the <code>WikiDemo.cs</code> files are all that is needed to share this mod now.

= Adding a Recipe to Craft =
To add a recipe to the medieval stall add this to the <code>WikiDemo.cs</code> file:<syntaxhighlight lang="c#" line="1">
using Eco.Core.Items;
using Eco.Gameplay.Components;
using Eco.Gameplay.Items;
using Eco.Gameplay.Items.Recipes;
using Eco.Gameplay.Objects;
using Eco.Gameplay.Skills;
using Eco.Mods.TechTree;
using Eco.Shared.Localization;
using Eco.Shared.Serialization;
using System.Collections.Generic;
using System.Runtime.Versioning;
using System;
using Eco.Core.Controller;
using Eco.Gameplay.Systems.NewTooltip;
using Eco.Shared.Items;
using Eco.Gameplay.Occupancy;
using Eco.Shared.Math;
using Eco.Gameplay.Components.Auth;

namespace WikiDemo
{
#region Item

#region Recipe

#region Object

#region CraftingRecipes
public partial class MyArrowRecipe : RecipeFamily
{
[SupportedOSPlatform("windows7.0")]
public MyArrowRecipe()
{
var recipe = new Recipe();
recipe.Init(
name: "Alternate Arrow",
displayName: Localizer.DoStr("Alternate Arrow"),
ingredients: new List<IngredientElement>
{
new IngredientElement("Wood", 1, typeof(Skill)),
new IngredientElement("Rock", 1)
},
items: new List<CraftingElement>
{
new CraftingElement<ArrowItem>(1)
}
);
this.Recipes = new List<Recipe> { recipe };
this.LaborInCalories = CreateLaborInCaloriesValue(10);
this.CraftMinutes = CreateCraftTimeValue(0.1f);

// Perform pre/post initialization for user mods and initialize our recipe instance with the display name "Market Stall"
this.ModsPreInitialize();
this.Initialize(displayText: Localizer.DoStr("Alternate Arrow Recipe"), recipeType: typeof(MyArrowRecipe));
this.ModsPostInitialize();

// Register our RecipeFamily instance to a work table (in this case the Carpentry Table) so it can be crafted.
CraftingComponent.AddRecipe(tableType: typeof(MedievalStallObject), recipeFamily: this); // NOTE: The table must be the object instance!
}

/// <summary>Hook for other mods to customize RecipeFamily before initialization.</summary>
partial void ModsPreInitialize();

/// <summary>Hook for other mods to customize RecipeFamily after initialization, but before registration. You can change skill requirements here.</summary>
partial void ModsPostInitialize();
}
#endregion
}
</syntaxhighlight>
[[File:WikiDemo MedievalStall AltArrowRecipe.png|thumb|Shows a new recipe added to the crafting tab of the Medieval Stall.]]
'''Line 58:''' This line here adds this recipe to the <code>MedievalStallObject</code> just created.

Getting Started with Eco Modding in Visual Studio

2026-04-29T14:59:22Z

WugWugg:

= Introduction =
This guide focuses on setting up a C# modding environment in Visual Studio.

It does '''not''' cover adding Unity assets (models, prefabs, UI) to the game. See: [[From 3D Asset to Working Worktable]] for that workflow.

This guide won’t teach you how to code or write a mod, but it will help you get everything set up so you’re ready to start learning. Helpful resources are listed at the bottom of this guide, including [[Helpful Examples for Modding]] for practical code examples.

Visual Studio 2026 has a completely free version called the '''Community Edition'''. This guide is written assuming that's the version used.

=== Have Ready ===
* A copy of the Eco game installed
* A file explorer and the file-path to <code>Eco</code> folder<br>'''Tip:''' Within this folder there's folders like <code>D3D12</code> and <code>Eco_Data</code>. Also, you'll find the <code>Eco.exe</code> file here. There are other files and folder here too, but this list is just to help you know what the folder looks like.
* '''Tip:''' Steam users can find the install folder by right-clicking on the game in your Steam Library:<br>[[File:Steam Library -- Browse Local Files.png|alt=Shows a Steam Library with a menu open over the Eco game. Highlighted in that menu is a "Manage" option, opening a sub-menu. The sub-menu has "Browse local files" highlighted.|frameless|border|upright=3|location=center|link=]]

= Installing Visual Studio =
# Go to <code><nowiki>https://visualstudio.microsoft.com/downloads/#visual-studio-community-2026</nowiki></code> and look for the "'''Visual Studio Community 2026'''" download.
# Start the download by clicking on the ''Download'' button.
# Run the installer until it reaches the Workloads page
# Select these workloads...
## .NET desktop development -- '''Required''' for any mod development
## ASP.NET and web development -- Optional. If you want to interact with external websites or Eco's own web server (e.g. Discord's webhooks or extending the API)
# With those workloads selected the page should look something like this:<br>[[File:VisualStudioCommunity2022 Workloads.png|alt=Workloads screen during VS2022 installation. Options selected are "ASP.NET and web development" and ".NET desktop development". |frameless|location=center|upright=4|link=|border]]
# Click the Install button. It will take a few minutes to complete installation.
# Open Visual Studio after it installs.
# You may be prompted to sign in:
## Click ''Skip and add accounts later'' to continue.
## If you plan to use GitHub, sign in to make version control easier.
# Finally, it might ask what color theme you'd like. Select your preference and continue.
# Visual Studio is now installed and ready to be used.

= Setting Up a New Mod =
Once Eco and Visual Studio are installed, all of the tools needed to code, build, and run a mod are ready.

== Creating a New Project ==
# Open Visual Studio. When it first opens it will show you a dashboard where you can quickly select what you want to do.
# On the right, under ''Get Started'' find the ''Create a new project'' button:<br>[[File:VS2022 OpeningDashboard.png|alt=VS2022's launch dashboard showing recent projects on the left and quick action buttons on the right. Highlighted is a button titled "Create a new project".|frameless|border|link=|location=center|upright=4]]
# A new window will pop-up.
# Select C# ''Class Library.'' To find the template, search <code>C# library</code> in the search bar. Select the C# option titled ''Class Library''.<br>'''Note:''' <u>Make sure you select the <code>C#</code> option as there are other options similarly named ''Class Library''.</u><br>[[File:VS2022 NewProjectWizard Templates.png|frameless|border|location=center|upright=4|link=]]
# Click the ''Next'' button.
# For ''Project Name'' type the name of the mod being created.
# The other options like the ''Location'' and the ''Solution Name'' do not need edited.
# Leave the box ''Place solution and project in the same directory'' unchecked.
# Click the Next button.
# In the ''Framework'' drop-down select the same version of .NET Eco uses (as described below). '''Tip:''' Eco currently targets ''.NET 10.0''

== .NET Version ==
To confirm the version of .NET that Eco uses:

# Go to the NuGet Gallery <code>www.nuget.org/packages?q=Eco.ReferenceAssemblies</code>
# Find the package with the name ''Eco.ReferenceAssemblies'' made by ''StrangeLoopGames''.
# Notice the chip underneath of it with the ''.NET'' version it targets.<br>[[File:NuGetGallery -- Eco.ReferenceAssemblies Search.png|alt=Shows the search result of Eco.ReferenceAssemblies. In a blue chip the text ".NET 8.0" can be seen.|frameless|upright=4|location=center|link=|border]]
# Click on that search result (shown above).
# A more detailed page is shown. Again, there's chips showing what version of .NET to use:<br>[[File:NuGetGallery--Eco.ReferenceAssemblies Details.png|alt=Show the package page for "Eco.ReferenceAssemblies" on NuGet Gallery. Circled in red are two chips with some version of the text ".NET 8.0" inside them.|frameless|link=|border|location=center|upright=3]]

== Linking to Eco Assemblies ==
# Find the ''Solution Explorer'' on the right side of Visual Studio. It should look something like this:<br>'''Note''': If the solution explorer isn't there, open the ''View'' menu (top toolbar) and select ''Solution Explorer''.<br>[[File:VS2022 -- Solution Explorer.png|alt=A picture of a basic layout in Visual Studio 2022 with the Solution Explorer open on the right-hand side. The solution explorer is circled in red.|frameless|link=|upright=4|location=center|border]]
# In the ''Solution Explorer'', find and right-click on the ''Dependencies'' item.
# Select ''Manage NuGet Packages...''<br>[[File:VS2022 Solution Explorer -- Manage NuGet Packages.png|alt=Shows VS2022's Solution Explorer with project expanded. The References line is highlighted and a menu is open. On that menu the "Manage NuGet Packages" line is highlighted.|frameless|link=|upright=4|location=center|border]]
# A ''NuGet'' tab will have opened in the editor window...
## Right above the search bar on this tab there's sub-tabs.
## Select the ''Browse'' sub-tab.
## Type <code>Eco.ReferenceAssemblies</code> into the search bar.
## Check the ''Include prerelease'' check-box.
## Find the option with the name ''Eco.ReferenceAssemblies'' made by ''StrangeLoopGames''.
## Click on that.
## A details panel will show up to the right. It will show the version of the reference assemblies being targeted. By default it chooses the latest and can be left at its default.
## Click the Install button.
### Click the ''Apply'' button on the popup to finish adding the references.<br>[[File:VS2022 -- NuGet Install Eco.ReferenceAssemblies.png|alt=VS2022 is open to the NuGet tab and is searching with the text Eco.ReferenceAssemblies. The checkbox to the right of the search is checked -- include prerelease. The only search result is selected. There is yellow highlights over part of the photo.|frameless|link=|upright=4|location=center|border]]
# The reference assemblies have now been added. That means when coding Visual Studio will provide IntelliSense popups.
# Try it out by going back to the <code>Class1.cs</code> file and typing <code>Eco.</code> and suggestions will pop up.

= Dynamic Link Library (DLL) =
Building the mod creates the <code>.dll</code> file that can be dropped into the <code>Mods/UserCode</code> folder of any server and run.

== Building for Development ==

# Open the project in Visual Studio.
# Open the ''Build'' menu from the top toolbar.
# Select ''Build Solution''. This will produce a non-optimized DLL used for testing and development.<br>[[File:VS2022 -- Build Menu.png|alt=VS2022 top menu "Build" is open with "build solution" highlighted (ctrl + shift + b).|frameless|link=|upright=4|location=center|border]]
# To find the file Visual Studio just built, right click on the project in the Solution Explorer.
# Select ''Open Folder in File Explorer.''<br>[[File:VS2022 -- Project Menu.png|alt=VS2022's solution explorer is shown with the projects right-click menu open. Highlighted is "Open folder in File Explorer"|frameless|link=|upright=4|location=center|border]]
# From here, the mod's DLL will be in the <code>bin/Debug/net10.0/</code> folder. The file will be named with mod's name, like <code>TheMod.dll</code>.
# Copy the mod's DLL file.
# Paste it into the folder <code>Eco/Eco_Data/Server/Mods/UserCode</code>.

=== Checkpoint ===

# Start Eco and create a local world to see if the mod is being loaded.
# Check the logs at <code>Eco/Eco_Data/Server/Logs/</code> to verify...
## Open the <u>most recent</u> log file here.
## If the mod was loaded it there will be a line mentioning the file-name of the DLL. If the DLL was named <code>TheMod.dll</code>, line 5 is what to look for in the log file:
<syntaxhighlight lang="text" line="1">
[13:55:54.815] [4] [ Info] [Eco] Starting ModKitPlugin ...
[13:56:27.399] [4] [ Info] [Eco] Starting ModKitPlugin ... Finished in 32.584 sec

[13:56:27.439] [4] [ Info] [Eco] Loading mods ...
[13:56:27.439] [9] [ Info] [Eco] Loading TheMod...
</syntaxhighlight>

'''Tip:''' Setup File Explorer to Sort By Date

# Setup the file view to ''Details'' in this folder because it will show the ''Date Modified'' for each file.<br>[[File:File Explorer -- View Settings Menu.png|alt=Show Window's File Explorer's view setting menu with the "details" option highlighted.|frameless|link=|upright=2|location=center|border]]
# Click on the ''Date Modified'' header to sort all files. This will sort it so the most recent is on top. Now, every time the server starts the log file is easily found -- it's the one on top!<br>[[File:File Explorer -- Details Example.png|alt=Show's window's File Explorer with the date modified header highlighted.|frameless|link=|upright=2|location=center|border]]

== Building for Release ==
Release builds are optimized and intended for sharing. Unlike Debug builds, they exclude extra debugging overhead and produce a cleaner, final version of your mod.

# Open the project in Visual Studio.
# Click on the mod's project in the Solution Explorer to highlight it.<br>[[File:VS2022 -- Solution Explorer Project Highlight.png|alt=Shows VS2022's solution explorer with the project highlighted.|frameless|link=|upright=2|location=center|border]]
# Open the ''Build'' menu from the top toolbar.
# Select ''Publish Selection''.
# A new ''Publish'' window will pop-up.
# Set the target ''as Folder''.
# Click the ''Next'' button.<br>[[File:VS2022 -- Publish Wizard.png|alt=VS2022's publish wizard showing the target selection screen. The Folder option is highlighted.|frameless|link=|upright=2|location=center|border]]
# Leave the folder location as it is.
# Click the ''Finish'' button.
# Click the ''Close'' button.
# Click the ''Publish'' button to start the build. This may take a minute.
# A green alert will pop up when the build is completed:<br>[[File:VS2022 -- Publish Screen.png|alt=Show's VS2022 publish screen. There's publish button at the top of this screen.|frameless|link=|upright=2|location=center|border]]
# Inside the alert there will be a blue ''Navigate'' link. Click it.
# A file explorer should have opened to where the <code>.dll</code> file is.
# The mod file will be named with the mod project's name. For example, <code>TheMod.dll</code>.
# To share this mod, the only file needed is the mod's <code>.dll</code>. Do not copy any of the <code>.dll</code> files starting with ''Eco'' or ''StrangeCloud''. Additionally, do not copy the <code>TheMod.deps.json</code> or the <code>TheMod.pdb</code> files.

= Post-Build Scripts =
With a post-build script Visual Studio will automatically copy the files into the Eco <code>Mods/UserCode</code> folder every time it builds. It's a very nice feature to have when developing and rebuilding to test something new.

# Open the project in Visual Studio.
# Right-click on the project in the ''Solution Explorer.''
# Select ''↱'' ''Edit Project File'' option.
# Add the properties <code>EcoServerExe</code> and <code>EcoServerDir</code> inside of the <code>PropertyGroup</code> tag.<br>'''Tip:''' By holding shift and right-clicking on a file in the file explorer an old-school menu pops up. Midway down this menu is an option to ''Copy As Path''. Neat!
# The project file should look something like this (lines 8-9):
<syntaxhighlight lang="xml" line="1">
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<TargetFramework>net10.0</TargetFramework>
<ImplicitUsings>enable</ImplicitUsings>
<Nullable>enable</Nullable>


<EcoModsDir>C:\Program Files (x86)\Steam\steamapps\common\Eco\Eco_Data\Server\Mods\UserCode</EcoModsDir>

</PropertyGroup>

<ItemGroup>
<PackageReference Include="Eco.ReferenceAssemblies" Version="0.11.1.13-beta-release-887" />
</ItemGroup>

</Project>
</syntaxhighlight>
# Add the <code>PostBuild</code> property inside the <code>Project</code> tag.
<syntaxhighlight lang="xml" line="1">
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
... SNIP ...
</PropertyGroup>

<ItemGroup>
... SNIP ...
</ItemGroup>

<Target Name="CopyModToEco" AfterTargets="Build">
<Copy SourceFiles="$(TargetPath)" DestinationFolder="$(EcoModsDir)" SkipUnchangedFiles="true" />
<Copy SourceFiles="$(TargetDir)$(TargetName).pdb" DestinationFolder="$(EcoModsDir)" SkipUnchangedFiles="true" Condition="Exists('$(TargetDir)$(TargetName).pdb')" />
</Target>
</Project>
</syntaxhighlight>
# Build the project.
# Look in the <code>Mods/UserCode</code> folder.
# There should be <code>TheMod.dll</code> file.

= Setting up Debugging =
To set up debugging, make sure the project is configured with the post-build script described above.

Debugging is a powerful tool that allows you to set breakpoints anywhere in your code to pause execution. While paused, you can inspect variable values and step through the code line by line. This is invaluable when tracking down bugs or understanding complex behavior.

When running the server in debug mode, code changes can be hot-reloaded. This allows you to modify code and apply changes without rebuilding and restarting Eco, significantly speeding up development.

# Open the ''Debug'' menu from the top toolbar.
# Select ''YourModName Debug Properties'' from the bottom of the menu.<br>[[File:VS2022 -- Debug Menu.png|alt=VS2022's debug menu is open from the top of the application. Highlighted is the last option "Debug Properties".|frameless|link=|upright=2|location=center|border]]
# Click the ''Create a new profile'' button in the top-left of this new window (see image below).
# Select ''Executable'' from the drop-down menu.<br>[[File:VS2022 -- Debugger Launch Profiles.png|alt=VS2022's launch profile window is open. Underlined and pointed to by a red mark is the "Create a new profile" button, located in the top-left of the window. Highlighted from the menu under it is the option reading "Executable".|frameless|link=|upright=2|location=center|border]]
# Set the ''Executable'' field to the full path to the <code>EcoServer.exe</code> file.<br>'''Example:''' <code>C:\Program Files (x86)\Steam\steamapps\common\Eco\Eco_Data\Server</code><code>\EcoServer.exe</code>.
# Set the ''Working Directory'' field to the full path to the folder containing the <code>EcoServer.exe</code> file.<br>'''Example:''' <code>C:\Program Files (x86)\Steam\steamapps\common\Eco\Eco_Data\Server</code>.<br>[[File:VS2022 -- Eco Debugging Profile.png|alt=A fully configured profile ready to debug Eco on VS2022's launch profile page.|frameless|link=|upright=2|location=center|border]]
# Switch to this newly configured profile by clicking the small arrow to the right of the play icon (see image).<br>[[File:VS2022 -- Debugger Profile Selection.png|alt=VS2022's debugger profile selection menu is open with the newly created "Profile 1" highlighted.|frameless|link=|upright=2|location=center|border]]
# Select the newly created profile -- ''Profile 1''.

=== Checkpoint ===

# Put the following in <code>Class1.cs</code> file:
<syntaxhighlight lang="c#" line="1">
using Eco.Core.Plugins.Interfaces;
using Eco.Core.Utils;
using Eco.ModKit;

namespace Test
{
public class Class1 : IModKitPlugin, IInitializablePlugin
{
public string GetCategory() => "Tutorial";

public string GetStatus() => this._status;
string _status = string.Empty;

public void Initialize(TimedTask timer)
{
this._status = "Ok";
bool yes = true;
return;
}
}

[ChatCommandHandler]
[SupportedOSPlatform("windows7.0")]
public static class CommonCentsCommands
{
[ChatCommand("wikiTest", ChatAuthorizationLevel.Moderator)]
public static void wikiTest(IChatClient chat)
{
chat.MsgLoc($"Hello, World.");
}
}
}

</syntaxhighlight>
This code creates a basic plugin, called <code>Class1</code>, that Eco will load and initialize on startup. Eco knows to do this because this class inherits the <code>IModKitPlugin</code> interface (causes it to be loaded) and the <code>IInitializablePlugin</code> interface (causes it to be initialized).
# Add a breakpoint to the code by right-clicking on the line <code>bool yes = true;</code><br>[[File:VS2022 -- Adding a breakpoint.png|alt=A boilerplate example of a mod is shown in the VS2022 text editor. A line has a menu open above it with the option "Breakpoint" expanded and the option "Insert Breakpoint" highlighted on the sub-menu.|frameless|link=|upright=2|location=center|border]]
# Click the green ''⏵'' button to start the server with the mod. The server will start and Visual Studio will flash back on screen once Eco tries to initialize the mod's plugin.<br>[[File:VS2022 -- Launch Debugger.png|alt=Highlighted is the play button for VS2022's debugger. The "Profile 1" is still selected from before.|frameless|link=|upright=2|location=center|border]]
# When Visual Studio hits the breakpoint it will keep startup from continuing and allow detailed inspection to happen. In the bottom left (circled in red) is a table of all of the variables within scope. Use this to see what is happening (especially useful in loops!). At the middle-top (circled in red) are some of the debugger controls. Clicking the highlighted ''Continue'' button resumes normal operation. Using the buttons to the right that are highlighted will allow the developer to step through the codes execution to see exactly how each line is performing. Debugging is a deep and rich topic that this guide will not explain further, but there's a great video by Microsoft Visual Studio on YouTube called Basics of Debugging. In that 45 minute video (don't worry there's annotations to jump to just what is interesting) a whole gamut of information about how to use debugging is covered.<br>[[File:VS2022 -- Debugger LIve.png|alt=Shows a simple plugin's code in the editor of VS2022. In the bottom-left is a table of all variables used in the function. It is circled in red. On the top of the image also circled in red is the debugger controls. Highlighted within is the continue button and the "step over" button.|frameless|link=|upright=2|location=center|border]]
# Hit the green''⏵'' ''Continue'' button.
# Let the server finish loading.
# Open Eco to play.
# Connect to the LAN world by named something like ''Eco World''.
# Type <code>/wikiDemo</code> in chat.
# See that the mod replies with ''Hello, World.''
# Change line 29 in <code>Class1.cs</code> to <code>chat.MsgLoc($"Hello, Modder!");</code>
# Hit the hot reload button. It's just to the right of the green ''⏵'' ''Continue'' button and vaguely looks like the 🔥 icon.
# Type <code>/wikiDemo</code> in chat.
# See that the mod now replies with ''Hello, Modder!''

== Releasing a Mod ==

=== Mod.io ===
<code>mod.io</code> is where creators share their mods with players and others. To share a new mod there all that is necessary is an account:

# Goto <code><nowiki>https://mod.io/g/eco</nowiki></code> and click "Login" in the top-right corner.
# Sign up with whatever account type you prefer.
# Click the "Add Mod" button in the top-right.
# Follow the upload wizard as directed.
# Once on the "File Manager" section, a zip file is needed...
## Zip the mod's <code>release/</code> dll and any other assets necessary (e.g. Unity bundles) by putting all the files into a folder.
## Right-click on that folder
## Hover "Compress To..."
## Select "ZIP file".
## Use and upload that zip file.<br>'''Tip:''' Considering naming it with a version number to help stay organized (e.g. "v1"). Next release, increase that number by 1 (e.g. "v2")

=== Sharing on Discord ===
Consider posting an ad on the official {{EcoDiscord}}. There's a channel for mods called ''mod-ads''.
Please read the rules before posting.

== Helpful Resources ==

* Consider learning source control (Git). Completely optional, but can help you keep things organized as development continues.
* Explore Eco’s open-source mod projects for ideas (search on GitHub "Eco Mods" to find some real-life examples)
** {{EcoDiscord}}has a channel for mod developers to help one another called ''mod-dev.'' '''Note:''' Make under the ''Channel & Roles'' settings you have the 🛠''Yes, I want to see the channels about modding'' role selected.

Getting Started with Eco Modding in Visual Studio

2026-04-29T14:55:30Z

WugWugg:

= Introduction =
This guide focuses on setting up a C# modding environment in Visual Studio.

It does '''not''' cover adding Unity assets (models, prefabs, UI) to the game. See: [[From 3D Asset to Working Worktable]] for that workflow.

This guide won’t teach you how to code or write a mod, but it will help you get everything set up so you’re ready to start learning. Helpful resources are listed at the bottom of this guide, including [[Helpful Examples for Modding]] for practical code examples.

Visual Studio 2026 has a completely free version called the '''Community Edition'''. This guide is written assuming that's the version used.

=== Have Ready ===
* A copy of the Eco game installed
* A file explorer and the file-path to <code>Eco</code> folder<br>'''Tip:''' Within this folder there's folders like <code>D3D12</code> and <code>Eco_Data</code>. Also, you'll find the <code>Eco.exe</code> file here. There are other files and folder here too, but this list is just to help you know what the folder looks like.
* '''Tip:''' Steam users can find the install folder by right-clicking on the game in your Steam Library:<br>[[File:Steam Library -- Browse Local Files.png|alt=Shows a Steam Library with a menu open over the Eco game. Highlighted in that menu is a "Manage" option, opening a sub-menu. The sub-menu has "Browse local files" highlighted.|frameless|border|upright=3|location=center|link=]]

= Installing Visual Studio =
# Go to <code><nowiki>https://visualstudio.microsoft.com/downloads/#visual-studio-community-2026</nowiki></code> and look for the "'''Visual Studio Community 2026'''" download.
# Start the download by clicking on the ''Download'' button.
# Run the installer until it reaches the Workloads page
# Select these workloads...
## .NET desktop development -- '''Required''' for any mod development
## ASP.NET and web development -- Optional. If you want to interact with external websites or Eco's own web server (e.g. Discord's webhooks or extending the API)
# With those workloads selected the page should look something like this:<br>[[File:VisualStudioCommunity2022 Workloads.png|alt=Workloads screen during VS2022 installation. Options selected are "ASP.NET and web development" and ".NET desktop development". |frameless|location=center|upright=4|link=|border]]
# Click the Install button. It will take a few minutes to complete installation.
# Open Visual Studio after it installs.
# You may be prompted to sign in:
## Click ''Skip and add accounts later'' to continue.
## If you plan to use GitHub, sign in to make version control easier.
# Finally, it might ask what color theme you'd like. Select your preference and continue.
# Visual Studio is now installed and ready to be used.

= Setting Up a New Mod =
Once Eco and Visual Studio are installed, all of the tools needed to code, build, and run a mod are ready.

== Creating a New Project ==
# Open Visual Studio. When it first opens it will show you a dashboard where you can quickly select what you want to do.
# On the right, under ''Get Started'' find the ''Create a new project'' button:<br>[[File:VS2022 OpeningDashboard.png|alt=VS2022's launch dashboard showing recent projects on the left and quick action buttons on the right. Highlighted is a button titled "Create a new project".|frameless|border|link=|location=center|upright=4]]
# A new window will pop-up.
# Select C# ''Class Library.'' To find the template, search <code>C# library</code> in the search bar. Select the C# option titled ''Class Library''.<br>'''Note:''' <u>Make sure you select the <code>C#</code> option as there are other options similarly named ''Class Library''.</u><br>[[File:VS2022 NewProjectWizard Templates.png|frameless|border|location=center|upright=4|link=]]
# Click the ''Next'' button.
# For ''Project Name'' type the name of the mod being created.
# The other options like the ''Location'' and the ''Solution Name'' do not need edited.
# Leave the box ''Place solution and project in the same directory'' unchecked.
# Click the Next button.
# In the ''Framework'' drop-down select the same version of .NET Eco uses (as described below). '''Tip:''' Eco currently targets ''.NET 10.0''

== .NET Version ==
To confirm the version of .NET that Eco uses:

# Go to the NuGet Gallery <code>www.nuget.org/packages?q=Eco.ReferenceAssemblies</code>
# Find the package with the name ''Eco.ReferenceAssemblies'' made by ''StrangeLoopGames''.
# Notice the chip underneath of it with the ''.NET'' version it targets.<br>[[File:NuGetGallery -- Eco.ReferenceAssemblies Search.png|alt=Shows the search result of Eco.ReferenceAssemblies. In a blue chip the text ".NET 8.0" can be seen.|frameless|upright=4|location=center|link=|border]]
# Click on that search result (shown above).
# A more detailed page is shown. Again, there's chips showing what version of .NET to use:<br>[[File:NuGetGallery--Eco.ReferenceAssemblies Details.png|alt=Show the package page for "Eco.ReferenceAssemblies" on NuGet Gallery. Circled in red are two chips with some version of the text ".NET 8.0" inside them.|frameless|link=|border|location=center|upright=3]]

== Linking to Eco Assemblies ==
# Find the ''Solution Explorer'' on the right side of Visual Studio. It should look something like this:<br>'''Note''': If the solution explorer isn't there, open the ''View'' menu (top toolbar) and select ''Solution Explorer''.<br>[[File:VS2022 -- Solution Explorer.png|alt=A picture of a basic layout in Visual Studio 2022 with the Solution Explorer open on the right-hand side. The solution explorer is circled in red.|frameless|link=|upright=4|location=center|border]]
# In the ''Solution Explorer'', find and right-click on the ''Dependencies'' item.
# Select ''Manage NuGet Packages...''<br>[[File:VS2022 Solution Explorer -- Manage NuGet Packages.png|alt=Shows VS2022's Solution Explorer with project expanded. The References line is highlighted and a menu is open. On that menu the "Manage NuGet Packages" line is highlighted.|frameless|link=|upright=4|location=center|border]]
# A ''NuGet'' tab will have opened in the editor window...
## Right above the search bar on this tab there's sub-tabs.
## Select the ''Browse'' sub-tab.
## Type <code>Eco.ReferenceAssemblies</code> into the search bar.
## Check the ''Include prerelease'' check-box.
## Find the option with the name ''Eco.ReferenceAssemblies'' made by ''StrangeLoopGames''.
## Click on that.
## A details panel will show up to the right. It will show the version of the reference assemblies being targeted. By default it chooses the latest and can be left at its default.
## Click the Install button.
### Click the ''Apply'' button on the popup to finish adding the references.<br>[[File:VS2022 -- NuGet Install Eco.ReferenceAssemblies.png|alt=VS2022 is open to the NuGet tab and is searching with the text Eco.ReferenceAssemblies. The checkbox to the right of the search is checked -- include prerelease. The only search result is selected. There is yellow highlights over part of the photo.|frameless|link=|upright=4|location=center|border]]
# The reference assemblies have now been added. That means when coding Visual Studio will provide IntelliSense popups.
# Try it out by going back to the <code>Class1.cs</code> file and typing <code>Eco.</code> and suggestions will pop up.

= Dynamic Link Library (DLL) =
Building the mod creates the <code>.dll</code> file that can be dropped into the <code>Mods/UserCode</code> folder of any server and run.

== Building for Development ==

# Open the project in Visual Studio.
# Open the ''Build'' menu from the top toolbar.
# Select ''Build Solution''. This will produce a non-optimized DLL used for testing and development.<br>[[File:VS2022 -- Build Menu.png|alt=VS2022 top menu "Build" is open with "build solution" highlighted (ctrl + shift + b).|frameless|link=|upright=4|location=center|border]]
# To find the file Visual Studio just built, right click on the project in the Solution Explorer.
# Select ''Open Folder in File Explorer.''<br>[[File:VS2022 -- Project Menu.png|alt=VS2022's solution explorer is shown with the projects right-click menu open. Highlighted is "Open folder in File Explorer"|frameless|link=|upright=4|location=center|border]]
# From here, the mod's DLL will be in the <code>bin/Debug/net10.0/</code> folder. The file will be named with mod's name, like <code>TheMod.dll</code>.
# Copy the mod's DLL file.
# Paste it into the folder <code>Eco/Eco_Data/Server/Mods/UserCode</code>.

=== Checkpoint ===

# Start Eco and create a local world to see if the mod is being loaded.
# Check the logs at <code>Eco/Eco_Data/Server/Logs/</code> to verify...
## Open the <u>most recent</u> log file here.
## If the mod was loaded it there will be a line mentioning the file-name of the DLL. If the DLL was named <code>TheMod.dll</code>, line 5 is what to look for in the log file:
<syntaxhighlight lang="text" line="1">
[13:55:54.815] [4] [ Info] [Eco] Starting ModKitPlugin ...
[13:56:27.399] [4] [ Info] [Eco] Starting ModKitPlugin ... Finished in 32.584 sec

[13:56:27.439] [4] [ Info] [Eco] Loading mods ...
[13:56:27.439] [9] [ Info] [Eco] Loading TheMod...
</syntaxhighlight>

'''Tip:''' Setup File Explorer to Sort By Date

# Setup the file view to ''Details'' in this folder because it will show the ''Date Modified'' for each file.<br>[[File:File Explorer -- View Settings Menu.png|alt=Show Window's File Explorer's view setting menu with the "details" option highlighted.|frameless|link=|upright=2|location=center|border]]
# Click on the ''Date Modified'' header to sort all files. This will sort it so the most recent is on top. Now, every time the server starts the log file is easily found -- it's the one on top!<br>[[File:File Explorer -- Details Example.png|alt=Show's window's File Explorer with the date modified header highlighted.|frameless|link=|upright=2|location=center|border]]

== Building for Release ==
Release builds are optimized and intended for sharing. Unlike Debug builds, they exclude extra debugging overhead and produce a cleaner, final version of your mod.

# Open the project in Visual Studio.
# Click on the mod's project in the Solution Explorer to highlight it.<br>[[File:VS2022 -- Solution Explorer Project Highlight.png|alt=Shows VS2022's solution explorer with the project highlighted.|frameless|link=|upright=2|location=center|border]]
# Open the ''Build'' menu from the top toolbar.
# Select ''Publish Selection''.
# A new ''Publish'' window will pop-up.
# Set the target ''as Folder''.
# Click the ''Next'' button.<br>[[File:VS2022 -- Publish Wizard.png|alt=VS2022's publish wizard showing the target selection screen. The Folder option is highlighted.|frameless|link=|upright=2|location=center|border]]
# Leave the folder location as it is.
# Click the ''Finish'' button.
# Click the ''Close'' button.
# Click the ''Publish'' button to start the build. This may take a minute.
# A green alert will pop up when the build is completed:<br>[[File:VS2022 -- Publish Screen.png|alt=Show's VS2022 publish screen. There's publish button at the top of this screen.|frameless|link=|upright=2|location=center|border]]
# Inside the alert there will be a blue ''Navigate'' link. Click it.
# A file explorer should have opened to where the <code>.dll</code> file is.
# The mod file will be named with the mod project's name. For example, <code>TheMod.dll</code>.
# To share this mod, the only file needed is the mod's <code>.dll</code>. Do not copy any of the <code>.dll</code> files starting with ''Eco'' or ''StrangeCloud''. Additionally, do not copy the <code>TheMod.deps.json</code> or the <code>TheMod.pdb</code> files.

= Post-Build Scripts =
With a post-build script Visual Studio will automatically copy the files into the Eco <code>Mods/UserCode</code> folder every time it builds. It's a very nice feature to have when developing and rebuilding to test something new.

# Open the project in Visual Studio.
# Right-click on the project in the ''Solution Explorer.''
# Select ''↱'' ''Edit Project File'' option.
# Add the properties <code>EcoServerExe</code> and <code>EcoServerDir</code> inside of the <code>PropertyGroup</code> tag.<br>'''Tip:''' By holding shift and right-clicking on a file in the file explorer an old-school menu pops up. Midway down this menu is an option to ''Copy As Path''. Neat!
# The project file should look something like this (lines 8-9):
<syntaxhighlight lang="xml" line="1">
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<TargetFramework>net10.0</TargetFramework>
<ImplicitUsings>enable</ImplicitUsings>
<Nullable>enable</Nullable>


<EcoModsDir>C:\Program Files (x86)\Steam\steamapps\common\Eco\Eco_Data\Server\Mods\UserCode</EcoModsDir>

</PropertyGroup>

<ItemGroup>
<PackageReference Include="Eco.ReferenceAssemblies" Version="0.11.1.13-beta-release-887" />
</ItemGroup>

</Project>
</syntaxhighlight>
# Add the <code>PostBuild</code> property inside the <code>Project</code> tag.
<syntaxhighlight lang="xml" line="1">
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
... SNIP ...
</PropertyGroup>

<ItemGroup>
... SNIP ...
</ItemGroup>

<Target Name="CopyModToEco" AfterTargets="Build">
<Copy SourceFiles="$(TargetPath)" DestinationFolder="$(EcoModsDir)" SkipUnchangedFiles="true" />
<Copy SourceFiles="$(TargetDir)$(TargetName).pdb" DestinationFolder="$(EcoModsDir)" SkipUnchangedFiles="true" Condition="Exists('$(TargetDir)$(TargetName).pdb')" />
</Target>
</Project>
</syntaxhighlight>
# Build the project.
# Look in the <code>Mods/UserCode</code> folder.
# There should be <code>TheMod.dll</code> file.

= Setting up Debugging =
To set up debugging, make sure the project is configured with the post-build script described above.

Debugging is a powerful tool that allows you to set breakpoints anywhere in your code to pause execution. While paused, you can inspect variable values and step through the code line by line. This is invaluable when tracking down bugs or understanding complex behavior.

When running the server in debug mode, code changes can be hot-reloaded. This allows you to modify code and apply changes without rebuilding and restarting Eco, significantly speeding up development.

# Open the ''Debug'' menu from the top toolbar.
# Select ''YourModName Debug Properties'' from the bottom of the menu.<br>[[File:VS2022 -- Debug Menu.png|alt=VS2022's debug menu is open from the top of the application. Highlighted is the last option "Debug Properties".|frameless|link=|upright=2|location=center|border]]
# Click the ''Create a new profile'' button in the top-left of this new window (see image below).
# Select ''Executable'' from the drop-down menu.<br>[[File:VS2022 -- Debugger Launch Profiles.png|alt=VS2022's launch profile window is open. Underlined and pointed to by a red mark is the "Create a new profile" button, located in the top-left of the window. Highlighted from the menu under it is the option reading "Executable".|frameless|link=|upright=2|location=center|border]]
# Set the ''Executable'' field to the full path to the <code>EcoServer.exe</code> file.<br>'''Example:''' <code>C:\Program Files (x86)\Steam\steamapps\common\Eco\Eco_Data\Server</code><code>\EcoServer.exe</code>.
# Set the ''Working Directory'' field to the full path to the folder containing the <code>EcoServer.exe</code> file.<br>'''Example:''' <code>C:\Program Files (x86)\Steam\steamapps\common\Eco\Eco_Data\Server</code>.<br>[[File:VS2022 -- Eco Debugging Profile.png|alt=A fully configured profile ready to debug Eco on VS2022's launch profile page.|frameless|link=|upright=2|location=center|border]]
# Switch to this newly configured profile by clicking the small arrow to the right of the play icon (see image).<br>[[File:VS2022 -- Debugger Profile Selection.png|alt=VS2022's debugger profile selection menu is open with the newly created "Profile 1" highlighted.|frameless|link=|upright=2|location=center|border]]
# Select the newly created profile -- ''Profile 1''.

=== Checkpoint ===

# Put the following in <code>Class1.cs</code> file:
<syntaxhighlight lang="c#" line="1">
using Eco.Core.Plugins.Interfaces;
using Eco.Core.Utils;
using Eco.ModKit;

namespace Test
{
public class Class1 : IModKitPlugin, IInitializablePlugin
{
public string GetCategory() => "Tutorial";

public string GetStatus() => this._status;
string _status = string.Empty;

public void Initialize(TimedTask timer)
{
this._status = "Ok";
bool yes = true;
return;
}
}

[ChatCommandHandler]
[SupportedOSPlatform("windows7.0")]
public static class CommonCentsCommands
{
[ChatCommand("wikiTest", ChatAuthorizationLevel.Moderator)]
public static void wikiTest(IChatClient chat)
{
chat.MsgLoc($"Hello, World.");
}
}
}

</syntaxhighlight><br>This code creates a basic plugin, called <code>Class1</code>, that Eco will load and initialize on startup. Eco knows to do this because this class inherits the <code>IModKitPlugin</code> interface (causes it to be loaded) and the <code>IInitializablePlugin</code> interface (causes it to be initialized).
# Add a breakpoint to the code by right-clicking on the line <code>bool yes = true;</code><br>[[File:VS2022 -- Adding a breakpoint.png|alt=A boilerplate example of a mod is shown in the VS2022 text editor. A line has a menu open above it with the option "Breakpoint" expanded and the option "Insert Breakpoint" highlighted on the sub-menu.|frameless|link=|upright=2|location=center|border]]
# Click the green ''⏵'' button to start the server with the mod. The server will start and Visual Studio will flash back on screen once Eco tries to initialize the mod's plugin.<br>[[File:VS2022 -- Launch Debugger.png|alt=Highlighted is the play button for VS2022's debugger. The "Profile 1" is still selected from before.|frameless|link=|upright=2|location=center|border]]
# When Visual Studio hits the breakpoint it will keep startup from continuing and allow detailed inspection to happen. In the bottom left (circled in red) is a table of all of the variables within scope. Use this to see what is happening (especially useful in loops!). At the middle-top (circled in red) are some of the debugger controls. Clicking the highlighted ''Continue'' button resumes normal operation. Using the buttons to the right that are highlighted will allow the developer to step through the codes execution to see exactly how each line is performing. Debugging is a deep and rich topic that this guide will not explain further, but there's a great video by Microsoft Visual Studio on YouTube called Basics of Debugging. In that 45 minute video (don't worry there's annotations to jump to just what is interesting) a whole gamut of information about how to use debugging is covered.<br>[[File:VS2022 -- Debugger LIve.png|alt=Shows a simple plugin's code in the editor of VS2022. In the bottom-left is a table of all variables used in the function. It is circled in red. On the top of the image also circled in red is the debugger controls. Highlighted within is the continue button and the "step over" button.|frameless|link=|upright=2|location=center|border]]
# Hit the green''⏵'' ''Continue'' button.
# Let the server finish loading.
# Open Eco to play.
# Connect to the LAN world by named something like ''Eco World''.
# Type <code>/wikiDemo</code> in chat.
# See that the mod replies with ''Hello, World.''
# Change line 29 in <code>Class1.cs</code> to <code>chat.MsgLoc($"Hello, Modder!");</code>
# Hit the hot reload button. It's just to the right of the green ''⏵'' ''Continue'' button and vaguely looks like the 🔥 icon.
# Type <code>/wikiDemo</code> in chat.
# See that the mod now replies with ''Hello, Modder!''

== Releasing a Mod ==

=== Mod.io ===
<code>mod.io</code> is where creators share their mods with players and others. To share a new mod there all that is necessary is an account:

# Goto <code><nowiki>https://mod.io/g/eco</nowiki></code> and click "Login" in the top-right corner.
# Sign up with whatever account type you prefer.
# Click the "Add Mod" button in the top-right.
# Follow the upload wizard as directed.
# Once on the "File Manager" section, a zip file is needed...
## Zip the mod's <code>release/</code> dll and any other assets necessary (e.g. Unity bundles) by putting all the files into a folder.
## Right-click on that folder
## Hover "Compress To..."
## Select "ZIP file".
## Use and upload that zip file.<br>'''Tip:''' Considering naming it with a version number to help stay organized (e.g. "v1"). Next release, increase that number by 1 (e.g. "v2")

=== Sharing on Discord ===
Consider posting an ad on the official {{EcoDiscord}}. There's a channel for mods called ''mod-ads''.
Please read the rules before posting.

== Helpful Resources ==

* Consider learning source control (Git). Completely optional, but can help you keep things organized as development continues.
* Explore Eco’s open-source mod projects for ideas (search on GitHub "Eco Mods" to find some real-life examples)
** {{EcoDiscord}}has a channel for mod developers to help one another called ''mod-dev.'' '''Note:''' Make under the ''Channel & Roles'' settings you have the 🛠''Yes, I want to see the channels about modding'' role selected.

Getting Started with Eco Modding in Visual Studio

2026-04-29T14:44:07Z

WugWugg:

= Introduction =
This guide focuses on setting up a C# modding environment in Visual Studio.

It does '''not''' cover adding Unity assets (models, prefabs, UI) to the game. See: [[From 3D Asset to Working Worktable]] for that workflow.

This guide won’t teach you how to code or write a mod, but it will help you get everything set up so you’re ready to start learning. Helpful resources are listed at the bottom of this guide, including [[Helpful Examples for Modding]] for practical code examples.

Visual Studio 2026 has a completely free to use version called the '''Community Edition'''. This guide is written assuming that's the version used.

=== Have Ready ===
* A copy of the Eco game installed
* A file explorer and the file-path to <code>Eco</code> folder<br>'''Tip:''' Within this folder there's folders like <code>D3D12</code> and <code>Eco_Data</code>. Also, you'll find the <code>Eco.exe</code> file here. There are other files and folder here too, but this list is just to help you know what the folder looks like.
* '''Tip:''' Steam users can find the install folder by right-clicking on the game in your Steam Library:<br>[[File:Steam Library -- Browse Local Files.png|alt=Shows a Steam Library with a menu open over the Eco game. Highlighted in that menu is a "Manage" option, opening a sub-menu. The sub-menu has "Browse local files" highlighted.|frameless|border|upright=3|location=center|link=]]

= Installing Visual Studio =
# Go to <code><nowiki>https://visualstudio.microsoft.com/downloads/#visual-studio-community-2026</nowiki></code> and look for the "'''Visual Studio Community 2026'''" download.
# Start the download by clicking on the ''Download'' button.
# Run the installer until it reaches to the Workloads page.
# Select these workloads...
## .NET desktop development -- '''Required''' for any mod development
## ASP.NET and web development -- Optional. If you want to interact with external websites or Eco's own web server (e.g. Discord's webhooks or extending the API)
# With those workloads selected the page should look something like this:<br>[[File:VisualStudioCommunity2022 Workloads.png|alt=Workloads screen during VS2022 installation. Options selected are "ASP.NET and web development" and ".NET desktop development". |frameless|location=center|upright=4|link=|border]]
# Click the Install button. It will take a few minutes to complete installation.
# Open Visual Studio after it installs.
# You may be prompted to sign in:
## Click ''Skip and add accounts later'' to continue.
## If you plan to use Github, sign in to make version control easier.
# Finally, it might ask what color theme you'd like. Select your preference and continue.
# Visual Studio is now installed and ready to be used.

= Setting Up a New Mod =
Once Eco and Visual Studio are installed all of the tools needed to code, build, and run a mod are ready.

== Creating a New Project ==
# Open Visual Studio. When it first opens it will show you a dashboard where you can quickly select what you want to do.
# On the right, under ''Get Started'' find the ''Create a new project'' button:<br>[[File:VS2022 OpeningDashboard.png|alt=VS2022's launch dashboard showing recent projects on the left and quick action buttons on the right. Highlighted is a button titled "Create a new project".|frameless|border|link=|location=center|upright=4]]
# A new window will pop-up.
# Select C# ''Class Library.'' To find the template, search <code>C# library</code> in the search bar. Select the C# option titled ''Class Library''.<br>'''Note:''' <u>Make sure you select the <code>C#</code> option as there are other options similarly named ''Class Library''.</u><br>[[File:VS2022 NewProjectWizard Templates.png|frameless|border|location=center|upright=4|link=]]
# Click the ''Next'' button.
# For ''Project Name'' type the name of the mod being created.
# The other options like the ''Location'' and the ''Solution Name'' do not need edited.
# Leave the box ''Place solution and project in the same directory'' unchecked.
# Click the Next button.
# In the ''Framework'' drop-down select the same version of .NET Eco uses (as described below). '''Tip:''' Eco currently targets ''.NET 10.0''

== .NET Version ==
To confirm the version of .NET that Eco uses:

# Go to the NuGet Gallery <code>www.nuget.org/packages?q=Eco.ReferenceAssemblies</code>
# Find the package with the name ''Eco.ReferenceAssemblies'' made by ''StrangeLoopGames''.
# Notice the chip underneath of it with the ''.NET'' version it targets.<br>[[File:NuGetGallery -- Eco.ReferenceAssemblies Search.png|alt=Shows the search result of Eco.ReferenceAssemblies. In a blue chip the text ".NET 8.0" can be seen.|frameless|upright=4|location=center|link=|border]]
# Click on that search result (shown above).
# A more detailed page is shown. Again, there's chips showing what version of .NET to use:<br>[[File:NuGetGallery--Eco.ReferenceAssemblies Details.png|alt=Show the package page for "Eco.ReferenceAssemblies" on NuGet Gallery. Circled in red are two chips with some version of the text ".NET 8.0" inside them.|frameless|link=|border|location=center|upright=3]]

== Linking to Eco Assemblies ==
# Find the ''Solution Explorer'' on the right side of Visual Studio. It should look something like this:<br>'''Note''': If the solution explorer isn't there, open the ''View'' menu (top toolbar) and select ''Solution Explorer''.<br>[[File:VS2022 -- Solution Explorer.png|alt=A picture of a basic layout in Visual Studio 2022 with the Solution Explorer open on the right-hand side. The solution explorer is circled in red.|frameless|link=|upright=4|location=center|border]]
# In the ''Solution Explorer'', find and right-click on the ''Dependencies'' item.
# Select ''Manage NuGet Packages...''<br>[[File:VS2022 Solution Explorer -- Manage NuGet Packages.png|alt=Shows VS2022's Solution Explorer with project expanded. The References line is highlighted and a menu is open. On that menu the "Manage NuGet Packages" line is highlighted.|frameless|link=|upright=4|location=center|border]]
# A ''NuGet'' tab will have opened in the editor window...
## Right above the search bar on this tab there's sub-tabs.
## Select the ''Browse'' sub-tab.
## Type <code>Eco.ReferenceAssemblies</code> into the search bar.
## Check the ''Include prerelease'' check-box.
## Find the option with the name ''Eco.ReferenceAssemblies'' made by ''StrangeLoopGames''.
## Click on that.
## A details panel will show up to the right. It will show the version of the reference assemblies being targeted. By default it chooses the latest and can be left at its default.
## Click the Install button.
## Click the ''Apply'' button on the popup to finish adding the references.<br>[[File:VS2022 -- NuGet Install Eco.ReferenceAssemblies.png|alt=VS2022 is open to the NuGet tab and is searching with the text Eco.ReferenceAssemblies. The checkbox to the right of the search is checked -- include prerelease. The only search result is selected. There is yellow highlights over part of the photo.|frameless|link=|upright=4|location=center|border]]
# Now reference assemblies have now been added. That means when coding Visual Studio will provide IntelliSense popups.
# Try it out by going back to the <code>Class1.cs</code> file and typing <code>Eco.</code> and you will see suggestion pop up.

= Dynamic Link Library (DLL) =
Building the mod creates the <code>.dll</code> file that can be dropped into the <code>Mods/UserCode</code> folder of any server an ran.

== Building for Development ==

# Open the project in Visual Studio.
# Open the ''Build'' menu from the top toolbar.
# Select ''Build Solution''. This will produce non-optimized DLL used for testing and development.<br>[[File:VS2022 -- Build Menu.png|alt=VS2022 top menu "Build" is open with "build solution" highlighted (ctrl + shift + b).|frameless|link=|upright=4|location=center|border]]
# To find the file Visual Studio just built, right click on the project in the Solution Explorer.
# Select ''Open Folder in File Explorer.''<br>[[File:VS2022 -- Project Menu.png|alt=VS2022's solution explorer is shown with the projects right-click menu open. Highlighted is "Open folder in File Explorer"|frameless|link=|upright=4|location=center|border]]
# From here, the mod's DLL will be in the <code>bin/Debug/net10.0/</code> folder. The file will be named with mod's name, like <code>TheMod.dll</code>.
# Copy the mod's DLL file.
# Paste it into the folder <code>Eco/Eco_Data/Server/Mods/UserCode</code>.

=== Checkpoint ===

# Start a Eco and create a local world to see if the mod is being loaded.
# Check the logs at <code>Eco/Eco_Data/Server/Logs/</code> to verify...
## Open the <u>most recent</u> log file here.
## If the mod was loaded it there will be a line mentioning the file-name of the DLL. If the DLL was named <code>TheMod.dll</code>, line 5 is what to look for in the log file:<br><syntaxhighlight lang="text" line="1">[13:55:54.815] [4] [ Info] [Eco] Starting ModKitPlugin ...
[13:56:27.399] [4] [ Info] [Eco] Starting ModKitPlugin ... Finished in 32.584 sec

[13:56:27.439] [4] [ Info] [Eco] Loading mods ...
[13:56:27.439] [9] [ Info] [Eco] Loading TheMod...</syntaxhighlight>

'''Pro-Tip:''' Setup File Explorer to Sort By Date

# Setup the file view to ''Details'' in this folder because it will show the ''Date Modified'' for each file.<br>[[File:File Explorer -- View Settings Menu.png|alt=Show Window's File Explorer's view setting menu with the "details" option highlighted.|frameless|link=|upright=2|location=center|border]]
# Click on the ''Date Modified'' header to sort all files. This will sort it so the most recent is on top. Now, every time the server starts the log file is easily found -- it's the one on top!<br>[[File:File Explorer -- Details Example.png|alt=Show's window's File Explorer with the date modified header highlighted.|frameless|link=|upright=2|location=center|border]]

== Building for Release ==
Release builds are optimized and intended for sharing. Unlike Debug builds, they exclude extra debugging overhead and produce a cleaner, final version of your mod.

# Open the project in Visual Studio.
# Click on the mod's project in the Solution Explorer to highlight it. [[File:VS2022 -- Solution Explorer Project Highlight.png|alt=Shows VS2022's solution explorer with the project highlighted.|frameless|link=|upright=2|location=center|border]]
# Open the ''Build'' menu from the top toolbar.
# Select ''Publish Selection''.
# A new ''Publish'' window will pop-up.
# Set the target ''as Folder''.
# Click the ''Next'' button. [[File:VS2022 -- Publish Wizard.png|alt=VS2022's publish wizard showing the target selection screen. The Folder option is highlighted.|frameless|link=|upright=2|location=center|border]]
# Leave the folder location as it is.
# Click the ''Finish'' button.
# Click the ''Close'' button.
# Click the ''Publish'' button to start the build. This may take a minute.
# A green alert will pop up when the build is completed: [[File:VS2022 -- Publish Screen.png|alt=Show's VS2022 publish screen. There's publish button at the top of this screen.|frameless|link=|upright=2|location=center|border]]
# Inside the alert there will be a blue ''Navigate'' link. Click it.
# A file explorer should have opened to where the <code>.dll</code> file is.
# The mod file will be named with the mod project's name. For example, <code>TheMod.dll</code>.
# To share this mod, the only file needed is the mod's <code>.dll</code>. Do not copy any of the <code>.dll</code> files starting with ''Eco'' or ''StrangeCloud''. Additionally, do not copy the <code>TheMod.deps.json</code> or the <code>TheMod.pbd</code> files.

= Post-Build Scripts =
With a post-build script Visual Studio will automatically copy the files into the Eco <code>Mods/UserCode</code> folder every time it builds. It's a very nice feature to have when developing and rebuilding to test something new.

# Open the project in Visual Studio.
# Right-click on the project in the ''Solution Explorer.''
# Select ''↱'' ''Edit Project File'' option.
# Add the properties <code>EcoServerExe</code> and <code>EcoServerDir</code> inside of the <code>PropertyGroup</code> tag. '''Tip:''' By holding shift and right-clicking on a file in the file explorer an old-school menu pops up. Midway down this menu is an option to ''Copy As Path''. Neat!
# The project file should look something like this (lines 8-9):<syntaxhighlight lang="xml" line="1"><Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<TargetFramework>net10.0</TargetFramework>
<ImplicitUsings>enable</ImplicitUsings>
<Nullable>enable</Nullable>


<EcoModsDir>C:\Program Files (x86)\Steam\steamapps\common\Eco\Eco_Data\Server\Mods\UserCode</EcoModsDir>

</PropertyGroup>

<ItemGroup>
<PackageReference Include="Eco.ReferenceAssemblies" Version="0.11.1.13-beta-release-887" />
</ItemGroup>

</Project></syntaxhighlight>
# Add the <code>PostBuild</code> property inside the <code>Project</code> tag.<syntaxhighlight lang="xml" line="1">
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
... SNIP ...
</PropertyGroup>

<ItemGroup>
... SNIP ...
</ItemGroup>

<Target Name="CopyModToEco" AfterTargets="Build">
<Copy SourceFiles="$(TargetPath)" DestinationFolder="$(EcoModsDir)" SkipUnchangedFiles="true" />
<Copy SourceFiles="$(TargetDir)$(TargetName).pdb" DestinationFolder="$(EcoModsDir)" SkipUnchangedFiles="true" Condition="Exists('$(TargetDir)$(TargetName).pdb')" />
</Target>
</Project>
</syntaxhighlight>
# Build the project.
# Look in the <code>Mods/UserCode</code> folder.
# There should be <code>TheMod.dll</code> file.

= Setting up Debugging =
To set up debugging, make sure the project is configured with the post-build script described above.

Debugging is a powerful tool that allows you to set breakpoints anywhere in your code to pause execution. While paused, you can inspect variable values and step through the code line by line. This is invaluable when tracking down bugs or understanding complex behavior.

When running the server in debug mode, code changes can be hot-reloaded. This allows you to modify code and apply changes without rebuilding and restarting Eco, significantly speeding up development.

# Open the ''Debug'' menu from the top toolbar.
# Select ''YourModName Debug Properties'' from the bottom of the menu. [[File:VS2022 -- Debug Menu.png|alt=VS2022's debug menu is open from the top of the application. Highlighted is the last option "Debug Properties".|frameless|link=|upright=2|location=center|border]]
# Click the ''Create a new profile'' button in the top-left of this new window (see image below).
# Select ''Executable'' from the drop-down menu. [[File:VS2022 -- Debugger Launch Profiles.png|alt=VS2022's launch profile window is open. Underlined and pointed to by a red mark is the "Create a new profile" button, located in the top-left of the window. Highlighted from the menu under it is the option reading "Executable".|frameless|link=|upright=2|location=center|border]]
# Set the ''Executable'' field to the full path to the <code>EcoServer.exe</code> file. '''Example:''' <code>C:\Program Files (x86)\Steam\steamapps\common\Eco\Eco_Data\Server</code><code>\EcoServer.exe</code>.
# Set the ''Working Directory'' field to the full path to the folder containing the <code>EcoServer.exe</code> file. '''Example:''' <code>C:\Program Files (x86)\Steam\steamapps\common\Eco\Eco_Data\Server</code>. [[File:VS2022 -- Eco Debugging Profile.png|alt=A fully configured profile ready to debug Eco on VS2022's launch profile page.|frameless|link=|upright=2|location=center|border]]
# Switch to this newly configured profile by clicking the small arrow to the right of the play icon (see image). [[File:VS2022 -- Debugger Profile Selection.png|alt=VS2022's debugger profile selection menu is open with the newly created "Profile 1" highlighted.|frameless|link=|upright=2|location=center|border]]
# Select the newly created profile -- ''Profile 1''.

=== Checkpoint ===

# Put the following in <code>Class1.cs</code> file:<syntaxhighlight lang="c#" line="1">
using Eco.Core.Plugins.Interfaces;
using Eco.Core.Utils;
using Eco.ModKit;

namespace Test
{
public class Class1 : IModKitPlugin, IInitializablePlugin
{
public string GetCategory() => "Tutorial";

public string GetStatus() => this._status;
string _status = string.Empty;

public void Initialize(TimedTask timer)
{
this._status = "Ok";
bool yes = true;
return;
}
}

[ChatCommandHandler]
[SupportedOSPlatform("windows7.0")]
public static class CommonCentsCommands
{
[ChatCommand("wikiTest", ChatAuthorizationLevel.Moderator)]
public static void wikiTest(IChatClient chat)
{
chat.MsgLoc($"Hello, World.");
}
}
}

</syntaxhighlight>This code creates a basic plugin, called <code>Class1</code>, that Eco will load and initialize on startup. Eco knows to do this because this class inherits the <code>IModKitPlugin</code> interface (causes it to be loaded) and the <code>IInitializablePlugin</code> interface (causes it to be initialized).
# Add a breakpoint to the code by right-clicking on the line <code>bool yes = true;</code>[[File:VS2022 -- Adding a breakpoint.png|alt=A boilerplate example of a mod is shown in the VS2022 text editor. A line has a menu open above it with the option "Breakpoint" expanded and the option "Insert Breakpoint" highlighted on the sub-menu.|frameless|link=|upright=2|location=center|border]]
# Click the green ''⏵'' button to start the server with the mod. The server will start and Visual Studio will flash back on screen once Eco tries to initialize the mod's plugin.[[File:VS2022 -- Launch Debugger.png|alt=Highlighted is the play button for VS2022's debugger. The "Profile 1" is still selected from before.|frameless|link=|upright=2|location=center|border]]
# When Visual Studio hits the breakpoint it will keep startup from continuing and allow detailed inspection to happen. In the bottom left (circled in red) is a table of all of the variables within scope. Use this to see what is happening (especially useful in loops!). At the middle-top (circled in red) are some of the debugger controls. Clicking the highlighted ''Continue'' button resumes normal operation. Using the buttons to the right that are highlighted will allow the developer to step through the codes execution to see exactly how each line is performing. Debugging is a deep and rich topic that this guide will not explain further, but there's a great video by Microsoft Visual Studio on YouTube called Basics of Debugging. In that 45 minute video (don't worry there's annotations to jump to just what is interesting) a whole gamut of information about how to use debugging is covered. [[File:VS2022 -- Debugger LIve.png|alt=Shows a simple plugin's code in the editor of VS2022. In the bottom-left is a table of all variables used in the function. It is circled in red. On the top of the image also circled in red is the debugger controls. Highlighted within is the continue button and the "step over" button.|frameless|link=|upright=2|location=center|border]]
# Hit the green''⏵'' ''Continue'' button.
# Let the server finish loading.
# Open Eco to play.
# Connect to the LAN world by named something like ''Eco World''.
# Type <code>/wikiDemo</code> in chat.
# See that the mod replies with ''Hello, World.''
# Change line 29 in <code>Class1.cs</code> to <code>chat.MsgLoc($"Hello, Modder!");</code>
# Hit the hot reload button. It's just to the right of the green ''⏵'' ''Continue'' button and vaguely looks like the 🔥 icon.
# Type <code>/wikiDemo</code> in chat.
# See that the mod now replies with ''Hello, Modder!''

== Releasing a Mod ==

=== Mod.io ===
<code>mod.io</code> is where creators share their mods with players and others. To share a new mod there all that is necessary is an account:

# Goto <code><nowiki>https://mod.io/g/eco</nowiki></code> and click "Login" in the top-right corner.
# Sign up with whatever account type you prefer.
# Click the "Add Mod" button in the top-right.
# Follow the upload wizard as directed.
# Once on the "File Manager" section, a zip file is needed...
## Zip the mod's <code>release/</code> dll and any other assets necessary (e.g. Unity bundles) by putting all the files into a folder.
## Right-click on that folder
## Hover "Compress To..."
## Select "ZIP file".
## Use and upload that zip file.<br> Tip: Considering naming it with a version number to help stay organized (e.g. "v1"). Next release, increase that number by 1 (e.g. "v2")

=== Sharing on Discord ===
Consider posting an ad on the official {{EcoDiscord}}. There's a channel for mods called ''mod-ads''.
Please read the rules before posting.

== Helpful Resources ==

* Consider learning source control (Git). Completely optional, but can help you keep things organized as development continues.
* Explore Eco’s open-source mod projects for ideas (search on Github "Eco Mods" to find some real-life examples)
** {{EcoDiscord}}has a channel for mod developers to help one another called ''mod-dev.'' '''Note:''' Make under the ''Channel & Roles'' settings you have the 🛠''Yes, I want to see the channels about modding'' role selected.

Getting Started with Eco Modding in Visual Studio

2026-04-29T14:32:15Z

WugWugg:

= Introduction =
This guide focuses on setting up a C# modding environment in Visual Studio.

It does '''not''' cover adding Unity assets (models, prefabs, UI) to the game. See: [[From 3D Asset to Working Worktable]] for that workflow.

This guide won’t teach you how to code or write a mod, but it will help you get everything set up so you’re ready to start learning. Helpful resources are listed at the bottom of this guide, including [[Helpful Examples for Modding]] for practical code examples.

Visual Studio 2026 has a completely free to use version called the '''Community Edition'''. This guide is written assuming that's the version used.

=== Have Ready ===
* A copy of the Eco game installed
* A file explorer and the file-path to <code>Eco</code> folder<br>'''Tip:''' Within this folder there's folders like <code>D3D12</code> and <code>Eco_Data</code>. Also, you'll find the <code>Eco.exe</code> file here. There are other files and folder here too, but this list is just to help you know what the folder looks like.
* '''Tip:''' Steam users can find the install folder by right-clicking on the game in your Steam Library:<br>[[File:Steam Library -- Browse Local Files.png|alt=Shows a Steam Library with a menu open over the Eco game. Highlighted in that menu is a "Manage" option, opening a sub-menu. The sub-menu has "Browse local files" highlighted.|frameless|border|upright=3|location=center|link=]]

= Installing Visual Studio =
# Go to <code><nowiki>https://visualstudio.microsoft.com/downloads/#visual-studio-community-2026</nowiki></code> and look for the "'''Visual Studio Community 2026'''" download.
# Start the download by clicking on the ''Download'' button.
# Run the installer until it reaches to the Workloads page.
# Select these workloads...
## .NET desktop development -- '''Required''' for any mod development
## ASP.NET and web development -- Optional. If you want to interact with external websites or Eco's own web server (e.g. Discord's webhooks or extending the API)
# With those workloads selected the page should look something like this:<br>[[File:VisualStudioCommunity2022 Workloads.png|alt=Workloads screen during VS2022 installation. Options selected are "ASP.NET and web development" and ".NET desktop development". |frameless|location=center|upright=4|link=|border]]
# Click the Install button. It will take a few minutes to complete installation.
# Open Visual Studio after it installs.
# You may be prompted to sign in:
## Click ''Skip and add accounts later'' to continue.
## If you plan to use Github, sign in to make version control easier.
# Finally, it might ask what color theme you'd like. Select your preference and continue.
# Visual Studio is now installed and ready to be used.

= Setting Up a New Mod =
Once Eco and Visual Studio are installed all of the tools needed to code, build, and run a mod are ready.

== Creating a New Project ==
# Open Visual Studio. When it first opens it will show you a dashboard where you can quickly select what you want to do.
# On the right, under ''Get Started'' find the ''Create a new project'' button:<br>[[File:VS2022 OpeningDashboard.png|alt=VS2022's launch dashboard showing recent projects on the left and quick action buttons on the right. Highlighted is a button titled "Create a new project".|frameless|border|link=|location=center|upright=4]]
# A new window will pop-up.
# Select C# ''Class Library.'' To find the template, search <code>C# library</code> in the search bar. Select the C# option titled ''Class Library''.<br>'''Note:''' <u>Make sure you select the <code>C#</code> option as there are other options similarly named ''Class Library''.</u><br>[[File:VS2022 NewProjectWizard Templates.png|frameless|border|location=center|upright=4|link=]]
# Click the ''Next'' button.
# For ''Project Name'' type the name of the mod being created.
# The other options like the ''Location'' and the ''Solution Name'' do not need edited.
# Leave the box ''Place solution and project in the same directory'' unchecked.
# Click the Next button.
# In the ''Framework'' drop-down select the same version of .NET Eco uses (as described below). '''Tip:''' Eco currently targets ''.NET 10.0''

== .NET Version ==
To confirm the version of .NET that Eco uses:

# Go to the NuGet Gallery <code>www.nuget.org/packages?q=Eco.ReferenceAssemblies</code>
# Find the package with the name ''Eco.ReferenceAssemblies'' made by ''StrangeLoopGames''.
# Notice the chip underneath of it with the ''.NET'' version it targets.<br>[[File:NuGetGallery -- Eco.ReferenceAssemblies Search.png|alt=Shows the search result of Eco.ReferenceAssemblies. In a blue chip the text ".NET 8.0" can be seen.|frameless|upright=4|location=center|link=|border]]
# Click on that search result (shown above).
# A more detailed page is shown. Again, there's chips showing what version of .NET to use:<br>[[File:NuGetGallery--Eco.ReferenceAssemblies Details.png|alt=Show the package page for "Eco.ReferenceAssemblies" on NuGet Gallery. Circled in red are two chips with some version of the text ".NET 8.0" inside them.|frameless|link=|border|location=center|upright=3]]

== Linking to Eco Assemblies ==
# Find the ''Solution Explorer'' on the right side of Visual Studio. It should look something like this:<br>'''Note''': If the solution explorer isn't there, open the ''View'' menu (top toolbar) and select ''Solution Explorer''.<br>[[File:VS2022 -- Solution Explorer.png|alt=A picture of a basic layout in Visual Studio 2022 with the Solution Explorer open on the right-hand side. The solution explorer is circled in red.|frameless|link=|upright=4|location=center|border]]
# In the ''Solution Explorer'', find and right-click on the ''Dependencies'' item.
# Select ''Manage NuGet Packages...''<br>[[File:VS2022 Solution Explorer -- Manage NuGet Packages.png|alt=Shows VS2022's Solution Explorer with project expanded. The References line is highlighted and a menu is open. On that menu the "Manage NuGet Packages" line is highlighted.|frameless|link=|upright=4|location=center|border]]
# A ''NuGet'' tab will have opened in the editor window...
## Right above the search bar on this tab there's sub-tabs.
## Select the ''Browse'' sub-tab.
## Type <code>Eco.ReferenceAssemblies</code> into the search bar.
## Check the ''Include prerelease'' check-box.
## Find the option with the name ''Eco.ReferenceAssemblies'' made by ''StrangeLoopGames''.
## Click on that.
## A details panel will show up to the right. It will show the version of the reference assemblies being targeted. By default it chooses the latest and can be left at its default.
## Click the Install button.
## Click the ''Apply'' button on the popup to finish adding the references.<br>[[File:VS2022 -- NuGet Install Eco.ReferenceAssemblies.png|alt=VS2022 is open to the NuGet tab and is searching with the text Eco.ReferenceAssemblies. The checkbox to the right of the search is checked -- include prerelease. The only search result is selected. There is yellow highlights over part of the photo.|frameless|link=|upright=4|location=center|border]]
# Now reference assemblies have now been added. That means when coding Visual Studio will provide IntelliSense popups.
# Try it out by going back to the <code>Class1.cs</code> file and typing <code>Eco.</code> and you will see suggestion pop up.

= Dynamic Link Library (DLL) =
Building the mod creates the <code>.dll</code> file that can be dropped into the <code>Mods/UserCode</code> folder of any server an ran.

== Building for Development ==

# Open the project in Visual Studio.
# Open the ''Build'' menu from the top toolbar.
# Select ''Build Solution''. This will produce non-optimized DLL used for testing and development.<br>[[File:VS2022 -- Build Menu.png|alt=VS2022 top menu "Build" is open with "build solution" highlighted (ctrl + shift + b).|frameless|link=|upright=4|location=center|border]]
# To find the file Visual Studio just built, right click on the project in the Solution Explorer.
# Select ''Open Folder in File Explorer.''<br>[[File:VS2022 -- Project Menu.png|alt=VS2022's solution explorer is shown with the projects right-click menu open. Highlighted is "Open folder in File Explorer"|frameless|link=|upright=4|location=center|border]]
# From here, the mod's DLL will be in the <code>bin/Debug/net10.0/</code> folder. The file will be named with mod's name, like <code>TheMod.dll</code>.
# Copy the mod's DLL file.
# Paste it into the folder <code>Eco/Eco_Data/Server/Mods/UserCode</code>.

=== Checkpoint ===

# Start a Eco and create a local world to see if the mod is being loaded.
# Check the logs at <code>Eco/Eco_Data/Server/Logs/</code> to verify...
## Open the <u>most recent</u> log file here.
## If the mod was loaded it there will be a line mentioning the file-name of the DLL. If the DLL was named <code>TheMod.dll</code>, line 5 is what to look for in the log file:<br><syntaxhighlight lang="text" line="1">[13:55:54.815] [4] [ Info] [Eco] Starting ModKitPlugin ...
[13:56:27.399] [4] [ Info] [Eco] Starting ModKitPlugin ... Finished in 32.584 sec

[13:56:27.439] [4] [ Info] [Eco] Loading mods ...
[13:56:27.439] [9] [ Info] [Eco] Loading TheMod...</syntaxhighlight>

'''Pro-Tip:''' Setup File Explorer to Sort By Date

# Setup the file view to ''Details'' in this folder because it will show the ''Date Modified'' for each file.<br>[[File:File Explorer -- View Settings Menu.png|alt=Show Window's File Explorer's view setting menu with the "details" option highlighted.|frameless|link=|upright=2|location=center|border]]
# Click on the ''Date Modified'' header to sort all files. This will sort it so the most recent is on top. Now, every time the server starts the log file is easily found -- it's the one on top!<br>[[File:File Explorer -- Details Example.png|alt=Show's window's File Explorer with the date modified header highlighted.|frameless|link=|upright=2|location=center|border]]

== Building for Release ==
Release builds are optimized and intended for sharing. Unlike Debug builds, they exclude extra debugging overhead and produce a cleaner, final version of your mod.

# Open the project in Visual Studio.
# Click on the mod's project in the Solution Explorer to highlight it. [[File:VS2022 -- Solution Explorer Project Highlight.png|alt=Shows VS2022's solution explorer with the project highlighted.|frameless|link=|upright=2|location=center|border]]
# Open the ''Build'' menu from the top toolbar.
# Select ''Publish Selection''.
# A new ''Publish'' window will pop-up.
# Set the target ''as Folder''.
# Click the ''Next'' button. [[File:VS2022 -- Publish Wizard.png|alt=VS2022's publish wizard showing the target selection screen. The Folder option is highlighted.|frameless|link=|upright=2|location=center|border]]
# Leave the folder location as it is.
# Click the ''Finish'' button.
# Click the ''Close'' button.
# Click the ''Publish'' button to start the build. This may take a minute.
# A green alert will pop up when the build is completed: [[File:VS2022 -- Publish Screen.png|alt=Show's VS2022 publish screen. There's publish button at the top of this screen.|frameless|link=|upright=2|location=center|border]]
# Inside the alert there will be a blue ''Navigate'' link. Click it.
# A file explorer should have opened to where the <code>.dll</code> file is.
# The mod file will be named with the mod project's name. For example, <code>TheMod.dll</code>.
# To share this mod, the only file needed is the mod's <code>.dll</code>. Do not copy any of the <code>.dll</code> files starting with ''Eco'' or ''StrangeCloud''. Additionally, do not copy the <code>TheMod.deps.json</code> or the <code>TheMod.pbd</code> files.

= Post-Build Scripts =
With a post-build script Visual Studio will automatically copy the files into the Eco <code>Mods/UserCode</code> folder every time it builds. It's a very nice feature to have when developing and rebuilding to test something new.

# Open the project in Visual Studio.
# Right-click on the project in the ''Solution Explorer.''
# Select ''↱'' ''Edit Project File'' option.
# Add the properties <code>EcoServerExe</code> and <code>EcoServerDir</code> inside of the <code>PropertyGroup</code> tag. '''Tip:''' By holding shift and right-clicking on a file in the file explorer an old-school menu pops up. Midway down this menu is an option to ''Copy As Path''. Neat!
# The project file should look something like this (lines 8-9):<syntaxhighlight lang="xml" line="1"><Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<TargetFramework>net10.0</TargetFramework>
<ImplicitUsings>enable</ImplicitUsings>
<Nullable>enable</Nullable>


<EcoModsDir>C:\Program Files (x86)\Steam\steamapps\common\Eco\Eco_Data\Server\Mods\UserCode</EcoModsDir>

</PropertyGroup>

<ItemGroup>
<PackageReference Include="Eco.ReferenceAssemblies" Version="0.11.1.13-beta-release-887" />
</ItemGroup>

</Project></syntaxhighlight>
# Add the <code>PostBuild</code> property inside the <code>Project</code> tag.<syntaxhighlight lang="xml" line="1">
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
... SNIP ...
</PropertyGroup>

<ItemGroup>
... SNIP ...
</ItemGroup>

<Target Name="CopyModToEco" AfterTargets="Build">
<Copy SourceFiles="$(TargetPath)" DestinationFolder="$(EcoModsDir)" SkipUnchangedFiles="true" />
<Copy SourceFiles="$(TargetDir)$(TargetName).pdb" DestinationFolder="$(EcoModsDir)" SkipUnchangedFiles="true" Condition="Exists('$(TargetDir)$(TargetName).pdb')" />
</Target>
</Project>
</syntaxhighlight>
# Build the project.
# Look in the <code>Mods/UserCode</code> folder.
# There should be <code>TheMod.dll</code> file.

= Setting up Debugging =
To set up debugging, make sure the project is configured with the post-build script described above.

Debugging is a powerful tool that allows you to set breakpoints anywhere in your code to pause execution. While paused, you can inspect variable values and step through the code line by line. This is invaluable when tracking down bugs or understanding complex behavior.

When running the server in debug mode, code changes can be hot-reloaded. This allows you to modify code and apply changes without rebuilding and restarting Eco, significantly speeding up development.

# Open the ''Debug'' menu from the top toolbar.
# Select ''YourModName Debug Properties'' from the bottom of the menu. [[File:VS2022 -- Debug Menu.png|alt=VS2022's debug menu is open from the top of the application. Highlighted is the last option "Debug Properties".|frameless|link=|upright=2|location=center|border]]
# Click the ''Create a new profile'' button in the top-left of this new window (see image below).
# Select ''Executable'' from the drop-down menu. [[File:VS2022 -- Debugger Launch Profiles.png|alt=VS2022's launch profile window is open. Underlined and pointed to by a red mark is the "Create a new profile" button, located in the top-left of the window. Highlighted from the menu under it is the option reading "Executable".|frameless|link=|upright=2|location=center|border]]
# Set the ''Executable'' field to the full path to the <code>EcoServer.exe</code> file. '''Example:''' <code>C:\Program Files (x86)\Steam\steamapps\common\Eco\Eco_Data\Server</code><code>\EcoServer.exe</code>.
# Set the ''Working Directory'' field to the full path to the folder containing the <code>EcoServer.exe</code> file. '''Example:''' <code>C:\Program Files (x86)\Steam\steamapps\common\Eco\Eco_Data\Server</code>. [[File:VS2022 -- Eco Debugging Profile.png|alt=A fully configured profile ready to debug Eco on VS2022's launch profile page.|frameless|link=|upright=2|location=center|border]]
# Switch to this newly configured profile by clicking the small arrow to the right of the play icon (see image). [[File:VS2022 -- Debugger Profile Selection.png|alt=VS2022's debugger profile selection menu is open with the newly created "Profile 1" highlighted.|frameless|link=|upright=2|location=center|border]]
# Select the newly created profile -- ''Profile 1''.

=== Checkpoint ===

# Put the following in <code>Class1.cs</code> file:<syntaxhighlight lang="c#" line="1">
using Eco.Core.Plugins.Interfaces;
using Eco.Core.Utils;
using Eco.ModKit;

namespace Test
{
public class Class1 : IModKitPlugin, IInitializablePlugin
{
public string GetCategory() => "Tutorial";

public string GetStatus() => this._status;
string _status = string.Empty;

public void Initialize(TimedTask timer)
{
this._status = "Ok";
bool yes = true;
return;
}
}

[ChatCommandHandler]
[SupportedOSPlatform("windows7.0")]
public static class CommonCentsCommands
{
[ChatCommand("wikiTest", ChatAuthorizationLevel.Moderator)]
public static void wikiTest(IChatClient chat)
{
chat.MsgLoc($"Hello, World.");
}
}
}

</syntaxhighlight>This code creates a basic plugin, called <code>Class1</code>, that Eco will load and initialize on startup. Eco knows to do this because this class inherits the <code>IModKitPlugin</code> interface (causes it to be loaded) and the <code>IInitializablePlugin</code> interface (causes it to be initialized).
# Add a breakpoint to the code by right-clicking on the line <code>bool yes = true;</code>[[File:VS2022 -- Adding a breakpoint.png|alt=A boilerplate example of a mod is shown in the VS2022 text editor. A line has a menu open above it with the option "Breakpoint" expanded and the option "Insert Breakpoint" highlighted on the sub-menu.|frameless|link=|upright=2|location=center|border]]
# Click the green ''⏵'' button to start the server with the mod. The server will start and Visual Studio will flash back on screen once Eco tries to initialize the mod's plugin.[[File:VS2022 -- Launch Debugger.png|alt=Highlighted is the play button for VS2022's debugger. The "Profile 1" is still selected from before.|frameless|link=|upright=2|location=center|border]]
# When Visual Studio hits the breakpoint it will keep startup from continuing and allow detailed inspection to happen. In the bottom left (circled in red) is a table of all of the variables within scope. Use this to see what is happening (especially useful in loops!). At the middle-top (circled in red) are some of the debugger controls. Clicking the highlighted ''Continue'' button resumes normal operation. Using the buttons to the right that are highlighted will allow the developer to step through the codes execution to see exactly how each line is performing. Debugging is a deep and rich topic that this guide will not explain further, but there's a great video by Microsoft Visual Studio on YouTube called Basics of Debugging. In that 45 minute video (don't worry there's annotations to jump to just what is interesting) a whole gamut of information about how to use debugging is covered. [[File:VS2022 -- Debugger LIve.png|alt=Shows a simple plugin's code in the editor of VS2022. In the bottom-left is a table of all variables used in the function. It is circled in red. On the top of the image also circled in red is the debugger controls. Highlighted within is the continue button and the "step over" button.|frameless|link=|upright=2|location=center|border]]
# Hit the green''⏵'' ''Continue'' button.
# Let the server finish loading.
# Open Eco to play.
# Connect to the LAN world by named something like ''Eco World''.
# Type <code>/wikiDemo</code> in chat.
# See that the mod replies with ''Hello, World.''
# Change line 29 in <code>Class1.cs</code> to <code>chat.MsgLoc($"Hello, Modder!");</code>
# Hit the hot reload button. It's just to the right of the green ''⏵'' ''Continue'' button and vaguely looks like the 🔥 icon.
# Type <code>/wikiDemo</code> in chat.
# See that the mod now replies with ''Hello, Modder!''

== Releasing a Mod ==

=== Mod.io ===
<code>mod.io</code> is where creators share their mods with players and others.

To share a new mod here all that is necessary is an account.

Head over to <code>mod.io/g/eco</code> and click ''Login'' in the top-right corner.

Finish signing-up with whatever account type you prefer.

Click the ''Add Mod'' button in the top-right.

Follow the upload wizard as directed.

Once on the ''File Manager'' section, a zip file is needed.

Zip the mod's <u>release</u> dll and any other assets necessary (e.g. Unity bundles) by putting all the files into a folder. Then right-click on that folder and select ''Compress To...'' and from the sub-menu select ''ZIP file''.

Upload that zip file. Considering naming it with a version number to help stay organized (e.g. ''v1''). Next release, increase that number by 1 (e.g. ''v2'')

Congratulations on releasing the mod!

=== Sharing on Discord ===
Consider posting an ad on the official {{EcoDiscord}}. There's a channel for mods called ''mod-ads''.
Please read the rules before posting.

== Helpful Resources ==

* Consider learning source control (Git). Completely optional, but can help you keep things organized as development continues.
* Explore Eco’s open-source mod projects for ideas (search on Github "Eco Mods" to find some real-life examples)
** {{EcoDiscord}}has a channel for mod developers to help one another called ''mod-dev.'' '''Note:''' Make under the ''Channel & Roles'' settings you have the 🛠''Yes, I want to see the channels about modding'' role selected.

Getting Started with Eco Modding in Visual Studio

2026-04-29T13:21:33Z

WugWugg: Building for development is updated.

= Introduction =
This guide focuses on setting up a C# modding environment in Visual Studio.

It does '''not''' cover adding Unity assets (models, prefabs, UI) to the game. See: [[From 3D Asset to Working Worktable]] for that workflow.

This guide won’t teach you how to code or write a mod, but it will help you get everything set up so you’re ready to start learning. Helpful resources are listed at the bottom of this guide, including [[Helpful Examples for Modding]] for practical code examples.

Visual Studio 2026 has a completely free to use version called the '''Community Edition'''. This guide is written assuming that's the version used.

=== Have Ready ===
* A copy of the Eco game installed
* A file explorer and the file-path to <code>Eco</code> folder<br>'''Tip:''' Within this folder there's folders like <code>D3D12</code> and <code>Eco_Data</code>. Also, you'll find the <code>Eco.exe</code> file here. There are other files and folder here too, but this list is just to help you know what the folder looks like.
* '''Tip:''' Steam users can find the install folder by right-clicking on the game in your Steam Library:<br>[[File:Steam Library -- Browse Local Files.png|alt=Shows a Steam Library with a menu open over the Eco game. Highlighted in that menu is a "Manage" option, opening a sub-menu. The sub-menu has "Browse local files" highlighted.|frameless|border|upright=3|location=center|link=]]

= Installing Visual Studio =
# Go to <code><nowiki>https://visualstudio.microsoft.com/downloads/#visual-studio-community-2026</nowiki></code> and look for the "'''Visual Studio Community 2026'''" download.
# Start the download by clicking on the ''Download'' button.
# Run the installer until it reaches to the Workloads page.
# Select these workloads...
## .NET desktop development -- '''Required''' for any mod development
## ASP.NET and web development -- Optional. If you want to interact with external websites or Eco's own web server (e.g. Discord's webhooks or extending the API)
# With those workloads selected the page should look something like this:<br>[[File:VisualStudioCommunity2022 Workloads.png|alt=Workloads screen during VS2022 installation. Options selected are "ASP.NET and web development" and ".NET desktop development". |frameless|location=center|upright=4|link=|border]]
# Click the Install button. It will take a few minutes to complete installation.
# Open Visual Studio after it installs.
# You may be prompted to sign in:
## Click ''Skip and add accounts later'' to continue.
## If you plan to use Github, sign in to make version control easier.
# Finally, it might ask what color theme you'd like. Select your preference and continue.
# Visual Studio is now installed and ready to be used.

= Setting Up a New Mod =
Once Eco and Visual Studio are installed all of the tools needed to code, build, and run a mod are ready.

== Creating a New Project ==
# Open Visual Studio. When it first opens it will show you a dashboard where you can quickly select what you want to do.
# On the right, under ''Get Started'' find the ''Create a new project'' button:<br>[[File:VS2022 OpeningDashboard.png|alt=VS2022's launch dashboard showing recent projects on the left and quick action buttons on the right. Highlighted is a button titled "Create a new project".|frameless|border|link=|location=center|upright=4]]
# A new window will pop-up.
# Select C# ''Class Library.'' To find the template, search <code>C# library</code> in the search bar. Select the C# option titled ''Class Library''.<br>'''Note:''' <u>Make sure you select the <code>C#</code> option as there are other options similarly named ''Class Library''.</u><br>[[File:VS2022 NewProjectWizard Templates.png|frameless|border|location=center|upright=4|link=]]
# Click the ''Next'' button.
# For ''Project Name'' type the name of the mod being created.
# The other options like the ''Location'' and the ''Solution Name'' do not need edited.
# Leave the box ''Place solution and project in the same directory'' unchecked.
# Click the Next button.
# In the ''Framework'' drop-down select the same version of .NET Eco uses (as described below). '''Tip:''' Eco currently targets ''.NET 10.0''

== .NET Version ==
To confirm the version of .NET that Eco uses:

# Go to the NuGet Gallery <code>www.nuget.org/packages?q=Eco.ReferenceAssemblies</code>
# Find the package with the name ''Eco.ReferenceAssemblies'' made by ''StrangeLoopGames''.
# Notice the chip underneath of it with the ''.NET'' version it targets.<br>[[File:NuGetGallery -- Eco.ReferenceAssemblies Search.png|alt=Shows the search result of Eco.ReferenceAssemblies. In a blue chip the text ".NET 8.0" can be seen.|frameless|upright=4|location=center|link=|border]]
# Click on that search result (shown above).
# A more detailed page is shown. Again, there's chips showing what version of .NET to use:<br>[[File:NuGetGallery--Eco.ReferenceAssemblies Details.png|alt=Show the package page for "Eco.ReferenceAssemblies" on NuGet Gallery. Circled in red are two chips with some version of the text ".NET 8.0" inside them.|frameless|link=|border|location=center|upright=3]]

== Linking to Eco Assemblies ==
# Find the ''Solution Explorer'' on the right side of Visual Studio. It should look something like this:<br>'''Note''': If the solution explorer isn't there, open the ''View'' menu (top toolbar) and select ''Solution Explorer''.<br>[[File:VS2022 -- Solution Explorer.png|alt=A picture of a basic layout in Visual Studio 2022 with the Solution Explorer open on the right-hand side. The solution explorer is circled in red.|frameless|link=|upright=4|location=center|border]]
# In the ''Solution Explorer'', find and right-click on the ''Dependencies'' item.
# Select ''Manage NuGet Packages...''<br>[[File:VS2022 Solution Explorer -- Manage NuGet Packages.png|alt=Shows VS2022's Solution Explorer with project expanded. The References line is highlighted and a menu is open. On that menu the "Manage NuGet Packages" line is highlighted.|frameless|link=|upright=4|location=center|border]]
# A ''NuGet'' tab will have opened in the editor window...
## Right above the search bar on this tab there's sub-tabs.
## Select the ''Browse'' sub-tab.
## Type <code>Eco.ReferenceAssemblies</code> into the search bar.
## Check the ''Include prerelease'' check-box.
## Find the option with the name ''Eco.ReferenceAssemblies'' made by ''StrangeLoopGames''.
## Click on that.
## A details panel will show up to the right. It will show the version of the reference assemblies being targeted. By default it chooses the latest and can be left at its default.
## Click the Install button.
## Click the ''Apply'' button on the popup to finish adding the references.<br>[[File:VS2022 -- NuGet Install Eco.ReferenceAssemblies.png|alt=VS2022 is open to the NuGet tab and is searching with the text Eco.ReferenceAssemblies. The checkbox to the right of the search is checked -- include prerelease. The only search result is selected. There is yellow highlights over part of the photo.|frameless|link=|upright=4|location=center|border]]
# Now reference assemblies have now been added. That means when coding Visual Studio will provide IntelliSense popups.
# Try it out by going back to the <code>Class1.cs</code> file and typing <code>Eco.</code> and you will see suggestion pop up.

= Dynamic Link Library (DLL) =
Building the mod creates the <code>.dll</code> file that can be dropped into the <code>Mods/UserCode</code> folder of any server an ran.

== Building for Development ==

# Open Visual Studio.
# Open the ''Build'' menu from the top toolbar.
# Select ''Build Solution''. This will produce non-optimized DLL used for testing and development.<br>[[File:VS2022 -- Build Menu.png|alt=VS2022 top menu "Build" is open with "build solution" highlighted (ctrl + shift + b).|frameless|link=|upright=4|location=center|border]]
# To find the file Visual Studio just built, right click on the project in the Solution Explorer.
# Select ''Open Folder in File Explorer.''<br>[[File:VS2022 -- Project Menu.png|alt=VS2022's solution explorer is shown with the projects right-click menu open. Highlighted is "Open folder in File Explorer"|frameless|link=|upright=4|location=center|border]]
# From here, the mod's DLL will be in the <code>bin/Debug/net10.0/</code> folder. The file will be named with mod's name, like <code>TheMod.dll</code>.
# Copy the mod's DLL file.
# Paste it into the folder <code>Eco/Eco_Data/Server/Mods/UserCode</code>.

=== Checkpoint ===

# Start a Eco and create a local world to see if the mod is being loaded.
# Check the logs at <code>Eco/Eco_Data/Server/Logs/</code> to verify...
## Open the <u>most recent</u> log file here.
## If the mod was loaded it there will be a line mentioning the file-name of the DLL. If the DLL was named <code>TheMod.dll</code>, line 5 is what to look for in the log file:<br><syntaxhighlight lang="text" line="1">[13:55:54.815] [4] [ Info] [Eco] Starting ModKitPlugin ...
[13:56:27.399] [4] [ Info] [Eco] Starting ModKitPlugin ... Finished in 32.584 sec

[13:56:27.439] [4] [ Info] [Eco] Loading mods ...
[13:56:27.439] [9] [ Info] [Eco] Loading TheMod...</syntaxhighlight>

'''Pro-Tip:''' Setup File Explorer to Sort By Date

# Setup the file view to ''Details'' in this folder because it will show the ''Date Modified'' for each file.<br>[[File:File Explorer -- View Settings Menu.png|alt=Show Window's File Explorer's view setting menu with the "details" option highlighted.|frameless|link=|upright=2|location=center|border]]
# Click on the ''Date Modified'' header to sort all files. This will sort it so the most recent is on top. Now, every time the server starts the log file is easily found -- it's the one on top!<br>[[File:File Explorer -- Details Example.png|alt=Show's window's File Explorer with the date modified header highlighted.|frameless|link=|upright=2|location=center|border]]

== Building for Release ==
To build for release, click on the mod's project in the Solution Explorer to highlight it.

[[File:VS2022 -- Solution Explorer Project Highlight.png|alt=Shows VS2022's solution explorer with the project highlighted.|frameless|link=|upright=2|location=center|border]]

Then, open the ''Build'' menu from the top of VS2022 and select ''Publish Selection''.

Set the target ''as Folder''. Click the ''Next'' button.

[[File:VS2022 -- Publish Wizard.png|alt=VS2022's publish wizard showing the target selection screen. The Folder option is highlighted.|frameless|link=|upright=2|location=center|border]]

Leave the folder location as default. Click the ''Finish'' button.

Click the ''Close'' button.

Finally, click the ''Publish'' button to start the build.

A green alert will pop up when the build is completed:

[[File:VS2022 -- Publish Screen.png|alt=Show's VS2022 publish screen. There's publish button at the top of this screen.|frameless|link=|upright=2|location=center|border]]

Either use the blue links on this page to find the file or browse the project's files as shown in "Building for Development".

Inside the project, the file will be in <code>bin/Release/net8.0/publish</code>. The file will be named with the mod project's name. For example, <code>TheMod.dll</code>.

Since the reference assemblies are already included in the game, do not worry about the other files here.

To share this mod, the only file needed is the mod's dll -- <code>TheMod.dll</code>.

=== Post-Build Scripts: Automatic Copy ===
With a post-build script VS2022 will automatically copy the files each build. It's a very nice feature to have when developing and rebuilding every 5 minutes to test something new.

First, add the variables about where <code>EcoServer.exe</code> is located to the project file.

Right-click on the project in the Solution Explorer and select the ''Edit Project File'' option.

Add the properties <code>EcoServerExe</code> and <code>EcoServerDir</code> <u>inside of the <code>PropertyGroup</code> tag.</u>

>>> Tip: By holding shift and right-clicking on a file in the file explorer an old-school menu pops up. Midway down this menu is an option to ''Copy As Path''. Neat!

The project file should look something like this:
<syntaxhighlight lang="xml"><Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<TargetFramework>net8.0</TargetFramework>
<ImplicitUsings>enable</ImplicitUsings>
<Nullable>enable</Nullable>

<EcoServerExe>$(EcoServerDir)\EcoServer.exe</EcoServerExe>
<EcoServerDir>C:\Program Files (x86)\Steam\steamapps\common\Eco\Eco_Data\Server</EcoServerDir>

</PropertyGroup>

<ItemGroup>
<PackageReference Include="Eco.ReferenceAssemblies" Version="0.11.1.13-beta-release-887" />
</ItemGroup>

</Project></syntaxhighlight>

Next, add the <code>PostBuild</code> property inside the <code>Project</code> tag.<syntaxhighlight lang="xml">
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
... SNIP ...
</PropertyGroup>

<ItemGroup>
... SNIP ...
</ItemGroup>

<Target Name="PostBuild" AfterTargets="PostBuildEvent">
<Exec Command='call PostBuild.bat "$(EcoServerDir)" "$(OutDir)" "$(MSBuildProjectName)"'/>
</Target>
</Project>
</syntaxhighlight>

Finally create a new file directly inside the project by right-clicking on the project in the Solution Explorer. Select the ''Add'' and click on ''New Item...'' from the sub-menu.

Use the name <code>PostBuild.bat</code> for this new file.

Open it and put the following in the PostBuild file:
<syntaxhighlight lang="batch">REM reading in arguements to sensible variables
set serverDir=%1
set outDir=%2
set projName=%3

REM removing double-quotes added to variables for concatenation
set serverDir=%serverDir:"=%
set outDir=%outDir:"=%
set projName=%projName:"=%

REM Copy mod dll to Mods dir
set dllFile=%outDir%%projName%.dll
echo Copying mod dll file: %dllFile%
copy "%dllFile%" "%serverDir%\Mods"

REM Copy mod pdb to directory where EcoServer.exe is
set pdbFile=%outDir%%projName%.pdb
echo Copying mod pdb file: %pdbFile%
copy "%pdbFile%" "%serverDir%"</syntaxhighlight>Now try running a rebuild of the project. The output should report copying files and inside the <code>Eco/Eco_Data/Server/Mods</code> folder should be <code>TheMod.dll</code> file

=== Setting up Debugging ===
'''Special thanks to Monzun#0606 on Eco's Discord for helping research the following information.'''
To setup debugging, <u>make sure that the project is setup with the post-build script described above</u>.

Debugging is a <u>powerful</u> tool to a developer and allows the developer to set breakpoints anywhere in the code to stop execution. When execution is stopped the developer can review every variable's value and incrementally continue the code. This is invaluable when tracking down bugs or trying to understand a complex piece of code.

From the top menu, select ''Debug'' and click on the option ''TheMod Debug Properties'' at the bottom of the menu.

[[File:VS2022 -- Debug Menu.png|alt=VS2022's debug menu is open from the top of the application. Highlighted is the last option "Debug Properties".|frameless|link=|upright=2|location=center|border]]

Find the ''Create a new profile'' button '''in the top-left''' of this new window. Select ''Executable'' from the drop-down menu.

[[File:VS2022 -- Debugger Launch Profiles.png|alt=VS2022's launch profile window is open. Underlined and pointed to by a red mark is the "Create a new profile" button, located in the top-left of the window. Highlighted from the menu under it is the option reading "Executable".|frameless|link=|upright=2|location=center|border]]

Set the ''Executable'' field to the full path to the <code>EcoServer.exe</code> file. For example, <code>C:\Program Files (x86)\Steam\steamapps\common\Eco\Eco_Data\Server</code><code>\EcoServer.exe</code>.

Set the ''Working Directory'' field to the full path to the folder containing the <code>EcoServer.exe</code> file. For example, <code>C:\Program Files (x86)\Steam\steamapps\common\Eco\Eco_Data\Server</code>.

[[File:VS2022 -- Eco Debugging Profile.png|alt=A fully configured profile ready to debug Eco on VS2022's launch profile page.|frameless|link=|upright=2|location=center|border]]

To use this newly configured profile, switch to it by clicking the small arrow to the right of the play icon (see image). Select the newly created profile -- ''Profile 1''.

[[File:VS2022 -- Debugger Profile Selection.png|alt=VS2022's debugger profile selection menu is open with the newly created "Profile 1" highlighted.|frameless|link=|upright=2|location=center|border]]

To see how breakpoints work, put the following in <code>Class1.cs</code> file:<syntaxhighlight lang="c#">
using Eco.Core.Plugins.Interfaces;
using Eco.Core.Utils;
using Eco.ModKit;

namespace Test
{
public class Class1 : IModKitPlugin, IInitializablePlugin
{
public string GetCategory() => "Tutorial";

public string GetStatus() => this._status;
string _status = string.Empty;

public void Initialize(TimedTask timer)
{
this._status = "Ok";
bool yes = true;
return;
}
}
}

</syntaxhighlight>This code creates a basic plugin, called <code>Class1</code>, that Eco will load and initialize on startup. Eco knows to do this because this class inherits the <code>IModKitPlugin</code> interface (causes it to be loaded) and the <code>IInitializablePlugin</code> interface (causes it to be initialized).

Add a breakpoint to the code by right-clicking on the line <code>bool yes = true;</code>.

[[File:VS2022 -- Adding a breakpoint.png|alt=A boilerplate example of a mod is shown in the VS2022 text editor. A line has a menu open above it with the option "Breakpoint" expanded and the option "Insert Breakpoint" highlighted on the sub-menu.|frameless|link=|upright=2|location=center|border]]

Now hit the play button. The server will start and VS2022 will flash back on screen once Eco tries to initialize the mod's plugin.

[[File:VS2022 -- Launch Debugger.png|alt=Highlighted is the play button for VS2022's debugger. The "Profile 1" is still selected from before.|frameless|link=|upright=2|location=center|border]]

After a little bit the server will start-up and hit the breakpoint set. When it does VS2022 will keep startup from continuing and allow detailed inspection to happen.

In the bottom left (circled in red) is a table of all of the variables within scope. Use this to see what is happening (especially useful in loops!).

At the middle-top (circled in red) are some of the debugger controls. Clicking the highlighted ''Continue'' button resumes normal operation. Using the buttons to the right that are highlighted will allow the developer to step through the codes execution to see exactly how each line is performing. Debugging is a deep and rich topic that this guide will not explain further, but there's a great video by Microsoft Visual Studio on YouTube called Basics of Debugging. In that 45 minute video (don't worry there's annotations to jump to just what is interesting) a whole gamut of information about how to use debugging is covered.

[[File:VS2022 -- Debugger LIve.png|alt=Shows a simple plugin's code in the editor of VS2022. In the bottom-left is a table of all variables used in the function. It is circled in red. On the top of the image also circled in red is the debugger controls. Highlighted within is the continue button and the "step over" button.|frameless|link=|upright=2|location=center|border]]

== Releasing a Mod ==

=== Mod.io ===
<code>mod.io</code> is where creators share their mods with players and others.

To share a new mod here all that is necessary is an account.

Head over to <code>mod.io/g/eco</code> and click ''Login'' in the top-right corner.

Finish signing-up with whatever account type you prefer.

Click the ''Add Mod'' button in the top-right.

Follow the upload wizard as directed.

Once on the ''File Manager'' section, a zip file is needed.

Zip the mod's <u>release</u> dll and any other assets necessary (e.g. Unity bundles) by putting all the files into a folder. Then right-click on that folder and select ''Compress To...'' and from the sub-menu select ''ZIP file''.

Upload that zip file. Considering naming it with a version number to help stay organized (e.g. ''v1''). Next release, increase that number by 1 (e.g. ''v2'')

Congratulations on releasing the mod!

=== Sharing on Discord ===
Consider posting an ad on the official {{EcoDiscord}}. There's a channel for mods called ''mod-ads''.
Please read the rules before posting.

== Helpful Resources ==

* Consider learning source control (Git). Completely optional, but can help you keep things organized as development continues.
* Explore Eco’s open-source mod projects for ideas (search on Github "Eco Mods" to find some real-life examples)
** {{EcoDiscord}}has a channel for mod developers to help one another called ''mod-dev.'' '''Note:''' Make under the ''Channel & Roles'' settings you have the 🛠''Yes, I want to see the channels about modding'' role selected.

Getting Started with Eco Modding in Visual Studio

2026-04-29T13:08:37Z

WugWugg:

= Introduction =
This guide focuses on setting up a C# modding environment in Visual Studio.

It does '''not''' cover adding Unity assets (models, prefabs, UI) to the game. See: [[From 3D Asset to Working Worktable]] for that workflow.

This guide won’t teach you how to code or write a mod, but it will help you get everything set up so you’re ready to start learning. Helpful resources are listed at the bottom of this guide, including [[Helpful Examples for Modding]] for practical code examples.

Visual Studio 2026 has a completely free to use version called the '''Community Edition'''. This guide is written assuming that's the version used.

=== Have Ready ===
* A copy of the Eco game installed
* A file explorer and the file-path to <code>Eco</code> folder<br>'''Tip:''' Within this folder there's folders like <code>D3D12</code> and <code>Eco_Data</code>. Also, you'll find the <code>Eco.exe</code> file here. There are other files and folder here too, but this list is just to help you know what the folder looks like.
* '''Tip:''' Steam users can find the install folder by right-clicking on the game in your Steam Library:<br>[[File:Steam Library -- Browse Local Files.png|alt=Shows a Steam Library with a menu open over the Eco game. Highlighted in that menu is a "Manage" option, opening a sub-menu. The sub-menu has "Browse local files" highlighted.|frameless|border|upright=3|location=center|link=]]

= Installing Visual Studio =
# Go to <code><nowiki>https://visualstudio.microsoft.com/downloads/#visual-studio-community-2026</nowiki></code> and look for the "'''Visual Studio Community 2026'''" download.
# Start the download by clicking on the ''Download'' button.
# Run the installer until it reaches to the Workloads page.
# Select these workloads...
## .NET desktop development -- '''Required''' for any mod development
## ASP.NET and web development -- Optional. If you want to interact with external websites or Eco's own web server (e.g. Discord's webhooks or extending the API)
# With those workloads selected the page should look something like this:<br>[[File:VisualStudioCommunity2022 Workloads.png|alt=Workloads screen during VS2022 installation. Options selected are "ASP.NET and web development" and ".NET desktop development". |frameless|location=center|upright=4|link=|border]]
# Click the Install button. It will take a few minutes to complete installation.
# Open Visual Studio after it installs.
# You may be prompted to sign in:
## Click ''Skip and add accounts later'' to continue.
## If you plan to use Github, sign in to make version control easier.
# Finally, it might ask what color theme you'd like. Select your preference and continue.
# Visual Studio is now installed and ready to be used.

= The Mod =
Once Eco and Visual Studio are installed all of the tools needed to code, build, and run a mod are ready.

=== Creating a New Project ===

# Open Visual Studio. When it first opens it will show you a dashboard where you can quickly select what you want to do.
# On the right, under ''Get Started'' find the ''Create a new project'' button:<br>[[File:VS2022 OpeningDashboard.png|alt=VS2022's launch dashboard showing recent projects on the left and quick action buttons on the right. Highlighted is a button titled "Create a new project".|frameless|border|link=|location=center|upright=4]]
# A new window will pop-up.
# Select C# ''Class Library.'' To find the template, search <code>C# library</code> in the search bar. Select the C# option titled ''Class Library''.<br>'''Note:''' <u>Make sure you select the <code>C#</code> option as there are other options similarly named ''Class Library''.</u><br>[[File:VS2022 NewProjectWizard Templates.png|frameless|border|location=center|upright=4|link=]]
# Click the ''Next'' button.
# For ''Project Name'' type the name of the mod being created.
# The other options like the ''Location'' and the ''Solution Name'' do not need edited.
# Leave the box ''Place solution and project in the same directory'' unchecked.
# Click the Next button.
# In the ''Framework'' drop-down select the same version of .NET Eco uses (as described below). '''Tip:''' Eco currently targets ''.NET 10.0''

=== .NET Version ===
To confirm the version of .NET that Eco uses:

# Go to the NuGet Gallery <code>www.nuget.org/packages?q=Eco.ReferenceAssemblies</code>
# Find the package with the name ''Eco.ReferenceAssemblies'' made by ''StrangeLoopGames''.
# Notice the chip underneath of it with the ''.NET'' version it targets.<br>[[File:NuGetGallery -- Eco.ReferenceAssemblies Search.png|alt=Shows the search result of Eco.ReferenceAssemblies. In a blue chip the text ".NET 8.0" can be seen.|frameless|upright=4|location=center|link=|border]]
# Click on that search result (shown above).
# A more detailed page is shown. Again, there's chips showing what version of .NET to use:<br>[[File:NuGetGallery--Eco.ReferenceAssemblies Details.png|alt=Show the package page for "Eco.ReferenceAssemblies" on NuGet Gallery. Circled in red are two chips with some version of the text ".NET 8.0" inside them.|frameless|link=|border|location=center|upright=3]]
=== Linking to Eco Assemblies ===

# Find the ''Solution Explorer'' on the right side of Visual Studio. It should look something like this:<br>'''Note''': If the solution explorer isn't there, open the ''View'' menu (top toolbar) and select ''Solution Explorer''.<br>[[File:VS2022 -- Solution Explorer.png|alt=A picture of a basic layout in Visual Studio 2022 with the Solution Explorer open on the right-hand side. The solution explorer is circled in red.|frameless|link=|upright=4|location=center|border]]
# In the ''Solution Explorer'', find and right-click on the ''Dependencies'' item.
# Select ''Manage NuGet Packages...''<br>[[File:VS2022 Solution Explorer -- Manage NuGet Packages.png|alt=Shows VS2022's Solution Explorer with project expanded. The References line is highlighted and a menu is open. On that menu the "Manage NuGet Packages" line is highlighted.|frameless|link=|upright=4|location=center|border]]
# A ''NuGet'' tab will have opened in the editor window...
## Right above the search bar on this tab there's sub-tabs.
## Select the ''Browse'' sub-tab.
## Type <code>Eco.ReferenceAssemblies</code> into the search bar.
## Check the ''Include prerelease'' check-box.
## Find the option with the name ''Eco.ReferenceAssemblies'' made by ''StrangeLoopGames''.
## Click on that.
## A details panel will show up to the right. It will show the version of the reference assemblies being targeted. By default it chooses the latest and can be left at its default.
## Click the Install button.
## Click the ''Apply'' button on the popup to finish adding the references.<br>[[File:VS2022 -- NuGet Install Eco.ReferenceAssemblies.png|alt=VS2022 is open to the NuGet tab and is searching with the text Eco.ReferenceAssemblies. The checkbox to the right of the search is checked -- include prerelease. The only search result is selected. There is yellow highlights over part of the photo.|frameless|link=|upright=4|location=center|border]]
# Now reference assemblies have now been added. That means when coding Visual Studio will provide IntelliSense popups.
# Try it out by going back to the <code>Class1.cs</code> file and typing <code>Eco.</code> and you will see suggestion pop up.
=== Building The Dynamic Link Library (DLL) ===

==== Building for Development ====
Building the mod creates the <code>.dll</code> file that can be used to test with.

To build, open the ''Build'' menu from the top of VS2022.

Select ''Build Solution''. This will produce non-optimized DLL used for testing and development.

[[File:VS2022 -- Build Menu.png|alt=VS2022 top menu "Build" is open with "build solution" highlighted (ctrl + shift + b).|frameless|link=|upright=4|location=center|border]]

To find the file VS2022 just built, right click on the project in the Solution Explorer.

Select ''Open Folder in File Explorer.''

[[File:VS2022 -- Project Menu.png|alt=VS2022's solution explorer is shown with the projects right-click menu open. Highlighted is "Open folder in File Explorer"|frameless|link=|upright=4|location=center|border]]

From here, the mod's DLL will be in the <code>bin/Debug/net8.0/</code> folder. The file will be named with mod's name, like <code>TheMod.dll</code>.

Copy the mod's DLL file.

Paste it into the folder <code>Eco/Eco_Data/Server/Mods/</code>.

To run a game with that mod '''create a local world'''.

The mod should be running. Check the logs at <code>Eco/Eco_Data/Server/Logs/</code> to verify. Open the <u>most recent</u> log file here.

If the mod was loaded it there will be a line mentioning the file-name of the DLL. If the DLL was named <code>TheMod.dll</code> this is what to look for in the log file:<syntaxhighlight lang="text">[13:55:54.815] [4] [ Info] [Eco] Starting ModKitPlugin ...
[13:56:27.399] [4] [ Info] [Eco] Starting ModKitPlugin ... Finished in 32.584 sec

[13:56:27.439] [4] [ Info] [Eco] Loading mods ...
[13:56:27.439] [9] [ Info] [Eco] Loading TheMod...</syntaxhighlight>

===== Tip: Setup File Explorer to Sort By Date =====
It's suggested to setup the file view to ''Details'' in this folder because it will show the ''Date Modified'' for each file.

[[File:File Explorer -- View Settings Menu.png|alt=Show Window's File Explorer's view setting menu with the "details" option highlighted.|frameless|link=|upright=2|location=center|border]]

Additionally, clicking on the ''Date Modified'' header sorts all files. Sort it so the most recent is on top and every time the server starts the log file is easily found -- it's the one on top!

[[File:File Explorer -- Details Example.png|alt=Show's window's File Explorer with the date modified header highlighted.|frameless|link=|upright=2|location=center|border]]

==== Building for Release ====
To build for release, click on the mod's project in the Solution Explorer to highlight it.

[[File:VS2022 -- Solution Explorer Project Highlight.png|alt=Shows VS2022's solution explorer with the project highlighted.|frameless|link=|upright=2|location=center|border]]

Then, open the ''Build'' menu from the top of VS2022 and select ''Publish Selection''.

Set the target ''as Folder''. Click the ''Next'' button.

[[File:VS2022 -- Publish Wizard.png|alt=VS2022's publish wizard showing the target selection screen. The Folder option is highlighted.|frameless|link=|upright=2|location=center|border]]

Leave the folder location as default. Click the ''Finish'' button.

Click the ''Close'' button.

Finally, click the ''Publish'' button to start the build.

A green alert will pop up when the build is completed:

[[File:VS2022 -- Publish Screen.png|alt=Show's VS2022 publish screen. There's publish button at the top of this screen.|frameless|link=|upright=2|location=center|border]]

Either use the blue links on this page to find the file or browse the project's files as shown in "Building for Development".

Inside the project, the file will be in <code>bin/Release/net8.0/publish</code>. The file will be named with the mod project's name. For example, <code>TheMod.dll</code>.

Since the reference assemblies are already included in the game, do not worry about the other files here.

To share this mod, the only file needed is the mod's dll -- <code>TheMod.dll</code>.

=== Post-Build Scripts: Automatic Copy ===
With a post-build script VS2022 will automatically copy the files each build. It's a very nice feature to have when developing and rebuilding every 5 minutes to test something new.

First, add the variables about where <code>EcoServer.exe</code> is located to the project file.

Right-click on the project in the Solution Explorer and select the ''Edit Project File'' option.

Add the properties <code>EcoServerExe</code> and <code>EcoServerDir</code> <u>inside of the <code>PropertyGroup</code> tag.</u>

>>> Tip: By holding shift and right-clicking on a file in the file explorer an old-school menu pops up. Midway down this menu is an option to ''Copy As Path''. Neat!

The project file should look something like this:
<syntaxhighlight lang="xml"><Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<TargetFramework>net8.0</TargetFramework>
<ImplicitUsings>enable</ImplicitUsings>
<Nullable>enable</Nullable>

<EcoServerExe>$(EcoServerDir)\EcoServer.exe</EcoServerExe>
<EcoServerDir>C:\Program Files (x86)\Steam\steamapps\common\Eco\Eco_Data\Server</EcoServerDir>

</PropertyGroup>

<ItemGroup>
<PackageReference Include="Eco.ReferenceAssemblies" Version="0.11.1.13-beta-release-887" />
</ItemGroup>

</Project></syntaxhighlight>

Next, add the <code>PostBuild</code> property inside the <code>Project</code> tag.<syntaxhighlight lang="xml">
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
... SNIP ...
</PropertyGroup>

<ItemGroup>
... SNIP ...
</ItemGroup>

<Target Name="PostBuild" AfterTargets="PostBuildEvent">
<Exec Command='call PostBuild.bat "$(EcoServerDir)" "$(OutDir)" "$(MSBuildProjectName)"'/>
</Target>
</Project>
</syntaxhighlight>

Finally create a new file directly inside the project by right-clicking on the project in the Solution Explorer. Select the ''Add'' and click on ''New Item...'' from the sub-menu.

Use the name <code>PostBuild.bat</code> for this new file.

Open it and put the following in the PostBuild file:
<syntaxhighlight lang="batch">REM reading in arguements to sensible variables
set serverDir=%1
set outDir=%2
set projName=%3

REM removing double-quotes added to variables for concatenation
set serverDir=%serverDir:"=%
set outDir=%outDir:"=%
set projName=%projName:"=%

REM Copy mod dll to Mods dir
set dllFile=%outDir%%projName%.dll
echo Copying mod dll file: %dllFile%
copy "%dllFile%" "%serverDir%\Mods"

REM Copy mod pdb to directory where EcoServer.exe is
set pdbFile=%outDir%%projName%.pdb
echo Copying mod pdb file: %pdbFile%
copy "%pdbFile%" "%serverDir%"</syntaxhighlight>Now try running a rebuild of the project. The output should report copying files and inside the <code>Eco/Eco_Data/Server/Mods</code> folder should be <code>TheMod.dll</code> file

=== Setting up Debugging ===
'''Special thanks to Monzun#0606 on Eco's Discord for helping research the following information.'''
To setup debugging, <u>make sure that the project is setup with the post-build script described above</u>.

Debugging is a <u>powerful</u> tool to a developer and allows the developer to set breakpoints anywhere in the code to stop execution. When execution is stopped the developer can review every variable's value and incrementally continue the code. This is invaluable when tracking down bugs or trying to understand a complex piece of code.

From the top menu, select ''Debug'' and click on the option ''TheMod Debug Properties'' at the bottom of the menu.

[[File:VS2022 -- Debug Menu.png|alt=VS2022's debug menu is open from the top of the application. Highlighted is the last option "Debug Properties".|frameless|link=|upright=2|location=center|border]]

Find the ''Create a new profile'' button '''in the top-left''' of this new window. Select ''Executable'' from the drop-down menu.

[[File:VS2022 -- Debugger Launch Profiles.png|alt=VS2022's launch profile window is open. Underlined and pointed to by a red mark is the "Create a new profile" button, located in the top-left of the window. Highlighted from the menu under it is the option reading "Executable".|frameless|link=|upright=2|location=center|border]]

Set the ''Executable'' field to the full path to the <code>EcoServer.exe</code> file. For example, <code>C:\Program Files (x86)\Steam\steamapps\common\Eco\Eco_Data\Server</code><code>\EcoServer.exe</code>.

Set the ''Working Directory'' field to the full path to the folder containing the <code>EcoServer.exe</code> file. For example, <code>C:\Program Files (x86)\Steam\steamapps\common\Eco\Eco_Data\Server</code>.

[[File:VS2022 -- Eco Debugging Profile.png|alt=A fully configured profile ready to debug Eco on VS2022's launch profile page.|frameless|link=|upright=2|location=center|border]]

To use this newly configured profile, switch to it by clicking the small arrow to the right of the play icon (see image). Select the newly created profile -- ''Profile 1''.

[[File:VS2022 -- Debugger Profile Selection.png|alt=VS2022's debugger profile selection menu is open with the newly created "Profile 1" highlighted.|frameless|link=|upright=2|location=center|border]]

To see how breakpoints work, put the following in <code>Class1.cs</code> file:<syntaxhighlight lang="c#">
using Eco.Core.Plugins.Interfaces;
using Eco.Core.Utils;
using Eco.ModKit;

namespace Test
{
public class Class1 : IModKitPlugin, IInitializablePlugin
{
public string GetCategory() => "Tutorial";

public string GetStatus() => this._status;
string _status = string.Empty;

public void Initialize(TimedTask timer)
{
this._status = "Ok";
bool yes = true;
return;
}
}
}

</syntaxhighlight>This code creates a basic plugin, called <code>Class1</code>, that Eco will load and initialize on startup. Eco knows to do this because this class inherits the <code>IModKitPlugin</code> interface (causes it to be loaded) and the <code>IInitializablePlugin</code> interface (causes it to be initialized).

Add a breakpoint to the code by right-clicking on the line <code>bool yes = true;</code>.

[[File:VS2022 -- Adding a breakpoint.png|alt=A boilerplate example of a mod is shown in the VS2022 text editor. A line has a menu open above it with the option "Breakpoint" expanded and the option "Insert Breakpoint" highlighted on the sub-menu.|frameless|link=|upright=2|location=center|border]]

Now hit the play button. The server will start and VS2022 will flash back on screen once Eco tries to initialize the mod's plugin.

[[File:VS2022 -- Launch Debugger.png|alt=Highlighted is the play button for VS2022's debugger. The "Profile 1" is still selected from before.|frameless|link=|upright=2|location=center|border]]

After a little bit the server will start-up and hit the breakpoint set. When it does VS2022 will keep startup from continuing and allow detailed inspection to happen.

In the bottom left (circled in red) is a table of all of the variables within scope. Use this to see what is happening (especially useful in loops!).

At the middle-top (circled in red) are some of the debugger controls. Clicking the highlighted ''Continue'' button resumes normal operation. Using the buttons to the right that are highlighted will allow the developer to step through the codes execution to see exactly how each line is performing. Debugging is a deep and rich topic that this guide will not explain further, but there's a great video by Microsoft Visual Studio on YouTube called Basics of Debugging. In that 45 minute video (don't worry there's annotations to jump to just what is interesting) a whole gamut of information about how to use debugging is covered.

[[File:VS2022 -- Debugger LIve.png|alt=Shows a simple plugin's code in the editor of VS2022. In the bottom-left is a table of all variables used in the function. It is circled in red. On the top of the image also circled in red is the debugger controls. Highlighted within is the continue button and the "step over" button.|frameless|link=|upright=2|location=center|border]]

== Releasing a Mod ==

=== Mod.io ===
<code>mod.io</code> is where creators share their mods with players and others.

To share a new mod here all that is necessary is an account.

Head over to <code>mod.io/g/eco</code> and click ''Login'' in the top-right corner.

Finish signing-up with whatever account type you prefer.

Click the ''Add Mod'' button in the top-right.

Follow the upload wizard as directed.

Once on the ''File Manager'' section, a zip file is needed.

Zip the mod's <u>release</u> dll and any other assets necessary (e.g. Unity bundles) by putting all the files into a folder. Then right-click on that folder and select ''Compress To...'' and from the sub-menu select ''ZIP file''.

Upload that zip file. Considering naming it with a version number to help stay organized (e.g. ''v1''). Next release, increase that number by 1 (e.g. ''v2'')

Congratulations on releasing the mod!

=== Sharing on Discord ===
Consider posting an ad on the official {{EcoDiscord}}. There's a channel for mods called ''mod-ads''.
Please read the rules before posting.

== Helpful Resources ==

* Consider learning source control (Git). Completely optional, but can help you keep things organized as development continues.
* Explore Eco’s open-source mod projects for ideas (search on Github "Eco Mods" to find some real-life examples)
** {{EcoDiscord}}has a channel for mod developers to help one another called ''mod-dev.'' '''Note:''' Make under the ''Channel & Roles'' settings you have the 🛠''Yes, I want to see the channels about modding'' role selected.

Getting Started with Eco Modding in Visual Studio

2026-04-29T12:59:51Z

WugWugg:

== Introduction ==
This guide focuses on setting up a C# modding environment in Visual Studio.

It does '''not''' cover adding Unity assets (models, prefabs, UI) to the game. See: [[From 3D Asset to Working Worktable]] for that workflow.

This guide won’t teach you how to code or write a mod, but it will help you get everything set up so you’re ready to start learning. Helpful resources are listed at the bottom of this guide, including [[Helpful Examples for Modding]] for practical code examples.

Visual Studio 2026 has a completely free to use version called the '''Community Edition'''. This guide is written assuming that's the version used.

=== Have Ready ===
* A copy of the Eco game installed
* A file explorer and the file-path to <code>Eco</code> folder<br>'''Tip:''' Within this folder there's folders like <code>D3D12</code> and <code>Eco_Data</code>. Also, you'll find the <code>Eco.exe</code> file here. There are other files and folder here too, but this list is just to help you know what the folder looks like.

==== Tip: Find Folder with Steam ====
Steam users can find the install folder by right-clicking on the game in your Steam Library:

[[File:Steam Library -- Browse Local Files.png|alt=Shows a Steam Library with a menu open over the Eco game. Highlighted in that menu is a "Manage" option, opening a sub-menu. The sub-menu has "Browse local files" highlighted.|frameless|border|upright=3|location=center|link=]]

== Installing Visual Studio ==

# Go to <code><nowiki>https://visualstudio.microsoft.com/downloads/#visual-studio-community-2026</nowiki></code> and look for the "'''Visual Studio Community 2026'''" download.
# Start the download by clicking on the ''Download'' button.
# Run the installer until it reaches to the Workloads page.
# Select these workloads...
## .NET desktop development -- '''Required''' for any mod development
## ASP.NET and web development -- Optional. If you want to interact with external websites or Eco's own web server (e.g. Discord's webhooks or extending the API)
# With those workloads selected the page should look something like this:<br>[[File:VisualStudioCommunity2022 Workloads.png|alt=Workloads screen during VS2022 installation. Options selected are "ASP.NET and web development" and ".NET desktop development". |frameless|location=center|upright=4|link=|border]]
# Click the Install button. It will take a few minutes to complete installation.
# Open Visual Studio after it installs.
# You may be prompted to sign in:
## Click ''Skip and add accounts later'' to continue.
## If you plan to use Github, sign in to make version control easier.
# Finally, it might ask what color theme you'd like. Select your preference and continue.
# Visual Studio is now installed and ready to be used.

== The Mod ==

Once Eco and Visual Studio are installed all of the tools needed to code, build, and run a mod are ready.

=== Creating a New Project ===

# Open Visual Studio. When it first opens it will show you a dashboard where you can quickly select what you want to do.
# On the right, under ''Get Started'' find the ''Create a new project'' button:<br>[[File:VS2022 OpeningDashboard.png|alt=VS2022's launch dashboard showing recent projects on the left and quick action buttons on the right. Highlighted is a button titled "Create a new project".|frameless|border|link=|location=center|upright=4]]
# A new window will pop-up.
# Select C# ''Class Library.'' To find the template, search <code>C# library</code> in the search bar. Select the C# option titled ''Class Library''.<br>'''Note:''' <u>Make sure you select the <code>C#</code> option as there are other options similarly named ''Class Library''.</u><br>[[File:VS2022 NewProjectWizard Templates.png|frameless|border|location=center|upright=4|link=]]
# Click the ''Next'' button.
# For ''Project Name'' type the name of the mod being created.
# The other options like the ''Location'' and the ''Solution Name'' do not need edited.
# Leave the box ''Place solution and project in the same directory'' unchecked.
# Click the Next button.
# In the ''Framework'' drop-down select the same version of .NET Eco uses (as described below). '''Tip:''' Eco currently targets ''.NET 10.0''

=== .NET Version ===
To confirm the version of .NET that Eco uses:

# Go to the NuGet Gallery <code>www.nuget.org/packages?q=Eco.ReferenceAssemblies</code>
# Find the package with the name ''Eco.ReferenceAssemblies'' made by ''StrangeLoopGames''.
# Notice the chip underneath of it with the ''.NET'' version it targets.<br>[[File:NuGetGallery -- Eco.ReferenceAssemblies Search.png|alt=Shows the search result of Eco.ReferenceAssemblies. In a blue chip the text ".NET 8.0" can be seen.|frameless|upright=4|location=center|link=|border]]
# Click on that search result (shown above).
# A more detailed page is shown. Again, there's chips showing what version of .NET to use:<br>[[File:NuGetGallery--Eco.ReferenceAssemblies Details.png|alt=Show the package page for "Eco.ReferenceAssemblies" on NuGet Gallery. Circled in red are two chips with some version of the text ".NET 8.0" inside them.|frameless|link=|border|location=center|upright=3]]
=== Linking to Eco Assemblies ===

# Find the ''Solution Explorer'' on the right side of Visual Studio. It should look something like this:<br>'''Note''': If the solution explorer isn't there, open the ''View'' menu (top toolbar) and select ''Solution Explorer''.<br>[[File:VS2022 -- Solution Explorer.png|alt=A picture of a basic layout in Visual Studio 2022 with the Solution Explorer open on the right-hand side. The solution explorer is circled in red.|frameless|link=|upright=4|location=center|border]]
# In the ''Solution Explorer'', find and right-click on the ''Dependencies'' item.
# Select ''Manage NuGet Packages...''<br>[[File:VS2022 Solution Explorer -- Manage NuGet Packages.png|alt=Shows VS2022's Solution Explorer with project expanded. The References line is highlighted and a menu is open. On that menu the "Manage NuGet Packages" line is highlighted.|frameless|link=|upright=4|location=center|border]]
# A ''NuGet'' tab will have opened in the editor window...
## Right above the search bar on this tab there's sub-tabs.
## Select the ''Browse'' sub-tab.
## Type <code>Eco.ReferenceAssemblies</code> into the search bar.
## Check the ''Include prerelease'' check-box.
## Find the option with the name ''Eco.ReferenceAssemblies'' made by ''StrangeLoopGames''.
## Click on that.
## A details panel will show up to the right. It will show the version of the reference assemblies being targeted. By default it chooses the latest and can be left at its default.
## Click the Install button.
## Click the ''Apply'' button on the popup to finish adding the references.<br>[[File:VS2022 -- NuGet Install Eco.ReferenceAssemblies.png|alt=VS2022 is open to the NuGet tab and is searching with the text Eco.ReferenceAssemblies. The checkbox to the right of the search is checked -- include prerelease. The only search result is selected. There is yellow highlights over part of the photo.|frameless|link=|upright=4|location=center|border]]

The reference assemblies have now been added! When coding VS2022 will provide IntelliSense popups. Try it out by going back to the <code>Class1.cs</code> file and typing <code>Eco.</code> and you will see suggestion pop up. It’s an essential tool for a lot of modders.

[[File:VS2022 -- Intellisense.png|alt=Shows a text editor with a basic class file. Inside there's the text "Eco." and a menu that show the suggested namespaces within.|frameless|link=|upright=4|location=center|border]]

=== Building The Dynamic Link Library (DLL) ===

==== Building for Development ====
Building the mod creates the <code>.dll</code> file that can be used to test with.

To build, open the ''Build'' menu from the top of VS2022.

Select ''Build Solution''. This will produce non-optimized DLL used for testing and development.

[[File:VS2022 -- Build Menu.png|alt=VS2022 top menu "Build" is open with "build solution" highlighted (ctrl + shift + b).|frameless|link=|upright=4|location=center|border]]

To find the file VS2022 just built, right click on the project in the Solution Explorer.

Select ''Open Folder in File Explorer.''

[[File:VS2022 -- Project Menu.png|alt=VS2022's solution explorer is shown with the projects right-click menu open. Highlighted is "Open folder in File Explorer"|frameless|link=|upright=4|location=center|border]]

From here, the mod's DLL will be in the <code>bin/Debug/net8.0/</code> folder. The file will be named with mod's name, like <code>TheMod.dll</code>.

Copy the mod's DLL file.

Paste it into the folder <code>Eco/Eco_Data/Server/Mods/</code>.

To run a game with that mod '''create a local world'''.

The mod should be running. Check the logs at <code>Eco/Eco_Data/Server/Logs/</code> to verify. Open the <u>most recent</u> log file here.

If the mod was loaded it there will be a line mentioning the file-name of the DLL. If the DLL was named <code>TheMod.dll</code> this is what to look for in the log file:<syntaxhighlight lang="text">[13:55:54.815] [4] [ Info] [Eco] Starting ModKitPlugin ...
[13:56:27.399] [4] [ Info] [Eco] Starting ModKitPlugin ... Finished in 32.584 sec

[13:56:27.439] [4] [ Info] [Eco] Loading mods ...
[13:56:27.439] [9] [ Info] [Eco] Loading TheMod...</syntaxhighlight>

===== Tip: Setup File Explorer to Sort By Date =====
It's suggested to setup the file view to ''Details'' in this folder because it will show the ''Date Modified'' for each file.

[[File:File Explorer -- View Settings Menu.png|alt=Show Window's File Explorer's view setting menu with the "details" option highlighted.|frameless|link=|upright=2|location=center|border]]

Additionally, clicking on the ''Date Modified'' header sorts all files. Sort it so the most recent is on top and every time the server starts the log file is easily found -- it's the one on top!

[[File:File Explorer -- Details Example.png|alt=Show's window's File Explorer with the date modified header highlighted.|frameless|link=|upright=2|location=center|border]]

==== Building for Release ====
To build for release, click on the mod's project in the Solution Explorer to highlight it.

[[File:VS2022 -- Solution Explorer Project Highlight.png|alt=Shows VS2022's solution explorer with the project highlighted.|frameless|link=|upright=2|location=center|border]]

Then, open the ''Build'' menu from the top of VS2022 and select ''Publish Selection''.

Set the target ''as Folder''. Click the ''Next'' button.

[[File:VS2022 -- Publish Wizard.png|alt=VS2022's publish wizard showing the target selection screen. The Folder option is highlighted.|frameless|link=|upright=2|location=center|border]]

Leave the folder location as default. Click the ''Finish'' button.

Click the ''Close'' button.

Finally, click the ''Publish'' button to start the build.

A green alert will pop up when the build is completed:

[[File:VS2022 -- Publish Screen.png|alt=Show's VS2022 publish screen. There's publish button at the top of this screen.|frameless|link=|upright=2|location=center|border]]

Either use the blue links on this page to find the file or browse the project's files as shown in "Building for Development".

Inside the project, the file will be in <code>bin/Release/net8.0/publish</code>. The file will be named with the mod project's name. For example, <code>TheMod.dll</code>.

Since the reference assemblies are already included in the game, do not worry about the other files here.

To share this mod, the only file needed is the mod's dll -- <code>TheMod.dll</code>.

=== Post-Build Scripts: Automatic Copy ===
With a post-build script VS2022 will automatically copy the files each build. It's a very nice feature to have when developing and rebuilding every 5 minutes to test something new.

First, add the variables about where <code>EcoServer.exe</code> is located to the project file.

Right-click on the project in the Solution Explorer and select the ''Edit Project File'' option.

Add the properties <code>EcoServerExe</code> and <code>EcoServerDir</code> <u>inside of the <code>PropertyGroup</code> tag.</u>

>>> Tip: By holding shift and right-clicking on a file in the file explorer an old-school menu pops up. Midway down this menu is an option to ''Copy As Path''. Neat!

The project file should look something like this:
<syntaxhighlight lang="xml"><Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<TargetFramework>net8.0</TargetFramework>
<ImplicitUsings>enable</ImplicitUsings>
<Nullable>enable</Nullable>

<EcoServerExe>$(EcoServerDir)\EcoServer.exe</EcoServerExe>
<EcoServerDir>C:\Program Files (x86)\Steam\steamapps\common\Eco\Eco_Data\Server</EcoServerDir>

</PropertyGroup>

<ItemGroup>
<PackageReference Include="Eco.ReferenceAssemblies" Version="0.11.1.13-beta-release-887" />
</ItemGroup>

</Project></syntaxhighlight>

Next, add the <code>PostBuild</code> property inside the <code>Project</code> tag.<syntaxhighlight lang="xml">
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
... SNIP ...
</PropertyGroup>

<ItemGroup>
... SNIP ...
</ItemGroup>

<Target Name="PostBuild" AfterTargets="PostBuildEvent">
<Exec Command='call PostBuild.bat "$(EcoServerDir)" "$(OutDir)" "$(MSBuildProjectName)"'/>
</Target>
</Project>
</syntaxhighlight>

Finally create a new file directly inside the project by right-clicking on the project in the Solution Explorer. Select the ''Add'' and click on ''New Item...'' from the sub-menu.

Use the name <code>PostBuild.bat</code> for this new file.

Open it and put the following in the PostBuild file:
<syntaxhighlight lang="batch">REM reading in arguements to sensible variables
set serverDir=%1
set outDir=%2
set projName=%3

REM removing double-quotes added to variables for concatenation
set serverDir=%serverDir:"=%
set outDir=%outDir:"=%
set projName=%projName:"=%

REM Copy mod dll to Mods dir
set dllFile=%outDir%%projName%.dll
echo Copying mod dll file: %dllFile%
copy "%dllFile%" "%serverDir%\Mods"

REM Copy mod pdb to directory where EcoServer.exe is
set pdbFile=%outDir%%projName%.pdb
echo Copying mod pdb file: %pdbFile%
copy "%pdbFile%" "%serverDir%"</syntaxhighlight>Now try running a rebuild of the project. The output should report copying files and inside the <code>Eco/Eco_Data/Server/Mods</code> folder should be <code>TheMod.dll</code> file

=== Setting up Debugging ===
'''Special thanks to Monzun#0606 on Eco's Discord for helping research the following information.'''
To setup debugging, <u>make sure that the project is setup with the post-build script described above</u>.

Debugging is a <u>powerful</u> tool to a developer and allows the developer to set breakpoints anywhere in the code to stop execution. When execution is stopped the developer can review every variable's value and incrementally continue the code. This is invaluable when tracking down bugs or trying to understand a complex piece of code.

From the top menu, select ''Debug'' and click on the option ''TheMod Debug Properties'' at the bottom of the menu.

[[File:VS2022 -- Debug Menu.png|alt=VS2022's debug menu is open from the top of the application. Highlighted is the last option "Debug Properties".|frameless|link=|upright=2|location=center|border]]

Find the ''Create a new profile'' button '''in the top-left''' of this new window. Select ''Executable'' from the drop-down menu.

[[File:VS2022 -- Debugger Launch Profiles.png|alt=VS2022's launch profile window is open. Underlined and pointed to by a red mark is the "Create a new profile" button, located in the top-left of the window. Highlighted from the menu under it is the option reading "Executable".|frameless|link=|upright=2|location=center|border]]

Set the ''Executable'' field to the full path to the <code>EcoServer.exe</code> file. For example, <code>C:\Program Files (x86)\Steam\steamapps\common\Eco\Eco_Data\Server</code><code>\EcoServer.exe</code>.

Set the ''Working Directory'' field to the full path to the folder containing the <code>EcoServer.exe</code> file. For example, <code>C:\Program Files (x86)\Steam\steamapps\common\Eco\Eco_Data\Server</code>.

[[File:VS2022 -- Eco Debugging Profile.png|alt=A fully configured profile ready to debug Eco on VS2022's launch profile page.|frameless|link=|upright=2|location=center|border]]

To use this newly configured profile, switch to it by clicking the small arrow to the right of the play icon (see image). Select the newly created profile -- ''Profile 1''.

[[File:VS2022 -- Debugger Profile Selection.png|alt=VS2022's debugger profile selection menu is open with the newly created "Profile 1" highlighted.|frameless|link=|upright=2|location=center|border]]

To see how breakpoints work, put the following in <code>Class1.cs</code> file:<syntaxhighlight lang="c#">
using Eco.Core.Plugins.Interfaces;
using Eco.Core.Utils;
using Eco.ModKit;

namespace Test
{
public class Class1 : IModKitPlugin, IInitializablePlugin
{
public string GetCategory() => "Tutorial";

public string GetStatus() => this._status;
string _status = string.Empty;

public void Initialize(TimedTask timer)
{
this._status = "Ok";
bool yes = true;
return;
}
}
}

</syntaxhighlight>This code creates a basic plugin, called <code>Class1</code>, that Eco will load and initialize on startup. Eco knows to do this because this class inherits the <code>IModKitPlugin</code> interface (causes it to be loaded) and the <code>IInitializablePlugin</code> interface (causes it to be initialized).

Add a breakpoint to the code by right-clicking on the line <code>bool yes = true;</code>.

[[File:VS2022 -- Adding a breakpoint.png|alt=A boilerplate example of a mod is shown in the VS2022 text editor. A line has a menu open above it with the option "Breakpoint" expanded and the option "Insert Breakpoint" highlighted on the sub-menu.|frameless|link=|upright=2|location=center|border]]

Now hit the play button. The server will start and VS2022 will flash back on screen once Eco tries to initialize the mod's plugin.

[[File:VS2022 -- Launch Debugger.png|alt=Highlighted is the play button for VS2022's debugger. The "Profile 1" is still selected from before.|frameless|link=|upright=2|location=center|border]]

After a little bit the server will start-up and hit the breakpoint set. When it does VS2022 will keep startup from continuing and allow detailed inspection to happen.

In the bottom left (circled in red) is a table of all of the variables within scope. Use this to see what is happening (especially useful in loops!).

At the middle-top (circled in red) are some of the debugger controls. Clicking the highlighted ''Continue'' button resumes normal operation. Using the buttons to the right that are highlighted will allow the developer to step through the codes execution to see exactly how each line is performing. Debugging is a deep and rich topic that this guide will not explain further, but there's a great video by Microsoft Visual Studio on YouTube called Basics of Debugging. In that 45 minute video (don't worry there's annotations to jump to just what is interesting) a whole gamut of information about how to use debugging is covered.

[[File:VS2022 -- Debugger LIve.png|alt=Shows a simple plugin's code in the editor of VS2022. In the bottom-left is a table of all variables used in the function. It is circled in red. On the top of the image also circled in red is the debugger controls. Highlighted within is the continue button and the "step over" button.|frameless|link=|upright=2|location=center|border]]

== Releasing a Mod ==

=== Mod.io ===
<code>mod.io</code> is where creators share their mods with players and others.

To share a new mod here all that is necessary is an account.

Head over to <code>mod.io/g/eco</code> and click ''Login'' in the top-right corner.

Finish signing-up with whatever account type you prefer.

Click the ''Add Mod'' button in the top-right.

Follow the upload wizard as directed.

Once on the ''File Manager'' section, a zip file is needed.

Zip the mod's <u>release</u> dll and any other assets necessary (e.g. Unity bundles) by putting all the files into a folder. Then right-click on that folder and select ''Compress To...'' and from the sub-menu select ''ZIP file''.

Upload that zip file. Considering naming it with a version number to help stay organized (e.g. ''v1''). Next release, increase that number by 1 (e.g. ''v2'')

Congratulations on releasing the mod!

=== Sharing on Discord ===
Consider posting an ad on the official {{EcoDiscord}}. There's a channel for mods called ''mod-ads''.
Please read the rules before posting.

== Helpful Resources ==

* Consider learning source control (Git). Completely optional, but can help you keep things organized as development continues.
* Explore Eco’s open-source mod projects for ideas (search on Github "Eco Mods" to find some real-life examples)
** {{EcoDiscord}}has a channel for mod developers to help one another called ''mod-dev.'' '''Note:''' Make under the ''Channel & Roles'' settings you have the 🛠''Yes, I want to see the channels about modding'' role selected.

Getting Started with Eco Modding in Visual Studio

2026-04-29T12:44:27Z

WugWugg: Updated from intro to The Mod > .NET Version (text and images)

== Introduction ==
This guide focuses on setting up a C# modding environment in Visual Studio.

It does '''not''' cover adding Unity assets (models, prefabs, UI) to the game. See: [[From 3D Asset to Working Worktable]] for that workflow.

This guide won’t teach you how to code or write a mod, but it will help you get everything set up so you’re ready to start learning. Helpful resources are listed at the bottom of this guide, including [[Helpful Examples for Modding]] for practical code examples.

Visual Studio 2026 has a completely free to use version called the '''Community Edition'''. This guide is written assuming that's the version used.

=== Have Ready ===
* A copy of the Eco game installed
* A file explorer and the file-path to <code>Eco</code> folder<br>'''Tip:''' Within this folder there's folders like <code>D3D12</code> and <code>Eco_Data</code>. Also, you'll find the <code>Eco.exe</code> file here. There are other files and folder here too, but this list is just to help you know what the folder looks like.

==== Tip: Find Folder with Steam ====
Steam users can find the install folder by right-clicking on the game in your Steam Library:

[[File:Steam Library -- Browse Local Files.png|alt=Shows a Steam Library with a menu open over the Eco game. Highlighted in that menu is a "Manage" option, opening a sub-menu. The sub-menu has "Browse local files" highlighted.|frameless|border|upright=3|location=center|link=]]

== Installing Visual Studio ==

# Go to <code><nowiki>https://visualstudio.microsoft.com/downloads/#visual-studio-community-2026</nowiki></code> and look for the "'''Visual Studio Community 2026'''" download.
# Start the download by clicking on the ''Download'' button.
# Run the installer until it reaches to the Workloads page.
# Select these workloads...
## .NET desktop development -- '''Required''' for any mod development
## ASP.NET and web development -- Optional. If you want to interact with external websites or Eco's own web server (e.g. Discord's webhooks or extending the API)
# With those workloads selected the page should look something like this:<br>[[File:VisualStudioCommunity2022 Workloads.png|alt=Workloads screen during VS2022 installation. Options selected are "ASP.NET and web development" and ".NET desktop development". |frameless|location=center|upright=4|link=|border]]
# Click the Install button. It will take a few minutes to complete installation.
# Open Visual Studio after it installs.
# You may be prompted to sign in:
## Click ''Skip and add accounts later'' to continue.
## If you plan to use Github, sign in to make version control easier.
# Finally, it might ask what color theme you'd like. Select your preference and continue.
# Visual Studio is now installed and ready to be used.

== The Mod ==

Once Eco and Visual Studio are installed all of the tools needed to code, build, and run a mod are ready.

=== Creating a New Project ===

# Open Visual Studio. When it first opens it will show you a dashboard where you can quickly select what you want to do.
# On the right, under ''Get Started'' find the ''Create a new project'' button:<br>[[File:VS2022 OpeningDashboard.png|alt=VS2022's launch dashboard showing recent projects on the left and quick action buttons on the right. Highlighted is a button titled "Create a new project".|frameless|border|link=|location=center|upright=4]]
# A new window will pop-up.
# Select C# ''Class Library.'' To find the template, search <code>C# library</code> in the search bar. Select the C# option titled ''Class Library''.<br>'''Note:''' <u>Make sure you select the <code>C#</code> option as there are other options similarly named ''Class Library''.</u><br>[[File:VS2022 NewProjectWizard Templates.png|frameless|border|location=center|upright=4|link=]]
# Click the ''Next'' button.
# For ''Project Name'' type the name of the mod being created.
# The other options like the ''Location'' and the ''Solution Name'' do not need edited.
# Leave the box ''Place solution and project in the same directory'' unchecked.
# Click the Next button.
# Continue with the next section in this guide to determine the ''Framework'' selection.

=== .NET Version ===
<u>As of April of 2026</u>, Eco targets ''.NET 10.0'' and the mod should too.

To confirm the version of .NET that Eco uses:

# Go to the NuGet Gallery <code>www.nuget.org/packages?q=Eco.ReferenceAssemblies</code>
# Find the package with the name ''Eco.ReferenceAssemblies'' made by ''StrangeLoopGames''.
# Notice the chip underneath of it with the ''.NET'' version it targets.<br>[[File:NuGetGallery -- Eco.ReferenceAssemblies Search.png|alt=Shows the search result of Eco.ReferenceAssemblies. In a blue chip the text ".NET 8.0" can be seen.|frameless|upright=4|location=center|link=|border]]
# Click on that search result (shown above).
# A more detailed page is shown. Again, there's chips showing what version of .NET to use:<br>[[File:NuGetGallery--Eco.ReferenceAssemblies Details.png|alt=Show the package page for "Eco.ReferenceAssemblies" on NuGet Gallery. Circled in red are two chips with some version of the text ".NET 8.0" inside them.|frameless|link=|border|location=center|upright=3]]

'''Back to VS2022'''

On the Additional Information page, there's the Framework drop-down. Select the same version of .NET Eco uses (as described above).

Click the Create button to finish creating the mod!

=== Linking to Eco Assemblies ===
Look for the Solution Explorer on the right-hand side of VS2022. It should look something like this:

'''Note''': If the solution explorer isn't there, open it from the top menu. Click the ''View'' button and select ''Solution Explorer'' from the menu.

[[File:VS2022 -- Solution Explorer.png|alt=A picture of a basic layout in Visual Studio 2022 with the Solution Explorer open on the right-hand side. The solution explorer is circled in red.|frameless|link=|upright=4|location=center|border]]

From the Solution Explorer, find the ''References'' line and right-click on it. On that menu select ''Manage NuGet packages...''

[[File:VS2022 Solution Explorer -- Manage NuGet Packages.png|alt=Shows VS2022's Solution Explorer with project expanded. The References line is highlighted and a menu is open. On that menu the "Manage NuGet Packages" line is highlighted.|frameless|link=|upright=4|location=center|border]]

This will open a new tab. Above the search bar there's sub-tabs. '''Select the ''Browse'' sub-tab.'''

Type <code>Eco.ReferenceAssemblies</code> into the search bar.

'''Check the ''Include prerelease'' check-box.'''

Find the option with the name ''Eco.ReferenceAssemblies'' made by ''StrangeLoopGames''. Click on it.

A details panel will show up to the right. It will show the version of the reference assemblies being targeted. By default it chooses the latest and can be left at its default.

Click the Install button.

[[File:VS2022 -- NuGet Install Eco.ReferenceAssemblies.png|alt=VS2022 is open to the NuGet tab and is searching with the text Eco.ReferenceAssemblies. The checkbox to the right of the search is checked -- include prerelease. The only search result is selected. There is yellow highlights over part of the photo.|frameless|link=|upright=4|location=center|border]]

Click the ''Apply'' button on the popup to finish adding the references.

The reference assemblies have now been added! When coding VS2022 will provide IntelliSense popups. Try it out by going back to the <code>Class1.cs</code> file and typing <code>Eco.</code> and you will see suggestion pop up. It’s an essential tool for a lot of modders.

[[File:VS2022 -- Intellisense.png|alt=Shows a text editor with a basic class file. Inside there's the text "Eco." and a menu that show the suggested namespaces within.|frameless|link=|upright=4|location=center|border]]

=== Building The Dynamic Link Library (DLL) ===

==== Building for Development ====
Building the mod creates the <code>.dll</code> file that can be used to test with.

To build, open the ''Build'' menu from the top of VS2022.

Select ''Build Solution''. This will produce non-optimized DLL used for testing and development.

[[File:VS2022 -- Build Menu.png|alt=VS2022 top menu "Build" is open with "build solution" highlighted (ctrl + shift + b).|frameless|link=|upright=4|location=center|border]]

To find the file VS2022 just built, right click on the project in the Solution Explorer.

Select ''Open Folder in File Explorer.''

[[File:VS2022 -- Project Menu.png|alt=VS2022's solution explorer is shown with the projects right-click menu open. Highlighted is "Open folder in File Explorer"|frameless|link=|upright=4|location=center|border]]

From here, the mod's DLL will be in the <code>bin/Debug/net8.0/</code> folder. The file will be named with mod's name, like <code>TheMod.dll</code>.

Copy the mod's DLL file.

Paste it into the folder <code>Eco/Eco_Data/Server/Mods/</code>.

To run a game with that mod '''create a local world'''.

The mod should be running. Check the logs at <code>Eco/Eco_Data/Server/Logs/</code> to verify. Open the <u>most recent</u> log file here.

If the mod was loaded it there will be a line mentioning the file-name of the DLL. If the DLL was named <code>TheMod.dll</code> this is what to look for in the log file:<syntaxhighlight lang="text">[13:55:54.815] [4] [ Info] [Eco] Starting ModKitPlugin ...
[13:56:27.399] [4] [ Info] [Eco] Starting ModKitPlugin ... Finished in 32.584 sec

[13:56:27.439] [4] [ Info] [Eco] Loading mods ...
[13:56:27.439] [9] [ Info] [Eco] Loading TheMod...</syntaxhighlight>

===== Tip: Setup File Explorer to Sort By Date =====
It's suggested to setup the file view to ''Details'' in this folder because it will show the ''Date Modified'' for each file.

[[File:File Explorer -- View Settings Menu.png|alt=Show Window's File Explorer's view setting menu with the "details" option highlighted.|frameless|link=|upright=2|location=center|border]]

Additionally, clicking on the ''Date Modified'' header sorts all files. Sort it so the most recent is on top and every time the server starts the log file is easily found -- it's the one on top!

[[File:File Explorer -- Details Example.png|alt=Show's window's File Explorer with the date modified header highlighted.|frameless|link=|upright=2|location=center|border]]

==== Building for Release ====
To build for release, click on the mod's project in the Solution Explorer to highlight it.

[[File:VS2022 -- Solution Explorer Project Highlight.png|alt=Shows VS2022's solution explorer with the project highlighted.|frameless|link=|upright=2|location=center|border]]

Then, open the ''Build'' menu from the top of VS2022 and select ''Publish Selection''.

Set the target ''as Folder''. Click the ''Next'' button.

[[File:VS2022 -- Publish Wizard.png|alt=VS2022's publish wizard showing the target selection screen. The Folder option is highlighted.|frameless|link=|upright=2|location=center|border]]

Leave the folder location as default. Click the ''Finish'' button.

Click the ''Close'' button.

Finally, click the ''Publish'' button to start the build.

A green alert will pop up when the build is completed:

[[File:VS2022 -- Publish Screen.png|alt=Show's VS2022 publish screen. There's publish button at the top of this screen.|frameless|link=|upright=2|location=center|border]]

Either use the blue links on this page to find the file or browse the project's files as shown in "Building for Development".

Inside the project, the file will be in <code>bin/Release/net8.0/publish</code>. The file will be named with the mod project's name. For example, <code>TheMod.dll</code>.

Since the reference assemblies are already included in the game, do not worry about the other files here.

To share this mod, the only file needed is the mod's dll -- <code>TheMod.dll</code>.

=== Post-Build Scripts: Automatic Copy ===
With a post-build script VS2022 will automatically copy the files each build. It's a very nice feature to have when developing and rebuilding every 5 minutes to test something new.

First, add the variables about where <code>EcoServer.exe</code> is located to the project file.

Right-click on the project in the Solution Explorer and select the ''Edit Project File'' option.

Add the properties <code>EcoServerExe</code> and <code>EcoServerDir</code> <u>inside of the <code>PropertyGroup</code> tag.</u>

>>> Tip: By holding shift and right-clicking on a file in the file explorer an old-school menu pops up. Midway down this menu is an option to ''Copy As Path''. Neat!

The project file should look something like this:
<syntaxhighlight lang="xml"><Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<TargetFramework>net8.0</TargetFramework>
<ImplicitUsings>enable</ImplicitUsings>
<Nullable>enable</Nullable>

<EcoServerExe>$(EcoServerDir)\EcoServer.exe</EcoServerExe>
<EcoServerDir>C:\Program Files (x86)\Steam\steamapps\common\Eco\Eco_Data\Server</EcoServerDir>

</PropertyGroup>

<ItemGroup>
<PackageReference Include="Eco.ReferenceAssemblies" Version="0.11.1.13-beta-release-887" />
</ItemGroup>

</Project></syntaxhighlight>

Next, add the <code>PostBuild</code> property inside the <code>Project</code> tag.<syntaxhighlight lang="xml">
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
... SNIP ...
</PropertyGroup>

<ItemGroup>
... SNIP ...
</ItemGroup>

<Target Name="PostBuild" AfterTargets="PostBuildEvent">
<Exec Command='call PostBuild.bat "$(EcoServerDir)" "$(OutDir)" "$(MSBuildProjectName)"'/>
</Target>
</Project>
</syntaxhighlight>

Finally create a new file directly inside the project by right-clicking on the project in the Solution Explorer. Select the ''Add'' and click on ''New Item...'' from the sub-menu.

Use the name <code>PostBuild.bat</code> for this new file.

Open it and put the following in the PostBuild file:
<syntaxhighlight lang="batch">REM reading in arguements to sensible variables
set serverDir=%1
set outDir=%2
set projName=%3

REM removing double-quotes added to variables for concatenation
set serverDir=%serverDir:"=%
set outDir=%outDir:"=%
set projName=%projName:"=%

REM Copy mod dll to Mods dir
set dllFile=%outDir%%projName%.dll
echo Copying mod dll file: %dllFile%
copy "%dllFile%" "%serverDir%\Mods"

REM Copy mod pdb to directory where EcoServer.exe is
set pdbFile=%outDir%%projName%.pdb
echo Copying mod pdb file: %pdbFile%
copy "%pdbFile%" "%serverDir%"</syntaxhighlight>Now try running a rebuild of the project. The output should report copying files and inside the <code>Eco/Eco_Data/Server/Mods</code> folder should be <code>TheMod.dll</code> file

=== Setting up Debugging ===
'''Special thanks to Monzun#0606 on Eco's Discord for helping research the following information.'''
To setup debugging, <u>make sure that the project is setup with the post-build script described above</u>.

Debugging is a <u>powerful</u> tool to a developer and allows the developer to set breakpoints anywhere in the code to stop execution. When execution is stopped the developer can review every variable's value and incrementally continue the code. This is invaluable when tracking down bugs or trying to understand a complex piece of code.

From the top menu, select ''Debug'' and click on the option ''TheMod Debug Properties'' at the bottom of the menu.

[[File:VS2022 -- Debug Menu.png|alt=VS2022's debug menu is open from the top of the application. Highlighted is the last option "Debug Properties".|frameless|link=|upright=2|location=center|border]]

Find the ''Create a new profile'' button '''in the top-left''' of this new window. Select ''Executable'' from the drop-down menu.

[[File:VS2022 -- Debugger Launch Profiles.png|alt=VS2022's launch profile window is open. Underlined and pointed to by a red mark is the "Create a new profile" button, located in the top-left of the window. Highlighted from the menu under it is the option reading "Executable".|frameless|link=|upright=2|location=center|border]]

Set the ''Executable'' field to the full path to the <code>EcoServer.exe</code> file. For example, <code>C:\Program Files (x86)\Steam\steamapps\common\Eco\Eco_Data\Server</code><code>\EcoServer.exe</code>.

Set the ''Working Directory'' field to the full path to the folder containing the <code>EcoServer.exe</code> file. For example, <code>C:\Program Files (x86)\Steam\steamapps\common\Eco\Eco_Data\Server</code>.

[[File:VS2022 -- Eco Debugging Profile.png|alt=A fully configured profile ready to debug Eco on VS2022's launch profile page.|frameless|link=|upright=2|location=center|border]]

To use this newly configured profile, switch to it by clicking the small arrow to the right of the play icon (see image). Select the newly created profile -- ''Profile 1''.

[[File:VS2022 -- Debugger Profile Selection.png|alt=VS2022's debugger profile selection menu is open with the newly created "Profile 1" highlighted.|frameless|link=|upright=2|location=center|border]]

To see how breakpoints work, put the following in <code>Class1.cs</code> file:<syntaxhighlight lang="c#">
using Eco.Core.Plugins.Interfaces;
using Eco.Core.Utils;
using Eco.ModKit;

namespace Test
{
public class Class1 : IModKitPlugin, IInitializablePlugin
{
public string GetCategory() => "Tutorial";

public string GetStatus() => this._status;
string _status = string.Empty;

public void Initialize(TimedTask timer)
{
this._status = "Ok";
bool yes = true;
return;
}
}
}

</syntaxhighlight>This code creates a basic plugin, called <code>Class1</code>, that Eco will load and initialize on startup. Eco knows to do this because this class inherits the <code>IModKitPlugin</code> interface (causes it to be loaded) and the <code>IInitializablePlugin</code> interface (causes it to be initialized).

Add a breakpoint to the code by right-clicking on the line <code>bool yes = true;</code>.

[[File:VS2022 -- Adding a breakpoint.png|alt=A boilerplate example of a mod is shown in the VS2022 text editor. A line has a menu open above it with the option "Breakpoint" expanded and the option "Insert Breakpoint" highlighted on the sub-menu.|frameless|link=|upright=2|location=center|border]]

Now hit the play button. The server will start and VS2022 will flash back on screen once Eco tries to initialize the mod's plugin.

[[File:VS2022 -- Launch Debugger.png|alt=Highlighted is the play button for VS2022's debugger. The "Profile 1" is still selected from before.|frameless|link=|upright=2|location=center|border]]

After a little bit the server will start-up and hit the breakpoint set. When it does VS2022 will keep startup from continuing and allow detailed inspection to happen.

In the bottom left (circled in red) is a table of all of the variables within scope. Use this to see what is happening (especially useful in loops!).

At the middle-top (circled in red) are some of the debugger controls. Clicking the highlighted ''Continue'' button resumes normal operation. Using the buttons to the right that are highlighted will allow the developer to step through the codes execution to see exactly how each line is performing. Debugging is a deep and rich topic that this guide will not explain further, but there's a great video by Microsoft Visual Studio on YouTube called Basics of Debugging. In that 45 minute video (don't worry there's annotations to jump to just what is interesting) a whole gamut of information about how to use debugging is covered.

[[File:VS2022 -- Debugger LIve.png|alt=Shows a simple plugin's code in the editor of VS2022. In the bottom-left is a table of all variables used in the function. It is circled in red. On the top of the image also circled in red is the debugger controls. Highlighted within is the continue button and the "step over" button.|frameless|link=|upright=2|location=center|border]]

== Releasing a Mod ==

=== Mod.io ===
<code>mod.io</code> is where creators share their mods with players and others.

To share a new mod here all that is necessary is an account.

Head over to <code>mod.io/g/eco</code> and click ''Login'' in the top-right corner.

Finish signing-up with whatever account type you prefer.

Click the ''Add Mod'' button in the top-right.

Follow the upload wizard as directed.

Once on the ''File Manager'' section, a zip file is needed.

Zip the mod's <u>release</u> dll and any other assets necessary (e.g. Unity bundles) by putting all the files into a folder. Then right-click on that folder and select ''Compress To...'' and from the sub-menu select ''ZIP file''.

Upload that zip file. Considering naming it with a version number to help stay organized (e.g. ''v1''). Next release, increase that number by 1 (e.g. ''v2'')

Congratulations on releasing the mod!

=== Sharing on Discord ===
Consider posting an ad on the official {{EcoDiscord}}. There's a channel for mods called ''mod-ads''.
Please read the rules before posting.

== Helpful Resources ==

* Consider learning source control (Git). Completely optional, but can help you keep things organized as development continues.
* Explore Eco’s open-source mod projects for ideas (search on Github "Eco Mods" to find some real-life examples)
** {{EcoDiscord}}has a channel for mod developers to help one another called ''mod-dev.'' '''Note:''' Make under the ''Channel & Roles'' settings you have the 🛠''Yes, I want to see the channels about modding'' role selected.

Getting Started with Eco Modding in Visual Studio

2026-04-29T12:19:44Z

WugWugg: Updated Installing Visual Studio section (text only)

== Introduction ==
This guide focuses on setting up a C# modding environment in Visual Studio.

It does '''not''' cover adding Unity assets (models, prefabs, UI) to the game. See: [[From 3D Asset to Working Worktable]] for that workflow.

This guide won’t teach you how to code or write a mod, but it will help you get everything set up so you’re ready to start learning. Helpful resources are listed at the bottom of this guide, including [[Helpful Examples for Modding]] for practical code examples.

Visual Studio 2026 has a completely free to use version called the '''Community Edition'''. This guide is written assuming that's the version used.

=== Have Ready ===
* A copy of the Eco game installed
* A file explorer and the file-path to <code>Eco</code> folder<br>'''Tip:''' Within this folder there's folders like <code>D3D12</code> and <code>Eco_Data</code>. Also, you'll find the <code>Eco.exe</code> file here. There are other files and folder here too, but this list is just to help you know what the folder looks like.

==== '''Tip:''' Find Folder with Steam ====
Steam users can find the install folder by right-clicking on the game in your Steam Library:

[[File:Steam Library -- Browse Local Files.png|alt=Shows a Steam Library with a menu open over the Eco game. Highlighted in that menu is a "Manage" option, opening a sub-menu. The sub-menu has "Browse local files" highlighted.|frameless|border|upright=3|location=center|link=]]

== Installing Visual Studio ==

# Go to <code><nowiki>https://visualstudio.microsoft.com/downloads/#visual-studio-community-2026</nowiki></code> and look for the "'''Visual Studio Community 2026'''" download.
# Start the download by clicking on the ''Download'' button.
# Run the installer until it reaches to the Workloads page.
# Select these workloads...
## .NET desktop development -- '''Required''' for any mod development
## ASP.NET and web development -- Optional. If you want to interact with external websites or Eco's own web server (e.g. Discord's webhooks or extending the API)
# With those workloads selected the page should look something like this:[[File:VisualStudioCommunity2022 Workloads.png|alt=Workloads screen during VS2022 installation. Options selected are "ASP.NET and web development" and ".NET desktop development". |frameless|location=center|upright=4|link=|border]]
# Click the Install button. It will take a few minutes to complete installation. By default, it should launch Visual Studio after it installs.
# You may be prompted to sign in:
## Click ''Skip and add accounts later'' to continue.
## If you plan to use Github, sign in to make version control easier.
# Finally, it might ask what color theme you'd like. Select your preference and continue.
# Visual Studio is now installed and ready to be used.

== The Mod ==

Once Eco and Visual Studio are installed all of the tools needed to code, build, and run a mod are ready.

=== Creating a New Project ===

When VS2022 first opens it will show you a dashboard where you can quickly select what you want to do. On the left, are any recent projects opened. There won't be any if this is the first time installing it.

On the right there will be a few options, from here select the ''Create a new project'' option.

[[File:VS2022 OpeningDashboard.png|alt=VS2022's launch dashboard showing recent projects on the left and quick action buttons on the right. Highlighted is a button titled "Create a new project".|frameless|border|link=|location=center|upright=4]]

Now, it's time to go through the new project wizard. First, the wizard asks what kind of project is being made.

To mod Eco we need to make a '''C# Class Library'''.

To find the template, search <code>C# library</code> in the search bar. Select the C# option titled ''Class Library''.

It's important to '''pay attention to the icon and chips''' below the title and description. Make sure you '''select the <code>C#</code> option''' as there are other options similarly named ''Class Library''.

[[File:VS2022 NewProjectWizard Templates.png|frameless|border|location=center|upright=4|link=]]

The next page will ask you what the Project Name should be. Type the name of the mod being created.

The other options like the Location and the Solution Name do not need edited.

Leave the box ''Place solution and project in the same directory'' unchecked.

Click the Next button and continue along in the next section of this guide.

=== .NET Version ===
<u>As of April of 2026</u>, '''Eco targets .NET 10.0''' and the mod should too.

It's suggested to confirm the version of .NET that Eco uses by looking at the .NET version the reference assemblies use.

The reference assemblies can be found on the NuGet Gallery by searching for <code>Eco.ReferenceAssemblies</code>. See: <code>www.nuget.org/packages?q=Eco.ReferenceAssemblies</code>

Find the package with the name ''Eco.ReferenceAssemblies'' made by ''StrangeLoopGames''.

There will be a chip underneath of it with the ''.NET'' version it targets. This is what that page looks like:

[[File:NuGetGallery -- Eco.ReferenceAssemblies Search.png|alt=Shows the search result of Eco.ReferenceAssemblies. In a blue chip the text ".NET 8.0" can be seen.|frameless|upright=4|location=center|link=|border]]

By clicking on that search result (shown above), a more detailed page opens is show. Again, there's chips showing what version of .NET to use:

[[File:NuGetGallery--Eco.ReferenceAssemblies Details.png|alt=Show the package page for "Eco.ReferenceAssemblies" on NuGet Gallery. Circled in red are two chips with some version of the text ".NET 8.0" inside them.|frameless|link=|border|location=center|upright=3]]

'''Back to VS2022'''

On the Additional Information page, there's the Framework drop-down. Select the same version of .NET Eco uses (as described above).

Click the Create button to finish creating the mod!

=== Linking to Eco Assemblies ===
Look for the Solution Explorer on the right-hand side of VS2022. It should look something like this:

'''Note''': If the solution explorer isn't there, open it from the top menu. Click the ''View'' button and select ''Solution Explorer'' from the menu.

[[File:VS2022 -- Solution Explorer.png|alt=A picture of a basic layout in Visual Studio 2022 with the Solution Explorer open on the right-hand side. The solution explorer is circled in red.|frameless|link=|upright=4|location=center|border]]

From the Solution Explorer, find the ''References'' line and right-click on it. On that menu select ''Manage NuGet packages...''

[[File:VS2022 Solution Explorer -- Manage NuGet Packages.png|alt=Shows VS2022's Solution Explorer with project expanded. The References line is highlighted and a menu is open. On that menu the "Manage NuGet Packages" line is highlighted.|frameless|link=|upright=4|location=center|border]]

This will open a new tab. Above the search bar there's sub-tabs. '''Select the ''Browse'' sub-tab.'''

Type <code>Eco.ReferenceAssemblies</code> into the search bar.

'''Check the ''Include prerelease'' check-box.'''

Find the option with the name ''Eco.ReferenceAssemblies'' made by ''StrangeLoopGames''. Click on it.

A details panel will show up to the right. It will show the version of the reference assemblies being targeted. By default it chooses the latest and can be left at its default.

Click the Install button.

[[File:VS2022 -- NuGet Install Eco.ReferenceAssemblies.png|alt=VS2022 is open to the NuGet tab and is searching with the text Eco.ReferenceAssemblies. The checkbox to the right of the search is checked -- include prerelease. The only search result is selected. There is yellow highlights over part of the photo.|frameless|link=|upright=4|location=center|border]]

Click the ''Apply'' button on the popup to finish adding the references.

The reference assemblies have now been added! When coding VS2022 will provide IntelliSense popups. Try it out by going back to the <code>Class1.cs</code> file and typing <code>Eco.</code> and you will see suggestion pop up. It’s an essential tool for a lot of modders.

[[File:VS2022 -- Intellisense.png|alt=Shows a text editor with a basic class file. Inside there's the text "Eco." and a menu that show the suggested namespaces within.|frameless|link=|upright=4|location=center|border]]

=== Building The Dynamic Link Library (DLL) ===

==== Building for Development ====
Building the mod creates the <code>.dll</code> file that can be used to test with.

To build, open the ''Build'' menu from the top of VS2022.

Select ''Build Solution''. This will produce non-optimized DLL used for testing and development.

[[File:VS2022 -- Build Menu.png|alt=VS2022 top menu "Build" is open with "build solution" highlighted (ctrl + shift + b).|frameless|link=|upright=4|location=center|border]]

To find the file VS2022 just built, right click on the project in the Solution Explorer.

Select ''Open Folder in File Explorer.''

[[File:VS2022 -- Project Menu.png|alt=VS2022's solution explorer is shown with the projects right-click menu open. Highlighted is "Open folder in File Explorer"|frameless|link=|upright=4|location=center|border]]

From here, the mod's DLL will be in the <code>bin/Debug/net8.0/</code> folder. The file will be named with mod's name, like <code>TheMod.dll</code>.

Copy the mod's DLL file.

Paste it into the folder <code>Eco/Eco_Data/Server/Mods/</code>.

To run a game with that mod '''create a local world'''.

The mod should be running. Check the logs at <code>Eco/Eco_Data/Server/Logs/</code> to verify. Open the <u>most recent</u> log file here.

If the mod was loaded it there will be a line mentioning the file-name of the DLL. If the DLL was named <code>TheMod.dll</code> this is what to look for in the log file:<syntaxhighlight lang="text">[13:55:54.815] [4] [ Info] [Eco] Starting ModKitPlugin ...
[13:56:27.399] [4] [ Info] [Eco] Starting ModKitPlugin ... Finished in 32.584 sec

[13:56:27.439] [4] [ Info] [Eco] Loading mods ...
[13:56:27.439] [9] [ Info] [Eco] Loading TheMod...</syntaxhighlight>

===== Tip: Setup File Explorer to Sort By Date =====
It's suggested to setup the file view to ''Details'' in this folder because it will show the ''Date Modified'' for each file.

[[File:File Explorer -- View Settings Menu.png|alt=Show Window's File Explorer's view setting menu with the "details" option highlighted.|frameless|link=|upright=2|location=center|border]]

Additionally, clicking on the ''Date Modified'' header sorts all files. Sort it so the most recent is on top and every time the server starts the log file is easily found -- it's the one on top!

[[File:File Explorer -- Details Example.png|alt=Show's window's File Explorer with the date modified header highlighted.|frameless|link=|upright=2|location=center|border]]

==== Building for Release ====
To build for release, click on the mod's project in the Solution Explorer to highlight it.

[[File:VS2022 -- Solution Explorer Project Highlight.png|alt=Shows VS2022's solution explorer with the project highlighted.|frameless|link=|upright=2|location=center|border]]

Then, open the ''Build'' menu from the top of VS2022 and select ''Publish Selection''.

Set the target ''as Folder''. Click the ''Next'' button.

[[File:VS2022 -- Publish Wizard.png|alt=VS2022's publish wizard showing the target selection screen. The Folder option is highlighted.|frameless|link=|upright=2|location=center|border]]

Leave the folder location as default. Click the ''Finish'' button.

Click the ''Close'' button.

Finally, click the ''Publish'' button to start the build.

A green alert will pop up when the build is completed:

[[File:VS2022 -- Publish Screen.png|alt=Show's VS2022 publish screen. There's publish button at the top of this screen.|frameless|link=|upright=2|location=center|border]]

Either use the blue links on this page to find the file or browse the project's files as shown in "Building for Development".

Inside the project, the file will be in <code>bin/Release/net8.0/publish</code>. The file will be named with the mod project's name. For example, <code>TheMod.dll</code>.

Since the reference assemblies are already included in the game, do not worry about the other files here.

To share this mod, the only file needed is the mod's dll -- <code>TheMod.dll</code>.

=== Post-Build Scripts: Automatic Copy ===
With a post-build script VS2022 will automatically copy the files each build. It's a very nice feature to have when developing and rebuilding every 5 minutes to test something new.

First, add the variables about where <code>EcoServer.exe</code> is located to the project file.

Right-click on the project in the Solution Explorer and select the ''Edit Project File'' option.

Add the properties <code>EcoServerExe</code> and <code>EcoServerDir</code> <u>inside of the <code>PropertyGroup</code> tag.</u>

>>> Tip: By holding shift and right-clicking on a file in the file explorer an old-school menu pops up. Midway down this menu is an option to ''Copy As Path''. Neat!

The project file should look something like this:
<syntaxhighlight lang="xml"><Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<TargetFramework>net8.0</TargetFramework>
<ImplicitUsings>enable</ImplicitUsings>
<Nullable>enable</Nullable>

<EcoServerExe>$(EcoServerDir)\EcoServer.exe</EcoServerExe>
<EcoServerDir>C:\Program Files (x86)\Steam\steamapps\common\Eco\Eco_Data\Server</EcoServerDir>

</PropertyGroup>

<ItemGroup>
<PackageReference Include="Eco.ReferenceAssemblies" Version="0.11.1.13-beta-release-887" />
</ItemGroup>

</Project></syntaxhighlight>

Next, add the <code>PostBuild</code> property inside the <code>Project</code> tag.<syntaxhighlight lang="xml">
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
... SNIP ...
</PropertyGroup>

<ItemGroup>
... SNIP ...
</ItemGroup>

<Target Name="PostBuild" AfterTargets="PostBuildEvent">
<Exec Command='call PostBuild.bat "$(EcoServerDir)" "$(OutDir)" "$(MSBuildProjectName)"'/>
</Target>
</Project>
</syntaxhighlight>

Finally create a new file directly inside the project by right-clicking on the project in the Solution Explorer. Select the ''Add'' and click on ''New Item...'' from the sub-menu.

Use the name <code>PostBuild.bat</code> for this new file.

Open it and put the following in the PostBuild file:
<syntaxhighlight lang="batch">REM reading in arguements to sensible variables
set serverDir=%1
set outDir=%2
set projName=%3

REM removing double-quotes added to variables for concatenation
set serverDir=%serverDir:"=%
set outDir=%outDir:"=%
set projName=%projName:"=%

REM Copy mod dll to Mods dir
set dllFile=%outDir%%projName%.dll
echo Copying mod dll file: %dllFile%
copy "%dllFile%" "%serverDir%\Mods"

REM Copy mod pdb to directory where EcoServer.exe is
set pdbFile=%outDir%%projName%.pdb
echo Copying mod pdb file: %pdbFile%
copy "%pdbFile%" "%serverDir%"</syntaxhighlight>Now try running a rebuild of the project. The output should report copying files and inside the <code>Eco/Eco_Data/Server/Mods</code> folder should be <code>TheMod.dll</code> file

=== Setting up Debugging ===
'''Special thanks to Monzun#0606 on Eco's Discord for helping research the following information.'''
To setup debugging, <u>make sure that the project is setup with the post-build script described above</u>.

Debugging is a <u>powerful</u> tool to a developer and allows the developer to set breakpoints anywhere in the code to stop execution. When execution is stopped the developer can review every variable's value and incrementally continue the code. This is invaluable when tracking down bugs or trying to understand a complex piece of code.

From the top menu, select ''Debug'' and click on the option ''TheMod Debug Properties'' at the bottom of the menu.

[[File:VS2022 -- Debug Menu.png|alt=VS2022's debug menu is open from the top of the application. Highlighted is the last option "Debug Properties".|frameless|link=|upright=2|location=center|border]]

Find the ''Create a new profile'' button '''in the top-left''' of this new window. Select ''Executable'' from the drop-down menu.

[[File:VS2022 -- Debugger Launch Profiles.png|alt=VS2022's launch profile window is open. Underlined and pointed to by a red mark is the "Create a new profile" button, located in the top-left of the window. Highlighted from the menu under it is the option reading "Executable".|frameless|link=|upright=2|location=center|border]]

Set the ''Executable'' field to the full path to the <code>EcoServer.exe</code> file. For example, <code>C:\Program Files (x86)\Steam\steamapps\common\Eco\Eco_Data\Server</code><code>\EcoServer.exe</code>.

Set the ''Working Directory'' field to the full path to the folder containing the <code>EcoServer.exe</code> file. For example, <code>C:\Program Files (x86)\Steam\steamapps\common\Eco\Eco_Data\Server</code>.

[[File:VS2022 -- Eco Debugging Profile.png|alt=A fully configured profile ready to debug Eco on VS2022's launch profile page.|frameless|link=|upright=2|location=center|border]]

To use this newly configured profile, switch to it by clicking the small arrow to the right of the play icon (see image). Select the newly created profile -- ''Profile 1''.

[[File:VS2022 -- Debugger Profile Selection.png|alt=VS2022's debugger profile selection menu is open with the newly created "Profile 1" highlighted.|frameless|link=|upright=2|location=center|border]]

To see how breakpoints work, put the following in <code>Class1.cs</code> file:<syntaxhighlight lang="c#">
using Eco.Core.Plugins.Interfaces;
using Eco.Core.Utils;
using Eco.ModKit;

namespace Test
{
public class Class1 : IModKitPlugin, IInitializablePlugin
{
public string GetCategory() => "Tutorial";

public string GetStatus() => this._status;
string _status = string.Empty;

public void Initialize(TimedTask timer)
{
this._status = "Ok";
bool yes = true;
return;
}
}
}

</syntaxhighlight>This code creates a basic plugin, called <code>Class1</code>, that Eco will load and initialize on startup. Eco knows to do this because this class inherits the <code>IModKitPlugin</code> interface (causes it to be loaded) and the <code>IInitializablePlugin</code> interface (causes it to be initialized).

Add a breakpoint to the code by right-clicking on the line <code>bool yes = true;</code>.

[[File:VS2022 -- Adding a breakpoint.png|alt=A boilerplate example of a mod is shown in the VS2022 text editor. A line has a menu open above it with the option "Breakpoint" expanded and the option "Insert Breakpoint" highlighted on the sub-menu.|frameless|link=|upright=2|location=center|border]]

Now hit the play button. The server will start and VS2022 will flash back on screen once Eco tries to initialize the mod's plugin.

[[File:VS2022 -- Launch Debugger.png|alt=Highlighted is the play button for VS2022's debugger. The "Profile 1" is still selected from before.|frameless|link=|upright=2|location=center|border]]

After a little bit the server will start-up and hit the breakpoint set. When it does VS2022 will keep startup from continuing and allow detailed inspection to happen.

In the bottom left (circled in red) is a table of all of the variables within scope. Use this to see what is happening (especially useful in loops!).

At the middle-top (circled in red) are some of the debugger controls. Clicking the highlighted ''Continue'' button resumes normal operation. Using the buttons to the right that are highlighted will allow the developer to step through the codes execution to see exactly how each line is performing. Debugging is a deep and rich topic that this guide will not explain further, but there's a great video by Microsoft Visual Studio on YouTube called Basics of Debugging. In that 45 minute video (don't worry there's annotations to jump to just what is interesting) a whole gamut of information about how to use debugging is covered.

[[File:VS2022 -- Debugger LIve.png|alt=Shows a simple plugin's code in the editor of VS2022. In the bottom-left is a table of all variables used in the function. It is circled in red. On the top of the image also circled in red is the debugger controls. Highlighted within is the continue button and the "step over" button.|frameless|link=|upright=2|location=center|border]]

== Releasing a Mod ==

=== Mod.io ===
<code>mod.io</code> is where creators share their mods with players and others.

To share a new mod here all that is necessary is an account.

Head over to <code>mod.io/g/eco</code> and click ''Login'' in the top-right corner.

Finish signing-up with whatever account type you prefer.

Click the ''Add Mod'' button in the top-right.

Follow the upload wizard as directed.

Once on the ''File Manager'' section, a zip file is needed.

Zip the mod's <u>release</u> dll and any other assets necessary (e.g. Unity bundles) by putting all the files into a folder. Then right-click on that folder and select ''Compress To...'' and from the sub-menu select ''ZIP file''.

Upload that zip file. Considering naming it with a version number to help stay organized (e.g. ''v1''). Next release, increase that number by 1 (e.g. ''v2'')

Congratulations on releasing the mod!

=== Sharing on Discord ===
Consider posting an ad on the official {{EcoDiscord}}. There's a channel for mods called ''mod-ads''.
Please read the rules before posting.

== Helpful Resources ==

* Consider learning source control (Git). Completely optional, but can help you keep things organized as development continues.
* Explore Eco’s open-source mod projects for ideas (search on Github "Eco Mods" to find some real-life examples)
** {{EcoDiscord}}has a channel for mod developers to help one another called ''mod-dev.'' '''Note:''' Make under the ''Channel & Roles'' settings you have the 🛠''Yes, I want to see the channels about modding'' role selected.

Getting Started with Eco Modding in Visual Studio

2026-04-29T12:01:20Z

WugWugg: Minor wording nitpicks.

== Introduction ==

This guide focuses on setting up a C# modding environment in Visual Studio.

It does '''not''' cover adding Unity assets (models, prefabs, UI) to the game. See: [[From 3D Asset to Working Worktable]] for that workflow.

This guide won’t teach you how to code or write a mod, but it will help you get everything set up so you’re ready to start learning. Helpful resources are listed at the bottom of this guide, including [[Helpful Examples for Modding]] for practical code examples.

=== Have Ready ===
* A copy of the Eco game installed
* A file explorer and the file-path to <code>Eco</code> folder '''Tip:''' Within this folder there's folders like <code>D3D12</code> and <code>Eco_Data</code>. Also, you'll find the <code>Eco.exe</code> file here. There are other files and folder here too, but this list is just to help you know what the folder looks like.

==== Note: Find Folder with Steam ====
'''Steam''' users can find the install folder by right-clicking on the game in your Steam Library:

[[File:Steam Library -- Browse Local Files.png|alt=Shows a Steam Library with a menu open over the Eco game. Highlighted in that menu is a "Manage" option, opening a sub-menu. The sub-menu has "Browse local files" highlighted.|frameless|border|upright=3|location=center|link=]]

== Installing Visual Studio 2022 ==
Visual Studio 2022 (VS2022) has a completely free to use version called the '''Community Edition'''. This guide is written assuming that's the version used.

Go to https://visualstudio.microsoft.com/downloads/#visual-studio-community-2022 and look for the "'''Visual Studio Community 2022'''" download. The download button looks like:

[[File:VisualStudio2022 DownloadPage.png|alt=A picture of a website showing a row. The first column has the name "Visual Studio Community 2022" and there's a "Download" button two columns to the right, past it's description text.|frameless|location=center|link=|border|upright=4]]

Start the download by clicking on the Download button.

Run the installer until it reaches to the Workloads page. On this page, select these workloads:
* '''.NET desktop development''' -- Required for any mod development
* ASP.NET and web development -- Optional. If you want to interact with external websites or Eco's own web server (e.g. Discord's webhooks or extending the API)
'''Note''': Using the Workloads installation page is easy, but will install a few extra things (e.g. Github Copilot). If you want '''to keep the tooling minimal''' you can just install .NET from <code>dotnet.microsoft.com/en-us/download</code>. <u>At the time of writing</u>, Eco supports '''.NET version 8.0'''. See the later section [https://wiki.play.eco/en/index.php?title=Getting_Started_with_Eco_Modding_in_Visual_Studio_2022&veaction=edit&section=7 .NET Version] of this guide to learn how to check if that has changed.

This is what the Workloads page looks like with those options selected:

[[File:VisualStudioCommunity2022 Workloads.png|alt=Workloads screen during VS2022 installation. Options selected are "ASP.NET and web development" and ".NET desktop development". |frameless|location=center|upright=4|link=|border]]

Click the Install button. It will take a few minutes to complete installation. By default, it should launch VS2022 after it installs.

It will ask you to sign in. '''You do not need to''' and can completely avoid this by clicking the ''Skip and add accounts later'' option in tiny text below the buttons.

If you plan to upload your mod to Github, VS2022 does have integrated support for Github. So consider signing in with Github to make that process easier.

This guide is continuing as if the ''Skip and add accounts later'' option was selected. Finally, it might ask what color theme you'd like. Select your preference and continue.

Installation Complete!

== The Mod ==

Once Eco and Visual Studio are installed all of the tools needed to code, build, and run a mod are ready.

=== Creating a New Project ===

When VS2022 first opens it will show you a dashboard where you can quickly select what you want to do. On the left, are any recent projects opened. There won't be any if this is the first time installing it.

On the right there will be a few options, from here select the ''Create a new project'' option.

[[File:VS2022 OpeningDashboard.png|alt=VS2022's launch dashboard showing recent projects on the left and quick action buttons on the right. Highlighted is a button titled "Create a new project".|frameless|border|link=|location=center|upright=4]]

Now, it's time to go through the new project wizard. First, the wizard asks what kind of project is being made.

To mod Eco we need to make a '''C# Class Library'''.

To find the template, search <code>C# library</code> in the search bar. Select the C# option titled ''Class Library''.

It's important to '''pay attention to the icon and chips''' below the title and description. Make sure you '''select the <code>C#</code> option''' as there are other options similarly named ''Class Library''.

[[File:VS2022 NewProjectWizard Templates.png|frameless|border|location=center|upright=4|link=]]

The next page will ask you what the Project Name should be. Type the name of the mod being created.

The other options like the Location and the Solution Name do not need edited.

Leave the box ''Place solution and project in the same directory'' unchecked.

Click the Next button and continue along in the next section of this guide.

=== .NET Version ===
<u>As of April of 2026</u>, '''Eco targets .NET 10.0''' and the mod should too.

It's suggested to confirm the version of .NET that Eco uses by looking at the .NET version the reference assemblies use.

The reference assemblies can be found on the NuGet Gallery by searching for <code>Eco.ReferenceAssemblies</code>. See: <code>www.nuget.org/packages?q=Eco.ReferenceAssemblies</code>

Find the package with the name ''Eco.ReferenceAssemblies'' made by ''StrangeLoopGames''.

There will be a chip underneath of it with the ''.NET'' version it targets. This is what that page looks like:

[[File:NuGetGallery -- Eco.ReferenceAssemblies Search.png|alt=Shows the search result of Eco.ReferenceAssemblies. In a blue chip the text ".NET 8.0" can be seen.|frameless|upright=4|location=center|link=|border]]

By clicking on that search result (shown above), a more detailed page opens is show. Again, there's chips showing what version of .NET to use:

[[File:NuGetGallery--Eco.ReferenceAssemblies Details.png|alt=Show the package page for "Eco.ReferenceAssemblies" on NuGet Gallery. Circled in red are two chips with some version of the text ".NET 8.0" inside them.|frameless|link=|border|location=center|upright=3]]

'''Back to VS2022'''

On the Additional Information page, there's the Framework drop-down. Select the same version of .NET Eco uses (as described above).

Click the Create button to finish creating the mod!

=== Linking to Eco Assemblies ===
Look for the Solution Explorer on the right-hand side of VS2022. It should look something like this:

'''Note''': If the solution explorer isn't there, open it from the top menu. Click the ''View'' button and select ''Solution Explorer'' from the menu.

[[File:VS2022 -- Solution Explorer.png|alt=A picture of a basic layout in Visual Studio 2022 with the Solution Explorer open on the right-hand side. The solution explorer is circled in red.|frameless|link=|upright=4|location=center|border]]

From the Solution Explorer, find the ''References'' line and right-click on it. On that menu select ''Manage NuGet packages...''

[[File:VS2022 Solution Explorer -- Manage NuGet Packages.png|alt=Shows VS2022's Solution Explorer with project expanded. The References line is highlighted and a menu is open. On that menu the "Manage NuGet Packages" line is highlighted.|frameless|link=|upright=4|location=center|border]]

This will open a new tab. Above the search bar there's sub-tabs. '''Select the ''Browse'' sub-tab.'''

Type <code>Eco.ReferenceAssemblies</code> into the search bar.

'''Check the ''Include prerelease'' check-box.'''

Find the option with the name ''Eco.ReferenceAssemblies'' made by ''StrangeLoopGames''. Click on it.

A details panel will show up to the right. It will show the version of the reference assemblies being targeted. By default it chooses the latest and can be left at its default.

Click the Install button.

[[File:VS2022 -- NuGet Install Eco.ReferenceAssemblies.png|alt=VS2022 is open to the NuGet tab and is searching with the text Eco.ReferenceAssemblies. The checkbox to the right of the search is checked -- include prerelease. The only search result is selected. There is yellow highlights over part of the photo.|frameless|link=|upright=4|location=center|border]]

Click the ''Apply'' button on the popup to finish adding the references.

The reference assemblies have now been added! When coding VS2022 will provide IntelliSense popups. Try it out by going back to the <code>Class1.cs</code> file and typing <code>Eco.</code> and you will see suggestion pop up. It’s an essential tool for a lot of modders.

[[File:VS2022 -- Intellisense.png|alt=Shows a text editor with a basic class file. Inside there's the text "Eco." and a menu that show the suggested namespaces within.|frameless|link=|upright=4|location=center|border]]

=== Building The Dynamic Link Library (DLL) ===

==== Building for Development ====
Building the mod creates the <code>.dll</code> file that can be used to test with.

To build, open the ''Build'' menu from the top of VS2022.

Select ''Build Solution''. This will produce non-optimized DLL used for testing and development.

[[File:VS2022 -- Build Menu.png|alt=VS2022 top menu "Build" is open with "build solution" highlighted (ctrl + shift + b).|frameless|link=|upright=4|location=center|border]]

To find the file VS2022 just built, right click on the project in the Solution Explorer.

Select ''Open Folder in File Explorer.''

[[File:VS2022 -- Project Menu.png|alt=VS2022's solution explorer is shown with the projects right-click menu open. Highlighted is "Open folder in File Explorer"|frameless|link=|upright=4|location=center|border]]

From here, the mod's DLL will be in the <code>bin/Debug/net8.0/</code> folder. The file will be named with mod's name, like <code>TheMod.dll</code>.

Copy the mod's DLL file.

Paste it into the folder <code>Eco/Eco_Data/Server/Mods/</code>.

To run a game with that mod '''create a local world'''.

The mod should be running. Check the logs at <code>Eco/Eco_Data/Server/Logs/</code> to verify. Open the <u>most recent</u> log file here.

If the mod was loaded it there will be a line mentioning the file-name of the DLL. If the DLL was named <code>TheMod.dll</code> this is what to look for in the log file:<syntaxhighlight lang="text">[13:55:54.815] [4] [ Info] [Eco] Starting ModKitPlugin ...
[13:56:27.399] [4] [ Info] [Eco] Starting ModKitPlugin ... Finished in 32.584 sec

[13:56:27.439] [4] [ Info] [Eco] Loading mods ...
[13:56:27.439] [9] [ Info] [Eco] Loading TheMod...</syntaxhighlight>

===== Tip: Setup File Explorer to Sort By Date =====
It's suggested to setup the file view to ''Details'' in this folder because it will show the ''Date Modified'' for each file.

[[File:File Explorer -- View Settings Menu.png|alt=Show Window's File Explorer's view setting menu with the "details" option highlighted.|frameless|link=|upright=2|location=center|border]]

Additionally, clicking on the ''Date Modified'' header sorts all files. Sort it so the most recent is on top and every time the server starts the log file is easily found -- it's the one on top!

[[File:File Explorer -- Details Example.png|alt=Show's window's File Explorer with the date modified header highlighted.|frameless|link=|upright=2|location=center|border]]

==== Building for Release ====
To build for release, click on the mod's project in the Solution Explorer to highlight it.

[[File:VS2022 -- Solution Explorer Project Highlight.png|alt=Shows VS2022's solution explorer with the project highlighted.|frameless|link=|upright=2|location=center|border]]

Then, open the ''Build'' menu from the top of VS2022 and select ''Publish Selection''.

Set the target ''as Folder''. Click the ''Next'' button.

[[File:VS2022 -- Publish Wizard.png|alt=VS2022's publish wizard showing the target selection screen. The Folder option is highlighted.|frameless|link=|upright=2|location=center|border]]

Leave the folder location as default. Click the ''Finish'' button.

Click the ''Close'' button.

Finally, click the ''Publish'' button to start the build.

A green alert will pop up when the build is completed:

[[File:VS2022 -- Publish Screen.png|alt=Show's VS2022 publish screen. There's publish button at the top of this screen.|frameless|link=|upright=2|location=center|border]]

Either use the blue links on this page to find the file or browse the project's files as shown in "Building for Development".

Inside the project, the file will be in <code>bin/Release/net8.0/publish</code>. The file will be named with the mod project's name. For example, <code>TheMod.dll</code>.

Since the reference assemblies are already included in the game, do not worry about the other files here.

To share this mod, the only file needed is the mod's dll -- <code>TheMod.dll</code>.

=== Post-Build Scripts: Automatic Copy ===
With a post-build script VS2022 will automatically copy the files each build. It's a very nice feature to have when developing and rebuilding every 5 minutes to test something new.

First, add the variables about where <code>EcoServer.exe</code> is located to the project file.

Right-click on the project in the Solution Explorer and select the ''Edit Project File'' option.

Add the properties <code>EcoServerExe</code> and <code>EcoServerDir</code> <u>inside of the <code>PropertyGroup</code> tag.</u>

>>> Tip: By holding shift and right-clicking on a file in the file explorer an old-school menu pops up. Midway down this menu is an option to ''Copy As Path''. Neat!

The project file should look something like this:
<syntaxhighlight lang="xml"><Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<TargetFramework>net8.0</TargetFramework>
<ImplicitUsings>enable</ImplicitUsings>
<Nullable>enable</Nullable>

<EcoServerExe>$(EcoServerDir)\EcoServer.exe</EcoServerExe>
<EcoServerDir>C:\Program Files (x86)\Steam\steamapps\common\Eco\Eco_Data\Server</EcoServerDir>

</PropertyGroup>

<ItemGroup>
<PackageReference Include="Eco.ReferenceAssemblies" Version="0.11.1.13-beta-release-887" />
</ItemGroup>

</Project></syntaxhighlight>

Next, add the <code>PostBuild</code> property inside the <code>Project</code> tag.<syntaxhighlight lang="xml">
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
... SNIP ...
</PropertyGroup>

<ItemGroup>
... SNIP ...
</ItemGroup>

<Target Name="PostBuild" AfterTargets="PostBuildEvent">
<Exec Command='call PostBuild.bat "$(EcoServerDir)" "$(OutDir)" "$(MSBuildProjectName)"'/>
</Target>
</Project>
</syntaxhighlight>

Finally create a new file directly inside the project by right-clicking on the project in the Solution Explorer. Select the ''Add'' and click on ''New Item...'' from the sub-menu.

Use the name <code>PostBuild.bat</code> for this new file.

Open it and put the following in the PostBuild file:
<syntaxhighlight lang="batch">REM reading in arguements to sensible variables
set serverDir=%1
set outDir=%2
set projName=%3

REM removing double-quotes added to variables for concatenation
set serverDir=%serverDir:"=%
set outDir=%outDir:"=%
set projName=%projName:"=%

REM Copy mod dll to Mods dir
set dllFile=%outDir%%projName%.dll
echo Copying mod dll file: %dllFile%
copy "%dllFile%" "%serverDir%\Mods"

REM Copy mod pdb to directory where EcoServer.exe is
set pdbFile=%outDir%%projName%.pdb
echo Copying mod pdb file: %pdbFile%
copy "%pdbFile%" "%serverDir%"</syntaxhighlight>Now try running a rebuild of the project. The output should report copying files and inside the <code>Eco/Eco_Data/Server/Mods</code> folder should be <code>TheMod.dll</code> file

=== Setting up Debugging ===
'''Special thanks to Monzun#0606 on Eco's Discord for helping research the following information.'''
To setup debugging, <u>make sure that the project is setup with the post-build script described above</u>.

Debugging is a <u>powerful</u> tool to a developer and allows the developer to set breakpoints anywhere in the code to stop execution. When execution is stopped the developer can review every variable's value and incrementally continue the code. This is invaluable when tracking down bugs or trying to understand a complex piece of code.

From the top menu, select ''Debug'' and click on the option ''TheMod Debug Properties'' at the bottom of the menu.

[[File:VS2022 -- Debug Menu.png|alt=VS2022's debug menu is open from the top of the application. Highlighted is the last option "Debug Properties".|frameless|link=|upright=2|location=center|border]]

Find the ''Create a new profile'' button '''in the top-left''' of this new window. Select ''Executable'' from the drop-down menu.

[[File:VS2022 -- Debugger Launch Profiles.png|alt=VS2022's launch profile window is open. Underlined and pointed to by a red mark is the "Create a new profile" button, located in the top-left of the window. Highlighted from the menu under it is the option reading "Executable".|frameless|link=|upright=2|location=center|border]]

Set the ''Executable'' field to the full path to the <code>EcoServer.exe</code> file. For example, <code>C:\Program Files (x86)\Steam\steamapps\common\Eco\Eco_Data\Server</code><code>\EcoServer.exe</code>.

Set the ''Working Directory'' field to the full path to the folder containing the <code>EcoServer.exe</code> file. For example, <code>C:\Program Files (x86)\Steam\steamapps\common\Eco\Eco_Data\Server</code>.

[[File:VS2022 -- Eco Debugging Profile.png|alt=A fully configured profile ready to debug Eco on VS2022's launch profile page.|frameless|link=|upright=2|location=center|border]]

To use this newly configured profile, switch to it by clicking the small arrow to the right of the play icon (see image). Select the newly created profile -- ''Profile 1''.

[[File:VS2022 -- Debugger Profile Selection.png|alt=VS2022's debugger profile selection menu is open with the newly created "Profile 1" highlighted.|frameless|link=|upright=2|location=center|border]]

To see how breakpoints work, put the following in <code>Class1.cs</code> file:<syntaxhighlight lang="c#">
using Eco.Core.Plugins.Interfaces;
using Eco.Core.Utils;
using Eco.ModKit;

namespace Test
{
public class Class1 : IModKitPlugin, IInitializablePlugin
{
public string GetCategory() => "Tutorial";

public string GetStatus() => this._status;
string _status = string.Empty;

public void Initialize(TimedTask timer)
{
this._status = "Ok";
bool yes = true;
return;
}
}
}

</syntaxhighlight>This code creates a basic plugin, called <code>Class1</code>, that Eco will load and initialize on startup. Eco knows to do this because this class inherits the <code>IModKitPlugin</code> interface (causes it to be loaded) and the <code>IInitializablePlugin</code> interface (causes it to be initialized).

Add a breakpoint to the code by right-clicking on the line <code>bool yes = true;</code>.

[[File:VS2022 -- Adding a breakpoint.png|alt=A boilerplate example of a mod is shown in the VS2022 text editor. A line has a menu open above it with the option "Breakpoint" expanded and the option "Insert Breakpoint" highlighted on the sub-menu.|frameless|link=|upright=2|location=center|border]]

Now hit the play button. The server will start and VS2022 will flash back on screen once Eco tries to initialize the mod's plugin.

[[File:VS2022 -- Launch Debugger.png|alt=Highlighted is the play button for VS2022's debugger. The "Profile 1" is still selected from before.|frameless|link=|upright=2|location=center|border]]

After a little bit the server will start-up and hit the breakpoint set. When it does VS2022 will keep startup from continuing and allow detailed inspection to happen.

In the bottom left (circled in red) is a table of all of the variables within scope. Use this to see what is happening (especially useful in loops!).

At the middle-top (circled in red) are some of the debugger controls. Clicking the highlighted ''Continue'' button resumes normal operation. Using the buttons to the right that are highlighted will allow the developer to step through the codes execution to see exactly how each line is performing. Debugging is a deep and rich topic that this guide will not explain further, but there's a great video by Microsoft Visual Studio on YouTube called Basics of Debugging. In that 45 minute video (don't worry there's annotations to jump to just what is interesting) a whole gamut of information about how to use debugging is covered.

[[File:VS2022 -- Debugger LIve.png|alt=Shows a simple plugin's code in the editor of VS2022. In the bottom-left is a table of all variables used in the function. It is circled in red. On the top of the image also circled in red is the debugger controls. Highlighted within is the continue button and the "step over" button.|frameless|link=|upright=2|location=center|border]]

== Releasing a Mod ==

=== Mod.io ===
<code>mod.io</code> is where creators share their mods with players and others.

To share a new mod here all that is necessary is an account.

Head over to <code>mod.io/g/eco</code> and click ''Login'' in the top-right corner.

Finish signing-up with whatever account type you prefer.

Click the ''Add Mod'' button in the top-right.

Follow the upload wizard as directed.

Once on the ''File Manager'' section, a zip file is needed.

Zip the mod's <u>release</u> dll and any other assets necessary (e.g. Unity bundles) by putting all the files into a folder. Then right-click on that folder and select ''Compress To...'' and from the sub-menu select ''ZIP file''.

Upload that zip file. Considering naming it with a version number to help stay organized (e.g. ''v1''). Next release, increase that number by 1 (e.g. ''v2'')

Congratulations on releasing the mod!

=== Sharing on Discord ===
Consider posting an ad on the official {{EcoDiscord}}. There's a channel for mods called ''mod-ads''.
Please read the rules before posting.

== Helpful Resources ==

* Consider learning source control (Git). Completely optional, but can help you keep things organized as development continues.
* Explore Eco’s open-source mod projects for ideas (search on Github "Eco Mods" to find some real-life examples)
** {{EcoDiscord}}has a channel for mod developers to help one another called ''mod-dev.'' '''Note:''' Make under the ''Channel & Roles'' settings you have the 🛠''Yes, I want to see the channels about modding'' role selected.

Mod Development

2026-04-29T11:36:02Z

WugWugg: /* Player Contributed Written Guides */

<div class="container-fluid">
<div class="row">[[File:EcoModKit.jpg|class=headbanner|link=]]</div>
</div>

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 [https://github.com/StrangeLoopGames/EcoModKit EcoModKit] repository.
== Documentation ==
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}}.

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.

== 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]]
* [[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]
* [[Getting Started with Eco Modding in Visual Studio]]
* [[Helpful Examples for Modding]]
* [[From 3D Asset to Working Worktable]]
== 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>

== 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]
[[Category: Modding]]

From 3D Asset to Working Worktable

2026-04-29T00:29:04Z

WugWugg: /* Checkpoint */

= Introduction =
Below is a guide on how to take an 3D asset from the Unity Store and make a working workbench in Eco. This includes:
* Creating a recipe to craft the modded table
* Creating recipes so the player can use the modded table to craft something
* Using Blender to generate a modded icon (seen when holding it in inventory)
* Using Blender to adjust the origin point of the model
* How to setup all this in a Unity scene and package for Eco

= Setup =

* Already have setup '''ModKit + Unity'''
** See: [[Installing the ModKit]]
* Have a '''3D model'''
** Just following along? Find the one used here at <code><nowiki>https://assetstore.unity.com/packages/3d/props/low-poly-medieval-market-stalls-314286</nowiki></code>
* A '''C# IDE''' (notepad++, Visual Studio, etc.)
** Highly encouraged to have an Intellisense setup and linked to the '''Reference Assemblies'''. Optional, but its really worth the time to figure out because it will help quickly correct small typos and trivial mistakes.
** See: [[Getting Started with Eco Modding in Visual Studio 2022]] (generally the same steps apply if using a new version of Visual Studio)
* '''Blender''' installed
** Homepage: <code><nowiki>https://www.blender.org/</nowiki></code>

== Importing the Assets ==

# Open the Unity editor to the project.
# From the top toolbar open the ''Window'' drop down.
# Hover ''Package Management'' to open sub-menu.
# Select ''Package Manager''.
# The ''Package Manager'' window will pop-up.
# Install the package containing the assets you want to use...
## <u>If not using Unity Registry</u>...
### Find the ''+▾'' button in the top left and open the drop down.
### Install the package from one of those options.
## <u>If using Unity Registry</u>...
### Visit <code><nowiki>https://assetstore.unity.com</nowiki></code> and sign in.
### Search for the asset desired.
### Go to it's page (e.g. <code><nowiki>https://assetstore.unity.com/packages/3d/props/low-poly-medieval-market-stalls-314286</nowiki></code>) and click the big blue button, ''Add to My Assets.''
### Now, in the Unity editor and back at the ''Package Manager'' window.
### Find ''My Assets'' on the left menu and navigate to it.
### Click the ''⟳'' button in the lower-right.
### The asset should be in the list now. Use the search to filter if needed.
### Click on the asset in the list. For those following along, ''Low Poly Medieval Market Stalls''.
### In the right panel, find the ''Download ⤓'' button. Click it.
### Once downloaded, a new button should show up, it'll say something like ''⊕ Import 1.0 to project'' . Click it.
### The ''Import Unity Package'' window will pop-up.
### Select ''Import'' on it.
# Verify you can find your assets from the explorer. If following along, the assets are at <code>Assets/PolyRonin/Medieval Market Stalls</code>.
# Load in a demo scene, if provided, and make sure everything looks okay.
## For those following along, double click on the ''Demo'' scene at <code>Assets/PolyRonin/Medieval Market Stalls/Demo.unity</code>.

[[File:Eco - Unity - View Modes.png|thumb|Underlined in red are the different draw mode buttons. <u>4/20/26</u>]]
If something seems off, check the different draw modes and see if changing those allow the scene to render as expected (see picture).

= Creating The Worktable =
This guide will create the worktable in this order:

# Create the item that represents the worktable
# Make a recipe to craft the worktable item
# Make the worktable item something that places a world object
# Give the worktable functionality by adding recipes to it

== Creating the Item ==

=== Item Icon ===
[[File:TeamstersStall - StallOnly - 256x256.png|thumb|A large (256x256px) icon created of Stall4 from the medieval assets.]]
# Open <u>Blender</u>.
# Delete everything in the ''Scene Collection''. Find this section in the top-right of the application.
# From the top toolbar, open the ''File'' drop down.
# Hover ''Import'' to open the sub-menu.
# Select the type of 3D asset. For those using medieval assets, select ''FBX (.fbx)''.
# Find the asset on the computer...<br>'''Tip:''' Use Unity to find the <code>.fbx</code> asset.
## For the medieval assets, that's in <code>Assets/PolyRonin/Medieval Market Stalls/Meshes/medieval-market-stalls-1.fbx</code>.
## Right click on it and select ''Show in explorer''.
## Now copy the address of that folder from Explorer. It might look like <code>C:\Users\Wug\EcoMod--WikiDemo\WikiDemo\Assets\PolyRonin\Medieval Market Stalls\Meshes</code>.
## Paste that in the address bar of the <u>Blender</u> import pop-up.
# Select the blue ''Import FBX'' button''.''
# Be in the ''Layout'' workspace (top toolbar) and in the ''Object Mode...''
## Find the drop down in the second toolbar from the top that has options like ''Object Mode, Edit Mode, Sculpt Mode,'' etc.
## Select ''Object Mode'' from that drop down.
# Change the Viewport Shading to Material Preview or Rendered. This is on the second toolbar down, far right of center, but before ''Scene Collection'' section.
# If you see purple models, Blender will need help finding textures for these meshes...
## From the top toolbar, open the ''File'' drop down.
## Hover ''External Data'' to open the sub-menu.
## Select ''Find Missing Files...''
## Point this to the whole directory that the 3D assets came in. For the medieval pack, <code>C:\Users\</code><code>Wug\EcoMod--WikiDemo\WikiDemo\Assets\PolyRonin</code>.
## The proper textures/materials should have now loaded in. If it hasn't, consult Google because without the textures the following steps won't produce a usable icon.
# Add a source of light...
## Still be in the ''Layout'' workspace (top toolbar) and in the ''Object Mode...''
### Find the drop down in the second toolbar from the top that has options like ''Object Mode, Edit Mode, Sculpt Mode,'' etc.
### Select ''Object Mode'' from that drop down.
## From the toolbar just under that one, find and open the ''Add'' drop down.
## Hover ''Light'' to open that sub-menu.
## Click ''Sun''.
# Add a camera...
## In the ''Layout'' workspace (top toolbar) and in the ''Object Mode...''
### Find the drop down in the second toolbar from the top that has options like ''Object Mode, Edit Mode, Sculpt Mode,'' etc.
### Select ''Object Mode'' from that drop down.
## From the second toolbar down, find and open the ''Add'' drop down.
## Select ''Camera''.
# Setup the scene with the object placement and lighting direction desired.<br>'''Tip:''' To reset the editor to something selected press the period key <u>on the numpad</u>. Without a numpad, use ''View'' (second toolbar from the top) and select ''Frame Selected'' from it. Alternatively, just set the zoom to zoom to the mouse position: ''Edit'' (top toolbar), ''Preferences'' (from drop down), ''Navigation'' (on left menu), ''Zoom to Mouse Position'' (In the zoom section). This makes moving around a lot more natural feeling.
# Setup the rendering camera...
## Go to ''Rendering'' tab on the top toolbar
## On the right there will be a side-panel open, it should be the ''Render'' tab. Confirm that.
## Change ''Render Engine'' to ''Cycles''.
## Look down below in the same tab for the ''Film'' section.
## Expand it and find the ''Transparent'' checkbox and section. Click it so that it has a check mark. This will make the icon's background transparent.
## Now, go to the ''Output'' tab <u>on the side panel</u>. The tab is just below the current one.
## In the ''Format'' section set ''Resolution X'' to ''64.'' And ''Y'' to ''64'' as well. This will make the icon generated a 64 by 64 pixel image.
# Go back to the ''Layout'' tab from the top toolbar.
# Center your view on the object (numpad period or ''View > Frame Selected''). Adjust it so that the object is how it should be for the icon.
# Align the camera to the view...
## Make sure the editor is in ''Layout'' workspace (top toolbar) and in the ''Object Mode...''
### Find the drop down in the second toolbar from the top that has options like ''Object Mode, Edit Mode, Sculpt Mode,'' etc.
### Select ''Object Mode'' from that drop down.
## Find ''View'' from the second from the top toolbar and open the drop down.
## Hover ''Align View'' to open the sub-menu.
## Select ''Align Active Camera To View''.
## If the view is slightly off, there is a lock icon on the right side of this panel. Use it to "lock" controls to the camera and tweak it's view.
# Now return to the ''Rendering'' tab from the top toolbar.
# Press the F12 key to start the render. This should complete quickly since 64x64 pixels is a very small render.
# A window should popup, ''Blender Render''. This is the icon!
# From the top tool bar of this ''Blender Render'' window, open the ''Image'' drop down.
# Select ''Save As...'' to save somewhere on the computer.
# Return to step 13 and repeat to do larger images if desired. Create a 128 by 128 pixel image too. It will make things smoother later.
# Save the Blender scene. Not only will it be used later, this will make making a new icon with a small tweak that much easier.
## ''File'' drop down from top toolbar.
## ''Save As...'' to save the Blender scene to the computer.
## Save it to <code>Assets/WikiDemo/MedievalStall - Icon Scene.blend</code>.

=== Adding to Unity Scene ===
The developers explain how to create an item in one of ModKit's read me files (See: <code>Assets/EcoModKit/Docs/README.md</code>), but this guide will explain it below.

Additionally, '''TheKye''' on YouTube covers this in their ''Creating Your First Item'' and ''Creating Your First Item Pt 2'' videos.

Use those additional resource to help troubleshoot issues with item's icons.

# Open <u>Unity</u>.
# In the left panel, the ''Hierarchy'' tab should be selected.
# Select the top-most object there. It should be a scene. If the editor last loaded the ''Demo'' scene from the medieval assets, it'll be named ''Demo''.
# Right click on this scene and select ''Add New Scene'' from the menu.
# Right click again on the old scene (''Demo'') and select ''Remove Scene''.
# Let it save if the changes to the old scene are important. Discard if it was open just for exploration's sake.
# Right click the new, ''Untitled'' scene. Click ''Save Scene As...''
# Save it to <code>Assets/WikiDemo.unity</code>.
# Delete <u>anything</u> in the scene.
# Right click the scene, hover ''GameObject'', and select ''Create Empty'' from the sub-menu.
# Name this new object ''Objects''.
# Select the newly created ''Objects'' object from the ''Hierarchy'' menu.
# On the far right side of the screen, in the ''Inspector'' menu, click the ''Add Component'' button.
# Type in ''ModkitPrefabContainer''. Click on the component from the search to add it. The component now should be listed in the ''Inspector''.
# In the ''Hierarchy'' panel right click the scene, hover ''GameObject'', and select ''Create Empty''.
# Name this new object ''Items''.
# Right click the scene, hover ''GameObject'', and select ''Create Empty''.
# Name this new object ''Emoji''.
# Select the newly created ''Emoji'' object, find the ''Inspector'' menu (far-right), and click the ''Add Component'' button.
# Type in ''ChatEmoteSetOld''. Click on the component from the search to add it. That component should now be listed in the ''Inspector''.
# Right click the scene, hover ''GameObject'', and select ''Create Empty''.
# Name this new object ''BlockSets''.
# Select the newly created ''BlockSets'' object, find the ''Inspector'' menu (far-right), and click ''Add Component''.
# Search for ''BlockSetContainer''. Click on the component from the search to add it. The ''Inspector'' should now show that component as added.
#Go to <code>Assets/EcoModKit/Prefabs</code> in the Unity project window.
# Find the prefab ''ItemTemplate''.
# Drag it onto the ''Items'' object in the ''Hierarchy'' panel. It should add it as a <u>child</u> of the ''Items'' object.
# Right click on the new ''ItemTemplate'' object, hover ''Prefab'', and select ''Unpack Completely''.
# Right click on the ''ItemTemplate'' object and select ''Rename''. Name this what you want the item to be called. Example: ''MedievalStallItem''.
# Set this item's background...
## Here's the default backgrounds (blue = item, brown = block, green = food): <br>[[File:Eco - Item - Background.png|border|frameless]] [[File:Eco - Block - Background.png|frameless]] [[File:Eco - Food - Background.png|frameless]]
## Download or prepare the background and add it to the <code>Assets</code> folder in Unity.
### To follow along lockstep, put the background in a new <code>Assets/WikiDemo</code> folder.
### Right click on <code>Assets</code> folder, hover ''Create'', select ''Folder''.
### Name the folder ''WikiDemo''.
## Configure Unity to use these as sprites...
### Select the background(s) added (Ctrl+Click each one).
### In the ''Inspector'', find ''TextureType'' and change that to ''Sprite (2D and UI)''.
### Again in the ''Inspector'', find ''SpriteMode'' and change that to ''Single''.
### Then scroll and go to the bottom of the ''Inspector'' and find the ''Apply'' button.
### This will apply those changes to that file and all other ones highlighted.
## Select the item being created (''MedievalStallItem'').
## In the ''Inspector'' panel (far-right), scroll and find the ''Item Template (Script)'' section.
## In here find the ''Background'' input. It'll say ''Background (Image)'' in it. If clicked that text to reveal and highlight the related object in the ''Hierarchy'' panel.
## Select the revealed, and highlighted object ''Background''.
## In the ''Inspector'' panel, scroll and find the ''Image'' component section.
## Inside that component's section, find ''Source Image''. It'll say ''Missing (Sprite)''. Click the ''⦿'' button to the right.
## The ''Select Sprite'' popup will show. Make sure the ''Assets'' tab is selected, and find the backgrounds desired.
#Create the foreground image...
##This is easily accomplished in MS Paint.
##Get to the background image file in a <u>file explorer</u>.
##Right click on it, hover ''Open with...'', and select ''Paint''.
##The solid background should be displayed.
##Open the ''File'' menu from the top toolbar.
##Hover ''Import to Canvas'' and select ''From a File''.
##Find the icon in the file browser and import it. Match the size of the background image to have it nicely center itself.
##Now ''File'' from the top toolbar.
##Hover ''Save As...'' and select ''PNG''.
##Save this to the <code>Assets/WikiDemo</code> folder in Unity.
##Configure Unity to use these as sprites...
### Select the foreground image.
### In the ''Inspector'', find ''TextureType'' and change that to ''Sprite (2D and UI)''.
### Again in the ''Inspector'', find ''SpriteMode'' and change that to ''Single''.
### Then scroll and go to the bottom of the ''Inspector'' and find the ''Apply'' button.
### This will apply those changes to that file and all other ones highlighted.
#Set this item's foreground...
## Copy the item's icon into the <code>Assets</code> folder.
## Configure Unity to use it as a sprite (see the previous step's ''Set this item's background...'' instructions)
## Select the item being created (''MedievalStallItem'').
## In the ''Inspector'' panel (far-right), scroll and find the ''Item Template (Script)'' section.
## In here find the ''Foreground'' input. It'll say ''Foreground (Image)'' in it. If clicked that text to reveal and highlight the related object in the ''Hierarchy'' panel.
## Select the revealed, and highlighted object ''Foreground''.
## Use the ''Inspector'', find the ''Image'' component, within that component find the ''Source Image'' input. It will say ''Missing (Sprite)''.
## Click the ''⦿'' button to the right of that input.
## From the ''Select Sprite'' popup, ensure the ''Assets'' tab is being searched, and find the icon just created.

=== Export From Unity ===

# Open the ''File'' menu from the top toolbar.
# Select ''Save.'' Save it to the <code>Assets/WikiDemo</code> folder.<br>'''Note:''' Do not skip. The scene must be saved for the ModKit build to work properly.
# Open the ''Eco Tools'' menu from the top toolbar.
# Hover ''Mod Kit'' to open the sub-menu.
# Select ''Build Current Bundle''.
# Have it output the bundle to <code>/Eco Server/Mods/UserCode/WikiDemo.unity3d</code>
# Wait for this to build. This may take a few minutes.

=== Coding the Item ===
For this guide, all code will be placed in a single <code>.cs</code> file and will not be compiled into a <code>.dll</code>.

# Create a <code>.cs</code> file: <code>/Eco Server/Mods/UserCode/WikiDemo.cs</code>
# Put the following into the newly created file:
<syntaxhighlight lang="c#" line="1">using Eco.Core.Items;
using Eco.Gameplay.Items;
using Eco.Shared.Localization;
using Eco.Shared.Serialization;

namespace WikiDemo
{
#region Item
[Serialized] // Tells the save/load system this object needs to be serialized.
[LocDisplayName("Market Stall")] // Defines the localized name of the item.
[Weight(100)] // Defines how heavy this is.
[Ecopedia("Work Stations", "Craft Tables", createAsSubPage: true)]
[LocDescription("A medieval market stall.")] //The tooltip description for the item.
public partial class MedievalStallItem: Item { }
#endregion
}</syntaxhighlight>'''Line 8:''' A region tag. Lets the editor know it can collapse all of that code as a section. The following examples in this guide will just show <code>#region Item</code> in their code examples.

'''Line 13:''' The implementation of <code>Item</code> means that Eco will find this and look for Unity assets that matching this class' name, <code>MedivalStallItem</code>. While this doesn't do anything fancy, it completes the first step towards a new workbench.

=== Checkpoint #1 ===
[[File:Eco - Hotbar With Modded Icon.png|thumb|Shows the medieval stall as a modded icon in-game.]]
Make sure everything is running smoothly by doing the following:

# Double-check that the <code>WikiDemo.unity3d</code> and the <code>WikiDemo.cs</code> files are in <code>/Eco Server/Mods/UserCode</code> folder.
# Start the server and connect to it.
# Test it out by typing <code>/give MedievalStall</code> in chat.
## It's also possible to do <code>/give Market Stall</code> to get the item. How? Line 10: of the the above code declares that name as this item's "common name". Neat.
# The item should appear in the players inventory with a working icon.

== Code the Item's Recipe ==
The following goes over how to add a new class and implement the <code>RecipeFamily</code> interface.<syntaxhighlight lang="c#" line="1">using Eco.Core.Items;
using Eco.Gameplay.Components;
using Eco.Gameplay.Items;
using Eco.Gameplay.Items.Recipes;
using Eco.Gameplay.Skills;
using Eco.Mods.TechTree;
using Eco.Shared.Localization;
using Eco.Shared.Serialization;
using System.Runtime.Versioning;
using System.Collections.Generic;

namespace WikiDemo
{
#region Item

#region Recipe
[RequiresSkill(typeof(CarpentrySkill), 3)]
[Ecopedia("Work Stations", "Craft Tables", subPageName: "Market Stall")]
public partial class MedievalStallRecipe : RecipeFamily
{
[SupportedOSPlatform("windows7.0")]
public MedievalStallRecipe()
{
var recipe = new Recipe();
recipe.Init(
name: "MedievalStallItem",
displayName: Localizer.DoStr("Market Stall"),
ingredients: new List<IngredientElement>
{
new IngredientElement("Wood", 40, typeof(Skill)),
new IngredientElement(typeof(CottonFabricItem), 30, typeof(Skill)),
new IngredientElement(typeof(HempMooringRopeItem), 5, true)
},
items: new List<CraftingElement>
{
new CraftingElement<MedievalStallItem>(1)
}
);
this.Recipes = new List<Recipe> { recipe };
this.LaborInCalories = CreateLaborInCaloriesValue(800, typeof(Skill));
this.CraftMinutes = CreateCraftTimeValue(typeof(MedievalStallRecipe), 10f, typeof(Skill));

// Perform pre/post initialization for user mods and initialize our recipe instance with the display name "Market Stall"
this.ModsPreInitialize();
this.Initialize(displayText: Localizer.DoStr("Market Stall"), recipeType: typeof(MedievalStallRecipe));
this.ModsPostInitialize();

// Register our RecipeFamily instance to a work table (in this case the Carpentry Table) so it can be crafted.
CraftingComponent.AddRecipe(tableType: typeof(CarpentryTableObject), recipeFamily: this); // NOTE: The table must be the object instance!
}

/// <summary>Hook for other mods to customize RecipeFamily before initialization.</summary>
partial void ModsPreInitialize();

/// <summary>Hook for other mods to customize RecipeFamily after initialization, but before registration. You can change skill requirements here.</summary>
partial void ModsPostInitialize();
}
#endregion
}</syntaxhighlight>'''Line 10:''' Eco will need this explicitly added to the file. Visual Studio will not add this line automatically. It's used for the <code>List<T></code> objects found in this code.

'''Line 14:''' "Collapsed" <code>Item</code> section. See the earlier sections in this guide for the code that belongs there.

'''Line 17:''' Sets the required skill and skill level to craft this recipe.

'''Line 21:''' <code>[SupportedOSPlatform("windows7.0")]</code> is here to silence some annoying warnings in Visual Studio. It's optional.

'''Line 30-32:''' Declares the input ingredients used for crafting. <code>typeof(Skill)</code> gets mapped to the <code>CarpentrySkill</code> as defined by line 31. In this example the <code>HempMooringRope</code> is a static input. A static input will not be modified by skills, upgrade modules, or game settings.<br>'''Note:''' It seems that at the time of writing (4/21/2026, Eco v13.0.2) the only way to get an ingredient to be a dynamic value that is reduced by the table's upgrade is to pass <code>typeof(Skill)</code> to it; Passing either <code>true</code> or <code>false</code> makes the this input static.

'''Line 34:''' The <code>items</code> list declares what items are <u>output</u> by this recipe.

'''Line 36:''' This line declares that one medieval stall is output from this recipe. Functionally this links this recipe to the <code>MedievalStallItem</code> (aka "Market Stall") item created in the last step.

'''Line 40:''' Amount of calories needed to craft this item. For a static value (not modified by upgrades or skill levels) change this line to: <code>this.LaborInCalories = CreateLaborInCaloriesValue(800);</code>. As it's written in the example, this item's calorie cost will be dynamic (modified by upgrades and skill levels). The skill level that will modify it is declared on line 16.

'''Line 41:''' Minutes needed to craft. Both static and dynamic values for crafting time can be modified by the world difficulty settings. For a static value change this line to: <code>this.CraftMinutes = CreateCraftTimeValue(10f);</code>. As it's written in the example, this item's craft time will be dynamic.

'''Line 49:''' This line assigns the recipe to a workbench. <u>Do not assign</u> to itself because then the first table could never be made. It's recommend to use a preexisting vanilla table.
=== Checkpoint #2 ===
Check the functionality at this point -- it should be possible to see the recipe in the crafting table.

# Have the <code>.unity3d</code> and the <code>.cs</code> file in the <code>/Eco Server/Mods/UserCode</code> folder.
# Start the server and log in.
# Type <code>/give Carpentry Table</code>.
# Place the Carpentry Table down and interact to see the what can be crafted.
# Find the newly added recipe under the name ''Market Stall.''
# Type <code>/give Basic Upgrade 4</code>.
# Put the basic upgrade into the table.
# Go back to the recipe for the ''Market Stall'' and make sure the Wood and the Cotton fabric inputs now require less, but the Hemp Mooring Rope still is the same.<br>'''Note:''' In case the recipe hasn't changed close that table's window and interact with it again. It should for the recipes to refresh now that the upgrade is in it.

== Create the World Object ==
=== Preparing the 3D Asset ===
# Open <u>Blender</u>.
# Load the 3D object created earlier for icon rendering -- <code>Assets/WikiDemo/MedievalStall - Icon Scene.blend</code>.
# Cleanup the scene...
## Delete any light source. Use the ''Scene Collection'' panel on the top-right side of the screen. These will have a 💡 icon and by default are named something like "sun", "point", "spot" or "area".<br>'''Note:''' If your model is a light source or has one in it, you can leave that light source. The point here is to remove the ambient lights used for icon rendering.
## Delete any camera(s). Again, use the ''Scene Collection'' panel. These have a 🎥 icon and by default are named something like "camera".
# <u>If there are multiple different 3D assets in the scene</u> (like bags, crates, jars, ect.), join them all together...
## Select all of the meshes by holding ''Shift'' and clicking on each one in the ''Scene Collection'' panel (right side of window).<br>'''Tip:''' Quickly select a group of them by selecting one near the top. Then hold ''Shift'', ''Ctrl,'' and click on one near the bottom. This will both the one at the top and the one at the bottom, but also every item in between. Neat!
## Be in ''Layout'' workspace (top toolbar) and in the ''Object Mode...''
### Find the drop down in the second toolbar from the top that has options like ''Object Mode, Edit Mode, Sculpt Mode,'' etc.
### Select ''Object Mode'' from that drop down.
## Find and open the ''Object'' menu (second toolbar down from the top).
## Select ''Join''.
## In the ''Scene Collection'' panel, double click on the name of the newly joined mesh.
# Rename the joined mesh to <code>MedievalStallMesh</code>.
# Add and position a reference cube...
## Make sure the editor is in ''Layout'' view (top toolbar) and in the ''Object Mode...''
### Find the drop down in the second toolbar from the top that has options like ''Object Mode, Edit Mode, Sculpt Mode,'' etc.
### Select ''Object Mode'' from that drop down.
## Then, add a reference cube. Open the ''Add'' menu (second top toolbar down).
## Hover ''Mesh''.
## Select ''Cube.''
## Open the ''View'' menu (second toolbar down).
## Select ''Sidebar''.
## A new panel will have expanded.
## Along the right side of that panel there's buttons (''Item, Tool, View, Animation''). Find and click the ''Item'' button.
## Find and expand the ''Transform'' section
## Set the ''Location...''
### ''X'' to ''1''.
### ''Y'' to ''1''.
### ''Z'' to ''1''.
## The bottom corner of the cube should be touching the where green and red axis lines meet.
# Move the reference cube's origin to <code>(0, 0, 0)</code>...
## Be in ''Layout'' workspace (top toolbar) and in the ''Object Mode...''
### Find the drop down in the second toolbar from the top that has options like ''Object Mode, Edit Mode, Sculpt Mode,'' etc.
### Select ''Object Mode'' from that drop down.
## Open the ''View'' menu (second toolbar down).
## Select ''Sidebar''.
## A new panel will have expanded.
## Along the right side of that panel there's buttons (''Item, Tool, View, Animation''). Find and click the ''View'' button.
## Find and expand the ''3D Cursor'' section.
## Set the 3D cursor's ''Location''...
### ''X'' to ''0''.
### ''Y'' to ''0''.
### ''Z'' to ''0.''
## Now in the ''Scene Collection'' panel, click on the ''Cube'' mesh to highlight and select it.
## Open the ''Object'' menu from the second toolbar down from the top.
## Hover ''Set Origin''.
## Select ''Origin to 3D Cursor''.
# Set the reference cube's dimensions...
## Be in ''Layout'' workspace (top toolbar) and in the ''Object Mode...''
### Find the drop down in the second toolbar from the top that has options like ''Object Mode, Edit Mode, Sculpt Mode,'' etc.
### Select ''Object Mode'' from that drop down.
## Open the ''View'' menu (second toolbar down).
## Select and check the ''Sidebar'' option''.''
## The ''Sidebar'' menu just expanded over on the right side of the screen.
## To the right of the ''Sidebar'', find and click the ''Item'' button.
## Expand the ''Transform'' section.
## Set the ''Dimensions...'''''<br>Note:''' These dimensions only make sense for the asset being used for this guide. If using a different one, set the dimensions to the size of the box that model should fit in.
### ''X'' to ''4''.
### ''Y'' to ''3''.
### ''Z'' to ''3''.
# Adjust the position and scale of the ''MedievalStallMesh'' to fit inside a box.
## Be in ''Layout'' workspace (top toolbar) and in the ''Object Mode...''
### Find the drop down in the second toolbar from the top that has options like ''Object Mode, Edit Mode, Sculpt Mode,'' etc.
### Select ''Object Mode'' from that drop down.
## On the left side of the screen there's a column of icons. Hover over them to see their names.
## Select the ''Move'' tool.
## Click on the Medieval Stall to select it. Zoom out and reposition the camera so that the blue, green, and red arrows are visible.<br>'''Tip:''' By holding the middle-mouse button and dragging the scene will rotate. By holding the middle-mouse button and the ''Shift'' key, the scene will pan.<br>'''Tip:''' If panning or rotating the scene becomes slow or frustrating (especially after zooming), try selecting 3D asset from the ''Scene Collection'' panel, opening the ''View'' menu (second toolbar from top), and selecting ''Frame Selected''. This will reset the view onto that object and controls should feel normal again.
## Click and hold one of the arrows. Move the mouse to drag the 3D asset towards the box.
## Move the 3D asset around till it's <u>completely inside the box</u>. If it cannot fit and is too big, continue to the next step.<br>'''Tip:''' To select the 3D asset once it disappears, use the ''Scene Collection'' panel. Click on it there and the blue, green, and red arrows will show up again for it.<br>'''Tip:''' There are preset views. To use them go to the ''View'' menu (second toolbar from top)'','' hover ''Viewpoint'', and select the view that would be most helpful.
## Find the ''Scale'' tool from the left side of the screen.
## Now the blue, green, and red "arrows" don't really look like arrows anymore. They are lines with boxes at the end.
## Click and hold on those lines to adjust the scale of the 3D asset to make it fit inside the box.<br>'''Tip:''' There are little colored boxes in between the lines that can be dragged to scale the 3D asset more proportionally.
## Continue using the ''Move'' and ''Scale'' tools till the model fits. This will take patience and time.<br>'''Tip:''' Hide the reference cube to see what is happening with the 3D asset. Go to the ''Scene Collections'' panel and click the 👁 button to hide it. Click that button again to show it.
# Move the reference cube's origin to <code>(0.5, 0.5, 0.5)</code>...
## Be in ''Layout'' workspace (top toolbar) and in the ''Object Mode...''
### Find the drop down in the second toolbar from the top that has options like ''Object Mode, Edit Mode, Sculpt Mode,'' etc.
### Select ''Object Mode'' from that drop down.
## Open the ''View'' menu (second toolbar down).
## Select ''Sidebar''.
## A new panel will have expanded.
## Along the right side of that panel there's buttons (''Item, Tool, View, Animation''). Find and click the ''View'' button.
## Find and expand the ''3D Cursor'' section.
## Set the 3D cursor's ''Location''...
### ''X'' to ''0''.5.
### ''Y'' to ''0.5''.
### ''Z'' to ''0.5.''
## Select the ''MedievalStallMesh'' using the ''Scene Collection'' panel.
## Open the ''Object'' menu (second toolbar down).
## Hover ''Set Origin''.
## Select ''Origin to 3D Cursor''.
# Select the reference cube named ''Cube'' from the ''Scene Collections'' panel.
# Open ''Object'' menu (second toolbar down).
# Select ''Delete''.
# Move the ''MedievalStallMesh'' to <code>(0, 0, 0)</code>...
## Be in ''Layout'' workspace (top toolbar) and in the ''Object Mode...''
### Find the drop down in the second toolbar from the top that has options like ''Object Mode, Edit Mode, Sculpt Mode,'' etc.
### Select ''Object Mode'' from that drop down.
## Open the ''View'' menu (second toolbar down).
## Select ''Sidebar''.
## A new panel will have expanded.
## Along the right side of that panel there's buttons (''Item, Tool, View, Animation''). Find and click the ''Item'' button.
## Make sure the ''MedievalStallMesh'' is selected. Use the ''Scene Collection'' panel if needed.
## Find and expand the ''Transform'' section
## Set the ''Location...''
### ''X'' to 0.
### ''Y'' to 0.
### ''Z'' to 0.
# Make sure the ''MedievalStallMesh'' is selected. Use the ''Scene Collection'' panel if needed.
# Open the ''Object'' menu.
# Hover ''Apply''.
# Select ''All Transformations''.<br>'''Note:''' This step bakes all of the changes into the mesh. It's very important.
# Open the ''File'' menu from the top toolbar.
# Hover ''Export'' to open the sub-menu.
# Select ''FBX (.fbx)''
# A ''Blender File View'' window will pop-up.
# On the right side of this window there's a ⚙️ icon. Click it to expand the settings region.
# In the expanded region find the ''Include'' section and expand it. Change the following:
## Find ''Object Types'' and only select ''Mesh.'' No other option should be highlighted for this setting.
# In the settings region scroll and find the ''Transform'' section and expand it. Change the following:
## Find ''Apply Scalings'' and set it to ''FBX All''.
## Just below that find ''Forward'' and set it to ''Z Forward''.
## Ensure that the next setting down, ''Up'', changed to ''Y Up''.
## Find ''Apply Unit'' and make sure it's checked.
## Next, find ''Use Space Transform'' check it.
## Lastly, find ''Apply Transform'' and check it too.
# Save it to <code>Assets/WikiDemo/MedievalStall.fbx</code>.
# Save the Blender scene...
## ''File'' drop down from top toolbar.
## ''Save As...'' to save the Blender scene to the computer.
## Save it to <code>Assets/WikiDemo/MedievalStall - Eco Ready Scene.blend</code>.

=== Add to Unity Scene ===

# Open <u>Unity</u>.
# Select the <code>.fbx</code> file in the project window.
# Open the ''Eco Tools'' menu from the top toolbar.
# Hover ''Mod Kit''.
# Select ''World Object Setup.''
# A ''World Object Setup'' window will pop-up.
# Make sure that ''Selected Objects'' reads ''MedievalStall.''
# Also make sure that ''World Object Type'' is set to ''World Object''.
# Press the ''Setup World Objects'' button.
# Notice in the project window that a new <code>.prefab</code> file was created -- <code>MedievalStallObject.prefab</code>
# Select the <code>.prefab</code>.
# In the ''Inspector'' panel find the ''Transform'' component.
# Change this component's ''Rotation...''
## ''X'' to ''0.''
## ''Y'' to ''0.''
## ''Z'' to ''0.''
# In the ''Inspector'' panel find the ''Box Collider'' component.
#Find the ''⋮'' icon (all the way to the right of the words ''Box Collider)'' and click on it.
#Select ''Reset'' from the menu. This will regenerate the box collider now that the rotation has changed.
#Look in the ''Inspector'' panel and find the ''World Object (Script)'' component.
# That component has a checkbox ''Override Occupancy''. Check it.
# A new field should've expanded below it called ''Size''.
# Set the ''Size''...<br>'''Note:''' This size similar to the size of the reference cube from earlier, but the Y and Z coordinates get flipped! So if in Blender it was <code>(1, 2, 3)</code> then in Unity its <code>(1, 3, 2)</code>.
## ''X'' to ''4''.
## ''Y'' to ''3''.
## ''Z'' to ''3''.
# Select ''Objects'' from ''Hierarchy'' panel (left-side of the window).
# Find the ''Modkit Prefab Container (Script)'' component. This component was added earlier, if it's not there add it now.
# Expand the ''Prefabs'' section in that component.
# Click the ''+'' button to add an item to the list.
# Either...
## Click the ''⦿'' button, switch to the ''Assets'' tab, find or search for ''MedievalStallObject'', and double click on it. Make sure it's the medieval stall <u>object</u> with the <code>.prefab</code> ending.
## Drag the <code>.prefab</code> file onto the ''⦿'' button
# Open the ''File'' menu from top toolbar and select ''Save''.<br>'''Note:''' Do not skip. The scene must be saved for the ModKit build to work properly.
# Open the ''Eco Tools'' menu from the top toolbar.
# Hover ''Mod Kit''.
# Select ''Build Current Bundle''.
# Save the bundle to <code>/Eco Server/Mods/UserCode/WikiDemo.unity3d</code>

=== Coding the World Object ===
The following collapses the <code>#region Recipe</code>. Please see the earlier section [[#Code the Item's Recipe|Code the Item's Recipe]] to get the code that belongs there.

Add the new <code>using</code> lines, replace the <code>#region Item</code> section, and replace the <code>#region Object</code> sections using the following:<syntaxhighlight lang="c#" line="1">using Eco.Core.Items;
using Eco.Gameplay.Components;
using Eco.Gameplay.Items;
using Eco.Gameplay.Items.Recipes;
using Eco.Gameplay.Objects;
using Eco.Gameplay.Skills;
using Eco.Mods.TechTree;
using Eco.Shared.Localization;
using Eco.Shared.Serialization;
using System.Collections.Generic;
using System.Runtime.Versioning;
using System;
using Eco.Core.Controller;
using Eco.Gameplay.Systems.NewTooltip;
using Eco.Shared.Items;
using Eco.Gameplay.Occupancy;
using Eco.Shared.Math;
using Eco.Gameplay.Components.Auth;

namespace WikiDemo
{
#region Item
[Serialized] // Tells the save/load system this object needs to be serialized.
[SupportedOSPlatform("windows7.0")]
[LocDisplayName("Market Stall")] // Defines the localized name of the item.
[Weight(3000)] // Defines how heavy this is.
[Ecopedia("Work Stations", "Craft Tables", createAsSubPage: true)]
[LocDescription("A medieval market stall.")] //The tooltip description for the item.
public partial class MedievalStallItem : WorldObjectItem<MedievalStallObject>, IPersistentData
{
[Serialized, SyncToView, NewTooltipChildren(CacheAs.Instance, flags: TTFlags.AllowNonControllerTypeForChildren)] public object? PersistentData { get; set; }

protected override OccupancyContext GetOccupancyContext => new SideAttachedContext(
DirectionAxisFlags.Down, // Read: every occupied block on the bottom must be supported
WorldObject.GetOccupancyInfo(this.WorldObjectType)
);
}
#endregion

#region Recipe

#region Object
[Serialized]
[SupportedOSPlatform("windows7.0")]
[RequireComponent(typeof(CraftingComponent))]
[RequireComponent(typeof(MinimapComponent))]
[RequireComponent(typeof(LinkComponent))]
[RequireComponent(typeof(OccupancyRequirementComponent))]
[Tag("Usable")]
[Ecopedia("Work Stations", "Craft Tables", subPageName: "Market Stall")]
public partial class MedievalStallObject : WorldObject, IRepresentsItem
{
public Type RepresentedItemType => typeof(MedievalStallItem);

static MedievalStallObject()
{
WorldObject.AddOccupancy<MedievalStallObject>(CalculateBoxOccupancy(4, 3, 3));
}

protected override void Initialize()
{
this.ModsPreInitialize();
this.GetComponent<LinkComponent>().Initialize(15);
this.GetComponent<MinimapComponent>().SetCategory(Localizer.DoStr("Crafting"));
this.ModsPostInitialize();
}

/// <summary>Hook for mods to customize WorldObject before initialization. You can change housing values here.</summary>
partial void ModsPreInitialize();
/// <summary>Hook for mods to customize WorldObject after initialization.</summary>
partial void ModsPostInitialize();

/// <summary>
/// Calculates the blocks that this item will occupy when placed. All coordinates are offsets relative to this 3D model's origin
/// point. This function can only be used to calculate a box shape; there can be no gaps. All blocks will be of the
/// BlockOccupancyType.None type.
/// </summary>
///
/// Examples:
/// * Imagine a 1x1x1 cube. The origin point of the 3D model is the middle of the bottom-left cube. The only block the
/// cube would occupy would be the same one the origin point is in. In offset coordinates, the only block the cube occupies
/// is (0,0,0) from the origin point.
/// * Image a 1x5x1 flag pole. Again the origin point of the 3D model is in the middle of the bottom most cube. The only
/// blocks the flage pole occupies is the one the origin point is in and the 4 above that one. In offset coordinates, that
/// would be (0,0,0) + (0,1,0) + (0,2,0) + (0,3,0) + (0,4,0).
/// <returns></returns>
private static List<BlockOccupancy> CalculateBoxOccupancy(int sizeX, int sizeY, int sizeZ)
{
var cells = new List<BlockOccupancy>(sizeX * sizeY * sizeZ);
for (int x = 0; x < sizeX; x++)
for (int y = 0; y < sizeY; y++)
for (int z = 0; z < sizeZ; z++)
cells.Add(new BlockOccupancy(new Vector3i(x, y, z)));
return cells;
}
}
#endregion
}
</syntaxhighlight>'''Line 30:''' This changes from implementing <code>Item</code> to <code>WorldObjectItem<MedievalStallObject></code>. This is what tell Eco that this item has the ability to place a world object into the world.

'''Line 32:''' This defines the object where <code>PersistentData</code> is stored. Other components like a ''PartsComponet'' would store the information of the table parts' durability in here. in this example, this line is illustrative and doesn't have any components using it.

'''Line 34:''' Sets the type of occupancy context this world object has. Occupancy is the system used to determine what space blocks and object are in. The <code>SideAttachContext</code> means that this object must have a certain side supported for it to be attached to the world and valid to be placed.

'''Line 35:''' Defines the bottom side as the side this object uses to attach.

'''Line 36:''' This line is getting the list of blocks occupied from a static lookup in <code>WorldObject</code> for the <code>MedievalStallObject</code>. See line 60 to see this value set.

'''Line 41:''' The "collapsed" Recipe section. See earlier sections in this guide to see what code belongs here.

'''Line 46:''' Adds a <code>CraftComponent</code> to the table. This component lets players use this table to craft something on.

'''Line 47:''' <code>MinimapComponent</code> this registers the object with the minimap. This makes it so when a player places a medieval stall, the minimap shows it. Related: line 67.

'''Line 48:''' <code>LinkComponent</code> allows storage linking. Related: line 66.

'''Line 49:''' <code>OccupancyRequirementComponent</code> defines this object as having and occupying physical space. Related: line 60.

'''Line 50:''' Assigns a tag to this object. Like how the tag ''Wood'' in Eco refers to all the different types of logs. In this case, the ''MedievalStallObject'' is being added to the <code>Usable</code> tag.

'''Line 52:''' Declares the <code>MedievalStallObject</code>. It's important that this class name is matches exactly the <code>.prefab</code> file name because the name is what links them.

'''Line 54:''' Declares the item that is given when this world object is picked up.

'''Line 58:''' This sets the occupancy for the world object in the simulation. This must also be set for the object in addition to the ''Override Occupancy'' and ''Size'' setting previously set on the Unity <code>.prefab</code>. That's because the settings in Unity are used client side. This sets the occupancy on the server side. They both need to be set and be matching for things to work right.

'''Line 64:''' Initializes the <code>LinkComponent</code> with a base 15 block radius. Know that this value is just the base value and that server settings will determine the actual game play radius.

'''Line 65:''' Initializes the <code>MinimapComponent</code> and add this object to the <code>Crafting</code> category.

=== Checkpoint ===

[[File:WikiDemo - Medieval Stall - Checkpoint -3.png|thumb|The Medieval Stall modded into Eco.]]
'''Warning:''' In ''Eco'' v13.0.2, free-placed objects may display misaligned ghost cubes, even when configured correctly in your mod. This is a visual-only base-game bug — placement still works as expected, even if the object appears red near edges. 

# Have the <code>.unity3d</code> and the <code>.cs</code> file in the <code>/Eco Server/Mods/UserCode</code> folder.
# Start the server and log in.
# Type <code>/give MedievalStall</code>.
# Place the stall down. '''Pro-tip:''' Put down a floor of <u>flat roof</u> tiles made of ''Reinforced Concrete''. This will show you where the occupancy of your object is when you place it because the roof tiles will change shape under the object. Neat!
# It should look and function like a normal workbench.

The <code>WikiDemo.unity3d</code> and the <code>WikiDemo.cs</code> files are all that is needed to share this mod now.

= Adding a Recipe to Craft =
To add a recipe to the medieval stall add this to the <code>WikiDemo.cs</code> file:<syntaxhighlight lang="c#" line="1">
using Eco.Core.Items;
using Eco.Gameplay.Components;
using Eco.Gameplay.Items;
using Eco.Gameplay.Items.Recipes;
using Eco.Gameplay.Objects;
using Eco.Gameplay.Skills;
using Eco.Mods.TechTree;
using Eco.Shared.Localization;
using Eco.Shared.Serialization;
using System.Collections.Generic;
using System.Runtime.Versioning;
using System;
using Eco.Core.Controller;
using Eco.Gameplay.Systems.NewTooltip;
using Eco.Shared.Items;
using Eco.Gameplay.Occupancy;
using Eco.Shared.Math;
using Eco.Gameplay.Components.Auth;

namespace WikiDemo
{
#region Item

#region Recipe

#region Object

#region CraftingRecipes
public partial class MyArrowRecipe : RecipeFamily
{
[SupportedOSPlatform("windows7.0")]
public MyArrowRecipe()
{
var recipe = new Recipe();
recipe.Init(
name: "Alternate Arrow",
displayName: Localizer.DoStr("Alternate Arrow"),
ingredients: new List<IngredientElement>
{
new IngredientElement("Wood", 1, typeof(Skill)),
new IngredientElement("Rock", 1)
},
items: new List<CraftingElement>
{
new CraftingElement<ArrowItem>(1)
}
);
this.Recipes = new List<Recipe> { recipe };
this.LaborInCalories = CreateLaborInCaloriesValue(10);
this.CraftMinutes = CreateCraftTimeValue(0.1f);

// Perform pre/post initialization for user mods and initialize our recipe instance with the display name "Market Stall"
this.ModsPreInitialize();
this.Initialize(displayText: Localizer.DoStr("Alternate Arrow Recipe"), recipeType: typeof(MyArrowRecipe));
this.ModsPostInitialize();

// Register our RecipeFamily instance to a work table (in this case the Carpentry Table) so it can be crafted.
CraftingComponent.AddRecipe(tableType: typeof(MedievalStallObject), recipeFamily: this); // NOTE: The table must be the object instance!
}

/// <summary>Hook for other mods to customize RecipeFamily before initialization.</summary>
partial void ModsPreInitialize();

/// <summary>Hook for other mods to customize RecipeFamily after initialization, but before registration. You can change skill requirements here.</summary>
partial void ModsPostInitialize();
}
#endregion
}
</syntaxhighlight>
[[File:WikiDemo MedievalStall AltArrowRecipe.png|thumb|Shows a new recipe added to the crafting tab of the Medieval Stall.]]
'''Line 58:''' This line here adds this recipe to the <code>MedievalStallObject</code> just created.

Mod Development

2026-04-29T00:20:44Z

WugWugg: Updated Player Contributed Written Guides

<div class="container-fluid">
<div class="row">[[File:EcoModKit.jpg|class=headbanner|link=]]</div>
</div>

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 [https://github.com/StrangeLoopGames/EcoModKit EcoModKit] repository.
== Documentation ==
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}}.

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.

== 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]]
* [[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]
* [[Getting Started with Eco Modding in Visual Studio 2022]]
* [[Helpful Examples for Modding]]
* [[From 3D Asset to Working Worktable]]
== 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>

== 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]
[[Category: Modding]]

From 3D Asset to Working Worktable

2026-04-29T00:19:23Z

WugWugg: Done. This guide is long and probably too repetitive, but it will produce results!

= Introduction =
Below is a guide on how to take an 3D asset from the Unity Store and make a working workbench in Eco. This includes:
* Creating a recipe to craft the modded table
* Creating recipes so the player can use the modded table to craft something
* Using Blender to generate a modded icon (seen when holding it in inventory)
* Using Blender to adjust the origin point of the model
* How to setup all this in a Unity scene and package for Eco

= Setup =

* Already have setup '''ModKit + Unity'''
** See: [[Installing the ModKit]]
* Have a '''3D model'''
** Just following along? Find the one used here at <code><nowiki>https://assetstore.unity.com/packages/3d/props/low-poly-medieval-market-stalls-314286</nowiki></code>
* A '''C# IDE''' (notepad++, Visual Studio, etc.)
** Highly encouraged to have an Intellisense setup and linked to the '''Reference Assemblies'''. Optional, but its really worth the time to figure out because it will help quickly correct small typos and trivial mistakes.
** See: [[Getting Started with Eco Modding in Visual Studio 2022]] (generally the same steps apply if using a new version of Visual Studio)
* '''Blender''' installed
** Homepage: <code><nowiki>https://www.blender.org/</nowiki></code>

== Importing the Assets ==

# Open the Unity editor to the project.
# From the top toolbar open the ''Window'' drop down.
# Hover ''Package Management'' to open sub-menu.
# Select ''Package Manager''.
# The ''Package Manager'' window will pop-up.
# Install the package containing the assets you want to use...
## <u>If not using Unity Registry</u>...
### Find the ''+▾'' button in the top left and open the drop down.
### Install the package from one of those options.
## <u>If using Unity Registry</u>...
### Visit <code><nowiki>https://assetstore.unity.com</nowiki></code> and sign in.
### Search for the asset desired.
### Go to it's page (e.g. <code><nowiki>https://assetstore.unity.com/packages/3d/props/low-poly-medieval-market-stalls-314286</nowiki></code>) and click the big blue button, ''Add to My Assets.''
### Now, in the Unity editor and back at the ''Package Manager'' window.
### Find ''My Assets'' on the left menu and navigate to it.
### Click the ''⟳'' button in the lower-right.
### The asset should be in the list now. Use the search to filter if needed.
### Click on the asset in the list. For those following along, ''Low Poly Medieval Market Stalls''.
### In the right panel, find the ''Download ⤓'' button. Click it.
### Once downloaded, a new button should show up, it'll say something like ''⊕ Import 1.0 to project'' . Click it.
### The ''Import Unity Package'' window will pop-up.
### Select ''Import'' on it.
# Verify you can find your assets from the explorer. If following along, the assets are at <code>Assets/PolyRonin/Medieval Market Stalls</code>.
# Load in a demo scene, if provided, and make sure everything looks okay.
## For those following along, double click on the ''Demo'' scene at <code>Assets/PolyRonin/Medieval Market Stalls/Demo.unity</code>.

[[File:Eco - Unity - View Modes.png|thumb|Underlined in red are the different draw mode buttons. <u>4/20/26</u>]]
If something seems off, check the different draw modes and see if changing those allow the scene to render as expected (see picture).

= Creating The Worktable =
This guide will create the worktable in this order:

# Create the item that represents the worktable
# Make a recipe to craft the worktable item
# Make the worktable item something that places a world object
# Give the worktable functionality by adding recipes to it

== Creating the Item ==

=== Item Icon ===
[[File:TeamstersStall - StallOnly - 256x256.png|thumb|A large (256x256px) icon created of Stall4 from the medieval assets.]]
# Open <u>Blender</u>.
# Delete everything in the ''Scene Collection''. Find this section in the top-right of the application.
# From the top toolbar, open the ''File'' drop down.
# Hover ''Import'' to open the sub-menu.
# Select the type of 3D asset. For those using medieval assets, select ''FBX (.fbx)''.
# Find the asset on the computer...<br>'''Tip:''' Use Unity to find the <code>.fbx</code> asset.
## For the medieval assets, that's in <code>Assets/PolyRonin/Medieval Market Stalls/Meshes/medieval-market-stalls-1.fbx</code>.
## Right click on it and select ''Show in explorer''.
## Now copy the address of that folder from Explorer. It might look like <code>C:\Users\Wug\EcoMod--WikiDemo\WikiDemo\Assets\PolyRonin\Medieval Market Stalls\Meshes</code>.
## Paste that in the address bar of the <u>Blender</u> import pop-up.
# Select the blue ''Import FBX'' button''.''
# Be in the ''Layout'' workspace (top toolbar) and in the ''Object Mode...''
## Find the drop down in the second toolbar from the top that has options like ''Object Mode, Edit Mode, Sculpt Mode,'' etc.
## Select ''Object Mode'' from that drop down.
# Change the Viewport Shading to Material Preview or Rendered. This is on the second toolbar down, far right of center, but before ''Scene Collection'' section.
# If you see purple models, Blender will need help finding textures for these meshes...
## From the top toolbar, open the ''File'' drop down.
## Hover ''External Data'' to open the sub-menu.
## Select ''Find Missing Files...''
## Point this to the whole directory that the 3D assets came in. For the medieval pack, <code>C:\Users\</code><code>Wug\EcoMod--WikiDemo\WikiDemo\Assets\PolyRonin</code>.
## The proper textures/materials should have now loaded in. If it hasn't, consult Google because without the textures the following steps won't produce a usable icon.
# Add a source of light...
## Still be in the ''Layout'' workspace (top toolbar) and in the ''Object Mode...''
### Find the drop down in the second toolbar from the top that has options like ''Object Mode, Edit Mode, Sculpt Mode,'' etc.
### Select ''Object Mode'' from that drop down.
## From the toolbar just under that one, find and open the ''Add'' drop down.
## Hover ''Light'' to open that sub-menu.
## Click ''Sun''.
# Add a camera...
## In the ''Layout'' workspace (top toolbar) and in the ''Object Mode...''
### Find the drop down in the second toolbar from the top that has options like ''Object Mode, Edit Mode, Sculpt Mode,'' etc.
### Select ''Object Mode'' from that drop down.
## From the second toolbar down, find and open the ''Add'' drop down.
## Select ''Camera''.
# Setup the scene with the object placement and lighting direction desired.<br>'''Tip:''' To reset the editor to something selected press the period key <u>on the numpad</u>. Without a numpad, use ''View'' (second toolbar from the top) and select ''Frame Selected'' from it. Alternatively, just set the zoom to zoom to the mouse position: ''Edit'' (top toolbar), ''Preferences'' (from drop down), ''Navigation'' (on left menu), ''Zoom to Mouse Position'' (In the zoom section). This makes moving around a lot more natural feeling.
# Setup the rendering camera...
## Go to ''Rendering'' tab on the top toolbar
## On the right there will be a side-panel open, it should be the ''Render'' tab. Confirm that.
## Change ''Render Engine'' to ''Cycles''.
## Look down below in the same tab for the ''Film'' section.
## Expand it and find the ''Transparent'' checkbox and section. Click it so that it has a check mark. This will make the icon's background transparent.
## Now, go to the ''Output'' tab <u>on the side panel</u>. The tab is just below the current one.
## In the ''Format'' section set ''Resolution X'' to ''64.'' And ''Y'' to ''64'' as well. This will make the icon generated a 64 by 64 pixel image.
# Go back to the ''Layout'' tab from the top toolbar.
# Center your view on the object (numpad period or ''View > Frame Selected''). Adjust it so that the object is how it should be for the icon.
# Align the camera to the view...
## Make sure the editor is in ''Layout'' workspace (top toolbar) and in the ''Object Mode...''
### Find the drop down in the second toolbar from the top that has options like ''Object Mode, Edit Mode, Sculpt Mode,'' etc.
### Select ''Object Mode'' from that drop down.
## Find ''View'' from the second from the top toolbar and open the drop down.
## Hover ''Align View'' to open the sub-menu.
## Select ''Align Active Camera To View''.
## If the view is slightly off, there is a lock icon on the right side of this panel. Use it to "lock" controls to the camera and tweak it's view.
# Now return to the ''Rendering'' tab from the top toolbar.
# Press the F12 key to start the render. This should complete quickly since 64x64 pixels is a very small render.
# A window should popup, ''Blender Render''. This is the icon!
# From the top tool bar of this ''Blender Render'' window, open the ''Image'' drop down.
# Select ''Save As...'' to save somewhere on the computer.
# Return to step 13 and repeat to do larger images if desired. Create a 128 by 128 pixel image too. It will make things smoother later.
# Save the Blender scene. Not only will it be used later, this will make making a new icon with a small tweak that much easier.
## ''File'' drop down from top toolbar.
## ''Save As...'' to save the Blender scene to the computer.
## Save it to <code>Assets/WikiDemo/MedievalStall - Icon Scene.blend</code>.

=== Adding to Unity Scene ===
The developers explain how to create an item in one of ModKit's read me files (See: <code>Assets/EcoModKit/Docs/README.md</code>), but this guide will explain it below.

Additionally, '''TheKye''' on YouTube covers this in their ''Creating Your First Item'' and ''Creating Your First Item Pt 2'' videos.

Use those additional resource to help troubleshoot issues with item's icons.

# Open <u>Unity</u>.
# In the left panel, the ''Hierarchy'' tab should be selected.
# Select the top-most object there. It should be a scene. If the editor last loaded the ''Demo'' scene from the medieval assets, it'll be named ''Demo''.
# Right click on this scene and select ''Add New Scene'' from the menu.
# Right click again on the old scene (''Demo'') and select ''Remove Scene''.
# Let it save if the changes to the old scene are important. Discard if it was open just for exploration's sake.
# Right click the new, ''Untitled'' scene. Click ''Save Scene As...''
# Save it to <code>Assets/WikiDemo.unity</code>.
# Delete <u>anything</u> in the scene.
# Right click the scene, hover ''GameObject'', and select ''Create Empty'' from the sub-menu.
# Name this new object ''Objects''.
# Select the newly created ''Objects'' object from the ''Hierarchy'' menu.
# On the far right side of the screen, in the ''Inspector'' menu, click the ''Add Component'' button.
# Type in ''ModkitPrefabContainer''. Click on the component from the search to add it. The component now should be listed in the ''Inspector''.
# In the ''Hierarchy'' panel right click the scene, hover ''GameObject'', and select ''Create Empty''.
# Name this new object ''Items''.
# Right click the scene, hover ''GameObject'', and select ''Create Empty''.
# Name this new object ''Emoji''.
# Select the newly created ''Emoji'' object, find the ''Inspector'' menu (far-right), and click the ''Add Component'' button.
# Type in ''ChatEmoteSetOld''. Click on the component from the search to add it. That component should now be listed in the ''Inspector''.
# Right click the scene, hover ''GameObject'', and select ''Create Empty''.
# Name this new object ''BlockSets''.
# Select the newly created ''BlockSets'' object, find the ''Inspector'' menu (far-right), and click ''Add Component''.
# Search for ''BlockSetContainer''. Click on the component from the search to add it. The ''Inspector'' should now show that component as added.
#Go to <code>Assets/EcoModKit/Prefabs</code> in the Unity project window.
# Find the prefab ''ItemTemplate''.
# Drag it onto the ''Items'' object in the ''Hierarchy'' panel. It should add it as a <u>child</u> of the ''Items'' object.
# Right click on the new ''ItemTemplate'' object, hover ''Prefab'', and select ''Unpack Completely''.
# Right click on the ''ItemTemplate'' object and select ''Rename''. Name this what you want the item to be called. Example: ''MedievalStallItem''.
# Set this item's background...
## Here's the default backgrounds (blue = item, brown = block, green = food): <br>[[File:Eco - Item - Background.png|border|frameless]] [[File:Eco - Block - Background.png|frameless]] [[File:Eco - Food - Background.png|frameless]]
## Download or prepare the background and add it to the <code>Assets</code> folder in Unity.
### To follow along lockstep, put the background in a new <code>Assets/WikiDemo</code> folder.
### Right click on <code>Assets</code> folder, hover ''Create'', select ''Folder''.
### Name the folder ''WikiDemo''.
## Configure Unity to use these as sprites...
### Select the background(s) added (Ctrl+Click each one).
### In the ''Inspector'', find ''TextureType'' and change that to ''Sprite (2D and UI)''.
### Again in the ''Inspector'', find ''SpriteMode'' and change that to ''Single''.
### Then scroll and go to the bottom of the ''Inspector'' and find the ''Apply'' button.
### This will apply those changes to that file and all other ones highlighted.
## Select the item being created (''MedievalStallItem'').
## In the ''Inspector'' panel (far-right), scroll and find the ''Item Template (Script)'' section.
## In here find the ''Background'' input. It'll say ''Background (Image)'' in it. If clicked that text to reveal and highlight the related object in the ''Hierarchy'' panel.
## Select the revealed, and highlighted object ''Background''.
## In the ''Inspector'' panel, scroll and find the ''Image'' component section.
## Inside that component's section, find ''Source Image''. It'll say ''Missing (Sprite)''. Click the ''⦿'' button to the right.
## The ''Select Sprite'' popup will show. Make sure the ''Assets'' tab is selected, and find the backgrounds desired.
#Create the foreground image...
##This is easily accomplished in MS Paint.
##Get to the background image file in a <u>file explorer</u>.
##Right click on it, hover ''Open with...'', and select ''Paint''.
##The solid background should be displayed.
##Open the ''File'' menu from the top toolbar.
##Hover ''Import to Canvas'' and select ''From a File''.
##Find the icon in the file browser and import it. Match the size of the background image to have it nicely center itself.
##Now ''File'' from the top toolbar.
##Hover ''Save As...'' and select ''PNG''.
##Save this to the <code>Assets/WikiDemo</code> folder in Unity.
##Configure Unity to use these as sprites...
### Select the foreground image.
### In the ''Inspector'', find ''TextureType'' and change that to ''Sprite (2D and UI)''.
### Again in the ''Inspector'', find ''SpriteMode'' and change that to ''Single''.
### Then scroll and go to the bottom of the ''Inspector'' and find the ''Apply'' button.
### This will apply those changes to that file and all other ones highlighted.
#Set this item's foreground...
## Copy the item's icon into the <code>Assets</code> folder.
## Configure Unity to use it as a sprite (see the previous step's ''Set this item's background...'' instructions)
## Select the item being created (''MedievalStallItem'').
## In the ''Inspector'' panel (far-right), scroll and find the ''Item Template (Script)'' section.
## In here find the ''Foreground'' input. It'll say ''Foreground (Image)'' in it. If clicked that text to reveal and highlight the related object in the ''Hierarchy'' panel.
## Select the revealed, and highlighted object ''Foreground''.
## Use the ''Inspector'', find the ''Image'' component, within that component find the ''Source Image'' input. It will say ''Missing (Sprite)''.
## Click the ''⦿'' button to the right of that input.
## From the ''Select Sprite'' popup, ensure the ''Assets'' tab is being searched, and find the icon just created.

=== Export From Unity ===

# Open the ''File'' menu from the top toolbar.
# Select ''Save.'' Save it to the <code>Assets/WikiDemo</code> folder.<br>'''Note:''' Do not skip. The scene must be saved for the ModKit build to work properly.
# Open the ''Eco Tools'' menu from the top toolbar.
# Hover ''Mod Kit'' to open the sub-menu.
# Select ''Build Current Bundle''.
# Have it output the bundle to <code>/Eco Server/Mods/UserCode/WikiDemo.unity3d</code>
# Wait for this to build. This may take a few minutes.

=== Coding the Item ===
For this guide, all code will be placed in a single <code>.cs</code> file and will not be compiled into a <code>.dll</code>.

# Create a <code>.cs</code> file: <code>/Eco Server/Mods/UserCode/WikiDemo.cs</code>
# Put the following into the newly created file:
<syntaxhighlight lang="c#" line="1">using Eco.Core.Items;
using Eco.Gameplay.Items;
using Eco.Shared.Localization;
using Eco.Shared.Serialization;

namespace WikiDemo
{
#region Item
[Serialized] // Tells the save/load system this object needs to be serialized.
[LocDisplayName("Market Stall")] // Defines the localized name of the item.
[Weight(100)] // Defines how heavy this is.
[Ecopedia("Work Stations", "Craft Tables", createAsSubPage: true)]
[LocDescription("A medieval market stall.")] //The tooltip description for the item.
public partial class MedievalStallItem: Item { }
#endregion
}</syntaxhighlight>'''Line 8:''' A region tag. Lets the editor know it can collapse all of that code as a section. The following examples in this guide will just show <code>#region Item</code> in their code examples.

'''Line 13:''' The implementation of <code>Item</code> means that Eco will find this and look for Unity assets that matching this class' name, <code>MedivalStallItem</code>. While this doesn't do anything fancy, it completes the first step towards a new workbench.

=== Checkpoint #1 ===
[[File:Eco - Hotbar With Modded Icon.png|thumb|Shows the medieval stall as a modded icon in-game.]]
Make sure everything is running smoothly by doing the following:

# Double-check that the <code>WikiDemo.unity3d</code> and the <code>WikiDemo.cs</code> files are in <code>/Eco Server/Mods/UserCode</code> folder.
# Start the server and connect to it.
# Test it out by typing <code>/give MedievalStall</code> in chat.
## It's also possible to do <code>/give Market Stall</code> to get the item. How? Line 10: of the the above code declares that name as this item's "common name". Neat.
# The item should appear in the players inventory with a working icon.

== Code the Item's Recipe ==
The following goes over how to add a new class and implement the <code>RecipeFamily</code> interface.<syntaxhighlight lang="c#" line="1">using Eco.Core.Items;
using Eco.Gameplay.Components;
using Eco.Gameplay.Items;
using Eco.Gameplay.Items.Recipes;
using Eco.Gameplay.Skills;
using Eco.Mods.TechTree;
using Eco.Shared.Localization;
using Eco.Shared.Serialization;
using System.Runtime.Versioning;
using System.Collections.Generic;

namespace WikiDemo
{
#region Item

#region Recipe
[RequiresSkill(typeof(CarpentrySkill), 3)]
[Ecopedia("Work Stations", "Craft Tables", subPageName: "Market Stall")]
public partial class MedievalStallRecipe : RecipeFamily
{
[SupportedOSPlatform("windows7.0")]
public MedievalStallRecipe()
{
var recipe = new Recipe();
recipe.Init(
name: "MedievalStallItem",
displayName: Localizer.DoStr("Market Stall"),
ingredients: new List<IngredientElement>
{
new IngredientElement("Wood", 40, typeof(Skill)),
new IngredientElement(typeof(CottonFabricItem), 30, typeof(Skill)),
new IngredientElement(typeof(HempMooringRopeItem), 5, true)
},
items: new List<CraftingElement>
{
new CraftingElement<MedievalStallItem>(1)
}
);
this.Recipes = new List<Recipe> { recipe };
this.LaborInCalories = CreateLaborInCaloriesValue(800, typeof(Skill));
this.CraftMinutes = CreateCraftTimeValue(typeof(MedievalStallRecipe), 10f, typeof(Skill));

// Perform pre/post initialization for user mods and initialize our recipe instance with the display name "Market Stall"
this.ModsPreInitialize();
this.Initialize(displayText: Localizer.DoStr("Market Stall"), recipeType: typeof(MedievalStallRecipe));
this.ModsPostInitialize();

// Register our RecipeFamily instance to a work table (in this case the Carpentry Table) so it can be crafted.
CraftingComponent.AddRecipe(tableType: typeof(CarpentryTableObject), recipeFamily: this); // NOTE: The table must be the object instance!
}

/// <summary>Hook for other mods to customize RecipeFamily before initialization.</summary>
partial void ModsPreInitialize();

/// <summary>Hook for other mods to customize RecipeFamily after initialization, but before registration. You can change skill requirements here.</summary>
partial void ModsPostInitialize();
}
#endregion
}</syntaxhighlight>'''Line 10:''' Eco will need this explicitly added to the file. Visual Studio will not add this line automatically. It's used for the <code>List<T></code> objects found in this code.

'''Line 14:''' "Collapsed" <code>Item</code> section. See the earlier sections in this guide for the code that belongs there.

'''Line 17:''' Sets the required skill and skill level to craft this recipe.

'''Line 21:''' <code>[SupportedOSPlatform("windows7.0")]</code> is here to silence some annoying warnings in Visual Studio. It's optional.

'''Line 30-32:''' Declares the input ingredients used for crafting. <code>typeof(Skill)</code> gets mapped to the <code>CarpentrySkill</code> as defined by line 31. In this example the <code>HempMooringRope</code> is a static input. A static input will not be modified by skills, upgrade modules, or game settings.<br>'''Note:''' It seems that at the time of writing (4/21/2026, Eco v13.0.2) the only way to get an ingredient to be a dynamic value that is reduced by the table's upgrade is to pass <code>typeof(Skill)</code> to it; Passing either <code>true</code> or <code>false</code> makes the this input static.

'''Line 34:''' The <code>items</code> list declares what items are <u>output</u> by this recipe.

'''Line 36:''' This line declares that one medieval stall is output from this recipe. Functionally this links this recipe to the <code>MedievalStallItem</code> (aka "Market Stall") item created in the last step.

'''Line 40:''' Amount of calories needed to craft this item. For a static value (not modified by upgrades or skill levels) change this line to: <code>this.LaborInCalories = CreateLaborInCaloriesValue(800);</code>. As it's written in the example, this item's calorie cost will be dynamic (modified by upgrades and skill levels). The skill level that will modify it is declared on line 16.

'''Line 41:''' Minutes needed to craft. Both static and dynamic values for crafting time can be modified by the world difficulty settings. For a static value change this line to: <code>this.CraftMinutes = CreateCraftTimeValue(10f);</code>. As it's written in the example, this item's craft time will be dynamic.

'''Line 49:''' This line assigns the recipe to a workbench. <u>Do not assign</u> to itself because then the first table could never be made. It's recommend to use a preexisting vanilla table.
=== Checkpoint #2 ===
Check the functionality at this point -- it should be possible to see the recipe in the crafting table.

# Have the <code>.unity3d</code> and the <code>.cs</code> file in the <code>/Eco Server/Mods/UserCode</code> folder.
# Start the server and log in.
# Type <code>/give Carpentry Table</code>.
# Place the Carpentry Table down and interact to see the what can be crafted.
# Find the newly added recipe under the name ''Market Stall.''
# Type <code>/give Basic Upgrade 4</code>.
# Put the basic upgrade into the table.
# Go back to the recipe for the ''Market Stall'' and make sure the Wood and the Cotton fabric inputs now require less, but the Hemp Mooring Rope still is the same.<br>'''Note:''' In case the recipe hasn't changed close that table's window and interact with it again. It should for the recipes to refresh now that the upgrade is in it.

== Create the World Object ==
=== Preparing the 3D Asset ===
# Open <u>Blender</u>.
# Load the 3D object created earlier for icon rendering -- <code>Assets/WikiDemo/MedievalStall - Icon Scene.blend</code>.
# Cleanup the scene...
## Delete any light source. Use the ''Scene Collection'' panel on the top-right side of the screen. These will have a 💡 icon and by default are named something like "sun", "point", "spot" or "area".<br>'''Note:''' If your model is a light source or has one in it, you can leave that light source. The point here is to remove the ambient lights used for icon rendering.
## Delete any camera(s). Again, use the ''Scene Collection'' panel. These have a 🎥 icon and by default are named something like "camera".
# <u>If there are multiple different 3D assets in the scene</u> (like bags, crates, jars, ect.), join them all together...
## Select all of the meshes by holding ''Shift'' and clicking on each one in the ''Scene Collection'' panel (right side of window).<br>'''Tip:''' Quickly select a group of them by selecting one near the top. Then hold ''Shift'', ''Ctrl,'' and click on one near the bottom. This will both the one at the top and the one at the bottom, but also every item in between. Neat!
## Be in ''Layout'' workspace (top toolbar) and in the ''Object Mode...''
### Find the drop down in the second toolbar from the top that has options like ''Object Mode, Edit Mode, Sculpt Mode,'' etc.
### Select ''Object Mode'' from that drop down.
## Find and open the ''Object'' menu (second toolbar down from the top).
## Select ''Join''.
## In the ''Scene Collection'' panel, double click on the name of the newly joined mesh.
# Rename the joined mesh to <code>MedievalStallMesh</code>.
# Add and position a reference cube...
## Make sure the editor is in ''Layout'' view (top toolbar) and in the ''Object Mode...''
### Find the drop down in the second toolbar from the top that has options like ''Object Mode, Edit Mode, Sculpt Mode,'' etc.
### Select ''Object Mode'' from that drop down.
## Then, add a reference cube. Open the ''Add'' menu (second top toolbar down).
## Hover ''Mesh''.
## Select ''Cube.''
## Open the ''View'' menu (second toolbar down).
## Select ''Sidebar''.
## A new panel will have expanded.
## Along the right side of that panel there's buttons (''Item, Tool, View, Animation''). Find and click the ''Item'' button.
## Find and expand the ''Transform'' section
## Set the ''Location...''
### ''X'' to ''1''.
### ''Y'' to ''1''.
### ''Z'' to ''1''.
## The bottom corner of the cube should be touching the where green and red axis lines meet.
# Move the reference cube's origin to <code>(0, 0, 0)</code>...
## Be in ''Layout'' workspace (top toolbar) and in the ''Object Mode...''
### Find the drop down in the second toolbar from the top that has options like ''Object Mode, Edit Mode, Sculpt Mode,'' etc.
### Select ''Object Mode'' from that drop down.
## Open the ''View'' menu (second toolbar down).
## Select ''Sidebar''.
## A new panel will have expanded.
## Along the right side of that panel there's buttons (''Item, Tool, View, Animation''). Find and click the ''View'' button.
## Find and expand the ''3D Cursor'' section.
## Set the 3D cursor's ''Location''...
### ''X'' to ''0''.
### ''Y'' to ''0''.
### ''Z'' to ''0.''
## Now in the ''Scene Collection'' panel, click on the ''Cube'' mesh to highlight and select it.
## Open the ''Object'' menu from the second toolbar down from the top.
## Hover ''Set Origin''.
## Select ''Origin to 3D Cursor''.
# Set the reference cube's dimensions...
## Be in ''Layout'' workspace (top toolbar) and in the ''Object Mode...''
### Find the drop down in the second toolbar from the top that has options like ''Object Mode, Edit Mode, Sculpt Mode,'' etc.
### Select ''Object Mode'' from that drop down.
## Open the ''View'' menu (second toolbar down).
## Select and check the ''Sidebar'' option''.''
## The ''Sidebar'' menu just expanded over on the right side of the screen.
## To the right of the ''Sidebar'', find and click the ''Item'' button.
## Expand the ''Transform'' section.
## Set the ''Dimensions...'''''<br>Note:''' These dimensions only make sense for the asset being used for this guide. If using a different one, set the dimensions to the size of the box that model should fit in.
### ''X'' to ''4''.
### ''Y'' to ''3''.
### ''Z'' to ''3''.
# Adjust the position and scale of the ''MedievalStallMesh'' to fit inside a box.
## Be in ''Layout'' workspace (top toolbar) and in the ''Object Mode...''
### Find the drop down in the second toolbar from the top that has options like ''Object Mode, Edit Mode, Sculpt Mode,'' etc.
### Select ''Object Mode'' from that drop down.
## On the left side of the screen there's a column of icons. Hover over them to see their names.
## Select the ''Move'' tool.
## Click on the Medieval Stall to select it. Zoom out and reposition the camera so that the blue, green, and red arrows are visible.<br>'''Tip:''' By holding the middle-mouse button and dragging the scene will rotate. By holding the middle-mouse button and the ''Shift'' key, the scene will pan.<br>'''Tip:''' If panning or rotating the scene becomes slow or frustrating (especially after zooming), try selecting 3D asset from the ''Scene Collection'' panel, opening the ''View'' menu (second toolbar from top), and selecting ''Frame Selected''. This will reset the view onto that object and controls should feel normal again.
## Click and hold one of the arrows. Move the mouse to drag the 3D asset towards the box.
## Move the 3D asset around till it's <u>completely inside the box</u>. If it cannot fit and is too big, continue to the next step.<br>'''Tip:''' To select the 3D asset once it disappears, use the ''Scene Collection'' panel. Click on it there and the blue, green, and red arrows will show up again for it.<br>'''Tip:''' There are preset views. To use them go to the ''View'' menu (second toolbar from top)'','' hover ''Viewpoint'', and select the view that would be most helpful.
## Find the ''Scale'' tool from the left side of the screen.
## Now the blue, green, and red "arrows" don't really look like arrows anymore. They are lines with boxes at the end.
## Click and hold on those lines to adjust the scale of the 3D asset to make it fit inside the box.<br>'''Tip:''' There are little colored boxes in between the lines that can be dragged to scale the 3D asset more proportionally.
## Continue using the ''Move'' and ''Scale'' tools till the model fits. This will take patience and time.<br>'''Tip:''' Hide the reference cube to see what is happening with the 3D asset. Go to the ''Scene Collections'' panel and click the 👁 button to hide it. Click that button again to show it.
# Move the reference cube's origin to <code>(0.5, 0.5, 0.5)</code>...
## Be in ''Layout'' workspace (top toolbar) and in the ''Object Mode...''
### Find the drop down in the second toolbar from the top that has options like ''Object Mode, Edit Mode, Sculpt Mode,'' etc.
### Select ''Object Mode'' from that drop down.
## Open the ''View'' menu (second toolbar down).
## Select ''Sidebar''.
## A new panel will have expanded.
## Along the right side of that panel there's buttons (''Item, Tool, View, Animation''). Find and click the ''View'' button.
## Find and expand the ''3D Cursor'' section.
## Set the 3D cursor's ''Location''...
### ''X'' to ''0''.5.
### ''Y'' to ''0.5''.
### ''Z'' to ''0.5.''
## Select the ''MedievalStallMesh'' using the ''Scene Collection'' panel.
## Open the ''Object'' menu (second toolbar down).
## Hover ''Set Origin''.
## Select ''Origin to 3D Cursor''.
# Select the reference cube named ''Cube'' from the ''Scene Collections'' panel.
# Open ''Object'' menu (second toolbar down).
# Select ''Delete''.
# Move the ''MedievalStallMesh'' to <code>(0, 0, 0)</code>...
## Be in ''Layout'' workspace (top toolbar) and in the ''Object Mode...''
### Find the drop down in the second toolbar from the top that has options like ''Object Mode, Edit Mode, Sculpt Mode,'' etc.
### Select ''Object Mode'' from that drop down.
## Open the ''View'' menu (second toolbar down).
## Select ''Sidebar''.
## A new panel will have expanded.
## Along the right side of that panel there's buttons (''Item, Tool, View, Animation''). Find and click the ''Item'' button.
## Make sure the ''MedievalStallMesh'' is selected. Use the ''Scene Collection'' panel if needed.
## Find and expand the ''Transform'' section
## Set the ''Location...''
### ''X'' to 0.
### ''Y'' to 0.
### ''Z'' to 0.
# Make sure the ''MedievalStallMesh'' is selected. Use the ''Scene Collection'' panel if needed.
# Open the ''Object'' menu.
# Hover ''Apply''.
# Select ''All Transformations''.<br>'''Note:''' This step bakes all of the changes into the mesh. It's very important.
# Open the ''File'' menu from the top toolbar.
# Hover ''Export'' to open the sub-menu.
# Select ''FBX (.fbx)''
# A ''Blender File View'' window will pop-up.
# On the right side of this window there's a ⚙️ icon. Click it to expand the settings region.
# In the expanded region find the ''Include'' section and expand it. Change the following:
## Find ''Object Types'' and only select ''Mesh.'' No other option should be highlighted for this setting.
# In the settings region scroll and find the ''Transform'' section and expand it. Change the following:
## Find ''Apply Scalings'' and set it to ''FBX All''.
## Just below that find ''Forward'' and set it to ''Z Forward''.
## Ensure that the next setting down, ''Up'', changed to ''Y Up''.
## Find ''Apply Unit'' and make sure it's checked.
## Next, find ''Use Space Transform'' check it.
## Lastly, find ''Apply Transform'' and check it too.
# Save it to <code>Assets/WikiDemo/MedievalStall.fbx</code>.
# Save the Blender scene...
## ''File'' drop down from top toolbar.
## ''Save As...'' to save the Blender scene to the computer.
## Save it to <code>Assets/WikiDemo/MedievalStall - Eco Ready Scene.blend</code>.

=== Add to Unity Scene ===

# Open <u>Unity</u>.
# Select the <code>.fbx</code> file in the project window.
# Open the ''Eco Tools'' menu from the top toolbar.
# Hover ''Mod Kit''.
# Select ''World Object Setup.''
# A ''World Object Setup'' window will pop-up.
# Make sure that ''Selected Objects'' reads ''MedievalStall.''
# Also make sure that ''World Object Type'' is set to ''World Object''.
# Press the ''Setup World Objects'' button.
# Notice in the project window that a new <code>.prefab</code> file was created -- <code>MedievalStallObject.prefab</code>
# Select the <code>.prefab</code>.
# In the ''Inspector'' panel find the ''Transform'' component.
# Change this component's ''Rotation...''
## ''X'' to ''0.''
## ''Y'' to ''0.''
## ''Z'' to ''0.''
# In the ''Inspector'' panel find the ''Box Collider'' component.
#Find the ''⋮'' icon (all the way to the right of the words ''Box Collider)'' and click on it.
#Select ''Reset'' from the menu. This will regenerate the box collider now that the rotation has changed.
#Look in the ''Inspector'' panel and find the ''World Object (Script)'' component.
# That component has a checkbox ''Override Occupancy''. Check it.
# A new field should've expanded below it called ''Size''.
# Set the ''Size''...<br>'''Note:''' This size similar to the size of the reference cube from earlier, but the Y and Z coordinates get flipped! So if in Blender it was <code>(1, 2, 3)</code> then in Unity its <code>(1, 3, 2)</code>.
## ''X'' to ''4''.
## ''Y'' to ''3''.
## ''Z'' to ''3''.
# Select ''Objects'' from ''Hierarchy'' panel (left-side of the window).
# Find the ''Modkit Prefab Container (Script)'' component. This component was added earlier, if it's not there add it now.
# Expand the ''Prefabs'' section in that component.
# Click the ''+'' button to add an item to the list.
# Either...
## Click the ''⦿'' button, switch to the ''Assets'' tab, find or search for ''MedievalStallObject'', and double click on it. Make sure it's the medieval stall <u>object</u> with the <code>.prefab</code> ending.
## Drag the <code>.prefab</code> file onto the ''⦿'' button
# Open the ''File'' menu from top toolbar and select ''Save''.<br>'''Note:''' Do not skip. The scene must be saved for the ModKit build to work properly.
# Open the ''Eco Tools'' menu from the top toolbar.
# Hover ''Mod Kit''.
# Select ''Build Current Bundle''.
# Save the bundle to <code>/Eco Server/Mods/UserCode/WikiDemo.unity3d</code>

=== Coding the World Object ===
The following collapses the <code>#region Recipe</code>. Please see the earlier section [[#Code the Item's Recipe|Code the Item's Recipe]] to get the code that belongs there.

Add the new <code>using</code> lines, replace the <code>#region Item</code> section, and replace the <code>#region Object</code> sections using the following:<syntaxhighlight lang="c#" line="1">using Eco.Core.Items;
using Eco.Gameplay.Components;
using Eco.Gameplay.Items;
using Eco.Gameplay.Items.Recipes;
using Eco.Gameplay.Objects;
using Eco.Gameplay.Skills;
using Eco.Mods.TechTree;
using Eco.Shared.Localization;
using Eco.Shared.Serialization;
using System.Collections.Generic;
using System.Runtime.Versioning;
using System;
using Eco.Core.Controller;
using Eco.Gameplay.Systems.NewTooltip;
using Eco.Shared.Items;
using Eco.Gameplay.Occupancy;
using Eco.Shared.Math;
using Eco.Gameplay.Components.Auth;

namespace WikiDemo
{
#region Item
[Serialized] // Tells the save/load system this object needs to be serialized.
[SupportedOSPlatform("windows7.0")]
[LocDisplayName("Market Stall")] // Defines the localized name of the item.
[Weight(3000)] // Defines how heavy this is.
[Ecopedia("Work Stations", "Craft Tables", createAsSubPage: true)]
[LocDescription("A medieval market stall.")] //The tooltip description for the item.
public partial class MedievalStallItem : WorldObjectItem<MedievalStallObject>, IPersistentData
{
[Serialized, SyncToView, NewTooltipChildren(CacheAs.Instance, flags: TTFlags.AllowNonControllerTypeForChildren)] public object? PersistentData { get; set; }

protected override OccupancyContext GetOccupancyContext => new SideAttachedContext(
DirectionAxisFlags.Down, // Read: every occupied block on the bottom must be supported
WorldObject.GetOccupancyInfo(this.WorldObjectType)
);
}
#endregion

#region Recipe

#region Object
[Serialized]
[SupportedOSPlatform("windows7.0")]
[RequireComponent(typeof(CraftingComponent))]
[RequireComponent(typeof(MinimapComponent))]
[RequireComponent(typeof(LinkComponent))]
[RequireComponent(typeof(OccupancyRequirementComponent))]
[Tag("Usable")]
[Ecopedia("Work Stations", "Craft Tables", subPageName: "Market Stall")]
public partial class MedievalStallObject : WorldObject, IRepresentsItem
{
public Type RepresentedItemType => typeof(MedievalStallItem);

static MedievalStallObject()
{
WorldObject.AddOccupancy<MedievalStallObject>(CalculateBoxOccupancy(4, 3, 3));
}

protected override void Initialize()
{
this.ModsPreInitialize();
this.GetComponent<LinkComponent>().Initialize(15);
this.GetComponent<MinimapComponent>().SetCategory(Localizer.DoStr("Crafting"));
this.ModsPostInitialize();
}

/// <summary>Hook for mods to customize WorldObject before initialization. You can change housing values here.</summary>
partial void ModsPreInitialize();
/// <summary>Hook for mods to customize WorldObject after initialization.</summary>
partial void ModsPostInitialize();

/// <summary>
/// Calculates the blocks that this item will occupy when placed. All coordinates are offsets relative to this 3D model's origin
/// point. This function can only be used to calculate a box shape; there can be no gaps. All blocks will be of the
/// BlockOccupancyType.None type.
/// </summary>
///
/// Examples:
/// * Imagine a 1x1x1 cube. The origin point of the 3D model is the middle of the bottom-left cube. The only block the
/// cube would occupy would be the same one the origin point is in. In offset coordinates, the only block the cube occupies
/// is (0,0,0) from the origin point.
/// * Image a 1x5x1 flag pole. Again the origin point of the 3D model is in the middle of the bottom most cube. The only
/// blocks the flage pole occupies is the one the origin point is in and the 4 above that one. In offset coordinates, that
/// would be (0,0,0) + (0,1,0) + (0,2,0) + (0,3,0) + (0,4,0).
/// <returns></returns>
private static List<BlockOccupancy> CalculateBoxOccupancy(int sizeX, int sizeY, int sizeZ)
{
var cells = new List<BlockOccupancy>(sizeX * sizeY * sizeZ);
for (int x = 0; x < sizeX; x++)
for (int y = 0; y < sizeY; y++)
for (int z = 0; z < sizeZ; z++)
cells.Add(new BlockOccupancy(new Vector3i(x, y, z)));
return cells;
}
}
#endregion
}
</syntaxhighlight>'''Line 30:''' This changes from implementing <code>Item</code> to <code>WorldObjectItem<MedievalStallObject></code>. This is what tell Eco that this item has the ability to place a world object into the world.

'''Line 32:''' This defines the object where <code>PersistentData</code> is stored. Other components like a ''PartsComponet'' would store the information of the table parts' durability in here. in this example, this line is illustrative and doesn't have any components using it.

'''Line 34:''' Sets the type of occupancy context this world object has. Occupancy is the system used to determine what space blocks and object are in. The <code>SideAttachContext</code> means that this object must have a certain side supported for it to be attached to the world and valid to be placed.

'''Line 35:''' Defines the bottom side as the side this object uses to attach.

'''Line 36:''' This line is getting the list of blocks occupied from a static lookup in <code>WorldObject</code> for the <code>MedievalStallObject</code>. See line 60 to see this value set.

'''Line 41:''' The "collapsed" Recipe section. See earlier sections in this guide to see what code belongs here.

'''Line 46:''' Adds a <code>CraftComponent</code> to the table. This component lets players use this table to craft something on.

'''Line 47:''' <code>MinimapComponent</code> this registers the object with the minimap. This makes it so when a player places a medieval stall, the minimap shows it. Related: line 67.

'''Line 48:''' <code>LinkComponent</code> allows storage linking. Related: line 66.

'''Line 49:''' <code>OccupancyRequirementComponent</code> defines this object as having and occupying physical space. Related: line 60.

'''Line 50:''' Assigns a tag to this object. Like how the tag ''Wood'' in Eco refers to all the different types of logs. In this case, the ''MedievalStallObject'' is being added to the <code>Usable</code> tag.

'''Line 52:''' Declares the <code>MedievalStallObject</code>. It's important that this class name is matches exactly the <code>.prefab</code> file name because the name is what links them.

'''Line 54:''' Declares the item that is given when this world object is picked up.

'''Line 58:''' This sets the occupancy for the world object in the simulation. This must also be set for the object in addition to the ''Override Occupancy'' and ''Size'' setting previously set on the Unity <code>.prefab</code>. That's because the settings in Unity are used client side. This sets the occupancy on the server side. They both need to be set and be matching for things to work right.

'''Line 64:''' Initializes the <code>LinkComponent</code> with a base 15 block radius. Know that this value is just the base value and that server settings will determine the actual game play radius.

'''Line 65:''' Initializes the <code>MinimapComponent</code> and add this object to the <code>Crafting</code> category.

=== Checkpoint ===

# Have the <code>.unity3d</code> and the <code>.cs</code> file in the <code>/Eco Server/Mods/UserCode</code> folder.
# Start the server and log in.
# Type <code>/give Carpentry Table</code>.
# Place the Carpentry Table down and interact to see the what can be crafted.
# Find the newly added recipe under the name ''Market Stall.''
# Type <code>/give Basic Upgrade 4</code>.
# Put the basic upgrade into the table.
# Go back to the recipe for the ''Market Stall'' and make sure the Wood and the Cotton fabric inputs now require less, but the Hemp Mooring Rope still is the same. '''Note:''' In case the recipe hasn't changed close that table's window and interact with it again. It should for the recipes to refresh now that the upgrade is in it.

[[File:WikiDemo - Medieval Stall - Checkpoint -3.png|thumb|The Medieval Stall modded into Eco.]]
'''Warning:''' In ''Eco'' v13.0.2, free-placed objects may display misaligned ghost cubes, even when configured correctly in your mod. This is a visual-only base-game bug — placement still works as expected, even if the object appears red near edges. 

# Have the <code>.unity3d</code> and the <code>.cs</code> file in the <code>/Eco Server/Mods/UserCode</code> folder.
# Start the server and log in.
# Type <code>/give MedievalStall</code>.
# Place the stall down. '''Pro-tip:''' Put down a floor of <u>flat roof</u> tiles made of ''Reinforced Concrete''. This will show you where the occupancy of your object is when you place it because the roof tiles will change shape under the object. Neat!
# It should look and function like a normal workbench.

The <code>WikiDemo.unity3d</code> and the <code>WikiDemo.cs</code> files are all that is needed to share this mod now.

= Adding a Recipe to Craft =
To add a recipe to the medieval stall add this to the <code>WikiDemo.cs</code> file:<syntaxhighlight lang="c#" line="1">
using Eco.Core.Items;
using Eco.Gameplay.Components;
using Eco.Gameplay.Items;
using Eco.Gameplay.Items.Recipes;
using Eco.Gameplay.Objects;
using Eco.Gameplay.Skills;
using Eco.Mods.TechTree;
using Eco.Shared.Localization;
using Eco.Shared.Serialization;
using System.Collections.Generic;
using System.Runtime.Versioning;
using System;
using Eco.Core.Controller;
using Eco.Gameplay.Systems.NewTooltip;
using Eco.Shared.Items;
using Eco.Gameplay.Occupancy;
using Eco.Shared.Math;
using Eco.Gameplay.Components.Auth;

namespace WikiDemo
{
#region Item

#region Recipe

#region Object

#region CraftingRecipes
public partial class MyArrowRecipe : RecipeFamily
{
[SupportedOSPlatform("windows7.0")]
public MyArrowRecipe()
{
var recipe = new Recipe();
recipe.Init(
name: "Alternate Arrow",
displayName: Localizer.DoStr("Alternate Arrow"),
ingredients: new List<IngredientElement>
{
new IngredientElement("Wood", 1, typeof(Skill)),
new IngredientElement("Rock", 1)
},
items: new List<CraftingElement>
{
new CraftingElement<ArrowItem>(1)
}
);
this.Recipes = new List<Recipe> { recipe };
this.LaborInCalories = CreateLaborInCaloriesValue(10);
this.CraftMinutes = CreateCraftTimeValue(0.1f);

// Perform pre/post initialization for user mods and initialize our recipe instance with the display name "Market Stall"
this.ModsPreInitialize();
this.Initialize(displayText: Localizer.DoStr("Alternate Arrow Recipe"), recipeType: typeof(MyArrowRecipe));
this.ModsPostInitialize();

// Register our RecipeFamily instance to a work table (in this case the Carpentry Table) so it can be crafted.
CraftingComponent.AddRecipe(tableType: typeof(MedievalStallObject), recipeFamily: this); // NOTE: The table must be the object instance!
}

/// <summary>Hook for other mods to customize RecipeFamily before initialization.</summary>
partial void ModsPreInitialize();

/// <summary>Hook for other mods to customize RecipeFamily after initialization, but before registration. You can change skill requirements here.</summary>
partial void ModsPostInitialize();
}
#endregion
}
</syntaxhighlight>
[[File:WikiDemo MedievalStall AltArrowRecipe.png|thumb|Shows a new recipe added to the crafting tab of the Medieval Stall.]]
'''Line 58:''' This line here adds this recipe to the <code>MedievalStallObject</code> just created.

From 3D Asset to Working Worktable

2026-04-28T22:35:23Z

WugWugg: Aside from 1 test, the Preparing the 3D asset section is done.

= Introduction =
Below is a guide on how to take an 3D asset from the Unity Store and make a working workbench in Eco. This includes:
* Creating a recipe to craft the modded table
* Creating recipes so the player can use the modded table to craft something
* Using Blender to generate a modded icon (seen when holding it in inventory)
* Using Blender to adjust the origin point of the model
* How to setup all this in a Unity scene and package for Eco

= Setup =

* Already have setup '''ModKit + Unity'''
** See: [[Installing the ModKit]]
* Have a '''3D model'''
** Just following along? Find the one used here at <code><nowiki>https://assetstore.unity.com/packages/3d/props/low-poly-medieval-market-stalls-314286</nowiki></code>
* A '''C# IDE''' (notepad++, Visual Studio, etc.)
** Highly encouraged to have an Intellisense setup and linked to the '''Reference Assemblies'''. Optional, but its really worth the time to figure out because it will help quickly correct small typos and trivial mistakes.
** See: [[Getting Started with Eco Modding in Visual Studio 2022]] (generally the same steps apply if using a new version of Visual Studio)
* '''Blender''' installed
** Homepage: <code><nowiki>https://www.blender.org/</nowiki></code>

== Importing the Assets ==

# Open the Unity editor to the project.
# From the top toolbar open the ''Window'' drop down.
# Hover ''Package Management'' to open sub-menu.
# Select ''Package Manager''.
# The ''Package Manager'' window will pop-up.
# Install the package containing the assets you want to use...
## <u>If not using Unity Registry</u>...
### Find the ''+▾'' button in the top left and open the drop down.
### Install the package from one of those options.
## <u>If using Unity Registry</u>...
### Visit <code><nowiki>https://assetstore.unity.com</nowiki></code> and sign in.
### Search for the asset desired.
### Go to it's page (e.g. <code><nowiki>https://assetstore.unity.com/packages/3d/props/low-poly-medieval-market-stalls-314286</nowiki></code>) and click the big blue button, ''Add to My Assets.''
### Now, in the Unity editor and back at the ''Package Manager'' window.
### Find ''My Assets'' on the left menu and navigate to it.
### Click the ''⟳'' button in the lower-right.
### The asset should be in the list now. Use the search to filter if needed.
### Click on the asset in the list. For those following along, ''Low Poly Medieval Market Stalls''.
### In the right panel, find the ''Download ⤓'' button. Click it.
### Once downloaded, a new button should show up, it'll say something like ''⊕ Import 1.0 to project'' . Click it.
### The ''Import Unity Package'' window will pop-up.
### Select ''Import'' on it.
# Verify you can find your assets from the explorer. If following along, the assets are at <code>Assets/PolyRonin/Medieval Market Stalls</code>.
# Load in a demo scene, if provided, and make sure everything looks okay.
## For those following along, double click on the ''Demo'' scene at <code>Assets/PolyRonin/Medieval Market Stalls/Demo.unity</code>.

[[File:Eco - Unity - View Modes.png|thumb|Underlined in red are the different draw mode buttons. <u>4/20/26</u>]]
If something seems off, check the different draw modes and see if changing those allow the scene to render as expected (see picture).

= Creating The Worktable =
This guide will create the worktable in this order:

# Create the item that represents the worktable
# Make a recipe to craft the worktable item
# Make the worktable item something that places a world object
# Give the worktable functionality by adding recipes to it

== Creating the Item ==

=== Item Icon ===
[[File:TeamstersStall - StallOnly - 256x256.png|thumb|A large (256x256px) icon created of Stall4 from the medieval assets.]]
# Open <u>Blender</u>.
# Delete everything in the ''Scene Collection''. Find this section in the top-right of the application.
# From the top toolbar, open the ''File'' drop down.
# Hover ''Import'' to open the sub-menu.
# Select the type of 3D asset. For those using medieval assets, select ''FBX (.fbx)''.
# Find the asset on the computer...<br>'''Tip:''' Use Unity to find the <code>.fbx</code> asset.
## For the medieval assets, that's in <code>Assets/PolyRonin/Medieval Market Stalls/Meshes/medieval-market-stalls-1.fbx</code>.
## Right click on it and select ''Show in explorer''.
## Now copy the address of that folder from Explorer. It might look like <code>C:\Users\Wug\EcoMod--WikiDemo\WikiDemo\Assets\PolyRonin\Medieval Market Stalls\Meshes</code>.
## Paste that in the address bar of the <u>Blender</u> import pop-up.
# Select the blue ''Import FBX'' button''.''
# Be in the ''Layout'' workspace (top toolbar) and in the ''Object Mode...''
## Find the drop down in the second toolbar from the top that has options like ''Object Mode, Edit Mode, Sculpt Mode,'' etc.
## Select ''Object Mode'' from that drop down.
# Change the Viewport Shading to Material Preview or Rendered. This is on the second toolbar down, far right of center, but before ''Scene Collection'' section.
# If you see purple models, Blender will need help finding textures for these meshes...
## From the top toolbar, open the ''File'' drop down.
## Hover ''External Data'' to open the sub-menu.
## Select ''Find Missing Files...''
## Point this to the whole directory that the 3D assets came in. For the medieval pack, <code>C:\Users\</code><code>Wug\EcoMod--WikiDemo\WikiDemo\Assets\PolyRonin</code>.
## The proper textures/materials should have now loaded in. If it hasn't, consult Google because without the textures the following steps won't produce a usable icon.
# Add a source of light...
## Still be in the ''Layout'' workspace (top toolbar) and in the ''Object Mode...''
### Find the drop down in the second toolbar from the top that has options like ''Object Mode, Edit Mode, Sculpt Mode,'' etc.
### Select ''Object Mode'' from that drop down.
## From the toolbar just under that one, find and open the ''Add'' drop down.
## Hover ''Light'' to open that sub-menu.
## Click ''Sun''.
# Add a camera...
## In the ''Layout'' workspace (top toolbar) and in the ''Object Mode...''
### Find the drop down in the second toolbar from the top that has options like ''Object Mode, Edit Mode, Sculpt Mode,'' etc.
### Select ''Object Mode'' from that drop down.
## From the second toolbar down, find and open the ''Add'' drop down.
## Select ''Camera''.
# Setup the scene with the object placement and lighting direction desired.<br>'''Tip:''' To reset the editor to something selected press the period key <u>on the numpad</u>. Without a numpad, use ''View'' (second toolbar from the top) and select ''Frame Selected'' from it. Alternatively, just set the zoom to zoom to the mouse position: ''Edit'' (top toolbar), ''Preferences'' (from drop down), ''Navigation'' (on left menu), ''Zoom to Mouse Position'' (In the zoom section). This makes moving around a lot more natural feeling.
# Setup the rendering camera...
## Go to ''Rendering'' tab on the top toolbar
## On the right there will be a side-panel open, it should be the ''Render'' tab. Confirm that.
## Change ''Render Engine'' to ''Cycles''.
## Look down below in the same tab for the ''Film'' section.
## Expand it and find the ''Transparent'' checkbox and section. Click it so that it has a check mark. This will make the icon's background transparent.
## Now, go to the ''Output'' tab <u>on the side panel</u>. The tab is just below the current one.
## In the ''Format'' section set ''Resolution X'' to ''64.'' And ''Y'' to ''64'' as well. This will make the icon generated a 64 by 64 pixel image.
# Go back to the ''Layout'' tab from the top toolbar.
# Center your view on the object (numpad period or ''View > Frame Selected''). Adjust it so that the object is how it should be for the icon.
# Align the camera to the view...
## Make sure the editor is in ''Layout'' workspace (top toolbar) and in the ''Object Mode...''
### Find the drop down in the second toolbar from the top that has options like ''Object Mode, Edit Mode, Sculpt Mode,'' etc.
### Select ''Object Mode'' from that drop down.
## Find ''View'' from the second from the top toolbar and open the drop down.
## Hover ''Align View'' to open the sub-menu.
## Select ''Align Active Camera To View''.
## If the view is slightly off, there is a lock icon on the right side of this panel. Use it to "lock" controls to the camera and tweak it's view.
# Now return to the ''Rendering'' tab from the top toolbar.
# Press the F12 key to start the render. This should complete quickly since 64x64 pixels is a very small render.
# A window should popup, ''Blender Render''. This is the icon!
# From the top tool bar of this ''Blender Render'' window, open the ''Image'' drop down.
# Select ''Save As...'' to save somewhere on the computer.
# Return to step 13 and repeat to do larger images if desired. Create a 128 by 128 pixel image too. It will make things smoother later.
# Save the Blender scene. Not only will it be used later, this will make making a new icon with a small tweak that much easier.
## ''File'' drop down from top toolbar.
## ''Save As...'' to save the Blender scene to the computer.
## Save it to <code>Assets/WikiDemo/MedievalStall - Icon Scene.blend</code>.

=== Adding to Unity Scene ===
The developers explain how to create an item in one of ModKit's read me files (See: <code>Assets/EcoModKit/Docs/README.md</code>), but this guide will explain it below.

Additionally, '''TheKye''' on YouTube covers this in their ''Creating Your First Item'' and ''Creating Your First Item Pt 2'' videos.

Use those additional resource to help troubleshoot issues with item's icons.

# Open <u>Unity</u>.
# In the left panel, the ''Hierarchy'' tab should be selected.
# Select the top-most object there. It should be a scene. If the editor last loaded the ''Demo'' scene from the medieval assets, it'll be named ''Demo''.
# Right click on this scene and select ''Add New Scene'' from the menu.
# Right click again on the old scene (''Demo'') and select ''Remove Scene''.
# Let it save if the changes to the old scene are important. Discard if it was open just for exploration's sake.
# Right click the new, ''Untitled'' scene. Click ''Save Scene As...''
# Save it to <code>Assets/WikiDemo.unity</code>.
# Delete <u>anything</u> in the scene.
# Right click the scene, hover ''GameObject'', and select ''Create Empty'' from the sub-menu.
# Name this new object ''Objects''.
# Select the newly created ''Objects'' object from the ''Hierarchy'' menu.
# On the far right side of the screen, in the ''Inspector'' menu, click the ''Add Component'' button.
# Type in ''ModkitPrefabContainer''. Click on the component from the search to add it. The component now should be listed in the ''Inspector''.
# In the ''Hierarchy'' panel right click the scene, hover ''GameObject'', and select ''Create Empty''.
# Name this new object ''Items''.
# Right click the scene, hover ''GameObject'', and select ''Create Empty''.
# Name this new object ''Emoji''.
# Select the newly created ''Emoji'' object, find the ''Inspector'' menu (far-right), and click the ''Add Component'' button.
# Type in ''ChatEmoteSetOld''. Click on the component from the search to add it. That component should now be listed in the ''Inspector''.
# Right click the scene, hover ''GameObject'', and select ''Create Empty''.
# Name this new object ''BlockSets''.
# Select the newly created ''BlockSets'' object, find the ''Inspector'' menu (far-right), and click ''Add Component''.
# Search for ''BlockSetContainer''. Click on the component from the search to add it. The ''Inspector'' should now show that component as added.
#Go to <code>Assets/EcoModKit/Prefabs</code> in the Unity project window.
# Find the prefab ''ItemTemplate''.
# Drag it onto the ''Items'' object in the ''Hierarchy'' panel. It should add it as a <u>child</u> of the ''Items'' object.
# Right click on the new ''ItemTemplate'' object, hover ''Prefab'', and select ''Unpack Completely''.
# Right click on the ''ItemTemplate'' object and select ''Rename''. Name this what you want the item to be called. Example: ''MedievalStallItem''.
# Set this item's background...
## Here's the default backgrounds (blue = item, brown = block, green = food): <br>[[File:Eco - Item - Background.png|border|frameless]] [[File:Eco - Block - Background.png|frameless]] [[File:Eco - Food - Background.png|frameless]]
## Download or prepare the background and add it to the <code>Assets</code> folder in Unity.
### To follow along lockstep, put the background in a new <code>Assets/WikiDemo</code> folder.
### Right click on <code>Assets</code> folder, hover ''Create'', select ''Folder''.
### Name the folder ''WikiDemo''.
## Configure Unity to use these as sprites...
### Select the background(s) added (Ctrl+Click each one).
### In the ''Inspector'', find ''TextureType'' and change that to ''Sprite (2D and UI)''.
### Again in the ''Inspector'', find ''SpriteMode'' and change that to ''Single''.
### Then scroll and go to the bottom of the ''Inspector'' and find the ''Apply'' button.
### This will apply those changes to that file and all other ones highlighted.
## Select the item being created (''MedievalStallItem'').
## In the ''Inspector'' panel (far-right), scroll and find the ''Item Template (Script)'' section.
## In here find the ''Background'' input. It'll say ''Background (Image)'' in it. If clicked that text to reveal and highlight the related object in the ''Hierarchy'' panel.
## Select the revealed, and highlighted object ''Background''.
## In the ''Inspector'' panel, scroll and find the ''Image'' component section.
## Inside that component's section, find ''Source Image''. It'll say ''Missing (Sprite)''. Click the ''⦿'' button to the right.
## The ''Select Sprite'' popup will show. Make sure the ''Assets'' tab is selected, and find the backgrounds desired.
#Create the foreground image...
##This is easily accomplished in MS Paint.
##Get to the background image file in a <u>file explorer</u>.
##Right click on it, hover ''Open with...'', and select ''Paint''.
##The solid background should be displayed.
##Open the ''File'' menu from the top toolbar.
##Hover ''Import to Canvas'' and select ''From a File''.
##Find the icon in the file browser and import it. Match the size of the background image to have it nicely center itself.
##Now ''File'' from the top toolbar.
##Hover ''Save As...'' and select ''PNG''.
##Save this to the <code>Assets/WikiDemo</code> folder in Unity.
##Configure Unity to use these as sprites...
### Select the foreground image.
### In the ''Inspector'', find ''TextureType'' and change that to ''Sprite (2D and UI)''.
### Again in the ''Inspector'', find ''SpriteMode'' and change that to ''Single''.
### Then scroll and go to the bottom of the ''Inspector'' and find the ''Apply'' button.
### This will apply those changes to that file and all other ones highlighted.
#Set this item's foreground...
## Copy the item's icon into the <code>Assets</code> folder.
## Configure Unity to use it as a sprite (see the previous step's ''Set this item's background...'' instructions)
## Select the item being created (''MedievalStallItem'').
## In the ''Inspector'' panel (far-right), scroll and find the ''Item Template (Script)'' section.
## In here find the ''Foreground'' input. It'll say ''Foreground (Image)'' in it. If clicked that text to reveal and highlight the related object in the ''Hierarchy'' panel.
## Select the revealed, and highlighted object ''Foreground''.
## Use the ''Inspector'', find the ''Image'' component, within that component find the ''Source Image'' input. It will say ''Missing (Sprite)''.
## Click the ''⦿'' button to the right of that input.
## From the ''Select Sprite'' popup, ensure the ''Assets'' tab is being searched, and find the icon just created.

=== Export From Unity ===

# Open the ''File'' menu from the top toolbar.
# Select ''Save.'' Save it to the <code>Assets/WikiDemo</code> folder.<br>'''Note:''' Do not skip. The scene must be saved for the ModKit build to work properly.
# Open the ''Eco Tools'' menu from the top toolbar.
# Hover ''Mod Kit'' to open the sub-menu.
# Select ''Build Current Bundle''.
# Have it output the bundle to <code>/Eco Server/Mods/UserCode/WikiDemo.unity3d</code>
# Wait for this to build. This may take a few minutes.

=== Scripting the Item ===
For this guide, all code will be placed in a single <code>.cs</code> file and will not be compiled into a <code>.dll</code>.

# Create a <code>.cs</code> file: <code>/Eco Server/Mods/UserCode/WikiDemo.cs</code>
# Put the following into the newly created file:
<syntaxhighlight lang="c#" line="1">using Eco.Core.Items;
using Eco.Gameplay.Items;
using Eco.Shared.Localization;
using Eco.Shared.Serialization;

namespace WikiDemo
{
#region Item
[Serialized] // Tells the save/load system this object needs to be serialized.
[LocDisplayName("Market Stall")] // Defines the localized name of the item.
[Weight(100)] // Defines how heavy Arrow is.
[Ecopedia("Work Stations", "Craft Tables", createAsSubPage: true)]
[LocDescription("A medieval market stall.")] //The tooltip description for the item.
public partial class MedievalStallItem: Item { }
#endregion
}</syntaxhighlight>'''Line 8:''' A region tag. Lets the editor know it can collapse all of that code as a section. The following examples in this guide will just show <code>#region Item</code> in their code examples.

'''Line 13:''' The implementation of <code>Item</code> means that Eco will find this and look for Unity assets that matching this class' name, <code>MedivalStallItem</code>. While this doesn't do anything fancy, it completes the first step towards a new workbench.

=== Checkpoint #1 ===
[[File:Eco - Hotbar With Modded Icon.png|thumb|Shows the medieval stall as a modded icon in-game.]]
Make sure everything is running smoothly by doing the following:

# Double-check that the <code>WikiDemo.unity3d</code> and the <code>WikiDemo.cs</code> files are in <code>/Eco Server/Mods/UserCode</code> folder.
# Start the server and connect to it.
# Test it out by typing <code>/give MedievalStall</code> in chat.
## It's also possible to do <code>/give Market Stall</code> to get the item. How? Line 10: of the the above code declares that name as this item's "common name". Neat.
# The item should appear in the players inventory with a working icon.

== Code the Item's Recipe ==
The following goes over how to add a new class and implement the <code>RecipeFamily</code> interface.<syntaxhighlight lang="c#" line="1">using Eco.Core.Items;
using Eco.Gameplay.Components;
using Eco.Gameplay.Items;
using Eco.Gameplay.Items.Recipes;
using Eco.Gameplay.Skills;
using Eco.Mods.TechTree;
using Eco.Shared.Localization;
using Eco.Shared.Serialization;
using System.Runtime.Versioning;
using System.Collections.Generic;

namespace WikiDemo
{
#region Item

#region Recipe
[RequiresSkill(typeof(CarpentrySkill), 3)]
[Ecopedia("Work Stations", "Craft Tables", subPageName: "Market Stall")]
public partial class MedievalStallRecipe : RecipeFamily
{
[SupportedOSPlatform("windows7.0")]
public MedievalStallRecipe()
{
var recipe = new Recipe();
recipe.Init(
name: "MedievalStallItem",
displayName: Localizer.DoStr("Market Stall"),
ingredients: new List<IngredientElement>
{
new IngredientElement("Wood", 40, typeof(Skill)),
new IngredientElement(typeof(CottonFabricItem), 30, typeof(Skill)),
new IngredientElement(typeof(HempMooringRopeItem), 5, true)
},
items: new List<CraftingElement>
{
new CraftingElement<MedievalStallItem>(1)
}
);
this.Recipes = new List<Recipe> { recipe };
this.LaborInCalories = CreateLaborInCaloriesValue(800, typeof(Skill));
this.CraftMinutes = CreateCraftTimeValue(typeof(MedievalStallRecipe), 10f, typeof(Skill));

// Perform pre/post initialization for user mods and initialize our recipe instance with the display name "Market Stall"
this.ModsPreInitialize();
this.Initialize(displayText: Localizer.DoStr("Market Stall"), recipeType: typeof(MedievalStallRecipe));
this.ModsPostInitialize();

// Register our RecipeFamily instance to a work table (in this case the Carpentry Table) so it can be crafted.
CraftingComponent.AddRecipe(tableType: typeof(CarpentryTableObject), recipeFamily: this); // NOTE: The table must be the object instance!
}

/// <summary>Hook for other mods to customize RecipeFamily before initialization.</summary>
partial void ModsPreInitialize();

/// <summary>Hook for other mods to customize RecipeFamily after initialization, but before registration. You can change skill requirements here.</summary>
partial void ModsPostInitialize();
}
#endregion
}</syntaxhighlight>'''Line 10:''' Eco will need this explicitly added to the file. Visual Studio will not add this line automatically. It's used for the <code>List<T></code> objects found in this code.

'''Line 14:''' "Collapsed" <code>Item</code> section. See the earlier sections in this guide for the code that belongs there.

'''Line 17:''' Sets the required skill and skill level to craft this recipe.

'''Line 21:''' <code>[SupportedOSPlatform("windows7.0")]</code> is here to silence some annoying warnings in Visual Studio. It's optional.

'''Line 30-32:''' Declares the input ingredients used for crafting. <code>typeof(Skill)</code> gets mapped to the <code>CarpentrySkill</code> as defined by line 31. In this example the <code>HempMooringRope</code> is a static input. A static input will not be modified by skills, upgrade modules, or game settings.<br>'''Note:''' It seems that at the time of writing (4/21/2026, Eco v13.0.2) the only way to get an ingredient to be a dynamic value that is reduced by the table's upgrade is to pass <code>typeof(Skill)</code> to it; Passing either <code>true</code> or <code>false</code> makes the this input static.

'''Line 34:''' The <code>items</code> list declares what items are <u>output</u> by this recipe.

'''Line 36:''' This line declares that one medieval stall is output from this recipe. Functionally this links this recipe to the <code>MedievalStallItem</code> (aka "Market Stall") item created in the last step.

'''Line 40:''' Amount of calories needed to craft this item. For a static value (not modified by upgrades or skill levels) change this line to: <code>this.LaborInCalories = CreateLaborInCaloriesValue(800);</code>. As it's written in the example, this item's calorie cost will be dynamic (modified by upgrades and skill levels). The skill level that will modify it is declared on line 16.

'''Line 41:''' Minutes needed to craft. Both static and dynamic values for crafting time can be modified by the world difficulty settings. For a static value change this line to: <code>this.CraftMinutes = CreateCraftTimeValue(10f);</code>. As it's written in the example, this item's craft time will be dynamic.

'''Line 49:''' This line assigns the recipe to a workbench. <u>Do not assign</u> to itself because then the first table could never be made. It's recommend to use a preexisting vanilla table.
=== Checkpoint #2 ===
Check the functionality at this point -- it should be possible to see the recipe in the crafting table.

# Have the <code>.unity3d</code> and the <code>.cs</code> file in the <code>/Eco Server/Mods/UserCode</code> folder.
# Start the server and log in.
# Type <code>/give Carpentry Table</code>.
# Place the Carpentry Table down and interact to see the what can be crafted.
# Find the newly added recipe under the name ''Market Stall.''
# Type <code>/give Basic Upgrade 4</code>.
# Put the basic upgrade into the table.
# Go back to the recipe for the ''Market Stall'' and make sure the Wood and the Cotton fabric inputs now require less, but the Hemp Mooring Rope still is the same.<br>'''Note:''' In case the recipe hasn't changed close that table's window and interact with it again. It should for the recipes to refresh now that the upgrade is in it.

== Create the World Object ==
=== Preparing the 3D Asset ===
# Open <u>Blender</u>.
# Load the 3D object created earlier for icon rendering -- <code>Assets/WikiDemo/MedievalStall - Icon Scene.blend</code>.
# Cleanup the scene...
## Delete any light source. Use the ''Scene Collection'' panel on the top-right side of the screen. These will have a 💡 icon and by default are named something like "sun", "point", "spot" or "area".<br>'''Note:''' If your model is a light source or has one in it, you can leave that light source. The point here is to remove the ambient lights used for icon rendering.
## Delete any camera(s). Again, use the ''Scene Collection'' panel. These have a 🎥 icon and by default are named something like "camera".
# <u>If there are multiple different 3D assets in the scene</u> (like bags, crates, jars, ect.), join them all together...
## Select all of the meshes by holding ''Shift'' and clicking on each one in the ''Scene Collection'' panel (right side of window).<br>'''Tip:''' Quickly select a group of them by selecting one near the top. Then hold ''Shift'', ''Ctrl,'' and click on one near the bottom. This will both the one at the top and the one at the bottom, but also every item in between. Neat!
## Be in ''Layout'' workspace (top toolbar) and in the ''Object Mode...''
### Find the drop down in the second toolbar from the top that has options like ''Object Mode, Edit Mode, Sculpt Mode,'' etc.
### Select ''Object Mode'' from that drop down.
## Find and open the ''Object'' menu (second toolbar down from the top).
## Select ''Join''.
## In the ''Scene Collection'' panel, double click on the name of the newly joined mesh.
# Rename the joined mesh to <code>MedievalStallMesh</code>.
# Add and position a reference cube...
## Make sure the editor is in ''Layout'' view (top toolbar) and in the ''Object Mode...''
### Find the drop down in the second toolbar from the top that has options like ''Object Mode, Edit Mode, Sculpt Mode,'' etc.
### Select ''Object Mode'' from that drop down.
## Then, add a reference cube. Open the ''Add'' menu (second top toolbar down).
## Hover ''Mesh''.
## Select ''Cube.''
## Open the ''View'' menu (second toolbar down).
## Select ''Sidebar''.
## A new panel will have expanded.
## Along the right side of that panel there's buttons (''Item, Tool, View, Animation''). Find and click the ''Item'' button.
## Find and expand the ''Transform'' section
## Set the ''Location...''
### ''X'' to ''1''.
### ''Y'' to ''1''.
### ''Z'' to ''1''.
## The bottom corner of the cube should be touching the where green and red axis lines meet.
# Move the reference cube's origin to <code>(0, 0, 0)</code>...
## Be in ''Layout'' workspace (top toolbar) and in the ''Object Mode...''
### Find the drop down in the second toolbar from the top that has options like ''Object Mode, Edit Mode, Sculpt Mode,'' etc.
### Select ''Object Mode'' from that drop down.
## Open the ''View'' menu (second toolbar down).
## Select ''Sidebar''.
## A new panel will have expanded.
## Along the right side of that panel there's buttons (''Item, Tool, View, Animation''). Find and click the ''View'' button.
## Find and expand the ''3D Cursor'' section.
## Set the 3D cursor's ''Location''...
### ''X'' to ''0''.
### ''Y'' to ''0''.
### ''Z'' to ''0.''
## Now in the ''Scene Collection'' panel, click on the ''Cube'' mesh to highlight and select it.
## Open the ''Object'' menu from the second toolbar down from the top.
## Hover ''Set Origin''.
## Select ''Origin to 3D Cursor''.
# Set the reference cube's dimensions...
## Be in ''Layout'' workspace (top toolbar) and in the ''Object Mode...''
### Find the drop down in the second toolbar from the top that has options like ''Object Mode, Edit Mode, Sculpt Mode,'' etc.
### Select ''Object Mode'' from that drop down.
## Open the ''View'' menu (second toolbar down).
## Select and check the ''Sidebar'' option''.''
## The ''Sidebar'' menu just expanded over on the right side of the screen.
## To the right of the ''Sidebar'', find and click the ''Item'' button.
## Expand the ''Transform'' section.
## Set the ''Dimensions...'''''<br>Note:''' These dimensions only make sense for the asset being used for this guide. If using a different one, set the dimensions to the size of the box that model should fit in.
### ''X'' to ''4''.
### ''Y'' to ''3''.
### ''Z'' to ''3''.
# Adjust the position and scale of the ''MedievalStallMesh'' to fit inside a box.
## Be in ''Layout'' workspace (top toolbar) and in the ''Object Mode...''
### Find the drop down in the second toolbar from the top that has options like ''Object Mode, Edit Mode, Sculpt Mode,'' etc.
### Select ''Object Mode'' from that drop down.
## On the left side of the screen there's a column of icons. Hover over them to see their names.
## Select the ''Move'' tool.
## Click on the Medieval Stall to select it. Zoom out and reposition the camera so that the blue, green, and red arrows are visible.<br>'''Tip:''' By holding the middle-mouse button and dragging the scene will rotate. By holding the middle-mouse button and the ''Shift'' key, the scene will pan.<br>'''Tip:''' If panning or rotating the scene becomes slow or frustrating (especially after zooming), try selecting 3D asset from the ''Scene Collection'' panel, opening the ''View'' menu (second toolbar from top), and selecting ''Frame Selected''. This will reset the view onto that object and controls should feel normal again.
## Click and hold one of the arrows. Move the mouse to drag the 3D asset towards the box.
## Move the 3D asset around till it's <u>completely inside the box</u>. If it cannot fit and is too big, continue to the next step.<br>'''Tip:''' To select the 3D asset once it disappears, use the ''Scene Collection'' panel. Click on it there and the blue, green, and red arrows will show up again for it.<br>'''Tip:''' There are preset views. To use them go to the ''View'' menu (second toolbar from top)'','' hover ''Viewpoint'', and select the view that would be most helpful.
## Find the ''Scale'' tool from the left side of the screen.
## Now the blue, green, and red "arrows" don't really look like arrows anymore. They are lines with boxes at the end.
## Click and hold on those lines to adjust the scale of the 3D asset to make it fit inside the box.<br>'''Tip:''' There are little colored boxes in between the lines that can be dragged to scale the 3D asset more proportionally.
## Continue using the ''Move'' and ''Scale'' tools till the model fits. This will take patience and time.<br>'''Tip:''' Hide the reference cube to see what is happening with the 3D asset. Go to the ''Scene Collections'' panel and click the 👁 button to hide it. Click that button again to show it.
# Move the reference cube's origin to <code>(0.5, 0.5, 0.5)</code>...
## Be in ''Layout'' workspace (top toolbar) and in the ''Object Mode...''
### Find the drop down in the second toolbar from the top that has options like ''Object Mode, Edit Mode, Sculpt Mode,'' etc.
### Select ''Object Mode'' from that drop down.
## Open the ''View'' menu (second toolbar down).
## Select ''Sidebar''.
## A new panel will have expanded.
## Along the right side of that panel there's buttons (''Item, Tool, View, Animation''). Find and click the ''View'' button.
## Find and expand the ''3D Cursor'' section.
## Set the 3D cursor's ''Location''...
### ''X'' to ''0''.5.
### ''Y'' to ''0.5''.
### ''Z'' to ''0.5.''
## Select the ''MedievalStallMesh'' using the ''Scene Collection'' panel.
## Open the ''Object'' menu (second toolbar down).
## Hover ''Set Origin''.
## Select ''Origin to 3D Cursor''.
# Select the reference cube named ''Cube'' from the ''Scene Collections'' panel.
# Open ''Object'' menu (second toolbar down).
# Select ''Delete''.
# Move the ''MedievalStallMesh'' to <code>(0, 0, 0)</code>...
## Be in ''Layout'' workspace (top toolbar) and in the ''Object Mode...''
### Find the drop down in the second toolbar from the top that has options like ''Object Mode, Edit Mode, Sculpt Mode,'' etc.
### Select ''Object Mode'' from that drop down.
## Open the ''View'' menu (second toolbar down).
## Select ''Sidebar''.
## A new panel will have expanded.
## Along the right side of that panel there's buttons (''Item, Tool, View, Animation''). Find and click the ''Item'' button.
## Make sure the ''MedievalStallMesh'' is selected. Use the ''Scene Collection'' panel if needed.
## Find and expand the ''Transform'' section
## Set the ''Location...''
### ''X'' to 0.
### ''Y'' to 0.
### ''Z'' to 0.
# Make sure the ''MedievalStallMesh'' is selected. Use the ''Scene Collection'' panel if needed.
# Open the ''Object'' menu.
# Hover ''Apply''.
# Select ''All Transformations''. '''Note:''' This step bakes all of the changes into the mesh. It's very important.
# Open the ''File'' menu from the top toolbar.
# Hover ''Export'' to open the sub-menu.
# Select ''FBX (.fbx)''
# A ''Blender File View'' window will pop-up.
# On the right side of this window there's a ⚙️ icon. Click it to expand the settings region.
# In the expanded region find the ''Include'' section and expand it. Change the following:
## Find ''Object Types'' and only select ''Mesh.'' No other option should be highlighted for this setting.
# In the settings region scroll and find the ''Transform'' section and expand it. Change the following:
## Find ''Apply Scalings'' and set it to ''FBX All''.
## Just below that find ''Forward'' and set it to ''Z Forward''.
## Ensure that the next setting down, ''Up'', changed to ''Y Up''.
## Find ''Apply Unit'' and make sure it's checked.
## Next, find ''Use Space Transform'' check it.
## Lastly, find ''Apply Transform'' and check it too.
# Save it to <code>Assets/WikiDemo/MedievalStall.fbx</code>.
# Save the Blender scene...
## ''File'' drop down from top toolbar.
## ''Save As...'' to save the Blender scene to the computer.
## Save it to <code>Assets/WikiDemo/MedievalStall - Eco Ready Scene.blend</code>.

=== Add to Unity Scene ===

# Open <u>Unity</u>.
# Select the <code>.fbx</code> file in the project window.
# Open the ''Eco Tools'' menu from the top toolbar.
# Hover ''Mod Kit''.
# Select ''World Object Setup.''
# A ''World Object Setup'' window will pop-up.
# Make sure that ''Selected Objects'' reads ''MedievalStall.''
# Also make sure that ''World Object Type'' is set to ''World Object''.
# Press the ''Setup World Objects'' button.
# Notice in the project window that a new <code>.prefab</code> file was created -- <code>MedievalStallObject.prefab</code>
# Select the <code>.prefab</code>.
# In the ''Inspector'' panel find the ''Transform'' component.
# Change this component's ''Rotation...''
## ''X'' to ''0.''
## ''Y'' to ''0.''
## ''Z'' to ''0.''
# In the ''Inspector'' panel find the ''Box Collider'' component.
#Find the ''⋮'' icon (all the way to the right of the words ''Box Collider)'' and click on it.
#Select ''Reset'' from the menu. This will regenerate the box collider now that the rotation has changed.
#Look in the ''Inspector'' panel and find the ''World Object (Script)'' component.
# That component has a checkbox ''Override Occupancy''. Check it.
# A new field should've expanded below it called ''Size''.
# Set the ''Size''... '''Note:''' This size similar to the size of the reference cube from earlier, but the Y and Z coordinates get flipped! So if in Blender it was <code>(1, 2, 3)</code> then in Unity its <code>(1, 3, 2)</code>. '''TODO: Test This'''
## ''X'' to ''4''.
## ''Y'' to ''3''.
## ''Z'' to ''3''.
# Select ''Objects'' from ''Hierarchy'' panel (left-side of the window).
# Find the ''Modkit Prefab Container (Script)'' component. This component was added earlier, if it's not there add it now.
# Expand the ''Prefabs'' section in that component.
# Click the ''+'' button to add an item to the list.
# Either...
## Click the ''⦿'' button, switch to the ''Assets'' tab, find or search for ''MedievalStallObject'', and double click on it. Make sure it's the medieval stall <u>object</u> with the <code>.prefab</code> ending.
## Drag the <code>.prefab</code> file onto the ''⦿'' button
# Open the ''File'' menu from top toolbar and select ''Save''.<br>'''Note:''' Do not skip. The scene must be saved for the ModKit build to work properly.
# Open the ''Eco Tools'' menu from the top toolbar.
# Hover ''Mod Kit''.
# Select ''Build Current Bundle''.
# Save the bundle to <code>/Eco Server/Mods/UserCode/WikiDemo.unity3d</code>

=== Scripting the World Object ===
WIP: Need occupancy code.

Code that links the Item to this World Object.<syntaxhighlight lang="c#" line="1">
using Eco.Core.Items;
using Eco.Gameplay.Components;
using Eco.Gameplay.Items;
using Eco.Gameplay.Items.Recipes;
using Eco.Gameplay.Objects;
using Eco.Gameplay.Skills;
using Eco.Mods.TechTree;
using Eco.Shared.Localization;
using Eco.Shared.Serialization;
using System.Collections.Generic;
using System.Runtime.Versioning;
using System;

namespace WikiDemo
{
#region Item
[Serialized] // Tells the save/load system this object needs to be serialized.
[LocDisplayName("Market Stall")] // Defines the localized name of the item.
[Weight(100)] // Defines how heavy Arrow is.
[Ecopedia("Work Stations", "Craft Tables", createAsSubPage: true)]
[LocDescription("A medieval market stall.")] //The tooltip description for the item.
public partial class MedievalStallItem : WorldObjectItem<MedievalStallObject> { }
#endregion

#region Recipe

#region Object
[Serialized]
public partial class MedievalStallObject : WorldObject, IRepresentsItem
{
public Type RepresentedItemType => typeof(MedievalStallItem);
}
#endregion
}
</syntaxhighlight>'''Line 22:''' This changes from implementing <code>Item</code> to <code>WorldObjectItem<MedievalStallObject></code>. This is what gives the item the ability to place the table down in the world.

'''Line 25:''' The "collapsed" Recipe section. See earlier sections in this guide to see what code belongs here.

'''Line 29:''' Declares the <code>MedievalStallObject</code>. It's important that this class name is matches exactly the <code>.prefab</code> file name because the name is what links them.

'''Line 31:''' This line is similar in function to line 22, it's declaring that this <code>MedievalStallObject</code> is <code>MedievalStallItem</code> when in inventories.

=== Checkpoint ===
'''Warning:''' In ''Eco'' v13.0.2, free-placed objects may display misaligned ghost cubes, even when configured correctly in your mod. This is a visual-only base-game bug—placement still works as expected, even if the object appears red near edges. 

Export and see what it does. Ensure it's not lifting off the ground because of a non-curved shader.

==== Origin Point Editing ====
Talk about what it does: the point that the simulation considers this world object to be at.

Show how to move it around using blender.

== Final Export ==
Export.

Package.

Distribute.

From 3D Asset to Working Worktable

2026-04-28T21:29:06Z

WugWugg: Creating the world object, Preparing the 3D asset is good.

= Introduction =
Below is a guide on how to take an 3D asset from the Unity Store and make a working workbench in Eco. This includes:
* Creating a recipe to craft the modded table
* Creating recipes so the player can use the modded table to craft something
* Using Blender to generate a modded icon (seen when holding it in inventory)
* Using Blender to adjust the origin point of the model
* How to setup all this in a Unity scene and package for Eco

= Setup =

* Already have setup '''ModKit + Unity'''
** See: [[Installing the ModKit]]
* Have a '''3D model'''
** Just following along? Find the one used here at <code><nowiki>https://assetstore.unity.com/packages/3d/props/low-poly-medieval-market-stalls-314286</nowiki></code>
* A '''C# IDE''' (notepad++, Visual Studio, etc.)
** Highly encouraged to have an Intellisense setup and linked to the '''Reference Assemblies'''. Optional, but its really worth the time to figure out because it will help quickly correct small typos and trivial mistakes.
** See: [[Getting Started with Eco Modding in Visual Studio 2022]] (generally the same steps apply if using a new version of Visual Studio)
* '''Blender''' installed
** Homepage: <code><nowiki>https://www.blender.org/</nowiki></code>

== Importing the Assets ==

# Open the Unity editor to the project.
# From the top toolbar open the ''Window'' drop down.
# Hover ''Package Management'' to open sub-menu.
# Select ''Package Manager''.
# The ''Package Manager'' window will pop-up.
# Install the package containing the assets you want to use...
## <u>If not using Unity Registry</u>...
### Find the ''+▾'' button in the top left and open the drop down.
### Install the package from one of those options.
## <u>If using Unity Registry</u>...
### Visit <code><nowiki>https://assetstore.unity.com</nowiki></code> and sign in.
### Search for the asset desired.
### Go to it's page (e.g. <code><nowiki>https://assetstore.unity.com/packages/3d/props/low-poly-medieval-market-stalls-314286</nowiki></code>) and click the big blue button, ''Add to My Assets.''
### Now, in the Unity editor and back at the ''Package Manager'' window.
### Find ''My Assets'' on the left menu and navigate to it.
### Click the ''⟳'' button in the lower-right.
### The asset should be in the list now. Use the search to filter if needed.
### Click on the asset in the list. For those following along, ''Low Poly Medieval Market Stalls''.
### In the right panel, find the ''Download ⤓'' button. Click it.
### Once downloaded, a new button should show up, it'll say something like ''⊕ Import 1.0 to project'' . Click it.
### The ''Import Unity Package'' window will pop-up.
### Select ''Import'' on it.
# Verify you can find your assets from the explorer. If following along, the assets are at <code>Assets/PolyRonin/Medieval Market Stalls</code>.
# Load in a demo scene, if provided, and make sure everything looks okay.
## For those following along, double click on the ''Demo'' scene at <code>Assets/PolyRonin/Medieval Market Stalls/Demo.unity</code>.

[[File:Eco - Unity - View Modes.png|thumb|Underlined in red are the different draw mode buttons. <u>4/20/26</u>]]
If something seems off, check the different draw modes and see if changing those allow the scene to render as expected (see picture).

= Creating The Worktable =
This guide will create the worktable in this order:

# Create the item that represents the worktable
# Make a recipe to craft the worktable item
# Make the worktable item something that places a world object
# Give the worktable functionality by adding recipes to it

== Creating the Item ==

=== Item Icon ===
[[File:TeamstersStall - StallOnly - 256x256.png|thumb|A large (256x256px) icon created of Stall4 from the medieval assets.]]
# Open <u>Blender</u>.
# Delete everything in the ''Scene Collection''. Find this section in the top-right of the application.
# From the top toolbar, open the ''File'' drop down.
# Hover ''Import'' to open the sub-menu.
# Select the type of 3D asset. For those using medieval assets, select ''FBX (.fbx)''.
# Find the asset on the computer...<br>'''Tip:''' Use Unity to find the <code>.fbx</code> asset.
## For the medieval assets, that's in <code>Assets/PolyRonin/Medieval Market Stalls/Meshes/medieval-market-stalls-1.fbx</code>.
## Right click on it and select ''Show in explorer''.
## Now copy the address of that folder from Explorer. It might look like <code>C:\Users\Wug\EcoMod--WikiDemo\WikiDemo\Assets\PolyRonin\Medieval Market Stalls\Meshes</code>.
## Paste that in the address bar of the <u>Blender</u> import pop-up.
# Select the blue ''Import FBX'' button''.''
# Be in the ''Layout'' workspace (top toolbar) and in the ''Object Mode...''
## Find the drop down in the second toolbar from the top that has options like ''Object Mode, Edit Mode, Sculpt Mode,'' etc.
## Select ''Object Mode'' from that drop down.
# Change the Viewport Shading to Material Preview or Rendered. This is on the second toolbar down, far right of center, but before ''Scene Collection'' section.
# If you see purple models, Blender will need help finding textures for these meshes...
## From the top toolbar, open the ''File'' drop down.
## Hover ''External Data'' to open the sub-menu.
## Select ''Find Missing Files...''
## Point this to the whole directory that the 3D assets came in. For the medieval pack, <code>C:\Users\</code><code>Wug\EcoMod--WikiDemo\WikiDemo\Assets\PolyRonin</code>.
## The proper textures/materials should have now loaded in. If it hasn't, consult Google because without the textures the following steps won't produce a usable icon.
# Add a source of light...
## Still be in the ''Layout'' workspace (top toolbar) and in the ''Object Mode...''
### Find the drop down in the second toolbar from the top that has options like ''Object Mode, Edit Mode, Sculpt Mode,'' etc.
### Select ''Object Mode'' from that drop down.
## From the toolbar just under that one, find and open the ''Add'' drop down.
## Hover ''Light'' to open that sub-menu.
## Click ''Sun''.
# Add a camera...
## In the ''Layout'' workspace (top toolbar) and in the ''Object Mode...''
### Find the drop down in the second toolbar from the top that has options like ''Object Mode, Edit Mode, Sculpt Mode,'' etc.
### Select ''Object Mode'' from that drop down.
## From the second toolbar down, find and open the ''Add'' drop down.
## Select ''Camera''.
# Setup the scene with the object placement and lighting direction desired.<br>'''Tip:''' To reset the editor to something selected press the period key <u>on the numpad</u>. Without a numpad, use ''View'' (second toolbar from the top) and select ''Frame Selected'' from it. Alternatively, just set the zoom to zoom to the mouse position: ''Edit'' (top toolbar), ''Preferences'' (from drop down), ''Navigation'' (on left menu), ''Zoom to Mouse Position'' (In the zoom section). This makes moving around a lot more natural feeling.
# Setup the rendering camera...
## Go to ''Rendering'' tab on the top toolbar
## On the right there will be a side-panel open, it should be the ''Render'' tab. Confirm that.
## Change ''Render Engine'' to ''Cycles''.
## Look down below in the same tab for the ''Film'' section.
## Expand it and find the ''Transparent'' checkbox and section. Click it so that it has a check mark. This will make the icon's background transparent.
## Now, go to the ''Output'' tab <u>on the side panel</u>. The tab is just below the current one.
## In the ''Format'' section set ''Resolution X'' to ''64.'' And ''Y'' to ''64'' as well. This will make the icon generated a 64 by 64 pixel image.
# Go back to the ''Layout'' tab from the top toolbar.
# Center your view on the object (numpad period or ''View > Frame Selected''). Adjust it so that the object is how it should be for the icon.
# Align the camera to the view...
## Make sure the editor is in ''Layout'' workspace (top toolbar) and in the ''Object Mode...''
### Find the drop down in the second toolbar from the top that has options like ''Object Mode, Edit Mode, Sculpt Mode,'' etc.
### Select ''Object Mode'' from that drop down.
## Find ''View'' from the second from the top toolbar and open the drop down.
## Hover ''Align View'' to open the sub-menu.
## Select ''Align Active Camera To View''.
## If the view is slightly off, there is a lock icon on the right side of this panel. Use it to "lock" controls to the camera and tweak it's view.
# Now return to the ''Rendering'' tab from the top toolbar.
# Press the F12 key to start the render. This should complete quickly since 64x64 pixels is a very small render.
# A window should popup, ''Blender Render''. This is the icon!
# From the top tool bar of this ''Blender Render'' window, open the ''Image'' drop down.
# Select ''Save As...'' to save somewhere on the computer.
# Return to step 13 and repeat to do larger images if desired. Create a 128 by 128 pixel image too. It will make things smoother later.
# Save the Blender scene. Not only will it be used later, this will make making a new icon with a small tweak that much easier.
## ''File'' drop down from top toolbar.
## ''Save As...'' to save the Blender scene to the computer.
## Save it to <code>Assets/WikiDemo/MedievalStall - Icon Scene.blend</code>.

=== Adding to Unity Scene ===
The developers explain how to create an item in one of ModKit's read me files (See: <code>Assets/EcoModKit/Docs/README.md</code>), but this guide will explain it below.

Additionally, '''TheKye''' on YouTube covers this in their ''Creating Your First Item'' and ''Creating Your First Item Pt 2'' videos.

Use those additional resource to help troubleshoot issues with item's icons.

# Open <u>Unity</u>.
# In the left panel, the ''Hierarchy'' tab should be selected.
# Select the top-most object there. It should be a scene. If the editor last loaded the ''Demo'' scene from the medieval assets, it'll be named ''Demo''.
# Right click on this scene and select ''Add New Scene'' from the menu.
# Right click again on the old scene (''Demo'') and select ''Remove Scene''.
# Let it save if the changes to the old scene are important. Discard if it was open just for exploration's sake.
# Right click the new, ''Untitled'' scene. Click ''Save Scene As...''
# Save it to <code>Assets/WikiDemo.unity</code>.
# Delete <u>anything</u> in the scene.
# Right click the scene, hover ''GameObject'', and select ''Create Empty'' from the sub-menu.
# Name this new object ''Objects''.
# Select the newly created ''Objects'' object from the ''Hierarchy'' menu.
# On the far right side of the screen, in the ''Inspector'' menu, click the ''Add Component'' button.
# Type in ''ModkitPrefabContainer''. Click on the component from the search to add it. The component now should be listed in the ''Inspector''.
# In the ''Hierarchy'' panel right click the scene, hover ''GameObject'', and select ''Create Empty''.
# Name this new object ''Items''.
# Right click the scene, hover ''GameObject'', and select ''Create Empty''.
# Name this new object ''Emoji''.
# Select the newly created ''Emoji'' object, find the ''Inspector'' menu (far-right), and click the ''Add Component'' button.
# Type in ''ChatEmoteSetOld''. Click on the component from the search to add it. That component should now be listed in the ''Inspector''.
# Right click the scene, hover ''GameObject'', and select ''Create Empty''.
# Name this new object ''BlockSets''.
# Select the newly created ''BlockSets'' object, find the ''Inspector'' menu (far-right), and click ''Add Component''.
# Search for ''BlockSetContainer''. Click on the component from the search to add it. The ''Inspector'' should now show that component as added.
#Go to <code>Assets/EcoModKit/Prefabs</code> in the Unity project window.
# Find the prefab ''ItemTemplate''.
# Drag it onto the ''Items'' object in the ''Hierarchy'' panel. It should add it as a <u>child</u> of the ''Items'' object.
# Right click on the new ''ItemTemplate'' object, hover ''Prefab'', and select ''Unpack Completely''.
# Right click on the ''ItemTemplate'' object and select ''Rename''. Name this what you want the item to be called. Example: ''MedievalStallItem''.
# Set this item's background...
## Here's the default backgrounds (blue = item, brown = block, green = food): <br>[[File:Eco - Item - Background.png|border|frameless]] [[File:Eco - Block - Background.png|frameless]] [[File:Eco - Food - Background.png|frameless]]
## Download or prepare the background and add it to the <code>Assets</code> folder in Unity.
### To follow along lockstep, put the background in a new <code>Assets/WikiDemo</code> folder.
### Right click on <code>Assets</code> folder, hover ''Create'', select ''Folder''.
### Name the folder ''WikiDemo''.
## Configure Unity to use these as sprites...
### Select the background(s) added (Ctrl+Click each one).
### In the ''Inspector'', find ''TextureType'' and change that to ''Sprite (2D and UI)''.
### Again in the ''Inspector'', find ''SpriteMode'' and change that to ''Single''.
### Then scroll and go to the bottom of the ''Inspector'' and find the ''Apply'' button.
### This will apply those changes to that file and all other ones highlighted.
## Select the item being created (''MedievalStallItem'').
## In the ''Inspector'' panel (far-right), scroll and find the ''Item Template (Script)'' section.
## In here find the ''Background'' input. It'll say ''Background (Image)'' in it. If clicked that text to reveal and highlight the related object in the ''Hierarchy'' panel.
## Select the revealed, and highlighted object ''Background''.
## In the ''Inspector'' panel, scroll and find the ''Image'' component section.
## Inside that component's section, find ''Source Image''. It'll say ''Missing (Sprite)''. Click the ''⦿'' button to the right.
## The ''Select Sprite'' popup will show. Make sure the ''Assets'' tab is selected, and find the backgrounds desired.
#Create the foreground image...
##This is easily accomplished in MS Paint.
##Get to the background image file in a <u>file explorer</u>.
##Right click on it, hover ''Open with...'', and select ''Paint''.
##The solid background should be displayed.
##Open the ''File'' menu from the top toolbar.
##Hover ''Import to Canvas'' and select ''From a File''.
##Find the icon in the file browser and import it. Match the size of the background image to have it nicely center itself.
##Now ''File'' from the top toolbar.
##Hover ''Save As...'' and select ''PNG''.
##Save this to the <code>Assets/WikiDemo</code> folder in Unity.
##Configure Unity to use these as sprites...
### Select the foreground image.
### In the ''Inspector'', find ''TextureType'' and change that to ''Sprite (2D and UI)''.
### Again in the ''Inspector'', find ''SpriteMode'' and change that to ''Single''.
### Then scroll and go to the bottom of the ''Inspector'' and find the ''Apply'' button.
### This will apply those changes to that file and all other ones highlighted.
#Set this item's foreground...
## Copy the item's icon into the <code>Assets</code> folder.
## Configure Unity to use it as a sprite (see the previous step's ''Set this item's background...'' instructions)
## Select the item being created (''MedievalStallItem'').
## In the ''Inspector'' panel (far-right), scroll and find the ''Item Template (Script)'' section.
## In here find the ''Foreground'' input. It'll say ''Foreground (Image)'' in it. If clicked that text to reveal and highlight the related object in the ''Hierarchy'' panel.
## Select the revealed, and highlighted object ''Foreground''.
## Use the ''Inspector'', find the ''Image'' component, within that component find the ''Source Image'' input. It will say ''Missing (Sprite)''.
## Click the ''⦿'' button to the right of that input.
## From the ''Select Sprite'' popup, ensure the ''Assets'' tab is being searched, and find the icon just created.

=== Export From Unity ===

# Open the ''File'' menu from the top toolbar.
# Select ''Save.'' Save it to the <code>Assets/WikiDemo</code> folder.<br>'''Note:''' Do not skip. The scene must be saved for the ModKit build to work properly.
# Open the ''Eco Tools'' menu from the top toolbar.
# Hover ''Mod Kit'' to open the sub-menu.
# Select ''Build Current Bundle''.
# Have it output the bundle to <code>/Eco Server/Mods/UserCode/WikiDemo.unity3d</code>
# Wait for this to build. This may take a few minutes.

=== Scripting the Item ===
For this guide, all code will be placed in a single <code>.cs</code> file and will not be compiled into a <code>.dll</code>.

# Create a <code>.cs</code> file: <code>/Eco Server/Mods/UserCode/WikiDemo.cs</code>
# Put the following into the newly created file:
<syntaxhighlight lang="c#" line="1">using Eco.Core.Items;
using Eco.Gameplay.Items;
using Eco.Shared.Localization;
using Eco.Shared.Serialization;

namespace WikiDemo
{
#region Item
[Serialized] // Tells the save/load system this object needs to be serialized.
[LocDisplayName("Market Stall")] // Defines the localized name of the item.
[Weight(100)] // Defines how heavy Arrow is.
[Ecopedia("Work Stations", "Craft Tables", createAsSubPage: true)]
[LocDescription("A medieval market stall.")] //The tooltip description for the item.
public partial class MedievalStallItem: Item { }
#endregion
}</syntaxhighlight>'''Line 8:''' A region tag. Lets the editor know it can collapse all of that code as a section. The following examples in this guide will just show <code>#region Item</code> in their code examples.

'''Line 13:''' The implementation of <code>Item</code> means that Eco will find this and look for Unity assets that matching this class' name, <code>MedivalStallItem</code>. While this doesn't do anything fancy, it completes the first step towards a new workbench.

=== Checkpoint #1 ===
[[File:Eco - Hotbar With Modded Icon.png|thumb|Shows the medieval stall as a modded icon in-game.]]
Make sure everything is running smoothly by doing the following:

# Double-check that the <code>WikiDemo.unity3d</code> and the <code>WikiDemo.cs</code> files are in <code>/Eco Server/Mods/UserCode</code> folder.
# Start the server and connect to it.
# Test it out by typing <code>/give MedievalStall</code> in chat.
## It's also possible to do <code>/give Market Stall</code> to get the item. How? Line 10: of the the above code declares that name as this item's "common name". Neat.
# The item should appear in the players inventory with a working icon.

== Code the Item's Recipe ==
The following goes over how to add a new class and implement the <code>RecipeFamily</code> interface.<syntaxhighlight lang="c#" line="1">using Eco.Core.Items;
using Eco.Gameplay.Components;
using Eco.Gameplay.Items;
using Eco.Gameplay.Items.Recipes;
using Eco.Gameplay.Skills;
using Eco.Mods.TechTree;
using Eco.Shared.Localization;
using Eco.Shared.Serialization;
using System.Runtime.Versioning;
using System.Collections.Generic;

namespace WikiDemo
{
#region Item

#region Recipe
[RequiresSkill(typeof(CarpentrySkill), 3)]
[Ecopedia("Work Stations", "Craft Tables", subPageName: "Market Stall")]
public partial class MedievalStallRecipe : RecipeFamily
{
[SupportedOSPlatform("windows7.0")]
public MedievalStallRecipe()
{
var recipe = new Recipe();
recipe.Init(
name: "MedievalStallItem",
displayName: Localizer.DoStr("Market Stall"),
ingredients: new List<IngredientElement>
{
new IngredientElement("Wood", 40, typeof(Skill)),
new IngredientElement(typeof(CottonFabricItem), 30, typeof(Skill)),
new IngredientElement(typeof(HempMooringRopeItem), 5, true)
},
items: new List<CraftingElement>
{
new CraftingElement<MedievalStallItem>(1)
}
);
this.Recipes = new List<Recipe> { recipe };
this.LaborInCalories = CreateLaborInCaloriesValue(800, typeof(Skill));
this.CraftMinutes = CreateCraftTimeValue(typeof(MedievalStallRecipe), 10f, typeof(Skill));

// Perform pre/post initialization for user mods and initialize our recipe instance with the display name "Market Stall"
this.ModsPreInitialize();
this.Initialize(displayText: Localizer.DoStr("Market Stall"), recipeType: typeof(MedievalStallRecipe));
this.ModsPostInitialize();

// Register our RecipeFamily instance to a work table (in this case the Carpentry Table) so it can be crafted.
CraftingComponent.AddRecipe(tableType: typeof(CarpentryTableObject), recipeFamily: this); // NOTE: The table must be the object instance!
}

/// <summary>Hook for other mods to customize RecipeFamily before initialization.</summary>
partial void ModsPreInitialize();

/// <summary>Hook for other mods to customize RecipeFamily after initialization, but before registration. You can change skill requirements here.</summary>
partial void ModsPostInitialize();
}
#endregion
}</syntaxhighlight>'''Line 10:''' Eco will need this explicitly added to the file. Visual Studio will not add this line automatically. It's used for the <code>List<T></code> objects found in this code.

'''Line 14:''' "Collapsed" <code>Item</code> section. See the earlier sections in this guide for the code that belongs there.

'''Line 17:''' Sets the required skill and skill level to craft this recipe.

'''Line 21:''' <code>[SupportedOSPlatform("windows7.0")]</code> is here to silence some annoying warnings in Visual Studio. It's optional.

'''Line 30-32:''' Declares the input ingredients used for crafting. <code>typeof(Skill)</code> gets mapped to the <code>CarpentrySkill</code> as defined by line 31. In this example the <code>HempMooringRope</code> is a static input. A static input will not be modified by skills, upgrade modules, or game settings.<br>'''Note:''' It seems that at the time of writing (4/21/2026, Eco v13.0.2) the only way to get an ingredient to be a dynamic value that is reduced by the table's upgrade is to pass <code>typeof(Skill)</code> to it; Passing either <code>true</code> or <code>false</code> makes the this input static.

'''Line 34:''' The <code>items</code> list declares what items are <u>output</u> by this recipe.

'''Line 36:''' This line declares that one medieval stall is output from this recipe. Functionally this links this recipe to the <code>MedievalStallItem</code> (aka "Market Stall") item created in the last step.

'''Line 40:''' Amount of calories needed to craft this item. For a static value (not modified by upgrades or skill levels) change this line to: <code>this.LaborInCalories = CreateLaborInCaloriesValue(800);</code>. As it's written in the example, this item's calorie cost will be dynamic (modified by upgrades and skill levels). The skill level that will modify it is declared on line 16.

'''Line 41:''' Minutes needed to craft. Both static and dynamic values for crafting time can be modified by the world difficulty settings. For a static value change this line to: <code>this.CraftMinutes = CreateCraftTimeValue(10f);</code>. As it's written in the example, this item's craft time will be dynamic.

'''Line 49:''' This line assigns the recipe to a workbench. <u>Do not assign</u> to itself because then the first table could never be made. It's recommend to use a preexisting vanilla table.
=== Checkpoint #2 ===
Check the functionality at this point -- it should be possible to see the recipe in the crafting table.

# Have the <code>.unity3d</code> and the <code>.cs</code> file in the <code>/Eco Server/Mods/UserCode</code> folder.
# Start the server and log in.
# Type <code>/give Carpentry Table</code>.
# Place the Carpentry Table down and interact to see the what can be crafted.
# Find the newly added recipe under the name ''Market Stall.''
# Type <code>/give Basic Upgrade 4</code>.
# Put the basic upgrade into the table.
# Go back to the recipe for the ''Market Stall'' and make sure the Wood and the Cotton fabric inputs now require less, but the Hemp Mooring Rope still is the same.<br>'''Note:''' In case the recipe hasn't changed close that table's window and interact with it again. It should for the recipes to refresh now that the upgrade is in it.

== Create the World Object ==
=== Preparing the 3D Asset ===
# Open <u>Blender</u>.
# Load the 3D object created earlier for icon rendering -- <code>Assets/WikiDemo/MedievalStall - Icon Scene.blend</code>.
# Cleanup the scene...
## Delete any light source. Use the ''Scene Collection'' panel on the top-right side of the screen. These will have a 💡 icon and by default are named something like "sun", "point", "spot" or "area".<br>'''Note:''' If your model is a light source or has one in it, you can leave that light source. The point here is to remove the ambient lights used for icon rendering.
## Delete any camera(s). Again, use the ''Scene Collection'' panel. These have a 🎥 icon and by default are named something like "camera".
# <u>If there are multiple different 3D assets in the scene</u> (like bags, crates, jars, ect.), join them all together...
## Select all of the meshes by holding ''Shift'' and clicking on each one in the ''Scene Collection'' panel (right side of window).<br>'''Tip:''' Quickly select a group of them by selecting one near the top. Then hold ''Shift'', ''Ctrl,'' and click on one near the bottom. This will both the one at the top and the one at the bottom, but also every item in between. Neat!
## Be in ''Layout'' workspace (top toolbar) and in the ''Object Mode...''
### Find the drop down in the second toolbar from the top that has options like ''Object Mode, Edit Mode, Sculpt Mode,'' etc.
### Select ''Object Mode'' from that drop down.
## Find and open the ''Object'' menu (second toolbar down from the top).
## Select ''Join''.
## In the ''Scene Collection'' panel, double click on the name of the newly joined mesh.
# Rename the joined mesh to <code>MedievalStallMesh</code>.
# Add and position a reference cube...
## Make sure the editor is in ''Layout'' view (top toolbar) and in the ''Object Mode...''
### Find the drop down in the second toolbar from the top that has options like ''Object Mode, Edit Mode, Sculpt Mode,'' etc.
### Select ''Object Mode'' from that drop down.
## Then, add a reference cube. Open the ''Add'' menu (second top toolbar down).
## Hover ''Mesh''.
## Select ''Cube.''
## Open the ''View'' menu (second toolbar down).
## Select ''Sidebar''.
## A new panel will have expanded.
## Along the right side of that panel there's buttons (''Item, Tool, View, Animation''). Find and click the ''Item'' button.
## Find and expand the ''Transform'' section
## Set the ''Location...''
### ''X'' to ''1''.
### ''Y'' to ''1''.
### ''Z'' to ''1''.
## The bottom corner of the cube should be touching the where green and red axis lines meet.
# Move the reference cube's origin to <code>(0, 0, 0)</code>...
## Be in ''Layout'' workspace (top toolbar) and in the ''Object Mode...''
### Find the drop down in the second toolbar from the top that has options like ''Object Mode, Edit Mode, Sculpt Mode,'' etc.
### Select ''Object Mode'' from that drop down.
## Open the ''View'' menu (second toolbar down).
## Select ''Sidebar''.
## A new panel will have expanded.
## Along the right side of that panel there's buttons (''Item, Tool, View, Animation''). Find and click the ''View'' button.
## Find and expand the ''3D Cursor'' section.
## Set the 3D cursor's ''Location''...
### ''X'' to ''0''.
### ''Y'' to ''0''.
### ''Z'' to ''0.''
## Now in the ''Scene Collection'' panel, click on the ''Cube'' mesh to highlight and select it.
## Open the ''Object'' menu from the second toolbar down from the top.
## Hover ''Set Origin''.
## Select ''Origin to 3D Cursor''.
# Set the reference cube's dimensions...
## Be in ''Layout'' workspace (top toolbar) and in the ''Object Mode...''
### Find the drop down in the second toolbar from the top that has options like ''Object Mode, Edit Mode, Sculpt Mode,'' etc.
### Select ''Object Mode'' from that drop down.
## Open the ''View'' menu (second toolbar down).
## Select and check the ''Sidebar'' option''.''
## The ''Sidebar'' menu just expanded over on the right side of the screen.
## To the right of the ''Sidebar'', find and click the ''Item'' button.
## Expand the ''Transform'' section.
## Set the ''Dimensions...'''''<br>Note:''' These dimensions only make sense for the asset being used for this guide. If using a different one, set the dimensions to the size of the box that model should fit in.
### ''X'' to ''4''.
### ''Y'' to ''3''.
### ''Z'' to ''3''.
# Adjust the position and scale of the ''MedievalStallMesh'' to fit inside a box.
## Be in ''Layout'' workspace (top toolbar) and in the ''Object Mode...''
### Find the drop down in the second toolbar from the top that has options like ''Object Mode, Edit Mode, Sculpt Mode,'' etc.
### Select ''Object Mode'' from that drop down.
## On the left side of the screen there's a column of icons. Hover over them to see their names.
## Select the ''Move'' tool.
## Click on the Medieval Stall to select it. Zoom out and reposition the camera so that the blue, green, and red arrows are visible.<br>'''Tip:''' By holding the middle-mouse button and dragging the scene will rotate. By holding the middle-mouse button and the ''Shift'' key, the scene will pan.<br>'''Tip:''' If panning or rotating the scene becomes slow or frustrating (especially after zooming), try selecting 3D asset from the ''Scene Collection'' panel, opening the ''View'' menu (second toolbar from top), and selecting ''Frame Selected''. This will reset the view onto that object and controls should feel normal again.
## Click and hold one of the arrows. Move the mouse to drag the 3D asset towards the box.
## Move the 3D asset around till it's <u>completely inside the box</u>. If it cannot fit and is too big, continue to the next step.<br>'''Tip:''' To select the 3D asset once it disappears, use the ''Scene Collection'' panel. Click on it there and the blue, green, and red arrows will show up again for it.<br>'''Tip:''' There are preset views. To use them go to the ''View'' menu (second toolbar from top)'','' hover ''Viewpoint'', and select the view that would be most helpful.
## Find the ''Scale'' tool from the left side of the screen.
## Now the blue, green, and red "arrows" don't really look like arrows anymore. They are lines with boxes at the end.
## Click and hold on those lines to adjust the scale of the 3D asset to make it fit inside the box.<br>'''Tip:''' There are little colored boxes in between the lines that can be dragged to scale the 3D asset more proportionally.
## Continue using the ''Move'' and ''Scale'' tools till the model fits. This will take patience and time.<br>'''Tip:''' Hide the reference cube to see what is happening with the 3D asset. Go to the ''Scene Collections'' panel and click the 👁 button to hide it. Click that button again to show it.
# Move the reference cube's origin to <code>(0.5, 0.5, 0.5)</code>...
## Be in ''Layout'' workspace (top toolbar) and in the ''Object Mode...''
### Find the drop down in the second toolbar from the top that has options like ''Object Mode, Edit Mode, Sculpt Mode,'' etc.
### Select ''Object Mode'' from that drop down.
## Open the ''View'' menu (second toolbar down).
## Select ''Sidebar''.
## A new panel will have expanded.
## Along the right side of that panel there's buttons (''Item, Tool, View, Animation''). Find and click the ''View'' button.
## Find and expand the ''3D Cursor'' section.
## Set the 3D cursor's ''Location''...
### ''X'' to ''0''.5.
### ''Y'' to ''0.5''.
### ''Z'' to ''0.5.''
## Select the ''MedievalStallMesh'' using the ''Scene Collection'' panel.
## Open the ''Object'' menu (second toolbar down).
## Hover ''Set Origin''.
## Select ''Origin to 3D Cursor''.
# Select the reference cube named ''Cube'' from the ''Scene Collections'' panel.
# Open ''Object'' menu (second toolbar down).
# Select ''Delete''.
# Move the ''MedievalStallMesh'' to <code>(0, 0, 0)</code>...
## Be in ''Layout'' workspace (top toolbar) and in the ''Object Mode...''
### Find the drop down in the second toolbar from the top that has options like ''Object Mode, Edit Mode, Sculpt Mode,'' etc.
### Select ''Object Mode'' from that drop down.
## Open the ''View'' menu (second toolbar down).
## Select ''Sidebar''.
## A new panel will have expanded.
## Along the right side of that panel there's buttons (''Item, Tool, View, Animation''). Find and click the ''Item'' button.
## Make sure the ''MedievalStallMesh'' is selected. Use the ''Scene Collection'' panel if needed.
## Find and expand the ''Transform'' section
## Set the ''Location...''
### ''X'' to 0.
### ''Y'' to 0.
### ''Z'' to 0.
# Make sure the ''MedievalStallMesh'' is selected. Use the ''Scene Collection'' panel if needed.
# Open the ''Object'' menu.
# Hover ''Apply''.
# Select ''All Transformations''. '''Note:''' This step bakes all of the changes into the mesh. It's very important.
# Open the ''File'' menu from the top toolbar.
# Hover ''Export'' to open the sub-menu.
# Select ''FBX (.fbx)''
# A ''Blender File View'' window will pop-up.
# On the right side of this window there's a ⚙️ icon. Click it to expand the settings region.
# In the expanded region find the ''Include'' section and expand it. Change the following:
## Find ''Object Types'' and only select ''Mesh.'' No other option should be highlighted for this setting.
# In the settings region scroll and find the ''Transform'' section and expand it. Change the following:
## Find ''Apply Scalings'' and set it to ''FBX All''.
## Just below that find ''Forward'' and set it to ''Z Forward''.
## Ensure that the next setting down, ''Up'', changed to ''Y Up''.
## Find ''Apply Unit'' and make sure it's checked.
## Next, find ''Use Space Transform'' check it.
## Lastly, find ''Apply Transform'' and check it too.
# Save it to <code>Assets/WikiDemo/MedievalStall.fbx</code>.
# Save the Blender scene...
## ''File'' drop down from top toolbar.
## ''Save As...'' to save the Blender scene to the computer.
## Save it to <code>Assets/WikiDemo/MedievalStall - Eco Ready Scene.blend</code>.

=== Add to Unity Scene ===

# Open <u>Unity</u>.
# Select the <code>.fbx</code> file in the project window.
# Open the ''Eco Tools'' menu from the top toolbar.
# Hover ''Mod Kit''.
# Select ''World Object Setup.''
# A ''World Object Setup'' window will pop-up.
# Make sure that ''Selected Objects'' reads ''MedievalStall.''
# Also make sure that ''World Object Type'' is set to ''World Object''.
# Press the ''Setup World Objects'' button.
# Notice in the project window that a new <code>.prefab</code> file was created -- <code>MedievalStallObject.prefab</code>
# Select the <code>.prefab</code> file in the project window.
# Select ''Objects'' from ''Hierarchy'' panel (left-side of the window).
# Find the ''Modkit Prefab Container (Script)'' component.
# Expand the ''Prefabs'' section in that component.
# Click the ''+'' button to add an item to the list.
# Either...
## Click the ''⦿'' button, switch to the ''Assets'' tab, find or search for ''MedievalStallObject'', and double click on it. Make sure it's the medieval stall <u>object</u> with the <code>.prefab</code> ending.
## Drag the <code>.prefab</code> file onto the ''⦿'' button
# Open the ''File'' menu from top toolbar and select ''Save''.<br>'''Note:''' Do not skip. The scene must be saved for the ModKit build to work properly.
# Open the ''Eco Tools'' menu from the top toolbar.
# Hover ''Mod Kit''.
# Select ''Build Current Bundle''.
# Save the bundle to <code>/Eco Server/Mods/UserCode/WikiDemo.unity3d</code>

=== Scripting the World Object ===
WIP: Need occupancy code.

Code that links the Item to this World Object.<syntaxhighlight lang="c#" line="1">
using Eco.Core.Items;
using Eco.Gameplay.Components;
using Eco.Gameplay.Items;
using Eco.Gameplay.Items.Recipes;
using Eco.Gameplay.Objects;
using Eco.Gameplay.Skills;
using Eco.Mods.TechTree;
using Eco.Shared.Localization;
using Eco.Shared.Serialization;
using System.Collections.Generic;
using System.Runtime.Versioning;
using System;

namespace WikiDemo
{
#region Item
[Serialized] // Tells the save/load system this object needs to be serialized.
[LocDisplayName("Market Stall")] // Defines the localized name of the item.
[Weight(100)] // Defines how heavy Arrow is.
[Ecopedia("Work Stations", "Craft Tables", createAsSubPage: true)]
[LocDescription("A medieval market stall.")] //The tooltip description for the item.
public partial class MedievalStallItem : WorldObjectItem<MedievalStallObject> { }
#endregion

#region Recipe

#region Object
[Serialized]
public partial class MedievalStallObject : WorldObject, IRepresentsItem
{
public Type RepresentedItemType => typeof(MedievalStallItem);
}
#endregion
}
</syntaxhighlight>'''Line 22:''' This changes from implementing <code>Item</code> to <code>WorldObjectItem<MedievalStallObject></code>. This is what gives the item the ability to place the table down in the world.

'''Line 25:''' The "collapsed" Recipe section. See earlier sections in this guide to see what code belongs here.

'''Line 29:''' Declares the <code>MedievalStallObject</code>. It's important that this class name is matches exactly the <code>.prefab</code> file name because the name is what links them.

'''Line 31:''' This line is similar in function to line 22, it's declaring that this <code>MedievalStallObject</code> is <code>MedievalStallItem</code> when in inventories.

=== Checkpoint ===
'''Warning:''' In ''Eco'' v13.0.2, free-placed objects may display misaligned ghost cubes, even when configured correctly in your mod. This is a visual-only base-game bug—placement still works as expected, even if the object appears red near edges. 

Export and see what it does. Ensure it's not lifting off the ground because of a non-curved shader.

==== Origin Point Editing ====
Talk about what it does: the point that the simulation considers this world object to be at.

Show how to move it around using blender.

== Final Export ==
Export.

Package.

Distribute.

From 3D Asset to Working Worktable

2026-04-27T21:11:21Z

WugWugg: Giving up for now.

= Introduction =
Below is a guide on how to take an 3D asset from the Unity Store and make a working workbench in Eco. This includes:
* Creating a recipe to craft the modded table
* Creating recipes so the player can use the modded table to craft something
* Using Blender to generate a modded icon (seen when holding it in inventory)
* Using Blender to adjust the origin point of the model
* How to setup all this in a Unity scene and package for Eco

= Setup =

* Already have setup '''ModKit + Unity'''
** See: [[Installing the ModKit]]
* Have a '''3D model'''
** Just following along? Find the one used here at <code><nowiki>https://assetstore.unity.com/packages/3d/props/low-poly-medieval-market-stalls-314286</nowiki></code>
* A '''C# IDE''' (notepad++, Visual Studio, etc.)
** Highly encouraged to have an Intellisense setup and linked to the '''Reference Assemblies'''. Optional, but its really worth the time to figure out because it will help quickly correct small typos and trivial mistakes.
** See: [[Getting Started with Eco Modding in Visual Studio 2022]] (generally the same steps apply if using a new version of Visual Studio)
* '''Blender''' installed
** Homepage: <code><nowiki>https://www.blender.org/</nowiki></code>

== Importing the Assets ==

# Open the Unity editor to the project.
# From the top toolbar open the ''Window'' drop down.
# Hover ''Package Management'' to open sub-menu.
# Select ''Package Manager''.
# The ''Package Manager'' window will pop-up.
# Install the package containing the assets you want to use...
## <u>If not using Unity Registry</u>...
### Find the ''+▾'' button in the top left and open the drop down.
### Install the package from one of those options.
## <u>If using Unity Registry</u>...
### Visit <code><nowiki>https://assetstore.unity.com</nowiki></code> and sign in.
### Search for the asset desired.
### Go to it's page (e.g. <code><nowiki>https://assetstore.unity.com/packages/3d/props/low-poly-medieval-market-stalls-314286</nowiki></code>) and click the big blue button, ''Add to My Assets.''
### Now, in the Unity editor and back at the ''Package Manager'' window.
### Find ''My Assets'' on the left menu and navigate to it.
### Click the ''⟳'' button in the lower-right.
### The asset should be in the list now. Use the search to filter if needed.
### Click on the asset in the list. For those following along, ''Low Poly Medieval Market Stalls''.
### In the right panel, find the ''Download ⤓'' button. Click it.
### Once downloaded, a new button should show up, it'll say something like ''⊕ Import 1.0 to project'' . Click it.
### The ''Import Unity Package'' window will pop-up.
### Select ''Import'' on it.
# Verify you can find your assets from the explorer. If following along, the assets are at <code>Assets/PolyRonin/Medieval Market Stalls</code>.
# Load in a demo scene, if provided, and make sure everything looks okay.
## For those following along, double click on the ''Demo'' scene at <code>Assets/PolyRonin/Medieval Market Stalls/Demo.unity</code>.

[[File:Eco - Unity - View Modes.png|thumb|Underlined in red are the different draw mode buttons. <u>4/20/26</u>]]
If something seems off, check the different draw modes and see if changing those allow the scene to render as expected (see picture).

With all that setup, it's time to get to the creation parts.

= Creating The Worktable =
This guide will create the worktable in this order:

# Create the item that represents the worktable
# Make a recipe to craft the worktable item
# Make the worktable item something that places a world object
# Give the worktable functionality by adding recipes to it

== Creating the Item ==

=== Item Icon ===
[[File:TeamstersStall - StallOnly - 256x256.png|thumb|A large (256x256px) icon created of Stall4 from the medieval assets.]]
This process is also explained here, <code><nowiki>https://mod.io/g/eco/r/origin-points-icon-images-with-blender</nowiki></code>, check it out if you need more visual reference points as that guide has a lot of pictures.

# Open <u>Blender</u>.
# Delete everything in the ''Scene Collection''. Find this section in the top-right of the application.
# From the top toolbar, open the ''File'' drop down.
# Hover ''Import'' to open the sub-menu.
# Select the type of 3D asset. For those using medieval assets, select ''FBX (.fbx)''.
# Find the asset on the computer...
## Tip: Use Unity to find the <code>.fbx</code> asset. For the medieval assets, that's in <code>Assets/PolyRonin/Medieval Market Stalls/Meshes/medieval-market-stalls-1.fbx</code>.
## Right click on it and select ''Show in explorer''.
## Now copy the address of that folder from Explorer. It might look like <code>C:\Users\Wug\EcoMod--WikiDemo\WikiDemo\Assets\PolyRonin\Medieval Market Stalls\Meshes</code>.
## Paste that in the address bar of the <u>Blender</u> import pop-up.
# Select the blue ''Import FBX'' button''.''
# From ''Layout'' mode, change the Viewport Shading to Material Preview or Rendered. This is on the second toolbar down, far right of center, but before ''Scene Collection'' section.
# If you see purple models, Blender will need help finding textures for these meshes...
## From the top toolbar, open the ''File'' drop down.
## Hover ''External Data'' to open the sub-menu.
## Select ''Find Missing Files...''
## Point this to the whole directory that the 3D assets came in. For the medieval pack, <code>C:\Users\</code><code>Wug\EcoMod--WikiDemo\WikiDemo\Assets\PolyRonin</code>.
## The proper textures/materials should have now loaded in. If it hasn't, consult Google because without the textures the following steps won't produce a usable icon.
# Add a source of light...
## Make sure the editor is in the ''Layout'' mode by checking the top most toolbar.
## From the toolbar just under that one, find and open the ''Add'' drop down.
## Hover ''Light'' to open that sub-menu.
## Click ''Sun''.
# Add a camera...
## Again make sure the editor is in the ''Layout'' mode.
## From the second toolbar down, find and open the ''Add'' drop down.
## Select ''Camera''.
# Setup the scene with the object placement and lighting direction desired. '''Tip:''' To reset the editor to something selected press the period key <u>on the numpad</u>. Without a numpad, use ''View'' (second toolbar from the top) and select ''Frame Selected'' from it. Alternatively, just set the zoom to zoom to the mouse position: ''Edit'' (top toolbar), ''Preferences'' (from drop down), ''Navigation'' (on left menu), ''Zoom to Mouse Position'' (In the zoom section). This makes moving around a lot more natural feeling.
# Setup the rendering camera...
## Go to ''Rendering'' tab on the top toolbar
## On the right there will be a side-panel open, it should be the ''Render'' tab. Confirm that.
## Change ''Render Engine'' to ''Cycles''.
## Look down below in the same tab for the ''Film'' section.
## Expand it and find the ''Transparent'' checkbox and section. Click it so that it has a check mark. This will make the icon's background transparent.
## Now, go to the ''Output'' tab <u>on the side panel</u>. The tab is just below the current one.
## In the ''Format'' section set ''Resolution X'' to ''64.'' And ''Y'' to ''64'' as well. This will make the icon generated a 64 by 64 pixel image.
# Go back to the ''Layout'' tab from the top toolbar.
# Center your view on the object (numpad period or ''View > Frame Selected''). Adjust it so that the object is how it should be for the icon.
# Align the camera to the view...
## Make sure the editor is in ''Layout'' mode (top toolbar).
## Find ''View'' from the second from the top toolbar and open the drop down.
## Hover ''Align View'' to open the sub-menu.
## Select ''Align Active Camera To View''.
## If the view is slightly off, there is a lock icon on the right side of this panel. Use it to "lock" controls to the camera and tweak it's view.
# Now return to the ''Rendering'' tab from the top toolbar.
# Press the F12 key to start the render. This should complete quickly since 64x64 pixels is a very small render.
# A window should popup, ''Blender Render''. This is the icon!
# From the top tool bar of this ''Blender Render'' window, open the ''Image'' drop down.
# Select ''Save As...'' to save somewhere on the computer.
# Return to step 13 and repeat to do larger images if desired. Create a 128 by 128 pixel image too. It will make things smoother later.
# Save the Blender scene. Not only will it be used later, this will make making a new icon with a small tweak that much easier.
## ''File'' drop down from top toolbar.
## ''Save As...'' to save the Blender scene to the computer.
## Save it to <code>Assets/WikiDemo/MedievalStall - Icon Scene.blend</code>.

=== Adding to Unity Scene ===
The developers explain how to create an item in one of ModKit's read me files (See: <code>Assets/EcoModKit/Docs/README.md</code>), but this guide will explain it below.

Additionally, '''TheKye''' on YouTube covers this in their ''Creating Your First Item'' and ''Creating Your First Item Pt 2'' videos.

Use those additional resource to help troubleshoot issues with item's icons.

# Open <u>Unity</u>.
# In the left panel, the ''Hierarchy'' tab should be selected.
# Select the top-most object there. It should be a scene. If the editor last loaded the ''Demo'' scene from the medieval assets, it'll be named ''Demo''.
# Right click on this scene and select ''Add New Scene'' from the menu.
# Right click again on the old scene (''Demo'') and select ''Remove Scene''.
# Let it save if the changes to the old scene are important. Discard if it was open just for exploration's sake.
# Right click the new, ''Untitled'' scene. Click ''Save Scene As...''
# Save it to <code>Assets/WikiDemo.unity</code>.
# Delete <u>anything</u> in the scene.
# Right click the scene, hover ''GameObject'', and select ''Create Empty'' from the sub-menu.
# Name this new object ''Objects''.
# Select the newly created ''Objects'' object from the ''Hierarchy'' menu.
# On the far right side of the screen, in the ''Inspector'' menu, click the ''Add Component'' button.
# Type in ''ModkitPrefabContainer''. Click on the component from the search to add it. The component now should be listed in the ''Inspector''.
# In the ''Hierarchy'' panel right click the scene, hover ''GameObject'', and select ''Create Empty''.
# Name this new object ''Items''.
# Right click the scene, hover ''GameObject'', and select ''Create Empty''.
# Name this new object ''Emoji''.
# Select the newly created ''Emoji'' object, find the ''Inspector'' menu (far-right), and click the ''Add Component'' button.
# Type in ''ChatEmoteSetOld''. Click on the component from the search to add it. That component should now be listed in the ''Inspector''.
# Right click the scene, hover ''GameObject'', and select ''Create Empty''.
# Name this new object ''BlockSets''.
# Select the newly created ''BlockSets'' object, find the ''Inspector'' menu (far-right), and click ''Add Component''.
# Search for ''BlockSetContainer''. Click on the component from the search to add it. The ''Inspector'' should now show that component as added.
#Go to <code>Assets/EcoModKit/Prefabs</code> in the Unity project window.
# Find the prefab ''ItemTemplate''.
# Drag it onto the ''Items'' object in the ''Hierarchy'' panel. It should add it as a <u>child</u> of the ''Items'' object.
# Right click on the new ''ItemTemplate'' object, hover ''Prefab'', and select ''Unpack Completely''.
# Right click on the ''ItemTemplate'' object and select ''Rename''. Name this what you want the item to be called. Example: ''MedievalStallItem''.
# Set this item's background...
## Here's the default backgrounds (blue = item, brown = block, green = food): [[File:Eco - Item - Background.png|border|frameless]] [[File:Eco - Block - Background.png|frameless]] [[File:Eco - Food - Background.png|frameless]]
## Download or prepare the background and add it to the <code>Assets</code> folder in Unity.
### To follow along lockstep, put the background in a new <code>Assets/WikiDemo</code> folder.
### Right click on <code>Assets</code> folder, hover ''Create'', select ''Folder''.
### Name the folder ''WikiDemo''.
## Configure Unity to use these as sprites...
### Select the background(s) added (Ctrl+Click each one).
### In the ''Inspector'', find ''TextureType'' and change that to ''Sprite (2D and UI)''.
### Again in the ''Inspector'', find ''SpriteMode'' and change that to ''Single''.
### Then scroll and go to the bottom of the ''Inspector'' and find the ''Apply'' button.
### This will apply those changes to that file and all other ones highlighted.
## Select the item being created (''MedievalStallItem'').
## In the ''Inspector'' panel (far-right), scroll and find the ''Item Template (Script)'' section.
## In here find the ''Background'' input. It'll say ''Background (Image)'' in it. If clicked that text to reveal and highlight the related object in the ''Hierarchy'' panel.
## Select the revealed, and highlighted object ''Background''.
## In the ''Inspector'' panel, scroll and find the ''Image'' component section.
## Inside that component's section, find ''Source Image''. It'll say ''Missing (Sprite)''. Click the ''⦿'' button to the right.
## The ''Select Sprite'' popup will show. Make sure the ''Assets'' tab is selected, and find the backgrounds desired.
#Create the foreground image...
##This is easily accomplished in MS Paint.
##Get to the background image file in a <u>file explorer</u>.
##Right click on it, hover ''Open with...'', and select ''Paint''.
##The solid background should be displayed.
##Open the ''File'' menu from the top toolbar.
##Hover ''Import to Canvas'' and select ''From a File''.
##Find the icon in the file browser and import it. Match the size of the background image to have it nicely center itself.
##Now ''File'' from the top toolbar.
##Hover ''Save As...'' and select ''PNG''.
##Save this to the <code>Assets/WikiDemo</code> folder in Unity.
##Configure Unity to use these as sprites...
### Select the foreground image.
### In the ''Inspector'', find ''TextureType'' and change that to ''Sprite (2D and UI)''.
### Again in the ''Inspector'', find ''SpriteMode'' and change that to ''Single''.
### Then scroll and go to the bottom of the ''Inspector'' and find the ''Apply'' button.
### This will apply those changes to that file and all other ones highlighted.
#Set this item's foreground...
## Copy the item's icon into the <code>Assets</code> folder.
## Configure Unity to use it as a sprite (see the previous step's ''Set this item's background...'' instructions)
## Select the item being created (''MedievalStallItem'').
## In the ''Inspector'' panel (far-right), scroll and find the ''Item Template (Script)'' section.
## In here find the ''Foreground'' input. It'll say ''Foreground (Image)'' in it. If clicked that text to reveal and highlight the related object in the ''Hierarchy'' panel.
## Select the revealed, and highlighted object ''Foreground''.
## Use the ''Inspector'', find the ''Image'' component, within that component find the ''Source Image'' input. It will say ''Missing (Sprite)''.
## Click the ''⦿'' button to the right of that input.
## From the ''Select Sprite'' popup, ensure the ''Assets'' tab is being searched, and find the icon just created.

=== Export From Unity ===

# Open the ''File'' menu from the top toolbar.
# Select ''Save.'' Save it to the <code>Assets/WikiDemo</code> folder. '''Note:''' Do not skip. The scene must be saved for the ModKit build to work properly.
# Open the ''Eco Tools'' menu from the top toolbar.
# Hover ''Mod Kit'' to open the sub-menu.
# Select ''Build Current Bundle''.
# Have it output the bundle to <code>/Eco Server/Mods/UserCode/WikiDemo.unity3d</code>
# Wait for this to build. This may take a few minutes.

=== Scripting the Item ===
For a more complex mod, it would be wise to build it into a DLL. See [[Getting Started with Eco Modding in Visual Studio 2022]] for details on that.

# Create a <code>.cs</code> file: <code>/Eco Server/Mods/UserCode/WikiDemo.cs</code>
# Put the following into the newly created file:
<syntaxhighlight lang="c#" line="1">using Eco.Core.Items;
using Eco.Gameplay.Items;
using Eco.Shared.Localization;
using Eco.Shared.Serialization;

namespace WikiDemo
{
#region Item
[Serialized] // Tells the save/load system this object needs to be serialized.
[LocDisplayName("Market Stall")] // Defines the localized name of the item.
[Weight(100)] // Defines how heavy Arrow is.
[Ecopedia("Work Stations", "Craft Tables", createAsSubPage: true)]
[LocDescription("A medieval market stall.")] //The tooltip description for the item.
public partial class MedievalStallItem: Item { }
#endregion
}</syntaxhighlight>'''Line 8:''' A region tag. Lets the editor know it can collapse all of that code as a section. The following examples in this guide will just show <code>#region Item</code> in their code examples.

'''Line 13:''' The implementation of <code>Item</code> means that Eco will find this and look for Unity assets that matching this class' name, <code>MedivalStallItem</code>. While this doesn't do anything fancy, it completes the first step towards a new workbench.

=== Checkpoint ===
[[File:Eco - Hotbar With Modded Icon.png|thumb|Shows the medieval stall as a modded icon in-game.]]
This was a lot of setup and steps. Make sure everything is running smoothly by doing the following:

# Double-check that the <code>WikiDemo.unity3d</code> and the <code>WikiDemo.cs</code> files are in <code>/Eco Server/Mods/UserCode</code> folder.
# Start the server and connect to it.
# Test it out by typing <code>/give MedievalStall</code> in chat
## It's also possible to do <code>/give Market Stall</code> to get the item. How? Line 10: of the the above code declares that name as this item's "common name". Neat.
# The item should appear in the players inventory with a working icon.

This was the longest "leg" of this journey. All the setup is done and the infrastructure is in place. The following sections will just build on what was taught here.

Keep on, keeping on!

== Code the Item's Recipe ==
This section will be much simpler than the last. The following goes over how to add a new class and implement the <code>RecipeFamily</code> interface.<syntaxhighlight lang="c#" line="1">using Eco.Core.Items;
using Eco.Gameplay.Components;
using Eco.Gameplay.Items;
using Eco.Gameplay.Items.Recipes;
using Eco.Gameplay.Skills;
using Eco.Mods.TechTree;
using Eco.Shared.Localization;
using Eco.Shared.Serialization;
using System.Runtime.Versioning;
using System.Collections.Generic;

namespace WikiDemo
{
#region Item

#region Recipe
[RequiresSkill(typeof(CarpentrySkill), 3)]
[Ecopedia("Work Stations", "Craft Tables", subPageName: "Market Stall")]
public partial class MedievalStallRecipe : RecipeFamily
{
[SupportedOSPlatform("windows7.0")]
public MedievalStallRecipe()
{
var recipe = new Recipe();
recipe.Init(
name: "MedievalStallItem",
displayName: Localizer.DoStr("Market Stall"),
ingredients: new List<IngredientElement>
{
new IngredientElement("Wood", 40, typeof(Skill)),
new IngredientElement(typeof(CottonFabricItem), 30, typeof(Skill)),
new IngredientElement(typeof(HempMooringRopeItem), 5, true)
},
items: new List<CraftingElement>
{
new CraftingElement<MedievalStallItem>(1)
}
);
this.Recipes = new List<Recipe> { recipe };
this.LaborInCalories = CreateLaborInCaloriesValue(800, typeof(Skill));
this.CraftMinutes = CreateCraftTimeValue(typeof(MedievalStallRecipe), 10f, typeof(Skill));

// Perform pre/post initialization for user mods and initialize our recipe instance with the display name "Market Stall"
this.ModsPreInitialize();
this.Initialize(displayText: Localizer.DoStr("Market Stall"), recipeType: typeof(MedievalStallRecipe));
this.ModsPostInitialize();

// Register our RecipeFamily instance to a work table (in this case the Carpentry Table) so it can be crafted.
CraftingComponent.AddRecipe(tableType: typeof(CarpentryTableObject), recipeFamily: this); // NOTE: The table must be the object instance!
}

/// <summary>Hook for other mods to customize RecipeFamily before initialization.</summary>
partial void ModsPreInitialize();

/// <summary>Hook for other mods to customize RecipeFamily after initialization, but before registration. You can change skill requirements here.</summary>
partial void ModsPostInitialize();
}
#endregion
}</syntaxhighlight>'''Line 10:''' Eco will need this explicitly added to the file. Visual Studio will not add this line automatically. It's used for the <code>List<T></code> objects found in this code.

'''Line 14:''' "Collapsed" <code>Item</code> section. See the earlier sections in this guide for the code that belongs there.

'''Line 17:''' Sets the required skill and skill level to craft this recipe.

'''Line 21:''' <code>[SupportedOSPlatform("windows7.0")]</code> is here to silence some annoying warnings in Visual Studio. It's optional.

'''Line 30-32:''' Declares the input ingredients used for crafting. <code>typeof(Skill)</code> gets mapped to the <code>CarpentrySkill</code> as defined by line 31. In this example the <code>HempMooringRope</code> is a static input. A static input will not be modified by skills, upgrade modules, or game settings. '''Note:''' It seems that at the time of writing (4/21/2026, Eco v13.0.2) the only way to get an ingredient to be a dynamic value that is reduced by the table's upgrade is to pass <code>typeof(Skill)</code> to it; Passing either <code>true</code> or <code>false</code> makes the this input static.

'''Line 34:''' The <code>items</code> list declares what items are <u>output</u> by this recipe.

'''Line 36:''' This line declares that one medieval stall is output from this recipe. Functionally this links this recipe to the <code>MedievalStallItem</code> (aka "Market Stall") item created in the last step.

'''Line 40:''' Amount of calories needed to craft this item. For a static value (not modified by upgrades or skill levels) change this line to: <code>this.LaborInCalories = CreateLaborInCaloriesValue(800);</code>. As it's written in the example, this item's calorie cost will be dynamic (modified by upgrades and skill levels). The skill level that will modify it is declared on line 16.

'''Line 41:''' Minutes needed to craft. Both static and dynamic values for crafting time can be modified by the world difficulty settings. For a static value change this line to: <code>this.CraftMinutes = CreateCraftTimeValue(10f);</code>. As it's written in the example, this item's craft time will be dynamic.'''Line 49:''' This line assigns the recipe to a workbench. <u>Do not assign</u> to itself because then the first table could never be made. It's recommend to use a preexisting vanilla table.
=== Checkpoint ===
Check the functionality at this point -- it should be possible to see the recipe in the crafting table.

# Have the <code>.unity3d</code> and the <code>.cs</code> file in the <code>/Eco Server/Mods/UserCode</code> folder.
# Start the server and log in.
# Type <code>/give Carpentry Table</code>.
# Place the Carpentry Table down and interact to see the what can be crafted.
# Scroll and find the ''Market Stall'' recipe.
# Type <code>/give Basic Upgrade 4</code>.
# Put the basic upgrade into the table.
# Go back to the recipe for the ''Market Stall'' and make sure the Wood and the Cotton fabric inputs now require less, but the Hemp Mooring Rope still is the same. '''Note:''' In case the recipe hasn't changed close that table's window and interact with it again. It should for the recipes to refresh now that the upgrade is in it.

== Create the World Object ==
=== Preparing the 3D Asset ===
WIP. Below is <u>incorrect</u>. The origin point of the object should be a (0.5, 0.5, 0.5). Need to remember to zero out any transforms (translation and rotation) that the world object build scrip applies in Unity.

You must use "override occupancy" for the prefab to be placable. The offset is still magic to me, need to figure that out.

Also the freeplace seems to use the center of the prefab, but the snap place uses the origin. Need to figure out how to use origin for both.
# Open <u>Blender</u>.
# Load the 3D object created earlier for icon rendering -- <code>Assets/WikiDemo/MedievalStall - Icon Scene.blend</code>.
# Cleanup the scene...
## Use the scene collection panel on the top-right side of the screen. Select and '''delete any light source'''. These will have a 💡 icon and by default are named something like "sun", "point", "spot" or "area". '''Note:''' If your model is a light source or has one in it, you can leave that light source. The point here is to remove the ambient lights used for icon rendering.
## In the scene collection panel, select and '''delete any camera(s)'''. These have a 🎥 icon and by default are named something like "camera".
# <u>If there are multiple different 3D assets in the scene</u> (like bags, crates, jars, ect.), join them all together...
## Select all of the meshes by holding ''Shift'' and clicking on each one in the ''Scene Collection'' panel (right side of window). '''Tip:''' Quickly select a group of them by selecting one near the top. Then hold ''Shift'', ''Ctrl,'' and click on one near the bottom. This will both the one at the top and the one at the bottom, but also every item in between. Neat!
## Be in ''Layout'' mode (top toolbar).
## Find and open the ''Object'' menu (second toolbar down from the top).
## Select ''Join''.
## In the ''Scene Collection'' panel, double click on the name of the newly joined mesh.
## Rename it to <code>MedievalStallMesh</code>.
# Add and position a reference cube...
## Make sure the editor is in ''Layout'' view (top toolbar).
## Then, add a reference cube. Open the ''Add'' menu (second top toolbar down).
## Hover ''Mesh''.
## Select ''Cube.''
## Find the ''Properties'' panel. It's just below the ''Scene Collection'' panel on the right side of the window.
## Now, still inside that panel but on the left side of it there's a column of icons.
## Hover them to see their names.
## Find the one that reads: ''Object'' ''Object Properties'' '''Tip:''' It kinda looks like an orange box
## Find and expand the ''Transform'' section
## Set ''Location X'' to ''1''.
## Just below that, set ''Y'' to ''1''.
## Just below that, again, set ''Z'' to ''1''.
## The bottom corner of the cube will be touching the green and red axis lines.
# Move the reference cube's origin to <code>(0, 0, 0)</code>...
## Be in ''Layout'' mode (top toolbar).
## Open the ''View'' menu (second toolbar down).
## Select ''Sidebar''.
## A new panel will have expanded.
## Along the right side of that panel there's buttons (''Item, Tool, View, Animation''). Find and click the ''View'' button.
## Find and expand the ''3D Cursor'' section.
## Under ''Location'' set ''X'' to ''0''.
## ''Y'' to 0.
## ''Z'' to 0.
## Now in the ''Scene Collection'' panel, select the ''Cube'' mesh.
## Open the ''Object'' menu from the second toolbar down from the top.
## Hover ''Set Origin''.
## Select ''Origin to 3D Cursor''.
# Set the reference cube's dimensions...
## Be in ''Layout'' mode, open the ''View'' menu (second toolbar down), and select and expand the ''Sidebar'' option''.''
## To the right of the sidebar, find and click the ''Item'' button.
## Expand the ''Transform'' section.
## Find the ''Dimensions,'' and set ''X'' to ''4''.
## ''Y'' to ''3''.
## ''Z'' to ''3''. '''Note:''' These dimensions only make sense for the asset being used for this guide. If using a different one, set the dimensions to the size of the box that model should fit in
# Adjust the position and scale to fit inside a box. This is important because it ensures that this object won't clip into other objects when placed.
## Be in ''Layout'' mode (top toolbar).
## Find the drop down in the second toolbar from the top that has options like ''Object Mode, Edit Mode, Sculpt Mode,'' etc.
## Select ''Object Mode'' from that drop down.
## On the left side of the screen there's a column of icons. Hover over them to see their names.
## Select the ''Move'' tool.
## Click on the Medieval Stall to select it. Zoom out and reposition the camera so that the blue, green, and red arrows are visible. '''Tip:''' By holding the middle-mouse button and dragging the scene will rotate. By holding the middle-mouse button and the ''Shift'' key, the scene will pan. '''Tip:''' If panning or rotating the scene becomes slow or frustrating (especially after zooming), try selecting 3D asset from the ''Scene Collection'' panel, opening the ''View'' menu (second toolbar from top), and selecting ''Frame Selected''. This will reset the view onto that object and controls should feel normal again.
## Click and hold one of the arrows. Move the mouse to drag the 3D asset towards the box.
## Move the 3D asset around till it's <u>completely inside the box</u>. If it cannot fit and is too big, continue to the next step. '''Tip:''' To select the 3D asset once it disappears, use the ''Scene Collection'' panel. Click on it there and the blue, green, and red arrows will show up again for it. '''Tip:''' There are preset views. To use them go to the ''View'' menu (second toolbar from top)'','' hover ''Viewpoint'', and select the view that would be most helpful.
## Find the ''Scale'' tool from the left side of the screen.
## Now the blue, green, and red "arrows" don't really look like arrows anymore. They are lines with boxes at the end.
## Click and hold on those lines to adjust the scale of the 3D asset to make it fit inside the box. '''Tip:''' There are little colored boxes in between the lines that can be dragged to scale the 3D asset more proportionally.
## Continue using the ''Move'' and ''Scale'' tools till the model fits. This will take patience and time. '''Tip:''' Hide the reference cube to see what is happening with the 3D asset. Go to the ''Scene Collections'' panel and click the 👁 button to hide it. Click that button again to show it.
# Now set the 3D asset's origin point... 
## Ensure that the 3D Cursor is still at <code>(0,0,0)</code>: Open the ''View'' menu (second toolbar down), select and expand the ''Sidebar'', click the ''View'' button (right side of the Sidebar), find and expand the ''3D cursor'' section, change the ''Location X, Y,'' and ''Z'' to ''0''.
## Select the 3D asset using the ''Scene Collection'' panel.
## Open the ''Object'' menu (second toolbar down).
## Hover ''Set Origin''.
## Select ''Origin to 3D Cursor''.
# Select the reference cube from the ''Scene Collections'' panel.
# Open ''Object'' menu (second toolbar down).
# Select ''Delete''.
# Open the ''Object'' menu.
# Hover ''Apply''.
# Select ''All Transformations''. '''TODO:''' Ensure this step doesn't alter the origin now that it's being place in bottom-center, 0.5m off ground
# Open the ''File'' menu from the top toolbar.
# Hover ''Export'' to open the sub-menu.
# Select ''FBX (.fbx)''
# A ''Blender File View'' window will pop-up.
# On the right side of this window there's a ⚙️ icon. Click it to expand the settings region.
# In the expanded region find the ''Include'' section and expand it. Change the following:
## Find ''Object Types'' and only select ''Mesh.'' No other option should be highlighted for this setting.
# In the settings region scroll and find the ''Transform'' section and expand it. Change the following:
## Find ''Apply Scalings'' and set it to ''FBX All''.
## Just below that find ''Forward'' and set it to ''-Z Forward''.
## Ensure that the next setting down, ''Up'', changed to ''Y Up''.
## Find ''Apply Unit'' and make sure it's checked.
## Next, find ''Use Space Transform'' check it.
## Lastly, find ''Apply Transform'' and check it too.
# Save it to <code>Assets/WikiDemo/MedievalStall.fbx</code>.
# Save the <code>.blend</code> file too and close Blender.

=== Add to Unity Scene ===

# Open <u>Unity</u>.
# Select the <code>.fbx</code> file in the project window.
# Open the ''Eco Tools'' menu from the top toolbar.
# Hover ''Mod Kit''.
# Select ''World Object Setup.''
# A ''World Object Setup'' window will pop-up.
# Make sure that ''Selected Objects'' reads ''MedievalStall.''
# Also make sure that ''World Object Type'' is set to ''World Object''.
# Press the ''Setup World Objects'' button.
# Notice in the project window that a new <code>.prefab</code> file was created -- <code>MedievalStallObject.prefab</code>
# Select the <code>.prefab</code> file in the project window.
# In the ''Inspector'' window (right side), scroll and find the ''World Object (Script)'' component.
# In that component, find the ''Override Occupancy'' checkbox and check it.
# A new field just appeared, ''Size''.
# Set the ''X'' to ''4''.
# ''Y'' to ''3''.
# ''Z'' to ''3.'' '''Note:''' These are the sizes used for the reference cube. If using different sizes make sure you <u>flip the Y and Z coordinates</u> when reading coordinates from Blender. Blender uses a different coordinate system that Unity!
# Select ''Objects'' from ''Hierarchy'' panel.
# Find the ''Modkit Prefab Container (Script)'' component.
# Expand the ''Prefabs'' section in that component.
# Click the ''+'' button to add an item to the list.
# Either...
## Click the ''⦿'' button, switch to the ''Assets'' tab, find or search for ''MedievalStallObject'', and double click on it. Make sure it's the medieval stall <u>object</u> with the <code>.prefab</code> ending.
## Drag the <code>.prefab</code> file onto the ''⦿'' button
#
# Open the ''File'' menu from top toolbar and select ''Save''. '''Note:''' Do not skip. The scene must be saved for the ModKit build to work properly.
# Open the ''Eco Tools'' menu from the top toolbar.
# Hover ''Mod Kit''.
# Select ''Build Current Bundle''.
# Save the bundle to <code>/Eco Server/Mods/UserCode/WikiDemo.unity3d</code>

=== Scripting the World Object ===
WIP: Need occupancy code.

Code that links the Item to this World Object.<syntaxhighlight lang="c#" line="1">
using Eco.Core.Items;
using Eco.Gameplay.Components;
using Eco.Gameplay.Items;
using Eco.Gameplay.Items.Recipes;
using Eco.Gameplay.Objects;
using Eco.Gameplay.Skills;
using Eco.Mods.TechTree;
using Eco.Shared.Localization;
using Eco.Shared.Serialization;
using System.Collections.Generic;
using System.Runtime.Versioning;
using System;

namespace WikiDemo
{
#region Item
[Serialized] // Tells the save/load system this object needs to be serialized.
[LocDisplayName("Market Stall")] // Defines the localized name of the item.
[Weight(100)] // Defines how heavy Arrow is.
[Ecopedia("Work Stations", "Craft Tables", createAsSubPage: true)]
[LocDescription("A medieval market stall.")] //The tooltip description for the item.
public partial class MedievalStallItem : WorldObjectItem<MedievalStallObject> { }
#endregion

#region Recipe

#region Object
[Serialized]
public partial class MedievalStallObject : WorldObject, IRepresentsItem
{
public Type RepresentedItemType => typeof(MedievalStallItem);
}
#endregion
}
</syntaxhighlight>'''Line 22:''' This changes from implementing <code>Item</code> to <code>WorldObjectItem<MedievalStallObject></code>. This is what gives the item the ability to place the table down in the world.

'''Line 25:''' The "collapsed" Recipe section. See earlier sections in this guide to see what code belongs here.

'''Line 29:''' Declares the <code>MedievalStallObject</code>. It's important that this class name is matches exactly the <code>.prefab</code> file name because the name is what links them.

'''Line 31:''' This line is similar in function to line 22, it's declaring that this <code>MedievalStallObject</code> is <code>MedievalStallItem</code> when in inventories.

=== Checkpoint ===
Export and see what it does. Ensure it's not lifting off the ground because of a non-curved shader.

==== Origin Point Editing ====
Talk about what it does: the point that the simulation considers this world object to be at.

Show how to move it around using blender.

== Final Export ==
Export.

Package.

Distribute.

From 3D Asset to Working Worktable

2026-04-27T06:08:04Z

WugWugg:

= Introduction =
Below is a guide on how to take an 3D asset from the Unity Store and make a working workbench in Eco. This includes:
* Creating a recipe to craft the modded table
* Creating recipes so the player can use the modded table to craft something
* Using Blender to generate a modded icon (seen when holding it in inventory)
* Using Blender to adjust the origin point of the model
* How to setup all this in a Unity scene and package for Eco

= Setup =

* Already have setup '''ModKit + Unity'''
** See: [[Installing the ModKit]]
* Have a '''3D model'''
** Just following along? Find the one used here at <code><nowiki>https://assetstore.unity.com/packages/3d/props/low-poly-medieval-market-stalls-314286</nowiki></code>
* A '''C# IDE''' (notepad++, Visual Studio, etc.)
** Highly encouraged to have an Intellisense setup and linked to the '''Reference Assemblies'''. Optional, but its really worth the time to figure out because it will help quickly correct small typos and trivial mistakes.
** See: [[Getting Started with Eco Modding in Visual Studio 2022]] (generally the same steps apply if using a new version of Visual Studio)
* '''Blender''' installed
** Homepage: <code><nowiki>https://www.blender.org/</nowiki></code>

== Importing the Assets ==

# Open the Unity editor to the project.
# From the top toolbar open the ''Window'' drop down.
# Hover ''Package Management'' to open sub-menu.
# Select ''Package Manager''.
# The ''Package Manager'' window will pop-up.
# Install the package containing the assets you want to use...
## <u>If not using Unity Registry</u>...
### Find the ''+▾'' button in the top left and open the drop down.
### Install the package from one of those options.
## <u>If using Unity Registry</u>...
### Visit <code><nowiki>https://assetstore.unity.com</nowiki></code> and sign in.
### Search for the asset desired.
### Go to it's page (e.g. <code><nowiki>https://assetstore.unity.com/packages/3d/props/low-poly-medieval-market-stalls-314286</nowiki></code>) and click the big blue button, ''Add to My Assets.''
### Now, in the Unity editor and back at the ''Package Manager'' window.
### Find ''My Assets'' on the left menu and navigate to it.
### Click the ''⟳'' button in the lower-right.
### The asset should be in the list now. Use the search to filter if needed.
### Click on the asset in the list. For those following along, ''Low Poly Medieval Market Stalls''.
### In the right panel, find the ''Download ⤓'' button. Click it.
### Once downloaded, a new button should show up, it'll say something like ''⊕ Import 1.0 to project'' . Click it.
### The ''Import Unity Package'' window will pop-up.
### Select ''Import'' on it.
# Verify you can find your assets from the explorer. If following along, the assets are at <code>Assets/PolyRonin/Medieval Market Stalls</code>.
# Load in a demo scene, if provided, and make sure everything looks okay.
## For those following along, double click on the ''Demo'' scene at <code>Assets/PolyRonin/Medieval Market Stalls/Demo.unity</code>.

[[File:Eco - Unity - View Modes.png|thumb|Underlined in red are the different draw mode buttons. <u>4/20/26</u>]]
If something seems off, check the different draw modes and see if changing those allow the scene to render as expected (see picture).

With all that setup, it's time to get to the creation parts.

= Creating The Worktable =
This guide will create the worktable in this order:

# Create the item that represents the worktable
# Make a recipe to craft the worktable item
# Make the worktable item something that places a world object
# Give the worktable functionality by adding recipes to it

== Creating the Item ==

=== Item Icon ===
[[File:TeamstersStall - StallOnly - 256x256.png|thumb|A large (256x256px) icon created of Stall4 from the medieval assets.]]
This process is also explained here, <code><nowiki>https://mod.io/g/eco/r/origin-points-icon-images-with-blender</nowiki></code>, check it out if you need more visual reference points as that guide has a lot of pictures.

# Open <u>Blender</u>.
# Delete everything in the ''Scene Collection''. Find this section in the top-right of the application.
# From the top toolbar, open the ''File'' drop down.
# Hover ''Import'' to open the sub-menu.
# Select the type of 3D asset. For those using medieval assets, select ''FBX (.fbx)''.
# Find the asset on the computer...
## Tip: Use Unity to find the <code>.fbx</code> asset. For the medieval assets, that's in <code>Assets/PolyRonin/Medieval Market Stalls/Meshes/medieval-market-stalls-1.fbx</code>.
## Right click on it and select ''Show in explorer''.
## Now copy the address of that folder from Explorer. It might look like <code>C:\Users\Wug\EcoMod--WikiDemo\WikiDemo\Assets\PolyRonin\Medieval Market Stalls\Meshes</code>.
## Paste that in the address bar of the <u>Blender</u> import pop-up.
# Select the blue ''Import FBX'' button''.''
# From ''Layout'' mode, change the Viewport Shading to Material Preview or Rendered. This is on the second toolbar down, far right of center, but before ''Scene Collection'' section.
# If you see purple models, Blender will need help finding textures for these meshes...
## From the top toolbar, open the ''File'' drop down.
## Hover ''External Data'' to open the sub-menu.
## Select ''Find Missing Files...''
## Point this to the whole directory that the 3D assets came in. For the medieval pack, <code>C:\Users\</code><code>Wug\EcoMod--WikiDemo\WikiDemo\Assets\PolyRonin</code>.
## The proper textures/materials should have now loaded in. If it hasn't, consult Google because without the textures the following steps won't produce a usable icon.
# Add a source of light...
## Make sure the editor is in the ''Layout'' mode by checking the top most toolbar.
## From the toolbar just under that one, find and open the ''Add'' drop down.
## Hover ''Light'' to open that sub-menu.
## Click ''Sun''.
# Add a camera...
## Again make sure the editor is in the ''Layout'' mode.
## From the second toolbar down, find and open the ''Add'' drop down.
## Select ''Camera''.
# Setup the scene with the object placement and lighting direction desired. '''Tip:''' To reset the editor to something selected press the period key <u>on the numpad</u>. Without a numpad, use ''View'' (second toolbar from the top) and select ''Frame Selected'' from it. Alternatively, just set the zoom to zoom to the mouse position: ''Edit'' (top toolbar), ''Preferences'' (from drop down), ''Navigation'' (on left menu), ''Zoom to Mouse Position'' (In the zoom section). This makes moving around a lot more natural feeling.
# Setup the rendering camera...
## Go to ''Rendering'' tab on the top toolbar
## On the right there will be a side-panel open, it should be the ''Render'' tab. Confirm that.
## Change ''Render Engine'' to ''Cycles''.
## Look down below in the same tab for the ''Film'' section.
## Expand it and find the ''Transparent'' checkbox and section. Click it so that it has a check mark. This will make the icon's background transparent.
## Now, go to the ''Output'' tab <u>on the side panel</u>. The tab is just below the current one.
## In the ''Format'' section set ''Resolution X'' to ''64.'' And ''Y'' to ''64'' as well. This will make the icon generated a 64 by 64 pixel image.
# Go back to the ''Layout'' tab from the top toolbar.
# Center your view on the object (numpad period or ''View > Frame Selected''). Adjust it so that the object is how it should be for the icon.
# Align the camera to the view...
## Make sure the editor is in ''Layout'' mode (top toolbar).
## Find ''View'' from the second from the top toolbar and open the drop down.
## Hover ''Align View'' to open the sub-menu.
## Select ''Align Active Camera To View''.
## If the view is slightly off, there is a lock icon on the right side of this panel. Use it to "lock" controls to the camera and tweak it's view.
# Now return to the ''Rendering'' tab from the top toolbar.
# Press the F12 key to start the render. This should complete quickly since 64x64 pixels is a very small render.
# A window should popup, ''Blender Render''. This is the icon!
# From the top tool bar of this ''Blender Render'' window, open the ''Image'' drop down.
# Select ''Save As...'' to save somewhere on the computer.
# Return to step 13 and repeat to do larger images if desired. Create a 128 by 128 pixel image too. It will make things smoother later.
# Save the Blender scene. Not only will it be used later, this will make making a new icon with a small tweak that much easier.
## ''File'' drop down from top toolbar.
## ''Save As...'' to save the Blender scene to the computer.
## Save it to <code>Assets/WikiDemo/MedievalStall - Icon Scene.blend</code>.

=== Adding to Unity Scene ===
The developers explain how to create an item in one of ModKit's read me files (See: <code>Assets/EcoModKit/Docs/README.md</code>), but this guide will explain it below.

Additionally, '''TheKye''' on YouTube covers this in their ''Creating Your First Item'' and ''Creating Your First Item Pt 2'' videos.

Use those additional resource to help troubleshoot issues with item's icons.

# Open <u>Unity</u>.
# In the left panel, the ''Hierarchy'' tab should be selected.
# Select the top-most object there. It should be a scene. If the editor last loaded the ''Demo'' scene from the medieval assets, it'll be named ''Demo''.
# Right click on this scene and select ''Add New Scene'' from the menu.
# Right click again on the old scene (''Demo'') and select ''Remove Scene''.
# Let it save if the changes to the old scene are important. Discard if it was open just for exploration's sake.
# Right click the new, ''Untitled'' scene. Click ''Save Scene As...''
# Save it to <code>Assets/WikiDemo.unity</code>.
# Delete <u>anything</u> in the scene.
# Right click the scene, hover ''GameObject'', and select ''Create Empty'' from the sub-menu.
# Name this new object ''Objects''.
# Select the newly created ''Objects'' object from the ''Hierarchy'' menu.
# On the far right side of the screen, in the ''Inspector'' menu, click the ''Add Component'' button.
# Type in ''ModkitPrefabContainer''. Click on the component from the search to add it. The component now should be listed in the ''Inspector''.
# In the ''Hierarchy'' panel right click the scene, hover ''GameObject'', and select ''Create Empty''.
# Name this new object ''Items''.
# Right click the scene, hover ''GameObject'', and select ''Create Empty''.
# Name this new object ''Emoji''.
# Select the newly created ''Emoji'' object, find the ''Inspector'' menu (far-right), and click the ''Add Component'' button.
# Type in ''ChatEmoteSetOld''. Click on the component from the search to add it. That component should now be listed in the ''Inspector''.
# Right click the scene, hover ''GameObject'', and select ''Create Empty''.
# Name this new object ''BlockSets''.
# Select the newly created ''BlockSets'' object, find the ''Inspector'' menu (far-right), and click ''Add Component''.
# Search for ''BlockSetContainer''. Click on the component from the search to add it. The ''Inspector'' should now show that component as added.
#Go to <code>Assets/EcoModKit/Prefabs</code> in the Unity project window.
# Find the prefab ''ItemTemplate''.
# Drag it onto the ''Items'' object in the ''Hierarchy'' panel. It should add it as a <u>child</u> of the ''Items'' object.
# Right click on the new ''ItemTemplate'' object, hover ''Prefab'', and select ''Unpack Completely''.
# Right click on the ''ItemTemplate'' object and select ''Rename''. Name this what you want the item to be called. Example: ''MedievalStallItem''.
# Set this item's background...
## Here's the default backgrounds (blue = item, brown = block, green = food): [[File:Eco - Item - Background.png|border|frameless]] [[File:Eco - Block - Background.png|frameless]] [[File:Eco - Food - Background.png|frameless]]
## Download or prepare the background and add it to the <code>Assets</code> folder in Unity.
### To follow along lockstep, put the background in a new <code>Assets/WikiDemo</code> folder.
### Right click on <code>Assets</code> folder, hover ''Create'', select ''Folder''.
### Name the folder ''WikiDemo''.
## Configure Unity to use these as sprites...
### Select the background(s) added (Ctrl+Click each one).
### In the ''Inspector'', find ''TextureType'' and change that to ''Sprite (2D and UI)''.
### Again in the ''Inspector'', find ''SpriteMode'' and change that to ''Single''.
### Then scroll and go to the bottom of the ''Inspector'' and find the ''Apply'' button.
### This will apply those changes to that file and all other ones highlighted.
## Select the item being created (''MedievalStallItem'').
## In the ''Inspector'' panel (far-right), scroll and find the ''Item Template (Script)'' section.
## In here find the ''Background'' input. It'll say ''Background (Image)'' in it. If clicked that text to reveal and highlight the related object in the ''Hierarchy'' panel.
## Select the revealed, and highlighted object ''Background''.
## In the ''Inspector'' panel, scroll and find the ''Image'' component section.
## Inside that component's section, find ''Source Image''. It'll say ''Missing (Sprite)''. Click the ''⦿'' button to the right.
## The ''Select Sprite'' popup will show. Make sure the ''Assets'' tab is selected, and find the backgrounds desired.
#Create the foreground image...
##This is easily accomplished in MS Paint.
##Get to the background image file in a <u>file explorer</u>.
##Right click on it, hover ''Open with...'', and select ''Paint''.
##The solid background should be displayed.
##Open the ''File'' menu from the top toolbar.
##Hover ''Import to Canvas'' and select ''From a File''.
##Find the icon in the file browser and import it. Match the size of the background image to have it nicely center itself.
##Now ''File'' from the top toolbar.
##Hover ''Save As...'' and select ''PNG''.
##Save this to the <code>Assets/WikiDemo</code> folder in Unity.
##Configure Unity to use these as sprites...
### Select the foreground image.
### In the ''Inspector'', find ''TextureType'' and change that to ''Sprite (2D and UI)''.
### Again in the ''Inspector'', find ''SpriteMode'' and change that to ''Single''.
### Then scroll and go to the bottom of the ''Inspector'' and find the ''Apply'' button.
### This will apply those changes to that file and all other ones highlighted.
#Set this item's foreground...
## Copy the item's icon into the <code>Assets</code> folder.
## Configure Unity to use it as a sprite (see the previous step's ''Set this item's background...'' instructions)
## Select the item being created (''MedievalStallItem'').
## In the ''Inspector'' panel (far-right), scroll and find the ''Item Template (Script)'' section.
## In here find the ''Foreground'' input. It'll say ''Foreground (Image)'' in it. If clicked that text to reveal and highlight the related object in the ''Hierarchy'' panel.
## Select the revealed, and highlighted object ''Foreground''.
## Use the ''Inspector'', find the ''Image'' component, within that component find the ''Source Image'' input. It will say ''Missing (Sprite)''.
## Click the ''⦿'' button to the right of that input.
## From the ''Select Sprite'' popup, ensure the ''Assets'' tab is being searched, and find the icon just created.

=== Export From Unity ===

# Open the ''File'' menu from the top toolbar.
# Select ''Save.'' Save it to the <code>Assets/WikiDemo</code> folder. '''Note:''' Do not skip. The scene must be saved for the ModKit build to work properly.
# Open the ''Eco Tools'' menu from the top toolbar.
# Hover ''Mod Kit'' to open the sub-menu.
# Select ''Build Current Bundle''.
# Have it output the bundle to <code>/Eco Server/Mods/UserCode/WikiDemo.unity3d</code>
# Wait for this to build. This may take a few minutes.

=== Scripting the Item ===
For a more complex mod, it would be wise to build it into a DLL. See [[Getting Started with Eco Modding in Visual Studio 2022]] for details on that.

# Create a <code>.cs</code> file: <code>/Eco Server/Mods/UserCode/WikiDemo.cs</code>
# Put the following into the newly created file:
<syntaxhighlight lang="c#" line="1">using Eco.Core.Items;
using Eco.Gameplay.Items;
using Eco.Shared.Localization;
using Eco.Shared.Serialization;

namespace WikiDemo
{
#region Item
[Serialized] // Tells the save/load system this object needs to be serialized.
[LocDisplayName("Market Stall")] // Defines the localized name of the item.
[Weight(100)] // Defines how heavy Arrow is.
[Ecopedia("Work Stations", "Craft Tables", createAsSubPage: true)]
[LocDescription("A medieval market stall.")] //The tooltip description for the item.
public partial class MedievalStallItem: Item { }
#endregion
}</syntaxhighlight>'''Line 8:''' A region tag. Lets the editor know it can collapse all of that code as a section. The following examples in this guide will just show <code>#region Item</code> in their code examples.

'''Line 13:''' The implementation of <code>Item</code> means that Eco will find this and look for Unity assets that matching this class' name, <code>MedivalStallItem</code>. While this doesn't do anything fancy, it completes the first step towards a new workbench.

=== Checkpoint ===
[[File:Eco - Hotbar With Modded Icon.png|thumb|Shows the medieval stall as a modded icon in-game.]]
This was a lot of setup and steps. Make sure everything is running smoothly by doing the following:

# Double-check that the <code>WikiDemo.unity3d</code> and the <code>WikiDemo.cs</code> files are in <code>/Eco Server/Mods/UserCode</code> folder.
# Start the server and connect to it.
# Test it out by typing <code>/give MedievalStall</code> in chat
## It's also possible to do <code>/give Market Stall</code> to get the item. How? Line 10: of the the above code declares that name as this item's "common name". Neat.
# The item should appear in the players inventory with a working icon.

This was the longest "leg" of this journey. All the setup is done and the infrastructure is in place. The following sections will just build on what was taught here.

Keep on, keeping on!

== Code the Item's Recipe ==
This section will be much simpler than the last. The following goes over how to add a new class and implement the <code>RecipeFamily</code> interface.<syntaxhighlight lang="c#" line="1">using Eco.Core.Items;
using Eco.Gameplay.Components;
using Eco.Gameplay.Items;
using Eco.Gameplay.Items.Recipes;
using Eco.Gameplay.Skills;
using Eco.Mods.TechTree;
using Eco.Shared.Localization;
using Eco.Shared.Serialization;
using System.Runtime.Versioning;
using System.Collections.Generic;

namespace WikiDemo
{
#region Item

#region Recipe
[RequiresSkill(typeof(CarpentrySkill), 3)]
[Ecopedia("Work Stations", "Craft Tables", subPageName: "Market Stall")]
public partial class MedievalStallRecipe : RecipeFamily
{
[SupportedOSPlatform("windows7.0")]
public MedievalStallRecipe()
{
var recipe = new Recipe();
recipe.Init(
name: "MedievalStallItem",
displayName: Localizer.DoStr("Market Stall"),
ingredients: new List<IngredientElement>
{
new IngredientElement("Wood", 40, typeof(Skill)),
new IngredientElement(typeof(CottonFabricItem), 30, typeof(Skill)),
new IngredientElement(typeof(HempMooringRopeItem), 5, true)
},
items: new List<CraftingElement>
{
new CraftingElement<MedievalStallItem>(1)
}
);
this.Recipes = new List<Recipe> { recipe };
this.LaborInCalories = CreateLaborInCaloriesValue(800, typeof(Skill));
this.CraftMinutes = CreateCraftTimeValue(typeof(MedievalStallRecipe), 10f, typeof(Skill));

// Perform pre/post initialization for user mods and initialize our recipe instance with the display name "Market Stall"
this.ModsPreInitialize();
this.Initialize(displayText: Localizer.DoStr("Market Stall"), recipeType: typeof(MedievalStallRecipe));
this.ModsPostInitialize();

// Register our RecipeFamily instance to a work table (in this case the Carpentry Table) so it can be crafted.
CraftingComponent.AddRecipe(tableType: typeof(CarpentryTableObject), recipeFamily: this); // NOTE: The table must be the object instance!
}

/// <summary>Hook for other mods to customize RecipeFamily before initialization.</summary>
partial void ModsPreInitialize();

/// <summary>Hook for other mods to customize RecipeFamily after initialization, but before registration. You can change skill requirements here.</summary>
partial void ModsPostInitialize();
}
#endregion
}</syntaxhighlight>'''Line 10:''' Eco will need this explicitly added to the file. Visual Studio will not add this line automatically. It's used for the <code>List<T></code> objects found in this code.

'''Line 14:''' "Collapsed" <code>Item</code> section. See the earlier sections in this guide for the code that belongs there.

'''Line 17:''' Sets the required skill and skill level to craft this recipe.

'''Line 21:''' <code>[SupportedOSPlatform("windows7.0")]</code> is here to silence some annoying warnings in Visual Studio. It's optional.

'''Line 30-32:''' Declares the input ingredients used for crafting. <code>typeof(Skill)</code> gets mapped to the <code>CarpentrySkill</code> as defined by line 31. In this example the <code>HempMooringRope</code> is a static input. A static input will not be modified by skills, upgrade modules, or game settings. '''Note:''' It seems that at the time of writing (4/21/2026, Eco v13.0.2) the only way to get an ingredient to be a dynamic value that is reduced by the table's upgrade is to pass <code>typeof(Skill)</code> to it; Passing either <code>true</code> or <code>false</code> makes the this input static.

'''Line 34:''' The <code>items</code> list declares what items are <u>output</u> by this recipe.

'''Line 36:''' This line declares that one medieval stall is output from this recipe. Functionally this links this recipe to the <code>MedievalStallItem</code> (aka "Market Stall") item created in the last step.

'''Line 40:''' Amount of calories needed to craft this item. For a static value (not modified by upgrades or skill levels) change this line to: <code>this.LaborInCalories = CreateLaborInCaloriesValue(800);</code>. As it's written in the example, this item's calorie cost will be dynamic (modified by upgrades and skill levels). The skill level that will modify it is declared on line 16.

'''Line 41:''' Minutes needed to craft. Both static and dynamic values for crafting time can be modified by the world difficulty settings. For a static value change this line to: <code>this.CraftMinutes = CreateCraftTimeValue(10f);</code>. As it's written in the example, this item's craft time will be dynamic.'''Line 49:''' This line assigns the recipe to a workbench. <u>Do not assign</u> to itself because then the first table could never be made. It's recommend to use a preexisting vanilla table.
=== Checkpoint ===
Check the functionality at this point -- it should be possible to see the recipe in the crafting table.

# Have the <code>.unity3d</code> and the <code>.cs</code> file in the <code>/Eco Server/Mods/UserCode</code> folder.
# Start the server and log in.
# Type <code>/give Carpentry Table</code>.
# Place the Carpentry Table down and interact to see the what can be crafted.
# Scroll and find the ''Market Stall'' recipe.
# Type <code>/give Basic Upgrade 4</code>.
# Put the basic upgrade into the table.
# Go back to the recipe for the ''Market Stall'' and make sure the Wood and the Cotton fabric inputs now require less, but the Hemp Mooring Rope still is the same. '''Note:''' In case the recipe hasn't changed close that table's window and interact with it again. It should for the recipes to refresh now that the upgrade is in it.

== Create the World Object ==
=== Preparing the 3D Asset ===
WIP. Below is <u>incorrect</u>. The origin point of the object must be in the center, bottom of the object. Instructions for reference cube moving and origin moving will produce bad results!
# Open <u>Blender</u>.
# Load the 3D object created earlier for icon rendering -- <code>Assets/WikiDemo/MedievalStall - Icon Scene.blend</code>.
# Cleanup the scene...
## Use the scene collection panel on the top-right side of the screen. Select and '''delete any light source'''. These will have a 💡 icon and by default are named something like "sun", "point", "spot" or "area". '''Note:''' If your model is a light source or has one in it, you can leave that light source. The point here is to remove the ambient lights used for icon rendering.
## In the scene collection panel, select and '''delete any camera(s)'''. These have a 🎥 icon and by default are named something like "camera".
# <u>If there are multiple different 3D assets in the scene</u> (like bags, crates, jars, ect.), join them all together...
## Select all of the meshes by holding ''Shift'' and clicking on each one in the ''Scene Collection'' panel (right side of window). '''Tip:''' Quickly select a group of them by selecting one near the top. Then hold ''Shift'', ''Ctrl,'' and click on one near the bottom. This will both the one at the top and the one at the bottom, but also every item in between. Neat!
## Be in ''Layout'' mode (top toolbar).
## Find and open the ''Object'' menu (second toolbar down from the top).
## Select ''Join''.
## In the ''Scene Collection'' panel, double click on the name of the newly joined mesh.
## Rename it to <code>MedievalStallMesh</code>.
# Add and position a reference cube...
## Make sure the editor is in ''Layout'' view (top toolbar).
## Then, add a reference cube. Open the ''Add'' menu (second top toolbar down).
## Hover ''Mesh''.
## Select ''Cube.''
## Find the ''Properties'' panel. It's just below the ''Scene Collection'' panel on the right side of the window.
## Now, still inside that panel but on the left side of it there's a column of icons.
## Hover them to see their names.
## Find the one that reads: ''Object'' ''Object Properties'' '''Tip:''' It kinda looks like an orange box
## Find and expand the ''Transform'' section
## Set ''Location X'' to ''1''.
## Just below that, set ''Y'' to ''1''.
## Just below that, again, set ''Z'' to ''1''.
## The bottom corner of the cube will be touching the green and red axis lines.
# Move the reference cube's origin to <code>(0, 0, 0)</code>...
## Be in ''Layout'' mode (top toolbar).
## Open the ''View'' menu (second toolbar down).
## Select ''Sidebar''.
## A new panel will have expanded.
## Along the right side of that panel there's buttons (''Item, Tool, View, Animation''). Find and click the ''View'' button.
## Find and expand the ''3D Cursor'' section.
## Under ''Location'' set ''X'' to ''0''.
## ''Y'' to 0.
## ''Z'' to 0.
## Now in the ''Scene Collection'' panel, select the ''Cube'' mesh.
## Open the ''Object'' menu from the second toolbar down from the top.
## Hover ''Set Origin''.
## Select ''Origin to 3D Cursor''.
# Set the reference cube's dimensions...
## Be in ''Layout'' mode, open the ''View'' menu (second toolbar down), and select and expand the ''Sidebar'' option''.''
## To the right of the sidebar, find and click the ''Item'' button.
## Expand the ''Transform'' section.
## Find the ''Dimensions,'' and set ''X'' to ''4''.
## ''Y'' to ''3''.
## ''Z'' to ''3''. '''Note:''' These dimensions only make sense for the asset being used for this guide. If using a different one, set the dimensions to the size of the box that model should fit in
# Adjust the position and scale to fit inside a box. This is important because it ensures that this object won't clip into other objects when placed.
## Be in ''Layout'' mode (top toolbar).
## Find the drop down in the second toolbar from the top that has options like ''Object Mode, Edit Mode, Sculpt Mode,'' etc.
## Select ''Object Mode'' from that drop down.
## On the left side of the screen there's a column of icons. Hover over them to see their names.
## Select the ''Move'' tool.
## Click on the Medieval Stall to select it. Zoom out and reposition the camera so that the blue, green, and red arrows are visible. '''Tip:''' By holding the middle-mouse button and dragging the scene will rotate. By holding the middle-mouse button and the ''Shift'' key, the scene will pan. '''Tip:''' If panning or rotating the scene becomes slow or frustrating (especially after zooming), try selecting 3D asset from the ''Scene Collection'' panel, opening the ''View'' menu (second toolbar from top), and selecting ''Frame Selected''. This will reset the view onto that object and controls should feel normal again.
## Click and hold one of the arrows. Move the mouse to drag the 3D asset towards the box.
## Move the 3D asset around till it's <u>completely inside the box</u>. If it cannot fit and is too big, continue to the next step. '''Tip:''' To select the 3D asset once it disappears, use the ''Scene Collection'' panel. Click on it there and the blue, green, and red arrows will show up again for it. '''Tip:''' There are preset views. To use them go to the ''View'' menu (second toolbar from top)'','' hover ''Viewpoint'', and select the view that would be most helpful.
## Find the ''Scale'' tool from the left side of the screen.
## Now the blue, green, and red "arrows" don't really look like arrows anymore. They are lines with boxes at the end.
## Click and hold on those lines to adjust the scale of the 3D asset to make it fit inside the box. '''Tip:''' There are little colored boxes in between the lines that can be dragged to scale the 3D asset more proportionally.
## Continue using the ''Move'' and ''Scale'' tools till the model fits. This will take patience and time. '''Tip:''' Hide the reference cube to see what is happening with the 3D asset. Go to the ''Scene Collections'' panel and click the 👁 button to hide it. Click that button again to show it.
# Now set the 3D asset's origin point... 
## Ensure that the 3D Cursor is still at <code>(0,0,0)</code>: Open the ''View'' menu (second toolbar down), select and expand the ''Sidebar'', click the ''View'' button (right side of the Sidebar), find and expand the ''3D cursor'' section, change the ''Location X, Y,'' and ''Z'' to ''0''.
## Select the 3D asset using the ''Scene Collection'' panel.
## Open the ''Object'' menu (second toolbar down).
## Hover ''Set Origin''.
## Select ''Origin to 3D Cursor''.
# Select the reference cube from the ''Scene Collections'' panel.
# Open ''Object'' menu (second toolbar down).
# Select ''Delete''.
# Open the ''Object'' menu.
# Hover ''Apply''.
# Select ''All Transformations''. '''TODO:''' Ensure this step doesn't alter the origin now that it's being place in bottom-center, 0.5m off ground
# Open the ''File'' menu from the top toolbar.
# Hover ''Export'' to open the sub-menu.
# Select ''FBX (.fbx)''
# A ''Blender File View'' window will pop-up.
# On the right side of this window there's a ⚙️ icon. Click it to expand the settings region.
# In the expanded region find the ''Include'' section and expand it. Change the following:
## Find ''Object Types'' and only select ''Mesh.'' No other option should be highlighted for this setting.
# In the settings region scroll and find the ''Transform'' section and expand it. Change the following:
## Find ''Apply Scalings'' and set it to ''FBX All''.
## Just below that find ''Forward'' and set it to ''-Z Forward''.
## Ensure that the next setting down, ''Up'', changed to ''Y Up''.
## Find ''Apply Unit'' and make sure it's checked.
## Next, find ''Use Space Transform'' check it.
## Lastly, find ''Apply Transform'' and check it too.
# Save it to <code>Assets/WikiDemo/MedievalStall.fbx</code>.
# Save the <code>.blend</code> file too and close Blender.

=== Add to Unity Scene ===

# Open <u>Unity</u>.
# Select the <code>.fbx</code> file in the project window.
# Open the ''Eco Tools'' menu from the top toolbar.
# Hover ''Mod Kit''.
# Select ''World Object Setup.''
# A ''World Object Setup'' window will pop-up.
# Make sure that ''Selected Objects'' reads ''MedievalStall.''
# Also make sure that ''World Object Type'' is set to ''World Object''.
# Press the ''Setup World Objects'' button.
# Notice in the project window that a new <code>.prefab</code> file was created -- <code>MedievalStallObject.prefab</code>
# Select the <code>.prefab</code> file in the project window.
# In the ''Inspector'' window (right side), scroll and find the ''World Object (Script)'' component.
# In that component, find the ''Override Occupancy'' checkbox and check it.
# A new field just appeared, ''Size''.
# Set the ''X'' to ''4''.
# ''Y'' to ''3''.
# ''Z'' to ''3.'' '''Note:''' These are the sizes used for the reference cube. If using different sizes make sure you <u>flip the Y and Z coordinates</u> when reading coordinates from Blender. Blender uses a different coordinate system that Unity!
# Select ''Objects'' from ''Hierarchy'' panel.
# Find the ''Modkit Prefab Container (Script)'' component.
# Expand the ''Prefabs'' section in that component.
# Click the ''+'' button to add an item to the list.
# Either...
## Click the ''⦿'' button, switch to the ''Assets'' tab, find or search for ''MedievalStallObject'', and double click on it. Make sure it's the medieval stall <u>object</u> with the <code>.prefab</code> ending.
## Drag the <code>.prefab</code> file onto the ''⦿'' button
#
# Open the ''File'' menu from top toolbar and select ''Save''. '''Note:''' Do not skip. The scene must be saved for the ModKit build to work properly.
# Open the ''Eco Tools'' menu from the top toolbar.
# Hover ''Mod Kit''.
# Select ''Build Current Bundle''.
# Save the bundle to <code>/Eco Server/Mods/UserCode/WikiDemo.unity3d</code>

'''TODO:''' Explain that if the orgin point isn't at the bottom-left corner of the model, then ''World Object (Script) > Occupancy Offset'' will need adjusted manually.

=== Scripting the World Object ===
Code that links the Item to this World Object.<syntaxhighlight lang="c#" line="1">
using Eco.Core.Items;
using Eco.Gameplay.Components;
using Eco.Gameplay.Items;
using Eco.Gameplay.Items.Recipes;
using Eco.Gameplay.Objects;
using Eco.Gameplay.Skills;
using Eco.Mods.TechTree;
using Eco.Shared.Localization;
using Eco.Shared.Serialization;
using System.Collections.Generic;
using System.Runtime.Versioning;
using System;

namespace WikiDemo
{
#region Item
[Serialized] // Tells the save/load system this object needs to be serialized.
[LocDisplayName("Market Stall")] // Defines the localized name of the item.
[Weight(100)] // Defines how heavy Arrow is.
[Ecopedia("Work Stations", "Craft Tables", createAsSubPage: true)]
[LocDescription("A medieval market stall.")] //The tooltip description for the item.
public partial class MedievalStallItem : WorldObjectItem<MedievalStallObject> { }
#endregion

#region Recipe

#region Object
[Serialized]
public partial class MedievalStallObject : WorldObject, IRepresentsItem
{
public Type RepresentedItemType => typeof(MedievalStallItem);
}
#endregion
}
</syntaxhighlight>'''Line 22:''' This changes from implementing <code>Item</code> to <code>WorldObjectItem<MedievalStallObject></code>. This is what gives the item the ability to place the table down in the world.

'''Line 25:''' The "collapsed" Recipe section. See earlier sections in this guide to see what code belongs here.

'''Line 29:''' Declares the <code>MedievalStallObject</code>. It's important that this class name is matches exactly the <code>.prefab</code> file name because the name is what links them.

'''Line 31:''' This line is similar in function to line 22, it's declaring that this <code>MedievalStallObject</code> is <code>MedievalStallItem</code> when in inventories.

=== Checkpoint ===
Export and see what it does. Ensure it's not lifting off the ground because of a non-curved shader.

==== Origin Point Editing ====
Talk about what it does: the point that the simulation considers this world object to be at.

Show how to move it around using blender.

== Final Export ==
Export.

Package.

Distribute.

From 3D Asset to Working Worktable

2026-04-27T04:56:42Z

WugWugg: Added warning about WIP section

= Introduction =
Below is a guide on how to take an 3D asset from the Unity Store and make a working workbench in Eco. This includes:
* Creating a recipe to craft the modded table
* Creating recipes so the player can use the modded table to craft something
* Using Blender to generate a modded icon (seen when holding it in inventory)
* Using Blender to adjust the origin point of the model
* How to setup all this in a Unity scene and package for Eco

= Setup =

* Already have setup '''ModKit + Unity'''
** See: [[Installing the ModKit]]
* Have a '''3D model'''
** Just following along? Find the one used here at <code><nowiki>https://assetstore.unity.com/packages/3d/props/low-poly-medieval-market-stalls-314286</nowiki></code>
* A '''C# IDE''' (notepad++, Visual Studio, etc.)
** Highly encouraged to have an Intellisense setup and linked to the '''Reference Assemblies'''. Optional, but its really worth the time to figure out because it will help quickly correct small typos and trivial mistakes.
** See: [[Getting Started with Eco Modding in Visual Studio 2022]] (generally the same steps apply if using a new version of Visual Studio)
* '''Blender''' installed
** Homepage: <code><nowiki>https://www.blender.org/</nowiki></code>

== Importing the Assets ==

# Open the Unity editor to the project.
# From the top toolbar open the ''Window'' drop down.
# Hover ''Package Management'' to open sub-menu.
# Select ''Package Manager''.
# The ''Package Manager'' window will pop-up.
# Install the package containing the assets you want to use...
## <u>If not using Unity Registry</u>...
### Find the ''+▾'' button in the top left and open the drop down.
### Install the package from one of those options.
## <u>If using Unity Registry</u>...
### Visit <code><nowiki>https://assetstore.unity.com</nowiki></code> and sign in.
### Search for the asset desired.
### Go to it's page (e.g. <code><nowiki>https://assetstore.unity.com/packages/3d/props/low-poly-medieval-market-stalls-314286</nowiki></code>) and click the big blue button, ''Add to My Assets.''
### Now, in the Unity editor and back at the ''Package Manager'' window.
### Find ''My Assets'' on the left menu and navigate to it.
### Click the ''⟳'' button in the lower-right.
### The asset should be in the list now. Use the search to filter if needed.
### Click on the asset in the list. For those following along, ''Low Poly Medieval Market Stalls''.
### In the right panel, find the ''Download ⤓'' button. Click it.
### Once downloaded, a new button should show up, it'll say something like ''⊕ Import 1.0 to project'' . Click it.
### The ''Import Unity Package'' window will pop-up.
### Select ''Import'' on it.
# Verify you can find your assets from the explorer. If following along, the assets are at <code>Assets/PolyRonin/Medieval Market Stalls</code>.
# Load in a demo scene, if provided, and make sure everything looks okay.
## For those following along, double click on the ''Demo'' scene at <code>Assets/PolyRonin/Medieval Market Stalls/Demo.unity</code>.

[[File:Eco - Unity - View Modes.png|thumb|Underlined in red are the different draw mode buttons. <u>4/20/26</u>]]
If something seems off, check the different draw modes and see if changing those allow the scene to render as expected (see picture).

With all that setup, it's time to get to the creation parts.

= Creating The Worktable =
This guide will create the worktable in this order:

# Create the item that represents the worktable
# Make a recipe to craft the worktable item
# Make the worktable item something that places a world object
# Give the worktable functionality by adding recipes to it

== Creating the Item ==

=== Item Icon ===
[[File:TeamstersStall - StallOnly - 256x256.png|thumb|A large (256x256px) icon created of Stall4 from the medieval assets.]]
This process is also explained here, <code><nowiki>https://mod.io/g/eco/r/origin-points-icon-images-with-blender</nowiki></code>, check it out if you need more visual reference points as that guide has a lot of pictures.

# Open <u>Blender</u>.
# Delete everything in the ''Scene Collection''. Find this section in the top-right of the application.
# From the top toolbar, open the ''File'' drop down.
# Hover ''Import'' to open the sub-menu.
# Select the type of 3D asset. For those using medieval assets, select ''FBX (.fbx)''.
# Find the asset on the computer...
## Tip: Use Unity to find the <code>.fbx</code> asset. For the medieval assets, that's in <code>Assets/PolyRonin/Medieval Market Stalls/Meshes/medieval-market-stalls-1.fbx</code>.
## Right click on it and select ''Show in explorer''.
## Now copy the address of that folder from Explorer. It might look like <code>C:\Users\Wug\EcoMod--WikiDemo\WikiDemo\Assets\PolyRonin\Medieval Market Stalls\Meshes</code>.
## Paste that in the address bar of the <u>Blender</u> import pop-up.
# Select the blue ''Import FBX'' button''.''
# From ''Layout'' mode, change the Viewport Shading to Material Preview or Rendered. This is on the second toolbar down, far right of center, but before ''Scene Collection'' section.
# If you see purple models, Blender will need help finding textures for these meshes...
## From the top toolbar, open the ''File'' drop down.
## Hover ''External Data'' to open the sub-menu.
## Select ''Find Missing Files...''
## Point this to the whole directory that the 3D assets came in. For the medieval pack, <code>C:\Users\</code><code>Wug\EcoMod--WikiDemo\WikiDemo\Assets\PolyRonin</code>.
## The proper textures/materials should have now loaded in. If it hasn't, consult Google because without the textures the following steps won't produce a usable icon.
# Add a source of light...
## Make sure the editor is in the ''Layout'' mode by checking the top most toolbar.
## From the toolbar just under that one, find and open the ''Add'' drop down.
## Hover ''Light'' to open that sub-menu.
## Click ''Sun''.
# Add a camera...
## Again make sure the editor is in the ''Layout'' mode.
## From the second toolbar down, find and open the ''Add'' drop down.
## Select ''Camera''.
# Setup the scene with the object placement and lighting direction desired. '''Tip:''' To reset the editor to something selected press the period key <u>on the numpad</u>. Without a numpad, use ''View'' (second toolbar from the top) and select ''Frame Selected'' from it. Alternatively, just set the zoom to zoom to the mouse position: ''Edit'' (top toolbar), ''Preferences'' (from drop down), ''Navigation'' (on left menu), ''Zoom to Mouse Position'' (In the zoom section). This makes moving around a lot more natural feeling.
# Setup the rendering camera...
## Go to ''Rendering'' tab on the top toolbar
## On the right there will be a side-panel open, it should be the ''Render'' tab. Confirm that.
## Change ''Render Engine'' to ''Cycles''.
## Look down below in the same tab for the ''Film'' section.
## Expand it and find the ''Transparent'' checkbox and section. Click it so that it has a check mark. This will make the icon's background transparent.
## Now, go to the ''Output'' tab <u>on the side panel</u>. The tab is just below the current one.
## In the ''Format'' section set ''Resolution X'' to ''64.'' And ''Y'' to ''64'' as well. This will make the icon generated a 64 by 64 pixel image.
# Go back to the ''Layout'' tab from the top toolbar.
# Center your view on the object (numpad period or ''View > Frame Selected''). Adjust it so that the object is how it should be for the icon.
# Align the camera to the view...
## Make sure the editor is in ''Layout'' mode (top toolbar).
## Find ''View'' from the second from the top toolbar and open the drop down.
## Hover ''Align View'' to open the sub-menu.
## Select ''Align Active Camera To View''.
## If the view is slightly off, there is a lock icon on the right side of this panel. Use it to "lock" controls to the camera and tweak it's view.
# Now return to the ''Rendering'' tab from the top toolbar.
# Press the F12 key to start the render. This should complete quickly since 64x64 pixels is a very small render.
# A window should popup, ''Blender Render''. This is the icon!
# From the top tool bar of this ''Blender Render'' window, open the ''Image'' drop down.
# Select ''Save As...'' to save somewhere on the computer.
# Return to step 13 and repeat to do larger images if desired. Create a 128 by 128 pixel image too. It will make things smoother later.
# Save the Blender scene. Not only will it be used later, this will make making a new icon with a small tweak that much easier.
## ''File'' drop down from top toolbar.
## ''Save As...'' to save the Blender scene to the computer.
## Save it to <code>Assets/WikiDemo/MedievalStall - Icon Scene.blend</code>.

=== Adding to Unity Scene ===
The developers explain how to create an item in one of ModKit's read me files (See: <code>Assets/EcoModKit/Docs/README.md</code>), but this guide will explain it below.

Additionally, '''TheKye''' on YouTube covers this in their ''Creating Your First Item'' and ''Creating Your First Item Pt 2'' videos.

Use those additional resource to help troubleshoot issues with item's icons.

# Open <u>Unity</u>.
# In the left panel, the ''Hierarchy'' tab should be selected.
# Select the top-most object there. It should be a scene. If the editor last loaded the ''Demo'' scene from the medieval assets, it'll be named ''Demo''.
# Right click on this scene and select ''Add New Scene'' from the menu.
# Right click again on the old scene (''Demo'') and select ''Remove Scene''.
# Let it save if the changes to the old scene are important. Discard if it was open just for exploration's sake.
# Right click the new, ''Untitled'' scene. Click ''Save Scene As...''
# Save it to <code>Assets/WikiDemo.unity</code>.
# Delete <u>anything</u> in the scene.
# Right click the scene, hover ''GameObject'', and select ''Create Empty'' from the sub-menu.
# Name this new object ''Objects''.
# Select the newly created ''Objects'' object from the ''Hierarchy'' menu.
# On the far right side of the screen, in the ''Inspector'' menu, click the ''Add Component'' button.
# Type in ''ModkitPrefabContainer''. Click on the component from the search to add it. The component now should be listed in the ''Inspector''.
# In the ''Hierarchy'' panel right click the scene, hover ''GameObject'', and select ''Create Empty''.
# Name this new object ''Items''.
# Right click the scene, hover ''GameObject'', and select ''Create Empty''.
# Name this new object ''Emoji''.
# Select the newly created ''Emoji'' object, find the ''Inspector'' menu (far-right), and click the ''Add Component'' button.
# Type in ''ChatEmoteSetOld''. Click on the component from the search to add it. That component should now be listed in the ''Inspector''.
# Right click the scene, hover ''GameObject'', and select ''Create Empty''.
# Name this new object ''BlockSets''.
# Select the newly created ''BlockSets'' object, find the ''Inspector'' menu (far-right), and click ''Add Component''.
# Search for ''BlockSetContainer''. Click on the component from the search to add it. The ''Inspector'' should now show that component as added.
#Go to <code>Assets/EcoModKit/Prefabs</code> in the Unity project window.
# Find the prefab ''ItemTemplate''.
# Drag it onto the ''Items'' object in the ''Hierarchy'' panel. It should add it as a <u>child</u> of the ''Items'' object.
# Right click on the new ''ItemTemplate'' object, hover ''Prefab'', and select ''Unpack Completely''.
# Right click on the ''ItemTemplate'' object and select ''Rename''. Name this what you want the item to be called. Example: ''MedievalStallItem''.
# Set this item's background...
## Here's the default backgrounds (blue = item, brown = block, green = food): [[File:Eco - Item - Background.png|border|frameless]] [[File:Eco - Block - Background.png|frameless]] [[File:Eco - Food - Background.png|frameless]]
## Download or prepare the background and add it to the <code>Assets</code> folder in Unity.
### To follow along lockstep, put the background in a new <code>Assets/WikiDemo</code> folder.
### Right click on <code>Assets</code> folder, hover ''Create'', select ''Folder''.
### Name the folder ''WikiDemo''.
## Configure Unity to use these as sprites...
### Select the background(s) added (Ctrl+Click each one).
### In the ''Inspector'', find ''TextureType'' and change that to ''Sprite (2D and UI)''.
### Again in the ''Inspector'', find ''SpriteMode'' and change that to ''Single''.
### Then scroll and go to the bottom of the ''Inspector'' and find the ''Apply'' button.
### This will apply those changes to that file and all other ones highlighted.
## Select the item being created (''MedievalStallItem'').
## In the ''Inspector'' panel (far-right), scroll and find the ''Item Template (Script)'' section.
## In here find the ''Background'' input. It'll say ''Background (Image)'' in it. If clicked that text to reveal and highlight the related object in the ''Hierarchy'' panel.
## Select the revealed, and highlighted object ''Background''.
## In the ''Inspector'' panel, scroll and find the ''Image'' component section.
## Inside that component's section, find ''Source Image''. It'll say ''Missing (Sprite)''. Click the ''⦿'' button to the right.
## The ''Select Sprite'' popup will show. Make sure the ''Assets'' tab is selected, and find the backgrounds desired.
#Create the foreground image...
##This is easily accomplished in MS Paint.
##Get to the background image file in a <u>file explorer</u>.
##Right click on it, hover ''Open with...'', and select ''Paint''.
##The solid background should be displayed.
##Open the ''File'' menu from the top toolbar.
##Hover ''Import to Canvas'' and select ''From a File''.
##Find the icon in the file browser and import it. Match the size of the background image to have it nicely center itself.
##Now ''File'' from the top toolbar.
##Hover ''Save As...'' and select ''PNG''.
##Save this to the <code>Assets/WikiDemo</code> folder in Unity.
##Configure Unity to use these as sprites...
### Select the foreground image.
### In the ''Inspector'', find ''TextureType'' and change that to ''Sprite (2D and UI)''.
### Again in the ''Inspector'', find ''SpriteMode'' and change that to ''Single''.
### Then scroll and go to the bottom of the ''Inspector'' and find the ''Apply'' button.
### This will apply those changes to that file and all other ones highlighted.
#Set this item's foreground...
## Copy the item's icon into the <code>Assets</code> folder.
## Configure Unity to use it as a sprite (see the previous step's ''Set this item's background...'' instructions)
## Select the item being created (''MedievalStallItem'').
## In the ''Inspector'' panel (far-right), scroll and find the ''Item Template (Script)'' section.
## In here find the ''Foreground'' input. It'll say ''Foreground (Image)'' in it. If clicked that text to reveal and highlight the related object in the ''Hierarchy'' panel.
## Select the revealed, and highlighted object ''Foreground''.
## Use the ''Inspector'', find the ''Image'' component, within that component find the ''Source Image'' input. It will say ''Missing (Sprite)''.
## Click the ''⦿'' button to the right of that input.
## From the ''Select Sprite'' popup, ensure the ''Assets'' tab is being searched, and find the icon just created.

=== Export From Unity ===

# Open the ''File'' menu from the top toolbar.
# Select ''Save.'' Save it to the <code>Assets/WikiDemo</code> folder. '''Note:''' Do not skip. The scene must be saved for the ModKit build to work properly.
# Open the ''Eco Tools'' menu from the top toolbar.
# Hover ''Mod Kit'' to open the sub-menu.
# Select ''Build Current Bundle''.
# Have it output the bundle to <code>/Eco Server/Mods/UserCode/WikiDemo.unity3d</code>
# Wait for this to build. This may take a few minutes.

=== Scripting the Item ===
For a more complex mod, it would be wise to build it into a DLL. See [[Getting Started with Eco Modding in Visual Studio 2022]] for details on that.

# Create a <code>.cs</code> file: <code>/Eco Server/Mods/UserCode/WikiDemo.cs</code>
# Put the following into the newly created file:
<syntaxhighlight lang="c#" line="1">using Eco.Core.Items;
using Eco.Gameplay.Items;
using Eco.Shared.Localization;
using Eco.Shared.Serialization;

namespace WikiDemo
{
#region Item
[Serialized] // Tells the save/load system this object needs to be serialized.
[LocDisplayName("Market Stall")] // Defines the localized name of the item.
[Weight(100)] // Defines how heavy Arrow is.
[Ecopedia("Work Stations", "Craft Tables", createAsSubPage: true)]
[LocDescription("A medieval market stall.")] //The tooltip description for the item.
public partial class MedievalStallItem: Item { }
#endregion
}</syntaxhighlight>'''Line 8:''' A region tag. Lets the editor know it can collapse all of that code as a section. The following examples in this guide will just show <code>#region Item</code> in their code examples.

'''Line 13:''' The implementation of <code>Item</code> means that Eco will find this and look for Unity assets that matching this class' name, <code>MedivalStallItem</code>. While this doesn't do anything fancy, it completes the first step towards a new workbench.

=== Checkpoint ===
[[File:Eco - Hotbar With Modded Icon.png|thumb|Shows the medieval stall as a modded icon in-game.]]
This was a lot of setup and steps. Make sure everything is running smoothly by doing the following:

# Double-check that the <code>WikiDemo.unity3d</code> and the <code>WikiDemo.cs</code> files are in <code>/Eco Server/Mods/UserCode</code> folder.
# Start the server and connect to it.
# Test it out by typing <code>/give MedievalStall</code> in chat
## It's also possible to do <code>/give Market Stall</code> to get the item. How? Line 10: of the the above code declares that name as this item's "common name". Neat.
# The item should appear in the players inventory with a working icon.

This was the longest "leg" of this journey. All the setup is done and the infrastructure is in place. The following sections will just build on what was taught here.

Keep on, keeping on!

== Code the Item's Recipe ==
This section will be much simpler than the last. The following goes over how to add a new class and implement the <code>RecipeFamily</code> interface.<syntaxhighlight lang="c#" line="1">using Eco.Core.Items;
using Eco.Gameplay.Components;
using Eco.Gameplay.Items;
using Eco.Gameplay.Items.Recipes;
using Eco.Gameplay.Skills;
using Eco.Mods.TechTree;
using Eco.Shared.Localization;
using Eco.Shared.Serialization;
using System.Runtime.Versioning;
using System.Collections.Generic;

namespace WikiDemo
{
#region Item

#region Recipe
[RequiresSkill(typeof(CarpentrySkill), 3)]
[Ecopedia("Work Stations", "Craft Tables", subPageName: "Market Stall")]
public partial class MedievalStallRecipe : RecipeFamily
{
[SupportedOSPlatform("windows7.0")]
public MedievalStallRecipe()
{
var recipe = new Recipe();
recipe.Init(
name: "MedievalStallItem",
displayName: Localizer.DoStr("Market Stall"),
ingredients: new List<IngredientElement>
{
new IngredientElement("Wood", 40, typeof(Skill)),
new IngredientElement(typeof(CottonFabricItem), 30, typeof(Skill)),
new IngredientElement(typeof(HempMooringRopeItem), 5, true)
},
items: new List<CraftingElement>
{
new CraftingElement<MedievalStallItem>(1)
}
);
this.Recipes = new List<Recipe> { recipe };
this.LaborInCalories = CreateLaborInCaloriesValue(800, typeof(Skill));
this.CraftMinutes = CreateCraftTimeValue(typeof(MedievalStallRecipe), 10f, typeof(Skill));

// Perform pre/post initialization for user mods and initialize our recipe instance with the display name "Market Stall"
this.ModsPreInitialize();
this.Initialize(displayText: Localizer.DoStr("Market Stall"), recipeType: typeof(MedievalStallRecipe));
this.ModsPostInitialize();

// Register our RecipeFamily instance to a work table (in this case the Carpentry Table) so it can be crafted.
CraftingComponent.AddRecipe(tableType: typeof(CarpentryTableObject), recipeFamily: this); // NOTE: The table must be the object instance!
}

/// <summary>Hook for other mods to customize RecipeFamily before initialization.</summary>
partial void ModsPreInitialize();

/// <summary>Hook for other mods to customize RecipeFamily after initialization, but before registration. You can change skill requirements here.</summary>
partial void ModsPostInitialize();
}
#endregion
}</syntaxhighlight>'''Line 10:''' Eco will need this explicitly added to the file. Visual Studio will not add this line automatically. It's used for the <code>List<T></code> objects found in this code.

'''Line 14:''' "Collapsed" <code>Item</code> section. See the earlier sections in this guide for the code that belongs there.

'''Line 17:''' Sets the required skill and skill level to craft this recipe.

'''Line 21:''' <code>[SupportedOSPlatform("windows7.0")]</code> is here to silence some annoying warnings in Visual Studio. It's optional.

'''Line 30-32:''' Declares the input ingredients used for crafting. <code>typeof(Skill)</code> gets mapped to the <code>CarpentrySkill</code> as defined by line 31. In this example the <code>HempMooringRope</code> is a static input. A static input will not be modified by skills, upgrade modules, or game settings. '''Note:''' It seems that at the time of writing (4/21/2026, Eco v13.0.2) the only way to get an ingredient to be a dynamic value that is reduced by the table's upgrade is to pass <code>typeof(Skill)</code> to it; Passing either <code>true</code> or <code>false</code> makes the this input static.

'''Line 34:''' The <code>items</code> list declares what items are <u>output</u> by this recipe.

'''Line 36:''' This line declares that one medieval stall is output from this recipe. Functionally this links this recipe to the <code>MedievalStallItem</code> (aka "Market Stall") item created in the last step.

'''Line 40:''' Amount of calories needed to craft this item. For a static value (not modified by upgrades or skill levels) change this line to: <code>this.LaborInCalories = CreateLaborInCaloriesValue(800);</code>. As it's written in the example, this item's calorie cost will be dynamic (modified by upgrades and skill levels). The skill level that will modify it is declared on line 16.

'''Line 41:''' Minutes needed to craft. Both static and dynamic values for crafting time can be modified by the world difficulty settings. For a static value change this line to: <code>this.CraftMinutes = CreateCraftTimeValue(10f);</code>. As it's written in the example, this item's craft time will be dynamic.'''Line 49:''' This line assigns the recipe to a workbench. <u>Do not assign</u> to itself because then the first table could never be made. It's recommend to use a preexisting vanilla table.
=== Checkpoint ===
Check the functionality at this point -- it should be possible to see the recipe in the crafting table.

# Have the <code>.unity3d</code> and the <code>.cs</code> file in the <code>/Eco Server/Mods/UserCode</code> folder.
# Start the server and log in.
# Type <code>/give Carpentry Table</code>.
# Place the Carpentry Table down and interact to see the what can be crafted.
# Scroll and find the ''Market Stall'' recipe.
# Type <code>/give Basic Upgrade 4</code>.
# Put the basic upgrade into the table.
# Go back to the recipe for the ''Market Stall'' and make sure the Wood and the Cotton fabric inputs now require less, but the Hemp Mooring Rope still is the same. '''Note:''' In case the recipe hasn't changed close that table's window and interact with it again. It should for the recipes to refresh now that the upgrade is in it.

== Create the World Object ==
=== Preparing the 3D Asset ===
WIP. Below is <u>incorrect</u>. The origin point of the object must be in the center, bottom of the object. Instructions for reference cube moving and origin moving will produce bad results!
# Open <u>Blender</u>.
# Load the 3D object created earlier for icon rendering -- <code>Assets/WikiDemo/MedievalStall - Icon Scene.blend</code>.
# Cleanup the scene...
## Use the scene collection panel on the top-right side of the screen. Select and '''delete any light source'''. These will have a 💡 icon and by default are named something like "sun", "point", "spot" or "area". '''Note:''' If your model is a light source or has one in it, you can leave that light source. The point here is to remove the ambient lights used for icon rendering.
## In the scene collection panel, select and '''delete any camera(s)'''. These have a 🎥 icon and by default are named something like "camera".
# <u>If there are multiple different 3D assets in the scene</u> (like bags, crates, jars, ect.), join them all together...
## Select all of the meshes by holding ''Shift'' and clicking on each one in the ''Scene Collection'' panel (right side of window). '''Tip:''' Quickly select a group of them by selecting one near the top. Then hold ''Shift'', ''Ctrl,'' and click on one near the bottom. This will both the one at the top and the one at the bottom, but also every item in between. Neat!
## Be in ''Layout'' mode (top toolbar).
## Find and open the ''Object'' menu (second toolbar down from the top).
## Select ''Join''.
## In the ''Scene Collection'' panel, double click on the name of the newly joined mesh.
## Rename it to <code>MedievalStallMesh</code>.
# Add and position a reference cube...
## Make sure the editor is in ''Layout'' view (top toolbar).
## Then, add a reference cube. Open the ''Add'' menu (second top toolbar down).
## Hover ''Mesh''.
## Select ''Cube.''
## Find the ''Properties'' panel. It's just below the ''Scene Collection'' panel on the right side of the window.
## Now, still inside that panel but on the left side of it there's a column of icons.
## Hover them to see their names.
## Find the one that reads: ''Object'' ''Object Properties'' '''Tip:''' It kinda looks like an orange box
## Find and expand the ''Transform'' section
## Set ''Location X'' to ''1''.
## Just below that, set ''Y'' to ''1''.
## Just below that, again, set ''Z'' to ''1''.
## The bottom corner of the cube will be touching the green and red axis lines.
# Move the reference cube's origin to <code>(0, 0, 0)</code>...
## Be in ''Layout'' mode (top toolbar).
## Open the ''View'' menu (second toolbar down).
## Select ''Sidebar''.
## A new panel will have expanded.
## Along the right side of that panel there's buttons (''Item, Tool, View, Animation''). Find and click the ''View'' button.
## Find and expand the ''3D Cursor'' section.
## Under ''Location'' set ''X'' to ''0''.
## ''Y'' to 0.
## ''Z'' to 0.
## Now in the ''Scene Collection'' panel, select the ''Cube'' mesh.
## Open the ''Object'' menu from the second toolbar down from the top.
## Hover ''Set Origin''.
## Select ''Origin to 3D Cursor''.
# Set the reference cube's dimensions...
## Be in ''Layout'' mode, open the ''View'' menu (second toolbar down), and select and expand the ''Sidebar'' option''.''
## To the right of the sidebar, find and click the ''Item'' button.
## Expand the ''Transform'' section.
## Find the ''Dimensions,'' and set ''X'' to ''4''.
## ''Y'' to ''3''.
## ''Z'' to ''3''. '''Note:''' These dimensions only make sense for the asset being used for this guide. If using a different one, set the dimensions to the size of the box that model should fit in
# Adjust the position and scale to fit inside a box. This is important because it ensures that this object won't clip into other objects when placed.
## Be in ''Layout'' mode (top toolbar).
## Find the drop down in the second toolbar from the top that has options like ''Object Mode, Edit Mode, Sculpt Mode,'' etc.
## Select ''Object Mode'' from that drop down.
## On the left side of the screen there's a column of icons. Hover over them to see their names.
## Select the ''Move'' tool.
## Click on the Medieval Stall to select it. Zoom out and reposition the camera so that the blue, green, and red arrows are visible. '''Tip:''' By holding the middle-mouse button and dragging the scene will rotate. By holding the middle-mouse button and the ''Shift'' key, the scene will pan. '''Tip:''' If panning or rotating the scene becomes slow or frustrating (especially after zooming), try selecting 3D asset from the ''Scene Collection'' panel, opening the ''View'' menu (second toolbar from top), and selecting ''Frame Selected''. This will reset the view onto that object and controls should feel normal again.
## Click and hold one of the arrows. Move the mouse to drag the 3D asset towards the box.
## Move the 3D asset around till it's <u>completely inside the box</u>. If it cannot fit and is too big, continue to the next step. '''Tip:''' To select the 3D asset once it disappears, use the ''Scene Collection'' panel. Click on it there and the blue, green, and red arrows will show up again for it. '''Tip:''' There are preset views. To use them go to the ''View'' menu (second toolbar from top)'','' hover ''Viewpoint'', and select the view that would be most helpful.
## Find the ''Scale'' tool from the left side of the screen.
## Now the blue, green, and red "arrows" don't really look like arrows anymore. They are lines with boxes at the end.
## Click and hold on those lines to adjust the scale of the 3D asset to make it fit inside the box. '''Tip:''' There are little colored boxes in between the lines that can be dragged to scale the 3D asset more proportionally.
## Continue using the ''Move'' and ''Scale'' tools till the model fits. This will take patience and time. '''Tip:''' Hide the reference cube to see what is happening with the 3D asset. Go to the ''Scene Collections'' panel and click the 👁 button to hide it. Click that button again to show it.
# Now set the 3D asset's origin point... 
## Ensure that the 3D Cursor is still at <code>(0,0,0)</code>: Open the ''View'' menu (second toolbar down), select and expand the ''Sidebar'', click the ''View'' button (right side of the Sidebar), find and expand the ''3D cursor'' section, change the ''Location X, Y,'' and ''Z'' to ''0''.
## Select the 3D asset using the ''Scene Collection'' panel.
## Open the ''Object'' menu (second toolbar down).
## Hover ''Set Origin''.
## Select ''Origin to 3D Cursor''.
# Select the reference cube from the ''Scene Collections'' panel.
# Open ''Object'' menu (second toolbar down).
# Select ''Delete''.
# Open the ''Object'' menu.
# Hover ''Apply''.
# Select ''All Transformations''.
# Open the ''File'' menu from the top toolbar.
# Hover ''Export'' to open the sub-menu.
# Select ''FBX (.fbx)''
# A ''Blender File View'' window will pop-up.
# On the right side of this window there's a ⚙️ icon. Click it to expand the settings region.
# In the expanded region find the ''Include'' section and expand it. Change the following:
## Find ''Object Types'' and only select ''Mesh.'' No other option should be highlighted for this setting.
# In the settings region scroll and find the ''Transform'' section and expand it. Change the following:
## Find ''Apply Scalings'' and set it to ''FBX All''.
## Just below that find ''Forward'' and set it to ''-Z Forward''.
## Ensure that the next setting down, ''Up'', changed to ''Y Up''.
## Find ''Apply Unit'' and make sure it's checked.
## Next, find ''Use Space Transform'' check it.
## Lastly, find ''Apply Transform'' and check it too.
# Save it to <code>Assets/WikiDemo/MedievalStall.fbx</code>.
# Save the <code>.blend</code> file too and close Blender.

=== Add to Unity Scene ===

# Open <u>Unity</u>.
# Select the <code>.fbx</code> file in the project window.
# Open the ''Eco Tools'' menu from the top toolbar.
# Hover ''Mod Kit''.
# Select ''World Object Setup.''
# A ''World Object Setup'' window will pop-up.
# Make sure that ''Selected Objects'' reads ''MedievalStall.''
# Also make sure that ''World Object Type'' is set to ''World Object''.
# Press the ''Setup World Objects'' button.
# Notice in the project window that a new <code>.prefab</code> file was created -- <code>MedievalStallObject.prefab</code>
# Select the <code>.prefab</code> file in the project window.
# In the ''Inspector'' window (right side), scroll and find the ''World Object (Script)'' component.
# In that component, find the ''Override Occupancy'' checkbox and check it.
# A new field just appeared, ''Size''.
# Set the ''X'' to ''4''.
# ''Y'' to ''3''.
# ''Z'' to ''3.'' '''Note:''' These are the sizes used for the reference cube. If using different sizes make sure you <u>flip the Y and Z coordinates</u> when reading coordinates from Blender. Blender uses a different coordinate system that Unity!
# Select ''Objects'' from ''Hierarchy'' panel.
# Find the ''Modkit Prefab Container (Script)'' component.
# Expand the ''Prefabs'' section in that component.
# Click the ''+'' button to add an item to the list.
# Either...
## Click the ''⦿'' button, switch to the ''Assets'' tab, find or search for ''MedievalStallObject'', and double click on it. Make sure it's the medieval stall <u>object</u> with the <code>.prefab</code> ending.
## Drag the <code>.prefab</code> file onto the ''⦿'' button
#
# Open the ''File'' menu from top toolbar and select ''Save''. '''Note:''' Do not skip. The scene must be saved for the ModKit build to work properly.
# Open the ''Eco Tools'' menu from the top toolbar.
# Hover ''Mod Kit''.
# Select ''Build Current Bundle''.
# Save the bundle to <code>/Eco Server/Mods/UserCode/WikiDemo.unity3d</code>

'''TODO:''' Explain that if the orgin point isn't at the bottom-left corner of the model, then ''World Object (Script) > Occupancy Offset'' will need adjusted manually.

=== Scripting the World Object ===
Code that links the Item to this World Object.<syntaxhighlight lang="c#" line="1">
using Eco.Core.Items;
using Eco.Gameplay.Components;
using Eco.Gameplay.Items;
using Eco.Gameplay.Items.Recipes;
using Eco.Gameplay.Objects;
using Eco.Gameplay.Skills;
using Eco.Mods.TechTree;
using Eco.Shared.Localization;
using Eco.Shared.Serialization;
using System.Collections.Generic;
using System.Runtime.Versioning;
using System;

namespace WikiDemo
{
#region Item
[Serialized] // Tells the save/load system this object needs to be serialized.
[LocDisplayName("Market Stall")] // Defines the localized name of the item.
[Weight(100)] // Defines how heavy Arrow is.
[Ecopedia("Work Stations", "Craft Tables", createAsSubPage: true)]
[LocDescription("A medieval market stall.")] //The tooltip description for the item.
public partial class MedievalStallItem : WorldObjectItem<MedievalStallObject> { }
#endregion

#region Recipe

#region Object
[Serialized]
public partial class MedievalStallObject : WorldObject, IRepresentsItem
{
public Type RepresentedItemType => typeof(MedievalStallItem);
}
#endregion
}
</syntaxhighlight>'''Line 22:''' This changes from implementing <code>Item</code> to <code>WorldObjectItem<MedievalStallObject></code>. This is what gives the item the ability to place the table down in the world.

'''Line 25:''' The "collapsed" Recipe section. See earlier sections in this guide to see what code belongs here.

'''Line 29:''' Declares the <code>MedievalStallObject</code>. It's important that this class name is matches exactly the <code>.prefab</code> file name because the name is what links them.

'''Line 31:''' This line is similar in function to line 22, it's declaring that this <code>MedievalStallObject</code> is <code>MedievalStallItem</code> when in inventories.

=== Checkpoint ===
Export and see what it does. Ensure it's not lifting off the ground because of a non-curved shader.

==== Origin Point Editing ====
Talk about what it does: the point that the simulation considers this world object to be at.

Show how to move it around using blender.

== Final Export ==
Export.

Package.

Distribute.

From 3D Asset to Working Worktable

2026-04-26T23:16:09Z

WugWugg: WIP

= Introduction =
Below is a guide on how to take an 3D asset from the Unity Store and make a working workbench in Eco. This includes:
* Creating a recipe to craft the modded table
* Creating recipes so the player can use the modded table to craft something
* Using Blender to generate a modded icon (seen when holding it in inventory)
* Using Blender to adjust the origin point of the model
* How to setup all this in a Unity scene and package for Eco

= Setup =

* Already have setup '''ModKit + Unity'''
** See: [[Installing the ModKit]]
* Have a '''3D model'''
** Just following along? Find the one used here at <code><nowiki>https://assetstore.unity.com/packages/3d/props/low-poly-medieval-market-stalls-314286</nowiki></code>
* A '''C# IDE''' (notepad++, Visual Studio, etc.)
** Highly encouraged to have an Intellisense setup and linked to the '''Reference Assemblies'''. Optional, but its really worth the time to figure out because it will help quickly correct small typos and trivial mistakes.
** See: [[Getting Started with Eco Modding in Visual Studio 2022]] (generally the same steps apply if using a new version of Visual Studio)
* '''Blender''' installed
** Homepage: <code><nowiki>https://www.blender.org/</nowiki></code>

== Importing the Assets ==

# Open the Unity editor to the project.
# From the top toolbar open the ''Window'' drop down.
# Hover ''Package Management'' to open sub-menu.
# Select ''Package Manager''.
# The ''Package Manager'' window will pop-up.
# Install the package containing the assets you want to use...
## <u>If not using Unity Registry</u>...
### Find the ''+▾'' button in the top left and open the drop down.
### Install the package from one of those options.
## <u>If using Unity Registry</u>...
### Visit <code><nowiki>https://assetstore.unity.com</nowiki></code> and sign in.
### Search for the asset desired.
### Go to it's page (e.g. <code><nowiki>https://assetstore.unity.com/packages/3d/props/low-poly-medieval-market-stalls-314286</nowiki></code>) and click the big blue button, ''Add to My Assets.''
### Now, in the Unity editor and back at the ''Package Manager'' window.
### Find ''My Assets'' on the left menu and navigate to it.
### Click the ''⟳'' button in the lower-right.
### The asset should be in the list now. Use the search to filter if needed.
### Click on the asset in the list. For those following along, ''Low Poly Medieval Market Stalls''.
### In the right panel, find the ''Download ⤓'' button. Click it.
### Once downloaded, a new button should show up, it'll say something like ''⊕ Import 1.0 to project'' . Click it.
### The ''Import Unity Package'' window will pop-up.
### Select ''Import'' on it.
# Verify you can find your assets from the explorer. If following along, the assets are at <code>Assets/PolyRonin/Medieval Market Stalls</code>.
# Load in a demo scene, if provided, and make sure everything looks okay.
## For those following along, double click on the ''Demo'' scene at <code>Assets/PolyRonin/Medieval Market Stalls/Demo.unity</code>.

[[File:Eco - Unity - View Modes.png|thumb|Underlined in red are the different draw mode buttons. <u>4/20/26</u>]]
If something seems off, check the different draw modes and see if changing those allow the scene to render as expected (see picture).

With all that setup, it's time to get to the creation parts.

= Creating The Worktable =
This guide will create the worktable in this order:

# Create the item that represents the worktable
# Make a recipe to craft the worktable item
# Make the worktable item something that places a world object
# Give the worktable functionality by adding recipes to it

== Creating the Item ==

=== Item Icon ===
[[File:TeamstersStall - StallOnly - 256x256.png|thumb|A large (256x256px) icon created of Stall4 from the medieval assets.]]
This process is also explained here, <code><nowiki>https://mod.io/g/eco/r/origin-points-icon-images-with-blender</nowiki></code>, check it out if you need more visual reference points as that guide has a lot of pictures.

# Open <u>Blender</u>.
# Delete everything in the ''Scene Collection''. Find this section in the top-right of the application.
# From the top toolbar, open the ''File'' drop down.
# Hover ''Import'' to open the sub-menu.
# Select the type of 3D asset. For those using medieval assets, select ''FBX (.fbx)''.
# Find the asset on the computer...
## Tip: Use Unity to find the <code>.fbx</code> asset. For the medieval assets, that's in <code>Assets/PolyRonin/Medieval Market Stalls/Meshes/medieval-market-stalls-1.fbx</code>.
## Right click on it and select ''Show in explorer''.
## Now copy the address of that folder from Explorer. It might look like <code>C:\Users\Wug\EcoMod--WikiDemo\WikiDemo\Assets\PolyRonin\Medieval Market Stalls\Meshes</code>.
## Paste that in the address bar of the <u>Blender</u> import pop-up.
# Select the blue ''Import FBX'' button''.''
# From ''Layout'' mode, change the Viewport Shading to Material Preview or Rendered. This is on the second toolbar down, far right of center, but before ''Scene Collection'' section.
# If you see purple models, Blender will need help finding textures for these meshes...
## From the top toolbar, open the ''File'' drop down.
## Hover ''External Data'' to open the sub-menu.
## Select ''Find Missing Files...''
## Point this to the whole directory that the 3D assets came in. For the medieval pack, <code>C:\Users\</code><code>Wug\EcoMod--WikiDemo\WikiDemo\Assets\PolyRonin</code>.
## The proper textures/materials should have now loaded in. If it hasn't, consult Google because without the textures the following steps won't produce a usable icon.
# Add a source of light...
## Make sure the editor is in the ''Layout'' mode by checking the top most toolbar.
## From the toolbar just under that one, find and open the ''Add'' drop down.
## Hover ''Light'' to open that sub-menu.
## Click ''Sun''.
# Add a camera...
## Again make sure the editor is in the ''Layout'' mode.
## From the second toolbar down, find and open the ''Add'' drop down.
## Select ''Camera''.
# Setup the scene with the object placement and lighting direction desired. '''Tip:''' To reset the editor to something selected press the period key <u>on the numpad</u>. Without a numpad, use ''View'' (second toolbar from the top) and select ''Frame Selected'' from it. Alternatively, just set the zoom to zoom to the mouse position: ''Edit'' (top toolbar), ''Preferences'' (from drop down), ''Navigation'' (on left menu), ''Zoom to Mouse Position'' (In the zoom section). This makes moving around a lot more natural feeling.
# Setup the rendering camera...
## Go to ''Rendering'' tab on the top toolbar
## On the right there will be a side-panel open, it should be the ''Render'' tab. Confirm that.
## Change ''Render Engine'' to ''Cycles''.
## Look down below in the same tab for the ''Film'' section.
## Expand it and find the ''Transparent'' checkbox and section. Click it so that it has a check mark. This will make the icon's background transparent.
## Now, go to the ''Output'' tab <u>on the side panel</u>. The tab is just below the current one.
## In the ''Format'' section set ''Resolution X'' to ''64.'' And ''Y'' to ''64'' as well. This will make the icon generated a 64 by 64 pixel image.
# Go back to the ''Layout'' tab from the top toolbar.
# Center your view on the object (numpad period or ''View > Frame Selected''). Adjust it so that the object is how it should be for the icon.
# Align the camera to the view...
## Make sure the editor is in ''Layout'' mode (top toolbar).
## Find ''View'' from the second from the top toolbar and open the drop down.
## Hover ''Align View'' to open the sub-menu.
## Select ''Align Active Camera To View''.
## If the view is slightly off, there is a lock icon on the right side of this panel. Use it to "lock" controls to the camera and tweak it's view.
# Now return to the ''Rendering'' tab from the top toolbar.
# Press the F12 key to start the render. This should complete quickly since 64x64 pixels is a very small render.
# A window should popup, ''Blender Render''. This is the icon!
# From the top tool bar of this ''Blender Render'' window, open the ''Image'' drop down.
# Select ''Save As...'' to save somewhere on the computer.
# Return to step 13 and repeat to do larger images if desired. Create a 128 by 128 pixel image too. It will make things smoother later.
# Save the Blender scene. Not only will it be used later, this will make making a new icon with a small tweak that much easier.
## ''File'' drop down from top toolbar.
## ''Save As...'' to save the Blender scene to the computer.
## Save it to <code>Assets/WikiDemo/MedievalStall - Icon Scene.blend</code>.

=== Adding to Unity Scene ===
The developers explain how to create an item in one of ModKit's read me files (See: <code>Assets/EcoModKit/Docs/README.md</code>), but this guide will explain it below.

Additionally, '''TheKye''' on YouTube covers this in their ''Creating Your First Item'' and ''Creating Your First Item Pt 2'' videos.

Use those additional resource to help troubleshoot issues with item's icons.

# Open <u>Unity</u>.
# In the left panel, the ''Hierarchy'' tab should be selected.
# Select the top-most object there. It should be a scene. If the editor last loaded the ''Demo'' scene from the medieval assets, it'll be named ''Demo''.
# Right click on this scene and select ''Add New Scene'' from the menu.
# Right click again on the old scene (''Demo'') and select ''Remove Scene''.
# Let it save if the changes to the old scene are important. Discard if it was open just for exploration's sake.
# Right click the new, ''Untitled'' scene. Click ''Save Scene As...''
# Save it to <code>Assets/WikiDemo.unity</code>.
# Delete <u>anything</u> in the scene.
# Right click the scene, hover ''GameObject'', and select ''Create Empty'' from the sub-menu.
# Name this new object ''Objects''.
# Select the newly created ''Objects'' object from the ''Hierarchy'' menu.
# On the far right side of the screen, in the ''Inspector'' menu, click the ''Add Component'' button.
# Type in ''ModkitPrefabContainer''. Click on the component from the search to add it. The component now should be listed in the ''Inspector''.
# In the ''Hierarchy'' panel right click the scene, hover ''GameObject'', and select ''Create Empty''.
# Name this new object ''Items''.
# Right click the scene, hover ''GameObject'', and select ''Create Empty''.
# Name this new object ''Emoji''.
# Select the newly created ''Emoji'' object, find the ''Inspector'' menu (far-right), and click the ''Add Component'' button.
# Type in ''ChatEmoteSetOld''. Click on the component from the search to add it. That component should now be listed in the ''Inspector''.
# Right click the scene, hover ''GameObject'', and select ''Create Empty''.
# Name this new object ''BlockSets''.
# Select the newly created ''BlockSets'' object, find the ''Inspector'' menu (far-right), and click ''Add Component''.
# Search for ''BlockSetContainer''. Click on the component from the search to add it. The ''Inspector'' should now show that component as added.
#Go to <code>Assets/EcoModKit/Prefabs</code> in the Unity project window.
# Find the prefab ''ItemTemplate''.
# Drag it onto the ''Items'' object in the ''Hierarchy'' panel. It should add it as a <u>child</u> of the ''Items'' object.
# Right click on the new ''ItemTemplate'' object, hover ''Prefab'', and select ''Unpack Completely''.
# Right click on the ''ItemTemplate'' object and select ''Rename''. Name this what you want the item to be called. Example: ''MedievalStallItem''.
# Set this item's background...
## Here's the default backgrounds (blue = item, brown = block, green = food): [[File:Eco - Item - Background.png|border|frameless]] [[File:Eco - Block - Background.png|frameless]] [[File:Eco - Food - Background.png|frameless]]
## Download or prepare the background and add it to the <code>Assets</code> folder in Unity.
### To follow along lockstep, put the background in a new <code>Assets/WikiDemo</code> folder.
### Right click on <code>Assets</code> folder, hover ''Create'', select ''Folder''.
### Name the folder ''WikiDemo''.
## Configure Unity to use these as sprites...
### Select the background(s) added (Ctrl+Click each one).
### In the ''Inspector'', find ''TextureType'' and change that to ''Sprite (2D and UI)''.
### Again in the ''Inspector'', find ''SpriteMode'' and change that to ''Single''.
### Then scroll and go to the bottom of the ''Inspector'' and find the ''Apply'' button.
### This will apply those changes to that file and all other ones highlighted.
## Select the item being created (''MedievalStallItem'').
## In the ''Inspector'' panel (far-right), scroll and find the ''Item Template (Script)'' section.
## In here find the ''Background'' input. It'll say ''Background (Image)'' in it. If clicked that text to reveal and highlight the related object in the ''Hierarchy'' panel.
## Select the revealed, and highlighted object ''Background''.
## In the ''Inspector'' panel, scroll and find the ''Image'' component section.
## Inside that component's section, find ''Source Image''. It'll say ''Missing (Sprite)''. Click the ''⦿'' button to the right.
## The ''Select Sprite'' popup will show. Make sure the ''Assets'' tab is selected, and find the backgrounds desired.
#Create the foreground image...
##This is easily accomplished in MS Paint.
##Get to the background image file in a <u>file explorer</u>.
##Right click on it, hover ''Open with...'', and select ''Paint''.
##The solid background should be displayed.
##Open the ''File'' menu from the top toolbar.
##Hover ''Import to Canvas'' and select ''From a File''.
##Find the icon in the file browser and import it. Match the size of the background image to have it nicely center itself.
##Now ''File'' from the top toolbar.
##Hover ''Save As...'' and select ''PNG''.
##Save this to the <code>Assets/WikiDemo</code> folder in Unity.
##Configure Unity to use these as sprites...
### Select the foreground image.
### In the ''Inspector'', find ''TextureType'' and change that to ''Sprite (2D and UI)''.
### Again in the ''Inspector'', find ''SpriteMode'' and change that to ''Single''.
### Then scroll and go to the bottom of the ''Inspector'' and find the ''Apply'' button.
### This will apply those changes to that file and all other ones highlighted.
#Set this item's foreground...
## Copy the item's icon into the <code>Assets</code> folder.
## Configure Unity to use it as a sprite (see the previous step's ''Set this item's background...'' instructions)
## Select the item being created (''MedievalStallItem'').
## In the ''Inspector'' panel (far-right), scroll and find the ''Item Template (Script)'' section.
## In here find the ''Foreground'' input. It'll say ''Foreground (Image)'' in it. If clicked that text to reveal and highlight the related object in the ''Hierarchy'' panel.
## Select the revealed, and highlighted object ''Foreground''.
## Use the ''Inspector'', find the ''Image'' component, within that component find the ''Source Image'' input. It will say ''Missing (Sprite)''.
## Click the ''⦿'' button to the right of that input.
## From the ''Select Sprite'' popup, ensure the ''Assets'' tab is being searched, and find the icon just created.

=== Export From Unity ===

# Open the ''File'' menu from the top toolbar.
# Select ''Save.'' Save it to the <code>Assets/WikiDemo</code> folder. '''Note:''' Do not skip. The scene must be saved for the ModKit build to work properly.
# Open the ''Eco Tools'' menu from the top toolbar.
# Hover ''Mod Kit'' to open the sub-menu.
# Select ''Build Current Bundle''.
# Have it output the bundle to <code>/Eco Server/Mods/UserCode/WikiDemo.unity3d</code>
# Wait for this to build. This may take a few minutes.

=== Scripting the Item ===
For a more complex mod, it would be wise to build it into a DLL. See [[Getting Started with Eco Modding in Visual Studio 2022]] for details on that.

# Create a <code>.cs</code> file: <code>/Eco Server/Mods/UserCode/WikiDemo.cs</code>
# Put the following into the newly created file:
<syntaxhighlight lang="c#" line="1">using Eco.Core.Items;
using Eco.Gameplay.Items;
using Eco.Shared.Localization;
using Eco.Shared.Serialization;

namespace WikiDemo
{
#region Item
[Serialized] // Tells the save/load system this object needs to be serialized.
[LocDisplayName("Market Stall")] // Defines the localized name of the item.
[Weight(100)] // Defines how heavy Arrow is.
[Ecopedia("Work Stations", "Craft Tables", createAsSubPage: true)]
[LocDescription("A medieval market stall.")] //The tooltip description for the item.
public partial class MedievalStallItem: Item { }
#endregion
}</syntaxhighlight>'''Line 8:''' A region tag. Lets the editor know it can collapse all of that code as a section. The following examples in this guide will just show <code>#region Item</code> in their code examples.

'''Line 13:''' The implementation of <code>Item</code> means that Eco will find this and look for Unity assets that matching this class' name, <code>MedivalStallItem</code>. While this doesn't do anything fancy, it completes the first step towards a new workbench.

=== Checkpoint ===
[[File:Eco - Hotbar With Modded Icon.png|thumb|Shows the medieval stall as a modded icon in-game.]]
This was a lot of setup and steps. Make sure everything is running smoothly by doing the following:

# Double-check that the <code>WikiDemo.unity3d</code> and the <code>WikiDemo.cs</code> files are in <code>/Eco Server/Mods/UserCode</code> folder.
# Start the server and connect to it.
# Test it out by typing <code>/give MedievalStall</code> in chat
## It's also possible to do <code>/give Market Stall</code> to get the item. How? Line 10: of the the above code declares that name as this item's "common name". Neat.
# The item should appear in the players inventory with a working icon.

This was the longest "leg" of this journey. All the setup is done and the infrastructure is in place. The following sections will just build on what was taught here.

Keep on, keeping on!

== Code the Item's Recipe ==
This section will be much simpler than the last. The following goes over how to add a new class and implement the <code>RecipeFamily</code> interface.<syntaxhighlight lang="c#" line="1">using Eco.Core.Items;
using Eco.Gameplay.Components;
using Eco.Gameplay.Items;
using Eco.Gameplay.Items.Recipes;
using Eco.Gameplay.Skills;
using Eco.Mods.TechTree;
using Eco.Shared.Localization;
using Eco.Shared.Serialization;
using System.Runtime.Versioning;
using System.Collections.Generic;

namespace WikiDemo
{
#region Item

#region Recipe
[RequiresSkill(typeof(CarpentrySkill), 3)]
[Ecopedia("Work Stations", "Craft Tables", subPageName: "Market Stall")]
public partial class MedievalStallRecipe : RecipeFamily
{
[SupportedOSPlatform("windows7.0")]
public MedievalStallRecipe()
{
var recipe = new Recipe();
recipe.Init(
name: "MedievalStallItem",
displayName: Localizer.DoStr("Market Stall"),
ingredients: new List<IngredientElement>
{
new IngredientElement("Wood", 40, typeof(Skill)),
new IngredientElement(typeof(CottonFabricItem), 30, typeof(Skill)),
new IngredientElement(typeof(HempMooringRopeItem), 5, true)
},
items: new List<CraftingElement>
{
new CraftingElement<MedievalStallItem>(1)
}
);
this.Recipes = new List<Recipe> { recipe };
this.LaborInCalories = CreateLaborInCaloriesValue(800, typeof(Skill));
this.CraftMinutes = CreateCraftTimeValue(typeof(MedievalStallRecipe), 10f, typeof(Skill));

// Perform pre/post initialization for user mods and initialize our recipe instance with the display name "Market Stall"
this.ModsPreInitialize();
this.Initialize(displayText: Localizer.DoStr("Market Stall"), recipeType: typeof(MedievalStallRecipe));
this.ModsPostInitialize();

// Register our RecipeFamily instance to a work table (in this case the Carpentry Table) so it can be crafted.
CraftingComponent.AddRecipe(tableType: typeof(CarpentryTableObject), recipeFamily: this); // NOTE: The table must be the object instance!
}

/// <summary>Hook for other mods to customize RecipeFamily before initialization.</summary>
partial void ModsPreInitialize();

/// <summary>Hook for other mods to customize RecipeFamily after initialization, but before registration. You can change skill requirements here.</summary>
partial void ModsPostInitialize();
}
#endregion
}</syntaxhighlight>'''Line 10:''' Eco will need this explicitly added to the file. Visual Studio will not add this line automatically. It's used for the <code>List<T></code> objects found in this code.

'''Line 14:''' "Collapsed" <code>Item</code> section. See the earlier sections in this guide for the code that belongs there.

'''Line 17:''' Sets the required skill and skill level to craft this recipe.

'''Line 21:''' <code>[SupportedOSPlatform("windows7.0")]</code> is here to silence some annoying warnings in Visual Studio. It's optional.

'''Line 30-32:''' Declares the input ingredients used for crafting. <code>typeof(Skill)</code> gets mapped to the <code>CarpentrySkill</code> as defined by line 31. In this example the <code>HempMooringRope</code> is a static input. A static input will not be modified by skills, upgrade modules, or game settings. '''Note:''' It seems that at the time of writing (4/21/2026, Eco v13.0.2) the only way to get an ingredient to be a dynamic value that is reduced by the table's upgrade is to pass <code>typeof(Skill)</code> to it; Passing either <code>true</code> or <code>false</code> makes the this input static.

'''Line 34:''' The <code>items</code> list declares what items are <u>output</u> by this recipe.

'''Line 36:''' This line declares that one medieval stall is output from this recipe. Functionally this links this recipe to the <code>MedievalStallItem</code> (aka "Market Stall") item created in the last step.

'''Line 40:''' Amount of calories needed to craft this item. For a static value (not modified by upgrades or skill levels) change this line to: <code>this.LaborInCalories = CreateLaborInCaloriesValue(800);</code>. As it's written in the example, this item's calorie cost will be dynamic (modified by upgrades and skill levels). The skill level that will modify it is declared on line 16.

'''Line 41:''' Minutes needed to craft. Both static and dynamic values for crafting time can be modified by the world difficulty settings. For a static value change this line to: <code>this.CraftMinutes = CreateCraftTimeValue(10f);</code>. As it's written in the example, this item's craft time will be dynamic.'''Line 49:''' This line assigns the recipe to a workbench. <u>Do not assign</u> to itself because then the first table could never be made. It's recommend to use a preexisting vanilla table.
=== Checkpoint ===
Check the functionality at this point -- it should be possible to see the recipe in the crafting table.

# Have the <code>.unity3d</code> and the <code>.cs</code> file in the <code>/Eco Server/Mods/UserCode</code> folder.
# Start the server and log in.
# Type <code>/give Carpentry Table</code>.
# Place the Carpentry Table down and interact to see the what can be crafted.
# Scroll and find the ''Market Stall'' recipe.
# Type <code>/give Basic Upgrade 4</code>.
# Put the basic upgrade into the table.
# Go back to the recipe for the ''Market Stall'' and make sure the Wood and the Cotton fabric inputs now require less, but the Hemp Mooring Rope still is the same. '''Note:''' In case the recipe hasn't changed close that table's window and interact with it again. It should for the recipes to refresh now that the upgrade is in it.

== Create the World Object ==
=== Preparing the 3D Asset ===

# Open <u>Blender</u>.
# Load the 3D object created earlier for icon rendering -- <code>Assets/WikiDemo/MedievalStall - Icon Scene.blend</code>.
# Cleanup the scene...
## Use the scene collection panel on the top-right side of the screen. Select and '''delete any light source'''. These will have a 💡 icon and by default are named something like "sun", "point", "spot" or "area". '''Note:''' If your model is a light source or has one in it, you can leave that light source. The point here is to remove the ambient lights used for icon rendering.
## In the scene collection panel, select and '''delete any camera(s)'''. These have a 🎥 icon and by default are named something like "camera".
# <u>If there are multiple different 3D assets in the scene</u> (like bags, crates, jars, ect.), join them all together...
## Select all of the meshes by holding ''Shift'' and clicking on each one in the ''Scene Collection'' panel (right side of window). '''Tip:''' Quickly select a group of them by selecting one near the top. Then hold ''Shift'', ''Ctrl,'' and click on one near the bottom. This will both the one at the top and the one at the bottom, but also every item in between. Neat!
## Be in ''Layout'' mode (top toolbar).
## Find and open the ''Object'' menu (second toolbar down from the top).
## Select ''Join''.
## In the ''Scene Collection'' panel, double click on the name of the newly joined mesh.
## Rename it to <code>MedievalStallMesh</code>.
# Add and position a reference cube...
## Make sure the editor is in ''Layout'' view (top toolbar).
## Then, add a reference cube. Open the ''Add'' menu (second top toolbar down).
## Hover ''Mesh''.
## Select ''Cube.''
## Find the ''Properties'' panel. It's just below the ''Scene Collection'' panel on the right side of the window.
## Now, still inside that panel but on the left side of it there's a column of icons.
## Hover them to see their names.
## Find the one that reads: ''Object'' ''Object Properties'' '''Tip:''' It kinda looks like an orange box
## Find and expand the ''Transform'' section
## Set ''Location X'' to ''1''.
## Just below that, set ''Y'' to ''1''.
## Just below that, again, set ''Z'' to ''1''.
## The bottom corner of the cube will be touching the green and red axis lines.
# Move the reference cube's origin to <code>(0, 0, 0)</code>...
## Be in ''Layout'' mode (top toolbar).
## Open the ''View'' menu (second toolbar down).
## Select ''Sidebar''.
## A new panel will have expanded.
## Along the right side of that panel there's buttons (''Item, Tool, View, Animation''). Find and click the ''View'' button.
## Find and expand the ''3D Cursor'' section.
## Under ''Location'' set ''X'' to ''0''.
## ''Y'' to 0.
## ''Z'' to 0.
## Now in the ''Scene Collection'' panel, select the ''Cube'' mesh.
## Open the ''Object'' menu from the second toolbar down from the top.
## Hover ''Set Origin''.
## Select ''Origin to 3D Cursor''.
# Set the reference cube's dimensions...
## Be in ''Layout'' mode, open the ''View'' menu (second toolbar down), and select and expand the ''Sidebar'' option''.''
## To the right of the sidebar, find and click the ''Item'' button.
## Expand the ''Transform'' section.
## Find the ''Dimensions,'' and set ''X'' to ''4''.
## ''Y'' to ''3''.
## ''Z'' to ''3''. '''Note:''' These dimensions only make sense for the asset being used for this guide. If using a different one, set the dimensions to the size of the box that model should fit in
# Adjust the position and scale to fit inside a box. This is important because it ensures that this object won't clip into other objects when placed.
## Be in ''Layout'' mode (top toolbar).
## Find the drop down in the second toolbar from the top that has options like ''Object Mode, Edit Mode, Sculpt Mode,'' etc.
## Select ''Object Mode'' from that drop down.
## On the left side of the screen there's a column of icons. Hover over them to see their names.
## Select the ''Move'' tool.
## Click on the Medieval Stall to select it. Zoom out and reposition the camera so that the blue, green, and red arrows are visible. '''Tip:''' By holding the middle-mouse button and dragging the scene will rotate. By holding the middle-mouse button and the ''Shift'' key, the scene will pan. '''Tip:''' If panning or rotating the scene becomes slow or frustrating (especially after zooming), try selecting 3D asset from the ''Scene Collection'' panel, opening the ''View'' menu (second toolbar from top), and selecting ''Frame Selected''. This will reset the view onto that object and controls should feel normal again.
## Click and hold one of the arrows. Move the mouse to drag the 3D asset towards the box.
## Move the 3D asset around till it's <u>completely inside the box</u>. If it cannot fit and is too big, continue to the next step. '''Tip:''' To select the 3D asset once it disappears, use the ''Scene Collection'' panel. Click on it there and the blue, green, and red arrows will show up again for it. '''Tip:''' There are preset views. To use them go to the ''View'' menu (second toolbar from top)'','' hover ''Viewpoint'', and select the view that would be most helpful.
## Find the ''Scale'' tool from the left side of the screen.
## Now the blue, green, and red "arrows" don't really look like arrows anymore. They are lines with boxes at the end.
## Click and hold on those lines to adjust the scale of the 3D asset to make it fit inside the box. '''Tip:''' There are little colored boxes in between the lines that can be dragged to scale the 3D asset more proportionally.
## Continue using the ''Move'' and ''Scale'' tools till the model fits. This will take patience and time. '''Tip:''' Hide the reference cube to see what is happening with the 3D asset. Go to the ''Scene Collections'' panel and click the 👁 button to hide it. Click that button again to show it.
# Now set the 3D asset's origin point... 
## Ensure that the 3D Cursor is still at <code>(0,0,0)</code>: Open the ''View'' menu (second toolbar down), select and expand the ''Sidebar'', click the ''View'' button (right side of the Sidebar), find and expand the ''3D cursor'' section, change the ''Location X, Y,'' and ''Z'' to ''0''.
## Select the 3D asset using the ''Scene Collection'' panel.
## Open the ''Object'' menu (second toolbar down).
## Hover ''Set Origin''.
## Select ''Origin to 3D Cursor''.
# Select the reference cube from the ''Scene Collections'' panel.
# Open ''Object'' menu (second toolbar down).
# Select ''Delete''.
# Open the ''Object'' menu.
# Hover ''Apply''.
# Select ''All Transformations''.
# Open the ''File'' menu from the top toolbar.
# Hover ''Export'' to open the sub-menu.
# Select ''FBX (.fbx)''
# A ''Blender File View'' window will pop-up.
# On the right side of this window there's a ⚙️ icon. Click it to expand the settings region.
# In the expanded region find the ''Include'' section and expand it. Change the following:
## Find ''Object Types'' and only select ''Mesh.'' No other option should be highlighted for this setting.
# In the settings region scroll and find the ''Transform'' section and expand it. Change the following:
## Find ''Apply Scalings'' and set it to ''FBX All''.
## Just below that find ''Forward'' and set it to ''-Z Forward''.
## Ensure that the next setting down, ''Up'', changed to ''Y Up''.
## Find ''Apply Unit'' and make sure it's checked.
## Next, find ''Use Space Transform'' check it.
## Lastly, find ''Apply Transform'' and check it too.
# Save it to <code>Assets/WikiDemo/MedievalStall.fbx</code>.
# Save the <code>.blend</code> file too and close Blender.

=== Add to Unity Scene ===

# Open <u>Unity</u>.
# Select the <code>.fbx</code> file in the project window.
# Open the ''Eco Tools'' menu from the top toolbar.
# Hover ''Mod Kit''.
# Select ''World Object Setup.''
# A ''World Object Setup'' window will pop-up.
# Make sure that ''Selected Objects'' reads ''MedievalStall.''
# Also make sure that ''World Object Type'' is set to ''World Object''.
# Press the ''Setup World Objects'' button.
# Notice in the project window that a new <code>.prefab</code> file was created -- <code>MedievalStallObject.prefab</code>
# Select the <code>.prefab</code> file in the project window.
# In the ''Inspector'' window (right side), scroll and find the ''World Object (Script)'' component.
# In that component, find the ''Override Occupancy'' checkbox and check it.
# A new field just appeared, ''Size''.
# Set the ''X'' to ''4''.
# ''Y'' to ''3''.
# ''Z'' to ''3.'' '''Note:''' These are the sizes used for the reference cube. If using different sizes make sure you <u>flip the Y and Z coordinates</u> when reading coordinates from Blender. Blender uses a different coordinate system that Unity!
# Select ''Objects'' from ''Hierarchy'' panel.
# Find the ''Modkit Prefab Container (Script)'' component.
# Expand the ''Prefabs'' section in that component.
# Click the ''+'' button to add an item to the list.
# Either...
## Click the ''⦿'' button, switch to the ''Assets'' tab, find or search for ''MedievalStallObject'', and double click on it. Make sure it's the medieval stall <u>object</u> with the <code>.prefab</code> ending.
## Drag the <code>.prefab</code> file onto the ''⦿'' button
#
# Open the ''File'' menu from top toolbar and select ''Save''. '''Note:''' Do not skip. The scene must be saved for the ModKit build to work properly.
# Open the ''Eco Tools'' menu from the top toolbar.
# Hover ''Mod Kit''.
# Select ''Build Current Bundle''.
# Save the bundle to <code>/Eco Server/Mods/UserCode/WikiDemo.unity3d</code>

'''TODO:''' Explain that if the orgin point isn't at the bottom-left corner of the model, then ''World Object (Script) > Occupancy Offset'' will need adjusted manually.

=== Scripting the World Object ===
Code that links the Item to this World Object.<syntaxhighlight lang="c#" line="1">
using Eco.Core.Items;
using Eco.Gameplay.Components;
using Eco.Gameplay.Items;
using Eco.Gameplay.Items.Recipes;
using Eco.Gameplay.Objects;
using Eco.Gameplay.Skills;
using Eco.Mods.TechTree;
using Eco.Shared.Localization;
using Eco.Shared.Serialization;
using System.Collections.Generic;
using System.Runtime.Versioning;
using System;

namespace WikiDemo
{
#region Item
[Serialized] // Tells the save/load system this object needs to be serialized.
[LocDisplayName("Market Stall")] // Defines the localized name of the item.
[Weight(100)] // Defines how heavy Arrow is.
[Ecopedia("Work Stations", "Craft Tables", createAsSubPage: true)]
[LocDescription("A medieval market stall.")] //The tooltip description for the item.
public partial class MedievalStallItem : WorldObjectItem<MedievalStallObject> { }
#endregion

#region Recipe

#region Object
[Serialized]
public partial class MedievalStallObject : WorldObject, IRepresentsItem
{
public Type RepresentedItemType => typeof(MedievalStallItem);
}
#endregion
}
</syntaxhighlight>'''Line 22:''' This changes from implementing <code>Item</code> to <code>WorldObjectItem<MedievalStallObject></code>. This is what gives the item the ability to place the table down in the world.

'''Line 25:''' The "collapsed" Recipe section. See earlier sections in this guide to see what code belongs here.

'''Line 29:''' Declares the <code>MedievalStallObject</code>. It's important that this class name is matches exactly the <code>.prefab</code> file name because the name is what links them.

'''Line 31:''' This line is similar in function to line 22, it's declaring that this <code>MedievalStallObject</code> is <code>MedievalStallItem</code> when in inventories.

=== Checkpoint ===
Export and see what it does. Ensure it's not lifting off the ground because of a non-curved shader.

==== Origin Point Editing ====
Talk about what it does: the point that the simulation considers this world object to be at.

Show how to move it around using blender.

== Final Export ==
Export.

Package.

Distribute.

From 3D Asset to Working Worktable

2026-04-21T19:20:52Z

WugWugg: Working on recipe code.

From 3D Asset to Working Worktable

2026-04-21T03:50:44Z

WugWugg:

From 3D Asset to Working Worktable

2026-04-21T01:39:18Z

WugWugg: Finished Creating the Item section

From 3D Asset to Working Worktable

2026-04-20T20:59:52Z

WugWugg:

From 3D Asset to Working Worktable

2026-04-20T20:58:14Z

WugWugg: WIP

Installing the ModKit

2026-04-20T20:21:31Z

WugWugg: Correcting project template style from URP 3D to 3D (Built-In Render Pipeline)

= What is ModKit =
ModKit is the freely available code and 3D assets used to modify Eco's game play.

With ModKit you can create new:

* '''World Objects*''' - Objects in the game server (e.g. workbenches)
* '''Items*''' - These are the icons for items and world objects.
* '''Block Sets*''' - The variations of a block's shape for building.
* '''Emoji Sets*''' - A collection of icon assets (PNG / sprite sheets).
* '''Plugins''' - These are code that changes how the server behaves (from adding a recipe to adding a new mechanic).

<nowiki>*</nowiki> Requires Unity

= Get ModKit =
[[File:Eco - Game Downloads - ModKit - Marked Up.png|thumb|The ''Game Downloads'' section where the ''ModKit'' download is. <u>4/20/2026</u>]]
# Go to https://play.eco/account and login (create your account, if necessary).
# Then on the account page find the ''Game Downloads'' section. Inside of that section there will be a button titled ''ModKit.''
## <u>If targeting the current release</u>, click on the only button that says ''ModKit'' near the top of that section.
## I<u>f targeting the staging (preview of next release) version</u>, click the ''More Downloads'' button in the top right. Then find the ''ModKit'' button in the bottom section. The button will be under a header that says "For advanced users that want to test the most recent, unstable version".
## <u>Unsure</u><u>?</u> Go with the current release version.
# Let it download.
# Unzip or Extract the ModKit archive.

= Installing ModKit =

== Installing Unity ==
[[File:Eco - Unity Installer - Engine Install Screen.png|thumb|Shows the Unity Hub's editor installation screen. <u>4/20/2026</u>]]

# Determine what version of Unity editor is needed. <u>As of 4/20/2026</u>, the Unity editor is <code>Unity 6.3</code>.
## Look for the <code>ProjectVersion.txt</code> file inside the ModKit folder.
## Find the line that looks like <code>m_EditorVersion: 0000.0.000</code>.
## Figure the matching Unity editor version.
### For <code>6000.3.6f1</code> that means install ''Unity 6.3.''
### If it was <code>2030.1.1de</code> then install ''Unity 2030.1'' (this version doesn't exist, just using it as an example).
## If the version has ''LTS'' in it, just ignore that. It just means Long Term Support and doesn't change that version's number. For example, if given <code>6000.3.6f1</code> then it is reasonable that both ''Unity 6.3'' and ''Unity 6.3 LTS'' will be compatible.
# Go to <code><nowiki>https://unity.com/</nowiki></code>.
# Download and install the ''Unity Hub''. '''Note:''' On first start Unity Hub will being downloading the most recent version of the Unity editor. View this by clicking on the download icon in the very top-right of the window (just left of the exit button on windows). If it is not downloading the version determined in step 1, cancel that download. Save some time and disk space this way.
# Install the correct version of Unity engine.
## On the left menu find ''Installs'' and navigate to that page.
## In the top right click the ''Install Editor'' button.
## A pop-up should appear where you can search, scroll, and find the version determined in step 1.

== The Unity Project ==
[[File:Eco - Unity Installer - Project Creation.png|thumb|''3D (Built-In Render Pipeline)'' project setup on Unity Hub. <u>4/20/2026</u>]]
ModKit is just a bundle of assets that is imported into a Unity project. If you already have a project you'd like to use the ModKit, open that project and skip to the ''Importing ModKit'' section below.

To create a new project, open Unity Hub and follow along:

# On the left menu find ''Projects'' and navigate to that page.
# In the top right click the ''+ New Project'' button.
# Here select the ''3D'' (''Built-In Render Pipeline)'' template. It may have to download the template first.
# <u>If you installed multiple versions of Unity</u>'','' double check the ''Editor version'' box here. Make sure the first four numbers and the numbers after the first dot (e.g.<code>6000.3</code>) match what is in the <code>ProjectVersion.txt</code> file.
# Name the project.
# Select where it will save to.
# Consider using a ''Source Control Provider''. Optional.
# Click ''+ Create project''.
# The Unity editor will setup this project. This process may take several minutes.

== Importing ModKit ==
'''Note:''' Importing ModKit into a pre-existing project will override some of the project's settings. Make a backup of your work proceeding!

Open the project you want to load ModKit into and follow along:
# From the top toolbar find and open the ''Assets'' drop down
# Hover the ''Import Package'' option to expand the sub-menu
# Select and click on ''Custom Package...'' A file browser should appear.
# Navigate to the ModKit folder.
# Select the <code>EcoModKit.unitypackage</code> file.
# Press ''Open''.
# A warning will pop-up.
## If this is a fresh new project'','' click ''Import.''
## If this is a project with stuff in it, make a backup copy before continuing. Continue by clicking ''Import''.
# A window will pop-up titled ''Import Unity Package''. It's listing all the changes being made.
# Click ''Next.''
# The window will now show any destructive changes it's going to make.
# Continue when ready by clicking ''Import.''
# The editor will import the ModKit assets. This process may take a few minutes.
# Install Text Mesh Pro features.
## From the top toolbar find and open the ''Window'' drop down.
## Hover ''TextMeshPro'' to expand the sub-menu.
## Select ''Import TextMeshPro Essential Resources''
## Review the import screen showing changes made.
## Click ''Import''.
<u>For older versions only</u> (<code>Unity 2019.#</code> and <code>Unity 2020.#</code>) of the Unity editor there are more steps:

# From the top toolbar find and open the ''Window'' drop down.
# Hover ''Package Management'' to open the sub-menu.
# Select ''Package Manager''.
# The ''Package Manager'' window should pop-up.
# In the top-left find and click the ''In Project'' tab.
# From it, select ''Unity Registry''.
# Select ''Collections'' from the list.
## In <code>Unity 2019.#</code>, if the ''Collections'' package is missing turn on ''Preview packages.'' To turn that feature on, find the ''Advanced'' drop down inside the ''Package Manager.'' From the ''Advanced'' drop down, check ''Show preview packages.''
## In <code>Unity 2020.#</code>, some packages are hidden entirely. Install these packages by clicking on the ''+'' (add) button in the ''Package Manager''. Select the ''Add packages from git URL'' option. Input <code>com.unity.collections</code> and click the ''Add'' button.
# Go down the list and click ''Install'' on all list items.

= Using ModKit =
[[File:Eco - Unity - ModKit - TemplateScene.png|thumb|ModKit ''Template Scene'' Asset. <u>4/20/2026</u>]]
In Unity's editor, ModKit assets can be found at <code>Assets/EcoModKit</code>.

Read the ''README'' files in <code>Assets/EcoModKit/README.md</code> and <code>Assets/EcoModKit/Docs/README.md</code>. The second one explains better what can be accomplished with ModKit.

See the ModKit tutorials on [[Mod Development]] page for guides on how to use ModKit and Unity to construct a mod.

== Exporting ==
Once finished with developing a mod's assets in Unity, it must be exported. ModKit provides a special script for this purpose. Open your Unity project and follow along to export:

# From the top toolbar find and open ''Eco Tools'' drop down.
# Hover ''Mod Kit'' and expand the sub-menu.
# Select ''Build Current Bundle.''
# A file explorer will pop-up.
## Select where to save the mod's assets.
## Give them a name.
# Unity will build the package. This may take several minutes.
# Once it finishes, that file ending in <code>.unity3d</code> is the asset you distribute and use in the Mods folder at <code>../Eco Server/Mods/UserCode</code>.

Happy Modding!
[[Category: Modding]]

Installing the ModKit

2026-04-20T19:03:38Z

WugWugg: Added export functionality description.

= What is ModKit =
ModKit is the freely available code and 3D assets used to modify Eco's game play.

With ModKit you can create new:

* '''World Objects*''' - Objects in the game server (e.g. workbenches)
* '''Items*''' - These are the icons for items and world objects.
* '''Block Sets*''' - The variations of a block's shape for building.
* '''Emoji Sets*''' - A collection of icon assets (PNG / sprite sheets).
* '''Plugins''' - These are code that changes how the server behaves (from adding a recipe to adding a new mechanic).

<nowiki>*</nowiki> Requires Unity

= Get ModKit =
[[File:Eco - Game Downloads - ModKit - Marked Up.png|thumb|The ''Game Downloads'' section where the ''ModKit'' download is. <u>4/20/2026</u>]]
# Go to https://play.eco/account and login (create your account, if necessary).
# Then on the account page find the ''Game Downloads'' section. Inside of that section there will be a button titled ''ModKit.''
## <u>If targeting the current release</u>, click on the only button that says ''ModKit'' near the top of that section.
## I<u>f targeting the staging (preview of next release) version</u>, click the ''More Downloads'' button in the top right. Then find the ''ModKit'' button in the bottom section. The button will be under a header that says "For advanced users that want to test the most recent, unstable version".
## <u>Unsure</u><u>?</u> Go with the current release version.
# Let it download.
# Unzip or Extract the ModKit archive.

= Installing ModKit =

== Installing Unity ==
[[File:Eco - Unity Installer - Engine Install Screen.png|thumb|Shows the Unity Hub's editor installation screen. <u>4/20/2026</u>]]

# Determine what version of Unity editor is needed. <u>As of 4/20/2026</u>, the Unity editor is <code>Unity 6.3</code>.
## Look for the <code>ProjectVersion.txt</code> file inside the ModKit folder.
## Find the line that looks like <code>m_EditorVersion: 0000.0.000</code>.
## Figure the matching Unity editor version.
### For <code>6000.3.6f1</code> that means install ''Unity 6.3.''
### If it was <code>2030.1.1de</code> then install ''Unity 2030.1'' (this version doesn't exist, just using it as an example).
## If the version has ''LTS'' in it, just ignore that. It just means Long Term Support and doesn't change that version's number. For example, if given <code>6000.3.6f1</code> then it is reasonable that both ''Unity 6.3'' and ''Unity 6.3 LTS'' will be compatible.
# Go to <code><nowiki>https://unity.com/</nowiki></code>.
# Download and install the ''Unity Hub''. '''Note:''' On first start Unity Hub will being downloading the most recent version of the Unity editor. View this by clicking on the download icon in the very top-right of the window (just left of the exit button on windows). If it is not downloading the version determined in step 1, cancel that download. Save some time and disk space this way.
# Install the correct version of Unity engine.
## On the left menu find ''Installs'' and navigate to that page.
## In the top right click the ''Install Editor'' button.
## A pop-up should appear where you can search, scroll, and find the version determined in step 1.

== The Unity Project ==
[[File:Eco - Unity Installer - Project Creation.png|thumb|''Universal 3D'' project setup on Unity Hub. <u>4/20/2026</u>]]
ModKit is just a bundle of assets that is imported into a Unity project. If you already have a project you'd like to use the ModKit, open that project and skip to the ''Importing ModKit'' section below.

To create a new project, open Unity Hub and follow along:

# On the left menu find ''Projects'' and navigate to that page.
# In the top right click the ''+ New Project'' button.
# Here select the ''Universal 3D'' template.
# <u>If you installed multiple versions of Unity</u>'','' double check the ''Editor version'' box here. Make sure the first four numbers and the numbers after the first dot (e.g.<code>6000.3</code>) match what is in the <code>ProjectVersion.txt</code> file.
# Name the project.
# Select where it will save to.
# Consider using a ''Source Control Provider''. Optional.
# Click ''+ Create project''.
# The Unity editor will setup this project. This process may take several minutes.

== Importing ModKit ==
'''Note:''' Importing ModKit into a pre-existing project will override some of the project's settings. Make a backup of your work proceeding!

Open the project you want to load ModKit into and follow along:
# From the top toolbar find and open the ''Assets'' drop down
# Hover the ''Import Package'' option to expand the sub-menu
# Select and click on ''Custom Package...'' A file browser should appear.
# Navigate to the ModKit folder.
# Select the <code>EcoModKit.unitypackage</code> file.
# Press ''Open''.
# A warning will pop-up.
## If this is a fresh new project'','' click ''Import.''
## If this is a project with stuff in it, make a backup copy before continuing. Continue by clicking ''Import''.
# A window will pop-up titled ''Import Unity Package''. It's listing all the changes being made.
# Click ''Next.''
# The window will now show any destructive changes it's going to make.
# Continue when ready by clicking ''Import.''
# The editor will import the ModKit assets. This process may take a few minutes.
# Install Text Mesh Pro features.
## From the top toolbar find and open the ''Window'' drop down.
## Hover ''TextMeshPro'' to expand the sub-menu.
## Select ''Import TextMeshPro Essential Resources''
## Review the import screen showing changes made.
## Click ''Import''.
<u>For older versions only</u> (<code>Unity 2019.#</code> and <code>Unity 2020.#</code>) of the Unity editor there are more steps:

# From the top toolbar find and open the ''Window'' drop down.
# Hover ''Package Management'' to open the sub-menu.
# Select ''Package Manager''.
# The ''Package Manager'' window should pop-up.
# In the top-left find and click the ''In Project'' tab.
# From it, select ''Unity Registry''.
# Select ''Collections'' from the list.
## In <code>Unity 2019.#</code>, if the ''Collections'' package is missing turn on ''Preview packages.'' To turn that feature on, find the ''Advanced'' drop down inside the ''Package Manager.'' From the ''Advanced'' drop down, check ''Show preview packages.''
## In <code>Unity 2020.#</code>, some packages are hidden entirely. Install these packages by clicking on the ''+'' (add) button in the ''Package Manager''. Select the ''Add packages from git URL'' option. Input <code>com.unity.collections</code> and click the ''Add'' button.
# Go down the list and click ''Install'' on all list items.

= Using ModKit =
[[File:Eco - Unity - ModKit - TemplateScene.png|thumb|ModKit ''Template Scene'' Asset. <u>4/20/2026</u>]]
In Unity's editor, ModKit assets can be found at <code>Assets/EcoModKit</code>.

Read the ''README'' files in <code>Assets/EcoModKit/README.md</code> and <code>Assets/EcoModKit/Docs/README.md</code>. The second one explains better what can be accomplished with ModKit.

See the ModKit tutorials on [[Mod Development]] page for guides on how to use ModKit and Unity to construct a mod.

== Exporting ==
Once finished with developing a mod's assets in Unity, it must be exported. ModKit provides a special script for this purpose. Open your Unity project and follow along to export:

# From the top toolbar find and open ''Eco Tools'' drop down.
# Hover ''Mod Kit'' and expand the sub-menu.
# Select ''Build Current Bundle.''
# A file explorer will pop-up.
## Select where to save the mod's assets.
## Give them a name.
# Unity will build the package. This may take several minutes.
# Once it finishes, that file ending in <code>.unity3d</code> is the asset you distribute and use in the Mods folder at <code>../Eco Server/Mods/UserCode</code>.

Happy Modding!
[[Category: Modding]]

Installing the ModKit

2026-04-20T18:44:41Z

WugWugg: Updating. Adding more detail, but mostly just spreading previous steps into step-by-step instructions.

= What is ModKit =
ModKit is the freely available code and 3D assets used to modify Eco's game play.

With ModKit you can create new:

* '''World Objects*''' - Objects in the game server (e.g. workbenches)
* '''Items*''' - These are the icons for items and world objects.
* '''Block Sets*''' - The variations of a block's shape for building.
* '''Emoji Sets*''' - A collection of icon assets (PNG / sprite sheets).
* '''Plugins''' - These are code that changes how the server behaves (from adding a recipe to adding a new mechanic).

<nowiki>*</nowiki> Requires Unity

= Get ModKit =
[[File:Eco - Game Downloads - ModKit - Marked Up.png|thumb|The ''Game Downloads'' section where the ''ModKit'' download is. <u>4/20/2026</u>]]
# Go to https://play.eco/account and login (create your account, if necessary).
# Then on the account page find the ''Game Downloads'' section. Inside of that section there will be a button titled ''ModKit.''
## <u>If targeting the current release</u>, click on the only button that says ''ModKit'' near the top of that section.
## I<u>f targeting the staging (preview of next release) version</u>, click the ''More Downloads'' button in the top right. Then find the ''ModKit'' button in the bottom section. The button will be under a header that says "For advanced users that want to test the most recent, unstable version".
## <u>Unsure</u><u>?</u> Go with the current release version.
# Let it download.
# Unzip or Extract the ModKit archive.

= Installing ModKit =

== Installing Unity ==
[[File:Eco - Unity Installer - Engine Install Screen.png|thumb|Shows the Unity Hub's editor installation screen. <u>4/20/2026</u>]]

# Determine what version of Unity editor is needed. <u>As of 4/20/2026</u>, the Unity editor is <code>Unity 6.3</code>.
## Look for the <code>ProjectVersion.txt</code> file inside the ModKit folder.
## Find the line that looks like <code>m_EditorVersion: 0000.0.000</code>.
## Figure the matching Unity editor version.
### For <code>6000.3.6f1</code> that means install ''Unity 6.3.''
### If it was <code>2030.1.1de</code> then install ''Unity 2030.1'' (this version doesn't exist, just using it as an example).
## If the version has ''LTS'' in it, just ignore that. It just means Long Term Support and doesn't change that version's number. For example, if given <code>6000.3.6f1</code> then it is reasonable that both ''Unity 6.3'' and ''Unity 6.3 LTS'' will be compatible.
# Go to <code><nowiki>https://unity.com/</nowiki></code>.
# Download and install the ''Unity Hub''. '''Note:''' On first start Unity Hub will being downloading the most recent version of the Unity editor. View this by clicking on the download icon in the very top-right of the window (just left of the exit button on windows). If it is not downloading the version determined in step 1, cancel that download. Save some time and disk space this way.
# Install the correct version of Unity engine.
## On the left menu find ''Installs'' and navigate to that page.
## In the top right click the ''Install Editor'' button.
## A pop-up should appear where you can search, scroll, and find the version determined in step 1.

== The Unity Project ==
[[File:Eco - Unity Installer - Project Creation.png|thumb|''Universal 3D'' project setup on Unity Hub. <u>4/20/2026</u>]]
ModKit is just a bundle of assets that is imported into a Unity project. If you already have a project you'd like to use the ModKit, open that project and skip to the ''Importing ModKit'' section below.

To create a new project, open Unity Hub and follow along:

# On the left menu find ''Projects'' and navigate to that page.
# In the top right click the ''+ New Project'' button.
# Here select the ''Universal 3D'' template.
# <u>If you installed multiple versions of Unity</u>'','' double check the ''Editor version'' box here. Make sure the first four numbers and the numbers after the first dot (e.g.<code>6000.3</code>) match what is in the <code>ProjectVersion.txt</code> file.
# Name the project.
# Select where it will save to.
# Consider using a ''Source Control Provider''. Optional.
# Click ''+ Create project''.
# The Unity editor will setup this project. This process may take several minutes.

== Importing ModKit ==
'''Note:''' Importing ModKit into a pre-existing project will override some of the project's settings. Make a backup of your work proceeding!

Open the project you want to load ModKit into and follow along:
# From the top toolbar find and open the ''Assets'' drop down
# Hover the ''Import Package'' option to expand the sub-menu
# Select and click on ''Custom Package...'' A file browser should appear.
# Navigate to the ModKit folder.
# Select the <code>EcoModKit.unitypackage</code> file.
# Press ''Open''.
# A warning will pop-up.
## If this is a fresh new project'','' click ''Import.''
## If this is a project with stuff in it, make a backup copy before continuing. Continue by clicking ''Import''.
# A window will pop-up titled ''Import Unity Package''. It's listing all the changes being made.
# Click ''Next.''
# The window will now show any destructive changes it's going to make.
# Continue when ready by clicking ''Import.''
# The editor will import the ModKit assets. This process may take a few minutes.
# Install Text Mesh Pro features.
## From the top toolbar find and open the ''Window'' drop down.
## Hover ''TextMeshPro'' to expand the sub-menu.
## Select ''Import TextMeshPro Essential Resources''
## Review the import screen showing changes made.
## Click ''Import''.
<u>For older versions only</u> (<code>Unity 2019.#</code> and <code>Unity 2020.#</code>) of the Unity editor there are more steps:

# From the top toolbar find and open the ''Window'' drop down.
# Hover ''Package Management'' to open the sub-menu.
# Select ''Package Manager''.
# The ''Package Manager'' window should pop-up.
# In the top-left find and click the ''In Project'' tab.
# From it, select ''Unity Registry''.
# Select ''Collections'' from the list.
## In <code>Unity 2019.#</code>, if the ''Collections'' package is missing turn on ''Preview packages.'' To turn that feature on, find the ''Advanced'' drop down inside the ''Package Manager.'' From the ''Advanced'' drop down, check ''Show preview packages.''
## In <code>Unity 2020.#</code>, some packages are hidden entirely. Install these packages by clicking on the ''+'' (add) button in the ''Package Manager''. Select the ''Add packages from git URL'' option. Input <code>com.unity.collections</code> and click the ''Add'' button.
# Go down the list and click ''Install'' on all list items.

= Using ModKit =
[[File:Eco - Unity - ModKit - TemplateScene.png|thumb|ModKit ''Template Scene'' Asset. <u>4/20/2026</u>]]
In Unity's editor, ModKit assets can be found at <code>Assets/EcoModKit</code>.

Read the ''README'' files in <code>Assets/EcoModKit/README.md</code> and <code>Assets/EcoModKit/Docs/README.md</code>. The second one explains better what can be accomplished with ModKit.

For more tutorials on using ModKit see the [[Mod Development]] page.

[[Category: Modding]]

Getting Started with Eco Modding in Visual Studio

2026-04-09T09:11:21Z

WugWugg: Updated project setup to mention .net10 now that it's LTS and ECO uses it

== Introduction ==

This guide covers how you could use Visual Studio 2022 as the development environment for your Eco mods — from creating your project to building, testing, and releasing a mod.

<u>This guide won’t teach you how to code or write a mod</u>, but it will help you get everything set up so you’re ready to start learning. There will be helpful resources for learning listed at the bottom of this guide.

=== Have Ready ===
* A copy of the Eco game installed
* A file explorer and the file-path to <code>Eco</code> folder
** <u>At the time of writing,</u> within this folder there's folders like <code>D3D12</code> and <code>Eco_Data</code>. Also, you'll find the <code>Eco.exe</code> file here. There are other files and folder here too, but this list is just to help you know what the folder looks like.

==== Note: Find Folder with Steam ====
'''Steam''' users can find the install folder by right-clicking on the game in your Steam Library:

[[File:Steam Library -- Browse Local Files.png|alt=Shows a Steam Library with a menu open over the Eco game. Highlighted in that menu is a "Manage" option, opening a sub-menu. The sub-menu has "Browse local files" highlighted.|frameless|border|upright=3|location=center|link=]]

== Installing Visual Studio 2022 ==
Visual Studio 2022 (VS2022) has a completely free to use version called the '''Community Edition'''. This guide is written assuming that's the version used.

Go to https://visualstudio.microsoft.com/downloads/#visual-studio-community-2022 and look for the "'''Visual Studio Community 2022'''" download. <u>At the time of writing,</u> the download button looked like:

[[File:VisualStudio2022 DownloadPage.png|alt=A picture of a website showing a row. The first column has the name "Visual Studio Community 2022" and there's a "Download" button two columns to the right, past it's description text.|frameless|location=center|link=|border|upright=4]]

Start the download by clicking on the Download button.

Then, run the installer till this the installer gets to the Workloads page. On this page, select these workloads:
* '''.NET desktop development''' -- Required for any mod development
* ASP.NET and web development -- Optional. If you want to interact with external websites or Eco's own web server (e.g. Discord's web-hooks or extending the API)
'''Note''': Using the Workflow installation page is easy, but will install a few extra things (e.g. GitHub Copilot). If you want '''to keep the tooling minimal''' you can just install .NET from <code>dotnet.microsoft.com/en-us/download</code>. <u>At the time of writing</u>, Eco supports '''.NET version 8.0'''. See the later section [https://wiki.play.eco/en/index.php?title=Getting_Started_with_Eco_Modding_in_Visual_Studio_2022&veaction=edit&section=7 .NET Version] of this guide to learn how to check if that has changed.

<u>At the time of writing,</u> this is what the Workloads page looks like with those options selected:

[[File:VisualStudioCommunity2022 Workloads.png|alt=Workloads screen during VS2022 installation. Options selected are "ASP.NET and web development" and ".NET desktop development". |frameless|location=center|upright=4|link=|border]]

Click the Install button. It will take a few minutes to complete installation. By default, it should launch VS2022 after it installs.

It will ask you to sign in. '''You do not need to''' and can completely avoid this by clicking the ''Skip and add accounts later'' option in tiny text below the buttons.

If you plan to upload your mod to Github, VS2022 does have integrated support for GitHub. So consider signing in with GitHub to make that process easier.

This guide is continuing as if the ''Skip and add accounts later'' option was selected. Finally, it might ask what color theme you'd like. Select your preference and continue.

Installation Complete!

== The Mod ==

With Eco and VS2022 are installed all of the tools needed to code, build, and run a mod are ready!

=== Creating a New Project ===

When VS2022 first opens it will show you a dashboard where you can quickly select what you want to do. On the left, are any recent projects opened. There won't be any if this is the first time installing it.

On the right there will be a few options, from here select the ''Create a new project'' option.

[[File:VS2022 OpeningDashboard.png|alt=VS2022's launch dashboard showing recent projects on the left and quick action buttons on the right. Highlighted is a button titled "Create a new project".|frameless|border|link=|location=center|upright=4]]

Now, it's time to go through the new project wizard. First, the wizard asks what kind of project is being made.

To mod Eco we need to make a '''C# Class Library'''.

To find the template, search <code>C# library</code> in the search bar. Select the C# option titled ''Class Library''.

It's important to '''pay attention to the icon and chips''' below the title and description. Make sure you '''select the <code>C#</code> option''' as there are other options similarly named ''Class Library''.

[[File:VS2022 NewProjectWizard Templates.png|frameless|border|location=center|upright=4|link=]]

The next page will ask you what the Project Name should be. Type the name of the mod being created.

The other options like the Location and the Solution Name do not need edited.

Leave the box ''Place solution and project in the same directory'' unchecked.

Click the Next button and continue along in the next section of this guide.

=== .NET Version ===
<u>As of April of 2026</u>, '''Eco targets .NET 10.0''' and the mod should too.

It's suggested to confirm the version of .NET that Eco uses by looking at the .NET version the reference assemblies use.

The reference assemblies can be found on the NuGet Gallery by searching for <code>Eco.ReferenceAssemblies</code>. See: <code>www.nuget.org/packages?q=Eco.ReferenceAssemblies</code>

Find the package with the name ''Eco.ReferenceAssemblies'' made by ''StrangeLoopGames''.

There will be a chip underneath of it with the ''.NET'' version it targets. <u>At the time of writing,</u> this is what that page looked like:

[[File:NuGetGallery -- Eco.ReferenceAssemblies Search.png|alt=Shows the search result of Eco.ReferenceAssemblies. In a blue chip the text ".NET 8.0" can be seen.|frameless|upright=4|location=center|link=|border]]

By clicking on that search result (shown above), a more detailed page opens is show. Again, there's chips showing what version of .NET to use:

[[File:NuGetGallery--Eco.ReferenceAssemblies Details.png|alt=Show the package page for "Eco.ReferenceAssemblies" on NuGet Gallery. Circled in red are two chips with some version of the text ".NET 8.0" inside them.|frameless|link=|border|location=center|upright=3]]

'''Back to VS2022'''

On the Additional Information page, there's the Framework drop-down. Select the same version of .NET Eco uses (as described above).

Click the Create button to finish creating the mod!

=== Linking to Eco Assemblies ===
Look for the Solution Explorer on the right-hand side of VS2022. It should look something like this:

'''Note''': If the solution explorer isn't there, open it from the top menu. Click the ''View'' button and select ''Solution Explorer'' from the menu.

[[File:VS2022 -- Solution Explorer.png|alt=A picture of a basic layout in Visual Studio 2022 with the Solution Explorer open on the right-hand side. The solution explorer is circled in red.|frameless|link=|upright=4|location=center|border]]

From the Solution Explorer, find the ''References'' line and right-click on it. On that menu select ''Manage NuGet packages...''

[[File:VS2022 Solution Explorer -- Manage NuGet Packages.png|alt=Shows VS2022's Solution Explorer with project expanded. The References line is highlighted and a menu is open. On that menu the "Manage NuGet Packages" line is highlighted.|frameless|link=|upright=4|location=center|border]]

This will open a new tab. Above the search bar there's sub-tabs. '''Select the ''Browse'' sub-tab.'''

Type <code>Eco.ReferenceAssemblies</code> into the search bar.

'''Check the ''Include prerelease'' check-box.'''

Find the option with the name ''Eco.ReferenceAssemblies'' made by ''StrangeLoopGames''. Click on it.

A details panel will show up to the right. It will show the version of the reference assemblies being targeted. By default it chooses the latest and can be left at it's default.

Click the Install button.

[[File:VS2022 -- NuGet Install Eco.ReferenceAssemblies.png|alt=VS2022 is open to the NuGet tab and is searching with the text Eco.ReferenceAssemblies. The checkbox to the right of the search is checked -- include prerelease. The only search result is selected. There is yellow highlights over part of the photo.|frameless|link=|upright=4|location=center|border]]

Click the ''Apply'' button on the popup to finish adding the references.

The reference assemblies have now been added! When coding VS2022 will provide IntelliSense popups. Try it out by going back to the <code>Class1.cs</code> file and typing <code>Eco.</code> and you will see suggestion pop up. It’s an essential tool for a lot of modders.

[[File:VS2022 -- Intellisense.png|alt=Shows a text editor with a basic class file. Inside there's the text "Eco." and a menu that show the suggested namespaces within.|frameless|link=|upright=4|location=center|border]]

=== Building The Dynamic Linked Library (DLL) ===

==== Building for Development ====
To build the mod makes the <code>.dll</code>that can be used to test with.

To build, open the ''Build'' menu from the top of VS2022.

Select ''Build Solution''. This will produce non-optimized DLL used for testing and development.

[[File:VS2022 -- Build Menu.png|alt=VS2022 top menu "Build" is open with "build solution" highlighted (ctrl + shift + b).|frameless|link=|upright=4|location=center|border]]

To find the file VS2022 just built, right click on the project in the Solution Explorer.

Select ''Open Folder in File Explorer.''

[[File:VS2022 -- Project Menu.png|alt=VS2022's solution explorer is shown with the projects right-click menu open. Highlighted is "Open folder in File Explorer"|frameless|link=|upright=4|location=center|border]]

From here, the mod's DLL will be in the <code>bin/Debug/net8.0/</code>folder. The file will be named with mod's name, like <code>TheMod.dll</code>.

Copy the mod's DLL file.

Paste it into the folder <code>Eco/Eco_Data/Server/Mods/</code>.

To run a game with that mod '''create a local world'''.

The mod should be running. Check the logs at <code>Eco/Eco_Data/Server/Logs/</code> to verify. Open the <u>most recent</u> log file here.

If the mod was loaded it there will be a line mentioning the file-name of the DLL. If the DLL was named <code>TheMod.dll</code> this is what to look for in the log file:<syntaxhighlight lang="text">[13:55:54.815] [4] [ Info] [Eco] Starting ModKitPlugin ...
[13:56:27.399] [4] [ Info] [Eco] Starting ModKitPlugin ... Finished in 32.584 sec

[13:56:27.439] [4] [ Info] [Eco] Loading mods ...
[13:56:27.439] [9] [ Info] [Eco] Loading TheMod...</syntaxhighlight>

===== Tip: Setup File Explorer to Sort By Date =====
It's suggested to setup the file view to ''Details'' in this folder because it will show the ''Date Modified'' for each file.

[[File:File Explorer -- View Settings Menu.png|alt=Show Window's File Explorer's view setting menu with the "details" option highlighted.|frameless|link=|upright=2|location=center|border]]

Additionally, clicking on the ''Date Modified'' header sorts all files. Sort it so the most recent is on top and every time the server starts the log file is easily found -- it's the one on top!

[[File:File Explorer -- Details Example.png|alt=Show's window's File Explorer with the date modified header highlighted.|frameless|link=|upright=2|location=center|border]]

==== Building for Release ====
To build for release, click on the mod's project in the Solution Explorer to highlight it.

[[File:VS2022 -- Solution Explorer Project Highlight.png|alt=Shows VS2022's solution explorer with the project highlighted.|frameless|link=|upright=2|location=center|border]]

Then, open the ''Build'' menu from the top of VS2022 and select ''Publish Selection''.

Set the target ''as Folder''. Click the ''Next'' button.

[[File:VS2022 -- Publish Wizard.png|alt=VS2022's publish wizard showing the target selection screen. The Folder option is highlighted.|frameless|link=|upright=2|location=center|border]]

Leave the folder location as default. Click the ''Finish'' button.

Click the ''Close'' button.

Finally, click the ''Publish'' button to start the build.

A green alert will pop up when the build is completed:

[[File:VS2022 -- Publish Screen.png|alt=Show's VS2022 publish screen. There's publish button at the top of this screen.|frameless|link=|upright=2|location=center|border]]

Either use the blue links on this page to find the file or browse the project's files as shown in "Building for Development".

Inside the project, the file will be in <code>bin/Release/net8.0/publish</code>. The file will be named with the mod project's name. For example, <code>TheMod.dll</code>.

Since the reference assemblies are already included in the game, do not worry about the other files here.

To share this mod, the only file needed is the mod's dll -- <code>TheMod.dll</code>.

=== Post Build Scripts: Automatic Copy ===
With a post build script VS2022 will automatically copy the files each build. It's a very nice feature to have when developing and rebuilding every 5 minutes to test something new.

First, add the variables about where <code>EcoServer.exe</code> is located to the project file.

Right-click on the project in the Solution Explorer and select the ''Edit Project File'' option.

Add the properties <code>EcoServerExe</code> and <code>EcoServerDir</code> <u>inside of the <code>PropertyGroup</code> tag.</u>

>>> Tip: By holding shift and right-clicking on a file in the file explorer a old-school menu pops up. Midway down this menu is an option to ''Copy As Path''. Neat!

The project file should look something like this:
<syntaxhighlight lang="xml"><Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<TargetFramework>net8.0</TargetFramework>
<ImplicitUsings>enable</ImplicitUsings>
<Nullable>enable</Nullable>

<EcoServerExe>$(EcoServerDir)\EcoServer.exe</EcoServerExe>
<EcoServerDir>C:\Program Files (x86)\Steam\steamapps\common\Eco\Eco_Data\Server</EcoServerDir>

</PropertyGroup>

<ItemGroup>
<PackageReference Include="Eco.ReferenceAssemblies" Version="0.11.1.13-beta-release-887" />
</ItemGroup>

</Project></syntaxhighlight>

Next, add the <code>PostBuild</code> property inside the <code>Project</code> tag.<syntaxhighlight lang="xml">
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
... SNIP ...
</PropertyGroup>

<ItemGroup>
... SNIP ...
</ItemGroup>

<Target Name="PostBuild" AfterTargets="PostBuildEvent">
<Exec Command='call PostBuild.bat "$(EcoServerDir)" "$(OutDir)" "$(MSBuildProjectName)"'/>
</Target>
</Project>
</syntaxhighlight>

Finally create a new file directly inside the project by right-clicking on the project in the Solution Explorer. Select the ''Add'' and click on ''New Item...'' from the sub-menu.

Use the name <code>PostBuild.bat</code> for this new file.

Open it and put the following in the PostBuild file:
<syntaxhighlight lang="batch">REM reading in arguements to sensible variables
set serverDir=%1
set outDir=%2
set projName=%3

REM removing double-quotes added to variables for concatenation
set serverDir=%serverDir:"=%
set outDir=%outDir:"=%
set projName=%projName:"=%

REM Copy mod dll to Mods dir
set dllFile=%outDir%%projName%.dll
echo Copying mod dll file: %dllFile%
copy "%dllFile%" "%serverDir%\Mods"

REM Copy mod pdb to directory where EcoServer.exe is
set pdbFile=%outDir%%projName%.pdb
echo Copying mod pdb file: %pdbFile%
copy "%pdbFile%" "%serverDir%"</syntaxhighlight>Now try running a rebuild of the project. The output should report copying files and inside the <code>Eco/Eco_Data/Server/Mods</code> folder should be <code>TheMod.dll</code> file

=== Setting up Debugging ===
'''Special thanks to Monzun#0606 on Eco's Discord for helping developing research the following information.'''
To setup debugging, <u>make sure that the project is setup with the post build script described above</u>.

Debugging is a <u>powerful</u> tool to a developer and allows the developer to set breakpoints anywhere in the code to stop execution. When execution is stopped the developer can review every variable's value and incrementally continue the code. This is invaluable when tracking down bugs or trying to understand a complex piece of code.

From the top menu, select ''Debug'' and click on the option ''TheMod Debug Properties'' at the bottom of the menu.

[[File:VS2022 -- Debug Menu.png|alt=VS2022's debug menu is open from the top of the application. Highlighted is the last option "Debug Properties".|frameless|link=|upright=2|location=center|border]]

Find the ''Create a new profile'' button '''in the top-left''' of this new window. Select ''Executable'' from the drop-down menu.

[[File:VS2022 -- Debugger Launch Profiles.png|alt=VS2022's launch profile window is open. Underlined and pointed to by a red mark is the "Create a new profile" button, located in the top-left of the window. Highlighted from the menu under it is the option reading "Executable".|frameless|link=|upright=2|location=center|border]]

Set the ''Executable'' field to the full path to the <code>EcoServer.exe</code> file. For example, <code>C:\Program Files (x86)\Steam\steamapps\common\Eco\Eco_Data\Server</code><code>\EcoServer.exe</code>.

Set the ''Working Directory'' field to the full path to the folder containing the <code>EcoServer.exe</code> file. For example, <code>C:\Program Files (x86)\Steam\steamapps\common\Eco\Eco_Data\Server</code>.

[[File:VS2022 -- Eco Debugging Profile.png|alt=A fully configured profile ready to debug Eco on VS2022's launch profile page.|frameless|link=|upright=2|location=center|border]]

To use this newly configured profile, switch to it by clicking the small arrow to the right of the play icon (see image). Select the newly created profile -- ''Profile 1''.

[[File:VS2022 -- Debugger Profile Selection.png|alt=VS2022's debugger profile selection menu is open with the newly created "Profile 1" highlighted.|frameless|link=|upright=2|location=center|border]]

To see how breakpoints work, put the following in <code>Class1.cs</code> file:<syntaxhighlight lang="c#">
using Eco.Core.Plugins.Interfaces;
using Eco.Core.Utils;
using Eco.ModKit;

namespace Test
{
public class Class1 : IModKitPlugin, IInitializablePlugin
{
public string GetCategory() => "Tutorial";

public string GetStatus() => this._status;
string _status = string.Empty;

public void Initialize(TimedTask timer)
{
this._status = "Ok";
bool yes = true;
return;
}
}
}

</syntaxhighlight>This code creates a basic plugin, called <code>Class1</code>, that Eco will load and initialize on startup. Eco knows to do this because this class inherits the <code>IModKitPlugin</code> interface (causes it to be loaded) and the <code>IInitializablePlugin</code> interface (causes it to be initialized).

Add a breakpoint to the code by right-clicking on the line <code>bool yes = true;</code>.

[[File:VS2022 -- Adding a breakpoint.png|alt=A boilerplate example of a mod is shown in the VS2022 text editor. A line has a menu open above it with the option "Breakpoint" expanded and the option "Insert Breakpoint" highlighted on the sub-menu.|frameless|link=|upright=2|location=center|border]]

Now hit the play button. The server will start and VS2022 will flash back on screen once Eco tries to initialize the mod's plugin.

[[File:VS2022 -- Launch Debugger.png|alt=Highlighted is the play button for VS2022's debugger. The "Profile 1" is still selected from before.|frameless|link=|upright=2|location=center|border]]

After a little bit the server will start-up and hit the breakpoint set. When it does VS2022 will keep startup from continuing and allow detailed inspection to happen.

In the bottom left (circled in red) is a table of all of the variables within scope. Use this to see what is happening (especially useful in loops!).

At the middle-top (circled in red) are some of the debugger controls. Clicking the highlighted ''Continue'' button resumes normal operation. Using the buttons to the right that are highlighted will allow the developer to step through the codes execution to see exactly how each line is performing. Debugging is a deep and rich topic that this guide will not explain further, but there's a great video by Microsoft Visual Studio on YouTube called Basics of Debugging. In that 45 minute video (don't worry there's annotations to jump to just what is interesting) a whole gamut of information about how to use debugging is covered.

[[File:VS2022 -- Debugger LIve.png|alt=Shows a simple plugin's code in the editor of VS2022. In the bottom-left is a table of all variables used in the function. It is circled in red. On the top of the image also circled in red is the debugger controls. Highlighted within is the continue button and the "step over" button.|frameless|link=|upright=2|location=center|border]]

== Releasing a Mod ==

=== Mod.io ===
<u>At the time of writing</u>, mod.io is where creators share their mods with players and others.

To share a new mod here all that is necessary is an account.

Head over to <code>mod.io/g/eco</code> and click ''Login'' in the top-right corner.

Finish signing-up with whatever account type you prefer.

Click the ''Add Mod'' button in the top-right.

Follow the upload wizard as directed.

Once on the ''File Manager'' section, a zip file is needed.

Zip the mod's <u>release</u> dll and any other assets necessary (e.g. Unity bundles) by putting all the files into a folder. Then right-click on that folder and select ''Compress To...'' and from the sub-menu select ''ZIP file''.

Upload that zip file. Considering naming it with a version number to help stay organized (e.g. ''v1''). Next release, increase that number by 1 (e.g. ''v2'')

Congratulations on releasing the mod!

=== Discord Ads ===
Consider posting a entry on the official {{EcoDiscord}}. There's a channel for mods called ''mod-ads''.
Please read the rules before posting.

== Where to Next? ==

* Where to learn modding logic (Eco Modding Wiki, Discord, sample mods)
**[[Helpful Examples for Modding]]
* Consider learning source control (Git). Completely optional, but can help you keep things organized as development continues.
* Explore Eco’s open-source mod projects for ideas (search on GitHub "Eco Mods" to find some real-life examples)

Module:IconUtils

2026-02-24T14:52:45Z

WugWugg: Despite the last commit working on Template:Icon page it does not work for item pages. Full revert to stable.

local p = {}

function p.main(param)
local Utils = require('Module:Utils')

local Icon = ''
local IconStyle = ''
local IconSize = ''
local IconLink = ''
local IconBorder = ''
local IconCount = ''

local args = Utils.normalise(param)

if args.id == nil or args.name == '' then return 'Module:IconUtils \'id\' must be specified.' end

local Icon = args.id .. '_Icon.png'

if args.size == nil or args.size == '' then IconSize = 28 else IconSize = args.size end
if args.style == nil or args.style == '' then IconStyle = '1' else IconStyle = args.style end
if args.link == nil or args.link == '' then IconLink = '' else IconLink = '[[' .. args.link .. ']]' end
if args.link == '1' then IconLink = '[[' .. args.name .. ']]' end
if IconLink == '' then IconTextLine = ' ' .. args.name IconTextBr = '<br>' .. args.name else IconTextLine = ' ' .. IconLink IconTextBr = '<br>' .. IconLink end
if args.count == nil or args.count == '' then IconCount = '1' else IconCount = args.count end
if args.border == nil or args.border == '' then IconBorder = ' borderwhite' else IconBorder = ' border' .. args.border end

if IconStyle == '1' then return '[[file:'.. Icon ..'|'.. IconSize ..'px|link='.. IconLink ..']]' end
if IconStyle == '2' then return '[[file:'.. Icon ..'|'.. IconSize ..'px|link='.. IconLink ..']]' .. IconTextLine end
if IconStyle == '3' then return '[[file:'.. Icon ..'|'.. IconSize ..'px|link='.. IconLink ..']]' .. IconTextBr end
if IconStyle == '4' then return '<div class="IconFrame">[[file:'.. Icon ..'|'.. IconSize ..'px|link='.. IconLink ..']]' .. IconTextBr .. '</div>' end
if IconStyle == '5' then return '<div class="recipeitem withcount' .. IconBorder .. '" style="font-size:' .. IconSize .. 'px">' .. '<div class="recipeitemicon">[[file:'.. Icon ..'|'.. IconSize ..'px|link=]]</div><span class="recipeitemcount">' .. IconCount .. '</span>' .. '[[' .. args.link .. '|<div class="recipeitemlink" title="' .. args.link .. '"></div>]]</div>' end
if IconStyle == '6' then return '<div class="recipeitem' .. IconBorder .. '" style="font-size:' .. IconSize .. 'px">' .. '<div class="recipeitemicon">[[file:'.. Icon ..'|'.. IconSize ..'px|link=]]</div>[[' .. args.link .. '|<div class="recipeitemlink" title="' .. args.link .. '"></div>]]</div>' end
end

return p

Module:IconUtils

2026-02-24T14:35:05Z

WugWugg: Adding comment to note weird behavior

local p = {}

function p.main(param)
local Utils = require('Module:Utils')

local Icon = ''
local IconStyle = ''
local IconSize = ''
local IconLink = ''
local IconBorder = ''
local IconCount = ''

local args = Utils.normalise(param)

if args.id == nil or args.name == '' then return 'Module:IconUtils \'id\' must be specified.' end

local Icon = args.id .. '_Icon.png'

if args.size == nil or args.size == '' then IconSize = 28 else IconSize = args.size end
if args.style == nil or args.style == '' then IconStyle = '1' else IconStyle = args.style end
if args.link == nil or args.link == '' then IconLink = '' else IconLink = '[[' .. args.link .. ']]' end
if args.link == '1' then
-- It is important to use <span> here instead of <div>. This ensures the Wiki doesn't strip it because it's an empty tag.
if args.style == '5' then IconLink = '[[' .. args.name ..'|<span class="recipeitemlink" title="' .. args.name .. '"></span>]]'
else IconLink = '[[' .. args.name .. ']]' end
end
if IconLink == '' then IconTextLine = ' ' .. args.name IconTextBr = '<br>' .. args.name else IconTextLine = ' ' .. IconLink IconTextBr = '<br>' .. IconLink end
if args.count == nil or args.count == '' then IconCount = '1' else IconCount = args.count end
if args.border == nil or args.border == '' then IconBorder = ' borderwhite' else IconBorder = ' border' .. args.border end

if IconStyle == '1' then return '[[file:'.. Icon ..'|'.. IconSize ..'px|link='.. IconLink ..']]' end
if IconStyle == '2' then return '[[file:'.. Icon ..'|'.. IconSize ..'px|link='.. IconLink ..']]' .. IconTextLine end
if IconStyle == '3' then return '[[file:'.. Icon ..'|'.. IconSize ..'px|link='.. IconLink ..']]' .. IconTextBr end
if IconStyle == '4' then return '<div class="IconFrame">[[file:'.. Icon ..'|'.. IconSize ..'px|link='.. IconLink ..']]' .. IconTextBr .. '</div>' end
if IconStyle == '5' then return '<div class="recipeitem withcount' .. IconBorder .. '" style="font-size:' .. IconSize .. 'px">' .. '<div class="recipeitemicon">[[file:'.. Icon ..'|'.. IconSize ..'px|link=]]</div><span class="recipeitemcount">' .. IconCount .. '</span> ' .. IconLink ..'</div>' end
end

return p

Module:IconUtils

2026-02-24T14:26:27Z

WugWugg: Minor Nit: Swapping to using span here for inline display type.

local p = {}

function p.main(param)
local Utils = require('Module:Utils')

local Icon = ''
local IconStyle = ''
local IconSize = ''
local IconLink = ''
local IconBorder = ''
local IconCount = ''

local args = Utils.normalise(param)

if args.id == nil or args.name == '' then return 'Module:IconUtils \'id\' must be specified.' end

local Icon = args.id .. '_Icon.png'

if args.size == nil or args.size == '' then IconSize = 28 else IconSize = args.size end
if args.style == nil or args.style == '' then IconStyle = '1' else IconStyle = args.style end
if args.link == nil or args.link == '' then IconLink = '' else IconLink = '[[' .. args.link .. ']]' end
if args.link == '1' then
if args.style == '5' then IconLink = '[[' .. args.name ..'|<span class="recipeitemlink" title="' .. args.name .. '"></span>]]'
else IconLink = '[[' .. args.name .. ']]' end
end
if IconLink == '' then IconTextLine = ' ' .. args.name IconTextBr = '<br>' .. args.name else IconTextLine = ' ' .. IconLink IconTextBr = '<br>' .. IconLink end
if args.count == nil or args.count == '' then IconCount = '1' else IconCount = args.count end
if args.border == nil or args.border == '' then IconBorder = ' borderwhite' else IconBorder = ' border' .. args.border end

if IconStyle == '1' then return '[[file:'.. Icon ..'|'.. IconSize ..'px|link='.. IconLink ..']]' end
if IconStyle == '2' then return '[[file:'.. Icon ..'|'.. IconSize ..'px|link='.. IconLink ..']]' .. IconTextLine end
if IconStyle == '3' then return '[[file:'.. Icon ..'|'.. IconSize ..'px|link='.. IconLink ..']]' .. IconTextBr end
if IconStyle == '4' then return '<div class="IconFrame">[[file:'.. Icon ..'|'.. IconSize ..'px|link='.. IconLink ..']]' .. IconTextBr .. '</div>' end
if IconStyle == '5' then return '<div class="recipeitem withcount' .. IconBorder .. '" style="font-size:' .. IconSize .. 'px">' .. '<div class="recipeitemicon">[[file:'.. Icon ..'|'.. IconSize ..'px|link=]]</div><span class="recipeitemcount">' .. IconCount .. '</span> ' .. IconLink ..'</div>' end
if IconStyle == '6' then return '<div class="recipeitem' .. IconBorder .. '" style="font-size:' .. IconSize .. 'px">' .. '<div class="recipeitemicon">[[file:'.. Icon ..'|'.. IconSize ..'px|link=]]</div>[[' .. args.link .. '|<div class="recipeitemlink" title="' .. args.link .. '"></div>]]</div>' end
end

return p

Module:IconUtils

2026-02-24T14:16:58Z

WugWugg: Bug Fix: Link not working? Removing unnecessary spaces

local p = {}

function p.main(param)
local Utils = require('Module:Utils')

local Icon = ''
local IconStyle = ''
local IconSize = ''
local IconLink = ''
local IconBorder = ''
local IconCount = ''

local args = Utils.normalise(param)

if args.id == nil or args.name == '' then return 'Module:IconUtils \'id\' must be specified.' end

local Icon = args.id .. '_Icon.png'

if args.size == nil or args.size == '' then IconSize = 28 else IconSize = args.size end
if args.style == nil or args.style == '' then IconStyle = '1' else IconStyle = args.style end
if args.link == nil or args.link == '' then IconLink = '' else IconLink = '[[' .. args.link .. ']]' end
if args.link == '1' then
if args.style == '5' then IconLink = '[[' .. args.name ..'|<div class="recipeitemlink" title="' .. args.name .. '"></div>]]'
else IconLink = '[[' .. args.name .. ']]' end
end
if IconLink == '' then IconTextLine = ' ' .. args.name IconTextBr = '<br>' .. args.name else IconTextLine = ' ' .. IconLink IconTextBr = '<br>' .. IconLink end
if args.count == nil or args.count == '' then IconCount = '1' else IconCount = args.count end
if args.border == nil or args.border == '' then IconBorder = ' borderwhite' else IconBorder = ' border' .. args.border end

if IconStyle == '1' then return '[[file:'.. Icon ..'|'.. IconSize ..'px|link='.. IconLink ..']]' end
if IconStyle == '2' then return '[[file:'.. Icon ..'|'.. IconSize ..'px|link='.. IconLink ..']]' .. IconTextLine end
if IconStyle == '3' then return '[[file:'.. Icon ..'|'.. IconSize ..'px|link='.. IconLink ..']]' .. IconTextBr end
if IconStyle == '4' then return '<div class="IconFrame">[[file:'.. Icon ..'|'.. IconSize ..'px|link='.. IconLink ..']]' .. IconTextBr .. '</div>' end
if IconStyle == '5' then return '<div class="recipeitem withcount' .. IconBorder .. '" style="font-size:' .. IconSize .. 'px">' .. '<div class="recipeitemicon">[[file:'.. Icon ..'|'.. IconSize ..'px|link=]]</div><span class="recipeitemcount">' .. IconCount .. '</span> ' .. IconLink ..'</div>' end
if IconStyle == '6' then return '<div class="recipeitem' .. IconBorder .. '" style="font-size:' .. IconSize .. 'px">' .. '<div class="recipeitemicon">[[file:'.. Icon ..'|'.. IconSize ..'px|link=]]</div>[[' .. args.link .. '|<div class="recipeitemlink" title="' .. args.link .. '"></div>]]</div>' end
end

return p

Module:IconUtils

2026-02-24T14:14:58Z

WugWugg: Bug Fix: Adding back the link (accidentally removed during the confusion)

local p = {}

function p.main(param)
local Utils = require('Module:Utils')

local Icon = ''
local IconStyle = ''
local IconSize = ''
local IconLink = ''
local IconBorder = ''
local IconCount = ''

local args = Utils.normalise(param)

if args.id == nil or args.name == '' then return 'Module:IconUtils \'id\' must be specified.' end

local Icon = args.id .. '_Icon.png'

if args.size == nil or args.size == '' then IconSize = 28 else IconSize = args.size end
if args.style == nil or args.style == '' then IconStyle = '1' else IconStyle = args.style end
if args.link == nil or args.link == '' then IconLink = '' else IconLink = '[[' .. args.link .. ']]' end
if args.link == '1' then
if args.style == '5' then IconLink = '[[' .. args.name ..'| <div class="recipeitemlink" title="' .. args.name .. '"></div> ]]'
else IconLink = '[[' .. args.name .. ']]' end
end
if IconLink == '' then IconTextLine = ' ' .. args.name IconTextBr = '<br>' .. args.name else IconTextLine = ' ' .. IconLink IconTextBr = '<br>' .. IconLink end
if args.count == nil or args.count == '' then IconCount = '1' else IconCount = args.count end
if args.border == nil or args.border == '' then IconBorder = ' borderwhite' else IconBorder = ' border' .. args.border end

if IconStyle == '1' then return '[[file:'.. Icon ..'|'.. IconSize ..'px|link='.. IconLink ..']]' end
if IconStyle == '2' then return '[[file:'.. Icon ..'|'.. IconSize ..'px|link='.. IconLink ..']]' .. IconTextLine end
if IconStyle == '3' then return '[[file:'.. Icon ..'|'.. IconSize ..'px|link='.. IconLink ..']]' .. IconTextBr end
if IconStyle == '4' then return '<div class="IconFrame">[[file:'.. Icon ..'|'.. IconSize ..'px|link='.. IconLink ..']]' .. IconTextBr .. '</div>' end
if IconStyle == '5' then return '<div class="recipeitem withcount' .. IconBorder .. '" style="font-size:' .. IconSize .. 'px">' .. '<div class="recipeitemicon">[[file:'.. Icon ..'|'.. IconSize ..'px|link=]]</div><span class="recipeitemcount">' .. IconCount .. '</span> ' .. IconLink ..'</div>' end
if IconStyle == '6' then return '<div class="recipeitem' .. IconBorder .. '" style="font-size:' .. IconSize .. 'px">' .. '<div class="recipeitemicon">[[file:'.. Icon ..'|'.. IconSize ..'px|link=]]</div>[[' .. args.link .. '|<div class="recipeitemlink" title="' .. args.link .. '"></div>]]</div>' end
end

return p

Module:IconUtils

2026-02-24T14:12:27Z

WugWugg: Bug Fix: IconStyle not being equal to 5? Changing to match on args.style

local p = {}

function p.main(param)
local Utils = require('Module:Utils')

local Icon = ''
local IconStyle = ''
local IconSize = ''
local IconLink = ''
local IconBorder = ''
local IconCount = ''

local args = Utils.normalise(param)

if args.id == nil or args.name == '' then return 'Module:IconUtils \'id\' must be specified.' end

local Icon = args.id .. '_Icon.png'

if args.size == nil or args.size == '' then IconSize = 28 else IconSize = args.size end
if args.style == nil or args.style == '' then IconStyle = '1' else IconStyle = args.style end
if args.link == nil or args.link == '' then IconLink = '' else IconLink = '[[' .. args.link .. ']]' end
if args.link == '1' then
if args.style == '5' then IconLink = '<div class="recipeitemlink" title="' .. args.name .. '"></div>'
else IconLink = '[[' .. args.name .. ']]' end
end
if IconLink == '' then IconTextLine = ' ' .. args.name IconTextBr = '<br>' .. args.name else IconTextLine = ' ' .. IconLink IconTextBr = '<br>' .. IconLink end
if args.count == nil or args.count == '' then IconCount = '1' else IconCount = args.count end
if args.border == nil or args.border == '' then IconBorder = ' borderwhite' else IconBorder = ' border' .. args.border end

if IconStyle == '1' then return '[[file:'.. Icon ..'|'.. IconSize ..'px|link='.. IconLink ..']]' end
if IconStyle == '2' then return '[[file:'.. Icon ..'|'.. IconSize ..'px|link='.. IconLink ..']]' .. IconTextLine end
if IconStyle == '3' then return '[[file:'.. Icon ..'|'.. IconSize ..'px|link='.. IconLink ..']]' .. IconTextBr end
if IconStyle == '4' then return '<div class="IconFrame">[[file:'.. Icon ..'|'.. IconSize ..'px|link='.. IconLink ..']]' .. IconTextBr .. '</div>' end
if IconStyle == '5' then return '<div class="recipeitem withcount' .. IconBorder .. '" style="font-size:' .. IconSize .. 'px">' .. '<div class="recipeitemicon">[[file:'.. Icon ..'|'.. IconSize ..'px|link=]]</div><span class="recipeitemcount">' .. IconCount .. '</span> ' .. IconLink ..'</div>' end
if IconStyle == '6' then return '<div class="recipeitem' .. IconBorder .. '" style="font-size:' .. IconSize .. 'px">' .. '<div class="recipeitemicon">[[file:'.. Icon ..'|'.. IconSize ..'px|link=]]</div>[[' .. args.link .. '|<div class="recipeitemlink" title="' .. args.link .. '"></div>]]</div>' end
end

return p

Module:IconUtils

2026-02-24T14:09:16Z

WugWugg: Bug Fix: IconStyle was matching on a numeral not a string causing style 5 and link 1 logic to not apply.

local p = {}

function p.main(param)
local Utils = require('Module:Utils')

local Icon = ''
local IconStyle = ''
local IconSize = ''
local IconLink = ''
local IconBorder = ''
local IconCount = ''

local args = Utils.normalise(param)

if args.id == nil or args.name == '' then return 'Module:IconUtils \'id\' must be specified.' end

local Icon = args.id .. '_Icon.png'

if args.size == nil or args.size == '' then IconSize = 28 else IconSize = args.size end
if args.style == nil or args.style == '' then IconStyle = '1' else IconStyle = args.style end
if args.link == nil or args.link == '' then IconLink = '' else IconLink = '[[' .. args.link .. ']]' end
if args.link == '1' then
if IconStyle == '5' then IconLink = '<div class="recipeitemlink" title="' .. args.name .. '"></div>'
else IconLink = '[[' .. args.name .. ']]' end
end
if IconLink == '' then IconTextLine = ' ' .. args.name IconTextBr = '<br>' .. args.name else IconTextLine = ' ' .. IconLink IconTextBr = '<br>' .. IconLink end
if args.count == nil or args.count == '' then IconCount = '1' else IconCount = args.count end
if args.border == nil or args.border == '' then IconBorder = ' borderwhite' else IconBorder = ' border' .. args.border end

if IconStyle == '1' then return '[[file:'.. Icon ..'|'.. IconSize ..'px|link='.. IconLink ..']]' end
if IconStyle == '2' then return '[[file:'.. Icon ..'|'.. IconSize ..'px|link='.. IconLink ..']]' .. IconTextLine end
if IconStyle == '3' then return '[[file:'.. Icon ..'|'.. IconSize ..'px|link='.. IconLink ..']]' .. IconTextBr end
if IconStyle == '4' then return '<div class="IconFrame">[[file:'.. Icon ..'|'.. IconSize ..'px|link='.. IconLink ..']]' .. IconTextBr .. '</div>' end
if IconStyle == '5' then return '<div class="recipeitem withcount' .. IconBorder .. '" style="font-size:' .. IconSize .. 'px">' .. '<div class="recipeitemicon">[[file:'.. Icon ..'|'.. IconSize ..'px|link=]]</div><span class="recipeitemcount">' .. IconCount .. '</span> ' .. IconLink ..'</div>' end
if IconStyle == '6' then return '<div class="recipeitem' .. IconBorder .. '" style="font-size:' .. IconSize .. 'px">' .. '<div class="recipeitemicon">[[file:'.. Icon ..'|'.. IconSize ..'px|link=]]</div>[[' .. args.link .. '|<div class="recipeitemlink" title="' .. args.link .. '"></div>]]</div>' end
end

return p

Module:IconUtils

2026-02-24T14:06:11Z

WugWugg: Undo revision 16409 by WugWugg (talk)

local p = {}

function p.main(param)
local Utils = require('Module:Utils')

local Icon = ''
local IconStyle = ''
local IconSize = ''
local IconLink = ''
local IconBorder = ''
local IconCount = ''

local args = Utils.normalise(param)

if args.id == nil or args.name == '' then return 'Module:IconUtils \'id\' must be specified.' end

local Icon = args.id .. '_Icon.png'

if args.size == nil or args.size == '' then IconSize = 28 else IconSize = args.size end
if args.style == nil or args.style == '' then IconStyle = '1' else IconStyle = args.style end
if args.link == nil or args.link == '' then IconLink = '' else IconLink = '[[' .. args.link .. ']]' end
if args.link == '1' then
if IconStyle == 5 then IconLink = '<div class="recipeitemlink" title="' .. args.name .. '"></div>'
else IconLink = '[[' .. args.name .. ']]' end
end
if IconLink == '' then IconTextLine = ' ' .. args.name IconTextBr = '<br>' .. args.name else IconTextLine = ' ' .. IconLink IconTextBr = '<br>' .. IconLink end
if args.count == nil or args.count == '' then IconCount = '1' else IconCount = args.count end
if args.border == nil or args.border == '' then IconBorder = ' borderwhite' else IconBorder = ' border' .. args.border end

if IconStyle == '1' then return '[[file:'.. Icon ..'|'.. IconSize ..'px|link='.. IconLink ..']]' end
if IconStyle == '2' then return '[[file:'.. Icon ..'|'.. IconSize ..'px|link='.. IconLink ..']]' .. IconTextLine end
if IconStyle == '3' then return '[[file:'.. Icon ..'|'.. IconSize ..'px|link='.. IconLink ..']]' .. IconTextBr end
if IconStyle == '4' then return '<div class="IconFrame">[[file:'.. Icon ..'|'.. IconSize ..'px|link='.. IconLink ..']]' .. IconTextBr .. '</div>' end
if IconStyle == '5' then return '<div class="recipeitem withcount' .. IconBorder .. '" style="font-size:' .. IconSize .. 'px">' .. '<div class="recipeitemicon">[[file:'.. Icon ..'|'.. IconSize ..'px|link=]]</div><span class="recipeitemcount">' .. IconCount .. '</span> ' .. IconLink ..'</div>' end
if IconStyle == '6' then return '<div class="recipeitem' .. IconBorder .. '" style="font-size:' .. IconSize .. 'px">' .. '<div class="recipeitemicon">[[file:'.. Icon ..'|'.. IconSize ..'px|link=]]</div>[[' .. args.link .. '|<div class="recipeitemlink" title="' .. args.link .. '"></div>]]</div>' end
end

return p

Module:IconUtils

2026-02-24T14:04:22Z

WugWugg: Moving the Link to outside the icon.

local p = {}

function p.main(param)
local Utils = require('Module:Utils')

local Icon = ''
local IconStyle = ''
local IconSize = ''
local IconLink = ''
local IconBorder = ''
local IconCount = ''

local args = Utils.normalise(param)

if args.id == nil or args.name == '' then return 'Module:IconUtils \'id\' must be specified.' end

local Icon = args.id .. '_Icon.png'

if args.size == nil or args.size == '' then IconSize = 28 else IconSize = args.size end
if args.style == nil or args.style == '' then IconStyle = '1' else IconStyle = args.style end
if args.link == nil or args.link == '' then IconLink = '' else IconLink = '[[' .. args.link .. ']]' end
if args.link == '1' then
if IconStyle == 5 then IconLink = '<div class="recipeitemlink" title="' .. args.name .. '"></div>'
else IconLink = '[[' .. args.name .. ']]' end
end
if IconLink == '' then IconTextLine = ' ' .. args.name IconTextBr = '<br>' .. args.name else IconTextLine = ' ' .. IconLink IconTextBr = '<br>' .. IconLink end
if args.count == nil or args.count == '' then IconCount = '1' else IconCount = args.count end
if args.border == nil or args.border == '' then IconBorder = ' borderwhite' else IconBorder = ' border' .. args.border end

if IconStyle == '1' then return '[[file:'.. Icon ..'|'.. IconSize ..'px|link='.. IconLink ..']]' end
if IconStyle == '2' then return '[[file:'.. Icon ..'|'.. IconSize ..'px|link='.. IconLink ..']]' .. IconTextLine end
if IconStyle == '3' then return '[[file:'.. Icon ..'|'.. IconSize ..'px|link='.. IconLink ..']]' .. IconTextBr end
if IconStyle == '4' then return '<div class="IconFrame">[[file:'.. Icon ..'|'.. IconSize ..'px|link='.. IconLink ..']]' .. IconTextBr .. '</div>' end
if IconStyle == '5' then return '<div class="recipeitem withcount' .. IconBorder .. '" style="font-size:' .. IconSize .. 'px">' .. '<div class="recipeitemicon">[[file:'.. Icon ..'|'.. IconSize ..'px|link=]]</div><span class="recipeitemcount">' .. IconCount .. '</span></div>' .. IconLink end
if IconStyle == '6' then return '<div class="recipeitem' .. IconBorder .. '" style="font-size:' .. IconSize .. 'px">' .. '<div class="recipeitemicon">[[file:'.. Icon ..'|'.. IconSize ..'px|link=]]</div>[[' .. args.link .. '|<div class="recipeitemlink" title="' .. args.link .. '"></div>]]</div>' end
end

return p

Module:IconUtils

2026-02-24T13:59:02Z

WugWugg: Bug Fix: Fixing the link for style 5

local p = {}

function p.main(param)
local Utils = require('Module:Utils')

local Icon = ''
local IconStyle = ''
local IconSize = ''
local IconLink = ''
local IconBorder = ''
local IconCount = ''

local args = Utils.normalise(param)

if args.id == nil or args.name == '' then return 'Module:IconUtils \'id\' must be specified.' end

local Icon = args.id .. '_Icon.png'

if args.size == nil or args.size == '' then IconSize = 28 else IconSize = args.size end
if args.style == nil or args.style == '' then IconStyle = '1' else IconStyle = args.style end
if args.link == nil or args.link == '' then IconLink = '' else IconLink = '[[' .. args.link .. ']]' end
if args.link == '1' then
if IconStyle == 5 then IconLink = '<div class="recipeitemlink" title="' .. args.name .. '"></div>'
else IconLink = '[[' .. args.name .. ']]' end
end
if IconLink == '' then IconTextLine = ' ' .. args.name IconTextBr = '<br>' .. args.name else IconTextLine = ' ' .. IconLink IconTextBr = '<br>' .. IconLink end
if args.count == nil or args.count == '' then IconCount = '1' else IconCount = args.count end
if args.border == nil or args.border == '' then IconBorder = ' borderwhite' else IconBorder = ' border' .. args.border end

if IconStyle == '1' then return '[[file:'.. Icon ..'|'.. IconSize ..'px|link='.. IconLink ..']]' end
if IconStyle == '2' then return '[[file:'.. Icon ..'|'.. IconSize ..'px|link='.. IconLink ..']]' .. IconTextLine end
if IconStyle == '3' then return '[[file:'.. Icon ..'|'.. IconSize ..'px|link='.. IconLink ..']]' .. IconTextBr end
if IconStyle == '4' then return '<div class="IconFrame">[[file:'.. Icon ..'|'.. IconSize ..'px|link='.. IconLink ..']]' .. IconTextBr .. '</div>' end
if IconStyle == '5' then return '<div class="recipeitem withcount' .. IconBorder .. '" style="font-size:' .. IconSize .. 'px">' .. '<div class="recipeitemicon">[[file:'.. Icon ..'|'.. IconSize ..'px|link=]]</div><span class="recipeitemcount">' .. IconCount .. '</span> ' .. IconLink ..'</div>' end
if IconStyle == '6' then return '<div class="recipeitem' .. IconBorder .. '" style="font-size:' .. IconSize .. 'px">' .. '<div class="recipeitemicon">[[file:'.. Icon ..'|'.. IconSize ..'px|link=]]</div>[[' .. args.link .. '|<div class="recipeitemlink" title="' .. args.link .. '"></div>]]</div>' end
end

return p

Module:IconUtils

2026-02-24T13:53:42Z

WugWugg: Bug Fix: Removing double-double brackets

local p = {}

function p.main(param)
local Utils = require('Module:Utils')

local Icon = ''
local IconStyle = ''
local IconSize = ''
local IconLink = ''
local IconBorder = ''
local IconCount = ''

local args = Utils.normalise(param)

if args.id == nil or args.name == '' then return 'Module:IconUtils \'id\' must be specified.' end

local Icon = args.id .. '_Icon.png'

if args.size == nil or args.size == '' then IconSize = 28 else IconSize = args.size end
if args.style == nil or args.style == '' then IconStyle = '1' else IconStyle = args.style end
if args.link == nil or args.link == '' then IconLink = '' else IconLink = '[[' .. args.link .. ']]' end
if args.link == '1' then
if IconStyle == 5 then IconLink = '[[' .. args.name .. '|<div class="recipeitemlink" title="' .. args.name .. '"></div>]]'
else IconLink = '[[' .. args.name .. ']]' end
end
if IconLink == '' then IconTextLine = ' ' .. args.name IconTextBr = '<br>' .. args.name else IconTextLine = ' ' .. IconLink IconTextBr = '<br>' .. IconLink end
if args.count == nil or args.count == '' then IconCount = '1' else IconCount = args.count end
if args.border == nil or args.border == '' then IconBorder = ' borderwhite' else IconBorder = ' border' .. args.border end

if IconStyle == '1' then return '[[file:'.. Icon ..'|'.. IconSize ..'px|link='.. IconLink ..']]' end
if IconStyle == '2' then return '[[file:'.. Icon ..'|'.. IconSize ..'px|link='.. IconLink ..']]' .. IconTextLine end
if IconStyle == '3' then return '[[file:'.. Icon ..'|'.. IconSize ..'px|link='.. IconLink ..']]' .. IconTextBr end
if IconStyle == '4' then return '<div class="IconFrame">[[file:'.. Icon ..'|'.. IconSize ..'px|link='.. IconLink ..']]' .. IconTextBr .. '</div>' end
if IconStyle == '5' then return '<div class="recipeitem withcount' .. IconBorder .. '" style="font-size:' .. IconSize .. 'px">' .. '<div class="recipeitemicon">[[file:'.. Icon ..'|'.. IconSize ..'px|link=]]</div><span class="recipeitemcount">' .. IconCount .. '</span> ' .. IconLink ..'</div>' end
if IconStyle == '6' then return '<div class="recipeitem' .. IconBorder .. '" style="font-size:' .. IconSize .. 'px">' .. '<div class="recipeitemicon">[[file:'.. Icon ..'|'.. IconSize ..'px|link=]]</div>[[' .. args.link .. '|<div class="recipeitemlink" title="' .. args.link .. '"></div>]]</div>' end
end

return p

Module:IconUtils

2026-02-24T13:51:23Z

WugWugg: All links worked. Changing style 5 to use new IconLink.

local p = {}

function p.main(param)
local Utils = require('Module:Utils')

local Icon = ''
local IconStyle = ''
local IconSize = ''
local IconLink = ''
local IconBorder = ''
local IconCount = ''

local args = Utils.normalise(param)

if args.id == nil or args.name == '' then return 'Module:IconUtils \'id\' must be specified.' end

local Icon = args.id .. '_Icon.png'

if args.size == nil or args.size == '' then IconSize = 28 else IconSize = args.size end
if args.style == nil or args.style == '' then IconStyle = '1' else IconStyle = args.style end
if args.link == nil or args.link == '' then IconLink = '' else IconLink = '[[' .. args.link .. ']]' end
if args.link == '1' then
if IconStyle == 5 then IconLink = '[[' .. args.name .. '|<div class="recipeitemlink" title="' .. args.name .. '"></div>]]'
else IconLink = '[[' .. args.name .. ']]' end
end
if IconLink == '' then IconTextLine = ' ' .. args.name IconTextBr = '<br>' .. args.name else IconTextLine = ' ' .. IconLink IconTextBr = '<br>' .. IconLink end
if args.count == nil or args.count == '' then IconCount = '1' else IconCount = args.count end
if args.border == nil or args.border == '' then IconBorder = ' borderwhite' else IconBorder = ' border' .. args.border end

if IconStyle == '1' then return '[[file:'.. Icon ..'|'.. IconSize ..'px|link='.. IconLink ..']]' end
if IconStyle == '2' then return '[[file:'.. Icon ..'|'.. IconSize ..'px|link='.. IconLink ..']]' .. IconTextLine end
if IconStyle == '3' then return '[[file:'.. Icon ..'|'.. IconSize ..'px|link='.. IconLink ..']]' .. IconTextBr end
if IconStyle == '4' then return '<div class="IconFrame">[[file:'.. Icon ..'|'.. IconSize ..'px|link='.. IconLink ..']]' .. IconTextBr .. '</div>' end
if IconStyle == '5' then return '<div class="recipeitem withcount' .. IconBorder .. '" style="font-size:' .. IconSize .. 'px">' .. '<div class="recipeitemicon">[[file:'.. Icon ..'|'.. IconSize ..'px|link=]]</div><span class="recipeitemcount">' .. IconCount .. '</span> [[' .. IconLink ..']]</div>' end
if IconStyle == '6' then return '<div class="recipeitem' .. IconBorder .. '" style="font-size:' .. IconSize .. 'px">' .. '<div class="recipeitemicon">[[file:'.. Icon ..'|'.. IconSize ..'px|link=]]</div>[[' .. args.link .. '|<div class="recipeitemlink" title="' .. args.link .. '"></div>]]</div>' end
end

return p

Module:IconUtils

2026-02-24T13:47:52Z

WugWugg: Making link=1 and style=5 correctly link to default page. Should not affect anything but style 5.

local p = {}

function p.main(param)
local Utils = require('Module:Utils')

local Icon = ''
local IconStyle = ''
local IconSize = ''
local IconLink = ''
local IconBorder = ''
local IconCount = ''

local args = Utils.normalise(param)

if args.id == nil or args.name == '' then return 'Module:IconUtils \'id\' must be specified.' end

local Icon = args.id .. '_Icon.png'

if args.size == nil or args.size == '' then IconSize = 28 else IconSize = args.size end
if args.style == nil or args.style == '' then IconStyle = '1' else IconStyle = args.style end
if args.link == nil or args.link == '' then IconLink = '' else IconLink = '[[' .. args.link .. ']]' end
if args.link == '1' then
if IconStyle == 5 then IconLink = '[[' .. args.name .. '|<div class="recipeitemlink" title="' .. args.name .. '"></div>]]'
else IconLink = '[[' .. args.name .. ']]' end
end
if IconLink == '' then IconTextLine = ' ' .. args.name IconTextBr = '<br>' .. args.name else IconTextLine = ' ' .. IconLink IconTextBr = '<br>' .. IconLink end
if args.count == nil or args.count == '' then IconCount = '1' else IconCount = args.count end
if args.border == nil or args.border == '' then IconBorder = ' borderwhite' else IconBorder = ' border' .. args.border end

if IconStyle == '1' then return '[[file:'.. Icon ..'|'.. IconSize ..'px|link='.. IconLink ..']]' end
if IconStyle == '2' then return '[[file:'.. Icon ..'|'.. IconSize ..'px|link='.. IconLink ..']]' .. IconTextLine end
if IconStyle == '3' then return '[[file:'.. Icon ..'|'.. IconSize ..'px|link='.. IconLink ..']]' .. IconTextBr end
if IconStyle == '4' then return '<div class="IconFrame">[[file:'.. Icon ..'|'.. IconSize ..'px|link='.. IconLink ..']]' .. IconTextBr .. '</div>' end
if IconStyle == '5' then return '<div class="recipeitem withcount' .. IconBorder .. '" style="font-size:' .. IconSize .. 'px">' .. '<div class="recipeitemicon">[[file:'.. Icon ..'|'.. IconSize ..'px|link=]]</div><span class="recipeitemcount">' .. IconCount .. '</span>' .. '[[' .. args.link .. '|<div class="recipeitemlink" title="' .. args.link .. '"></div>]]</div>' end
if IconStyle == '6' then return '<div class="recipeitem' .. IconBorder .. '" style="font-size:' .. IconSize .. 'px">' .. '<div class="recipeitemicon">[[file:'.. Icon ..'|'.. IconSize ..'px|link=]]</div>[[' .. args.link .. '|<div class="recipeitemlink" title="' .. args.link .. '"></div>]]</div>' end
end

return p

Template:Demo RecipeItemIcon/styles.css

2026-02-21T14:44:39Z

WugWugg: Undo revision 16349 by WugWugg (talk)

/* NOTE: The size of 'em' is set in the template via inline styles setting 'font-size' */
.recipe-item-icon {
position: relative;
width: fit-content;
height: fit-content;
overflow: hidden;
border-width: clamp(3px, 0.05em, 8px);
border-radius: clamp(4px, 0.1em, 16px);
box-shadow:
0 0.04em 0.06em rgba(0,0,0,0.75),
0 0.09em 0.14em rgba(0,0,0,0.45);
margin: 0.1em;
}

.recipe-item-icon.border-white {
background-color: white;
border-color: white;
border-style: solid;
}

.recipe-item-icon.border-yellow {
background-color: yellow;
border-color: yellow;
border-style: solid;
}

.recipe-item-icon.border-green {
background-color: lime;
border-color: lime;
border-style: solid;
}

.recipe-item-icon.has-count::after {
content: "";
position: absolute;
z-index: 1;
bottom: 0;
right: 0;
width: 100%;
height: 100%;
/* Known Limit/Bug: When an icon has a count the icon's image link cannot be clicked*/
/* Solution add pointer-events to this Wiki's supported CSS features*/
/* pointer-events: none;*/
background: linear-gradient(
315deg,
rgba(0,0,0,0.55) 0%,
rgba(0,0,0,0.4) 28%,
rgba(0,0,0,0.2) 35%,
rgba(0,0,0,0) 42%
);
}

.recipe-item-icon__img-container {
width: 1em;
height: 1em;
}

.recipe-item-icon__img-container img {
display: block;
}

.recipe-item-icon__count {
position: absolute;
z-index: 2;
bottom: clamp(4px, 0.1em, 16px);
right: clamp(4px, 0.1em, 16px);
line-height: 1;
color: #fff;
text-shadow: 0 1px 2px rgba(0,0,0,0.85);
font-weight: bold;
font-size: 0.25em;
}

/* Kill VE filler paragraph after the icon, only in the demo table */
.recipe-icon-demo td .recipe-item-icon + p {
margin: 0 !important;
line-height: 0 !important;
height: 0 !important;
}

.recipe-icon-demo td .recipe-item-icon + p > br {
display: none;
}

Template:Demo RecipeItemIcon/styles.css

2026-02-21T14:44:27Z

WugWugg: Undo revision 16352 by WugWugg (talk)

/* NOTE: The size of 'em' is set in the template via inline styles setting 'font-size' */
.recipe-item-icon {
position: relative;
width: fit-content;
height: fit-content;
overflow: hidden;
border-width: clamp(3px, 0.05em, 8px);
border-radius: clamp(4px, 0.1em, 16px);
box-shadow:
0 0.04em 0.06em rgba(0,0,0,0.75),
0 0.09em 0.14em rgba(0,0,0,0.45);
margin: 0.1em;
}

.recipe-item-icon.border-white {
background-color: white;
border-color: white;
border-style: solid;
}

.recipe-item-icon.border-yellow {
background-color: yellow;
border-color: yellow;
border-style: solid;
}

.recipe-item-icon.border-green {
background-color: lime;
border-color: lime;
border-style: solid;
}

.recipe-item-icon.has-count::after {
content: "";
position: absolute;
z-index: 1;
bottom: 0;
right: 0;
width: 100%;
height: 100%;
/* Known Limit/Bug: When an icon has a count the icon's image link cannot be clicked*/
/* Solution add pointer-events to this Wiki's supported CSS features*/
/* pointer-events: none;*/
background: linear-gradient(
315deg,
rgba(0,0,0,0.55) 0%,
rgba(0,0,0,0.4) 28%,
rgba(0,0,0,0.2) 35%,
rgba(0,0,0,0) 42%
);
}

.recipe-item-icon__img-container {
width: 1em;
height: 1em;
}

.recipe-item-icon__img-container img {
display: block;
width: 100% !important;
height: 100% !important;
}

.recipe-item-icon__count {
position: absolute;
z-index: 2;
bottom: clamp(4px, 0.1em, 16px);
right: clamp(4px, 0.1em, 16px);
line-height: 1;
color: #fff;
text-shadow: 0 1px 2px rgba(0,0,0,0.85);
font-weight: bold;
font-size: 0.25em;
}

/* Kill VE filler paragraph after the icon, only in the demo table */
.recipe-icon-demo td .recipe-item-icon + p {
margin: 0 !important;
line-height: 0 !important;
height: 0 !important;
}

.recipe-icon-demo td .recipe-item-icon + p > br {
display: none;
}

Template:Demo RecipeItemIcon

2026-02-21T14:43:57Z

WugWugg: Undo revision 16350 by WugWugg (talk)

<templatestyles src="Template:Demo_RecipeItemIcon/styles.css" />

<includeonly><div class="recipe-item-icon {{#if: {{{count|}}} | has-count }} {{#switch: {{{border|}}} | yellow = border-yellow | white = border-white | green = border-green | #default = border-white}}" style="font-size:{{{size|64}}}px"><div class="recipe-item-icon__img-container">[[File:{{{icon}}}|{{{size|64}}}px]]</div><span class="recipe-item-icon__count">{{{count|}}}</span></div></includeonly>

<noinclude>
=== Visual Goals ===
[[File:DaisyItem--Icon Yellow.png|frameless|border|upright=3|location=center|link=]]
[[File:DaisyItem--Icon White--No-Count.png|border|upright=3|location=center|link=]]
[[File:DaisyItem--Icon White.png|frameless|border|upright=3|location=center|link=]]
[[File:DaisyItem--Icon White--100.png|border|upright=3|location=center|link=]]

=== Template Examples ===
{| class="wikitable recipe-icon-demo"
|+ Border Colors
! Color !! Example
|-
| White ''(Default)'' ||{{Demo RecipeItemIcon|icon=DaisyItem_Icon.png}}
|-
| Yellow ||{{Demo RecipeItemIcon|icon=DaisyItem_Icon.png|border=yellow}}
|-
| Green ||{{Demo RecipeItemIcon|icon=DaisyItem_Icon.png|border=green}}
|}

{| class="wikitable recipe-icon-demo"
|+ Responsive Sizing
! Size !! Example
|-
| 64px ''(Default)'' ||{{Demo RecipeItemIcon|icon=DaisyItem_Icon.png|count=10|size=64}}
|-
| 128px ||{{Demo RecipeItemIcon|icon=DaisyItem_Icon.png|count=10|size=128}}
|-
| 256px ||{{Demo RecipeItemIcon|icon=DaisyItem_Icon.png|count=10|size=256}}
|}

{| class="wikitable recipe-icon-demo"
|+ Count Shadow
! Count !! Example
|-
| ''No Count/Shadow'' ||{{Demo RecipeItemIcon|icon=DaisyItem_Icon.png}}
|-
| 10 ||{{Demo RecipeItemIcon|icon=DaisyItem_Icon.png|count=10}}
|-
| 100 ||{{Demo RecipeItemIcon|icon=DaisyItem_Icon.png|count=100}}
|}

=== Grid Demo ===
<div class="row g-2 mb-3"><div class="col-xs-12 col-sm-6 col-md-4 col-lg-3">{{Demo RecipeItemIcon|icon=DaisyItem_Icon.png|count=100|size=128}}</div><div class="col-xs-12 col-sm-6 col-md-4 col-lg-3">{{Demo RecipeItemIcon|icon=TulipItem Icon.png|count=100|border=yellow|size=128}}</div><div class="col-xs-12 col-sm-6 col-md-4 col-lg-3">{{Demo RecipeItemIcon|icon=LupineItem Icon.png|size=128}}</div><div class="col-xs-12 col-sm-6 col-md-4 col-lg-3">{{Demo RecipeItemIcon|icon=RoseItem Icon.png|count=10|border=yellow|size=128}}</div><div class="col-xs-12 col-sm-6 col-md-4 col-lg-3">{{Demo RecipeItemIcon|icon=FlaxFlowerItem Icon.png|count=67|border=green|size=128}}</div><div class="col-xs-12 col-sm-6 col-md-4 col-lg-3">{{Demo RecipeItemIcon|icon=Flower Icon.png|border=green|size=128}}</div><div class="col-xs-12 col-sm-6 col-md-4 col-lg-3">{{Demo RecipeItemIcon|icon=EcoBookItem Icon.png|size=128}}</div><div class="col-xs-12 col-sm-6 col-md-4 col-lg-3">{{Demo RecipeItemIcon|icon=RiceFlourItem Icon.png|border=green|size=128}}</div><div class="col-xs-12 col-sm-6 col-md-4 col-lg-3">{{Demo RecipeItemIcon|icon=NailItem Icon.png|border=yellow|size=128}}</div><div class="col-xs-12 col-sm-6 col-md-4 col-lg-3">{{Demo RecipeItemIcon|icon=AdobeItem Icon.png|border=green|size=128}}</div><div class="col-xs-12 col-sm-6 col-md-4 col-lg-3">{{Demo RecipeItemIcon|icon=JoshuaLogItem Icon.png|size=128}}</div><div class="col-xs-12 col-sm-6 col-md-4 col-lg-3">{{Demo RecipeItemIcon|icon=IronOreItem Icon.png|border=yellow|size=128}}</div></div>

=== Recipe Demo ===
<div class="row g-2 mb-3 align-items-center justify-content-center"><div class="col-xs-12 col-sm-4 col-md-3 col-lg-2">{{Demo RecipeItemIcon|icon=NailItem Icon.png|border=yellow|size=128|count=2}}</div><div class="col-xs-12 col-sm-2 col-md-1"><i class="fas fa-plus" style="font-size:64px"></i></div><div class="col-xs-12 col-sm-4 col-md-3 col-lg-2">{{Demo RecipeItemIcon|icon=FlaxseedOilItem_Icon.png|border=yellow|size=128|count=0.5}}</div><div class="col-xs-12 col-sm-2 col-md-1"><i class="fas fa-plus" style="font-size:64px"></i></div><div class="col-xs-12 col-sm-4 col-md-3 col-lg-2">{{Demo RecipeItemIcon|icon=WoodBoard_Icon.png|border=yellow|size=128|count=10}}</div><div class="col-xs-12 col-sm-2 col-md-1"><i class="fas fa-equals" style="font-size:64px"></i></div><div class="col-xs-12 col-sm-4 col-md-3 col-lg-2">{{Demo RecipeItemIcon|icon=LumberItem_Icon.png|size=128|count=2}}</div></div>

<templatedata>
{
"params": {
"size": {
"description": "Size in pixels (numbers only)",
"example": "64",
"type": "number",
"suggestedvalues": [
"64",
"128"
],
"default": "64",
"autovalue": "64"
},
"icon": {
"description": "File name for icon.",
"example": "DaisyItem_Icon.png",
"required": true,
"type": "string"
},
"count": {
"aliases": [
"num"
],
"description": "A number to display over this icon's image. Useful for showing counts.",
"example": "10",
"type": "number"
},
"border": {
"description": "Border color",
"type": "string",
"suggestedvalues": [
"white",
"yellow",
"green"
],
"default": "white",
"autovalue": "white"
}
}
}
</templatedata>
</noinclude>

Template:Demo RecipeItemIcon

2026-02-21T14:43:38Z

WugWugg: Undo revision 16351 by WugWugg (talk)

<templatestyles src="Template:Demo_RecipeItemIcon/styles.css" />

<includeonly><div class="recipe-item-icon {{#if: {{{count|}}} | has-count }} {{#switch: {{{border|}}} | yellow = border-yellow | white = border-white | green = border-green | #default = border-white}}" style="font-size:{{{size|64}}}px"><div class="recipe-item-icon__img-container">[[File:{{{icon}}}]]</div><span class="recipe-item-icon__count">{{{count|}}}</span></div></includeonly>

<noinclude>
=== Visual Goals ===
[[File:DaisyItem--Icon Yellow.png|frameless|border|upright=3|location=center|link=]]
[[File:DaisyItem--Icon White--No-Count.png|border|upright=3|location=center|link=]]
[[File:DaisyItem--Icon White.png|frameless|border|upright=3|location=center|link=]]
[[File:DaisyItem--Icon White--100.png|border|upright=3|location=center|link=]]

=== Template Examples ===
{| class="wikitable recipe-icon-demo"
|+ Border Colors
! Color !! Example
|-
| White ''(Default)'' ||{{Demo RecipeItemIcon|icon=DaisyItem_Icon.png}}
|-
| Yellow ||{{Demo RecipeItemIcon|icon=DaisyItem_Icon.png|border=yellow}}
|-
| Green ||{{Demo RecipeItemIcon|icon=DaisyItem_Icon.png|border=green}}
|}

{| class="wikitable recipe-icon-demo"
|+ Responsive Sizing
! Size !! Example
|-
| 64px ''(Default)'' ||{{Demo RecipeItemIcon|icon=DaisyItem_Icon.png|count=10|size=64}}
|-
| 128px ||{{Demo RecipeItemIcon|icon=DaisyItem_Icon.png|count=10|size=128}}
|-
| 256px ||{{Demo RecipeItemIcon|icon=DaisyItem_Icon.png|count=10|size=256}}
|}

{| class="wikitable recipe-icon-demo"
|+ Count Shadow
! Count !! Example
|-
| ''No Count/Shadow'' ||{{Demo RecipeItemIcon|icon=DaisyItem_Icon.png}}
|-
| 10 ||{{Demo RecipeItemIcon|icon=DaisyItem_Icon.png|count=10}}
|-
| 100 ||{{Demo RecipeItemIcon|icon=DaisyItem_Icon.png|count=100}}
|}

=== Grid Demo ===
<div class="row g-2 mb-3"><div class="col-xs-12 col-sm-6 col-md-4 col-lg-3">{{Demo RecipeItemIcon|icon=DaisyItem_Icon.png|count=100|size=128}}</div><div class="col-xs-12 col-sm-6 col-md-4 col-lg-3">{{Demo RecipeItemIcon|icon=TulipItem Icon.png|count=100|border=yellow|size=128}}</div><div class="col-xs-12 col-sm-6 col-md-4 col-lg-3">{{Demo RecipeItemIcon|icon=LupineItem Icon.png|size=128}}</div><div class="col-xs-12 col-sm-6 col-md-4 col-lg-3">{{Demo RecipeItemIcon|icon=RoseItem Icon.png|count=10|border=yellow|size=128}}</div><div class="col-xs-12 col-sm-6 col-md-4 col-lg-3">{{Demo RecipeItemIcon|icon=FlaxFlowerItem Icon.png|count=67|border=green|size=128}}</div><div class="col-xs-12 col-sm-6 col-md-4 col-lg-3">{{Demo RecipeItemIcon|icon=Flower Icon.png|border=green|size=128}}</div><div class="col-xs-12 col-sm-6 col-md-4 col-lg-3">{{Demo RecipeItemIcon|icon=EcoBookItem Icon.png|size=128}}</div><div class="col-xs-12 col-sm-6 col-md-4 col-lg-3">{{Demo RecipeItemIcon|icon=RiceFlourItem Icon.png|border=green|size=128}}</div><div class="col-xs-12 col-sm-6 col-md-4 col-lg-3">{{Demo RecipeItemIcon|icon=NailItem Icon.png|border=yellow|size=128}}</div><div class="col-xs-12 col-sm-6 col-md-4 col-lg-3">{{Demo RecipeItemIcon|icon=AdobeItem Icon.png|border=green|size=128}}</div><div class="col-xs-12 col-sm-6 col-md-4 col-lg-3">{{Demo RecipeItemIcon|icon=JoshuaLogItem Icon.png|size=128}}</div><div class="col-xs-12 col-sm-6 col-md-4 col-lg-3">{{Demo RecipeItemIcon|icon=IronOreItem Icon.png|border=yellow|size=128}}</div></div>

=== Recipe Demo ===
<div class="row g-2 mb-3 align-items-center justify-content-center"><div class="col-xs-12 col-sm-4 col-md-3 col-lg-2">{{Demo RecipeItemIcon|icon=NailItem Icon.png|border=yellow|size=128|count=2}}</div><div class="col-xs-12 col-sm-2 col-md-1"><i class="fas fa-plus" style="font-size:64px"></i></div><div class="col-xs-12 col-sm-4 col-md-3 col-lg-2">{{Demo RecipeItemIcon|icon=FlaxseedOilItem_Icon.png|border=yellow|size=128|count=0.5}}</div><div class="col-xs-12 col-sm-2 col-md-1"><i class="fas fa-plus" style="font-size:64px"></i></div><div class="col-xs-12 col-sm-4 col-md-3 col-lg-2">{{Demo RecipeItemIcon|icon=WoodBoard_Icon.png|border=yellow|size=128|count=10}}</div><div class="col-xs-12 col-sm-2 col-md-1"><i class="fas fa-equals" style="font-size:64px"></i></div><div class="col-xs-12 col-sm-4 col-md-3 col-lg-2">{{Demo RecipeItemIcon|icon=LumberItem_Icon.png|size=128|count=2}}</div></div>

<templatedata>
{
"params": {
"size": {
"description": "Size in pixels (numbers only)",
"example": "64",
"type": "number",
"suggestedvalues": [
"64",
"128"
],
"default": "64",
"autovalue": "64"
},
"icon": {
"description": "File name for icon.",
"example": "DaisyItem_Icon.png",
"required": true,
"type": "string"
},
"count": {
"aliases": [
"num"
],
"description": "A number to display over this icon's image. Useful for showing counts.",
"example": "10",
"type": "number"
},
"border": {
"description": "Border color",
"type": "string",
"suggestedvalues": [
"white",
"yellow",
"green"
],
"default": "white",
"autovalue": "white"
}
}
}
</templatedata>
</noinclude>

Template:Demo RecipeItemIcon/styles.css

2026-02-21T14:08:49Z

WugWugg:

/* NOTE: The size of 'em' is set in the template via inline styles setting 'font-size' */
.recipe-item-icon {
position: relative;
width: fit-content;
height: fit-content;
overflow: hidden;
border-width: clamp(3px, 0.05em, 8px);
border-radius: clamp(4px, 0.1em, 16px);
box-shadow:
0 0.04em 0.06em rgba(0,0,0,0.75),
0 0.09em 0.14em rgba(0,0,0,0.45);
margin: 0.1em;
}

.recipe-item-icon.border-white {
background-color: white;
border-color: white;
border-style: solid;
}

.recipe-item-icon.border-yellow {
background-color: yellow;
border-color: yellow;
border-style: solid;
}

.recipe-item-icon.border-green {
background-color: lime;
border-color: lime;
border-style: solid;
}

.recipe-item-icon.has-count::after {
content: "";
position: absolute;
z-index: 1;
bottom: 0;
right: 0;
width: 100%;
height: 100%;
/* Known Limit/Bug: When an icon has a count the icon's image link cannot be clicked*/
/* Solution add pointer-events to this Wiki's supported CSS features*/
/* pointer-events: none;*/
background: linear-gradient(
315deg,
rgba(0,0,0,0.55) 0%,
rgba(0,0,0,0.4) 28%,
rgba(0,0,0,0.2) 35%,
rgba(0,0,0,0) 42%
);
}

/*.recipe-item-icon__img-container {}*/

.recipe-item-icon__img-container img {
display: block;
width: 100% !important;
height: 100% !important;
}

.recipe-item-icon__count {
position: absolute;
z-index: 2;
bottom: clamp(4px, 0.1em, 16px);
right: clamp(4px, 0.1em, 16px);
line-height: 1;
color: #fff;
text-shadow: 0 1px 2px rgba(0,0,0,0.85);
font-weight: bold;
font-size: 0.25em;
}

/* Kill VE filler paragraph after the icon, only in the demo table */
.recipe-icon-demo td .recipe-item-icon + p {
margin: 0 !important;
line-height: 0 !important;
height: 0 !important;
}

.recipe-icon-demo td .recipe-item-icon + p > br {
display: none;
}

Template:Demo RecipeItemIcon

2026-02-21T14:07:20Z

WugWugg:

<templatestyles src="Template:Demo_RecipeItemIcon/styles.css" />

<includeonly><div class="recipe-item-icon {{#if: {{{count|}}} | has-count }} {{#switch: {{{border|}}} | yellow = border-yellow | white = border-white | green = border-green | #default = border-white}}"><div class="recipe-item-icon__img-container">[[File:{{{icon}}}]]</div><span class="recipe-item-icon__count">{{{count|}}}</span></div></includeonly>

<noinclude>
=== Visual Goals ===
[[File:DaisyItem--Icon Yellow.png|frameless|border|upright=3|location=center|link=]]
[[File:DaisyItem--Icon White--No-Count.png|border|upright=3|location=center|link=]]
[[File:DaisyItem--Icon White.png|frameless|border|upright=3|location=center|link=]]
[[File:DaisyItem--Icon White--100.png|border|upright=3|location=center|link=]]

=== Template Examples ===
{| class="wikitable recipe-icon-demo"
|+ Border Colors
! Color !! Example
|-
| White ''(Default)'' ||{{Demo RecipeItemIcon|icon=DaisyItem_Icon.png}}
|-
| Yellow ||{{Demo RecipeItemIcon|icon=DaisyItem_Icon.png|border=yellow}}
|-
| Green ||{{Demo RecipeItemIcon|icon=DaisyItem_Icon.png|border=green}}
|}

{| class="wikitable recipe-icon-demo"
|+ Responsive Sizing
! Size !! Example
|-
| 64px ''(Default)'' ||{{Demo RecipeItemIcon|icon=DaisyItem_Icon.png|count=10|size=64}}
|-
| 128px ||{{Demo RecipeItemIcon|icon=DaisyItem_Icon.png|count=10|size=128}}
|-
| 256px ||{{Demo RecipeItemIcon|icon=DaisyItem_Icon.png|count=10|size=256}}
|}

{| class="wikitable recipe-icon-demo"
|+ Count Shadow
! Count !! Example
|-
| ''No Count/Shadow'' ||{{Demo RecipeItemIcon|icon=DaisyItem_Icon.png}}
|-
| 10 ||{{Demo RecipeItemIcon|icon=DaisyItem_Icon.png|count=10}}
|-
| 100 ||{{Demo RecipeItemIcon|icon=DaisyItem_Icon.png|count=100}}
|}

=== Grid Demo ===
<div class="row g-2 mb-3"><div class="col-xs-12 col-sm-6 col-md-4 col-lg-3">{{Demo RecipeItemIcon|icon=DaisyItem_Icon.png|count=100|size=128}}</div><div class="col-xs-12 col-sm-6 col-md-4 col-lg-3">{{Demo RecipeItemIcon|icon=TulipItem Icon.png|count=100|border=yellow|size=128}}</div><div class="col-xs-12 col-sm-6 col-md-4 col-lg-3">{{Demo RecipeItemIcon|icon=LupineItem Icon.png|size=128}}</div><div class="col-xs-12 col-sm-6 col-md-4 col-lg-3">{{Demo RecipeItemIcon|icon=RoseItem Icon.png|count=10|border=yellow|size=128}}</div><div class="col-xs-12 col-sm-6 col-md-4 col-lg-3">{{Demo RecipeItemIcon|icon=FlaxFlowerItem Icon.png|count=67|border=green|size=128}}</div><div class="col-xs-12 col-sm-6 col-md-4 col-lg-3">{{Demo RecipeItemIcon|icon=Flower Icon.png|border=green|size=128}}</div><div class="col-xs-12 col-sm-6 col-md-4 col-lg-3">{{Demo RecipeItemIcon|icon=EcoBookItem Icon.png|size=128}}</div><div class="col-xs-12 col-sm-6 col-md-4 col-lg-3">{{Demo RecipeItemIcon|icon=RiceFlourItem Icon.png|border=green|size=128}}</div><div class="col-xs-12 col-sm-6 col-md-4 col-lg-3">{{Demo RecipeItemIcon|icon=NailItem Icon.png|border=yellow|size=128}}</div><div class="col-xs-12 col-sm-6 col-md-4 col-lg-3">{{Demo RecipeItemIcon|icon=AdobeItem Icon.png|border=green|size=128}}</div><div class="col-xs-12 col-sm-6 col-md-4 col-lg-3">{{Demo RecipeItemIcon|icon=JoshuaLogItem Icon.png|size=128}}</div><div class="col-xs-12 col-sm-6 col-md-4 col-lg-3">{{Demo RecipeItemIcon|icon=IronOreItem Icon.png|border=yellow|size=128}}</div></div>

=== Recipe Demo ===
<div class="row g-2 mb-3 align-items-center justify-content-center"><div class="col-xs-12 col-sm-4 col-md-3 col-lg-2">{{Demo RecipeItemIcon|icon=NailItem Icon.png|border=yellow|size=128|count=2}}</div><div class="col-xs-12 col-sm-2 col-md-1"><i class="fas fa-plus" style="font-size:64px"></i></div><div class="col-xs-12 col-sm-4 col-md-3 col-lg-2">{{Demo RecipeItemIcon|icon=FlaxseedOilItem_Icon.png|border=yellow|size=128|count=0.5}}</div><div class="col-xs-12 col-sm-2 col-md-1"><i class="fas fa-plus" style="font-size:64px"></i></div><div class="col-xs-12 col-sm-4 col-md-3 col-lg-2">{{Demo RecipeItemIcon|icon=WoodBoard_Icon.png|border=yellow|size=128|count=10}}</div><div class="col-xs-12 col-sm-2 col-md-1"><i class="fas fa-equals" style="font-size:64px"></i></div><div class="col-xs-12 col-sm-4 col-md-3 col-lg-2">{{Demo RecipeItemIcon|icon=LumberItem_Icon.png|size=128|count=2}}</div></div>

<templatedata>
{
"params": {
"size": {
"description": "Size in pixels (numbers only)",
"example": "64",
"type": "number",
"suggestedvalues": [
"64",
"128"
],
"default": "64",
"autovalue": "64"
},
"icon": {
"description": "File name for icon.",
"example": "DaisyItem_Icon.png",
"required": true,
"type": "string"
},
"count": {
"aliases": [
"num"
],
"description": "A number to display over this icon's image. Useful for showing counts.",
"example": "10",
"type": "number"
},
"border": {
"description": "Border color",
"type": "string",
"suggestedvalues": [
"white",
"yellow",
"green"
],
"default": "white",
"autovalue": "white"
}
}
}
</templatedata>
</noinclude>