Skip to content
Common Mob Interface - Standardize the concept of a "mob" in Minetest
Lua
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
doc
COPYING
IMPLEMENTING.md
README.md
depends.txt
description.txt
devnotes
init.lua
mod.conf

README.md

Common Mob Interface

Purpose

There are multiple mob frameworks which provide APIs for creating mobs. This is good since it gives modders a variety of different ways to make mobs, and one framework might be more suited to making a particular mob than another. But implicitly they also all provide their own API for "using" mobs: things like checking if an entity is a mob or doing things on mob death. This is bad because modders who want to interface with mobs created by other modders need to code to as many interfaces as there are mob frameworks. CMI is a mod that provides the "one true mob interface". It is designed to be extensible and easy to integrate.

Usage

Usage documentation is provided as LDoc comments in the source files. To get nicely-formatted docs, you can run ldoc on init.lua.

Implementing in your mob mod/framework

Part of the implementation of this interface is in the mods that support it. If you are a mob framework author or making a mob without a framework, and you want to support CMI, take a look at IMPLEMENTING.md.

You can’t perform that action at this time.