Skip to content

Commit

Permalink
[docs/lua-api-mod.md] Added documentation about 'config.lua'.
Browse files Browse the repository at this point in the history
  • Loading branch information
Unarelith committed Jul 5, 2020
1 parent 1fd8999 commit 8fa3ba4
Showing 1 changed file with 23 additions and 1 deletion.
24 changes: 23 additions & 1 deletion docs/lua-api-mod.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,28 @@
# Lua API: Mod API Overview

## Introduction
## Intrduction

Mods are folders and they should contain at least two files:

- `init.lua`: your code
- `config.lua`: mod config (name, depedencies)

They are located in `mods` folder.

## Mod config

Here is an example of configuration:
```lua
mod_config = {
id = "creative_inventory",

dependencies = {"*default"}
}
```

The `*` before `default` means it's an optional dependency.

## How to use this API

You can create a mod using this function:
```
Expand Down

0 comments on commit 8fa3ba4

Please sign in to comment.