CrychicDoc

https://docs.variedmc.cc/
Admin
CrychicDoc is a documentation and resource index related to Minecraft, maintained by the PickAID...
Tokens:1,721,226
Snippets:6,754
Trust Score:2.1
Update:1 year ago
Show doc for...
Tokens:
Raw
### Start Local Preview with NPM

Source: https://docs.variedmc.cc/zh/doc/dev

Starts the local development server to preview the documentation. This command uses NPM to run the development script defined in the project's package.json.

```npm
npm docs:dev
```

--------------------------------

### Start Local Preview with Yarn

Source: https://docs.variedmc.cc/zh/doc/dev

Starts the local development server to preview the documentation using Yarn. This command executes the development script defined in the project's package.json.

```yarn
yarn docs:dev
```

--------------------------------

### KubeJS Basic Setup with VS Code and ProbeJS

Source: https://docs.variedmc.cc/zh/modpack/kubejs/1.20.1/KubeJSCourse/KubeJSBasic/Foreword

This section details the essential setup for using KubeJS, including installing Visual Studio Code and the ProbeJS extension and mod. These tools aid in writing and debugging KubeJS scripts.

```bash
1. Install Visual Studio Code.
2. Install the 'ProbeJS' extension in VS Code.
3. Install the 'ProbeJS' mod in your Minecraft game.
```

--------------------------------

### KubeJS: VS Code Setup

Source: https://docs.variedmc.cc/zh/modpack/kubejs/1.20.1/KubeJSCourse/KubeJSBasic/Customs/README

Provides instructions on how to install and set up Visual Studio Code for KubeJS development, including recommended extensions and configurations.

```KubeJS
// No specific code snippet for VS Code setup, but it involves installing VS Code and potentially extensions like 'KubeJS Language Support'.
```

--------------------------------

### Install Project Dependencies with Yarn

Source: https://docs.variedmc.cc/zh/doc/dev

Installs all necessary project dependencies using Yarn, a recommended package manager for this project. Run this command in the root directory of the cloned project.

```yarn
yarn install
```

--------------------------------

### Install Project Dependencies with NPM

Source: https://docs.variedmc.cc/zh/doc/dev

Installs all necessary project dependencies using the Node Package Manager (NPM). This command should be run in the root directory of the cloned project.

```npm
npm install
```

--------------------------------

### KubeJS: Environment Setup and First Item

Source: https://docs.variedmc.cc/zh/develop/modding/1.20.4/Neoforge/flandre/out_48_Advancement

This section covers the initial steps for setting up your KubeJS development environment and creating your very first custom item in Minecraft. It's a foundational guide for beginners.

```JavaScript
// Example of environment setup (conceptual)
// Ensure you have Forge/Fabric and KubeJS installed.

// Example of creating a simple item
console.log('Creating a new item!');
Events.listen('postRegistry', event => {
    event.createItem('kubejs:my_first_item')
        .displayName('My First Item')
        .texture('kubejs:item/my_first_item');
});

```

--------------------------------

### Deploying Recipes (Create Mod)

Source: https://docs.variedmc.cc/en/modpack/kubejs/1.20.1/KubeJSCourse/KubeJSAddon/CreateJS

Explains the deploying process, used for installing items onto others. It supports multiple outputs and probabilities, and can optionally keep the held item.

```javascript
//机械手 - 安装(支持多个输出结果和概率)
create.deploying("minecraft:chipped_anvil", [
	"minecraft:damaged_anvil",
	"minecraft:iron_ingot"
])
```

```javascript
//机械手 - 安装 - 不消耗手持物品
create.deploying("minecraft:anvil", [
	"minecraft:chipped_anvil",
	"minecraft:iron_ingot"
]).keepHeldItem()
```

--------------------------------

### KubeJS: Detecting Player First Join

Source: https://docs.variedmc.cc/zh/modpack/kubejs/1.20.1/KubeJSCourse/Resources/Sounds

Shows how to detect when a player joins the server for the first time, allowing for custom welcome messages, starting kits, or initial setup.

```javascript
// Example of detecting player first join
// This would typically be in a KubeJS script file

// Assuming 'event' is an object provided by KubeJS for player events
// event.player.onJoin(event => {
//     if (event.player.isFirstJoin()) {
//         event.player.tell('Welcome to the server!');
//     }
// });

// Placeholder for actual KubeJS player first join detection code
console.log('KubeJS player first join detection example');
```

