https://github.com/mineinabyss/mobzy

Config-driven custom mobs for Spigot using ECS
https://github.com/mineinabyss/mobzy

ecs kotlinx-serialization minecraft nms-entity pathfinder-goals spigot

Last synced: about 2 months ago
JSON representation

Config-driven custom mobs for Spigot using ECS

• Host: GitHub
• URL: https://github.com/mineinabyss/mobzy
• Owner: MineInAbyss
• License: mit
• Created: 2018-07-29T22:48:31.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-04-27T16:38:10.000Z (9 months ago)
• Last Synced: 2024-04-27T17:37:08.743Z (9 months ago)
• Topics: ecs, kotlinx-serialization, minecraft, nms-entity, pathfinder-goals, spigot
• Language: Kotlin
• Homepage: https://mineinabyss.com/Mobzy/
• Size: 1.79 MB
• Stars: 42
• Watchers: 6
• Forks: 8
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        


# Mobzy

[![Java CI with Gradle](https://github.com/MineInAbyss/Mobzy/actions/workflows/gradle-ci.yml/badge.svg)](https://github.com/MineInAbyss/Mobzy/actions/workflows/gradle-ci.yml)

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

[![Wiki](https://img.shields.io/badge/-Project%20Wiki-blueviolet?logo=Wikipedia&labelColor=gray)](https://github.com/MineInAbyss/Mobzy/wiki)

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



Mobzy is a [Paper](https://papermc.io/) plugin for creating custom mobs with config files. We use [Geary](https://github.com/MineInAbyss/geary-papermc) to break down complex entities into small components. We provide many components to modify vanilla behaviour, for new game features check out [Geary-addons](https://github.com/MineInAbyss/Geary-addons).

## Features

- Extend any existing entity (including NMS entities if registered by another plugin)

- Simple ModelEngine support

- Customize pathfinder goals

- Our own custom spawning system

## Example

[**`plugins/Geary/mineinabyss/mobs/hostile/kuongatari.yml`**](https://github.com/MineInAbyss/server-config/blob/master/servers/minecraft/plugins/Geary/mineinabyss/mobs/hostile/kuongatari.yml)

```yaml

- ! # Inherits components from another prefab

  from: [mineinabyss:hostile]

- ! # Tells Minecraft which entity to use under the hood. You may register a custom type with NMS.

  baseClass: minecraft:zombie

  creatureType: MONSTER

- ! "<#1FB53D>Kuongatari" # Sets a colored display name

- ! # Uses a ModelEngine model

  modelId: kuongatari

- ! # Sets some pathfinder goals

  targets:

    1: !

      range: 200

    2: !

      range: 10

  goals:

    1: !

      seeThroughWalls: true

    2: !

      jumpHeight: 0.6

    4: !

```

## Project Wiki

We have an old [wiki](https://github.com/MineInAbyss/Mobzy/wiki) that we want to update soon. For now, you can ask us questions in `#plugin-dev` on our [Discord](https://discord.gg/QXPCk2y) server, or come help with development there!

You may also find our [generated docs](https://mineinabyss.com/Mobzy/) useful