Information

Details

With this plugin you can allow your players to purchase and spawn in custom geometry entities using the Decorations shop UI! Everything is configurable in the decorations.json config file including price, spawn limits, entity scale, and more!

Usage

Use /deco to access the main interface. From there you can enter the shop or view your archived decorations. By selecting an item in your archive, you have the option to sell or spawn the decoration. In the shop, you can select what category you'd like to browse. Once you pick a category, choose an item to purchase and proceed to the pre-purchase form. The pre-purchase form is where you can choose how many to buy, but also choose where you'd like the item to be exported to once you purchase it (inventory or decoration archive). Once bought, you can spawn it by tapping the item on the block of where you want it to be. You have the ability, as the decoration owner, to view the decoration options by hitting it. This screen allows you to sell, archive, and pick up the decoration for easier transport or movement adjustments. You can also edit the entity's yaw and pitch along with fine tune the XYZ coordinates using sliders!

JSON Configuration

Please see the default JSON file here for a more detailed example of how categories and entries should be entered.

Here is the JSON file broken down into separate parts.

Category name

"dishes": {

Category format

"format": "§dDishes",

Entity list

"entities": [

Entry ID

"id": "mug",

Geometry file name

"geometry": "mug.geo.json",

Geometry identifier

"identifier": "geometry.mug",

Entity texture

"texture": "mug.png"

Entity rotation

"rotation": {
  "yaw": 30,
  "pitch": 0
},

Entity size

"scale": 0.4,

Allowed size

"scale-range": {
  "min": 0.1,
  "max": 2
},

Entry format

"format": "§6Coffee mug",

Entity buy price

"price": 20,

Entity spawn limit

"limit": 3,

Entity name tag

"nametag": "§aDrink me!"

The following table is used to determine a key's optionality.

In the end, your JSON entry will look something like this:

{
  "dishes": {
    "format": "§dDishes",
    "entities": [
      {
        "id": "mug",
        "model": {
          "geometry": "mug.geo.json",
          "identifier": "geometry.mug",
          "texture": "mug.png"
        },
        "rotation": {
          "yaw": 30,
          "pitch": 0
        },
        "scale": 0.4,
        "scale-range": {
          "min": 0.1,
          "max": 2
        },
        "format": "§6Coffee mug",
        "price": 20,
        "limit": 3,
        "nametag": "§aDrink me!"
      }
    ]
  }
}