Getting Started

JSPrismarine plugin-development quick-start guide

Generating boiler-plate plugin using create-prismarine-plugin

Start by executing the following command which will guide you through a step-by-step process

$ npx @jsprismarine/create-prismarine-plugin

You can contribute to create-prismarine-plugin by visting https://github.com/JSPrismarine/create-prismarine-plugin

Navigating the project structure

index.ts
package.json
index.ts
import type { PluginApi } from '@jsprismarine/prismarine';
export default class PluginBase {
api: PluginApi;
constructor(api: PluginApi) {
this.api = api;
}
public async onEnable() { }
public async onDisable() { }
}
package.json
{
...
"prismarine": {
"apiVersion": "${apiVersion}",
"displayName": "${displayName}"
},
...
}