SampleAddon

A sample HySkript addon.

You can dig through the code to learn how to make an addon.
This addon demonstrates how to create a basic HySkript addon with type registration and syntax registration.

Structure

You can structure your addon however you want.
You do however have to make sure to follow the simple steps in the main SampleAddon class to ensure your addon works properly.

Manifest

The addon manifest is located in src/main/resources/manifest.json.
This file tells HySkript how to load your addon.
The format is as follows:

{
  "Main": "com.github.skriptdev.addon.SampleAddon",
  "Name": "SampleAddon",
  "Version": "$addonVersion",
  "Description": "A sample addon",
  "Website": "https://github.com/SkriptDev/SampleAddon",
  "Authors": [
    "ShaneBee"
  ]
}

• Main = The main class of your addon (Required).
• Name = The name of your addon (Required).
• Version = The version of your addon (Required).
• Description = A short description of your addon [Optional].
• Website = A link to your addon's website [Optional].
• Authors = A list of authors of your addon [Optional].

Build

Simply run ./gradlew build to build your addon.
It will output a jar file in build/libs.

Usage

To use this addon, place the jar file in your HySkript addons folder and restart your server.

License

You can use whichever license you want, as long as you follow the terms of the license you choose.