--------------------------------

### KubeJS: Environment Setup and First Item Tutorial

Source: https://docs.variedmc.cc/zh/develop/modding/1.20.4/Neoforge/flandre/out_31_Enchantment

Guides users through setting up their development environment for KubeJS and creating their first custom item in Minecraft. This typically involves basic KubeJS API usage.

```javascript
// Example for environment setup and first item creation (conceptual)
// This would involve KubeJS API calls to register items and their properties.
console.log('Setting up KubeJS environment...');
// Example: Registering a new item
// events.listen('kubejs.item.register', event => {
//     event.create('my_custom_item').displayName('My Awesome Item');
// });
console.log('First item registered.');
```

--------------------------------

### Project Initialization Workflow

Source: https://docs.variedmc.cc/zh/doc/scripts

Provides a step-by-step guide for initializing a new project, including creating index files, setting frontmatter, and synchronizing titles.

```bash
# 1. Create index.md files for a new project
npm run create-indexes -- -p docs/zh --template advanced
# 2. Set basic frontmatter
npm run update-frontmatter -- -p docs/zh --editor "你的名字" --state draft
# 3. Synchronize titles
npm run update-titles
```

--------------------------------

### KubeJS Lazy get() Method Example

Source: https://docs.variedmc.cc/zh/modpack/kubejs/1.20.1/Introduction/Miscellaneous/Lazy

Demonstrates the usage of the get() method on a KubeJS Lazy object. The get() method retrieves the lazily evaluated value. In this example, a Lazy object is created to provide the number 123, and its value is then retrieved.

```javascript
let lazyNum = Utils.lazy(() => 123);
let num = lazyNum.get();
```

--------------------------------

### KubeJS Lazy get() Method Usage

Source: https://docs.variedmc.cc/en/modpack/kubejs/1.20.1/Introduction/Miscellaneous/Lazy

Illustrates the usage of the get() method on a KubeJS lazy object. This example first creates a lazy number and then calls get() to retrieve its value.

```javascript
let lazyNum = Utils.lazy(() => 123);
let num = lazyNum.get();
```

--------------------------------

### Get Player Stats (Java)

Source: https://docs.variedmc.cc/zh/modpack/kubejs/1.20.1/KubeJSCourse/KubeJSAdvanced/StaticClsss

Retrieves player statistics using the VariedMC API. This example shows how to get the total distance a player has walked.

```Java
Utils.server.getPlayer("gu__meng").getStats().get(Stats.BLOCK_MINED.get(Block.getBlock("stone")))
```

```Java
Utils.server.getPlayer("gu__meng").getStats().get(Stats.SWIM_ONE_CM)
```

--------------------------------

### KubeJS: Project Examples - Item Right-Click to Get Block Tag

Source: https://docs.variedmc.cc/zh/modpack/kubejs/1.20.1/KubeJSCourse/KubeJSAdvanced/ItemAttributeModify

Showcases a project example of obtaining a block's tag when a player right-clicks with a specific item using KubeJS.

```javascript
// Conceptual code for getting block tag on right-click
// event.on('player_right_click_block', function(event) {
//   if (event.item.id === 'kubejs:tag_finder') {
//     const blockTag = event.block.getTags();
//     event.player.tell('Block tags: ' + blockTag);
//   }
// });
```

--------------------------------

### KubeJS: Handling Startup Scripts

Source: https://docs.variedmc.cc/zh/modpack/kubejs/1.20.1/Upgrade/VariableType

Provides examples of startup scripts in KubeJS for initialization tasks.

```javascript
// startup script content
```

--------------------------------

### KubeJS VS Code Setup

Source: https://docs.variedmc.cc/en/modpack/kubejs/1.20.1/KubeJSCourse/KubeJSBasic/README

This section provides instructions on setting up Visual Studio Code for KubeJS development. It covers essential extensions and configurations to enhance the scripting experience, including syntax highlighting and autocompletion.

```KubeJS
// No direct code snippet for VS Code setup, but it involves installing extensions like:
// - Minecraft Development Environment (for general Minecraft modding)
// - JavaScript (ES6) code style and linting
```

--------------------------------

### KubeJS: Handling Server Startup Events

Source: https://docs.variedmc.cc/zh/modpack/kubejs/1.20.1/Introduction/GlobalScope/Description

Provides an example of how to hook into server startup events using KubeJS. This allows for custom logic to be executed when the server begins.

