Skip to content
Rasmus Praestholm edited this page Dec 13, 2012 · 1 revision

Modding API

This is the official Modding API for Terasology, detailing each extension point and status of relevant development. You may also want to read the Modding Guide

The API consists of an overview of all extension points and their status, as well as brief descriptions of each and links to relevant JavaDoc pages. Or, at least, that's the plan, it isn't all done yet :D

Overview

List all the things! That can serve as extension points for Terasology, that is. Please ask questions and provide feedback in the Forum Modding Doc Thread

Implemented

  • Components - for storing data and assigning behavior to entities (blocks, creatures, tools, etc)
  • Systems - for the logic to process entities with Components relevant to the System
  • Events - for communication between systems
  • Actions - similar to events, need more detail
  • Blocks - definitions & textures simply go in the right spot, no need to extend anything
  • Commands - can be included by implementing CommandProvider and using annotations for descriptions

Pending

  • Per-block data - see this thread
  • GUI modding - see this thread
  • Generators - for terrain creation
  • Game modes - predefined selections of mods / settings for a play style

Components

Systems

Related Links