Home

Welcome to the UncomplicatedCustomItems or UCI official wiki!

Note

This wiki is for the v1.5.0 of the plugin

How to install UCI

UncomplicatedCustomItems is easy to download: get the latest relase and put it inside your EXILED/Plugin config.
Newtonsoft.Json is required, you can get it from the latest relase and you'll need to put it one time inside the dependencies folder.
After that you'll be fine even updating the plugin.

UCI Configuration

The configuration of UncomplicatedCustomItems is for now only inside the config-<port>.yml file, handled by EXILED.

Custom Item

This is the structure (before in C# and then in YAML).
If you are a developer please see the developer zone.

C#

        public abstract uint Id { get; set; }
        public abstract string Name { get; set; }
        public abstract string Description { get; set; }
        public abstract float Weight { get; set; }
        public abstract ItemType Item { get; set; }
        public abstract Vector3 Scale { get; set; }
        public abstract CustomItemType CustomItemType { get; set; }
        public abstract Dictionary<string, string> CustomData { get; set; }

YAML

  custom_items:
  - id: 1
    name: 'Detonator'
    description: 'An item that reminds me of 9/11'
    weight: 2
    item: Coin
    scale:
      x: 1
      y: 1
      z: 1
    custom_item_type: Item
    custom_data:
      event: Command
      command: /SERVER_EVENT DETONATION_INSTANT
      console_message: UHUHUHUH!
      broadcast_message: The broadcast uuhh!!!
      broadcast_duration: 3
      hint_message: Yamato is a femboy

Warning

This example is the example of an Item

Tip

If you see [enum] before a type you should see our type reference

uint id

The Id (unsigned int) identify a uniqe custom item.

string name

The name of the custom item.

string description

The description. Can be read with .uci read.

float weight

The weight of the custom item as pickup.

[enum]ItemType item

The item base of the custom item.

Vector3 scale

The item scale as pickup.

[enum]CustomItemType custom_item_type

The type of the custom item.
Please see the reference.

IData custom_data

A data object that contains specific item informations based on the custom_item_type.
Please see the reference.