```javascript
onEvent('server.load', event => {
  // Server startup logic
});
```

--------------------------------

### Campfire Cooking Recipe Example

Source: https://docs.variedmc.cc/zh/modpack/kubejs/1.19.2/XPlusKubeJSTutorial/recipe/modify-recipes

This example shows how to add a campfire cooking recipe using KubeJS. It specifically demonstrates cooking a redstone torch from redstone dust. This utilizes the `event.recipes.minecraft.campfire_cooking` method.

```javascript
event.recipes.minecraft.campfire_cooking('minecraft:redstone_torch','minecraft:redstone')
```

--------------------------------

### KubeJS: Handling Startup Scripts

Source: https://docs.variedmc.cc/zh/modpack/kubejs/1.20.1/Upgrade/GlobalScope/WrappedClasses/Catalogue

This section explains how to create and manage startup scripts in KubeJS, which are executed when the game or server initializes.

```JavaScript
// Example of a startup script
// This is a placeholder and would involve specific KubeJS API calls
console.log("Startup script executed.");
```

--------------------------------

### KubeJS: Handling Startup Scripts

Source: https://docs.variedmc.cc/zh/modpack/kubejs/1.20.1/Introduction/Miscellaneous/Stat

How to write and execute scripts that run during the KubeJS startup phase, useful for initial setup and configuration.

```javascript
// Example: Startup script
Startup.info('KubeJS is starting up!');
```

--------------------------------

### KubeJS Lazy Instance Creation Example

Source: https://docs.variedmc.cc/zh/modpack/kubejs/1.20.1/Introduction/Miscellaneous/Lazy

Shows how to create a KubeJS Lazy object using the Utils.lazy() function. This example demonstrates creating a Lazy object that will provide a number value (123) when its get() method is called.

```javascript
let lazyNum = Utils.lazy(() => 123);
```

--------------------------------

### KubeJS: Project Examples - Server Sign-in

Source: https://docs.variedmc.cc/zh/modpack/kubejs/1.20.1/KubeJSCourse/KubeJSAdvanced/ItemAttributeModify

Illustrates a project example of implementing a server sign-in system using KubeJS, enhancing player management and engagement.

```javascript
// Conceptual code for server sign-in
// event.on('player_logged_in', function(event) {
//   // Sign-in logic
// });
```

--------------------------------

### KubeJS: Handling Startup Scripts

Source: https://docs.variedmc.cc/zh/modpack/kubejs/1.20.1/Introduction/GlobalScope/Classes/ResourceLocation

This section details how to write startup scripts for KubeJS. These scripts are executed when the game or server starts.

```javascript
// Example of a startup script
// This is a placeholder and would require specific KubeJS API calls
console.log('KubeJS startup script executed.');
// Example: onEvent('startup', event => {
//   console.log('KubeJS is starting up!');
// });
```

--------------------------------

### VariedMC Example Workflow

Source: https://docs.variedmc.cc/en/doc/vscode-snippets-guide

Illustrates a typical workflow for using VariedMC snippets to create and enhance documentation. It guides through page creation, adding dialogs, organizing content with steps, showcasing multi-language code, and formatting text.

```Markdown
1. Create Page: Type `@page-template` to scaffold a new page.
2. Add Dialog: Define dialog content using `@dialog-def` and create a trigger with `@dialog-trigger`.
3. Add Content: Use `@stepper` for tutorials and `@vp-info`, `@vp-warning`, or `@alert-success` for emphasis.
4. Showcase Code: Use `@vp-codegroup` for multi-language examples.
5. Format Text: Use `@mark` and `@spoiler` for enrichment.
```

--------------------------------

### KubeJS: Handling Startup Scripts

Source: https://docs.variedmc.cc/zh/modpack/kubejs/1.20.1/Introduction/Block/Catalogue

This section details the process of creating and managing startup scripts in KubeJS. These scripts are executed when the game or server starts.

```javascript
onEvent('startup', event => {
  console.log('Startup script executed!');
});
```

--------------------------------

### Recipe Filtering Examples

Source: https://docs.variedmc.cc/zh/modpack/kubejs/1.19.2/XPlusKubeJSTutorial/recipe/modify-recipes

This section provides examples of how to use recipe filters in KubeJS for modifying or removing recipes. It covers filtering by output, input, mod ID, recipe ID, recipe type, and combinations using AND, OR, and NOT logic.

