Class AddOn

The main entry point for bedrockKit. Represents a Minecraft Bedrock addon consisting of a behavior pack and an optional resource pack.

Create instances using the static async factory methods:

Example

// Node.js
const addon = await AddOn.fromDisk("./behavior_pack", "./resource_pack");

// Browser
const addon = await AddOn.fromFiles(bpFiles, rpFiles);

// Navigate
const zombie = addon.entities.get("minecraft:zombie");
console.log(zombie?.displayName);           // "Zombie"
console.log(zombie?.spawnRule?.biomeTags);  // ["monster", "overworld"]

const spear = addon.items.get("minecraft:copper_spear");
console.log(spear?.texture?.id);            // "textures/items/copper_spear"
console.log(spear?.recipes.length);         // 1

Accessors

animationControllers

get animationControllers(): AssetCollection<AnimationController>
All animation controller definitions from the resource pack.

Returns AssetCollection<AnimationController>
- Defined in src/addon.ts:172

animations

get animations(): AssetCollection<Animation>
All animation definitions from the resource pack.

Returns AssetCollection<Animation>
- Defined in src/addon.ts:167

attachables

get attachables(): AssetCollection<Attachable>
All attachable definitions from the resource pack.

Returns AssetCollection<Attachable>
- Defined in src/addon.ts:192

behaviorPackPath

get behaviorPackPath(): string
Resolved absolute path to the behavior pack directory.

Returns string
- Defined in src/addon.ts:278

biomes

get biomes(): AssetCollection<Biome>
All biomes as unified views merging behavior pack and resource pack (client biome) data. Access the BP side via biome.behavior, the RP side via biome.resource.

Returns AssetCollection<Biome>
- Defined in src/addon.ts:162

blocks

get blocks(): AssetCollection<Block>
All block definitions from the behavior pack.

Returns AssetCollection<Block>
- Defined in src/addon.ts:131

bpManifest

get bpManifest(): ManifestFile
The behavior pack manifest (manifest.json), or undefined if not found.

Returns ManifestFile
- Defined in src/addon.ts:250

entities

get entities(): AssetCollection<Entity>
All entities as unified views merging behavior, resource, and spawn rule data. Returns undefined from .get() for unknown identifiers.

Returns AssetCollection<Entity>
- Defined in src/addon.ts:139

featureRules

get featureRules(): AssetCollection<FeatureRule>
All feature rule definitions from the behavior pack.

Returns AssetCollection<FeatureRule>
- Defined in src/addon.ts:202

features

get features(): AssetCollection<Feature>
All world generation feature definitions from the behavior pack.

Returns AssetCollection<Feature>
- Defined in src/addon.ts:197

fogs

get fogs(): AssetCollection<Fog>
All fog definitions from the resource pack.

Returns AssetCollection<Fog>
- Defined in src/addon.ts:207

geometries

get geometries(): AssetCollection<GeometryModel>
All geometry model definitions from the resource pack.

Returns AssetCollection<GeometryModel>
- Defined in src/addon.ts:187

items

get items(): AssetCollection<Item>
All item definitions from the behavior pack.

Returns AssetCollection<Item>
- Defined in src/addon.ts:126

languages

get languages(): { get(lang?: string): LangFile }
Access to localization files. Call .get(langCode) to retrieve a LangFile for the given language code.

Returns { get(lang?: string): LangFile }
Example
```
const en = addon.languages.get("en_US");
console.log(en?.get("item.minecraft.stick.name")); // "Stick"
```
- Defined in src/addon.ts:271

lootTables

get lootTables(): AssetCollection<LootTable>
All loot table files, keyed by their relative path from the BP root.

Returns AssetCollection<LootTable>
- Defined in src/addon.ts:149

music

get music(): MusicDefinitionsFile
The parsed music_definitions.json file, or undefined if the resource pack does not contain one.

Returns MusicDefinitionsFile
Example
```
const entry = addon.music?.get("bamboo_jungle");
```
- Defined in src/addon.ts:243

particles

get particles(): AssetCollection<Particle>
All particle effect definitions from the resource pack.

Returns AssetCollection<Particle>
- Defined in src/addon.ts:182

recipes

get recipes(): AssetCollection<Recipe>
All crafting recipes from the behavior pack.

Returns AssetCollection<Recipe>
- Defined in src/addon.ts:144

renderControllers

get renderControllers(): AssetCollection<RenderController>
All render controller definitions from the resource pack.

Returns AssetCollection<RenderController>
- Defined in src/addon.ts:177

resourcePackPath

get resourcePackPath(): string
Resolved absolute path to the resource pack directory.

Returns string
- Defined in src/addon.ts:281

rpManifest

get rpManifest(): ManifestFile
The resource pack manifest (manifest.json), or undefined if not found.

Returns ManifestFile
- Defined in src/addon.ts:255

sounds

get sounds(): SoundDefinitionsFile
The parsed sound_definitions.json file, or undefined if the resource pack does not contain one.

Returns SoundDefinitionsFile
Example
```
const entry = addon.sounds?.get("mob.zombie.say");
```
- Defined in src/addon.ts:230

textures

get textures(): AssetCollection<Texture>
All texture files from the resource pack, keyed by relative path without extension. Only populated in Node.js (disk) mode. Empty in browser mode.

Returns AssetCollection<Texture>
- Defined in src/addon.ts:215

trading

get trading(): AssetCollection<TradingTable>
All villager trading table files.

Returns AssetCollection<TradingTable>
- Defined in src/addon.ts:154

Methods

getAssetByPath

getAssetByPath(filePath: string): Asset
Returns the asset whose file path matches (or ends with) filePath. Searches across all loaded asset types.

Pass a class constructor as the second argument to narrow the return type. Returns undefined if the asset is found but is not an instance of the requested class.
Parameters
- filePath: string
Returns Asset
Example
```
const asset  = addon.getAssetByPath("entities/zombie.json");
const entity = addon.getAssetByPath("entities/zombie.json", BehaviorEntity);
const recipe = addon.getAssetByPath("recipes/acacia_chest_boat.json", Recipe);
```
- Defined in src/addon.ts:308
getAssetByPath<T extends Asset>(
filePath: string,
type: new (...args: any[]) => T,
): T
Returns the asset whose file path matches (or ends with) filePath. Searches across all loaded asset types.

Pass a class constructor as the second argument to narrow the return type. Returns undefined if the asset is found but is not an instance of the requested class.
Type Parameters
- T extends Asset
Parameters
- filePath: string
- type: new (...args: any[]) => T
Returns T
Example
```
const asset  = addon.getAssetByPath("entities/zombie.json");
const entity = addon.getAssetByPath("entities/zombie.json", BehaviorEntity);
const recipe = addon.getAssetByPath("recipes/acacia_chest_boat.json", Recipe);
```
- Defined in src/addon.ts:309

`Static`fromDisk

fromDisk(bpPath: string, rpPath?: string): Promise<AddOn>
Creates an AddOn by reading pack directories from disk (Node.js only).
Parameters
- bpPath: string
  Absolute or relative path to the behavior pack directory.
- OptionalrpPath: string
  Absolute or relative path to the resource pack directory. Optional — omit if the addon has no resource pack.
Returns Promise<AddOn>
Example
```
const addon = await AddOn.fromDisk("./behavior_pack", "./resource_pack");
```
- Defined in src/addon.ts:97

`Static`fromFiles

fromFiles(bpFiles: File[], rpFiles: File[]): Promise<AddOn>
Creates an AddOn from browser File[] arrays (browser only).
Parameters
- bpFiles: File[]
  Files from the behavior pack folder selection.
- rpFiles: File[]
  Files from the resource pack folder selection.
Returns Promise<AddOn>
Example
```
const addon = await AddOn.fromFiles(bpFileList, rpFileList);
```
- Defined in src/addon.ts:118

Class AddOn

Example

Index

Accessors

Methods

Accessors

animationControllers

Returns AssetCollection<AnimationController>

animations

Returns AssetCollection<Animation>

attachables

Returns AssetCollection<Attachable>

behaviorPackPath

Returns string

biomes

Returns AssetCollection<Biome>

blocks

Returns AssetCollection<Block>

bpManifest

Returns ManifestFile

entities

Returns AssetCollection<Entity>

featureRules

Returns AssetCollection<FeatureRule>

features

Returns AssetCollection<Feature>

fogs

Returns AssetCollection<Fog>

geometries

Returns AssetCollection<GeometryModel>

items

Returns AssetCollection<Item>

languages

Returns { get(lang?: string): LangFile }

Example

lootTables

Returns AssetCollection<LootTable>

music

Returns MusicDefinitionsFile

Example

particles

Returns AssetCollection<Particle>

recipes

Returns AssetCollection<Recipe>

renderControllers

Returns AssetCollection<RenderController>

resourcePackPath

Returns string

rpManifest

Returns ManifestFile

sounds

Returns SoundDefinitionsFile

Example

textures

Returns AssetCollection<Texture>

trading

Returns AssetCollection<TradingTable>

Methods

getAssetByPath

Parameters

Returns Asset

Example

Type Parameters

Parameters

Returns T

Example

StaticfromDisk

Parameters

Returns Promise<AddOn>

Example

StaticfromFiles

Parameters

Returns Promise<AddOn>

Example

Settings

On This Page

`Static`fromDisk

`Static`fromFiles