Skip to content

Latest commit

 

History

History
42 lines (35 loc) · 1.11 KB

HowToBuildNoodle.md

File metadata and controls

42 lines (35 loc) · 1.11 KB

How to build an Ese Plugins

(There is an template project in naotiki/ese-noodle-template)

Configure Ese Gradle Plugin

Add this code to plugins block in build.gradle.kts.

id("me.naotiki.ese.gradle-plugin") version "0.0.1-dev2"

Add esePlugin block in build.gradle.kts to configure build of Ese Plugins.

This is one of configuring examples.

esePlugin {
    pluginClass.set("Main")
    pluginName.set("Test")
}

pluginClass is FQDN of ese plugin class. (Required)

pluginName is display name of ese plugin. (Required)

Implement Ese Plugin

Create a class named same name of pluginClass configured by build.gradle.kts esePlugin block. It should be implementing EsePlugin interface.

import me.naotiki.ese.core.api.EsePlugin

class Main : EsePlugin {
    override suspend fun init(user: User) {
        //...
    }
}

You can do install processes in init function.

Build Ese Plugin

Run createEsePlugin

./gradlew createEsePlugin

On Success, <pluginName>.ndl file is generated into build/ese/ directory.