```javascript
{output:'物品'}

```

```javascript
{input:'物品'}

```

```javascript
{mod:'模组ID'}

```

```javascript
{recipe:'配方ID'}

```

```javascript
{type: '配方类型'}

```

```javascript
{条件1:"值",条件2:"值"}

```

```javascript
[{条件1:"值"}, {条件2:"值"}]

```

```javascript
{not:{条件:"值"}}

```

--------------------------------

### KubeJS: Handling Client Startup Events

Source: https://docs.variedmc.cc/zh/modpack/kubejs/1.20.1/Introduction/GlobalScope/Description

Shows how to handle client-side startup events with KubeJS. This is useful for client-specific modifications or initializations.

```javascript
onEvent('client.load', event => {
  // Client startup logic
});
```

--------------------------------

### KubeJS Remove Recipe Examples

Source: https://docs.variedmc.cc/en/modpack/kubejs/1.20.1/KubeJSCourse/KubeJSBasic/BasicSyntax-DeleteAndModify

Provides examples of using the `event.remove()` function with various KubeJS recipe filters to delete specific recipes from the game. It shows how to remove recipes based on output, input, mod, ID, and type.

```javascript
ServerEvents.recipes(event => {
    // Remove all recipes outputting stone bricks
    event.remove({output : 'stone_bricks'});
    // Remove all recipes containing stone bricks as input
    event.remove({input : 'stone_bricks'});
    // Remove all recipes from the minecraft mod
    event.remove({mod : 'minecraft'});
    // Remove the specific recipe for oak wood (4 oak logs)
    event.remove({id : "minecraft:oak_wood"});
    // Remove all smelting recipes
    event.remove({type : "smelting"});
});
```

```javascript
ServerEvents.recipes(event => {
    // Remove the end stone bricks recipe specifically from crafting tables
    event.remove({type:"crafting_shaped",output:"end_stone_bricks"});
});
```

--------------------------------

### Create Deploying Examples

Source: https://docs.variedmc.cc/zh/modpack/kubejs/1.20.1/KubeJSCourse/KubeJSAddon/CreateJS

Shows examples of the Create mod's Mechanical Arm for deploying items. Includes basic deployment and deployment that keeps the held item.

```javascript
//机械手 - 安装(支持多个输出结果和概率)
create.deploying("minecraft:chipped_anvil", [
	"minecraft:damaged_anvil",
	"minecraft:iron_ingot"
])
//机械手 - 安装 - 不消耗手持物品
create.deploying("minecraft:anvil", [
	"minecraft:chipped_anvil",
	"minecraft:iron_ingot"
]).keepHeldItem()
```

--------------------------------

### KubeJS Replace Recipe Examples

Source: https://docs.variedmc.cc/en/modpack/kubejs/1.20.1/KubeJSCourse/KubeJSBasic/BasicSyntax-DeleteAndModify

Demonstrates how to use KubeJS's `replaceInput` and `replaceOutput` functions to modify existing recipes. Examples show replacing input items based on tags and replacing output items based on specific conditions.

```javascript
ServerEvents.recipes(event =>{
    // Replace sticks with blaze rods if the recipe requires stick and planks tag
    event.replaceInput({input:'minecraft:stick',input:'#minecraft:planks'},'minecraft:stick','minecraft:blaze_rod');
    // Replace cobblestone with diamond if the output is dispenser, dropper, or furnace
    event.replaceInput([{output:'minecraft:dispenser'},{output:'minecraft:dropper'},{output:'minecraft:furnace'}],"minecraft:cobblestone",'minecraft:diamond');
    // Replace logs with stone bricks if the recipe does not meet the input criteria (stick and planks tag)
    event.replaceOutput({not:{input:'minecraft:stick',input:'#minecraft:planks'}},'#minecraft:logs','minecraft:stone_bricks');
})
```

--------------------------------

### Configuration Priority Example

Source: https://docs.variedmc.cc/en/doc/sidebarTutorial

Demonstrates the application of configuration settings based on their priority, showing how global, root, sub, and JSON configurations override each other for properties like maxDepth and collapsed.

```yaml
# 1️⃣ docs/.sidebarrc.yml
defaults:
    maxDepth: 0
    collapsed: true
```

```yaml
# 2️⃣ docs/zh/modpack/kubejs/index.md
---
root: true
maxDepth: 2
collapsed: false
---
```

```yaml
# 3️⃣ docs/zh/modpack/kubejs/1.20.1/index.md
---
maxDepth: 1
---
```

```json
// 4️⃣ .vitepress/config/sidebar/zh/modpack/kubejs/1.20.1/collapsed.json
{
    "basic/": true
}
```

--------------------------------

### KubeJS Lazy forget() Method Example

Source: https://docs.variedmc.cc/zh/modpack/kubejs/1.20.1/Introduction/Miscellaneous/Lazy

Illustrates the functionality of the forget() method in KubeJS Lazy objects. Calling forget() discards the currently held value, forcing a re-evaluation the next time get() is called. This example shows that after forgetting, the supplier function is executed again.

```javascript
let lazy = Utils.lazy(() => { 
  console.log("Supplier: Message"); 
  return "Message";
});
lazy.get();
lazy.forget();
lazy.get();
```

--------------------------------

### Example: Sequenced Assembly Recipe

Source: https://docs.variedmc.cc/en/modpack/kubejs/1.18.2/XPlusKubeJSTutorial/addons/kubejs-create

A detailed example of a sequenced assembly recipe, including multiple steps, transitional items, loops, and probabilistic outputs.

```javascript
event.recipes.createSequencedAssembly([
  Item.of('6x create:large_cogwheel').withChance(32.0),
  Item.of('create:brass_ingot').withChance(2.0),
  'minecraft:andesite',
  'create:cogwheel',
  'minecraft:stick',
  'minecraft:iron_nugget'
], 'create:brass_ingot', [
  event.recipes.createDeploying('create:incomplete_large_cogwheel', ['create:incomplete_large_cogwheel', '#minecraft:planks']),
  event.recipes.createDeploying('create:incomplete_large_cogwheel', ['create:incomplete_large_cogwheel', '#minecraft:wooden_buttons']),
  event.recipes.createCutting('create:incomplete_large_cogwheel', 'create:incomplete_large_cogwheel').processingTime(50)
]).transitionalItem('create:incomplete_large_cogwheel').loops(6)
```

--------------------------------

### KubeJS Lazy Evaluation with Supplier

Source: https://docs.variedmc.cc/en/modpack/kubejs/1.20.1/Introduction/Miscellaneous/Supplier

Shows an example of using Utils.lazy() with a Supplier in KubeJS, where the value is only initialized when the get() method is called.

```javascript
let lazyLocation = Utils.lazy(() => new ResourceLocation("kubejs:demo"));
```

--------------------------------

### ExampleMod Main Class with Configuration Loading

Source: https://docs.variedmc.cc/zh/develop/modding/1.20.4/Neoforge/flandre/out_49_Config

This Java snippet shows the main class for an example mod, registering the common configuration type and handling setup events. It demonstrates how to log configuration values during the common setup phase, including boolean, string, and list types.

```Java
// The value here should match an entry in the META-INF/mods.toml file
@Mod(ExampleMod.MODID)
public class ExampleMod
{
    public static final String MODID = "examplemod";
    private static final Logger LOGGER = LogUtils.getLogger();
     public ExampleMod(IEventBus modEventBus)
    {
        //config
        ModLoadingContext.get().registerConfig(ModConfig.Type.COMMON, Config.SPEC);
        NeoForge.EVENT_BUS.register(this);
    }
    private void commonSetup(final FMLCommonSetupEvent event)
    {
        // log config info
        // 根据读取的字段的数值进行打印
        if (Config.logDirtBlock) // boolean值
            LOGGER.info("DIRT BLOCK >> {}", BuiltInRegistries.BLOCK.getKey(Blocks.DIRT));
        // string和value数值
        LOGGER.info(Config.magicNumberIntroduction + Config.magicNumber);
        // list
        Config.items.forEach((item) -> LOGGER.info("ITEM >> {}", item.toString()));
    }
}
```

--------------------------------

### KubeJS: Handling Server Startup Events

Source: https://docs.variedmc.cc/zh/modpack/kubejs/1.20.1/Introduction/Miscellaneous/Description

This snippet demonstrates how to handle server startup events in KubeJS. It allows for custom logic to be executed when the server starts.

```javascript
onEvent('kubejs:startup', event => {
  // Server startup logic here
});
```

--------------------------------

### KubeJS Sub Configuration Example (Markdown)

Source: https://docs.variedmc.cc/en/doc/sidebarTutorial

Provides an example of sub-configuration using frontmatter in a non-root directory's index.md file. This allows overriding sidebar settings like title, visibility, priority, and item order for specific directories.

```markdown
---
title: "Advanced Features" # Custom display title
hidden: false # Show this directory
priority: 50 # Adjust sorting
maxDepth: 1 # Limit expansion depth
collapsed: true # Default collapsed
itemOrder: # Child item sorting
    - "setup.md"
    - "advanced.md"
    - "troubleshooting.md"
---
# Advanced Features Guide
This directory contains detailed explanations of advanced features...
```

--------------------------------

### Get Global Loot Modifiers (Forge)

Source: https://docs.variedmc.cc/en/modpack/kubejs/1.20.1/Introduction/Addon/LootJs/Event

This example demonstrates how to retrieve and log all globally registered loot modifiers from other mods, specifically for Forge environments.

```javascript
LootJS.modifiers((event) => {
    const modifiers = event.getGlobalModifiers();
    modifiers.forEach((modifier) => {
        console.log(modifier);
    });
});
```

--------------------------------

### KubeJS: Add Enchantment Example

Source: https://docs.variedmc.cc/en/modpack/kubejs/1.20.1/KubeJSCourse/KubeJSBasic/Customs/BlockType/README

Guides users on how to add custom enchantments to items in Minecraft via KubeJS. This covers defining enchantment effects and compatibility.

```KubeJS
// Example for adding a custom enchantment
// Specific code will involve registering the enchantment and its effects
```

--------------------------------

### ProbeJS Setup and Usage

Source: https://docs.variedmc.cc/zh/modpack/kubejs/1.19.2/XPlusKubeJSTutorial/readme/probejs-and-commands

Instructions for setting up and using ProbeJS, a tool that generates VSCode code templates and declaration files to improve KubeJS modding efficiency. Requires VSCode and the ProbeJS mod.

```Shell
Install Visual Studio Code.
Install the ProbeJS mod for the game.
Execute `/probejs test_availability` in-game.
Execute `/probejs dump` in-game to generate declaration files.
Open the game directory in VSCode.
```

--------------------------------

### KubeJS 物品注册事件监听

Source: https://docs.variedmc.cc/en/modpack/kubejs/1.19.2/XPlusKubeJSTutorial/game-contents/item

使用 StartupEvents.registry 事件监听来注册物品。该事件允许你在游戏启动时添加或修改物品。

```javascript
StartupEvents.registry("item",event=>{
    // 脚本
})
```

--------------------------------

### KubeJS Localization Example

Source: https://docs.variedmc.cc/en/modpack/kubejs/1.18.2/XPlusKubeJSTutorial/others/i18n

This snippet demonstrates how to register custom blocks, items, and fluids in KubeJS and how to define their localized names in a JSON language file.

```javascript
onEvent('block.registry', event => {
	event.create('super_tnt').material('wood').hardness(1.0).displayName('超级TNT');
})
onEvent('item.registry', event => {
	event.create('can').displayName('罐头').maxStackSize(8);
})
onEvent('fluid.registry', event => {
	event.create("test_mud").displayName("泥").bucketColor(0x844031).textureThick(0x844031).textureThin(0x844031);
})
```

```json
{
    "block.kubejs.super_tnt":"Super TNT",
    "item.kubejs.can":"Can",
    "fluid.kubejs.mud":"Mud"
}
```

--------------------------------

### KubeJS: Get All Recipe JSONs

Source: https://docs.variedmc.cc/zh/modpack/kubejs/1.20.1/KubeJSCourse/KubeJSBasic/Customs/ItemType/README

This section provides an example of how to retrieve all recipe JSON data from the game and save it to a file using KubeJS, useful for analysis and backup.

```javascript
// Example for getting all recipe JSONs
// events.listen('kubejs:recipes_loaded', event => {
// 	const recipes = event.recipes;
// 	const fs = require('fs');
// 	fs.writeFileSync('recipes.json', JSON.stringify(recipes, null, 2));
// });
```

--------------------------------

### VitePress Preview Server Output

Source: https://docs.variedmc.cc/zh/doc/dev

This output indicates that the VitePress development server has successfully started. It provides local and network URLs for accessing the preview, along with options to show help or expose the server.

```text
vitepress v1.3.1
➜  Local:   http://localhost:5173/
➜  Network: use --host to expose
➜  press h to show help
```

