diff --git a/docs/astro.config.mjs b/docs/astro.config.mjs index 2b85d58..c0544a7 100644 --- a/docs/astro.config.mjs +++ b/docs/astro.config.mjs @@ -11,7 +11,7 @@ export default defineConfig({ sidebar: [ { label: 'Documentation', - autogenerate: { directory: 'documentation' }, + items: [{ autogenerate: { "directory": "documentation" } }] }, { label: 'Configuration', diff --git a/docs/package.json b/docs/package.json index 0fedf0a..4cda004 100644 --- a/docs/package.json +++ b/docs/package.json @@ -10,8 +10,7 @@ "astro": "astro" }, "dependencies": { - "@astrojs/starlight": "^0.34.3", - "astro": "^5.6.1", - "sharp": "^0.32.5" + "@astrojs/starlight": "^0.42.4", + "astro": "^7.2.10" } } \ No newline at end of file diff --git a/docs/src/content/docs/configuration/input-types.md b/docs/src/content/docs/configuration/input-types.md index 5957e80..297ed6b 100644 --- a/docs/src/content/docs/configuration/input-types.md +++ b/docs/src/content/docs/configuration/input-types.md @@ -4,11 +4,41 @@ description: How to specify common input types in configuration --- ## 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. -- `#minecraft:item_tag_name` - For item tags, - use namespaced tag id. If namespace is not provided, `minecraft` is assumed. Custom tags from other plugins and - datapacks are also supported. + +### Items + +#### Item reference +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 item tags, 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 block tags, 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 enchantment tags, use namespaced tag id. If +namespace is not provided, `minecraft` is assumed. Custom tags from other plugins and datapacks are also supported. ## Slot types - `ANY` - Any slot. diff --git a/docs/src/content/docs/configuration/reference.md b/docs/src/content/docs/configuration/reference.md index d4cb756..045cafe 100644 --- a/docs/src/content/docs/configuration/reference.md +++ b/docs/src/content/docs/configuration/reference.md @@ -18,8 +18,8 @@ Cost that will be added to the item when adding the enchantment to it in anvil. - **Type**: `int` -Weight of the enchantment. Used if `canGetFromEnchantingTable` is set to true. Higher numbers mean it will come up more -frequently in the enchanting table. +Weight of the enchantment. Higher numbers mean it will come up more frequently in the enchanting table. Used if +`#minecraft:in_enchanting_table` is present in enchantment tags. ### minimumCost @@ -29,7 +29,7 @@ Minimum cost that will be required for the enchantment to show up in the enchant - **Type**: `int` -Base cost of the enchant. +Base cost of the enchantment. #### perLevel @@ -45,7 +45,7 @@ Maximum cost that will be required for the enchantment to show up in the enchant - **Type**: `int` -Base cost of the enchant. +Base cost of the enchantment. #### perLevel @@ -55,23 +55,22 @@ Cost to add per level of the enchantment. ### 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, -mark it as a curse, etc. All vanilla -and custom tags are supported. +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. ### 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 -- **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 @@ -96,9 +95,11 @@ of the enchantment does not support multiple levels. ## Telepathy +### onlyUserCanPickupItems + - **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