History

octacian 8bb8a49701 Add `disabled` definition property		2017-03-01 17:30:50 -08:00
..
storage	Document public API	2017-02-24 12:26:22 -08:00
api.md	Add `disabled` definition property	2017-03-01 17:30:50 -08:00
modules.md	Added Ores module	2017-02-26 09:12:52 -08:00
README.md	Document public API	2017-02-24 12:26:22 -08:00

README.md

Documentation

The APIs provided by MicroExpansion are divided among several different files. Unless otherwise mentioned, the .md documentation file is labeled the same as the Lua file containing the code. However, for modules, documentation is found in a subdirectory. Below, the main documentation sections are found before being divided depending on the module.

`modules.md`

Non-API portions of MicroExpansion are loaded as modules to allow them to be easily enabled or disabled. This documents the API for loading, configuring, and interacting with modules.

`api.lua`

This section documents the "core" API that is always loaded before any modules (api.lua). This API is mostly made up of functions to make registering items, nodes, and recipes quicker and more intuitive.