--------------------------------

### Get Sound Resource (KubeJS)

Source: https://docs.variedmc.cc/zh/modpack/kubejs/1.20.1/Introduction/Miscellaneous/SoundEvent

Demonstrates how to retrieve an existing sound resource from the game using the Utils.getSound() function in KubeJS. This example retrieves the player level-up sound.

```javascript
let sound = Utils.getSound("entity.player.levelup");
```

--------------------------------

### Example: Sequenced Assembly Explanation

Source: https://docs.variedmc.cc/en/modpack/kubejs/1.18.2/XPlusKubeJSTutorial/addons/kubejs-create

An explanation of the sequenced assembly recipe structure, detailing the output array, input item, sequence steps, transitional item, and loop count.

```javascript
event.recipes.createSequencedAssembly([
 	//成品：
 	Item.of('6x create:large_cogwheel').withChance(32.0),
 	//随机废料：
 	Item.of('create:brass_ingot').withChance(2.0),
 	'minecraft:andesite',
 	'create:cogwheel',
 	'minecraft:stick',
 	'minecraft:iron_nugget'
	],
	//输入物品：
	'create:brass_ingot',
	[
	//每步的配方
	/*
	其中create:incomplete_large_cogwheel作为合成的半成品(即.transitionalItem('半成品注册名'))
	.loops(6)代表合成循环次数
	.transitionalItem和.loops是可选的
	*/
 	event.recipes.createDeploying('create:incomplete_large_cogwheel', ['create:incomplete_large_cogwheel', '#minecraft:planks']),//第一步
 	event.recipes.createDeploying('create:incomplete_large_cogwheel', ['create:incomplete_large_cogwheel', '#minecraft:wooden_buttons']),//第二步
 	event.recipes.createCutting('create:incomplete_large_cogwheel', 'create:incomplete_large_cogwheel').processingTime(50)//第三步
]).transitionalItem('create:incomplete_large_cogwheel').loops(6)
```

--------------------------------

### Java Interface Definition

Source: https://docs.variedmc.cc/zh/develop/modding/Mixin/annotation/Implements

Defines a custom interface named ICustomData with methods to get and set integer data. This serves as an example for the @Implements annotation.

```Java
public interface ICustomData {
    int getCustomData();
    void setCustomData(int data);
}
```

--------------------------------

### Register Hoe Item in KubeJS

Source: https://docs.variedmc.cc/en/modpack/kubejs/1.20.1/Introduction/Item/Register/Register

This example shows how to register a hoe item in KubeJS. It uses the StartupEvents registry to create an item of type 'hoe'.

```js
StartupEvents.registry('minecraft:item', event => {
    event.create('kubejs:demo', 'hoe')
})
```

--------------------------------

### KubeJS 脚本重载

Source: https://docs.variedmc.cc/zh/modpack/kubejs/1.18.2/XPlusKubeJSTutorial/the-start/commands

通过 `/kubejs reload [server_scripts|lang|texture|startup_scripts]` 指令可以重载服务器脚本、语言文件、纹理资源和启动脚本。`/kubejs reload server_scripts` 与 `/reload` 效果相似。

```plaintext
/kubejs reload [server_scripts|lang|texture|startup_scripts]
```

```plaintext
/kubejs reload server_scripts
```

```plaintext
/reload
```

--------------------------------

### KubeJS Project Examples

Source: https://docs.variedmc.cc/en/modpack/kubejs/1.20.1/KubeJSCourse/KubeJSBasic/README

This section showcases various project examples created using KubeJS, demonstrating practical applications such as custom material integration, enchanting workstations, altar crafting, drop crafting, lottery tickets, custom portals, player muting, server check-ins, registering AE storage components, and more.

```KubeJS
// Example: Registering AE Storage Component
// AE.registerStorageComponent('custom_storage_component', {
//   // ... component properties
// });

// Example: Custom Portal
// event.recipes.custom_portal.create('portal_block', 'destination_dimension');
```

--------------------------------

### Add Smithing Recipe (KubeJS)

Source: https://docs.variedmc.cc/en/modpack/kubejs/1.19.2/XPlusKubeJSTutorial/recipe/modify-recipes

Example of adding a smithing table recipe. It defines the output item, the base item, and the material required for the upgrade.

```javascript
event.smithing('minecraft:golden_apple', 'minecraft:apple', 'minecraft:gold_ingot')

```

