Skip to content

SkriptDev/SampleAddon

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SampleAddon

A sample HySkript addon.

This version of the addon is made as a Plugin.
The build will go in your mods folder.

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.

Hytale Plugin Manifest

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

{
  "Main": "com.github.skriptdev.addon.SampleAddonPlugin",
  "Group": "MyAddon",
  "Name": "SampleAddon",
  "Version": "$addonVersion",
  "ServerVersion": "$serverVersion",
  "Description": "A sample addon",
  "Website": "https://github.com/SkriptDev/SampleAddon",
  "Authors": [
    {
      "Name": "ShaneBee",
      "Url": "https://github.com/ShaneBeee"
    }
  ],
  "LoadBefore": {
    "skript:HySkript": "*"
  },
  "Dependencies": {},
  "OptionalDependencies": {},
  "DisabledByDefault": false,
  "IncludesAssetPack": false
}
  • Main = The main class of your plugin (Required).
  • Group = The group of your plugin (Required).
  • Name = The name of your plugin (Required).
  • Version = The version of your plugin (Required).
  • ServerVersion = The version of Hytale your plugin is compatible with [Optional - But is recommended].
  • Description = A short description of your plugin [Optional].
  • Website = A link to your plugin's website [Optional].
  • Authors = A list of authors of your plugin [Optional].
  • LoadBefore = A list of plugins that your plugin will load before (you are required to include "skript:HySkript" or your addon may not load correctly) [Optional].
  • Dependencies = A list of dependencies for this plugin [Optional].
  • OptionalDependencies = A list of optional dependencies for this plugin [Optional].
  • DisabledByDefault = Whether this plugin is disabled by default [Optional].
  • IncludesAssetPack = Whether this plugin includes an asset pack [Optional].

See HytaleDocs for further information.

Build

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

Usage

To use this addon, place the jar file in your Hytale mods 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.

About

A sample HySkript addon

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages