forked from mtcontrib/x_enchanting
188 lines
5.8 KiB
Markdown
188 lines
5.8 KiB
Markdown
# Enchanting Table and API [x_enchanting]
|
|
|
|
Adds Enchanting Mechanics and API.
|
|
|
|
|
|
|
|
## Features
|
|
|
|
* does not add new tools/items, it's using MT API to change existing items instead
|
|
* adds enchanting table
|
|
* supports all registered tools with known tool groups: pickaxe, shovel, axe, sword, e.g. `groups = {pickaxe = 1}`
|
|
* supports all bows with group `{bow = 1}`
|
|
* supports `default:bookshelf` or anything with `group:bookshelf`
|
|
* enchanting trade is for `default:mese_crystal` or anything with `groups = {enchanting_trade = 1}`
|
|
* adds enchantability for all MT default tools, for custom tools the enchantability can be set in the item group, e.g. `groups = {enchantability = 15}`
|
|
* uses only MT engine mechanics (e.g. tool capabilities)
|
|
* enchanted items have detailed enchantments description/short description
|
|
* mesh node model
|
|
* mesh entity model and animations
|
|
* tool texture will have enchanted glint
|
|
* adds grind stone to remove enchantments (excluding curses)
|
|
|
|
## How To
|
|
|
|
### Enchanting Setup
|
|
|
|
For maximum level of enchantments you need maximum of 15 bookshelfs around the enchanting table, maximum of 2 blocks away. Maximum level is 30.
|
|
|
|
### Enchanting Table
|
|
|
|
To be able to enchant items you need a trade item (by default `default:mese_crystal` or anything with `groups = {enchanting_trade = 1}`). Higher level enchantments costs more: level 1,2,3 costs mese crystals 1,2,3.
|
|
When place item in the enchantment table item slot you can see three buttons with:
|
|
- left side the trade cost amount
|
|
- middle the enchantment you will get + maybe more enchantments
|
|
- right side the base level for the enchantment (depends on how many bookshelfs are in reach)
|
|
When you place item in the enchantment table trade slot you will see that some buttons are now enabled and can be clicked on - depends on trade amount available.
|
|
The enchantments shown in the enchantment table will be always the same for item - this will change after you enchant an item. After enchanting an item a new enchantments will be shown.
|
|
|
|
### Item Enchantability
|
|
|
|
All default tools have enchantability set. Higher enchantability = higher chance of getting better enchantments.
|
|
Items enchantibility from worst to best:
|
|
- stone
|
|
- diamond
|
|
- steel
|
|
- wood / mese
|
|
- bronze
|
|
|
|
### Every Enchantment Explained
|
|
|
|
#### Sharpness
|
|
|
|
Increases melee damage.
|
|
|
|
groups: sword
|
|
|
|
#### Fortune
|
|
|
|
Increases the number and/or chances of specific item drops. Works with groups: stone, soil, sand, snowy, slippery, tree, leaves and all registered ores.
|
|
|
|
Incompatible: Silk Touch
|
|
|
|
groups: pickaxe, shovel, axe
|
|
|
|
#### Unbreaking
|
|
|
|
Increases the item's durability.
|
|
|
|
groups: any
|
|
|
|
#### Efficiency
|
|
|
|
Increases the player's mining speed. Also adds mining groupcaps to item, e.g. enchanted wood pickaxe can mine level 1 nodes (e.g. obsidian) after enchantment.
|
|
|
|
groups: pickaxe, shovel, axe
|
|
|
|
#### Silk Touch
|
|
|
|
Causes certain blocks to drop themselves as items instead of their usual drops when mined. Mods can prevent this behaviour with adding group `{ no_silktouch = 1 }` to the nodes.
|
|
|
|
Incompatible: Fortune
|
|
|
|
groups: pickaxe, shovel, axe
|
|
|
|
#### Curse of Vanishing
|
|
|
|
Causes the item to disappear on death.
|
|
|
|
groups: any
|
|
|
|
#### Knockback
|
|
|
|
Increases knockback (players only).
|
|
|
|
groups: sword
|
|
|
|
#### Looting
|
|
|
|
Cause mobs to drop more items. This value is not used in the engine; it is the responsibility of the game/mod code to implement this.
|
|
|
|
Supported: mobs_monster, mobs_animal, animalia
|
|
|
|
groups: sword
|
|
|
|
#### Power
|
|
|
|
Increases arrow damage.
|
|
Damage has to be calculated in the MOD where the bow comes from!
|
|
|
|
groups: bow
|
|
|
|
#### Punch
|
|
|
|
Increases arrow knockback.
|
|
Knockback has to be calculated in the MOD where the bow comes from!
|
|
|
|
This can be obtained from tool meta:
|
|
|
|
groups: bow
|
|
|
|
#### Infinity
|
|
|
|
Prevents regular arrows from being consumed when shot.
|
|
One arrow is needed INSIDE QUIVER to use a bow enchanted with Infinity.
|
|
Fired arrows cannot be retrieved even if they are not fired from Quiver.
|
|
Only set in item meta, logic for this has to be in the MOD where the bow comes from!
|
|
|
|
groups: bow
|
|
|
|
## API
|
|
|
|
`ItemStackMetaRef`
|
|
|
|
* `get_float(key)`: Returns `0` if key not present. `key` can be enchantment id prefixed with `is_`,
|
|
e.g. enchantment `punch` would have stored meta as `is_punch`. If returned value is bigger than zero
|
|
then the value represents enchantment level bonus. See below fields for bow:
|
|
* `power` Increase percentage
|
|
* `punch` Multiplier
|
|
* `infinity` If `1` then it is infinity enchanted
|
|
* `get_string(key)`: Returns `""` if key not present. See below fields for all enchantments:
|
|
* `x_enchanting` Serialized table with key/value pairs where: `key` is enchantment `id` and `value` is `Enchantment` definition
|
|
|
|
`Enchantment` definition
|
|
|
|
* `value` number, Value of the enchantment based on level, e.g. multiplier, percentage/number increase...
|
|
|
|
example:
|
|
|
|
```lua
|
|
-- For simplicity assuming that all meta are present (biggger than zero or not "")
|
|
-- MODs have to add those checks individually
|
|
|
|
local itemstack_meta = itemstack:get_meta()
|
|
|
|
local power_value = itemstack_meta:get_float('is_power')
|
|
local punch_value = itemstack_meta:get_float('is_punch')
|
|
local infinity_value = itemstack_meta:get_float('is_infinity')
|
|
|
|
-- Or for list of all enchantments
|
|
local x_enchanting = minetest.deserialize(itemstack_meta:get_string('x_enchanting')) or {}
|
|
local power_enchantment = enchantments.power
|
|
local punch_enchantment = enchantments.punch
|
|
local infinity_enchantment = enchantments.infinity
|
|
|
|
-- Custom logic
|
|
local new_damage = damage + damage * (punch_enchantment.value / 100)
|
|
local new_knockback = knockback * punch_enchantment.value
|
|
|
|
if enchantments.infinity.value > 0 then
|
|
-- Some logic for infinity
|
|
end
|
|
```
|
|
|
|
## Dependencies
|
|
|
|
- none
|
|
|
|
## Optional Dependencies
|
|
|
|
- xdecor (adjusts conflicting recipe)
|
|
- item_drop (make sure fortune will execute before item_drop mod overrides `handle_node_drops`)
|
|
|
|
## License:
|
|
|
|
### Code
|
|
|
|
GNU Lesser General Public License v2.1 or later (see included LICENSE file)
|