# parse-bmfont-xml

> parses XML BMFont files into a JavaScript object

Latest version **1.1.6** (published 2024-02-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install parse-bmfont-xml
pnpm add parse-bmfont-xml
yarn add parse-bmfont-xml
bun add parse-bmfont-xml
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.6 |
| Published | 2024-02-15 |
| First published | 2015-03-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 8.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Matt DesLauriers |
| Maintainers | mattdesl |
| Keywords | xml, parse, convert, bmfont, bm, bitmap, font, bitmaps, angel, angelcode, code, text, gl, sprite, sprites, stackgl |

## Links

- npm: https://www.npmjs.com/package/parse-bmfont-xml
- Repository: https://github.com/mattdesl/parse-bmfont-xml
- Issues: https://github.com/mattdesl/parse-bmfont-xml/issues
- npm.io page: https://npm.io/package/parse-bmfont-xml

## Dependencies (2)

- [xml2js](https://npm.io/package/xml2js.md) ^0.5.0
- [xml-parse-from-string](https://npm.io/package/xml-parse-from-string.md) ^1.0.0

## Alternatives

- [babylon](https://npm.io/package/babylon.md) — 5.1M weekly downloads
- [csscolorparser](https://npm.io/package/csscolorparser.md) — 3.7M weekly downloads
- [expr-eval-fork](https://npm.io/package/expr-eval-fork.md) — 1.5M weekly downloads
- [@leeoniya/ufuzzy](https://npm.io/package/@leeoniya/ufuzzy.md) — 247.7K weekly downloads
- [xml-parser](https://npm.io/package/xml-parser.md) — 78.4K weekly downloads

## Recent versions

- 1.1.6 (latest) — 2024-02-15
- 1.1.5 — 2024-02-12
- 1.1.4 — 2018-08-15
- 1.1.3 — 2015-03-14
- 1.1.2 — 2015-03-13
- 1.1.1 — 2015-03-13
- 1.1.0 — 2015-03-13
- 1.0.1 — 2015-03-10
- 1.0.0 — 2015-03-10

## README

# parse-bmfont-xml

[![stable](http://badges.github.io/stability-badges/dist/stable.svg)](http://github.com/badges/stability-badges)

Parses XML [BMFont files](http://www.angelcode.com/products/bmfont/).

Takes a string or Buffer:

```js
var fs = require('fs')
var parse = require('parse-bmfont-xml')

fs.readFileSync(__dirname+'/Arial.fnt', function(err, data) {
  var result = parse(data)
  console.log(result.info.face)   // "Arial"
  console.log(result.pages)       // [ 'sheet0.png' ]
  console.log(result.chars)       // [ ... char data ... ]
  console.log(result.kernings)    // [ ... kernings data ... ]
})
```

Also works in the browser, for example using XHR:

```js
var parse = require('parse-bmfont-xml')
var xhr = require('xhr')

xhr({ uri: 'fonts/NexaLight32.xml' }, function(err, res, body) {
  if (err)
    throw err
  var result = parse(body)
  console.log(result.info.face)
})
```

The spec for the returned JSON object is [here](https://github.com/mattdesl/bmfont2json/wiki/JsonSpec). The input XML should match the spec with a `<font>` root element, see [test/Nexa Light-32.fnt](test/Nexa Light-32.fnt) for an example.

## See Also

See [text-modules](https://github.com/mattdesl/text-modules) for related modules.

## Usage

[![NPM](https://nodei.co/npm/parse-bmfont-xml.png)](https://www.npmjs.com/package/parse-bmfont-xml)

#### `result = parse(data)`

Parses `data`, a string or Buffer that represents XML data of an AngelCode BMFont file. The returned `result` object looks like this:

```js
{
     pages: [
         "sheet_0.png", 
         "sheet_1.png"
     ],
     chars: [
         { chnl, height, id, page, width, x, y, xoffset, yoffset, xadvance },
         ...
     ],
     info: { ... },
     common: { ... },
     kernings: [
         { first, second, amount }
     ]
}
```

If the data is malformed, an error will be thrown.

The browser implementation relies on [xml-parse-from-string](https://github.com/Jam3/xml-parse-from-string), which may not work in environments without valid DOM APIs (like CocoonJS).

## License

MIT, see [LICENSE.md](http://github.com/mattdesl/parse-bmfont-xml/blob/master/LICENSE.md) for details.

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