Quick Start

Prerequisites

Installation

For production installs, download the latest release JAR. Build from source only when needed.

# 1. Build Kalo
git clone https://github.com/CyoriaSMP-Team/kalo.git
cd kalo
./gradlew build

# 2. Install plugin
cp build/libs/Kalo-*.jar /path/to/server/plugins/

# 3. Create content pack
mkdir -p plugins/Kalo/packs/myitem/configs
mkdir -p plugins/Kalo/packs/myitem/assets/textures/item

Run the pack creation commands from your server root after installing Kalo. Add a texture image to assets/textures/item/ruby_sword.png in your pack.

# plugins/Kalo/packs/myitem/pack.yml
id: myitem
version: 1.0.0
author: YourName

First Item

# plugins/Kalo/packs/myitem/configs/items.yml
ruby_sword:
  type: item
  display:
    name: "<red>Ruby Sword</red>"
    lore:
      - "<gray>A powerful sword</gray>"
  model:
    sprite: "item/ruby_sword"
  behaviour:
    durability: 1561
  java:
    base_material: DIAMOND_SWORD

Commands

CommandDescription
/kalo reloadReload all content packs
/kalo give <player> <item>Give a Kalo item
/kalo import <plugin>Migrate from other plugins