mirror of
https://github.com/YouHaveTrouble/Enchantio.git
synced 2026-10-26 12:25:28 +00:00
update the docs
This commit is contained in:
@@ -11,7 +11,7 @@ export default defineConfig({
|
|||||||
sidebar: [
|
sidebar: [
|
||||||
{
|
{
|
||||||
label: 'Documentation',
|
label: 'Documentation',
|
||||||
autogenerate: { directory: 'documentation' },
|
items: [{ autogenerate: { "directory": "documentation" } }]
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
label: 'Configuration',
|
label: 'Configuration',
|
||||||
|
|||||||
+2
-3
@@ -10,8 +10,7 @@
|
|||||||
"astro": "astro"
|
"astro": "astro"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@astrojs/starlight": "^0.34.3",
|
"@astrojs/starlight": "^0.42.4",
|
||||||
"astro": "^5.6.1",
|
"astro": "^7.2.10"
|
||||||
"sharp": "^0.32.5"
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -4,11 +4,41 @@ description: How to specify common input types in configuration
|
|||||||
---
|
---
|
||||||
|
|
||||||
## Tags
|
## Tags
|
||||||
There are 2 types of tags that can be used in the configuration:
|
|
||||||
- `minecraft:item_name` - For specific items, use namespaced vanilla item id. If namespace is not provided, `minecraft` is assumed.
|
### Items
|
||||||
- `#minecraft:item_tag_name` - For <a href="https://minecraft.wiki/w/Item_tag_(Java_Edition)" target="_blank">item tags</a>,
|
|
||||||
use namespaced tag id. If namespace is not provided, `minecraft` is assumed. Custom tags from other plugins and
|
#### Item reference
|
||||||
datapacks are also supported.
|
Example: `minecraft:stick`
|
||||||
|
|
||||||
|
For specific items, use namespaced vanilla item id. If namespace is not provided, `minecraft` is assumed.
|
||||||
|
|
||||||
|
#### Item tag
|
||||||
|
Example: `#minecraft:axes`
|
||||||
|
|
||||||
|
For <a href="https://minecraft.wiki/w/Item_tag_(Java_Edition)" target="_blank">item tags</a>, use namespaced tag id. If
|
||||||
|
namespace is not provided, `minecraft` is assumed. Custom tags from other plugins and datapacks are also supported.
|
||||||
|
|
||||||
|
### Blocks
|
||||||
|
|
||||||
|
#### Block reference
|
||||||
|
Example: `minecraft:dirt`
|
||||||
|
|
||||||
|
For specific items, use namespaced vanilla item id. If namespace is not provided, `minecraft` is assumed.
|
||||||
|
|
||||||
|
#### Block tag
|
||||||
|
Example: `#minecraft:planks`
|
||||||
|
|
||||||
|
For <a href="https://minecraft.wiki/w/Block_tag_(Java_Edition)" target="_blank">block tags</a>, use namespaced tag id. If
|
||||||
|
namespace is not provided, `minecraft` is assumed. Custom tags from other plugins and datapacks are also supported.
|
||||||
|
|
||||||
|
|
||||||
|
### Enchantments
|
||||||
|
|
||||||
|
#### Enchantment tag
|
||||||
|
Example: `#minecraft:in_enchanting_table`
|
||||||
|
|
||||||
|
For <a href="https://minecraft.wiki/w/Enchantment_tag_(Java_Edition)" target="_blank">enchantment tags</a>, use namespaced tag id. If
|
||||||
|
namespace is not provided, `minecraft` is assumed. Custom tags from other plugins and datapacks are also supported.
|
||||||
|
|
||||||
## Slot types
|
## Slot types
|
||||||
- `ANY` - Any slot.
|
- `ANY` - Any slot.
|
||||||
|
|||||||
@@ -18,8 +18,8 @@ Cost that will be added to the item when adding the enchantment to it in anvil.
|
|||||||
|
|
||||||
- **Type**: `int`
|
- **Type**: `int`
|
||||||
|
|
||||||
Weight of the enchantment. Used if `canGetFromEnchantingTable` is set to true. Higher numbers mean it will come up more
|
Weight of the enchantment. Higher numbers mean it will come up more frequently in the enchanting table. Used if
|
||||||
frequently in the enchanting table.
|
`#minecraft:in_enchanting_table` is present in enchantment tags.
|
||||||
|
|
||||||
### minimumCost
|
### minimumCost
|
||||||
|
|
||||||
@@ -29,7 +29,7 @@ Minimum cost that will be required for the enchantment to show up in the enchant
|
|||||||
|
|
||||||
- **Type**: `int`
|
- **Type**: `int`
|
||||||
|
|
||||||
Base cost of the enchant.
|
Base cost of the enchantment.
|
||||||
|
|
||||||
#### perLevel
|
#### perLevel
|
||||||
|
|
||||||
@@ -45,7 +45,7 @@ Maximum cost that will be required for the enchantment to show up in the enchant
|
|||||||
|
|
||||||
- **Type**: `int`
|
- **Type**: `int`
|
||||||
|
|
||||||
Base cost of the enchant.
|
Base cost of the enchantment.
|
||||||
|
|
||||||
#### perLevel
|
#### perLevel
|
||||||
|
|
||||||
@@ -55,23 +55,22 @@ Cost to add per level of the enchantment.
|
|||||||
|
|
||||||
### enchantmentTags
|
### enchantmentTags
|
||||||
|
|
||||||
- **Type**: `key[]`
|
- **Type**: [`Enchantment Tags`](/configuration/input-types/#enchantment-tag)
|
||||||
|
|
||||||
This is list of [tags](/configuration/input-types#tags) that the enchantment will be tagged with. This can be used to put the enchantment in enchanting table,
|
This is list of tags that the enchantment will be tagged with. This can be used to put the enchantment in enchanting table,
|
||||||
mark it as a curse, etc. <a href="https://minecraft.wiki/w/Enchantment_tag_(Java_Edition)" target="_blank">All vanilla</a>
|
mark it as a curse, etc.
|
||||||
and custom tags are supported.
|
|
||||||
|
|
||||||
### supportedItemTags
|
### supportedItemTags
|
||||||
|
|
||||||
- **Type**: `key[]`
|
- **Type**: [`Item Tags`](/configuration/input-types/#items)
|
||||||
|
|
||||||
[Items and/or item tags](/configuration/input-types#tags) that the enchantment can be applied to.
|
Items and/or item tags that the enchantment can be applied to.
|
||||||
|
|
||||||
### activeSlots
|
### activeSlots
|
||||||
|
|
||||||
- **Type**: `string[]`
|
- **Type**: [`Slot types`](/configuration/input-types/#slot-types)
|
||||||
|
|
||||||
[Slots](/configuration/input-types#slot-types) that the enchantment will be active in.
|
Inventory slots that the enchantment will be active in.
|
||||||
|
|
||||||
|
|
||||||
### enabled
|
### enabled
|
||||||
@@ -96,9 +95,11 @@ of the enchantment does not support multiple levels.
|
|||||||
|
|
||||||
## Telepathy
|
## Telepathy
|
||||||
|
|
||||||
|
### onlyUserCanPickupItems
|
||||||
|
|
||||||
- **Type**: `boolean`
|
- **Type**: `boolean`
|
||||||
|
|
||||||
If set to true, items teleported by the enchant will only be able to be picked up by the player that broke the block.
|
If set to true, items teleported by the enchantment will only be able to be picked up by the player that broke the block.
|
||||||
|
|
||||||
## Executioner
|
## Executioner
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user