HollaEx
Search…
Overview

JSON Object Layout

HollaEx Kit plugins can be installed, enabled, disabled, and updated on the fly. The basic plugin structure is in the form of a JSON object.
1
{
2
name: 'string',
3
type: 'string',
4
version: 'number',
5
bio: 'string',
6
description: 'string',
7
author: 'string',
8
public_meta: 'object',
9
meta: 'object',
10
prescript: {
11
install: 'array',
12
run: 'string'
13
},
14
postscript: {
15
run: 'string'
16
},
17
script: 'string',
18
web_view: 'array',
19
admin_view: 'string'
20
}
Copied!
Let's go over each key in this JSON object.

Name

The name of your plugin must not include spaces and has to be unique from all other plugins installed on your Kit.

Type

The type of this plugin. This value can be set to null. If this value is set, no other plugin with the same type can be installed.

Version

The version of your plugin is important when it comes to upgrading.

Bio

The bio is a short description for your plugin that shows in the plugin list on the blue admin panel.

Description

The description is the full description of your plugin shown on the plugin page.

Author

The author that is shown on the plugin page.

Public_meta

The public_meta object holds all public values used in the plugin that can be changed while the plugin is running. It should hold values that are publicly available.

Meta

The meta object holds all private values used in the plugin that can be changed while the plugin is running. It should hold values for unique keys, secrets, etc.

Prescript

The prescript object holds two fields, install, and run. install is an array of strings. Each string is the name of the NPM library the plugin should install before running. run is a bash script ran before the plugin is enabled. Currently, the run feature is not enabled.

Postscript

The postscript object holds the field run. run is a bash script ran after the plugin is enabled. Currently, the run feature is not enabled.

Script

This is the ES6+ script for your plugin. When enabled, this script will run. The script should be passed as a minified string.

Web_view

This field will contain the plugin's web client code. This functionality is currently not available.

Admin_view

This field will contain the plugin's admin client code.
Last modified 2mo ago