codelenny / load-bmfont

loads a BMFont file in Node and the browser

load-bmfont

Loads an AngelCode BMFont file from XHR (in browser) and fs (in Node), returning a JSON representation.

var load = require('@codelenny/load-bmfont')

load('fonts/Arial-32.fnt', function(err, font) {
  if (err)
    throw err

  //The BMFont spec in JSON form
  console.log(font.common.lineHeight)
  console.log(font.info)
  console.log(font.chars)
  console.log(font.kernings)
})

Currently supported BMFont formats:

• ASCII (text)
• JSON
• XML
• binary

Origin

This is a fork of Jam3/load-bmfont.

Added:

• Testing via Travis CI

Modified:

• Made error messages more informative

See Also

See text-modules for related modules.

Usage

load(opt, cb)

Loads a BMFont file with the opt settings and fires the callback with (err, font) params once finished. If opt is a string, it is used as the URI. Otherwise the options can be:

• uri or url the path (in Node) or URI (in the browser)
• binary boolean, whether the data should be read as binary, default false
• (in node) options for fs.readFile
• (in browser) options for xhr

To support binary files in the browser and Node, you should use binary: true. Otherwise the XHR request might come in the form of a UTF8 string, which will not work with binary files. This also sets up the XHR object to override mime type in older browsers.

load({
  uri: 'fonts/Arial.bin',
  binary: true
}, function(err, font) {
  console.log(font)
})

License

MIT, see LICENSE.md for details.

load-bmfont's Issues

Don't Overwrite Errors

https://github.com/Jam3/load-bmfont/blob/da0f0d926357dac395f3c117bd5ee57f4c2f28d4/index.js#L41

cb(new Error('cannot parse font file '+e.message))

Is not useful. This discards the entire stack for no purpose.

Add TravisCI

Automatically test via TravisCI.

Customize Repository

Publish under @codelenny/load-bmfont.