Unarelith/OpenMiner
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[docs] 'item', 'recipe', 'sky', 'tree', 'biome', 'dimension' documentation added.

Browse Source
This commit is contained in:
Quentin Bazin 2020-03-12 13:36:54 +01:00
parent d861627599
commit 292595e0fa
12 changed files with 646 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CONTRIBUTING.md
View File

@ -6,7 +6,7 @@ Contributions are **welcome** and will be fully **credited**.
- **Read the coding style** - Make sure you read the [coding style](https://github.com/Unarelith/OpenMiner/wiki/Coding-Style) before opening a pull request.
- **Document any change in behaviour** - Make sure any relevant documentation is kept up-to-date.
- **Document any change in behaviour** - Make sure any relevant [documentation](https://openminer.readthedocs.io/en/latest/) is kept up-to-date.
- **Create feature branches** - Don't ask us to pull from your master branch.

12
README.md
View File

@ -24,9 +24,17 @@ The long-term goal of this project is to provide a viable alternative to Minecra
## Wiki
- [Getting started](https://github.com/Unarelith/OpenMiner/wiki/Getting-Started)
- [Coding style](https://github.com/Unarelith/OpenMiner/wiki/Coding-Style)
- [Contributing](https://github.com/Unarelith/OpenMiner/blob/master/CONTRIBUTING.md)
- [Coding style](https://github.com/Unarelith/OpenMiner/wiki/Coding-Style)
- [Lua API](https://openminer.readthedocs.io/en/latest/lua-api-overview/)
- [Blocks](https://openminer.readthedocs.io/en/latest/lua-api-blocks/)
- [Block](https://openminer.readthedocs.io/en/latest/lua-api-block/)
- [Item](https://openminer.readthedocs.io/en/latest/lua-api-item/)
- [Recipe](https://openminer.readthedocs.io/en/latest/lua-api-recipe/)
- [Sky](https://openminer.readthedocs.io/en/latest/lua-api-sky/)
- [Tree](https://openminer.readthedocs.io/en/latest/lua-api-tree/)
- [Biome](https://openminer.readthedocs.io/en/latest/lua-api-biome/)
- [Dimension](https://openminer.readthedocs.io/en/latest/lua-api-dimension/)
- [Network Protocol](https://github.com/Unarelith/OpenMiner/wiki/Network-Protocol)
## Keys

8
docs/index.md
View File

@ -11,7 +11,13 @@
- [Contributing](https://github.com/Unarelith/OpenMiner/blob/master/CONTRIBUTING.md)
- [Coding Style](https://github.com/Unarelith/OpenMiner/wiki/Coding-Style)
- [Lua API](lua-api-overview.md)
- [Blocks](lua-api-blocks.md)
- [Block](lua-api-block.md)
- [Item](lua-api-item.md)
- [Recipe](lua-api-recipe.md)
- [Sky](lua-api-sky.md)
- [Tree](lua-api-tree.md)
- [Biome](lua-api-biome.md)
- [Dimension](lua-api-dimension.md)
- [Network Protocol](https://github.com/Unarelith/OpenMiner/wiki/Network-Protocol)
## Other

214
docs/lua-api-biome.md Normal file
View File

@ -0,0 +1,214 @@
# Lua API: Biome
## Example
```lua
mod:biome {
id = "desert",
name = "Desert",
params = {
temperature = -0.3,
precipitation = -0.7
},
trees = {
{
type = "default:tree_cactus",
probability = 0.001,
}
},
flora = {
{
block = "default:deadbush",
spawns_on = "default:sand",
probability = 0.005,
}
},
top_block = "default:sand",
ground_block = "default:sand",
deep_block = "default:stone",
beach_block = "default:sand",
liquid_block = "default:water",
portal_block = "default:portal",
portal_frame_block = "default:obsidian",
}
```
## Attributes
### `id`
ID of the biome. **Mandatory field.**
Example:
```lua
id = "biome_desert"
```
IDs are usually of the form `mod:biome` but the `mod:` prefix is prepended automatically so it's not needed.
### `name`
Label of the biome. **Mandatory field.**
Example:
```lua
name = "Desert"
```
This label is the name that will appear everywhere in the game.
### `params`
Parameters used to generate the biome.
Example:
```lua
params = {
temperature = -0.3,
precipitation = -0.7
}
```
Current valid parameters are:
- `temperature`
- `precipitation`
### `top_block`
String ID of the block used on the top of the terrain.
Example:
```lua
top_block = "default:grass"
```
### `ground_block`
String ID of the block used for the upper part of the terrain, under `top_block`.
Example:
```lua
ground_block = "default:dirt"
```
### `deep_block`
String ID of the block used for the lower part of the terrain, below `ground_block`.
Example:
```lua
deep_block = "default:stone"
```
### `beach_block`
String ID of the block used around and under `liquid_block`.
Example:
```lua
beach_block = "default:sand"
```
### `liquid_block`
String ID of the block used to make lakes under `SEALEVEL` (see EngineConfig.hpp).
Example:
```lua
liquid_block = "default:water"
```
### `portal_block`
String ID of the block used to generate portal center.
Example:
```lua
portal_block = "default:portal"
```
**Note:** This attribute is temporary and will get removed soon.
### `portal_frame_block`
String ID of the block used to generate portal frame.
Example:
```lua
portal_frame_block = "default:obsidian"
```
**Note:** This attribute is temporary and will get removed soon.
### `trees`
Table that defines tree placement.
Example:
```lua
trees = {
{
type = "default:oak",
probability = 0.01
},
{
type = "default:cactus",
probability = 0.001
}
}
```
Possible attributes:
- `type`: String ID of the tree definition
- `probability`: Probability to spawn this tree
### `flora`
Table that defines flora placement.
Example:
```lua
flora = {
{
block = "default:tallgrass",
spawns_on = "default:grass",
probability = 0.25
},
{
block = "default:dandelion",
spawns_on = "default:grass",
probability = 0.025
}
}
```
Possible attributes:
- `block`: Block used as flora
- `spawn_on`: What the block below must be
- `probability`: Probability to spawn `block`
### `ores`
Table that defines ore placement.
Example:
```lua
ores = {
{
block = "default:iron_ore",
probability = 0.0003,
size = 8
}
}
```
Possible attributes:
- `block`: Ore block to be used
- `probability`: Probability to spawn an ore vein with that block
- `size`: Ore vein size

15
docs/lua-api-blocks.md → docs/lua-api-block.md
View File

@ -1,4 +1,4 @@
# Lua API: Blocks
# Lua API: Block
## Example
@ -45,11 +45,20 @@ tiles = "myblock.png"
tiles = {"myblock_top.png", "myblock_bottom.png", "myblock_side.png"}
```
More documentation will come on the table form.
Table format:
```cpp
// namely: West, East, South, North, Bottom, Top
{0, 0, 0, 0, 0, 0}, // for size = 1
{1, 1, 1, 1, 0, 0}, // for size = 2
{2, 2, 2, 2, 1, 0}, // for size = 3
{2, 3, 3, 3, 1, 0}, // for size = 4
{2, 3, 4, 4, 1, 0}, // for size = 5
{2, 3, 4, 5, 1, 0}, // for size = 6
```
The textures will be loaded from `mods/<your-mod>/textures/blocks`
**Note:** Currently, you can only use textures of the exact same size (16x16, 32x32) than the other block textures in the game.
**Note:** Currently, you can only use textures of the exact same size (16x16, 32x32) than the other block/item textures in the game.
### `harvest_requirements`

57
docs/lua-api-dimension.md Normal file
View File

@ -0,0 +1,57 @@
# Lua API: Dimension
## Example
```lua
mod:dimension {
id = "overworld",
name = "Overworld",
biomes = {"default:grassland", "default:desert"},
sky = "default:sky_overworld",
}
```
## Attributes
### `id`
ID of the dimension. **Mandatory field.**
Example:
```lua
id = "dimension_nether"
```
IDs are usually of the form `mod:dimension` but the `mod:` prefix is prepended automatically so it's not needed.
### `name`
Label of the dimension. **Mandatory field.**
Example:
```lua
name = "Nether"
```
This label is the name that will appear everywhere in the game.
### `biomes`
Table containing all the string IDs of the possible biomes for this dimension.
Example:
```lua
biomes = {"default:grassland", "default:desert"}
```
### `sky`
String ID of the sky definition used for this dimension.
Example:
```lua
sky = "default:sky_nether"
```

82
docs/lua-api-item.md Normal file
View File

@ -0,0 +1,82 @@
# Lua API: Item
## Example
```lua
mod:item {
id = "myitem",
name = "My Item",
tiles = "myitem.png",
}
```
## Attributes
### `id`
ID of the item. **Mandatory field.**
Example:
```lua
id = "stick"
```
IDs are usually of the form `mod:item` but the `mod:` prefix is prepended automatically so it's not needed.
### `name`
Label of the item. **Mandatory field.**
Example:
```lua
name = "Stick"
```
This label is the name that will appear everywhere in the game.
### `tiles`
Texture of the item.
Example:
``` lua
tiles = "myblock.png"
```
The textures will be loaded from `mods/<your-mod>/textures/items`
**Note:** Currently, you can only use textures of the exact same size (16x16, 32x32) than the other block/item textures in the game.
### `harvest_capability`
For a tool, set which blocks are easier to mine.
**Note:** This attribute would need more doc but it'll probably get removed soon.
### `mining_speed`
For a tool, speed at which it mines the block.
Example:
```lua
mining_speed = 1 -- this is the default value
```
### `is_fuel`
Defines if the item is valid furnace fuel or not.
Example:
```lua
is_fuel = false -- this is the default value
```
### `burn_time`
Burn time of a fuel item.
Example:
```lua
burn_time = 200 -- example value for a coal item, default is 0
```

14
docs/lua-api-overview.md
View File

@ -72,10 +72,6 @@ mod:smelting_recipe {
}
```
Documented API so far:
- [Blocks](lua-api-blocks.md)
### Custom GUI
You can create a new GUI with:
@ -157,11 +153,11 @@ gui:image {
- `Sky get_sky_from_string(string id)`
- `Tree get_tree_from_string(string id)`
- `Biome get_biome_from_string(string id)`
- `List<Block> blocks()`
- `List<Item> items()`
- `List<Tree> trees()`
- `List<Biome> biomes()`
- `List<Dimension> dimensions()`
- `Block[] blocks()`
- `Item[] items()`
- `Tree[] trees()`
- `Biome[] biomes()`
- `Dimension[] dimensions()`
### World

121
docs/lua-api-recipe.md Normal file
View File

@ -0,0 +1,121 @@
# Lua API: Recipe
## Example
### Crafting recipe
```lua
mod:crafting_recipe {
result = {
id = "default:wooden_axe",
amount = 1
},
pattern = {
"##",
"#|",
" |"
},
keys = {
['#'] = "default:oak_planks",
['|'] = "default:stick",
}
}
```
### Smelting recipe
```lua
mod:smelting_recipe {
input = {
id = "default:iron_ore",
amount = 1
},
output = {
id = "default:iron_ingot",
amount = 1
}
}
```
## Attributes
### Crafting recipe
#### `result`
Item stack created with the craft.
Example
```lua
result = {
id = "default:wooden_axe",
amount = 1
}
```
Possible attributes:
- `id`: String ID of the item created.
- `amount`: Amount of items in the created stack
#### `pattern`
Pattern of the craft.
Example:
```lua
pattern = {
"##",
"#|",
" |",
}
```
#### `keys`
Mapping of the characters used in `pattern` to actual item string IDs.
Example:
```lua
keys = {
['#'] = "default:oak_planks",
['|'] = "default:stick",
}
```
### Smelting recipe
#### `input`
Item stack used as input for the recipe.
Example:
```lua
input = {
id = "default:cobblestone",
amount = 1
}
```
Possible attributes:
- `id`: String ID of the item created.
- `amount`: Amount of items in the created stack
#### `output`
Item stack created with the recipe.
Example:
```lua
output = {
id = "default:stone",
amount = 1
}
```
Possible attributes:
- `id`: String ID of the item created.
- `amount`: Amount of items in the created stack

59
docs/lua-api-sky.md Normal file
View File

@ -0,0 +1,59 @@
# Lua API: Sky
## Example
```lua
mod:sky {
id = "sky_overworld",
color = {
day = {50, 153, 204},
},
fog_color = {
day = {50, 153, 204},
},
}
```
## Attributes
### `id`
ID of the sky. **Mandatory field.**
Example:
```lua
id = "sky_nether"
```
IDs are usually of the form `mod:sky` but the `mod:` prefix is prepended automatically so it's not needed.
### `color`
Sky color.
Example:
```lua
color = {
day = {154, 50, 33}
}
```
Possible values:
- `day`: Sky color at midday
### `fog_color`
Fog color.
Example:
```lua
fog_color = {
day = {154, 50, 33}
}
```
Possible values:
- `day`: Fog color at midday

70
docs/lua-api-tree.md Normal file
View File

@ -0,0 +1,70 @@
# Lua API: Tree
## Example
```lua
mod:tree {
id = "oak",
log_block = "default:oak_wood",
leaves_block = "default:oak_leaves",
trunk_height = {
min = 3,
max = 6
},
}
```
## Attributes
### `id`
ID of the tree. **Mandatory field.**
Example:
```lua
id = "tree_oak"
```
IDs are usually of the form `mod:tree` but the `mod:` prefix is prepended automatically so it's not needed.
### `log_block`
String ID of the block used as a log.
Example:
```lua
log_block = "default:oak_wood"
```
### `leaves_block`
String ID of the block used as leaves if `has_leaves` is set to `true`.
Example:
```lua
leaves_block = "default:oak_leaves"
```
### `has_leaves`
Defines if the tree has leaves or not.
Example:
```lua
has_leaves = true -- this is the default value
```
### `trunk_height`
Minimum and maximum trunk height.
Example:
```lua
trunk_height = {
min = 3,
max = 6
}
```

11
mkdocs.yml
View File

@ -4,12 +4,17 @@ nav:
- 'Home': 'index.md'
- 'Lua API':
- 'Overview': 'lua-api-overview.md'
- 'Blocks': 'lua-api-blocks.md'
- 'Block': 'lua-api-block.md'
- 'Item': 'lua-api-item.md'
- 'Recipe': 'lua-api-recipe.md'
- 'Sky': 'lua-api-sky.md'
- 'Tree': 'lua-api-tree.md'
- 'Biome': 'lua-api-biome.md'
- 'Dimension': 'lua-api-dimension.md'
theme:
name: readthedocs
highlightjs: true
hljs_languages:
- yaml
- rust
- lua