Zh ManagedKits Description

From Documentation
Jump to: navigation, search

Installation

Plugin is installed on Minecraft Pocket Edition in a standard way through uploading into folder plugins on minecraft server.

Download archive. Unzip and upload phar file to the server.

Plugin supports Economy API €¢onom¥$ of onebone

Plugin configuration

There are two files to configure plugin


config.yml

This file you can change to set common plugin properties.

economy_enabled Support Economy API

0 - disabled

1 - enabled

default_kit_enabled Give default kit to new players

0 - disabled

1 - enabled

sign_enabled Enable feature to use signs for kits

0 - disabled

1 - enabled

kits.yml

In this file you can define your kits.

Lets to check this kit

Simple:
  name: "Simple"
  description: "kit with simple items"
  price: 0
  status: 1
  locked_time: 7200
  hidden: 0
  items:
    "298": 1
    "299": 1
    "300": 1
    "301": 1
    "273": 1
    "274": 1
    "275": 1
    "276": 1
Simple: Kit name (KitName), it used for kit list and access to kit definition

This kit has name Simple

name: Kit name property, currently not in use, but reserved. Use the same name as KitName
description: Kit description
price: Kit price, set zero if it's free kit

If you specify price more that zero and disable Economy API - that kit will be disabled

If you set negative price when enabled Economy API - that kit will be disabled

status: Kit initial status

0 - enabled

1 - disabled

locked_time: Time in seconds, while this kit will be unavailable for use by player again
hidden: Hidden for player or not. This property will be used in future development, and, for example, active kit can be hidden by setting this property and user can't access to it without special permissions. Default kit (default kit for new players) by default is hidden, players can't access to it.

0 - enabled

1 - hidden

items: Main parent node to define item list in kit

If this property will be not specified, or the details items will not entered, this kit will be disabled automatically

"298": 1 Item with ID = 298, and quantity = 1

In this case player will get 1 item with ID 298

"299": 1 Item with ID = 299, and quantity = 1

The others the same


Commands description

Command Permission Description
/kit
  • zhmanagedkits.kit.command
  • Server
Get all commands usage
/kit list
  • zhmanagedkits.kit.list.available
  • Server
Get list of active kits, you can see titles in different colors depends on it's status
  • white - enabled kit
  • purple - enabled kit, but limited (by time or by money)
  • gold - enabled kit with price (not free)
/kit list all
  • zhmanagedkits.kit.list.all
  • Server
Get list of all kits, you can see titles in different colors depends on it's status
  • gray - hidden kit
  • white - enabled kit
  • red - disabled kit
  • gold - enabled kit with price (not free)
/kit list disabled
  • zhmanagedkits.kit.list.disabled
  • Server
Get list of all disabled kits
/kit list hidden
  • zhmanagedkits.kit.list.hidden
  • Server
Get list of all hidden kits
/kit details KitName
  • zhmanagedkits.kit.details.available
  • zhmanagedkits.kit.details.all
  • Server
Get description of the kit KitName, you can see information about the kit, it's status and price (if Economy API is enabled)
/kit enable KitName
  • zhmanagedkits.kit.state.enable
  • Server
Enable the kit KitName, if the kit can't be enabled (due to configuration), it will be disabled
/kit enable all
  • zhmanagedkits.kit.state.enable
  • Server
Enable all available kits, if kit can't be enabled (due to configuration), it will be disabled
/kit disable KitName
  • zhmanagedkits.kit.state.disable
  • Server
Disable the kit KitName
/kit disable all
  • zhmanagedkits.kit.state.disable
  • Server
Disable all kits
/kit hide KitName
  • zhmanagedkits.kit.state.hide
  • Server
Hide the kit KitName
/kit hide all
  • zhmanagedkits.kit.state.hide
  • Server
Hide all available kits
/kit show KitName
  • zhmanagedkits.kit.state.show
  • Server
Set the kit KitName visible
/kit show all
  • zhmanagedkits.kit.state.show
  • Server
Set all available kits visible
/kit reload
  • zhmanagedkits.kit.config.reload
  • Server
Reload all kits from kit configuration file
/kit save
  • zhmanagedkits.kit.config.save
  • Сервер
Save current kits state into kits.yml config file
/kit get KitName
  • zhmanagedkits.kit.get
Give to a player the kit KitName. If he/she has permission to use (time, money...)

If Economy API is enabled, the price of the kit will be get

Description in examples

Plugin initialization, some valuable information is displayed

Kit-1-initialize.png


Server console commands

Call kit command

Kit-2-usage.png


Call kit list command

Kit-3-list.png


Call kit list all command

Kit-4-list-all.png


Call kit details command to get information about a kit

Kit-5-details.png


Call kit disable command to disable a kit.

If you disable a kit, all players get message about that.

Kit-6-disable.png


Call kit disable all command to disable all available kits

Kit-7-disable-all.png


Call kit enable command to enable a kit.

If you enable a kit, all players get message about that.

Kit-8-enable.png


Call kit enable all command to enable all available kits. If some kits can't be enabled, you'll see messages.

Kit-9-enable-all.png


Call kit reload command to reload kits, all changes in kits config file is applied.

Kit-10-reload.png


You can't call kit get command to get kit on a server. You can see error message.

Kit-11-get-server.png

Player commands

When player connected to the world first time, he/she will get default kit (if that enabled)

User-1-default-got-kit.png


Call /kit list command to see what kits are available

User-2-default-available-kits-after-got.png


Call /kit get Gold command to get kit with name Gold

User-3-gold-got-kit.png


Call /kit list command to see what kits are available. As you can see now Gold kit is enabled but unavailable.

User-4-gold-available-kits-after-got.png


Call /kit details Gold to see details of the kit.

User-5-gold-kit-details-after-got.png


Call /kit get Diamond command to get kit with name Diamond

User-6-diamond-got-kit.png


Now try again to call /kit get Diamond command to get kit with name Diamond again. You can see error message.

User-7-diamond-tried-to-get-kit-again.png


Now change price for Brilliant kit from 1000 to 10000. On that moment player haven't this amount of money.

Let's try to see available kits. You can see, that Brilliant kit unavailable.

Call /kit list command to see what kits are available.

User-8-brilliant-kit-list-locked-kit.png


Call /kit details Brilliant to see details of the kit. As you can see it is locked by money

User-9-brilliant-kit-details-for-locked-kit.png


Now try to call /kit get Brilliant command to get kit with name Brilliant which is unavailable due to insufficient amount of money. You can see error message.

User-10-brilliant-tried-to-get-locked-kit.png


Using signs

To create sing for kit you need:

  • Create sign
  • On the first line you have to write [zhManagedKits]
  • On the second line you have to write Your_KitName_To_Use


Language: English  • русский