Living

The Living library provides tools for creating and managing living entities within the Minecraft world. Whether you're spawning custom mobs or adding unique behaviors to existing ones, Living offers an easy-to-use framework for implementing complex entity logic.

Importing Living into your project:

You may import Living by running the following command:

go get github.com/bedrock-gophers/living

Adding a Living Entity to Your World

To add a living entity to your world, you can use the following example code:

func accept(p *player.Player) {
    opts := world.EntitySpawnOpts{
        Position: p.Position(),
    }

    conf := living.Config{
        EntityType: entityTypeEnderman{},
        Handler:    handler{},
        Drops: []living.Drop{
            living.NewDrop(item.EnderPearl{}, 0, 2),
        },
    }
    p.Tx().AddEntity(opts.New(conf.EntityType, conf))
}

Creating and Handling a living entity

To create and handle a living entity, you can use the following example code:

// Define a custom entity type for Enderman.
type entityTypeEnderman struct{}

// EncodeEntity ...
func (entityTypeEnderman) EncodeEntity() string {
	return "minecraft:enderman"
}

// BBox ...
func (entityTypeEnderman) BBox(world.Entity) cube.BBox {
	return cube.Box(-0.3, 0, -0.3, 0.3, 2.9, 0.3)
}

// handler represents a basic event handler for our endermen.
type handler struct {
	living.NopHandler
}

// HandleHurt ...
func (handler) HandleHurt(ctx living.Context, damage float64, immune bool, immunity *time.Duration, src world.DamageSource) {
	fmt.Println("enderman hurt")
}

This code defines an example of creating an Enderman entity type and implementing a custom event handler for handling hurt events. You can extend this pattern to implement various other behaviors and interactions for your living entities.

Configurable movement and knockback

living.Config accepts a MovementSimulator and KnockbackCalculator when an entity needs movement or impulse rules other than Dragonfly's defaults. Both interfaces run synchronously inside the entity's world transaction.

Player-shaped NPCs

The npc package builds server-controlled, player-shaped entities on top of Living. An NPC owns its skin, inventories, armour, effects, combat state, and event handler, while movement and knockback remain configurable through its embedded living.Config.

handle := world.EntitySpawnOpts{Position: position}.New(npc.Type, npc.Config{
	Name: "Practice Bot",
	Living: living.Config{
		MovementComputer: &entity.MovementComputer{Gravity: 0.08, Drag: 0.02},
		Knockback:        knockbackCalculator,
	},
})
tx.AddEntity(handle)