Lazuli Toolchain

简体中文 | English

A simple mod toolchain for Minecraft Bedrock Edition, includes the following modules:

• Lazuli core scripts
• Lazuli utils
• Lazuli data
• Lazuli api

Get Started

You need add the following code to initialize your mod:

import { initializeMod } from "lazuli-mc";
initializeMod(YOUR_MOD_ID, { name: "YOUR_MOD_NAME" });

Register API

If the instance has Need Registry category, it needs a static method in Register Api to registried it in game.

For example, if you want to define a tool:

const EXAMPL_TOOL: ToolItem = new ToolItem("exmaple:tool");
Register.toolRegistry(EXAMPLE_TOOL);

Docs

The document that generated with Typedoc can look them up in the links below:

• Core Scripts Document
• Utils Document
• Api Document
• Data Document

Language Files

Article API

If you want to enable the Article API, you need to add the following strings to the language file:

article.nothing.title=No unlocked article
article.nothing.body=You don't unlock any articles, you can get and read an article to unlock it.

Quest API

If you want to enable Quest API, you need to add the following strings to the language file:

api.unexpected_error.quest=Unknown error!
quest.finished=You have completed a quest!
quest.done=The quest has been completed
quest.check=Submit the quest
quest.not_enough.item=You need %1 %2 to complete this task
quest.not_enough.level=You need %1 experience to complete this task
quest.not_enough.xp=You need %1 experience to complete this task
quest.not_enough.entity=You also need %1 specific tasks to complete this task
Quest.not_enough.entity=You need to kill %1 to complete this quest
quest.condition=§eCompletion§r:
quest.award=§eReward§r:
quest.item=%1 %2;
quest.xp=%1 ×experience;
quest.level=%1 ×level;
quest.quests=Complete %1 specific quests;
quest.entity=Kill %1;
quest.reward.none=No reward
quest.condition.none=No condition
quest.tips=§4Tips§r: