# genie-scx

> .SCX scenario file reader.

Latest version **0.0.0-alpha.1** (published 2018-09-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install genie-scx
pnpm add genie-scx
yarn add genie-scx
bun add genie-scx
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.0-alpha.1 |
| Published | 2018-09-01 |
| First published | 2018-08-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 25 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | goto-bus-stop |
| Maintainers | goto-bus-stop |
| Keywords | age of empires, genie, scenario, scx |

## Links

- npm: https://www.npmjs.com/package/genie-scx
- Repository: https://github.com/goto-bus-stop/genie-scx
- Issues: https://github.com/goto-bus-stop/genie-scx/issues
- npm.io page: https://npm.io/package/genie-scx

## Dependencies (3)

- [awestruct](https://npm.io/package/awestruct.md) ^1.1.0
- [inflate-raw](https://npm.io/package/inflate-raw.md) ^1.0.0
- [safe-buffer](https://npm.io/package/safe-buffer.md) ^5.1.2

## Recent versions

- 0.0.0-alpha.1 (latest) — 2018-09-01
- 0.0.0-alpha.0 — 2018-08-29

## README

# genie-scx

Genie Engine SCX (scenario) file reader for Node.js and the browser

[![NPM](https://nodei.co/npm/genie-scx.png?compact=true)](https://npmjs.com/package/genie-scx)

## Usage Example

```javascript
var scx = require('genie-scx')
```

## API

### `SCX(filename: string)`

> Node only!

Creates a new SCX instance for the .SCX file `filename`.

### `SCX(buffer: Buffer)`

Creates a new SCX instance for the given Buffer.

### `scx.parse(cb)`

Parse the SCX file. `cb` is a Node-style callback `(err, data)`. `data` is an object with lots of data. Use console.log or devtools to figure out the shape.

## License

[MIT](./LICENSE)

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