@xmcl/resourcepack
Version:
A Minecraft resource pack parser
130 lines (93 loc) • 4.8 kB
Markdown
# Resourcepack Module
[](https://www.npmjs.com/package/@xmcl/resourcepack)
[](https://npmjs.com/@xmcl/resourcepack)
[](https://packagephobia.now.sh/result?p=@xmcl/resourcepack)
[](https://github.com/voxelum/minecraft-launcher-core-node/blob/master/LICENSE)
[](https://github.com/Voxelum/minecraft-launcher-core-node/actions?query=workflow%3ABuild)
Provide function to read resource pack.
## Usage
### Parse ResourcePack Basic Info
Read pack metadata from file:
```ts
import { ResourcePack, PackMeta } from "@xmcl/resourcepack"
const fileFullPath = "path/to/pack/some-pack.zip";
const pack: PackMeta.Pack = await ResourcePack.readPackMeta(fileFullPath);
// or you want read from folder, same function call
const dirFullPath = "path/to/pack/some-pack";
const fromFolder: PackMeta.Pack = await ResourcePack.readPackMeta(dirFullPath);
// if you have already read the file, don't want to reopen the file
// the file path will be only used for resource pack name
const fileContentBuffer: Buffer;
const fromBuff: PackMeta.Pack = await ResourcePack.readPackMeta(fileFullPath, fileContentBuffer);
```
Read pack icon:
```ts
import { ResourcePack, PackMeta } from "@xmcl/resourcepack"
const fileFullPath = "path/to/pack/some-pack.zip";
const pack: Uint8Array = await ResourcePack.readIcon(fileFullPath);
```
Put them together in efficent way (don't open resource pack again and again):
```ts
import { ResourcePack, PackMeta } from "@xmcl/resourcepack"
const fileFullPath = "path/to/pack/some-pack.zip";
const res = await ResourcePack.open(fileFullPath);
const pack: PackMeta.Pack = await ResourcePack.readPackMeta(res);
const icon: Uint8Array = await ResourcePack.readIcon(res);
// or
const pack: PackMeta.Pack = await res.info();
const icon: Uint8Array = await res.icon();
```
### Read ResourcePack Content
You can read resource pack content just like Minecraft:
```ts
import { ResourcePack, ResourceLocation } from "@xmcl/resourcepack"
const fileFullPath = "path/to/pack/some-pack.zip";
const pack: ResourcePack = await ResourcePack.open(fileFullPath);
// this is almost the same with original Minecraft
// this get the dirt texture png -> minecraft:textures/block/dirt.png
const resLocation: ResourceLocation = ResourceLocation.ofTexturePath("block/dirt");
console.log(resLocation); // minecraft:textures/block/dirt.png
const resource: Resource | undefined = await pack.get(resLocation);
if (resource) {
const binaryContent: Uint8Array = await resource.read();
// this is the metadata for resource, like animated texture metadata.
const metadata: PackMeta = await resource.readMetadata();
}
```
### Load Minecraft Block Model
You can use this to load Minecraft block model and texture just like Minecraft.
```ts
import { ResourcePack, Resource, BlockModel,ResourceManager, ModelLoader } from "@xmcl/resourcepack";
import { openFileSystem } from "@xmcl/system";
const man = new ResourceManager();
const resourcePack = new ResourcePack(await openFileSystem("/path/to/resource-pack.zip"));
// setup resource pack
man.addResourcePack(resourcePack);
const loader = new ModelLoader(man);
await loader.loadModel("block/grass"); // load grass model
await loader.loadModel("block/stone"); // load stone model
// ... load whatever you want model
const textures: Record<string, Resource> = loader.textures;
const models: Record<string, BlockModel.Resolved> = loader.models;
const resolvedModel: BlockModel.Resolved = models["block/grass"];
```
### Load Minecraft Resource
You can use this module in nodejs/electron:
```ts
import { openFileSystem } from "@xmcl/system";
import { ResourcePack, Resource, ResourceManager, ResourceLocation } from "@xmcl/resourcepack";
const manager: ResourceManager = new ResourceManager();
// add a resource source which load resource from file
await manager.addResourcePack(new ResourcePack(await openFileSystem('/base/path')));
// load grass block model resource; it will load file at `assets/${location.domain}/${location.path}`
// which is '/base/path/assets/minecraft/models/block/grass.json'
// same logic with minecraft
const resource = await manager.get(ResourceLocation.ofModelPath('block/grass'));
const content: string = await resource.read("utf-8"); // your resource content
const modelJSON = JSON.parse(content);
```
The resource manager will do the simplest cache for same resource location.
You can clear the cache by:
```ts
manager.clearCache();
```