# @xmcl/system

> An abstract layer for file system on reading zip or plain dictionary/file

Latest version **2.3.0** (published 2026-07-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install @xmcl/system
pnpm add @xmcl/system
yarn add @xmcl/system
bun add @xmcl/system
```

## Health

**Score 60/100 (C)** — status: active.

Positive: no vulnerabilities; has provenance; recently updated; high maintenance score.

Warnings: low downloads; no types; no esm support.

## Facts

| | |
|---|---|
| Version | 2.3.0 |
| Published | 2026-07-25 |
| First published | 2020-01-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=20 |
| Dependencies | 3 |
| Unpacked size | 66 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 1600 |
| Author | cijhn@hotmail.com |
| Maintainers | ci010 |
| Keywords | minecraft, typescript, minecraft-launcher, nodejs, file-system, electron |

## Links

- npm: https://www.npmjs.com/package/@xmcl/system
- Repository: https://github.com/Voxelum/x-minecraft-launcher
- Homepage: https://github.com/Voxelum/minecraft-launcher-core-node#readme
- Issues: https://github.com/Voxelum/minecraft-launcher-core-node/issues
- npm.io page: https://npm.io/package/@xmcl/system

## Dependencies (3)

- [jszip](https://npm.io/package/jszip.md) ^3.10.1
- [@xmcl/unzip](https://npm.io/package/@xmcl/unzip.md) workspace:^*
- [@xmcl/yauzl](https://npm.io/package/@xmcl/yauzl.md) workspace:^*

## Alternatives

- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads

## Recent versions

- 2.3.0 (latest) — 2026-07-25
- 2.2.9 — 2025-08-01
- 2.2.8 — 2025-01-10
- 2.2.7 — 2024-01-08
- 2.2.6 — 2023-04-24
- 2.2.5 — 2023-04-16
- 2.2.4 — 2023-04-13
- 2.2.3 — 2021-10-21
- 2.2.2 — 2021-10-20
- 2.2.1 — 2020-12-20
- 2.2.0 — 2020-08-31
- 2.1.0 — 2020-07-10
- 2.0.0 — 2020-04-10
- 1.0.9 — 2020-03-15
- 1.0.8 — 2020-03-14
- … 5 more at https://npm.io/package/@xmcl/system/versions

## README

# Common Module

[![npm version](https://img.shields.io/npm/v/@xmcl/system.svg)](https://www.npmjs.com/package/@xmcl/system)
[![Downloads](https://img.shields.io/npm/dm/@xmcl/system.svg)](https://npmjs.com/@xmcl/system)
[![Install size](https://packagephobia.now.sh/badge?p=@xmcl/system)](https://packagephobia.now.sh/result?p=@xmcl/system)
[![npm](https://img.shields.io/npm/l/@xmcl/minecraft-launcher-core.svg)](https://github.com/voxelum/minecraft-launcher-core-node/blob/master/LICENSE)
[![Build Status](https://github.com/voxelum/minecraft-launcher-core-node/workflows/Build/badge.svg)](https://github.com/Voxelum/minecraft-launcher-core-node/actions?query=workflow%3ABuild)

A unified API to read directory or zip.

Support both nodejs and browser.

You can do read operations for zip or directory in same API:

```ts
import { openFileSystem } from "@xmcl/system";

let filePath = "/path/to/dir/"
const fs = await openFileSystem(filePath);
fs.readFile("a.txt"); // read /path/to/dir/a.txt

let zipPath = "/path/to/file.zip"
const fs = await openFileSystem(zipPath);
fs.readFile("a.txt"); // read a.txt in the file.zip!
```

---
_Source: https://npm.io/package/@xmcl/system · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._