Template:Zh ManagedKits Description Config: Difference between revisions

From Documentation
Jump to navigation Jump to search
(Created page with "== Plugin configuration ==")
 
 
(21 intermediate revisions by the same user not shown)
Line 1: Line 1:
== Plugin configuration ==
== Plugin configuration ==
There are two files to configure plugin
=== config.yml ===
This file you can change to set common plugin properties.
{|class="zhpropertytable"
|-
|class="zhproperty"|economy_enabled||class="zhdescription"|Support Economy API
0 - disabled
1 - enabled
|-
|class="zhproperty"|default_kit_enabled||class="zhdescription"|Give default kit to new players
0 - disabled
1 - enabled
|-
|class="zhproperty"|sign_enabled||class="zhdescription"|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
<pre>
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
</pre>
{|class="zhpropertytable"
|-
|class="zhproperty"|Simple:||class="zhdescription"|Kit name ('''KitName'''), it used for kit list and access to kit definition
This kit has name '''Simple'''
|-
|class="zhproperty"|  name:||class="zhdescription"|Kit name property, currently not in use, but reserved. Use the same name as '''KitName'''
|-
|class="zhproperty"|  description:||class="zhdescription"|Kit description
|-
|class="zhproperty"|  price:||class="zhdescription"|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
|-
|class="zhproperty"|  status:||class="zhdescription"|Kit initial status
0 - enabled
1 - disabled
|-
|class="zhproperty"|  locked_time:||class="zhdescription"|Time in seconds, while this kit will be unavailable for use by player again
|-
|class="zhproperty"|  hidden:||class="zhdescription"|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
|-
|class="zhproperty"|  items:||class="zhdescription"|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
|-
|class="zhproperty"|    "298": 1||class="zhdescription"|Item with ID = 298, and quantity = 1
In this case player will get 1 item with ID 298
|-
|class="zhproperty"|  "299": 1||class="zhdescription"|Item with ID = 299, and quantity = 1
The others the same
|}

Latest revision as of 23:12, 11 May 2016

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

Retrieved from "https://wiki.zhuk.cc/index.php?title=Template:Zh_ManagedKits_Description_Config&oldid=2581"