About ECommons

ECommons is a multi-functional library designed to work within Dalamud Plugins. It features a variety of different systems and shortcuts which cuts out a lot of boiler plate code normally used to do standard plugin tasks.

Getting Started

Get ECommons from NuGet using a console command:

dotnet add package ECommons

Or simply find it via NuGet package manager GUI.

Then, initialize in the constructor of your plugin:

ECommonsMain.Init(pluginInterface, this);

where pluginInterface is a DalamudPluginInterface.

Don't forget to dispose it in your plugin's dispose method:

ECommonsMain.Dispose();

v3 changes

To ensure consistent building experience, ECommons 3.0.0.0 and higher no longer reference Windows Forms in any way. Additionally, `RELEASEFORMS` and `DEBUGFORMS` versions were removed. If you have previously used `System.Windows.Forms.Keys` with ECommons, replace it with `ECommons.WindowsFormsReflector.Keys`. Internal copy/paste methods now use reflection to call Windows Forms.

Using Modules

ECommons comes with various modules which needs to be initalised at plugin runtime. To do so, modify your initalising code as follows:

ECommonsMain.Init(pluginInterface, this, Modules.<Module>);

where <Module> is one of the following:

• All (For all modules)
• SplatoonAPI
• DalamudReflector
• ObjectLife
• ObjectFunctions

---

Warning

As of 2024-04-15 TaskManager's namespace has changed.
Add using ECommons.Automation.LegacyTaskManager; as an immediate fix.

Warning

As of 2024-04-14 Windows Forms and Windows Targeting are now disabled by default.
Manually set a build configuration with forms as a fix.