Skip to content

Getting Started with Marmalade

A marmalade is a plugin for a self-hosted EllieBot. It adds commands and features without a change to the bot's code. You can load, unload and update a marmalade while the bot runs.

A bot on EllieHome cannot load marmalades.

Manage marmalades

Put each marmalade in its own folder in data/marmalades. The folder and the .dll file must have the same name, for example data/marmalades/mymarmalade/mymarmalade.dll. Then use these owner-only commands:

Command What it does
.marmaladelist / .melist Shows the folders in data/marmalades, and which of them are loaded
.marmaladeload <name> / .meload Loads a marmalade
.marmaladeunload <name> / .meunload Unloads a marmalade
.marmaladereload <name> / .mereload Unloads a marmalade and loads it again
.marmaladeinfo <name> / .meinfo Shows the description, the sneks and the number of commands of a marmalade

The bot loads the same marmalades again after a restart. It keeps the list in the loaded list of data/marmalades/marmalade.yml.

Use only marmalades which you trust

Danger

A marmalade runs with all the rights of the bot. A bad marmalade can steal your bot token, and it can read and delete the files on the computer.

  • Load only marmalades which you wrote, or which come from a person you trust completely.
  • Run the bot on a server which runs nothing else.

To find marmalades from other people, ask in the #dev-and-modding channel of the EllieBot Discord server.

Make a marmalade

You write a marmalade in C#. You need some knowledge of C# and .NET. Read Create a marmalade.