# mishiro-core

> CGSS JavaScript library in Node.js

Latest version **6.3.7** (published 2024-03-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install mishiro-core
pnpm add mishiro-core
yarn add mishiro-core
bun add mishiro-core
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; large bundle.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 6.3.7 |
| Published | 2024-03-04 |
| First published | 2018-06-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 9 |
| Unpacked size | 16.5 MB |
| Known vulnerabilities | 0 |
| Install scripts | yes |
| GitHub stars | 17 |
| Author | toyobayashi |
| Maintainers | toyobayashi |
| Keywords | cgss, deresute, mishiro |

## Links

- npm: https://www.npmjs.com/package/mishiro-core
- Repository: https://github.com/toyobayashi/mishiro-core
- Homepage: https://github.com/toyobayashi/mishiro-core#readme
- Issues: https://github.com/toyobayashi/mishiro-core/issues
- npm.io page: https://npm.io/package/mishiro-core

## Dependencies (9)

- [acb](https://npm.io/package/acb.md) 2.1.0
- [got](https://npm.io/package/got.md) ^11.8.2
- [jimp](https://npm.io/package/jimp.md) 0.16.1
- [hca-decoder](https://npm.io/package/hca-decoder.md) 1.6.0
- [proxy-agent](https://npm.io/package/proxy-agent.md) 4.0.1
- [msgpack-lite](https://npm.io/package/msgpack-lite.md) 0.1.26
- [usm-decrypter](https://npm.io/package/usm-decrypter.md) 1.1.2
- [node-addon-api](https://npm.io/package/node-addon-api.md) *
- [@tybys/downloader](https://npm.io/package/@tybys/downloader.md) ^0.2.0

## Recent versions

- 6.3.7 (latest) — 2024-03-04
- 6.3.6 — 2024-03-04
- 6.3.5 — 2024-03-03
- 6.3.4 — 2024-03-03
- 6.3.3 — 2024-03-03
- 6.3.2 — 2024-03-03
- 6.3.1 — 2021-11-01
- 6.3.0 — 2021-07-26
- 6.2.1 — 2021-07-26
- 6.2.0 — 2021-07-25
- 6.1.0 — 2021-07-25
- 6.0.0 — 2021-06-01
- 5.1.0 — 2021-04-24
- 5.0.0 — 2021-04-23
- 4.8.0 — 2020-12-28
- … 47 more at https://npm.io/package/mishiro-core/versions

## README

# mishiro-core

<!-- [![Build status](https://travis-ci.com/toyobayashi/mishiro-core.svg?branch=master)](https://travis-ci.com/toyobayashi/mishiro-core/) -->
[![Build](https://github.com/toyobayashi/mishiro-core/workflows/Build/badge.svg)](https://github.com/toyobayashi/mishiro-core/actions?query=workflow%3ABuild)

``` bash
$ npm install mishiro-core
```

## Require

* Node.js >= 10.8.0 || electron >= 4.0.0 (Node.js 10.11.0)
* Python 2.7
* [Windows] Visual Studio 2017/2019 with C++ build tools and .NET
* [Linux] make & gcc & g++
* [MacOS] Xcode Command Line Tools

## Usage

``` javascript
const { Downloader, Client, audio, util, config } = require('mishiro-core')

let downloader = new Downloader() // download game resources

const {
  acb2hca,
  acb2wav,
  acb2mp3,
  acb2aac,
  hca2wav,
  hca2mp3,
  hca2aac,
  wav2mp3,
  wav2aac,
  MP3Encoder,
  AACEncoder
} = audio // decode music

const {
  Lz4, // LZ4 decompression class
  unpackTexture2D // unpack pictures from unity3d assets bundle
} = util

const client = new Client('123456789:987654321:1a3b5c7d-1234-4bcd-9efa-8e6f4a2b7c5d')

// check game resource version
client.check().then(resVer => console.log(resVer))

// for more details, see index.d.ts and test.
```

## Test

``` bash
# use latest npm (6.10.2+ with node-gyp 5.x)
# npm 6.9.0 use internal node-gyp whose version is v3
# it's important to match the globally installed node-gyp version
# because the location where node-gyp v5 cache the node header
# is different from node-gyp v3
$ npm install -g npm

$ npm install -g node-gyp@9

# install node C++ header
$ node-gyp install # --target=<node version>

$ npm install # --no-package-lock

# npm run test-check
# npm run test-download
# npm run test-audio
$ npm test
```

## License
* MIT

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