The Easy extensions plugin provides a way to extend Obsidian's functionality without the need to create and install custom plugins. Extensions are javascript objects that live in your vault and can be easily shared with others. The plugin makes the Obsidian APIs available to use, and it also adds its own API to facilitate certain actions.

Extensions are javascript files that the plugin loads from a specified location. A basic extension looks like this:

name = "My First Extension";
description = "A sample extension";

settings = {
    setting1: "value",
    setting2: "value2"
};

onLoad = (api, settings) => {
    // loading code goes here
};

onUnload = (api, settings) => {
    // unloading code goes here
};

Before creating an extension, go to the plugin settings and configure the location in your vault where your extensions will be stored.

To create an extension you can call the Create New Extension command from the command palette. You should now be able to edit your extension js file. An extension has the following properties:

The Extension API is a single, convenient way to access obsidian objects like App and the Extension plugin itself. It's aim is also to offer simple methods and access to other obsidian utility types (e.g. Notice) to your custom extensions.

For example, to create a notice using the obsidian API during the onLoad function you can do something like:

onLoad: (api) => {
    new api.Notice("This is a notice!");
}

You can also register new commands using the obsidian plugin API; you need to do it by accessing the plugin from the API itself:

onLoad: (api, settings) => {
    api.plugin.addCommand({
        id: 'command-id',
        name: 'Execute some command',
        callback: () => {
            new api.Notice("Command executed!");
        }
    });
}

Always remember to remove any commands your extension adds in the onUnload method. Otherwise the commands will linger even if the extension is removed. They can still be removed by reloading or uninstalling the plugin, but extensions should be self-contained and clean after themselves.

onUnload: (api, settings) => {
    api.plugin.removeCommand('command-id');
}

Reference: Obsidian Developer Documentation

Similarly, extensions can register new events using the API and they must also ensure the events are turned off when unloading.

onLoad: (api, settings) => {
    // create and register an event
    this.renameEvt = api.app.vault.on('rename', async (file, oldPath) => {
        console.log('Renaming a file');
    })
    api.plugin.registerEvent(this.renameEvt);
},
onUnload: (api, settings) => {
    // turn the event off when unloading
    api.app.vault.offref(this.renameEvt);
}

This plugin is currently not available via the official Obsidian plugin repository.

• Copy over main.js, styles.css, manifest.json to your vault VaultFolder/.obsidian/plugins/your-plugin-id/.