https://github.com/mineinabyss/looty

Highly configurable custom items for Minecraft
https://github.com/mineinabyss/looty

ecs kotlinx-serialization minecraft spigot

Last synced: 10 months ago
JSON representation

Highly configurable custom items for Minecraft

• Host: GitHub
• URL: https://github.com/mineinabyss/looty
• Owner: MineInAbyss
• License: mit
• Created: 2020-10-21T17:01:02.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-03-16T19:22:33.000Z (about 2 years ago)
• Last Synced: 2024-04-17T22:49:10.785Z (about 2 years ago)
• Topics: ecs, kotlinx-serialization, minecraft, spigot
• Language: Kotlin
• Homepage:
• Size: 411 KB
• Stars: 6
• Watchers: 6
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

          


# Looty

[![Maven](https://img.shields.io/maven-metadata/v?metadataUrl=https://repo.mineinabyss.com/releases/com/mineinabyss/looty/maven-metadata.xml)](https://repo.mineinabyss.com/#/releases/com/mineinabyss/looty)

[![Contribute](https://shields.io/badge/Contribute-e57be5?logo=github%20sponsors&style=flat&logoColor=white)](https://wiki.mineinabyss.com/contribute)



Looty is a [Paper](https://papermc.io/) plugin for creating custom items with config files. We extend on basic item functionality in [Geary](https://github.com/MineInAbyss/geary-papermc) to help create complicated items all in config.

## Features

- Useful components like `hat` to make any item wearable, or `food` to create food items with custom effects.

- Support for custom recipes

- Write configs in yaml, json, and more.

## Usage

Coming soon

## Examples

### Custom item from our server

`star-compass.yml`

```yaml

# Make items in the same inventory share one entity

- !

# Specify item name, model, and lore,

# if this ever changes, Looty will update existing items

- !

  item:

    type: PAPER

    customModelData: 125

    displayName: Star Compass

    lore:

      - Points towards the center of the Abyss

# Add a recipe using other custom items

- !

  discoverRecipes: true

  recipes:

    - !

      items:

        - prefab: mineinabyss:star_compass_needle

        - prefab: mineinabyss:titanjaw_pearl

# A component provided another plugin

- !

```

### Custom recipe for a vanilla item

`lead.yml`

```yaml

- !

  discoverRecipes: true

  result:

    type: LEAD

    amount: 2

  removeRecipes:

    - minecraft:lead

  group: "looty:lead"

  recipes:

    - !

      items:

        S:

          prefab: mineinabyss:silkfang_silk

        Z:

          prefab: mineinabyss:abyssal_snail_gunk

      configuration: |-

        |ZZ |

        |ZS |

        |  Z|

```