--------------------------------

### KubeJS: Handling Server Events

Source: https://docs.variedmc.cc/zh/modpack/kubejs/1.20.1/Upgrade/GlobalScope/Classes/Platform

Provides an example of how to handle server-side events in KubeJS, such as startup events. This allows for custom logic execution during server initialization.

```javascript
onEvent('kubejs:startup', event => {
  // Server startup logic
});
```

--------------------------------

### Add Campfire Cooking Recipe (KubeJS)

Source: https://docs.variedmc.cc/en/modpack/kubejs/1.19.2/XPlusKubeJSTutorial/recipe/modify-recipes

Example of adding a campfire cooking recipe. It specifies the output item and the input item to be cooked on the campfire.

```javascript
event.campfireCooking('minecraft:torch', 'minecraft:stick')

```

--------------------------------

### KubeJS: Get Item Block Tag

Source: https://docs.variedmc.cc/zh/modpack/kubejs/1.20.1/KubeJSCourse/KubeJSBasic/Customs/ItemType/README

This section provides an example of how to retrieve the block tag associated with a specific item using KubeJS, useful for various scripting purposes.

```javascript
// Example for getting item block tag
// events.listen('player.interacted', event => {
// 	const item = event.item;
// 	if (item.hasTag('forge:tools/pickaxe')) {
// 		const blockTag = item.getBlockTag();
// 		event.player.tell('Block tag: ' + blockTag);
// 	}
// });
```

--------------------------------

### Troubleshooting KubeJS 1.18.2 Startup Issues

Source: https://docs.variedmc.cc/zh/modpack/kubejs/1.18.2/XPlusKubeJSTutorial/migrate-to-1182/20-1

Provides instructions to resolve white screen or unresponsiveness issues during KubeJS 1.18.2 startup. This involves manually downloading and extracting specific mapping files to the temporary directory.

```plaintext
C:\Users\系统用户名\AppData\Local\Temp\rhino_forge_srg_remapped_1.18.2_v1_client.txt
C:\Users\系统用户名\AppData\Local\Temp\rhino_mojang_mappings_1.18.2_v1_client.txt
(注：可以在"文件资源管理器"或"运行"窗口中键入`%temp%`来快速跳转至指定文件夹)
```

--------------------------------

### Java Supplier Instance Creation and Usage (Java)

Source: https://docs.variedmc.cc/zh/modpack/kubejs/1.20.1/Introduction/Miscellaneous/Supplier

Provides an example of creating a Java Supplier using a lambda expression and retrieving its value using the `get()` method.

```java
Supplier<String> lazyStr = () -> "Hello World!";
System.out.println(lazyStr.get());
```

--------------------------------

### Spotlight Feature: Enable

Source: https://docs.variedmc.cc/en/modpack/kubejs/1.20.1/KubeJSCourse/KubeJSProjects/Meng/SignIn

Activates the Spotlight feature, which highlights the line currently hovered by the mouse to aid users with reading and focusing difficulties.

```markdown
#### Spotlight
#####  ON On
Turn on Spotlight.
```

--------------------------------

### KubeJS Get All Attribute Modifiers

Source: https://docs.variedmc.cc/en/modpack/kubejs/1.20.1/Introduction/Entity/Attribute

Provides an example of how to iterate through all modifiers applied to an entity's attribute, such as 'generic.max_health'. It logs the ID, name, amount, and operation of each modifier.

```javascript
ItemEvents.entityInteracted(event => {
    const { entity, target, hand, level, server } = event;
    // 此处使用了僵尸作为实验生物
    // 在实际操作属性时需要确保被操作的实体类型是LivingEntity的子类
    if (hand !== 'main_hand' || target.type !== 'minecraft:husk') return;
    /**
     * 为了使编辑器启动类型提示可以使用jsdoc
     * 因为Attribute是LivingEntity的属性，而target是一个Entity
     * @type {Internal.LivingEntity}
     */
    const livingEntity = target;
    livingEntity.getAttribute('generic.max_health').getModifiers().forEach(
        (attributeModifier) => {
            // 获取修饰符的Uuid
            console.log(attributeModifier.id);
            // 获取修饰符的标识符
            console.log(attributeModifier.name);
            // 获取修饰符的值
            console.log(attributeModifier.amount);
            // 获取修饰符的操作符
            console.log(attributeModifier.operation);
        });
});
```
Tokens:
Raw